Struct WebSearchTool 

pub struct WebSearchTool { /* private fields */ }

Web search tool for searching the internet. Supports multiple model_providers: DuckDuckGo (free), Brave (requires API key), Tavily (requires API key), SearXNG (self-hosted, requires instance URL), Jina AI (requires API key), Bocha AI (requires API key, Chinese-friendly).

API keys are resolved lazily at execution time: if the boot-time key is missing or still encrypted, the tool re-reads config.toml, decrypts the corresponding [web_search] field, and uses the result. This ensures that keys set or rotated after boot, and encrypted keys, are correctly picked up. The Bocha key has no boot-time snapshot at all — it is always resolved from config.toml at use time (see resolve_bocha_api_key), so the canonical [web_search] bocha_api_key field stays the single source of truth and rotation/removal takes effect without a restart.

Implementations

impl WebSearchTool

pub fn new( model_provider: String, brave_api_key: Option<String>, jina_api_key: Option<String>, max_results: usize, timeout_secs: u64, ) -> WebSearchTool

pub fn new_with_config( model_provider: String, brave_api_key: Option<String>, tavily_api_key: Option<String>, jina_api_key: Option<String>, searxng_instance_url: Option<String>, max_results: usize, timeout_secs: u64, config_path: PathBuf, secrets_encrypt: bool, ) -> WebSearchTool

Trait Implementations

impl Attributable for WebSearchTool

fn role(&self) -> Role

fn alias(&self) -> &str

impl Tool for WebSearchTool

fn name(&self) -> &str

Tool name (used in LLM function calling)

fn description(&self) -> &str

Human-readable description

fn parameters_schema(&self) -> Value

JSON schema for parameters

fn execute<'life0, 'async_trait>( &'life0 self, args: Value, ) -> Pin<Box<dyn Future<Output = Result<ToolResult, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, WebSearchTool: 'async_trait,

Execute the tool with given arguments

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

JSON schema describing the structured output this tool attaches to ToolOutput::data, when it declares one. None means the tool emits display text only; authoring surfaces fall back to sample-derived shapes from captured runs.

fn param_domains(&self) -> Vec<(&'static str, OptionDomain)>

Option domains for parameters whose value sets live in runtime config rather than the static schema (channel refs, peer targets, …). Surfaces resolve these through the runtime to render real selectable choices. Default: no domain-typed parameters.

fn spec(&self) -> ToolSpec