Skip to main content

GoogleSearchTool

Struct GoogleSearchTool

pub struct GoogleSearchTool;

Available on crate feature tools only.

Expand description

GoogleSearch is a built-in tool that is automatically invoked by Gemini models to retrieve search results from Google Search. The tool operates internally within the model and does not require or perform local code execution.

Implementations§

impl GoogleSearchTool

pub fn new() -> GoogleSearchTool

Create a new GoogleSearchTool.

Trait Implementations§

impl Default for GoogleSearchTool

fn default() -> GoogleSearchTool

Returns the “default value” for a type. Read more

impl Tool for GoogleSearchTool

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). Read more

fn declaration(&self) -> Value

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

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, GoogleSearchTool: '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. Read more

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.

Auto Trait Implementations§

impl Freeze for GoogleSearchTool

impl RefUnwindSafe for GoogleSearchTool

impl Send for GoogleSearchTool

impl Sync for GoogleSearchTool

impl Unpin for GoogleSearchTool

impl UnsafeUnpin for GoogleSearchTool

impl UnwindSafe for GoogleSearchTool

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ScopeToolExt for T
where T: Tool,

fn with_scope_guard( self, resolver: impl ScopeResolver + 'static, ) -> ScopedTool<Self>

Wrap this tool with scope enforcement using the given resolver.

impl<T> ToolExt for T
where T: Tool,

fn with_access_control(self, ac: Arc<AccessControl>) -> ProtectedTool<Self>

Wrap this tool with access control.

fn with_access_control_and_audit( self, ac: Arc<AccessControl>, audit: Arc<dyn AuditSink>, ) -> ProtectedTool<Self>

Wrap this tool with access control and audit logging.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more