Enum ToolChoice 

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,
}

Available on crate feature anthropic-client only.

Configuration for Claude’s tool choice behavior.

This can be one of the following:

• “auto”: Let the model decide if and when to use tools
• “any”: Allow the model to use any available tool
• “tool”: Force the model to use a specific named tool
• “none”: Do not use any tools

Variants

Auto

Automatic tool choice

Fields

disable_parallel_tool_use: Option<bool>

Whether to disable parallel tool use.

Defaults to false. If set to true, the model will output at most one tool use.

Any

Any tool choice

Fields

disable_parallel_tool_use: Option<bool>

Whether to disable parallel tool use.

Defaults to false. If set to true, the model will output exactly one tool use.

Tool

Specific tool choice

Fields

name: String

The name of the tool to use.

disable_parallel_tool_use: Option<bool>

Whether to disable parallel tool use.

Defaults to false. If set to true, the model will output exactly one tool use.

None

No tools

Implementations

impl ToolChoice

pub fn auto() -> ToolChoice

Create a new ToolChoice with auto mode.

pub fn auto_with_disable_parallel(disable: bool) -> ToolChoice

Create a new ToolChoice with auto mode, specifying whether to disable parallel tool use.

pub fn any() -> ToolChoice

Create a new ToolChoice allowing any tool.

pub fn any_with_disable_parallel(disable: bool) -> ToolChoice

Create a new ToolChoice allowing any tool, specifying whether to disable parallel tool use.

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

Create a new ToolChoice with a specific named tool.

pub fn tool_with_disable_parallel( name: impl Into<String>, disable: bool, ) -> ToolChoice

Create a new ToolChoice with a specific named tool, specifying whether to disable parallel tool use.

pub fn none() -> ToolChoice

Create a new ToolChoice with no tools.

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<(), Error>

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<ToolChoice, <__D as Deserializer<'de>>::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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolChoice