Enum FinishReason 

pub enum FinishReason {
    Stop,
    Length,
    ToolCalls,
    ContentFilter,
    Other(String),
}

Why the model stopped generating, normalized across providers.

Providers report this under different names and vocabularies (finish_reason, stop_reason, stopReason, …). Each provider’s response conversion maps its wire value onto these variants and preserves anything unmapped verbatim in FinishReason::Other, so a provider adding a new terminal reason never silently reads as a natural stop. Closes #2090/#1886.

Provider failure statuses that arrive with parseable output (a Gemini Interactions failed/cancelled interaction, a Cohere ERROR) follow one policy: the response converts normally and the status is preserved verbatim as FinishReason::Other, leaving the caller to decide whether a failure-flagged-but-parseable turn is usable. Statuses that arrive with no usable output surface as errors instead.

Variants

Stop

Natural end of the response.

Length

The response hit the output-token limit.

ToolCalls

The model stopped to call one or more tools.

ContentFilter

The provider filtered the content.

Other(String)

A provider-specific reason outside the normalized vocabulary, carried verbatim in the provider’s own wire spelling.

Implementations

impl FinishReason

pub fn reconcile_with_output(self, has_tool_call: bool) -> Self

Reconcile a provider’s reported reason with what the turn actually produced.

Several providers report a plain stop on a turn that carried tool calls (OpenAI-compatible gateways are the usual offenders). A caller branching on FinishReason::ToolCalls to decide whether to run tools would then miss the call entirely, so a natural stop is upgraded whenever the turn emitted at least one tool call.

Only FinishReason::Stop is upgraded: Length, ContentFilter, and Other describe terminations that remain true regardless of the content, and overriding them would lose information.

This is the single place the upgrade happens. Construct normalized responses through CompletionResponse::with_finish_reason or CompletionResponse::with_optional_finish_reason (and, for streams, crate::streaming::normalize_stream) so it is always applied.

pub fn truncated_output(&self) -> bool

Whether the provider cut the turn short instead of letting the model finish.

A turn that ended this way can legitimately carry no content at all — an output-token cap consumed entirely by hidden reasoning tokens, or a filter that removed everything the model produced — and the reason is then the only diagnostic the caller has. Normalization keeps such an empty turn rather than rejecting it as a malformed response, so a caller can tell “you hit the cap” from “the provider misbehaved”.

Stop and ToolCalls describe turns that ran to completion, so an empty one really is a provider defect; Other is unclassified and gets the strict treatment — it carries a provider’s own wire spelling with no normalized meaning.

This is also the set rig-agent has a remedy for when a turn arrives without an answer (“raise max_tokens” / “the provider filtered the response”), and that is the same question: the reasons a provider may hand back an answerless turn are the reasons there is something useful to say about it. Both sides read this predicate so they cannot drift.

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<'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