Enum ToolChoice 

#[non_exhaustive]
pub enum ToolChoice {
    Auto {
        disable_parallel_tool_use: Option<bool>,
    },
    Any {
        disable_parallel_tool_use: Option<bool>,
    },
    Tool {
        name: String,
        disable_parallel_tool_use: Option<bool>,
    },
    None,
}

How (or whether) the model should invoke a tool on this turn.

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

Default: the model decides whether and which tool to use.

Fields

disable_parallel_tool_use: Option<bool>

Set true to force serial tool calls when the model decides to use tools.

Any

The model must use a tool, but may choose which one.

Fields

disable_parallel_tool_use: Option<bool>

Set true to force serial tool calls.

Tool

The model must use the named tool.

Fields

name: String

Tool name the model must invoke.

disable_parallel_tool_use: Option<bool>

Set true to force a single tool call.

None

The model must not use any tool.

Implementations

impl ToolChoice

pub fn auto() -> Self

Default auto choice with no parallelism override.

pub fn any() -> Self

any – model must invoke some tool of its choice.

pub fn tool(name: impl Into<String>) -> Self

Force the model to invoke the named tool.

pub fn none() -> Self

Forbid all tool use.

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<'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 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 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 Eq for ToolChoice

impl StructuralPartialEq for ToolChoice