Enum FinishReason 

#[non_exhaustive]
pub enum FinishReason {
    Stop,
    Length,
    ToolUse,
    ContentFilter,
    Other(String),
}

Why a completion stopped (issue #859): what TextDelta::Finish names when a stream ends successfully, and the shape complete’s outcome takes on the streaming port.

#[non_exhaustive]: providers invent reasons, and Self::Other is the pressure valve — a caller that matches the known ones and treats anything else as Self::Stop-shaped should not recompile when a provider’s vocabulary grows.

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

The model finished its answer on its own.

Length

The answer was cut off at Prompt::max_tokens.

ToolUse

The model asked to call a tool; the answer continues in Completion::tool_calls.

ContentFilter

The provider withheld or truncated content under its own policy.

Other(String)

A reason this port does not name. The provider’s own word rides along for the log line.

Trait Implementations

impl Clone for FinishReason

fn clone(&self) -> Self

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<'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 From<&FinishReason> for UiFinishReason

fn from(reason: &FinishReason) -> Self

Converts to this type from the input type.

impl PartialEq for FinishReason

fn eq(&self, other: &Self) -> 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