Struct ToolChoice 

pub struct ToolChoice {
    pub mode: Option<ToolChoiceMode>,
}

Controls tool selection behavior for sampling requests.

JSON schema

{
 "description": "Controls tool selection behavior for sampling requests.",
 "type": "object",
 "properties": {
   "mode": {
     "description": "Controls the tool use ability of the model:\n- \"auto\": Model decides whether to use tools (default)\n- \"required\": Model MUST use at least one tool before completing\n- \"none\": Model MUST NOT use any tools",
     "type": "string",
     "enum": [
       "auto",
       "none",
       "required"
     ]
   }
 }
}

Fields

mode: Option<ToolChoiceMode>

Controls the tool use ability of the model: - “auto”: Model decides whether to use tools (default) - “required”: Model MUST use at least one tool before completing - “none”: Model MUST NOT use any 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

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