mirror of
https://github.com/google/adk-docs.git
synced 2026-09-14 16:16:59 +08:00
697 lines
70 KiB
HTML
697 lines
70 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>Runner (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.runner, class: Runner">
|
|
<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/Runner.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.runner</a></li>
|
|
<li><a href="Runner.html" class="current-selection">Runner</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></li>
|
|
<li><a href="#constructor-detail" tabindex="0">Constructor Details</a>
|
|
<ol class="toc-list">
|
|
<li><a href="#%3Cinit%3E(com.google.adk.agents.BaseAgent,java.lang.String,com.google.adk.artifacts.BaseArtifactService,com.google.adk.sessions.BaseSessionService,com.google.adk.memory.BaseMemoryService)" tabindex="0">Runner(BaseAgent, String, BaseArtifactService, BaseSessionService, BaseMemoryService)</a></li>
|
|
<li><a href="#%3Cinit%3E(com.google.adk.agents.BaseAgent,java.lang.String,com.google.adk.artifacts.BaseArtifactService,com.google.adk.sessions.BaseSessionService,com.google.adk.memory.BaseMemoryService,java.util.List)" tabindex="0">Runner(BaseAgent, String, BaseArtifactService, BaseSessionService, BaseMemoryService, List)</a></li>
|
|
<li><a href="#%3Cinit%3E(com.google.adk.agents.BaseAgent,java.lang.String,com.google.adk.artifacts.BaseArtifactService,com.google.adk.sessions.BaseSessionService,com.google.adk.memory.BaseMemoryService,java.util.List,com.google.adk.summarizer.EventsCompactionConfig,com.google.adk.agents.ContextCacheConfig)" tabindex="0">Runner(BaseAgent, String, BaseArtifactService, BaseSessionService, BaseMemoryService, List, EventsCompactionConfig, ContextCacheConfig)</a></li>
|
|
<li><a href="#%3Cinit%3E(com.google.adk.agents.BaseAgent,java.lang.String,com.google.adk.artifacts.BaseArtifactService,com.google.adk.sessions.BaseSessionService,com.google.adk.memory.BaseMemoryService,java.util.List,com.google.adk.summarizer.EventsCompactionConfig,com.google.adk.agents.ContextCacheConfig,com.google.adk.apps.ResumabilityConfig)" tabindex="0">Runner(BaseAgent, String, BaseArtifactService, BaseSessionService, BaseMemoryService, List, EventsCompactionConfig, ContextCacheConfig, ResumabilityConfig)</a></li>
|
|
<li><a href="#%3Cinit%3E(com.google.adk.agents.BaseAgent,java.lang.String,com.google.adk.artifacts.BaseArtifactService,com.google.adk.sessions.BaseSessionService)" tabindex="0">Runner(BaseAgent, String, BaseArtifactService, BaseSessionService)</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="#agent()" tabindex="0">agent()</a></li>
|
|
<li><a href="#appName()" tabindex="0">appName()</a></li>
|
|
<li><a href="#artifactService()" tabindex="0">artifactService()</a></li>
|
|
<li><a href="#sessionService()" tabindex="0">sessionService()</a></li>
|
|
<li><a href="#memoryService()" tabindex="0">memoryService()</a></li>
|
|
<li><a href="#pluginManager()" tabindex="0">pluginManager()</a></li>
|
|
<li><a href="#close()" tabindex="0">close()</a></li>
|
|
<li><a href="#runAsync(java.lang.String,java.lang.String,com.google.genai.types.Content,com.google.adk.agents.RunConfig)" tabindex="0">runAsync(String, String, Content, RunConfig)</a></li>
|
|
<li><a href="#runAsync(java.lang.String,java.lang.String,com.google.genai.types.Content,com.google.adk.agents.RunConfig,java.util.Map)" tabindex="0">runAsync(String, String, Content, RunConfig, Map)</a></li>
|
|
<li><a href="#runAsync(com.google.adk.sessions.SessionKey,com.google.genai.types.Content,com.google.adk.agents.RunConfig,java.util.Map)" tabindex="0">runAsync(SessionKey, Content, RunConfig, Map)</a></li>
|
|
<li><a href="#runAsync(com.google.adk.sessions.SessionKey,com.google.genai.types.Content,com.google.adk.agents.RunConfig)" tabindex="0">runAsync(SessionKey, Content, RunConfig)</a></li>
|
|
<li><a href="#runAsync(com.google.adk.sessions.SessionKey,com.google.genai.types.Content)" tabindex="0">runAsync(SessionKey, Content)</a></li>
|
|
<li><a href="#runAsync(java.lang.String,java.lang.String,com.google.genai.types.Content)" tabindex="0">runAsync(String, String, Content)</a></li>
|
|
<li><a href="#runAsyncImpl(com.google.adk.sessions.Session,com.google.genai.types.Content,com.google.adk.agents.RunConfig,java.util.Map)" tabindex="0">runAsyncImpl(Session, Content, RunConfig, Map)</a></li>
|
|
<li><a href="#runLive(com.google.adk.sessions.Session,com.google.adk.agents.LiveRequestQueue,com.google.adk.agents.RunConfig)" tabindex="0">runLive(Session, LiveRequestQueue, RunConfig)</a></li>
|
|
<li><a href="#runLive(java.lang.String,java.lang.String,com.google.adk.agents.LiveRequestQueue,com.google.adk.agents.RunConfig)" tabindex="0">runLive(String, String, LiveRequestQueue, RunConfig)</a></li>
|
|
<li><a href="#runLive(com.google.adk.sessions.SessionKey,com.google.adk.agents.LiveRequestQueue,com.google.adk.agents.RunConfig)" tabindex="0">runLive(SessionKey, LiveRequestQueue, RunConfig)</a></li>
|
|
<li><a href="#runLiveImpl(com.google.adk.sessions.Session,com.google.adk.agents.LiveRequestQueue,com.google.adk.agents.RunConfig)" tabindex="0">runLiveImpl(Session, LiveRequestQueue, RunConfig)</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 Runner" class="title">Class Runner</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">com.google.adk.runner.Runner</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>Direct Known Subclasses:</dt>
|
|
<dd><code><a href="FirestoreDatabaseRunner.html" title="class in com.google.adk.runner">FirestoreDatabaseRunner</a>, <a href="InMemoryRunner.html" title="class in com.google.adk.runner">InMemoryRunner</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="horizontal-scroll">
|
|
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Runner</span>
|
|
<span class="extends-implements">extends <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></div>
|
|
<div class="block">The main class for the GenAI Agents runner.</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="Runner.Builder.html" class="type-name-link" title="class in com.google.adk.runner">Runner.Builder</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Builder for <a href="Runner.html" title="class in com.google.adk.runner"><code>Runner</code></a>.</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> </code></div>
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(com.google.adk.agents.BaseAgent,java.lang.String,com.google.adk.artifacts.BaseArtifactService,com.google.adk.sessions.BaseSessionService)" class="member-name-link">Runner</a><wbr>(<a href="../agents/BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a> agent,
|
|
<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> appName,
|
|
<a href="../artifacts/BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a> artifactService,
|
|
<a href="../sessions/BaseSessionService.html" title="interface in com.google.adk.sessions">BaseSessionService</a> sessionService)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">Use <a href="Runner.Builder.html" title="class in com.google.adk.runner"><code>Runner.Builder</code></a> instead.</div>
|
|
</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code> </code></div>
|
|
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(com.google.adk.agents.BaseAgent,java.lang.String,com.google.adk.artifacts.BaseArtifactService,com.google.adk.sessions.BaseSessionService,com.google.adk.memory.BaseMemoryService)" class="member-name-link">Runner</a><wbr>(<a href="../agents/BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a> agent,
|
|
<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> appName,
|
|
<a href="../artifacts/BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a> artifactService,
|
|
<a href="../sessions/BaseSessionService.html" title="interface in com.google.adk.sessions">BaseSessionService</a> sessionService,
|
|
@Nullable <a href="../memory/BaseMemoryService.html" title="interface in com.google.adk.memory">BaseMemoryService</a> memoryService)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">Use <a href="Runner.Builder.html" title="class in com.google.adk.runner"><code>Runner.Builder</code></a> instead.</div>
|
|
</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code> </code></div>
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(com.google.adk.agents.BaseAgent,java.lang.String,com.google.adk.artifacts.BaseArtifactService,com.google.adk.sessions.BaseSessionService,com.google.adk.memory.BaseMemoryService,java.util.List)" class="member-name-link">Runner</a><wbr>(<a href="../agents/BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a> agent,
|
|
<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> appName,
|
|
<a href="../artifacts/BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a> artifactService,
|
|
<a href="../sessions/BaseSessionService.html" title="interface in com.google.adk.sessions">BaseSessionService</a> sessionService,
|
|
@Nullable <a href="../memory/BaseMemoryService.html" title="interface in com.google.adk.memory">BaseMemoryService</a> memoryService,
|
|
<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="../plugins/Plugin.html" title="interface in com.google.adk.plugins">Plugin</a>> plugins)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">Use <a href="Runner.Builder.html" title="class in com.google.adk.runner"><code>Runner.Builder</code></a> instead.</div>
|
|
</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>protected </code></div>
|
|
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(com.google.adk.agents.BaseAgent,java.lang.String,com.google.adk.artifacts.BaseArtifactService,com.google.adk.sessions.BaseSessionService,com.google.adk.memory.BaseMemoryService,java.util.List,com.google.adk.summarizer.EventsCompactionConfig,com.google.adk.agents.ContextCacheConfig)" class="member-name-link">Runner</a><wbr>(<a href="../agents/BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a> agent,
|
|
<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> appName,
|
|
<a href="../artifacts/BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a> artifactService,
|
|
<a href="../sessions/BaseSessionService.html" title="interface in com.google.adk.sessions">BaseSessionService</a> sessionService,
|
|
@Nullable <a href="../memory/BaseMemoryService.html" title="interface in com.google.adk.memory">BaseMemoryService</a> memoryService,
|
|
<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="../plugins/Plugin.html" title="interface in com.google.adk.plugins">Plugin</a>> plugins,
|
|
@Nullable <a href="../summarizer/EventsCompactionConfig.html" title="class in com.google.adk.summarizer">EventsCompactionConfig</a> eventsCompactionConfig,
|
|
@Nullable <a href="../agents/ContextCacheConfig.html" title="class in com.google.adk.agents">ContextCacheConfig</a> contextCacheConfig)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">Use <a href="Runner.Builder.html" title="class in com.google.adk.runner"><code>Runner.Builder</code></a> instead.</div>
|
|
</div>
|
|
</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.BaseAgent,java.lang.String,com.google.adk.artifacts.BaseArtifactService,com.google.adk.sessions.BaseSessionService,com.google.adk.memory.BaseMemoryService,java.util.List,com.google.adk.summarizer.EventsCompactionConfig,com.google.adk.agents.ContextCacheConfig,com.google.adk.apps.ResumabilityConfig)" class="member-name-link">Runner</a><wbr>(<a href="../agents/BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a> agent,
|
|
<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> appName,
|
|
<a href="../artifacts/BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a> artifactService,
|
|
<a href="../sessions/BaseSessionService.html" title="interface in com.google.adk.sessions">BaseSessionService</a> sessionService,
|
|
@Nullable <a href="../memory/BaseMemoryService.html" title="interface in com.google.adk.memory">BaseMemoryService</a> memoryService,
|
|
<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="../plugins/Plugin.html" title="interface in com.google.adk.plugins">Plugin</a>> plugins,
|
|
@Nullable <a href="../summarizer/EventsCompactionConfig.html" title="class in com.google.adk.summarizer">EventsCompactionConfig</a> eventsCompactionConfig,
|
|
@Nullable <a href="../agents/ContextCacheConfig.html" title="class in com.google.adk.agents">ContextCacheConfig</a> contextCacheConfig,
|
|
@Nullable <a href="../apps/ResumabilityConfig.html" title="class in com.google.adk.apps">ResumabilityConfig</a> resumabilityConfig)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">Use <a href="Runner.Builder.html" title="class in com.google.adk.runner"><code>Runner.Builder</code></a> instead.</div>
|
|
</div>
|
|
</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="../agents/BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#agent()" class="member-name-link">agent</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/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="#appName()" class="member-name-link">appName</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="../artifacts/BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#artifactService()" class="member-name-link">artifactService</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="Runner.Builder.html" title="class in com.google.adk.runner">Runner.Builder</a></code></div>
|
|
<div class="col-second odd-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 odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>io.reactivex.rxjava3.core.Completable</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close()" class="member-name-link">close</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Closes all plugins, code executors, and releases any resources.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="../memory/BaseMemoryService.html" title="interface in com.google.adk.memory">BaseMemoryService</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#memoryService()" class="member-name-link">memoryService</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="../plugins/PluginManager.html" title="class in com.google.adk.plugins">PluginManager</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#pluginManager()" class="member-name-link">pluginManager</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>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="#runAsync(com.google.adk.sessions.SessionKey,com.google.genai.types.Content)" class="member-name-link">runAsync</a><wbr>(<a href="../sessions/SessionKey.html" title="class in com.google.adk.sessions">SessionKey</a> sessionKey,
|
|
com.google.genai.types.Content newMessage)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">See <a href="#runAsync(java.lang.String,java.lang.String,com.google.genai.types.Content,com.google.adk.agents.RunConfig,java.util.Map)"><code>runAsync(String, String, Content, RunConfig, Map)</code></a>.</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="../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="#runAsync(com.google.adk.sessions.SessionKey,com.google.genai.types.Content,com.google.adk.agents.RunConfig)" class="member-name-link">runAsync</a><wbr>(<a href="../sessions/SessionKey.html" title="class in com.google.adk.sessions">SessionKey</a> sessionKey,
|
|
com.google.genai.types.Content newMessage,
|
|
<a href="../agents/RunConfig.html" title="class in com.google.adk.agents">RunConfig</a> runConfig)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">See <a href="#runAsync(java.lang.String,java.lang.String,com.google.genai.types.Content,com.google.adk.agents.RunConfig,java.util.Map)"><code>runAsync(String, String, Content, RunConfig, Map)</code></a>.</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="../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="#runAsync(com.google.adk.sessions.SessionKey,com.google.genai.types.Content,com.google.adk.agents.RunConfig,java.util.Map)" class="member-name-link">runAsync</a><wbr>(<a href="../sessions/SessionKey.html" title="class in com.google.adk.sessions">SessionKey</a> sessionKey,
|
|
com.google.genai.types.Content newMessage,
|
|
<a href="../agents/RunConfig.html" title="class in com.google.adk.agents">RunConfig</a> runConfig,
|
|
@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>> stateDelta)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">See <a href="#runAsync(java.lang.String,java.lang.String,com.google.genai.types.Content,com.google.adk.agents.RunConfig,java.util.Map)"><code>runAsync(String, String, Content, RunConfig, Map)</code></a>.</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="../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="#runAsync(java.lang.String,java.lang.String,com.google.genai.types.Content)" class="member-name-link">runAsync</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> userId,
|
|
<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> sessionId,
|
|
com.google.genai.types.Content newMessage)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">See <a href="#runAsync(java.lang.String,java.lang.String,com.google.genai.types.Content,com.google.adk.agents.RunConfig,java.util.Map)"><code>runAsync(String, String, Content, RunConfig, Map)</code></a>.</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="../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="#runAsync(java.lang.String,java.lang.String,com.google.genai.types.Content,com.google.adk.agents.RunConfig)" class="member-name-link">runAsync</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> userId,
|
|
<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> sessionId,
|
|
com.google.genai.types.Content newMessage,
|
|
<a href="../agents/RunConfig.html" title="class in com.google.adk.agents">RunConfig</a> runConfig)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">See <a href="#runAsync(java.lang.String,java.lang.String,com.google.genai.types.Content,com.google.adk.agents.RunConfig,java.util.Map)"><code>runAsync(String, String, Content, RunConfig, Map)</code></a>.</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="../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="#runAsync(java.lang.String,java.lang.String,com.google.genai.types.Content,com.google.adk.agents.RunConfig,java.util.Map)" class="member-name-link">runAsync</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> userId,
|
|
<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> sessionId,
|
|
com.google.genai.types.Content newMessage,
|
|
<a href="../agents/RunConfig.html" title="class in com.google.adk.agents">RunConfig</a> runConfig,
|
|
@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>> stateDelta)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Runs the agent with an invocation-based mode.</div>
|
|
</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.sessions.Session,com.google.genai.types.Content,com.google.adk.agents.RunConfig,java.util.Map)" class="member-name-link">runAsyncImpl</a><wbr>(<a href="../sessions/Session.html" title="class in com.google.adk.sessions">Session</a> session,
|
|
com.google.genai.types.Content newMessage,
|
|
<a href="../agents/RunConfig.html" title="class in com.google.adk.agents">RunConfig</a> runConfig,
|
|
@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>> stateDelta)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Runs the agent asynchronously using a provided Session object.</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="../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="#runLive(com.google.adk.sessions.SessionKey,com.google.adk.agents.LiveRequestQueue,com.google.adk.agents.RunConfig)" class="member-name-link">runLive</a><wbr>(<a href="../sessions/SessionKey.html" title="class in com.google.adk.sessions">SessionKey</a> sessionKey,
|
|
<a href="../agents/LiveRequestQueue.html" title="class in com.google.adk.agents">LiveRequestQueue</a> liveRequestQueue,
|
|
<a href="../agents/RunConfig.html" title="class in com.google.adk.agents">RunConfig</a> runConfig)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Retrieves the session and runs the agent in live mode.</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="../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="#runLive(com.google.adk.sessions.Session,com.google.adk.agents.LiveRequestQueue,com.google.adk.agents.RunConfig)" class="member-name-link">runLive</a><wbr>(<a href="../sessions/Session.html" title="class in com.google.adk.sessions">Session</a> session,
|
|
<a href="../agents/LiveRequestQueue.html" title="class in com.google.adk.agents">LiveRequestQueue</a> liveRequestQueue,
|
|
<a href="../agents/RunConfig.html" title="class in com.google.adk.agents">RunConfig</a> runConfig)</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>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="#runLive(java.lang.String,java.lang.String,com.google.adk.agents.LiveRequestQueue,com.google.adk.agents.RunConfig)" class="member-name-link">runLive</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> userId,
|
|
<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> sessionId,
|
|
<a href="../agents/LiveRequestQueue.html" title="class in com.google.adk.agents">LiveRequestQueue</a> liveRequestQueue,
|
|
<a href="../agents/RunConfig.html" title="class in com.google.adk.agents">RunConfig</a> runConfig)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Retrieves the session and runs the agent in live mode.</div>
|
|
</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="#runLiveImpl(com.google.adk.sessions.Session,com.google.adk.agents.LiveRequestQueue,com.google.adk.agents.RunConfig)" class="member-name-link">runLiveImpl</a><wbr>(<a href="../sessions/Session.html" title="class in com.google.adk.sessions">Session</a> session,
|
|
@Nullable <a href="../agents/LiveRequestQueue.html" title="class in com.google.adk.agents">LiveRequestQueue</a> liveRequestQueue,
|
|
<a href="../agents/RunConfig.html" title="class in com.google.adk.agents">RunConfig</a> runConfig)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Runs the agent in live mode, appending generated events to the session.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../sessions/BaseSessionService.html" title="interface in com.google.adk.sessions">BaseSessionService</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sessionService()" class="member-name-link">sessionService</a>()</code></div>
|
|
<div class="col-last even-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-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.BaseAgent,java.lang.String,com.google.adk.artifacts.BaseArtifactService,com.google.adk.sessions.BaseSessionService,com.google.adk.memory.BaseMemoryService)">
|
|
<h3>Runner</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="annotation interface in java.lang" class="external-link">@Deprecated</a>
|
|
</span><span class="modifiers">public</span> <span class="element-name">Runner</span><wbr><span class="parameters">(<a href="../agents/BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a> agent,
|
|
<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> appName,
|
|
<a href="../artifacts/BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a> artifactService,
|
|
<a href="../sessions/BaseSessionService.html" title="interface in com.google.adk.sessions">BaseSessionService</a> sessionService,
|
|
@Nullable <a href="../memory/BaseMemoryService.html" title="interface in com.google.adk.memory">BaseMemoryService</a> memoryService)</span></div>
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">Use <a href="Runner.Builder.html" title="class in com.google.adk.runner"><code>Runner.Builder</code></a> instead.</div>
|
|
</div>
|
|
<div class="block">Creates a new <code>Runner</code>.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="<init>(com.google.adk.agents.BaseAgent,java.lang.String,com.google.adk.artifacts.BaseArtifactService,com.google.adk.sessions.BaseSessionService,com.google.adk.memory.BaseMemoryService,java.util.List)">
|
|
<h3>Runner</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="annotation interface in java.lang" class="external-link">@Deprecated</a>
|
|
</span><span class="modifiers">public</span> <span class="element-name">Runner</span><wbr><span class="parameters">(<a href="../agents/BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a> agent,
|
|
<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> appName,
|
|
<a href="../artifacts/BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a> artifactService,
|
|
<a href="../sessions/BaseSessionService.html" title="interface in com.google.adk.sessions">BaseSessionService</a> sessionService,
|
|
@Nullable <a href="../memory/BaseMemoryService.html" title="interface in com.google.adk.memory">BaseMemoryService</a> memoryService,
|
|
<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="../plugins/Plugin.html" title="interface in com.google.adk.plugins">Plugin</a>> plugins)</span></div>
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">Use <a href="Runner.Builder.html" title="class in com.google.adk.runner"><code>Runner.Builder</code></a> instead.</div>
|
|
</div>
|
|
<div class="block">Creates a new <code>Runner</code> with a list of plugins.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="<init>(com.google.adk.agents.BaseAgent,java.lang.String,com.google.adk.artifacts.BaseArtifactService,com.google.adk.sessions.BaseSessionService,com.google.adk.memory.BaseMemoryService,java.util.List,com.google.adk.summarizer.EventsCompactionConfig,com.google.adk.agents.ContextCacheConfig)">
|
|
<h3>Runner</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="annotation interface in java.lang" class="external-link">@Deprecated</a>
|
|
</span><span class="modifiers">protected</span> <span class="element-name">Runner</span><wbr><span class="parameters">(<a href="../agents/BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a> agent,
|
|
<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> appName,
|
|
<a href="../artifacts/BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a> artifactService,
|
|
<a href="../sessions/BaseSessionService.html" title="interface in com.google.adk.sessions">BaseSessionService</a> sessionService,
|
|
@Nullable <a href="../memory/BaseMemoryService.html" title="interface in com.google.adk.memory">BaseMemoryService</a> memoryService,
|
|
<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="../plugins/Plugin.html" title="interface in com.google.adk.plugins">Plugin</a>> plugins,
|
|
@Nullable <a href="../summarizer/EventsCompactionConfig.html" title="class in com.google.adk.summarizer">EventsCompactionConfig</a> eventsCompactionConfig,
|
|
@Nullable <a href="../agents/ContextCacheConfig.html" title="class in com.google.adk.agents">ContextCacheConfig</a> contextCacheConfig)</span></div>
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">Use <a href="Runner.Builder.html" title="class in com.google.adk.runner"><code>Runner.Builder</code></a> instead.</div>
|
|
</div>
|
|
<div class="block">Creates a new <code>Runner</code> with a list of plugins.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="<init>(com.google.adk.agents.BaseAgent,java.lang.String,com.google.adk.artifacts.BaseArtifactService,com.google.adk.sessions.BaseSessionService,com.google.adk.memory.BaseMemoryService,java.util.List,com.google.adk.summarizer.EventsCompactionConfig,com.google.adk.agents.ContextCacheConfig,com.google.adk.apps.ResumabilityConfig)">
|
|
<h3>Runner</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="annotation interface in java.lang" class="external-link">@Deprecated</a>
|
|
</span><span class="modifiers">protected</span> <span class="element-name">Runner</span><wbr><span class="parameters">(<a href="../agents/BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a> agent,
|
|
<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> appName,
|
|
<a href="../artifacts/BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a> artifactService,
|
|
<a href="../sessions/BaseSessionService.html" title="interface in com.google.adk.sessions">BaseSessionService</a> sessionService,
|
|
@Nullable <a href="../memory/BaseMemoryService.html" title="interface in com.google.adk.memory">BaseMemoryService</a> memoryService,
|
|
<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="../plugins/Plugin.html" title="interface in com.google.adk.plugins">Plugin</a>> plugins,
|
|
@Nullable <a href="../summarizer/EventsCompactionConfig.html" title="class in com.google.adk.summarizer">EventsCompactionConfig</a> eventsCompactionConfig,
|
|
@Nullable <a href="../agents/ContextCacheConfig.html" title="class in com.google.adk.agents">ContextCacheConfig</a> contextCacheConfig,
|
|
@Nullable <a href="../apps/ResumabilityConfig.html" title="class in com.google.adk.apps">ResumabilityConfig</a> resumabilityConfig)</span></div>
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">Use <a href="Runner.Builder.html" title="class in com.google.adk.runner"><code>Runner.Builder</code></a> instead.</div>
|
|
</div>
|
|
<div class="block">Creates a new <code>Runner</code> with a resumability config.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="<init>(com.google.adk.agents.BaseAgent,java.lang.String,com.google.adk.artifacts.BaseArtifactService,com.google.adk.sessions.BaseSessionService)">
|
|
<h3>Runner</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="annotation interface in java.lang" class="external-link">@Deprecated</a>
|
|
</span><span class="modifiers">public</span> <span class="element-name">Runner</span><wbr><span class="parameters">(<a href="../agents/BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a> agent,
|
|
<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> appName,
|
|
<a href="../artifacts/BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a> artifactService,
|
|
<a href="../sessions/BaseSessionService.html" title="interface in com.google.adk.sessions">BaseSessionService</a> sessionService)</span></div>
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">Use <a href="Runner.Builder.html" title="class in com.google.adk.runner"><code>Runner.Builder</code></a> instead.</div>
|
|
</div>
|
|
<div class="block">Creates a new <code>Runner</code>.</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="Runner.Builder.html" title="class in com.google.adk.runner">Runner.Builder</a></span> <span class="element-name">builder</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="agent()">
|
|
<h3>agent</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../agents/BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a></span> <span class="element-name">agent</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="appName()">
|
|
<h3>appName</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/lang/String.html" title="class in java.lang" class="external-link">String</a></span> <span class="element-name">appName</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="artifactService()">
|
|
<h3>artifactService</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../artifacts/BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a></span> <span class="element-name">artifactService</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="sessionService()">
|
|
<h3>sessionService</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../sessions/BaseSessionService.html" title="interface in com.google.adk.sessions">BaseSessionService</a></span> <span class="element-name">sessionService</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="memoryService()">
|
|
<h3>memoryService</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="../memory/BaseMemoryService.html" title="interface in com.google.adk.memory">BaseMemoryService</a></span> <span class="element-name">memoryService</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="pluginManager()">
|
|
<h3>pluginManager</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../plugins/PluginManager.html" title="class in com.google.adk.plugins">PluginManager</a></span> <span class="element-name">pluginManager</span>()</div>
|
|
</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">Closes all plugins, code executors, and releases any resources.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="runAsync(java.lang.String,java.lang.String,com.google.genai.types.Content,com.google.adk.agents.RunConfig)">
|
|
<h3>runAsync</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="../events/Event.html" title="class in com.google.adk.events">Event</a>></span> <span class="element-name">runAsync</span><wbr><span class="parameters">(<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> userId,
|
|
<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> sessionId,
|
|
com.google.genai.types.Content newMessage,
|
|
<a href="../agents/RunConfig.html" title="class in com.google.adk.agents">RunConfig</a> runConfig)</span></div>
|
|
<div class="block">See <a href="#runAsync(java.lang.String,java.lang.String,com.google.genai.types.Content,com.google.adk.agents.RunConfig,java.util.Map)"><code>runAsync(String, String, Content, RunConfig, Map)</code></a>.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="runAsync(java.lang.String,java.lang.String,com.google.genai.types.Content,com.google.adk.agents.RunConfig,java.util.Map)">
|
|
<h3>runAsync</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="../events/Event.html" title="class in com.google.adk.events">Event</a>></span> <span class="element-name">runAsync</span><wbr><span class="parameters">(<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> userId,
|
|
<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> sessionId,
|
|
com.google.genai.types.Content newMessage,
|
|
<a href="../agents/RunConfig.html" title="class in com.google.adk.agents">RunConfig</a> runConfig,
|
|
@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>> stateDelta)</span></div>
|
|
<div class="block">Runs the agent with an invocation-based mode.
|
|
|
|
<p>TODO: make this the main implementation.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>userId</code> - The ID of the user for the session.</dd>
|
|
<dd><code>sessionId</code> - The ID of the session to run the agent in.</dd>
|
|
<dd><code>newMessage</code> - The new message from the user to process.</dd>
|
|
<dd><code>runConfig</code> - Configuration for the agent run.</dd>
|
|
<dd><code>stateDelta</code> - Optional map of state updates to merge into the session for this run.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>A Flowable stream of <a href="../events/Event.html" title="class in com.google.adk.events"><code>Event</code></a> objects generated by the agent during execution.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="runAsync(com.google.adk.sessions.SessionKey,com.google.genai.types.Content,com.google.adk.agents.RunConfig,java.util.Map)">
|
|
<h3>runAsync</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="../events/Event.html" title="class in com.google.adk.events">Event</a>></span> <span class="element-name">runAsync</span><wbr><span class="parameters">(<a href="../sessions/SessionKey.html" title="class in com.google.adk.sessions">SessionKey</a> sessionKey,
|
|
com.google.genai.types.Content newMessage,
|
|
<a href="../agents/RunConfig.html" title="class in com.google.adk.agents">RunConfig</a> runConfig,
|
|
@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>> stateDelta)</span></div>
|
|
<div class="block">See <a href="#runAsync(java.lang.String,java.lang.String,com.google.genai.types.Content,com.google.adk.agents.RunConfig,java.util.Map)"><code>runAsync(String, String, Content, RunConfig, Map)</code></a>.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="runAsync(com.google.adk.sessions.SessionKey,com.google.genai.types.Content,com.google.adk.agents.RunConfig)">
|
|
<h3>runAsync</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="../events/Event.html" title="class in com.google.adk.events">Event</a>></span> <span class="element-name">runAsync</span><wbr><span class="parameters">(<a href="../sessions/SessionKey.html" title="class in com.google.adk.sessions">SessionKey</a> sessionKey,
|
|
com.google.genai.types.Content newMessage,
|
|
<a href="../agents/RunConfig.html" title="class in com.google.adk.agents">RunConfig</a> runConfig)</span></div>
|
|
<div class="block">See <a href="#runAsync(java.lang.String,java.lang.String,com.google.genai.types.Content,com.google.adk.agents.RunConfig,java.util.Map)"><code>runAsync(String, String, Content, RunConfig, Map)</code></a>.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="runAsync(com.google.adk.sessions.SessionKey,com.google.genai.types.Content)">
|
|
<h3>runAsync</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="../events/Event.html" title="class in com.google.adk.events">Event</a>></span> <span class="element-name">runAsync</span><wbr><span class="parameters">(<a href="../sessions/SessionKey.html" title="class in com.google.adk.sessions">SessionKey</a> sessionKey,
|
|
com.google.genai.types.Content newMessage)</span></div>
|
|
<div class="block">See <a href="#runAsync(java.lang.String,java.lang.String,com.google.genai.types.Content,com.google.adk.agents.RunConfig,java.util.Map)"><code>runAsync(String, String, Content, RunConfig, Map)</code></a>.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="runAsync(java.lang.String,java.lang.String,com.google.genai.types.Content)">
|
|
<h3>runAsync</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="../events/Event.html" title="class in com.google.adk.events">Event</a>></span> <span class="element-name">runAsync</span><wbr><span class="parameters">(<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> userId,
|
|
<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> sessionId,
|
|
com.google.genai.types.Content newMessage)</span></div>
|
|
<div class="block">See <a href="#runAsync(java.lang.String,java.lang.String,com.google.genai.types.Content,com.google.adk.agents.RunConfig,java.util.Map)"><code>runAsync(String, String, Content, RunConfig, Map)</code></a>.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="runAsyncImpl(com.google.adk.sessions.Session,com.google.genai.types.Content,com.google.adk.agents.RunConfig,java.util.Map)">
|
|
<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="../sessions/Session.html" title="class in com.google.adk.sessions">Session</a> session,
|
|
com.google.genai.types.Content newMessage,
|
|
<a href="../agents/RunConfig.html" title="class in com.google.adk.agents">RunConfig</a> runConfig,
|
|
@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>> stateDelta)</span></div>
|
|
<div class="block">Runs the agent asynchronously using a provided Session object.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>session</code> - The session to run the agent in.</dd>
|
|
<dd><code>newMessage</code> - The new message from the user to process.</dd>
|
|
<dd><code>runConfig</code> - Configuration for the agent run.</dd>
|
|
<dd><code>stateDelta</code> - Optional map of state updates to merge into the session for this run.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>A Flowable stream of <a href="../events/Event.html" title="class in com.google.adk.events"><code>Event</code></a> objects generated by the agent during execution.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="runLive(com.google.adk.sessions.Session,com.google.adk.agents.LiveRequestQueue,com.google.adk.agents.RunConfig)">
|
|
<h3>runLive</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="../events/Event.html" title="class in com.google.adk.events">Event</a>></span> <span class="element-name">runLive</span><wbr><span class="parameters">(<a href="../sessions/Session.html" title="class in com.google.adk.sessions">Session</a> session,
|
|
<a href="../agents/LiveRequestQueue.html" title="class in com.google.adk.agents">LiveRequestQueue</a> liveRequestQueue,
|
|
<a href="../agents/RunConfig.html" title="class in com.google.adk.agents">RunConfig</a> runConfig)</span></div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="runLive(java.lang.String,java.lang.String,com.google.adk.agents.LiveRequestQueue,com.google.adk.agents.RunConfig)">
|
|
<h3>runLive</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="../events/Event.html" title="class in com.google.adk.events">Event</a>></span> <span class="element-name">runLive</span><wbr><span class="parameters">(<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> userId,
|
|
<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> sessionId,
|
|
<a href="../agents/LiveRequestQueue.html" title="class in com.google.adk.agents">LiveRequestQueue</a> liveRequestQueue,
|
|
<a href="../agents/RunConfig.html" title="class in com.google.adk.agents">RunConfig</a> runConfig)</span></div>
|
|
<div class="block">Retrieves the session and runs the agent in live mode.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>stream of events from the agent.</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class in java.lang" class="external-link">IllegalArgumentException</a></code> - if the session is not found.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="runLive(com.google.adk.sessions.SessionKey,com.google.adk.agents.LiveRequestQueue,com.google.adk.agents.RunConfig)">
|
|
<h3>runLive</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="../events/Event.html" title="class in com.google.adk.events">Event</a>></span> <span class="element-name">runLive</span><wbr><span class="parameters">(<a href="../sessions/SessionKey.html" title="class in com.google.adk.sessions">SessionKey</a> sessionKey,
|
|
<a href="../agents/LiveRequestQueue.html" title="class in com.google.adk.agents">LiveRequestQueue</a> liveRequestQueue,
|
|
<a href="../agents/RunConfig.html" title="class in com.google.adk.agents">RunConfig</a> runConfig)</span></div>
|
|
<div class="block">Retrieves the session and runs the agent in live mode.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>stream of events from the agent.</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class in java.lang" class="external-link">IllegalArgumentException</a></code> - if the session is not found.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="runLiveImpl(com.google.adk.sessions.Session,com.google.adk.agents.LiveRequestQueue,com.google.adk.agents.RunConfig)">
|
|
<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="../sessions/Session.html" title="class in com.google.adk.sessions">Session</a> session,
|
|
@Nullable <a href="../agents/LiveRequestQueue.html" title="class in com.google.adk.agents">LiveRequestQueue</a> liveRequestQueue,
|
|
<a href="../agents/RunConfig.html" title="class in com.google.adk.agents">RunConfig</a> runConfig)</span></div>
|
|
<div class="block">Runs the agent in live mode, appending generated events to the session.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>stream of events from the agent.</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>
|