mirror of
https://github.com/google/adk-docs.git
synced 2026-09-14 16:16:59 +08:00
Maciej Szwaja
199 lines
13 KiB
HTML
199 lines
13 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>Planner (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, interface: Planner">
|
|
<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/Planner.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="Planner.html" class="current-selection">Planner</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="#method-summary" tabindex="0">Method Summary</a></li>
|
|
<li><a href="#method-detail" tabindex="0">Method Details</a>
|
|
<ol class="toc-list">
|
|
<li><a href="#init(com.google.adk.agents.PlanningContext)" tabindex="0">init(PlanningContext)</a></li>
|
|
<li><a href="#firstAction(com.google.adk.agents.PlanningContext)" tabindex="0">firstAction(PlanningContext)</a></li>
|
|
<li><a href="#nextAction(com.google.adk.agents.PlanningContext)" tabindex="0">nextAction(PlanningContext)</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="Interface Planner" class="title">Interface Planner</h1>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>All Known Implementing Classes:</dt>
|
|
<dd><code><a href="../planner/goap/GoalOrientedPlanner.html" title="class in com.google.adk.planner.goap">GoalOrientedPlanner</a>, <a href="../planner/LoopPlanner.html" title="class in com.google.adk.planner">LoopPlanner</a>, <a href="../planner/p2p/P2PPlanner.html" title="class in com.google.adk.planner.p2p">P2PPlanner</a>, <a href="../planner/ParallelPlanner.html" title="class in com.google.adk.planner">ParallelPlanner</a>, <a href="../planner/SequentialPlanner.html" title="class in com.google.adk.planner">SequentialPlanner</a>, <a href="../planner/SupervisorPlanner.html" title="class in com.google.adk.planner">SupervisorPlanner</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="horizontal-scroll">
|
|
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Planner</span></div>
|
|
<div class="block">Strategy interface for planning which sub-agent(s) to execute next.
|
|
|
|
<p>A <code>Planner</code> is used by <a href="PlannerAgent.html" title="class in com.google.adk.agents"><code>PlannerAgent</code></a> to dynamically determine execution order at
|
|
runtime. The planning loop works as follows:
|
|
|
|
<ol>
|
|
<li><a href="#init(com.google.adk.agents.PlanningContext)"><code>init(PlanningContext)</code></a> is called once before the loop starts
|
|
<li><a href="#firstAction(com.google.adk.agents.PlanningContext)"><code>firstAction(PlanningContext)</code></a> returns the first action to execute
|
|
<li>The selected agent(s) execute, producing events and updating session state
|
|
<li><a href="#nextAction(com.google.adk.agents.PlanningContext)"><code>nextAction(PlanningContext)</code></a> is called with updated context to decide what to do next
|
|
<li>Steps 3-4 repeat until <a href="PlannerAction.Done.html" title="class in com.google.adk.agents"><code>PlannerAction.Done</code></a> or max iterations
|
|
</ol>
|
|
|
|
<p>Returns <code>Single</code><code><PlannerAction></code> to support both synchronous planners (wrap in
|
|
<code>Single.just()</code>) and asynchronous planners that call an LLM.</div>
|
|
</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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-tab3"><code>io.reactivex.rxjava3.core.Single<wbr><<a href="PlannerAction.html" title="interface in com.google.adk.agents">PlannerAction</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#firstAction(com.google.adk.agents.PlanningContext)" class="member-name-link">firstAction</a><wbr>(<a href="PlanningContext.html" title="class in com.google.adk.agents">PlanningContext</a> context)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Select the first action to execute.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#init(com.google.adk.agents.PlanningContext)" class="member-name-link">init</a><wbr>(<a href="PlanningContext.html" title="class in com.google.adk.agents">PlanningContext</a> context)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
|
|
<div class="block">Initialize the planner with context and available agents.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>io.reactivex.rxjava3.core.Single<wbr><<a href="PlannerAction.html" title="interface in com.google.adk.agents">PlannerAction</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#nextAction(com.google.adk.agents.PlanningContext)" class="member-name-link">nextAction</a><wbr>(<a href="PlanningContext.html" title="class in com.google.adk.agents">PlanningContext</a> context)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Select the next action based on updated state and events.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="init(com.google.adk.agents.PlanningContext)">
|
|
<h3>init</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">void</span> <span class="element-name">init</span><wbr><span class="parameters">(<a href="PlanningContext.html" title="class in com.google.adk.agents">PlanningContext</a> context)</span></div>
|
|
<div class="block">Initialize the planner with context and available agents. Called once before the planning loop
|
|
starts.
|
|
|
|
<p>Default implementation is a no-op. Override to perform setup like building dependency
|
|
graphs.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="firstAction(com.google.adk.agents.PlanningContext)">
|
|
<h3>firstAction</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="return-type">io.reactivex.rxjava3.core.Single<<a href="PlannerAction.html" title="interface in com.google.adk.agents">PlannerAction</a>></span> <span class="element-name">firstAction</span><wbr><span class="parameters">(<a href="PlanningContext.html" title="class in com.google.adk.agents">PlanningContext</a> context)</span></div>
|
|
<div class="block">Select the first action to execute.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="nextAction(com.google.adk.agents.PlanningContext)">
|
|
<h3>nextAction</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="return-type">io.reactivex.rxjava3.core.Single<<a href="PlannerAction.html" title="interface in com.google.adk.agents">PlannerAction</a>></span> <span class="element-name">nextAction</span><wbr><span class="parameters">(<a href="PlanningContext.html" title="class in com.google.adk.agents">PlanningContext</a> context)</span></div>
|
|
<div class="block">Select the next action based on updated state and events.</div>
|
|
</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>
|