enum OpenAI::FinishReason

Defined in:

openai/api/chat.cr

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

Instance Method Detail

def content_filter? #

[View source]
def function_call? #

[View source]
def length? #

[View source]
def null? #

[View source]
def stop? #

[View source]
def to_s(io : IO) : Nil #
Description copied from struct Enum

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

See also: #to_s.


[View source]
def to_s : String #
Description copied from struct Enum

Returns a String representation of this enum member. In the case of regular enums, this is just the name of the member. In the case of flag enums, it's the names joined by vertical bars, or "None", if the value is zero.

If an enum's value doesn't match a member's value, the raw value is returned as a string.

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

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

[View source]
def tool_calls? #

[View source]