Struct RagTool 

pub struct RagTool { /* private fields */ }

Available on crate feature rag only.

A retrieval tool that wraps a RagPipeline for agentic use.

Implements adk_core::Tool so it can be attached to any ADK agent. The tool accepts a required query string and optional collection and top_k parameters.

Implementations

impl RagTool

pub fn new( pipeline: Arc<RagPipeline>, default_collection: impl Into<String>, ) -> RagTool

Create a new RagTool backed by the given pipeline.

The default_collection is used when the agent does not specify a collection in the tool call arguments.

Trait Implementations

impl Tool for RagTool

fn name(&self) -> &str

fn description(&self) -> &str

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

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, RagTool: 'async_trait,

fn declaration(&self) -> Value

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

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 is_builtin(&self) -> bool

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

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

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.