Enum ToolChoiceDefinition 

pub enum ToolChoiceDefinition {
    Function {
        name: String,
    },
    AllowedTools {
        mode: AllowedToolsMode,
        tools: Vec<AllowedTool>,
    },
}

A typed Responses API tool-choice object.

Variants

Function

Force the model to call the named function tool.

Fields

name: String

Name of the function tool the model must call.

AllowedTools

Restrict the model to a subset of the request’s tools.

Fields

mode: AllowedToolsMode

Whether the model may still answer without a tool call (auto) or must call one of the allowed tools (required).

tools: Vec<AllowedTool>

The tools the model is allowed to call.

Trait Implementations

impl Clone for ToolChoiceDefinition

fn clone(&self) -> ToolChoiceDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolChoiceDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolChoiceDefinition

fn deserialize<__D>( __deserializer: __D, ) -> Result<ToolChoiceDefinition, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolChoiceDefinition

fn eq(&self, other: &ToolChoiceDefinition) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ToolChoiceDefinition

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 ToolChoiceDefinition