Struct ToolChoiceAllowed 

pub struct ToolChoiceAllowed {
    pub mode: ToolChoiceAllowedMode,
    pub tools: Vec<Value>,
}

Fields

mode: ToolChoiceAllowedMode

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

auto allows the model to pick from among the allowed tools and generate a message.

required requires the model to call one or more of the allowed tools.

tools: Vec<Value>

A list of tool definitions that the model should be allowed to call.

For the Responses API, the list of tool definitions might look like:

[
  { "type": "function", "name": "get_weather" },
  { "type": "mcp", "server_label": "deepwiki" },
  { "type": "image_generation" }
]

Trait Implementations

impl Clone for ToolChoiceAllowed

fn clone(&self) -> ToolChoiceAllowed

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolChoiceAllowed

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolChoiceAllowed

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolChoiceAllowed

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolChoiceAllowed

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 ToolChoiceAllowed