Enum ToolChoiceParam 

pub enum ToolChoiceParam {
    AllowedTools(ToolChoiceAllowed),
    Function(ToolChoiceFunction),
    Mcp(ToolChoiceMCP),
    Custom(ToolChoiceCustom),
    ApplyPatch,
    Shell,
    Hosted(ToolChoiceTypes),
    Mode(ToolChoiceOptions),
}

Available on crate feature response-types only.

Variants

AllowedTools(ToolChoiceAllowed)

Constrains the tools available to the model to a pre-defined set.

Function(ToolChoiceFunction)

Use this option to force the model to call a specific function.

Mcp(ToolChoiceMCP)

Use this option to force the model to call a specific tool on a remote MCP server.

Custom(ToolChoiceCustom)

Use this option to force the model to call a custom tool.

ApplyPatch

Forces the model to call the apply_patch tool when executing a tool call.

Shell

Forces the model to call the function shell tool when a tool call is required.

Hosted(ToolChoiceTypes)

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

Mode(ToolChoiceOptions)

Controls which (if any) tool is called by the model.

none means the model will not call any tool and instead generates a message.

auto means the model can pick between generating a message or calling one or more tools.

required means the model must call one or more tools.

Trait Implementations

impl Clone for ToolChoiceParam

fn clone(&self) -> ToolChoiceParam

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ToolChoiceParam

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolChoiceParam

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S: Into<String>> From<S> for ToolChoiceParam

fn from(name: S) -> Self

Converts to this type from the input type.

impl From<ToolChoiceCustom> for ToolChoiceParam

fn from(custom: ToolChoiceCustom) -> Self

Converts to this type from the input type.

impl From<ToolChoiceFunction> for ToolChoiceParam

fn from(function: ToolChoiceFunction) -> Self

Converts to this type from the input type.

impl From<ToolChoiceMCP> for ToolChoiceParam

fn from(mcp: ToolChoiceMCP) -> Self

Converts to this type from the input type.

impl From<ToolChoiceOptions> for ToolChoiceParam

fn from(mode: ToolChoiceOptions) -> Self

Converts to this type from the input type.

impl From<ToolChoiceTypes> for ToolChoiceParam

fn from(tool_type: ToolChoiceTypes) -> Self

Converts to this type from the input type.

impl PartialEq for ToolChoiceParam

fn eq(&self, other: &ToolChoiceParam) -> 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 ToolChoiceParam

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolChoiceParam