Struct ToolChoice 

pub struct ToolChoice {
    pub mode: String,
    pub name: Option<String>,
}

Tool choice mode for sampling requests (SEP-1577)

Controls how the LLM should use the available tools.

Fields

mode: String

The tool choice mode: “auto”, “none”, or “tool”

name: Option<String>

Name of the specific tool to use (required when mode is “tool”)

Implementations

impl ToolChoice

pub fn auto() -> ToolChoice

Model decides whether to use tools

pub fn required() -> ToolChoice

Model must use a tool

pub fn none() -> ToolChoice

Model should not use tools

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

Force the model to use a specific tool by name

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<'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 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.