Struct ToolChoiceTypes 

pub struct ToolChoiceTypes {
    pub type_: ToolChoiceTypesType,
}

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

JSON schema

{
 "title": "Hosted tool",
 "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](/docs/guides/tools).\n",
 "type": "object",
 "required": [
   "type"
 ],
 "properties": {
   "type": {
     "description": "The type of hosted tool the model should to use. Learn more about\n[built-in tools](/docs/guides/tools).\n\nAllowed values are:\n- `file_search`\n- `web_search_preview`\n- `computer`\n- `computer_use_preview`\n- `computer_use`\n- `code_interpreter`\n- `image_generation`\n",
     "type": "string",
     "enum": [
       "file_search",
       "web_search_preview",
       "computer",
       "computer_use_preview",
       "computer_use",
       "web_search_preview_2025_03_11",
       "image_generation",
       "code_interpreter"
     ]
   }
 }
}

Fields

type_: ToolChoiceTypesType

The type of hosted tool the model should to use. Learn more about built-in tools.

Allowed values are:

• file_search
• web_search_preview
• computer
• computer_use_preview
• computer_use
• code_interpreter
• image_generation

Trait Implementations

impl Clone for ToolChoiceTypes

fn clone(&self) -> ToolChoiceTypes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolChoiceTypes

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolChoiceTypes

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ToolChoiceTypes> for ToolChoiceParam

fn from(value: ToolChoiceTypes) -> Self

Converts to this type from the input type.

impl Serialize for ToolChoiceTypes

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

where __S: Serializer,

Serialize this value into the given Serde serializer.