enum OpenAI::FinishReason

Defined in:

Enum Members

Stop = 0

API returned complete message, or a message terminated by one of the stop sequences provided via the stop parameter

Length = 1

Incomplete model output due to max_tokens parameter or token limit

FunctionCall = 2

The model decided to call a function

ContentFilter = 3

Omitted content due to a flag from our content filters

Null = 4

API response still in progress or incomplete

ToolCalls = 5

if model called a tool

Instance Method Summary

• #content_filter?

  Returns true if this enum value equals ContentFilter

• #function_call?

  Returns true if this enum value equals FunctionCall

• #length?

  Returns true if this enum value equals Length

• #null?

  Returns true if this enum value equals Null

• #stop?

  Returns true if this enum value equals Stop

• #to_s(io : IO) : Nil

  Appends a String representation of this enum member to the given io.

• #to_s : String

  Returns a String representation of this enum member.

• #tool_calls?

  Returns true if this enum value equals ToolCalls

Instance Method Detail

Color::Red.to_s                     # => "Red"
IOMode::None.to_s                   # => "None"
(IOMode::Read | IOMode::Write).to_s # => "Read | Write"

Color.new(10).to_s # => "10"