mirror of
https://github.com/google/adk-docs.git
synced 2026-09-14 16:16:59 +08:00
901 lines
83 KiB
HTML
901 lines
83 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>LlmAgent (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.agents, class: LlmAgent">
|
|
<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/LlmAgent.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.agents</a></li>
|
|
<li><a href="LlmAgent.html" class="current-selection">LlmAgent</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="#constructor-summary" tabindex="0">Constructor Summary</a></li>
|
|
<li><a href="#method-summary" tabindex="0">Method Summary</a>
|
|
<ol class="toc-list">
|
|
<li><a href="#methods-inherited-from-class-com.google.adk.agents.BaseAgent" tabindex="0">Methods inherited from class BaseAgent</a></li>
|
|
<li><a href="#methods-inherited-from-class-java.lang.Object" tabindex="0">Methods inherited from class Object</a></li>
|
|
</ol>
|
|
</li>
|
|
<li><a href="#constructor-detail" tabindex="0">Constructor Details</a>
|
|
<ol class="toc-list">
|
|
<li><a href="#%3Cinit%3E(com.google.adk.agents.LlmAgent.Builder)" tabindex="0">LlmAgent(LlmAgent.Builder)</a></li>
|
|
</ol>
|
|
</li>
|
|
<li><a href="#method-detail" tabindex="0">Method Details</a>
|
|
<ol class="toc-list">
|
|
<li><a href="#builder()" tabindex="0">builder()</a></li>
|
|
<li><a href="#determineLlmFlow()" tabindex="0">determineLlmFlow()</a></li>
|
|
<li><a href="#runAsyncImpl(com.google.adk.agents.InvocationContext)" tabindex="0">runAsyncImpl(InvocationContext)</a></li>
|
|
<li><a href="#runLiveImpl(com.google.adk.agents.InvocationContext)" tabindex="0">runLiveImpl(InvocationContext)</a></li>
|
|
<li><a href="#canonicalInstruction(com.google.adk.agents.ReadonlyContext)" tabindex="0">canonicalInstruction(ReadonlyContext)</a></li>
|
|
<li><a href="#canonicalGlobalInstruction(com.google.adk.agents.ReadonlyContext)" tabindex="0">canonicalGlobalInstruction(ReadonlyContext)</a></li>
|
|
<li><a href="#canonicalTools()" tabindex="0">canonicalTools()</a></li>
|
|
<li><a href="#canonicalTools(com.google.adk.agents.ReadonlyContext)" tabindex="0">canonicalTools(ReadonlyContext)</a></li>
|
|
<li><a href="#instruction()" tabindex="0">instruction()</a></li>
|
|
<li><a href="#globalInstruction()" tabindex="0">globalInstruction()</a></li>
|
|
<li><a href="#model()" tabindex="0">model()</a></li>
|
|
<li><a href="#planning()" tabindex="0">planning()</a></li>
|
|
<li><a href="#maxSteps()" tabindex="0">maxSteps()</a></li>
|
|
<li><a href="#generateContentConfig()" tabindex="0">generateContentConfig()</a></li>
|
|
<li><a href="#includeContents()" tabindex="0">includeContents()</a></li>
|
|
<li><a href="#tools()" tabindex="0">tools()</a></li>
|
|
<li><a href="#toolsUnion()" tabindex="0">toolsUnion()</a></li>
|
|
<li><a href="#toolsets()" tabindex="0">toolsets()</a></li>
|
|
<li><a href="#disallowTransferToParent()" tabindex="0">disallowTransferToParent()</a></li>
|
|
<li><a href="#disallowTransferToPeers()" tabindex="0">disallowTransferToPeers()</a></li>
|
|
<li><a href="#beforeModelCallback()" tabindex="0">beforeModelCallback()</a></li>
|
|
<li><a href="#afterModelCallback()" tabindex="0">afterModelCallback()</a></li>
|
|
<li><a href="#beforeToolCallback()" tabindex="0">beforeToolCallback()</a></li>
|
|
<li><a href="#afterToolCallback()" tabindex="0">afterToolCallback()</a></li>
|
|
<li><a href="#onModelErrorCallback()" tabindex="0">onModelErrorCallback()</a></li>
|
|
<li><a href="#onToolErrorCallback()" tabindex="0">onToolErrorCallback()</a></li>
|
|
<li><a href="#canonicalBeforeModelCallbacks()" tabindex="0">canonicalBeforeModelCallbacks()</a></li>
|
|
<li><a href="#canonicalAfterModelCallbacks()" tabindex="0">canonicalAfterModelCallbacks()</a></li>
|
|
<li><a href="#canonicalOnModelErrorCallbacks()" tabindex="0">canonicalOnModelErrorCallbacks()</a></li>
|
|
<li><a href="#canonicalBeforeToolCallbacks()" tabindex="0">canonicalBeforeToolCallbacks()</a></li>
|
|
<li><a href="#canonicalAfterToolCallbacks()" tabindex="0">canonicalAfterToolCallbacks()</a></li>
|
|
<li><a href="#canonicalOnToolErrorCallbacks()" tabindex="0">canonicalOnToolErrorCallbacks()</a></li>
|
|
<li><a href="#inputSchema()" tabindex="0">inputSchema()</a></li>
|
|
<li><a href="#outputSchema()" tabindex="0">outputSchema()</a></li>
|
|
<li><a href="#executor()" tabindex="0">executor()</a></li>
|
|
<li><a href="#outputKey()" tabindex="0">outputKey()</a></li>
|
|
<li><a href="#codeExecutor()" tabindex="0">codeExecutor()</a></li>
|
|
<li><a href="#resolvedModel()" tabindex="0">resolvedModel()</a></li>
|
|
<li><a href="#fromConfig(com.google.adk.agents.LlmAgentConfig,java.lang.String)" tabindex="0">fromConfig(LlmAgentConfig, String)</a></li>
|
|
<li><a href="#close()" tabindex="0">close()</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 LlmAgent" class="title">Class LlmAgent</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="BaseAgent.html" title="class in com.google.adk.agents">com.google.adk.agents.BaseAgent</a>
|
|
<div class="inheritance">com.google.adk.agents.LlmAgent</div>
|
|
</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<hr>
|
|
<div class="horizontal-scroll">
|
|
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">LlmAgent</span>
|
|
<span class="extends-implements">extends <a href="BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a></span></div>
|
|
<div class="block">The LLM-based agent.</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="caption"><span>Nested Classes</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">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="LlmAgent.Builder.html" class="type-name-link" title="class in com.google.adk.agents">LlmAgent.Builder</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Builder for <a href="LlmAgent.html" title="class in com.google.adk.agents"><code>LlmAgent</code></a>.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static enum </code></div>
|
|
<div class="col-second odd-row-color"><code><a href="LlmAgent.IncludeContents.html" class="type-name-link" title="enum class in com.google.adk.agents">LlmAgent.IncludeContents</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Enum to define if contents of previous events should be included in requests to the underlying
|
|
LLM.</div>
|
|
</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 three-column-summary">
|
|
<div class="table-header col-first">Modifier</div>
|
|
<div class="table-header col-second">Constructor</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code>protected </code></div>
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(com.google.adk.agents.LlmAgent.Builder)" class="member-name-link">LlmAgent</a><wbr>(<a href="LlmAgent.Builder.html" title="class in com.google.adk.agents">LlmAgent.Builder</a> builder)</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><wbr><? extends <a href="Callbacks.AfterModelCallback.html" title="interface in com.google.adk.agents">Callbacks.AfterModelCallback</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#afterModelCallback()" class="member-name-link">afterModelCallback</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><wbr><? extends <a href="Callbacks.AfterToolCallback.html" title="interface in com.google.adk.agents">Callbacks.AfterToolCallback</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#afterToolCallback()" class="member-name-link">afterToolCallback</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><wbr><? extends <a href="Callbacks.BeforeModelCallback.html" title="interface in com.google.adk.agents">Callbacks.BeforeModelCallback</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#beforeModelCallback()" class="member-name-link">beforeModelCallback</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><wbr><? extends <a href="Callbacks.BeforeToolCallback.html" title="interface in com.google.adk.agents">Callbacks.BeforeToolCallback</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#beforeToolCallback()" class="member-name-link">beforeToolCallback</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="LlmAgent.Builder.html" title="class in com.google.adk.agents">LlmAgent.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#builder()" class="member-name-link">builder</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Returns a <a href="LlmAgent.Builder.html" title="class in com.google.adk.agents"><code>LlmAgent.Builder</code></a> for <a href="LlmAgent.html" title="class in com.google.adk.agents"><code>LlmAgent</code></a>.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><wbr><? extends <a href="Callbacks.AfterModelCallback.html" title="interface in com.google.adk.agents">Callbacks.AfterModelCallback</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#canonicalAfterModelCallbacks()" class="member-name-link">canonicalAfterModelCallbacks</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">The resolved afterModelCallback field as a list.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><wbr><? extends <a href="Callbacks.AfterToolCallback.html" title="interface in com.google.adk.agents">Callbacks.AfterToolCallback</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#canonicalAfterToolCallbacks()" class="member-name-link">canonicalAfterToolCallbacks</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">The resolved afterToolCallback field as a list.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><wbr><? extends <a href="Callbacks.BeforeModelCallback.html" title="interface in com.google.adk.agents">Callbacks.BeforeModelCallback</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#canonicalBeforeModelCallbacks()" class="member-name-link">canonicalBeforeModelCallbacks</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">The resolved beforeModelCallback field as a list.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><wbr><? extends <a href="Callbacks.BeforeToolCallback.html" title="interface in com.google.adk.agents">Callbacks.BeforeToolCallback</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#canonicalBeforeToolCallbacks()" class="member-name-link">canonicalBeforeToolCallbacks</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">The resolved beforeToolCallback field as a list.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>io.reactivex.rxjava3.core.Single<wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.Entry.html" title="interface in java.util" class="external-link">Map.Entry</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/Boolean.html" title="class in java.lang" class="external-link">Boolean</a>>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#canonicalGlobalInstruction(com.google.adk.agents.ReadonlyContext)" class="member-name-link">canonicalGlobalInstruction</a><wbr>(<a href="ReadonlyContext.html" title="class in com.google.adk.agents">ReadonlyContext</a> context)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Constructs the text global instruction for this agent based on the <code>globalInstruction</code>
|
|
field.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>io.reactivex.rxjava3.core.Single<wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.Entry.html" title="interface in java.util" class="external-link">Map.Entry</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/Boolean.html" title="class in java.lang" class="external-link">Boolean</a>>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#canonicalInstruction(com.google.adk.agents.ReadonlyContext)" class="member-name-link">canonicalInstruction</a><wbr>(<a href="ReadonlyContext.html" title="class in com.google.adk.agents">ReadonlyContext</a> context)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Constructs the text instruction for this agent based on the <code>instruction</code> field.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><wbr><? extends <a href="Callbacks.OnModelErrorCallback.html" title="interface in com.google.adk.agents">Callbacks.OnModelErrorCallback</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#canonicalOnModelErrorCallbacks()" class="member-name-link">canonicalOnModelErrorCallbacks</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">The resolved onModelErrorCallback field as a list.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><wbr><? extends <a href="Callbacks.OnToolErrorCallback.html" title="interface in com.google.adk.agents">Callbacks.OnToolErrorCallback</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#canonicalOnToolErrorCallbacks()" class="member-name-link">canonicalOnToolErrorCallbacks</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">The resolved onToolErrorCallback field as a list.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>io.reactivex.rxjava3.core.Flowable<wbr><<a href="../tools/BaseTool.html" title="class in com.google.adk.tools">BaseTool</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#canonicalTools()" class="member-name-link">canonicalTools</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Constructs the list of tools for this agent based on the <a href="#tools()"><code>tools()</code></a> field.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>io.reactivex.rxjava3.core.Flowable<wbr><<a href="../tools/BaseTool.html" title="class in com.google.adk.tools">BaseTool</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#canonicalTools(com.google.adk.agents.ReadonlyContext)" class="member-name-link">canonicalTools</a><wbr>(@Nullable <a href="ReadonlyContext.html" title="class in com.google.adk.agents">ReadonlyContext</a> context)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Constructs the list of tools for this agent based on the <a href="#tools()"><code>tools()</code></a> field.</div>
|
|
</div>
|
|
<div class="col-first odd-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close()" class="member-name-link">close</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Closes all sub-agents.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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><<a href="../codeexecutors/BaseCodeExecutor.html" title="class in com.google.adk.codeexecutors">BaseCodeExecutor</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#codeExecutor()" class="member-name-link">codeExecutor</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../flows/llmflows/BaseLlmFlow.html" title="class in com.google.adk.flows.llmflows">BaseLlmFlow</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#determineLlmFlow()" class="member-name-link">determineLlmFlow</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#disallowTransferToParent()" class="member-name-link">disallowTransferToParent</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#disallowTransferToPeers()" class="member-name-link">disallowTransferToPeers</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Executor.html" title="interface in java.util.concurrent" class="external-link">Executor</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#executor()" class="member-name-link">executor</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="LlmAgent.html" title="class in com.google.adk.agents">LlmAgent</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#fromConfig(com.google.adk.agents.LlmAgentConfig,java.lang.String)" class="member-name-link">fromConfig</a><wbr>(<a href="LlmAgentConfig.html" title="class in com.google.adk.agents">LlmAgentConfig</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 method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Creates an LlmAgent from configuration with full subagent support.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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.GenerateContentConfig></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#generateContentConfig()" class="member-name-link">generateContentConfig</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Instruction.html" title="interface in com.google.adk.agents">Instruction</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#globalInstruction()" class="member-name-link">globalInstruction</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LlmAgent.IncludeContents.html" title="enum class in com.google.adk.agents">LlmAgent.IncludeContents</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#includeContents()" class="member-name-link">includeContents</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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.Schema></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#inputSchema()" class="member-name-link">inputSchema</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Instruction.html" title="interface in com.google.adk.agents">Instruction</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#instruction()" class="member-name-link">instruction</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class in java.lang" class="external-link">Integer</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#maxSteps()" class="member-name-link">maxSteps</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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><<a href="../models/Model.html" title="class in com.google.adk.models">Model</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#model()" class="member-name-link">model</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><wbr><? extends <a href="Callbacks.OnModelErrorCallback.html" title="interface in com.google.adk.agents">Callbacks.OnModelErrorCallback</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onModelErrorCallback()" class="member-name-link">onModelErrorCallback</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><wbr><? extends <a href="Callbacks.OnToolErrorCallback.html" title="interface in com.google.adk.agents">Callbacks.OnToolErrorCallback</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onToolErrorCallback()" class="member-name-link">onToolErrorCallback</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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><<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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#outputKey()" class="member-name-link">outputKey</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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.Schema></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#outputSchema()" class="member-name-link">outputSchema</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#planning()" class="member-name-link">planning</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../models/Model.html" title="class in com.google.adk.models">Model</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#resolvedModel()" class="member-name-link">resolvedModel</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected io.reactivex.rxjava3.core.Flowable<wbr><<a href="../events/Event.html" title="class in com.google.adk.events">Event</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#runAsyncImpl(com.google.adk.agents.InvocationContext)" class="member-name-link">runAsyncImpl</a><wbr>(<a href="InvocationContext.html" title="class in com.google.adk.agents">InvocationContext</a> invocationContext)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Agent-specific asynchronous logic.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected io.reactivex.rxjava3.core.Flowable<wbr><<a href="../events/Event.html" title="class in com.google.adk.events">Event</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#runLiveImpl(com.google.adk.agents.InvocationContext)" class="member-name-link">runLiveImpl</a><wbr>(<a href="InvocationContext.html" title="class in com.google.adk.agents">InvocationContext</a> invocationContext)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Agent-specific synchronous logic.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>io.reactivex.rxjava3.core.Single<wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><<a href="../tools/BaseTool.html" title="class in com.google.adk.tools">BaseTool</a>>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#tools()" class="member-name-link">tools</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><wbr><<a href="../tools/BaseToolset.html" title="interface in com.google.adk.tools">BaseToolset</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toolsets()" class="member-name-link">toolsets</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toolsUnion()" class="member-name-link">toolsUnion</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-com.google.adk.agents.BaseAgent">Methods inherited from class <a href="BaseAgent.html#method-summary" title="class in com.google.adk.agents">BaseAgent</a></h3>
|
|
<code><a href="BaseAgent.html#afterAgentCallback()" title="afterAgentCallback()">afterAgentCallback</a>, <a href="BaseAgent.html#beforeAgentCallback()" title="beforeAgentCallback()">beforeAgentCallback</a>, <a href="BaseAgent.html#canonicalAfterAgentCallbacks()" title="canonicalAfterAgentCallbacks()">canonicalAfterAgentCallbacks</a>, <a href="BaseAgent.html#canonicalBeforeAgentCallbacks()" title="canonicalBeforeAgentCallbacks()">canonicalBeforeAgentCallbacks</a>, <a href="BaseAgent.html#description()" title="description()">description</a>, <a href="BaseAgent.html#findAgent(java.lang.String)" title="findAgent(String)">findAgent</a>, <a href="BaseAgent.html#findSubAgent(java.lang.String)" title="findSubAgent(String)">findSubAgent</a>, <a href="BaseAgent.html#fromConfig(com.google.adk.agents.BaseAgentConfig,java.lang.String)" title="fromConfig(BaseAgentConfig, String)">fromConfig</a>, <a href="BaseAgent.html#name()" title="name()">name</a>, <a href="BaseAgent.html#parentAgent()" title="parentAgent()">parentAgent</a>, <a href="BaseAgent.html#parentAgent(com.google.adk.agents.BaseAgent)" title="parentAgent(BaseAgent)">parentAgent</a>, <a href="BaseAgent.html#rootAgent()" title="rootAgent()">rootAgent</a>, <a href="BaseAgent.html#runAsync(com.google.adk.agents.InvocationContext)" title="runAsync(InvocationContext)">runAsync</a>, <a href="BaseAgent.html#runLive(com.google.adk.agents.InvocationContext)" title="runLive(InvocationContext)">runLive</a>, <a href="BaseAgent.html#subAgents()" title="subAgents()">subAgents</a>, <a href="BaseAgent.html#toolOrigin()" title="toolOrigin()">toolOrigin</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.ImmutableList<wbr><? extends <a href="Callbacks.AfterAgentCallback.html" title="interface in com.google.adk.agents">Callbacks.AfterAgentCallback</a>></code></div>
|
|
<div class="col-second even-row-color"><code><a href="BaseAgent.html#afterAgentCallback()" class="member-name-link">afterAgentCallback</a>()</code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
<div class="col-first odd-row-color"><code>com.google.common.collect.ImmutableList<wbr><? extends <a href="Callbacks.BeforeAgentCallback.html" title="interface in com.google.adk.agents">Callbacks.BeforeAgentCallback</a>></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="BaseAgent.html#beforeAgentCallback()" class="member-name-link">beforeAgentCallback</a>()</code></div>
|
|
<div class="col-last odd-row-color"> </div>
|
|
<div class="col-first even-row-color"><code>com.google.common.collect.ImmutableList<wbr><? extends <a href="Callbacks.AfterAgentCallback.html" title="interface in com.google.adk.agents">Callbacks.AfterAgentCallback</a>></code></div>
|
|
<div class="col-second even-row-color"><code><a href="BaseAgent.html#canonicalAfterAgentCallbacks()" class="member-name-link">canonicalAfterAgentCallbacks</a>()</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">The resolved afterAgentCallback field as a list.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>com.google.common.collect.ImmutableList<wbr><? extends <a href="Callbacks.BeforeAgentCallback.html" title="interface in com.google.adk.agents">Callbacks.BeforeAgentCallback</a>></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="BaseAgent.html#canonicalBeforeAgentCallbacks()" class="member-name-link">canonicalBeforeAgentCallbacks</a>()</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">The resolved beforeAgentCallback field as a list.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>final <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="BaseAgent.html#description()" class="member-name-link">description</a>()</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Gets the one-line description of the agent's capability.</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><<a href="BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a>></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="BaseAgent.html#findAgent(java.lang.String)" class="member-name-link">findAgent</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> name)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Finds an agent (this or descendant) by name.</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/util/Optional.html" title="class in java.util" class="external-link">Optional</a><wbr><<a href="BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a>></code></div>
|
|
<div class="col-second even-row-color"><code><a href="BaseAgent.html#findSubAgent(java.lang.String)" class="member-name-link">findSubAgent</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> name)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Recursively search sub agent by name.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static <a href="BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="BaseAgent.html#fromConfig(com.google.adk.agents.BaseAgentConfig,java.lang.String)" class="member-name-link">fromConfig</a><wbr>(<a href="BaseAgentConfig.html" title="class in com.google.adk.agents">BaseAgentConfig</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 new agent instance from a configuration object.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>final <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="BaseAgent.html#name()" class="member-name-link">name</a>()</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Gets the agent's unique name.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="BaseAgent.html#parentAgent()" class="member-name-link">parentAgent</a>()</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Retrieves the parent agent in the agent tree.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>protected void</code></div>
|
|
<div class="col-second even-row-color"><code><a href="BaseAgent.html#parentAgent(com.google.adk.agents.BaseAgent)" class="member-name-link">parentAgent</a><wbr>(<a href="BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a> parentAgent)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Sets the parent agent.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="BaseAgent.html#rootAgent()" class="member-name-link">rootAgent</a>()</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Returns the root agent for this agent by traversing up the parent chain.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>io.reactivex.rxjava3.core.Flowable<wbr><<a href="../events/Event.html" title="class in com.google.adk.events">Event</a>></code></div>
|
|
<div class="col-second even-row-color"><code><a href="BaseAgent.html#runAsync(com.google.adk.agents.InvocationContext)" class="member-name-link">runAsync</a><wbr>(<a href="InvocationContext.html" title="class in com.google.adk.agents">InvocationContext</a> parentContext)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Runs the agent asynchronously.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>io.reactivex.rxjava3.core.Flowable<wbr><<a href="../events/Event.html" title="class in com.google.adk.events">Event</a>></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="BaseAgent.html#runLive(com.google.adk.agents.InvocationContext)" class="member-name-link">runLive</a><wbr>(<a href="InvocationContext.html" title="class in com.google.adk.agents">InvocationContext</a> parentContext)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Runs the agent synchronously.</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/util/List.html" title="interface in java.util" class="external-link">List</a><wbr><? extends <a href="BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a>></code></div>
|
|
<div class="col-second even-row-color"><code><a href="BaseAgent.html#subAgents()" class="member-name-link">subAgents</a>()</code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
<div class="col-first odd-row-color"><code><a href="../utils/AgentEnums.AgentOrigin.html" title="enum class in com.google.adk.utils">AgentEnums.AgentOrigin</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="BaseAgent.html#toolOrigin()" class="member-name-link">toolOrigin</a>()</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Returns the origin of the tool when this agent is used as a tool.</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">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li>
|
|
<section class="constructor-details" id="constructor-detail">
|
|
<h2>Constructor Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="<init>(com.google.adk.agents.LlmAgent.Builder)">
|
|
<h3>LlmAgent</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">LlmAgent</span><wbr><span class="parameters">(<a href="LlmAgent.Builder.html" title="class in com.google.adk.agents">LlmAgent.Builder</a> builder)</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="builder()">
|
|
<h3>builder</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="LlmAgent.Builder.html" title="class in com.google.adk.agents">LlmAgent.Builder</a></span> <span class="element-name">builder</span>()</div>
|
|
<div class="block">Returns a <a href="LlmAgent.Builder.html" title="class in com.google.adk.agents"><code>LlmAgent.Builder</code></a> for <a href="LlmAgent.html" title="class in com.google.adk.agents"><code>LlmAgent</code></a>.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="determineLlmFlow()">
|
|
<h3>determineLlmFlow</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../flows/llmflows/BaseLlmFlow.html" title="class in com.google.adk.flows.llmflows">BaseLlmFlow</a></span> <span class="element-name">determineLlmFlow</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="runAsyncImpl(com.google.adk.agents.InvocationContext)">
|
|
<h3>runAsyncImpl</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">io.reactivex.rxjava3.core.Flowable<<a href="../events/Event.html" title="class in com.google.adk.events">Event</a>></span> <span class="element-name">runAsyncImpl</span><wbr><span class="parameters">(<a href="InvocationContext.html" title="class in com.google.adk.agents">InvocationContext</a> invocationContext)</span></div>
|
|
<div class="block"><span class="description-from-type-label">Description copied from class: <code><a href="BaseAgent.html#runAsyncImpl(com.google.adk.agents.InvocationContext)">BaseAgent</a></code></span></div>
|
|
<div class="block">Agent-specific asynchronous logic.</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="BaseAgent.html#runAsyncImpl(com.google.adk.agents.InvocationContext)">runAsyncImpl</a></code> in class <code><a href="BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a></code></dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>invocationContext</code> - Current invocation context.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>stream of agent-generated events.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="runLiveImpl(com.google.adk.agents.InvocationContext)">
|
|
<h3>runLiveImpl</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">io.reactivex.rxjava3.core.Flowable<<a href="../events/Event.html" title="class in com.google.adk.events">Event</a>></span> <span class="element-name">runLiveImpl</span><wbr><span class="parameters">(<a href="InvocationContext.html" title="class in com.google.adk.agents">InvocationContext</a> invocationContext)</span></div>
|
|
<div class="block"><span class="description-from-type-label">Description copied from class: <code><a href="BaseAgent.html#runLiveImpl(com.google.adk.agents.InvocationContext)">BaseAgent</a></code></span></div>
|
|
<div class="block">Agent-specific synchronous logic.</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="BaseAgent.html#runLiveImpl(com.google.adk.agents.InvocationContext)">runLiveImpl</a></code> in class <code><a href="BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a></code></dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>invocationContext</code> - Current invocation context.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>stream of agent-generated events.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="canonicalInstruction(com.google.adk.agents.ReadonlyContext)">
|
|
<h3>canonicalInstruction</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">io.reactivex.rxjava3.core.Single<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.Entry.html" title="interface in java.util" class="external-link">Map.Entry</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/Boolean.html" title="class in java.lang" class="external-link">Boolean</a>>></span> <span class="element-name">canonicalInstruction</span><wbr><span class="parameters">(<a href="ReadonlyContext.html" title="class in com.google.adk.agents">ReadonlyContext</a> context)</span></div>
|
|
<div class="block">Constructs the text instruction for this agent based on the <code>instruction</code> field. Also
|
|
returns a boolean indicating that state injection should be bypassed when the instruction is
|
|
constructed with an <a href="Instruction.Provider.html" title="class in com.google.adk.agents"><code>Instruction.Provider</code></a>.
|
|
|
|
<p>This method is only for use by Agent Development Kit.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>context</code> - The context to retrieve the session state.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The resolved instruction as a <code>Single</code> wrapped Map.Entry. The key is the
|
|
instruction string and the value is a boolean indicating if state injection should be
|
|
bypassed.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="canonicalGlobalInstruction(com.google.adk.agents.ReadonlyContext)">
|
|
<h3>canonicalGlobalInstruction</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">io.reactivex.rxjava3.core.Single<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.Entry.html" title="interface in java.util" class="external-link">Map.Entry</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/Boolean.html" title="class in java.lang" class="external-link">Boolean</a>>></span> <span class="element-name">canonicalGlobalInstruction</span><wbr><span class="parameters">(<a href="ReadonlyContext.html" title="class in com.google.adk.agents">ReadonlyContext</a> context)</span></div>
|
|
<div class="block">Constructs the text global instruction for this agent based on the <code>globalInstruction</code>
|
|
field. Also returns a boolean indicating that state injection should be bypassed when the
|
|
instruction is constructed with an <a href="Instruction.Provider.html" title="class in com.google.adk.agents"><code>Instruction.Provider</code></a>.
|
|
|
|
<p>This method is only for use by Agent Development Kit.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>context</code> - The context to retrieve the session state.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The resolved global instruction as a <code>Single</code> wrapped Map.Entry. The key is the
|
|
instruction string and the value is a boolean indicating if state injection should be
|
|
bypassed.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="canonicalTools()">
|
|
<h3>canonicalTools</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">io.reactivex.rxjava3.core.Flowable<<a href="../tools/BaseTool.html" title="class in com.google.adk.tools">BaseTool</a>></span> <span class="element-name">canonicalTools</span>()</div>
|
|
<div class="block">Constructs the list of tools for this agent based on the <a href="#tools()"><code>tools()</code></a> field.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>The resolved list of tools as a <code>Single</code> wrapped list of <a href="../tools/BaseTool.html" title="class in com.google.adk.tools"><code>BaseTool</code></a>.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="canonicalTools(com.google.adk.agents.ReadonlyContext)">
|
|
<h3>canonicalTools</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">io.reactivex.rxjava3.core.Flowable<<a href="../tools/BaseTool.html" title="class in com.google.adk.tools">BaseTool</a>></span> <span class="element-name">canonicalTools</span><wbr><span class="parameters">(@Nullable <a href="ReadonlyContext.html" title="class in com.google.adk.agents">ReadonlyContext</a> context)</span></div>
|
|
<div class="block">Constructs the list of tools for this agent based on the <a href="#tools()"><code>tools()</code></a> field.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>context</code> - The context to retrieve the session state.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The resolved list of tools as a <code>Single</code> wrapped list of <a href="../tools/BaseTool.html" title="class in com.google.adk.tools"><code>BaseTool</code></a>.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="instruction()">
|
|
<h3>instruction</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Instruction.html" title="interface in com.google.adk.agents">Instruction</a></span> <span class="element-name">instruction</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="globalInstruction()">
|
|
<h3>globalInstruction</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Instruction.html" title="interface in com.google.adk.agents">Instruction</a></span> <span class="element-name">globalInstruction</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="model()">
|
|
<h3>model</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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><<a href="../models/Model.html" title="class in com.google.adk.models">Model</a>></span> <span class="element-name">model</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="planning()">
|
|
<h3>planning</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">planning</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="maxSteps()">
|
|
<h3>maxSteps</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class in java.lang" class="external-link">Integer</a>></span> <span class="element-name">maxSteps</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="generateContentConfig()">
|
|
<h3>generateContentConfig</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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><com.google.genai.types.GenerateContentConfig></span> <span class="element-name">generateContentConfig</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="includeContents()">
|
|
<h3>includeContents</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LlmAgent.IncludeContents.html" title="enum class in com.google.adk.agents">LlmAgent.IncludeContents</a></span> <span class="element-name">includeContents</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="tools()">
|
|
<h3>tools</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">io.reactivex.rxjava3.core.Single<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><<a href="../tools/BaseTool.html" title="class in com.google.adk.tools">BaseTool</a>>></span> <span class="element-name">tools</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="toolsUnion()">
|
|
<h3>toolsUnion</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><<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>></span> <span class="element-name">toolsUnion</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="toolsets()">
|
|
<h3>toolsets</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><<a href="../tools/BaseToolset.html" title="interface in com.google.adk.tools">BaseToolset</a>></span> <span class="element-name">toolsets</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="disallowTransferToParent()">
|
|
<h3>disallowTransferToParent</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">disallowTransferToParent</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="disallowTransferToPeers()">
|
|
<h3>disallowTransferToPeers</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">disallowTransferToPeers</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="beforeModelCallback()">
|
|
<h3>beforeModelCallback</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><? extends <a href="Callbacks.BeforeModelCallback.html" title="interface in com.google.adk.agents">Callbacks.BeforeModelCallback</a>></span> <span class="element-name">beforeModelCallback</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="afterModelCallback()">
|
|
<h3>afterModelCallback</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><? extends <a href="Callbacks.AfterModelCallback.html" title="interface in com.google.adk.agents">Callbacks.AfterModelCallback</a>></span> <span class="element-name">afterModelCallback</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="beforeToolCallback()">
|
|
<h3>beforeToolCallback</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><? extends <a href="Callbacks.BeforeToolCallback.html" title="interface in com.google.adk.agents">Callbacks.BeforeToolCallback</a>></span> <span class="element-name">beforeToolCallback</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="afterToolCallback()">
|
|
<h3>afterToolCallback</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><? extends <a href="Callbacks.AfterToolCallback.html" title="interface in com.google.adk.agents">Callbacks.AfterToolCallback</a>></span> <span class="element-name">afterToolCallback</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="onModelErrorCallback()">
|
|
<h3>onModelErrorCallback</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><? extends <a href="Callbacks.OnModelErrorCallback.html" title="interface in com.google.adk.agents">Callbacks.OnModelErrorCallback</a>></span> <span class="element-name">onModelErrorCallback</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="onToolErrorCallback()">
|
|
<h3>onToolErrorCallback</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><? extends <a href="Callbacks.OnToolErrorCallback.html" title="interface in com.google.adk.agents">Callbacks.OnToolErrorCallback</a>></span> <span class="element-name">onToolErrorCallback</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="canonicalBeforeModelCallbacks()">
|
|
<h3>canonicalBeforeModelCallbacks</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><? extends <a href="Callbacks.BeforeModelCallback.html" title="interface in com.google.adk.agents">Callbacks.BeforeModelCallback</a>></span> <span class="element-name">canonicalBeforeModelCallbacks</span>()</div>
|
|
<div class="block">The resolved beforeModelCallback field as a list.
|
|
|
|
<p>This method is only for use by Agent Development Kit.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="canonicalAfterModelCallbacks()">
|
|
<h3>canonicalAfterModelCallbacks</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><? extends <a href="Callbacks.AfterModelCallback.html" title="interface in com.google.adk.agents">Callbacks.AfterModelCallback</a>></span> <span class="element-name">canonicalAfterModelCallbacks</span>()</div>
|
|
<div class="block">The resolved afterModelCallback field as a list.
|
|
|
|
<p>This method is only for use by Agent Development Kit.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="canonicalOnModelErrorCallbacks()">
|
|
<h3>canonicalOnModelErrorCallbacks</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><? extends <a href="Callbacks.OnModelErrorCallback.html" title="interface in com.google.adk.agents">Callbacks.OnModelErrorCallback</a>></span> <span class="element-name">canonicalOnModelErrorCallbacks</span>()</div>
|
|
<div class="block">The resolved onModelErrorCallback field as a list.
|
|
|
|
<p>This method is only for use by Agent Development Kit.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="canonicalBeforeToolCallbacks()">
|
|
<h3>canonicalBeforeToolCallbacks</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><? extends <a href="Callbacks.BeforeToolCallback.html" title="interface in com.google.adk.agents">Callbacks.BeforeToolCallback</a>></span> <span class="element-name">canonicalBeforeToolCallbacks</span>()</div>
|
|
<div class="block">The resolved beforeToolCallback field as a list.
|
|
|
|
<p>This method is only for use by Agent Development Kit.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="canonicalAfterToolCallbacks()">
|
|
<h3>canonicalAfterToolCallbacks</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><? extends <a href="Callbacks.AfterToolCallback.html" title="interface in com.google.adk.agents">Callbacks.AfterToolCallback</a>></span> <span class="element-name">canonicalAfterToolCallbacks</span>()</div>
|
|
<div class="block">The resolved afterToolCallback field as a list.
|
|
|
|
<p>This method is only for use by Agent Development Kit.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="canonicalOnToolErrorCallbacks()">
|
|
<h3>canonicalOnToolErrorCallbacks</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><? extends <a href="Callbacks.OnToolErrorCallback.html" title="interface in com.google.adk.agents">Callbacks.OnToolErrorCallback</a>></span> <span class="element-name">canonicalOnToolErrorCallbacks</span>()</div>
|
|
<div class="block">The resolved onToolErrorCallback field as a list.
|
|
|
|
<p>This method is only for use by Agent Development Kit.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="inputSchema()">
|
|
<h3>inputSchema</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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><com.google.genai.types.Schema></span> <span class="element-name">inputSchema</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="outputSchema()">
|
|
<h3>outputSchema</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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><com.google.genai.types.Schema></span> <span class="element-name">outputSchema</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="executor()">
|
|
<h3>executor</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Executor.html" title="interface in java.util.concurrent" class="external-link">Executor</a>></span> <span class="element-name">executor</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="outputKey()">
|
|
<h3>outputKey</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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><<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>></span> <span class="element-name">outputKey</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="codeExecutor()">
|
|
<h3>codeExecutor</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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><<a href="../codeexecutors/BaseCodeExecutor.html" title="class in com.google.adk.codeexecutors">BaseCodeExecutor</a>></span> <span class="element-name">codeExecutor</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="resolvedModel()">
|
|
<h3>resolvedModel</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../models/Model.html" title="class in com.google.adk.models">Model</a></span> <span class="element-name">resolvedModel</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="fromConfig(com.google.adk.agents.LlmAgentConfig,java.lang.String)">
|
|
<h3>fromConfig</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="LlmAgent.html" title="class in com.google.adk.agents">LlmAgent</a></span> <span class="element-name">fromConfig</span><wbr><span class="parameters">(<a href="LlmAgentConfig.html" title="class in com.google.adk.agents">LlmAgentConfig</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)</span>
|
|
throws <span class="exceptions"><a href="ConfigAgentUtils.ConfigurationException.html" title="class in com.google.adk.agents">ConfigAgentUtils.ConfigurationException</a></span></div>
|
|
<div class="block">Creates an LlmAgent from configuration with full subagent support.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>config</code> - the agent configuration</dd>
|
|
<dd><code>configAbsPath</code> - The absolute path to the agent config file. This is needed for resolving
|
|
relative paths for e.g. tools and subagents.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>the configured LlmAgent</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="ConfigAgentUtils.ConfigurationException.html" title="class in com.google.adk.agents">ConfigAgentUtils.ConfigurationException</a></code> - if the configuration is invalid</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="close()">
|
|
<h3>close</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">close</span>()</div>
|
|
<div class="block"><span class="description-from-type-label">Description copied from class: <code><a href="BaseAgent.html#close()">BaseAgent</a></code></span></div>
|
|
<div class="block">Closes all sub-agents.</div>
|
|
<dl class="notes">
|
|
<dt>Overrides:</dt>
|
|
<dd><code><a href="BaseAgent.html#close()">close</a></code> in class <code><a href="BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a></code></dd>
|
|
<dt>Returns:</dt>
|
|
<dd>a <code>Completable</code> that completes when all sub-agents are closed.</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>
|