Struct OpenAIWebSearchTool 

pub struct OpenAIWebSearchTool { /* private fields */ }

OpenAI hosted web search tool.

Implementations

impl OpenAIWebSearchTool

pub fn new() -> Self

pub fn preview(self) -> Self

pub fn with_allowed_domains( self, domains: impl IntoIterator<Item = impl Into<String>>, ) -> Self

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

pub fn with_search_context_size(self, size: impl Into<String>) -> Self

Trait Implementations

impl Clone for OpenAIWebSearchTool

fn clone(&self) -> OpenAIWebSearchTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenAIWebSearchTool

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

Formats the value using the given formatter.

impl Default for OpenAIWebSearchTool

fn default() -> OpenAIWebSearchTool

Returns the “default value” for a type.

impl Tool for OpenAIWebSearchTool

fn name(&self) -> &str

fn description(&self) -> &str

fn is_builtin(&self) -> bool

Indicates whether this tool is a built-in server-side tool (e.g., google_search, url_context).

fn declaration(&self) -> Value

Returns the tool declaration that should be exposed to model providers.

fn execute<'life0, 'async_trait>( &'life0 self, _ctx: Arc<dyn ToolContext>, _args: Value, ) -> Pin<Box<dyn Future<Output = Result<Value>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn enhanced_description(&self) -> String

Returns an enhanced description that may include additional notes. For long-running tools, this includes a warning not to call the tool again if it has already returned a pending status. Default implementation returns the base description.

fn is_long_running(&self) -> bool

Indicates whether the tool is a long-running operation. Long-running tools typically return a task ID immediately and complete the operation asynchronously.

fn parameters_schema(&self) -> Option<Value>

fn response_schema(&self) -> Option<Value>

fn required_scopes(&self) -> &[&str]

Returns the scopes required to execute this tool.