Struct WebSearchTool 

pub struct WebSearchTool { /* private fields */ }

Builtin tool that performs web searches and returns ranked result snippets.

Delegates to one of four backends selected via SearchProvider; the default Auto mode tries Exa → Tavily → Brave → DuckDuckGo in priority order based on which API keys are present in the environment. DuckDuckGo requires no key and is always available as a zero-config fallback. Results are returned as title + URL + snippet text, capped at MAX_NUM_RESULTS = 50.

Implementations

impl WebSearchTool

pub fn new() -> Self

Create a WebSearchTool with automatic provider selection.

Panics if the HTTP client cannot be built (TLS initialisation failure). Use WebSearchTool::try_new if you need to handle the error.

pub fn try_new() -> Result<Self, Error>

Create a WebSearchTool with automatic provider selection.

Returns Err if the underlying HTTP client cannot be constructed (e.g., TLS initialisation failure).

pub fn with_provider(provider: SearchProvider) -> Self

Create a WebSearchTool that uses a specific search provider instead of auto-detecting from environment variables.

Panics if the HTTP client cannot be built. Use WebSearchTool::try_with_provider if you need to handle the error.

pub fn try_with_provider(provider: SearchProvider) -> Result<Self, Error>

Create a WebSearchTool that uses a specific search provider.

Returns Err if the underlying HTTP client cannot be constructed.

Trait Implementations

impl Default for WebSearchTool

fn default() -> Self

Returns the “default value” for a type.

impl Tool for WebSearchTool

fn definition(&self) -> ToolDefinition

Return the tool’s definition (name, description, input schema) for the LLM.

fn execute( &self, _ctx: &ExecutionContext, input: Value, ) -> Pin<Box<dyn Future<Output = Result<ToolOutput, Error>> + Send + '_>>

Execute the tool with the LLM-supplied input JSON.

fn redact_for_history(&self, output: &str) -> String

Optional override: produce a compact version of the tool output suitable for inclusion in conversation history sent to subsequent LLM turns. The default implementation returns the input verbatim.