mirror of
https://github.com/google/adk-docs.git
synced 2026-09-14 16:16:59 +08:00
515 lines
40 KiB
HTML
515 lines
40 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>InvocationContext.Builder (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: InvocationContext, class: Builder">
|
|
<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/InvocationContext.Builder.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="InvocationContext.html">InvocationContext</a></li>
|
|
<li><a href="InvocationContext.Builder.html" class="current-selection">Builder</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="#sessionService(com.google.adk.sessions.BaseSessionService)" tabindex="0">sessionService(BaseSessionService)</a></li>
|
|
<li><a href="#artifactService(com.google.adk.artifacts.BaseArtifactService)" tabindex="0">artifactService(BaseArtifactService)</a></li>
|
|
<li><a href="#memoryService(com.google.adk.memory.BaseMemoryService)" tabindex="0">memoryService(BaseMemoryService)</a></li>
|
|
<li><a href="#pluginManager(com.google.adk.plugins.Plugin)" tabindex="0">pluginManager(Plugin)</a></li>
|
|
<li><a href="#liveRequestQueue(com.google.adk.agents.LiveRequestQueue)" tabindex="0">liveRequestQueue(LiveRequestQueue)</a></li>
|
|
<li><a href="#branch(java.lang.String)" tabindex="0">branch(String)</a></li>
|
|
<li><a href="#invocationId(java.lang.String)" tabindex="0">invocationId(String)</a></li>
|
|
<li><a href="#agent(com.google.adk.agents.BaseAgent)" tabindex="0">agent(BaseAgent)</a></li>
|
|
<li><a href="#session(com.google.adk.sessions.Session)" tabindex="0">session(Session)</a></li>
|
|
<li><a href="#userContent(com.google.genai.types.Content)" tabindex="0">userContent(Content)</a></li>
|
|
<li><a href="#runConfig(com.google.adk.agents.RunConfig)" tabindex="0">runConfig(RunConfig)</a></li>
|
|
<li><a href="#endInvocation(boolean)" tabindex="0">endInvocation(boolean)</a></li>
|
|
<li><a href="#eventsCompactionConfig(com.google.adk.summarizer.EventsCompactionConfig)" tabindex="0">eventsCompactionConfig(EventsCompactionConfig)</a></li>
|
|
<li><a href="#contextCacheConfig(com.google.adk.agents.ContextCacheConfig)" tabindex="0">contextCacheConfig(ContextCacheConfig)</a></li>
|
|
<li><a href="#resumabilityConfig(com.google.adk.apps.ResumabilityConfig)" tabindex="0">resumabilityConfig(ResumabilityConfig)</a></li>
|
|
<li><a href="#callbackContextData(java.util.Map)" tabindex="0">callbackContextData(Map)</a></li>
|
|
<li><a href="#build()" tabindex="0">build()</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 InvocationContext.Builder" class="title">Class InvocationContext.Builder</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.agents.InvocationContext.Builder</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>Enclosing class:</dt>
|
|
<dd><code><a href="InvocationContext.html" title="class in com.google.adk.agents">InvocationContext</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="horizontal-scroll">
|
|
<div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">InvocationContext.Builder</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">Builder for <a href="InvocationContext.html" title="class in com.google.adk.agents"><code>InvocationContext</code></a>.</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-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="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</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(com.google.adk.agents.BaseAgent)" class="member-name-link">agent</a><wbr>(<a href="BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a> agent)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Sets the agent being invoked.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#artifactService(com.google.adk.artifacts.BaseArtifactService)" class="member-name-link">artifactService</a><wbr>(<a href="../artifacts/BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a> artifactService)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Sets the artifact service for persisting artifacts.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#branch(java.lang.String)" class="member-name-link">branch</a><wbr>(@Nullable <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> branch)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Sets the branch ID for the invocation.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="InvocationContext.html" title="class in com.google.adk.agents">InvocationContext</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#build()" class="member-name-link">build</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Builds the <a href="InvocationContext.html" title="class in com.google.adk.agents"><code>InvocationContext</code></a> instance.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#callbackContextData(java.util.Map)" class="member-name-link">callbackContextData</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>> callbackContextData)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Sets the callback context data for the invocation.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#contextCacheConfig(com.google.adk.agents.ContextCacheConfig)" class="member-name-link">contextCacheConfig</a><wbr>(@Nullable <a href="ContextCacheConfig.html" title="class in com.google.adk.agents">ContextCacheConfig</a> contextCacheConfig)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Sets the context cache configuration for the current agent run.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#endInvocation(boolean)" class="member-name-link">endInvocation</a><wbr>(boolean endInvocation)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Sets whether this invocation should be ended.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#eventsCompactionConfig(com.google.adk.summarizer.EventsCompactionConfig)" class="member-name-link">eventsCompactionConfig</a><wbr>(@Nullable <a href="../summarizer/EventsCompactionConfig.html" title="class in com.google.adk.summarizer">EventsCompactionConfig</a> eventsCompactionConfig)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Sets the events compaction configuration for the current agent run.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#invocationId(java.lang.String)" class="member-name-link">invocationId</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> invocationId)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Sets the unique ID for the invocation.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#liveRequestQueue(com.google.adk.agents.LiveRequestQueue)" class="member-name-link">liveRequestQueue</a><wbr>(@Nullable <a href="LiveRequestQueue.html" title="class in com.google.adk.agents">LiveRequestQueue</a> liveRequestQueue)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Sets the queue for managing live requests.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#memoryService(com.google.adk.memory.BaseMemoryService)" class="member-name-link">memoryService</a><wbr>(<a href="../memory/BaseMemoryService.html" title="interface in com.google.adk.memory">BaseMemoryService</a> memoryService)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Sets the memory service for accessing agent memory.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#pluginManager(com.google.adk.plugins.Plugin)" class="member-name-link">pluginManager</a><wbr>(<a href="../plugins/Plugin.html" title="interface in com.google.adk.plugins">Plugin</a> pluginManager)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Sets the plugin manager for accessing tools and plugins.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#resumabilityConfig(com.google.adk.apps.ResumabilityConfig)" class="member-name-link">resumabilityConfig</a><wbr>(@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 method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Sets the resumability configuration for the invocation.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#runConfig(com.google.adk.agents.RunConfig)" class="member-name-link">runConfig</a><wbr>(<a href="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">Sets the configuration for the current agent run.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#session(com.google.adk.sessions.Session)" class="member-name-link">session</a><wbr>(<a href="../sessions/Session.html" title="class in com.google.adk.sessions">Session</a> session)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Sets the session associated with this invocation.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sessionService(com.google.adk.sessions.BaseSessionService)" class="member-name-link">sessionService</a><wbr>(<a href="../sessions/BaseSessionService.html" title="interface in com.google.adk.sessions">BaseSessionService</a> sessionService)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Sets the session service for managing session state.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#userContent(com.google.genai.types.Content)" class="member-name-link">userContent</a><wbr>(@Nullable com.google.genai.types.Content userContent)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Sets the user content that triggered this invocation.</div>
|
|
</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">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="sessionService(com.google.adk.sessions.BaseSessionService)">
|
|
<h3>sessionService</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@CanIgnoreReturnValue
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></span> <span class="element-name">sessionService</span><wbr><span class="parameters">(<a href="../sessions/BaseSessionService.html" title="interface in com.google.adk.sessions">BaseSessionService</a> sessionService)</span></div>
|
|
<div class="block">Sets the session service for managing session state.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>sessionService</code> - the session service to use; required.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>this builder instance for chaining.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="artifactService(com.google.adk.artifacts.BaseArtifactService)">
|
|
<h3>artifactService</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@CanIgnoreReturnValue
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></span> <span class="element-name">artifactService</span><wbr><span class="parameters">(<a href="../artifacts/BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a> artifactService)</span></div>
|
|
<div class="block">Sets the artifact service for persisting artifacts.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>artifactService</code> - the artifact service to use; required.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>this builder instance for chaining.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="memoryService(com.google.adk.memory.BaseMemoryService)">
|
|
<h3>memoryService</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@CanIgnoreReturnValue
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></span> <span class="element-name">memoryService</span><wbr><span class="parameters">(<a href="../memory/BaseMemoryService.html" title="interface in com.google.adk.memory">BaseMemoryService</a> memoryService)</span></div>
|
|
<div class="block">Sets the memory service for accessing agent memory.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>memoryService</code> - the memory service to use.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>this builder instance for chaining.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="pluginManager(com.google.adk.plugins.Plugin)">
|
|
<h3>pluginManager</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@CanIgnoreReturnValue
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></span> <span class="element-name">pluginManager</span><wbr><span class="parameters">(<a href="../plugins/Plugin.html" title="interface in com.google.adk.plugins">Plugin</a> pluginManager)</span></div>
|
|
<div class="block">Sets the plugin manager for accessing tools and plugins.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>pluginManager</code> - the plugin manager to use.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>this builder instance for chaining.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="liveRequestQueue(com.google.adk.agents.LiveRequestQueue)">
|
|
<h3>liveRequestQueue</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@CanIgnoreReturnValue
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></span> <span class="element-name">liveRequestQueue</span><wbr><span class="parameters">(@Nullable <a href="LiveRequestQueue.html" title="class in com.google.adk.agents">LiveRequestQueue</a> liveRequestQueue)</span></div>
|
|
<div class="block">Sets the queue for managing live requests.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>liveRequestQueue</code> - the queue for managing live requests.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>this builder instance for chaining.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="branch(java.lang.String)">
|
|
<h3>branch</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@CanIgnoreReturnValue
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></span> <span class="element-name">branch</span><wbr><span class="parameters">(@Nullable <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> branch)</span></div>
|
|
<div class="block">Sets the branch ID for the invocation.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>branch</code> - the branch ID for the invocation.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>this builder instance for chaining.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="invocationId(java.lang.String)">
|
|
<h3>invocationId</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@CanIgnoreReturnValue
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></span> <span class="element-name">invocationId</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> invocationId)</span></div>
|
|
<div class="block">Sets the unique ID for the invocation.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>invocationId</code> - the unique ID for the invocation.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>this builder instance for chaining.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="agent(com.google.adk.agents.BaseAgent)">
|
|
<h3>agent</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@CanIgnoreReturnValue
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></span> <span class="element-name">agent</span><wbr><span class="parameters">(<a href="BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a> agent)</span></div>
|
|
<div class="block">Sets the agent being invoked.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>agent</code> - the agent being invoked; required.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>this builder instance for chaining.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="session(com.google.adk.sessions.Session)">
|
|
<h3>session</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@CanIgnoreReturnValue
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></span> <span class="element-name">session</span><wbr><span class="parameters">(<a href="../sessions/Session.html" title="class in com.google.adk.sessions">Session</a> session)</span></div>
|
|
<div class="block">Sets the session associated with this invocation.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>session</code> - the session associated with this invocation; required.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>this builder instance for chaining.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="userContent(com.google.genai.types.Content)">
|
|
<h3>userContent</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@CanIgnoreReturnValue
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></span> <span class="element-name">userContent</span><wbr><span class="parameters">(@Nullable com.google.genai.types.Content userContent)</span></div>
|
|
<div class="block">Sets the user content that triggered this invocation.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>userContent</code> - the user content that triggered this invocation.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>this builder instance for chaining.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="runConfig(com.google.adk.agents.RunConfig)">
|
|
<h3>runConfig</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@CanIgnoreReturnValue
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></span> <span class="element-name">runConfig</span><wbr><span class="parameters">(<a href="RunConfig.html" title="class in com.google.adk.agents">RunConfig</a> runConfig)</span></div>
|
|
<div class="block">Sets the configuration for the current agent run.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>runConfig</code> - the configuration for the current agent run.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>this builder instance for chaining.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="endInvocation(boolean)">
|
|
<h3>endInvocation</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@CanIgnoreReturnValue
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></span> <span class="element-name">endInvocation</span><wbr><span class="parameters">(boolean endInvocation)</span></div>
|
|
<div class="block">Sets whether this invocation should be ended.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>endInvocation</code> - whether this invocation should be ended.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>this builder instance for chaining.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="eventsCompactionConfig(com.google.adk.summarizer.EventsCompactionConfig)">
|
|
<h3>eventsCompactionConfig</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@CanIgnoreReturnValue
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></span> <span class="element-name">eventsCompactionConfig</span><wbr><span class="parameters">(@Nullable <a href="../summarizer/EventsCompactionConfig.html" title="class in com.google.adk.summarizer">EventsCompactionConfig</a> eventsCompactionConfig)</span></div>
|
|
<div class="block">Sets the events compaction configuration for the current agent run.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>eventsCompactionConfig</code> - the events compaction configuration.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>this builder instance for chaining.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="contextCacheConfig(com.google.adk.agents.ContextCacheConfig)">
|
|
<h3>contextCacheConfig</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@CanIgnoreReturnValue
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></span> <span class="element-name">contextCacheConfig</span><wbr><span class="parameters">(@Nullable <a href="ContextCacheConfig.html" title="class in com.google.adk.agents">ContextCacheConfig</a> contextCacheConfig)</span></div>
|
|
<div class="block">Sets the context cache configuration for the current agent run.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>contextCacheConfig</code> - the context cache configuration.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>this builder instance for chaining.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="resumabilityConfig(com.google.adk.apps.ResumabilityConfig)">
|
|
<h3>resumabilityConfig</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@CanIgnoreReturnValue
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></span> <span class="element-name">resumabilityConfig</span><wbr><span class="parameters">(@Nullable <a href="../apps/ResumabilityConfig.html" title="class in com.google.adk.apps">ResumabilityConfig</a> resumabilityConfig)</span></div>
|
|
<div class="block">Sets the resumability configuration for the invocation.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>resumabilityConfig</code> - the resumability configuration.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>this builder instance for chaining.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="callbackContextData(java.util.Map)">
|
|
<h3>callbackContextData</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@CanIgnoreReturnValue
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="InvocationContext.Builder.html" title="class in com.google.adk.agents">InvocationContext.Builder</a></span> <span class="element-name">callbackContextData</span><wbr><span class="parameters">(<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>> callbackContextData)</span></div>
|
|
<div class="block">Sets the callback context data for the invocation.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>callbackContextData</code> - the callback context data.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>this builder instance for chaining.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="build()">
|
|
<h3>build</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="InvocationContext.html" title="class in com.google.adk.agents">InvocationContext</a></span> <span class="element-name">build</span>()</div>
|
|
<div class="block">Builds the <a href="InvocationContext.html" title="class in com.google.adk.agents"><code>InvocationContext</code></a> instance.</div>
|
|
<dl class="notes">
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class in java.lang" class="external-link">IllegalStateException</a></code> - if any required parameters are missing.</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>
|