Enum ToolChoice 

pub enum ToolChoice {
    Auto,
    Named(String),
}

Stable since 0.63.0

Tool definition and argument validation. Forces or leaves-to-the-model which tool the next assistant turn must call. `Auto` is the existing default behavior (model decides freely, including calling no tool). `Named` forces exactly one tool by name — only honored by providers with native forced-tool-choice support; owned (in-band XML) dialects and providers without the feature silently treat it as `Auto` (see each provider's mapping).

Variants

Auto

Let the model choose freely (the existing default behavior).

Named(String)

Force the next assistant turn to call the named tool. Only honored by providers with native forced-tool-choice support.

Trait Implementations

impl Clone for ToolChoice

fn clone(&self) -> ToolChoice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolChoice

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

Formats the value using the given formatter.

impl Default for ToolChoice

fn default() -> ToolChoice

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolChoice

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ToolChoice

impl PartialEq for ToolChoice

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolChoice

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 ToolChoice