Struct WebSearchTool20250305 

pub struct WebSearchTool20250305 {
    pub name: String,
    pub allowed_domains: Option<Vec<String>>,
    pub blocked_domains: Option<Vec<String>>,
    pub cache_control: Option<CacheControlEphemeral>,
    pub max_uses: Option<i32>,
    pub user_location: Option<UserLocation>,
}

Parameters for the web search tool.

This tool allows the model to search the web for information.

Fields

name: String

Name of the tool. This is how the tool will be called by the model and in tool_use blocks.

allowed_domains: Option<Vec<String>>

If provided, only these domains will be included in results.

Cannot be used alongside blocked_domains.

blocked_domains: Option<Vec<String>>

If provided, these domains will never appear in results.

Cannot be used alongside allowed_domains.

cache_control: Option<CacheControlEphemeral>

Create a cache control breakpoint at this content block.

max_uses: Option<i32>

Maximum number of times the tool can be used in the API request.

user_location: Option<UserLocation>

Parameters for the user’s location. Used to provide more relevant search results.

Implementations

impl WebSearchTool20250305

pub fn new() -> Self

Creates a new WebSearchTool20250305 instance with default values

pub fn with_allowed_domains(self, domains: Vec<String>) -> Self

Sets the allowed domains for the web search

If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.

pub fn with_blocked_domains(self, domains: Vec<String>) -> Self

Sets the blocked domains for the web search

If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.

pub fn with_cache_control(self, cache_control: CacheControlEphemeral) -> Self

Sets the cache control for the web search

pub fn with_max_uses(self, max_uses: i32) -> Self

Sets the maximum number of times the tool can be used in the API request

pub fn with_user_location(self, user_location: UserLocation) -> Self

Sets the user location for the web search

Trait Implementations

impl Clone for WebSearchTool20250305

fn clone(&self) -> WebSearchTool20250305

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSearchTool20250305

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

Formats the value using the given formatter.

impl Default for WebSearchTool20250305

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WebSearchTool20250305

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WebSearchTool20250305

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

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 WebSearchTool20250305

impl<A: Agent> Tool<A> for WebSearchTool20250305

fn name(&self) -> String

Returns the name of the tool.

fn callback(&self) -> Box<dyn ToolCallback<A>>

Returns the callback implementation for this tool.

fn to_param(&self) -> ToolUnionParam

Converts the tool to a parameter format for the API.