Enum ToolChoice 

#[non_exhaustive]
pub enum ToolChoice {
    Auto,
    Any,
    Tool {
        name: String,
    },
    None_,
}

Constraint placed on the model’s tool selection for a single request. Variant naming follows Anthropic’s wire vocabulary; the Chat Completions adapter translates Any → "required" and None_ → "none".

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.

Auto

Model decides whether to call a tool. Provider default.

Any

Model must call some tool, but may pick which one. Translates to "required" on Chat Completions.

Tool

Model must call this specific tool.

Fields

name: String

Name of the required tool; must appear in the request’s tools list.

None_

Model is forbidden from calling any tool. Trailing underscore avoids collision with the keyword None.

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 PartialEq for ToolChoice

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ToolChoice

impl StructuralPartialEq for ToolChoice