mirror of
https://github.com/google/adk-docs.git
synced 2026-09-14 16:16:59 +08:00
370 lines
30 KiB
HTML
370 lines
30 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Google Analytics tag (gtag.js) -->
|
|
<script async src="https://www.googletagmanager.com/gtag/js?id=G-DKHZS27PHP"></script>
|
|
<script>
|
|
window.dataLayer = window.dataLayer || [];
|
|
function gtag(){dataLayer.push(arguments);}
|
|
gtag("js", new Date());
|
|
gtag("config", "G-DKHZS27PHP");
|
|
</script>
|
|
<!-- Generated by javadoc (26) -->
|
|
<title>GoogleSearchTool (Google Agent Development Kit Maven Parent POM 1.7.0 API)</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<meta name="description" content="declaration: package: com.google.adk.tools, class: GoogleSearchTool">
|
|
<meta name="generator" content="javadoc/ClassWriter">
|
|
<link rel="stylesheet" type="text/css" href="../../../../resource-files/jquery-ui.min.css">
|
|
<link rel="stylesheet" type="text/css" href="../../../../resource-files/stylesheet.css">
|
|
<script type="text/javascript" src="../../../../script-files/script.js"></script>
|
|
<script type="text/javascript" src="../../../../script-files/jquery-3.7.1.min.js"></script>
|
|
<script type="text/javascript" src="../../../../script-files/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="class-declaration-page">
|
|
<script type="text/javascript">const pathtoroot = "../../../../";
|
|
loadScripts();
|
|
initTheme();
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<header role="banner">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="top-nav" id="navbar-top">
|
|
<div class="nav-content">
|
|
<div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button></div>
|
|
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../../../index.html">Overview</a></li>
|
|
<li class="nav-bar-cell1-rev">Class</li>
|
|
<li><a href="class-use/GoogleSearchTool.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../search.html">Search</a></li>
|
|
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"></button></li>
|
|
</ul>
|
|
<div id="theme-panel">
|
|
<div>Select Theme</div>
|
|
<div><label for="theme-light"><input type="radio" id="theme-light" disabled name="theme" value="theme-light"><span>Light</span></label><label for="theme-dark"><input type="radio" id="theme-dark" disabled name="theme" value="theme-dark"><span>Dark</span></label><label for="theme-os"><input type="radio" id="theme-os" disabled name="theme" value="theme-os"><span>System Setting</span></label></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div class="nav-content">
|
|
<ol class="sub-nav-list">
|
|
<li><a href="package-summary.html">com.google.adk.tools</a></li>
|
|
<li><a href="GoogleSearchTool.html" class="current-selection">GoogleSearchTool</a></li>
|
|
</ol>
|
|
<div class="nav-list-search"><input type="text" id="search-input" disabled placeholder="Search documentation (type /)" aria-label="Search in documentation" autocomplete="off" spellcheck="false"><input type="reset" id="reset-search" disabled value="Reset"></div>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
</header>
|
|
<div class="main-grid">
|
|
<nav role="navigation" class="toc" aria-label="Table of contents">
|
|
<div class="toc-header">Contents <input type="text" class="filter-input" disabled placeholder="Filter contents (type .)" aria-label="Filter table of contents" autocomplete="off" spellcheck="false"><input type="reset" class="reset-filter" disabled tabindex="-1" value="Reset"> <button class="toc-sort-toggle" id="toc-lexical-order-toggle"><img src="../../../../resource-files/sort-a-z.svg" alt="Sort member details in lexicographical order"></button></div>
|
|
<ol class="toc-list" tabindex="-1">
|
|
<li><a href="#" tabindex="0">Description</a></li>
|
|
<li><a href="#nested-class-summary" tabindex="0">Nested Class Summary</a></li>
|
|
<li><a href="#field-summary" tabindex="0">Field Summary</a></li>
|
|
<li><a href="#constructor-summary" tabindex="0">Constructor Summary</a></li>
|
|
<li><a href="#method-summary" tabindex="0">Method Summary</a></li>
|
|
<li><a href="#field-detail" tabindex="0">Field Details</a>
|
|
<ol class="toc-list">
|
|
<li><a href="#INSTANCE" tabindex="0">INSTANCE</a></li>
|
|
</ol>
|
|
</li>
|
|
<li><a href="#constructor-detail" tabindex="0">Constructor Details</a>
|
|
<ol class="toc-list">
|
|
<li><a href="#%3Cinit%3E()" tabindex="0">GoogleSearchTool()</a></li>
|
|
</ol>
|
|
</li>
|
|
<li><a href="#method-detail" tabindex="0">Method Details</a>
|
|
<ol class="toc-list">
|
|
<li><a href="#processLlmRequest(com.google.adk.models.LlmRequest.Builder,com.google.adk.tools.ToolContext)" tabindex="0">processLlmRequest(LlmRequest.Builder, ToolContext)</a></li>
|
|
</ol>
|
|
</li>
|
|
</ol>
|
|
<button class="hide-sidebar"><span>Hide sidebar </span><img src="../../../../resource-files/left.svg" alt="Hide sidebar"></button><button class="show-sidebar"><img src="../../../../resource-files/right.svg" alt="Show sidebar"><span> Show sidebar</span></button></nav>
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<h1 title="Class GoogleSearchTool" class="title">Class GoogleSearchTool</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">java.lang.Object</a>
|
|
<div class="inheritance"><a href="BaseTool.html" title="class in com.google.adk.tools">com.google.adk.tools.BaseTool</a>
|
|
<div class="inheritance">com.google.adk.tools.GoogleSearchTool</div>
|
|
</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<hr>
|
|
<div class="horizontal-scroll">
|
|
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">GoogleSearchTool</span>
|
|
<span class="extends-implements">extends <a href="BaseTool.html" title="class in com.google.adk.tools">BaseTool</a></span></div>
|
|
<div class="block">A built-in tool that is automatically invoked by Gemini 2 and 3 models to retrieve search results
|
|
from Google Search.
|
|
|
|
<p>This tool operates internally within the model and does not require or perform local code
|
|
execution.
|
|
|
|
<p>Usage example in an LlmAgent:
|
|
|
|
<pre><code>LlmAgent agent = LlmAgent.builder()
|
|
.addTool(GoogleSearchTool.INSTANCE)
|
|
.build();
|
|
</code></pre></div>
|
|
</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
<li>
|
|
<section class="nested-class-summary" id="nested-class-summary">
|
|
<h2>Nested Class Summary</h2>
|
|
<div class="inherited-list">
|
|
<h3 id="nested-classes-inherited-from-class-com.google.adk.tools.BaseTool">Nested classes/interfaces inherited from class <a href="BaseTool.html#nested-class-summary" title="class in com.google.adk.tools">BaseTool</a></h3>
|
|
<code><a href="BaseTool.ToolArgsConfig.html" title="class in com.google.adk.tools">BaseTool.ToolArgsConfig</a>, <a href="BaseTool.ToolConfig.html" title="class in com.google.adk.tools">BaseTool.ToolConfig</a></code>
|
|
<div class="summary-table three-column-summary">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Class</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code>static class </code></div>
|
|
<div class="col-second even-row-color"><code><a href="BaseTool.ToolArgsConfig.html" class="type-name-link" title="class in com.google.adk.tools">BaseTool.ToolArgsConfig</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Configuration class for tool arguments that allows arbitrary key-value pairs.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static class </code></div>
|
|
<div class="col-second odd-row-color"><code><a href="BaseTool.ToolConfig.html" class="type-name-link" title="class in com.google.adk.tools">BaseTool.ToolConfig</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Configuration class for a tool definition in YAML/JSON.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<li>
|
|
<section class="field-summary" id="field-summary">
|
|
<h2>Field Summary</h2>
|
|
<div class="caption"><span>Fields</span></div>
|
|
<div class="summary-table three-column-summary">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Field</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code>static final <a href="GoogleSearchTool.html" title="class in com.google.adk.tools">GoogleSearchTool</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#INSTANCE" class="member-name-link">INSTANCE</a></code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<li>
|
|
<section class="constructor-summary" id="constructor-summary">
|
|
<h2>Constructor Summary</h2>
|
|
<div class="caption"><span>Constructors</span></div>
|
|
<div class="summary-table two-column-summary">
|
|
<div class="table-header col-first">Constructor</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">GoogleSearchTool</a>()</code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method-summary">
|
|
<h2>Method Summary</h2>
|
|
<div id="method-summary-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
|
|
<div class="summary-table three-column-summary">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Method</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>io.reactivex.rxjava3.core.Completable</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#processLlmRequest(com.google.adk.models.LlmRequest.Builder,com.google.adk.tools.ToolContext)" class="member-name-link">processLlmRequest</a><wbr>(<a href="../models/LlmRequest.Builder.html" title="class in com.google.adk.models">LlmRequest.Builder</a> llmRequestBuilder,
|
|
<a href="ToolContext.html" title="class in com.google.adk.tools">ToolContext</a> toolContext)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Processes the outgoing <a href="../models/LlmRequest.Builder.html" title="class in com.google.adk.models"><code>LlmRequest.Builder</code></a>.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-com.google.adk.tools.BaseTool">Methods inherited from class <a href="BaseTool.html#method-summary" title="class in com.google.adk.tools">BaseTool</a></h3>
|
|
<code><a href="BaseTool.html#customMetadata()" title="customMetadata()">customMetadata</a>, <a href="BaseTool.html#declaration()" title="declaration()">declaration</a>, <a href="BaseTool.html#description()" title="description()">description</a>, <a href="BaseTool.html#fromConfig(com.google.adk.tools.BaseTool.ToolConfig,java.lang.String)" title="fromConfig(BaseTool.ToolConfig, String)">fromConfig</a>, <a href="BaseTool.html#longRunning()" title="longRunning()">longRunning</a>, <a href="BaseTool.html#name()" title="name()">name</a>, <a href="BaseTool.html#runAsync(I,com.google.adk.tools.ToolContext,com.fasterxml.jackson.core.type.TypeReference)" title="runAsync(I, ToolContext, TypeReference)">runAsync</a>, <a href="BaseTool.html#runAsync(I,com.google.adk.tools.ToolContext,com.fasterxml.jackson.databind.ObjectMapper,com.fasterxml.jackson.core.type.TypeReference)" title="runAsync(I, ToolContext, ObjectMapper, TypeReference)">runAsync</a>, <a href="BaseTool.html#runAsync(I,com.google.adk.tools.ToolContext,com.fasterxml.jackson.databind.ObjectMapper,java.lang.Class)" title="runAsync(I, ToolContext, ObjectMapper, Class)">runAsync</a>, <a href="BaseTool.html#runAsync(I,com.google.adk.tools.ToolContext,java.lang.Class)" title="runAsync(I, ToolContext, Class)">runAsync</a>, <a href="BaseTool.html#runAsync(java.util.Map,com.google.adk.tools.ToolContext)" title="runAsync(Map, ToolContext)">runAsync</a>, <a href="BaseTool.html#runAsync(T,com.google.adk.tools.ToolContext)" title="runAsync(T, ToolContext)">runAsync</a>, <a href="BaseTool.html#runAsync(T,com.google.adk.tools.ToolContext,com.fasterxml.jackson.databind.ObjectMapper)" title="runAsync(T, ToolContext, ObjectMapper)">runAsync</a>, <a href="BaseTool.html#setCustomMetadata(java.lang.String,java.lang.Object)" title="setCustomMetadata(String, Object)">setCustomMetadata</a></code>
|
|
<div class="summary-table three-column-summary">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Method</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code>com.google.common.collect.ImmutableMap<wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>></code></div>
|
|
<div class="col-second even-row-color"><code><a href="BaseTool.html#customMetadata()" class="member-name-link">customMetadata</a>()</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Returns a read-only view of the tool metadata.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class in java.util" class="external-link">Optional</a><wbr><com.google.genai.types.FunctionDeclaration></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="BaseTool.html#declaration()" class="member-name-link">declaration</a>()</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Gets the <code>FunctionDeclaration</code> representation of this tool.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="BaseTool.html#description()" class="member-name-link">description</a>()</code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
<div class="col-first odd-row-color"><code>static <a href="BaseTool.html" title="class in com.google.adk.tools">BaseTool</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="BaseTool.html#fromConfig(com.google.adk.tools.BaseTool.ToolConfig,java.lang.String)" class="member-name-link">fromConfig</a><wbr>(<a href="BaseTool.ToolConfig.html" title="class in com.google.adk.tools">BaseTool.ToolConfig</a> config,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a> configAbsPath)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Creates a tool instance from a config.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>boolean</code></div>
|
|
<div class="col-second even-row-color"><code><a href="BaseTool.html#longRunning()" class="member-name-link">longRunning</a>()</code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="BaseTool.html#name()" class="member-name-link">name</a>()</code></div>
|
|
<div class="col-last odd-row-color"> </div>
|
|
<div class="col-first even-row-color"><code>final <I,<wbr>O> io.reactivex.rxjava3.core.Single<wbr><O></code></div>
|
|
<div class="col-second even-row-color"><code><a href="BaseTool.html#runAsync(I,com.google.adk.tools.ToolContext,com.fasterxml.jackson.core.type.TypeReference)" class="member-name-link">runAsync</a><wbr>(I args,
|
|
<a href="ToolContext.html" title="class in com.google.adk.tools">ToolContext</a> toolContext,
|
|
com.fasterxml.jackson.core.type.TypeReference<? extends O> typeReference)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Calls a tool with generic arguments, returning the results converted to a specified type
|
|
reference.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>final <I,<wbr>O> io.reactivex.rxjava3.core.Single<wbr><O></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="BaseTool.html#runAsync(I,com.google.adk.tools.ToolContext,com.fasterxml.jackson.databind.ObjectMapper,com.fasterxml.jackson.core.type.TypeReference)" class="member-name-link">runAsync</a><wbr>(I args,
|
|
<a href="ToolContext.html" title="class in com.google.adk.tools">ToolContext</a> toolContext,
|
|
com.fasterxml.jackson.databind.ObjectMapper objectMapper,
|
|
com.fasterxml.jackson.core.type.TypeReference<? extends O> typeReference)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Calls a tool with generic arguments and a custom <code>ObjectMapper</code>, returning the results
|
|
converted to a specified type reference.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>final <I,<wbr>O> io.reactivex.rxjava3.core.Single<wbr><O></code></div>
|
|
<div class="col-second even-row-color"><code><a href="BaseTool.html#runAsync(I,com.google.adk.tools.ToolContext,com.fasterxml.jackson.databind.ObjectMapper,java.lang.Class)" class="member-name-link">runAsync</a><wbr>(I args,
|
|
<a href="ToolContext.html" title="class in com.google.adk.tools">ToolContext</a> toolContext,
|
|
com.fasterxml.jackson.databind.ObjectMapper objectMapper,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class in java.lang" class="external-link">Class</a><? extends O> oClass)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Calls a tool with generic arguments and a custom <code>ObjectMapper</code>, returning the results
|
|
converted to a specified class.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>final <I,<wbr>O> io.reactivex.rxjava3.core.Single<wbr><O></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="BaseTool.html#runAsync(I,com.google.adk.tools.ToolContext,java.lang.Class)" class="member-name-link">runAsync</a><wbr>(I args,
|
|
<a href="ToolContext.html" title="class in com.google.adk.tools">ToolContext</a> toolContext,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class in java.lang" class="external-link">Class</a><? extends O> oClass)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Calls a tool with generic arguments, returning the results converted to a specified class.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>io.reactivex.rxjava3.core.Single<wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>>></code></div>
|
|
<div class="col-second even-row-color"><code><a href="BaseTool.html#runAsync(java.util.Map,com.google.adk.tools.ToolContext)" class="member-name-link">runAsync</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>> args,
|
|
<a href="ToolContext.html" title="class in com.google.adk.tools">ToolContext</a> toolContext)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Calls a tool.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>final <T> io.reactivex.rxjava3.core.Single<wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>>></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="BaseTool.html#runAsync(T,com.google.adk.tools.ToolContext)" class="member-name-link">runAsync</a><wbr>(T args,
|
|
<a href="ToolContext.html" title="class in com.google.adk.tools">ToolContext</a> toolContext)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Calls a tool with generic arguments and returns a map of results.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>final <T> io.reactivex.rxjava3.core.Single<wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>>></code></div>
|
|
<div class="col-second even-row-color"><code><a href="BaseTool.html#runAsync(T,com.google.adk.tools.ToolContext,com.fasterxml.jackson.databind.ObjectMapper)" class="member-name-link">runAsync</a><wbr>(T args,
|
|
<a href="ToolContext.html" title="class in com.google.adk.tools">ToolContext</a> toolContext,
|
|
com.fasterxml.jackson.databind.ObjectMapper objectMapper)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Calls a tool with generic arguments using a custom <code>ObjectMapper</code> and returns a map of
|
|
results.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>void</code></div>
|
|
<div class="col-second odd-row-color"><code><a href="BaseTool.html#setCustomMetadata(java.lang.String,java.lang.Object)" class="member-name-link">setCustomMetadata</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a> key,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a> value)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Sets custom metadata to the tool associated with a key.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary" title="class in java.lang" class="external-link">Object</a></h3>
|
|
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="clone()" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="equals(Object)" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="finalize()" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="getClass()" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="hashCode()" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="notify()" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="notifyAll()" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="toString()" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="wait()" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="wait(long)" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="wait(long, int)" class="external-link">wait</a></code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
<li>
|
|
<section class="field-details" id="field-detail">
|
|
<h2>Field Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="INSTANCE">
|
|
<h3>INSTANCE</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="GoogleSearchTool.html" title="class in com.google.adk.tools">GoogleSearchTool</a></span> <span class="element-name">INSTANCE</span></div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li>
|
|
<section class="constructor-details" id="constructor-detail">
|
|
<h2>Constructor Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="<init>()">
|
|
<h3>GoogleSearchTool</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">GoogleSearchTool</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="processLlmRequest(com.google.adk.models.LlmRequest.Builder,com.google.adk.tools.ToolContext)">
|
|
<h3>processLlmRequest</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">io.reactivex.rxjava3.core.Completable</span> <span class="element-name">processLlmRequest</span><wbr><span class="parameters">(<a href="../models/LlmRequest.Builder.html" title="class in com.google.adk.models">LlmRequest.Builder</a> llmRequestBuilder,
|
|
<a href="ToolContext.html" title="class in com.google.adk.tools">ToolContext</a> toolContext)</span></div>
|
|
<div class="block"><span class="description-from-type-label">Description copied from class: <code><a href="BaseTool.html#processLlmRequest(com.google.adk.models.LlmRequest.Builder,com.google.adk.tools.ToolContext)">BaseTool</a></code></span></div>
|
|
<div class="block">Processes the outgoing <a href="../models/LlmRequest.Builder.html" title="class in com.google.adk.models"><code>LlmRequest.Builder</code></a>.
|
|
|
|
<p>This implementation adds the current tool's <a href="BaseTool.html#declaration()"><code>BaseTool.declaration()</code></a> to the <code>GenerateContentConfig</code> within the builder. If a tool with function declarations already exists,
|
|
the current tool's declaration is merged into it. Otherwise, a new tool definition with the
|
|
current tool's declaration is created. The current tool itself is also added to the builder's
|
|
internal list of tools. Override this method for processing the outgoing request.</div>
|
|
<dl class="notes">
|
|
<dt>Overrides:</dt>
|
|
<dd><code><a href="BaseTool.html#processLlmRequest(com.google.adk.models.LlmRequest.Builder,com.google.adk.tools.ToolContext)">processLlmRequest</a></code> in class <code><a href="BaseTool.html" title="class in com.google.adk.tools">BaseTool</a></code></dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<footer>
|
|
<hr>
|
|
<p class="legal-copy"><small>Copyright © 1980. All rights reserved.</small></p>
|
|
</footer>
|
|
</main>
|
|
</div>
|
|
</body>
|
|
</html>
|