Struct ToolChoiceAllowed 

pub struct ToolChoiceAllowed {
    pub mode: Mode,
    pub tools: Vec<IndexMap<String, Value>>,
}

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

Fields

mode: Mode

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<IndexMap<String, 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" }
]
```text

Implementations

impl ToolChoiceAllowed

pub fn builder() -> ToolChoiceAllowedBuilder<((), ())>

Create a builder for building ToolChoiceAllowed. On the builder, call .mode(...), .tools(...) to set the values of the fields. Finally, call .build() to create the instance of ToolChoiceAllowed.

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

Formats the value using the given formatter.

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

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolChoiceAllowed

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

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 ToolChoiceAllowed