Enum StopReason 

#[non_exhaustive]
pub enum StopReason {
    EndTurn,
    RequiresAction {
        event_ids: Vec<String>,
    },
    MaxTokens,
}

Why a turn ended. Included in status.idle events.

Wire Shapes

{"reason": "end_turn"}
{"reason": "requires_action", "event_ids": ["evt_001", "evt_002"]}
{"reason": "max_tokens"}

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.

EndTurn

The LLM naturally ended its turn (end_turn stop reason from provider).

RequiresAction

The agent emitted custom tool calls that require client action. The caller must send user.custom_tool_result for each listed event_id.

Fields

event_ids: Vec<String>

IDs of events requiring action.

MaxTokens

The LLM hit its maximum token limit mid-generation.

Trait Implementations

impl Clone for StopReason

fn clone(&self) -> StopReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StopReason

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StopReason

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for StopReason

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

where __S: Serializer,

Serialize this value into the given Serde serializer.