Enum FinishReason

pub enum FinishReason {
    Stop,
    Length,
    ContentFilter,
    ToolCalls,
    FunctionCall,
}

The reason the model stopped generating tokens. This will be stop if the model hit a natural stop point or a provided stop sequence, length if the maximum number of tokens specified in the request was reached, content_filter if content was omitted due to a flag from our content filters, tool_calls if the model called a tool, or function_call (deprecated) if the model called a function.

on openai.yaml

finish_reason:
  type: string
  description: >
    The reason the model stopped generating tokens. This will be
    `stop` if the model hit a natural stop point or a provided
    stop sequence,

    `length` if the maximum number of tokens specified in the
    request was reached,

    `content_filter` if content was omitted due to a flag from our
    content filters,

    `tool_calls` if the model called a tool, or `function_call`
    (deprecated) if the model called a function.
  enum:
    - stop
    - length
    - tool_calls
    - content_filter
    - function_call

Variants

Stop

Length

ContentFilter

ToolCalls

FunctionCall

Trait Implementations

impl Debug for FinishReason

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FinishReason

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FinishReason

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.