Enum ModelTool 

pub enum ModelTool {
    Function {
        name: String,
        parameters: Value,
        description: Option<String>,
        strict: Option<bool>,
    },
    WebSearch {
        allowed_domains: Option<Vec<String>>,
        excluded_domains: Option<Vec<String>>,
        enable_image_understanding: Option<bool>,
        external_web_access: Option<bool>,
        filters: Option<WebSearchFilters>,
        search_context_size: Option<String>,
        user_location: Option<Value>,
    },
    XSearch {
        allowed_x_handles: Option<Vec<String>>,
        excluded_x_handles: Option<Vec<String>>,
        enable_image_understanding: Option<bool>,
        enable_video_understanding: Option<bool>,
        from_date: Option<String>,
        to_date: Option<String>,
    },
    FileSearch {
        vector_store_ids: Vec<String>,
        max_num_results: Option<i32>,
        filters: Option<Value>,
        ranking_options: Option<Value>,
    },
    CodeInterpreter {
        container: Option<Value>,
    },
    Mcp {
        server_label: String,
        server_url: String,
        allowed_tools: Option<Vec<String>>,
        authorization: Option<String>,
        connector_id: Option<String>,
        headers: Option<HashMap<String, String>>,
        require_approval: Option<String>,
        server_description: Option<String>,
    },
}

Definition of one tool that the model can call (for Responses API).

Variants

Function

A function that the model can call.

Fields

name: String

The name of the function.

parameters: Value

A JSON schema describing the function parameters.

description: Option<String>

A description of the function.

strict: Option<bool>

Not supported. Only maintained for compatibility reasons.

WebSearch

Search the web.

Fields

allowed_domains: Option<Vec<String>>

List of website domains to allow in the search results.

excluded_domains: Option<Vec<String>>

List of website domains to exclude from the search results.

enable_image_understanding: Option<bool>

Enable image understanding during web search.

external_web_access: Option<bool>

Control whether the web search tool fetches live content or uses only cached content.

filters: Option<WebSearchFilters>

Filters to apply to the search results.

search_context_size: Option<String>

High level guidance for the amount of context window space to use.

user_location: Option<Value>

The user location to use for the search.

XSearch

Search X.

Fields

allowed_x_handles: Option<Vec<String>>

List of X Handles of the users from whom to consider the posts.

excluded_x_handles: Option<Vec<String>>

List of X Handles of the users from whom to exclude the posts.

enable_image_understanding: Option<bool>

Enable image understanding during X search.

enable_video_understanding: Option<bool>

Enable video understanding during X search.

from_date: Option<String>

Date from which to consider the results.

to_date: Option<String>

Date up to which to consider the results.

FileSearch

Search the knowledge bases.

Fields

vector_store_ids: Vec<String>

List of vector store IDs to search within.

max_num_results: Option<i32>

Maximum number of results.

filters: Option<Value>

A filter to apply.

ranking_options: Option<Value>

Ranking options for search.

CodeInterpreter

Execute code.

Fields

container: Option<Value>

The code interpreter container.

Mcp

A remote MCP server to use.

Fields

server_label: String

The label of the MCP server.

server_url: String

The URL of the MCP server.

allowed_tools: Option<Vec<String>>

Allowed tools.

authorization: Option<String>

Authorization token.

connector_id: Option<String>

Connector ID.

headers: Option<HashMap<String, String>>

Additional headers.

require_approval: Option<String>

Whether to require approval.

server_description: Option<String>

Server description.

Trait Implementations

impl Clone for ModelTool

fn clone(&self) -> ModelTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelTool

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

Formats the value using the given formatter.

impl Default for ModelTool

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModelTool

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ModelTool

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

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 ModelTool