Struct GeminiFileSearchTool 

pub struct GeminiFileSearchTool { /* private fields */ }

Available on crate feature tools only.

Gemini built-in file search tool.

Implementations

impl GeminiFileSearchTool

pub fn new( file_search_store_names: impl IntoIterator<Item = impl Into<String>>, ) -> GeminiFileSearchTool

Create a new GeminiFileSearchTool with the given store names.

Trait Implementations

impl BypassMultiToolsLimit for GeminiFileSearchTool

Bypass support: convert the built-in Gemini File Search tool into a function-calling tool so it can be used alongside custom function tools under the Gemini Interactions API.

The converted tool declares a query: string function schema and performs the document search by delegating to an internal single-turn agent (an LlmAgent configured with GeminiFileSearchTool and a Gemini model).

Example

use adk_tool::{BypassMultiToolsLimit, GeminiFileSearchTool};
use std::sync::Arc;

// `file_search_agent` is an LlmAgent with GeminiFileSearchTool + a Gemini model.
let tool = GeminiFileSearchTool::new(["my-store"])
    .with_bypass_multi_tools_limit(Arc::new(file_search_agent));
assert!(!tool.is_builtin());

fn bypass_name(&self) -> String

The function-tool name surfaced to the model after bypass conversion.

fn bypass_description(&self) -> String

The function-tool description surfaced to the model.

fn bypass_parameters_schema(&self) -> Value

The JSON Schema for the bypass function’s parameters.

fn bypass_query_field(&self) -> String

The argument field that carries the natural-language query forwarded to the internal agent (e.g. "query" for search, "url" for URL context).

fn with_bypass_multi_tools_limit(self, agent: Arc<dyn Agent>) -> Arc<dyn Tool>

Convert this built-in tool into a function-calling BypassBuiltinTool so it can coexist with custom function tools under the Interactions API.

impl Clone for GeminiFileSearchTool

fn clone(&self) -> GeminiFileSearchTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GeminiFileSearchTool

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

Formats the value using the given formatter.

impl Tool for GeminiFileSearchTool

fn name(&self) -> &str

Returns the unique name of this tool.

fn description(&self) -> &str

Returns a human-readable description of what this tool does.

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, AdkError>> + Send + 'async_trait>>

where 'life0: 'async_trait, GeminiFileSearchTool: 'async_trait,

Executes the tool with the given context and arguments.

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>

Returns the JSON Schema for this tool’s parameters, if any.

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

Returns the JSON Schema for this tool’s response, if any.

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

Returns the scopes required to execute this tool.

fn is_read_only(&self) -> bool

Indicates whether this tool performs no side effects. Read-only tools may be executed concurrently in Auto mode.

fn is_concurrency_safe(&self) -> bool

Indicates whether this tool is safe for concurrent execution. Used by the Parallel strategy to validate dispatch safety.