Enum FinishReason 

#[non_exhaustive]
pub enum FinishReason {
    Stop,
    Length,
    ToolCalls,
    ContentFilter,
    Cancelled,
    Error,
    Other(String),
    Unknown,
}

Why a model stopped producing output.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Stop

Natural completion.

Length

Output-token or context limit.

ToolCalls

The model requested one or more tools.

ContentFilter

Provider safety or content filter.

Cancelled

The operation was cancelled.

Error

Provider reported an error as a terminal reason.

Other(String)

Provider-specific reason retained as text.

Unknown

No reliable reason was provided.

Trait Implementations

impl Clone for FinishReason

fn clone(&self) -> FinishReason

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FinishReason

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

Formats the value using the given formatter.

impl Default for FinishReason

fn default() -> FinishReason

Returns the “default value” for a type.

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 Eq for FinishReason

impl PartialEq for FinishReason

fn eq(&self, other: &FinishReason) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

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.

impl StructuralPartialEq for FinishReason