Struct WebSearchTool 

pub struct WebSearchTool {
    pub filters: Option<WebSearchFilters>,
    pub return_token_budget: Option<WebSearchReturnTokenBudget>,
    pub search_context_size: Option<WebSearchContextSize>,
    pub user_location: Option<WebSearchUserLocation>,
}

Non-preview hosted web search tool configuration.

Spec: { type: "web_search" | "web_search_2025_08_26", filters? { allowed_domains? }, return_token_budget?: "default"|"unlimited", search_context_size?: "low"|"medium"|"high", user_location? }.

Distinct from WebSearchPreviewTool: adds filters.allowed_domains (domain allowlist), return_token_budget, and pins search_context_size to the spec-listed enum.

Fields

filters: Option<WebSearchFilters>

Optional domain allowlist applied to candidate sources.

return_token_budget: Option<WebSearchReturnTokenBudget>

Search-result context token budget. Spec enum: "default" | "unlimited".

search_context_size: Option<WebSearchContextSize>

Search context budget. Spec enum: "low" | "medium" | "high".

user_location: Option<WebSearchUserLocation>

Approximate user location used to bias results.

Trait Implementations

impl Clone for WebSearchTool

fn clone(&self) -> WebSearchTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSearchTool

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

Formats the value using the given formatter.

impl Default for WebSearchTool

fn default() -> WebSearchTool

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WebSearchTool

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for WebSearchTool

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for WebSearchTool

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

where __S: Serializer,

Serialize this value into the given Serde serializer.