mirror of
https://github.com/google/adk-docs.git
synced 2026-09-14 16:16:59 +08:00
106d242510
* fix: Remove duplicate Agent Starter Pack tip * docs: Add Google Analytics tags to API reference pages
859 lines
80 KiB
HTML
859 lines
80 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 (24) on Tue Aug 05 22:47:52 UTC 2025 -->
|
|
<title>AdkWebServer.AgentController (Google Agent Development Kit Maven Parent POM 0.2.1-SNAPSHOT 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="dc.created" content="2025-08-05">
|
|
<meta name="description" content="declaration: package: com.google.adk.web, class: AdkWebServer, class: AgentController">
|
|
<meta name="generator" content="javadoc/ClassWriter">
|
|
<link rel="stylesheet" type="text/css" href="../../../../resource-files/jquery-ui.min.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../resource-files/stylesheet.css" title="Style">
|
|
<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(document, 'script');</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/AdkWebServer.AgentController.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../search.html">Search</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div class="nav-content">
|
|
<ol class="sub-nav-list">
|
|
<li><a href="package-summary.html">com.google.adk.web</a></li>
|
|
<li><a href="AdkWebServer.html">AdkWebServer</a></li>
|
|
<li><a href="AdkWebServer.AgentController.html" class="current-selection">AgentController</a></li>
|
|
</ol>
|
|
<div class="nav-list-search">
|
|
<input type="text" id="search-input" disabled placeholder="Search" aria-label="Search in documentation" autocomplete="off">
|
|
<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" aria-label="Filter table of contents" autocomplete="off">
|
|
<input type="reset" class="reset-filter" disabled value="Reset">
|
|
</div>
|
|
<button class="hide-sidebar"><span>Hide sidebar </span>❮</button><button class="show-sidebar">❯<span> Show sidebar</span></button>
|
|
<ol class="toc-list">
|
|
<li><a href="#" tabindex="0">Description</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.sessions.BaseSessionService,com.google.adk.artifacts.BaseArtifactService,java.util.Map,com.google.adk.web.AdkWebServer.ApiServerSpanExporter,com.google.adk.web.AdkWebServer.RunnerService)" tabindex="0">AgentController(BaseSessionService, BaseArtifactService, Map, AdkWebServer.ApiServerSpanExporter, AdkWebServer.RunnerService)</a></li>
|
|
</ol>
|
|
</li>
|
|
<li><a href="#method-detail" tabindex="0">Method Details</a>
|
|
<ol class="toc-list">
|
|
<li><a href="#listApps()" tabindex="0">listApps()</a></li>
|
|
<li><a href="#getTraceDict(java.lang.String)" tabindex="0">getTraceDict(String)</a></li>
|
|
<li><a href="#getSessionTrace(java.lang.String)" tabindex="0">getSessionTrace(String)</a></li>
|
|
<li><a href="#getSession(java.lang.String,java.lang.String,java.lang.String)" tabindex="0">getSession(String, String, String)</a></li>
|
|
<li><a href="#listSessions(java.lang.String,java.lang.String)" tabindex="0">listSessions(String, String)</a></li>
|
|
<li><a href="#createSessionWithId(java.lang.String,java.lang.String,java.lang.String,java.util.Map)" tabindex="0">createSessionWithId(String, String, String, Map)</a></li>
|
|
<li><a href="#createSession(java.lang.String,java.lang.String,java.util.Map)" tabindex="0">createSession(String, String, Map)</a></li>
|
|
<li><a href="#deleteSession(java.lang.String,java.lang.String,java.lang.String)" tabindex="0">deleteSession(String, String, String)</a></li>
|
|
<li><a href="#loadArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Integer)" tabindex="0">loadArtifact(String, String, String, String, Integer)</a></li>
|
|
<li><a href="#loadArtifactVersion(java.lang.String,java.lang.String,java.lang.String,java.lang.String,int)" tabindex="0">loadArtifactVersion(String, String, String, String, int)</a></li>
|
|
<li><a href="#listArtifactNames(java.lang.String,java.lang.String,java.lang.String)" tabindex="0">listArtifactNames(String, String, String)</a></li>
|
|
<li><a href="#listArtifactVersions(java.lang.String,java.lang.String,java.lang.String,java.lang.String)" tabindex="0">listArtifactVersions(String, String, String, String)</a></li>
|
|
<li><a href="#deleteArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String)" tabindex="0">deleteArtifact(String, String, String, String)</a></li>
|
|
<li><a href="#agentRun(com.google.adk.web.AdkWebServer.AgentRunRequest)" tabindex="0">agentRun(AdkWebServer.AgentRunRequest)</a></li>
|
|
<li><a href="#agentRunSse(com.google.adk.web.AdkWebServer.AgentRunRequest)" tabindex="0">agentRunSse(AdkWebServer.AgentRunRequest)</a></li>
|
|
<li><a href="#getEventGraph(java.lang.String,java.lang.String,java.lang.String,java.lang.String)" tabindex="0">getEventGraph(String, String, String, String)</a></li>
|
|
<li><a href="#createEvalSet(java.lang.String,java.lang.String)" tabindex="0">createEvalSet(String, String)</a></li>
|
|
<li><a href="#listEvalSets(java.lang.String)" tabindex="0">listEvalSets(String)</a></li>
|
|
<li><a href="#addSessionToEvalSet(java.lang.String,java.lang.String,com.google.adk.web.AdkWebServer.AddSessionToEvalSetRequest)" tabindex="0">addSessionToEvalSet(String, String, AdkWebServer.AddSessionToEvalSetRequest)</a></li>
|
|
<li><a href="#listEvalsInEvalSet(java.lang.String,java.lang.String)" tabindex="0">listEvalsInEvalSet(String, String)</a></li>
|
|
<li><a href="#runEval(java.lang.String,java.lang.String,com.google.adk.web.AdkWebServer.RunEvalRequest)" tabindex="0">runEval(String, String, AdkWebServer.RunEvalRequest)</a></li>
|
|
<li><a href="#getEvalResult(java.lang.String,java.lang.String)" tabindex="0">getEvalResult(String, String)</a></li>
|
|
<li><a href="#listEvalResults(java.lang.String)" tabindex="0">listEvalResults(String)</a></li>
|
|
</ol>
|
|
</li>
|
|
</ol>
|
|
</nav>
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<h1 title="Class AdkWebServer.AgentController" class="title">Class AdkWebServer.AgentController</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 or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
<div class="inheritance">com.google.adk.web.AdkWebServer.AgentController</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>Enclosing class:</dt>
|
|
<dd><code><a href="AdkWebServer.html" title="class in com.google.adk.web">AdkWebServer</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="horizontal-scroll">
|
|
<div class="type-signature"><span class="annotations">@RestController
|
|
</span><span class="modifiers">public static class </span><span class="element-name type-name-label">AdkWebServer.AgentController</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 or interface in java.lang" class="external-link">Object</a></span></div>
|
|
<div class="block">Spring Boot REST Controller handling agent-related API endpoints.</div>
|
|
</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<li>
|
|
<section class="constructor-summary" id="constructor-summary">
|
|
<h2>Constructor Summary</h2>
|
|
<div class="caption"><span>Constructors</span></div>
|
|
<div class="summary-table two-column-summary">
|
|
<div class="table-header col-first">Constructor</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(com.google.adk.sessions.BaseSessionService,com.google.adk.artifacts.BaseArtifactService,java.util.Map,com.google.adk.web.AdkWebServer.ApiServerSpanExporter,com.google.adk.web.AdkWebServer.RunnerService)" class="member-name-link">AgentController</a><wbr>(<a href="../sessions/BaseSessionService.html" title="interface in com.google.adk.sessions">BaseSessionService</a> sessionService,
|
|
<a href="../artifacts/BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a> artifactService,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or 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 or interface in java.lang" class="external-link">String</a>, <a href="../agents/BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a>> agentRegistry,
|
|
<a href="AdkWebServer.ApiServerSpanExporter.html" title="class in com.google.adk.web">AdkWebServer.ApiServerSpanExporter</a> apiServerSpanExporter,
|
|
<a href="AdkWebServer.RunnerService.html" title="class in com.google.adk.web">AdkWebServer.RunnerService</a> runnerService)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Constructs the AgentController.</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-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>org.springframework.http.ResponseEntity<wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addSessionToEvalSet(java.lang.String,java.lang.String,com.google.adk.web.AdkWebServer.AddSessionToEvalSetRequest)" class="member-name-link">addSessionToEvalSet</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> evalSetId,
|
|
<a href="AdkWebServer.AddSessionToEvalSetRequest.html" title="class in com.google.adk.web">AdkWebServer.AddSessionToEvalSetRequest</a> req)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Placeholder for adding a session to an evaluation set.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><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="#agentRun(com.google.adk.web.AdkWebServer.AgentRunRequest)" class="member-name-link">agentRun</a><wbr>(<a href="AdkWebServer.AgentRunRequest.html" title="class in com.google.adk.web">AdkWebServer.AgentRunRequest</a> request)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Executes a non-streaming agent run for a given session and message.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.springframework.web.servlet.mvc.method.annotation.SseEmitter</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#agentRunSse(com.google.adk.web.AdkWebServer.AgentRunRequest)" class="member-name-link">agentRunSse</a><wbr>(<a href="AdkWebServer.AgentRunRequest.html" title="class in com.google.adk.web">AdkWebServer.AgentRunRequest</a> request)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Executes an agent run and streams the resulting events using Server-Sent Events (SSE).</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.springframework.http.ResponseEntity<wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createEvalSet(java.lang.String,java.lang.String)" class="member-name-link">createEvalSet</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> evalSetId)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Placeholder for creating an evaluation set.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../sessions/Session.html" title="class in com.google.adk.sessions">Session</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createSession(java.lang.String,java.lang.String,java.util.Map)" class="member-name-link">createSession</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> userId,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or 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 or interface 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 or interface in java.lang" class="external-link">Object</a>> state)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Creates a new session where the ID is generated by the service.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../sessions/Session.html" title="class in com.google.adk.sessions">Session</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createSessionWithId(java.lang.String,java.lang.String,java.lang.String,java.util.Map)" class="member-name-link">createSessionWithId</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface 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 or interface in java.lang" class="external-link">String</a> sessionId,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or 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 or interface 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 or interface in java.lang" class="external-link">Object</a>> state)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Creates a new session with a specific ID provided by the client.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.springframework.http.ResponseEntity<wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deleteArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">deleteArtifact</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface 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 or interface in java.lang" class="external-link">String</a> sessionId,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> artifactName)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Deletes an artifact and all its versions.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.springframework.http.ResponseEntity<wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deleteSession(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">deleteSession</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface 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 or interface in java.lang" class="external-link">String</a> sessionId)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Deletes a specific session.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.springframework.http.ResponseEntity<wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEvalResult(java.lang.String,java.lang.String)" class="member-name-link">getEvalResult</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> evalResultId)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Gets a specific evaluation result.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.springframework.http.ResponseEntity<wbr><<a href="AdkWebServer.GraphResponse.html" title="class in com.google.adk.web">AdkWebServer.GraphResponse</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEventGraph(java.lang.String,java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">getEventGraph</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface 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 or interface in java.lang" class="external-link">String</a> sessionId,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> eventId)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Endpoint to get a graph representation of an event (currently returns a placeholder).</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../sessions/Session.html" title="class in com.google.adk.sessions">Session</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSession(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">getSession</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface 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 or interface in java.lang" class="external-link">String</a> sessionId)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Retrieves a specific session by its ID.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.springframework.http.ResponseEntity<wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSessionTrace(java.lang.String)" class="member-name-link">getSessionTrace</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sessionId)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Retrieves trace spans for a given session ID.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.springframework.http.ResponseEntity<wbr><?></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTraceDict(java.lang.String)" class="member-name-link">getTraceDict</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> eventId)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Endpoint for retrieving trace information stored by the ApiServerSpanExporter, based on event
|
|
ID.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface 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="#listApps()" class="member-name-link">listApps</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Lists available applications.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#listArtifactNames(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">listArtifactNames</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface 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 or interface in java.lang" class="external-link">String</a> sessionId)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Lists the names of all artifacts associated with a session.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#listArtifactVersions(java.lang.String,java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">listArtifactVersions</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface 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 or interface in java.lang" class="external-link">String</a> sessionId,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> artifactName)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Lists the available versions for a specific artifact.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#listEvalResults(java.lang.String)" class="member-name-link">listEvalResults</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Lists all evaluation results for an app.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface 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="#listEvalSets(java.lang.String)" class="member-name-link">listEvalSets</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Placeholder for listing evaluation sets.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#listEvalsInEvalSet(java.lang.String,java.lang.String)" class="member-name-link">listEvalsInEvalSet</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> evalSetId)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Placeholder for listing evaluations within an evaluation set.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><wbr><<a href="../sessions/Session.html" title="class in com.google.adk.sessions">Session</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#listSessions(java.lang.String,java.lang.String)" class="member-name-link">listSessions</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> userId)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Lists all non-evaluation sessions for a given app and user.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>com.google.genai.types.Part</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#loadArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Integer)" class="member-name-link">loadArtifact</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface 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 or interface in java.lang" class="external-link">String</a> sessionId,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> artifactName,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> version)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Loads the latest or a specific version of an artifact associated with a session.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>com.google.genai.types.Part</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#loadArtifactVersion(java.lang.String,java.lang.String,java.lang.String,java.lang.String,int)" class="member-name-link">loadArtifactVersion</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface 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 or interface in java.lang" class="external-link">String</a> sessionId,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> artifactName,
|
|
int versionId)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Loads a specific version of an artifact.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><wbr><<a href="AdkWebServer.RunEvalResult.html" title="class in com.google.adk.web">AdkWebServer.RunEvalResult</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#runEval(java.lang.String,java.lang.String,com.google.adk.web.AdkWebServer.RunEvalRequest)" class="member-name-link">runEval</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> evalSetId,
|
|
<a href="AdkWebServer.RunEvalRequest.html" title="class in com.google.adk.web">AdkWebServer.RunEvalRequest</a> req)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Placeholder for running evaluations.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface 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="class or interface in java.lang" 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="class or interface in java.lang" 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="class or interface in java.lang" 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="class or interface in java.lang" 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="class or interface in java.lang" 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="class or interface in java.lang" 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="class or interface in java.lang" 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="class or interface in java.lang" 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="class or interface in java.lang" 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="class or interface in java.lang" 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="class or interface in java.lang" 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.sessions.BaseSessionService,com.google.adk.artifacts.BaseArtifactService,java.util.Map,com.google.adk.web.AdkWebServer.ApiServerSpanExporter,com.google.adk.web.AdkWebServer.RunnerService)">
|
|
<h3>AgentController</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@Autowired
|
|
</span><span class="modifiers">public</span> <span class="element-name">AgentController</span><wbr><span class="parameters">(<a href="../sessions/BaseSessionService.html" title="interface in com.google.adk.sessions">BaseSessionService</a> sessionService,
|
|
<a href="../artifacts/BaseArtifactService.html" title="interface in com.google.adk.artifacts">BaseArtifactService</a> artifactService,
|
|
@Qualifier("loadedAgentRegistry")
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or 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 or interface in java.lang" class="external-link">String</a>, <a href="../agents/BaseAgent.html" title="class in com.google.adk.agents">BaseAgent</a>> agentRegistry,
|
|
<a href="AdkWebServer.ApiServerSpanExporter.html" title="class in com.google.adk.web">AdkWebServer.ApiServerSpanExporter</a> apiServerSpanExporter,
|
|
<a href="AdkWebServer.RunnerService.html" title="class in com.google.adk.web">AdkWebServer.RunnerService</a> runnerService)</span></div>
|
|
<div class="block">Constructs the AgentController.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>sessionService</code> - The service for managing sessions.</dd>
|
|
<dd><code>artifactService</code> - The service for managing artifacts.</dd>
|
|
<dd><code>agentRegistry</code> - The registry of loaded agents.</dd>
|
|
<dd><code>apiServerSpanExporter</code> - The exporter holding all trace data.</dd>
|
|
<dd><code>runnerService</code> - The service for obtaining Runner instances.</dd>
|
|
</dl>
|
|
</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="listApps()">
|
|
<h3>listApps</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@GetMapping("/list-apps")
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">listApps</span>()</div>
|
|
<div class="block">Lists available applications. Currently returns only the configured root agent's name.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>A list containing the root agent's name.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getTraceDict(java.lang.String)">
|
|
<h3>getTraceDict</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@GetMapping("/debug/trace/{eventId}")
|
|
</span><span class="modifiers">public</span> <span class="return-type">org.springframework.http.ResponseEntity<?></span> <span class="element-name">getTraceDict</span><wbr><span class="parameters">(@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> eventId)</span></div>
|
|
<div class="block">Endpoint for retrieving trace information stored by the ApiServerSpanExporter, based on event
|
|
ID.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>eventId</code> - The ID of the event to trace (expected to be gcp.vertex.agent.event_id).</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>A ResponseEntity containing the trace data or NOT_FOUND.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getSessionTrace(java.lang.String)">
|
|
<h3>getSessionTrace</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@GetMapping("/debug/trace/session/{sessionId}")
|
|
</span><span class="modifiers">public</span> <span class="return-type">org.springframework.http.ResponseEntity<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></span> <span class="element-name">getSessionTrace</span><wbr><span class="parameters">(@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sessionId)</span></div>
|
|
<div class="block">Retrieves trace spans for a given session ID.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>sessionId</code> - The session ID.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>A ResponseEntity containing a list of span data maps for the session, or an empty
|
|
list.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getSession(java.lang.String,java.lang.String,java.lang.String)">
|
|
<h3>getSession</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@GetMapping("/apps/{appName}/users/{userId}/sessions/{sessionId}")
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="../sessions/Session.html" title="class in com.google.adk.sessions">Session</a></span> <span class="element-name">getSession</span><wbr><span class="parameters">(@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> userId,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sessionId)</span></div>
|
|
<div class="block">Retrieves a specific session by its ID.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>appName</code> - The application name.</dd>
|
|
<dd><code>userId</code> - The user ID.</dd>
|
|
<dd><code>sessionId</code> - The session ID.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The requested Session object.</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code>org.springframework.web.server.ResponseStatusException</code> - if the session is not found.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="listSessions(java.lang.String,java.lang.String)">
|
|
<h3>listSessions</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@GetMapping("/apps/{appName}/users/{userId}/sessions")
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../sessions/Session.html" title="class in com.google.adk.sessions">Session</a>></span> <span class="element-name">listSessions</span><wbr><span class="parameters">(@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> userId)</span></div>
|
|
<div class="block">Lists all non-evaluation sessions for a given app and user.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>appName</code> - The name of the application.</dd>
|
|
<dd><code>userId</code> - The ID of the user.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>A list of sessions, excluding those used for evaluation.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="createSessionWithId(java.lang.String,java.lang.String,java.lang.String,java.util.Map)">
|
|
<h3>createSessionWithId</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@PostMapping("/apps/{appName}/users/{userId}/sessions/{sessionId}")
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="../sessions/Session.html" title="class in com.google.adk.sessions">Session</a></span> <span class="element-name">createSessionWithId</span><wbr><span class="parameters">(@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> userId,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sessionId,
|
|
@RequestBody(required=false)
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or 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 or interface 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 or interface in java.lang" class="external-link">Object</a>> state)</span></div>
|
|
<div class="block">Creates a new session with a specific ID provided by the client.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>appName</code> - The application name.</dd>
|
|
<dd><code>userId</code> - The user ID.</dd>
|
|
<dd><code>sessionId</code> - The desired session ID.</dd>
|
|
<dd><code>state</code> - Optional initial state for the session.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The newly created Session object.</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code>org.springframework.web.server.ResponseStatusException</code> - if a session with the given ID already exists (BAD_REQUEST)
|
|
or if creation fails (INTERNAL_SERVER_ERROR).</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="createSession(java.lang.String,java.lang.String,java.util.Map)">
|
|
<h3>createSession</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@PostMapping("/apps/{appName}/users/{userId}/sessions")
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="../sessions/Session.html" title="class in com.google.adk.sessions">Session</a></span> <span class="element-name">createSession</span><wbr><span class="parameters">(@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> userId,
|
|
@RequestBody(required=false)
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or 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 or interface 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 or interface in java.lang" class="external-link">Object</a>> state)</span></div>
|
|
<div class="block">Creates a new session where the ID is generated by the service.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>appName</code> - The application name.</dd>
|
|
<dd><code>userId</code> - The user ID.</dd>
|
|
<dd><code>state</code> - Optional initial state for the session.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The newly created Session object.</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code>org.springframework.web.server.ResponseStatusException</code> - if creation fails (INTERNAL_SERVER_ERROR).</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="deleteSession(java.lang.String,java.lang.String,java.lang.String)">
|
|
<h3>deleteSession</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@DeleteMapping("/apps/{appName}/users/{userId}/sessions/{sessionId}")
|
|
</span><span class="modifiers">public</span> <span class="return-type">org.springframework.http.ResponseEntity<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></span> <span class="element-name">deleteSession</span><wbr><span class="parameters">(@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> userId,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sessionId)</span></div>
|
|
<div class="block">Deletes a specific session.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>appName</code> - The application name.</dd>
|
|
<dd><code>userId</code> - The user ID.</dd>
|
|
<dd><code>sessionId</code> - The session ID to delete.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>A ResponseEntity with status NO_CONTENT on success.</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code>org.springframework.web.server.ResponseStatusException</code> - if deletion fails (INTERNAL_SERVER_ERROR).</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="loadArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Integer)">
|
|
<h3>loadArtifact</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@GetMapping("/apps/{appName}/users/{userId}/sessions/{sessionId}/artifacts/{artifactName}")
|
|
</span><span class="modifiers">public</span> <span class="return-type">com.google.genai.types.Part</span> <span class="element-name">loadArtifact</span><wbr><span class="parameters">(@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> userId,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sessionId,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> artifactName,
|
|
@RequestParam(required=false)
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> version)</span></div>
|
|
<div class="block">Loads the latest or a specific version of an artifact associated with a session.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>appName</code> - The application name.</dd>
|
|
<dd><code>userId</code> - The user ID.</dd>
|
|
<dd><code>sessionId</code> - The session ID.</dd>
|
|
<dd><code>artifactName</code> - The name of the artifact.</dd>
|
|
<dd><code>version</code> - Optional specific version number. If null, loads the latest.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The artifact content as a Part object.</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code>org.springframework.web.server.ResponseStatusException</code> - if the artifact is not found (NOT_FOUND).</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="loadArtifactVersion(java.lang.String,java.lang.String,java.lang.String,java.lang.String,int)">
|
|
<h3>loadArtifactVersion</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@GetMapping("/apps/{appName}/users/{userId}/sessions/{sessionId}/artifacts/{artifactName}/versions/{versionId}")
|
|
</span><span class="modifiers">public</span> <span class="return-type">com.google.genai.types.Part</span> <span class="element-name">loadArtifactVersion</span><wbr><span class="parameters">(@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> userId,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sessionId,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> artifactName,
|
|
@PathVariable
|
|
int versionId)</span></div>
|
|
<div class="block">Loads a specific version of an artifact.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>appName</code> - The application name.</dd>
|
|
<dd><code>userId</code> - The user ID.</dd>
|
|
<dd><code>sessionId</code> - The session ID.</dd>
|
|
<dd><code>artifactName</code> - The name of the artifact.</dd>
|
|
<dd><code>versionId</code> - The specific version number.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The artifact content as a Part object.</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code>org.springframework.web.server.ResponseStatusException</code> - if the artifact version is not found (NOT_FOUND).</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="listArtifactNames(java.lang.String,java.lang.String,java.lang.String)">
|
|
<h3>listArtifactNames</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@GetMapping("/apps/{appName}/users/{userId}/sessions/{sessionId}/artifacts")
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">listArtifactNames</span><wbr><span class="parameters">(@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> userId,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sessionId)</span></div>
|
|
<div class="block">Lists the names of all artifacts associated with a session.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>appName</code> - The application name.</dd>
|
|
<dd><code>userId</code> - The user ID.</dd>
|
|
<dd><code>sessionId</code> - The session ID.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>A list of artifact names.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="listArtifactVersions(java.lang.String,java.lang.String,java.lang.String,java.lang.String)">
|
|
<h3>listArtifactVersions</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@GetMapping("/apps/{appName}/users/{userId}/sessions/{sessionId}/artifacts/{artifactName}/versions")
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></span> <span class="element-name">listArtifactVersions</span><wbr><span class="parameters">(@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> userId,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sessionId,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> artifactName)</span></div>
|
|
<div class="block">Lists the available versions for a specific artifact.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>appName</code> - The application name.</dd>
|
|
<dd><code>userId</code> - The user ID.</dd>
|
|
<dd><code>sessionId</code> - The session ID.</dd>
|
|
<dd><code>artifactName</code> - The name of the artifact.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>A list of version numbers (integers).</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="deleteArtifact(java.lang.String,java.lang.String,java.lang.String,java.lang.String)">
|
|
<h3>deleteArtifact</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@DeleteMapping("/apps/{appName}/users/{userId}/sessions/{sessionId}/artifacts/{artifactName}")
|
|
</span><span class="modifiers">public</span> <span class="return-type">org.springframework.http.ResponseEntity<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></span> <span class="element-name">deleteArtifact</span><wbr><span class="parameters">(@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> userId,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sessionId,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> artifactName)</span></div>
|
|
<div class="block">Deletes an artifact and all its versions.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>appName</code> - The application name.</dd>
|
|
<dd><code>userId</code> - The user ID.</dd>
|
|
<dd><code>sessionId</code> - The session ID.</dd>
|
|
<dd><code>artifactName</code> - The name of the artifact to delete.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>A ResponseEntity with status NO_CONTENT on success.</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code>org.springframework.web.server.ResponseStatusException</code> - if deletion fails (INTERNAL_SERVER_ERROR).</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="agentRun(com.google.adk.web.AdkWebServer.AgentRunRequest)">
|
|
<h3>agentRun</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@PostMapping("/run")
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../events/Event.html" title="class in com.google.adk.events">Event</a>></span> <span class="element-name">agentRun</span><wbr><span class="parameters">(@RequestBody
|
|
<a href="AdkWebServer.AgentRunRequest.html" title="class in com.google.adk.web">AdkWebServer.AgentRunRequest</a> request)</span></div>
|
|
<div class="block">Executes a non-streaming agent run for a given session and message.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>request</code> - The AgentRunRequest containing run details.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>A list of events generated during the run.</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code>org.springframework.web.server.ResponseStatusException</code> - if the session is not found or the run fails.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="agentRunSse(com.google.adk.web.AdkWebServer.AgentRunRequest)">
|
|
<h3>agentRunSse</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@PostMapping(value="/run_sse",
|
|
produces="text/event-stream")
|
|
</span><span class="modifiers">public</span> <span class="return-type">org.springframework.web.servlet.mvc.method.annotation.SseEmitter</span> <span class="element-name">agentRunSse</span><wbr><span class="parameters">(@RequestBody
|
|
<a href="AdkWebServer.AgentRunRequest.html" title="class in com.google.adk.web">AdkWebServer.AgentRunRequest</a> request)</span></div>
|
|
<div class="block">Executes an agent run and streams the resulting events using Server-Sent Events (SSE).</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>request</code> - The AgentRunRequest containing run details.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>A Flux that will stream events to the client.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getEventGraph(java.lang.String,java.lang.String,java.lang.String,java.lang.String)">
|
|
<h3>getEventGraph</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@GetMapping("/apps/{appName}/users/{userId}/sessions/{sessionId}/events/{eventId}/graph")
|
|
</span><span class="modifiers">public</span> <span class="return-type">org.springframework.http.ResponseEntity<<a href="AdkWebServer.GraphResponse.html" title="class in com.google.adk.web">AdkWebServer.GraphResponse</a>></span> <span class="element-name">getEventGraph</span><wbr><span class="parameters">(@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> userId,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sessionId,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> eventId)</span></div>
|
|
<div class="block">Endpoint to get a graph representation of an event (currently returns a placeholder).
|
|
Requires Graphviz or similar tooling for full implementation.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>appName</code> - Application name.</dd>
|
|
<dd><code>userId</code> - User ID.</dd>
|
|
<dd><code>sessionId</code> - Session ID.</dd>
|
|
<dd><code>eventId</code> - Event ID.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>ResponseEntity containing a GraphResponse with placeholder DOT source.</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code>org.springframework.web.server.ResponseStatusException</code> - if the session or event is not found.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="createEvalSet(java.lang.String,java.lang.String)">
|
|
<h3>createEvalSet</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@PostMapping("/apps/{appName}/eval_sets/{evalSetId}")
|
|
</span><span class="modifiers">public</span> <span class="return-type">org.springframework.http.ResponseEntity<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></span> <span class="element-name">createEvalSet</span><wbr><span class="parameters">(@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> evalSetId)</span></div>
|
|
<div class="block">Placeholder for creating an evaluation set.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="listEvalSets(java.lang.String)">
|
|
<h3>listEvalSets</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@GetMapping("/apps/{appName}/eval_sets")
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">listEvalSets</span><wbr><span class="parameters">(@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName)</span></div>
|
|
<div class="block">Placeholder for listing evaluation sets.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="addSessionToEvalSet(java.lang.String,java.lang.String,com.google.adk.web.AdkWebServer.AddSessionToEvalSetRequest)">
|
|
<h3>addSessionToEvalSet</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@PostMapping("/apps/{appName}/eval_sets/{evalSetId}/add-session")
|
|
</span><span class="modifiers">public</span> <span class="return-type">org.springframework.http.ResponseEntity<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></span> <span class="element-name">addSessionToEvalSet</span><wbr><span class="parameters">(@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> evalSetId,
|
|
@RequestBody
|
|
<a href="AdkWebServer.AddSessionToEvalSetRequest.html" title="class in com.google.adk.web">AdkWebServer.AddSessionToEvalSetRequest</a> req)</span></div>
|
|
<div class="block">Placeholder for adding a session to an evaluation set.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="listEvalsInEvalSet(java.lang.String,java.lang.String)">
|
|
<h3>listEvalsInEvalSet</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@GetMapping("/apps/{appName}/eval_sets/{evalSetId}/evals")
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">listEvalsInEvalSet</span><wbr><span class="parameters">(@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> evalSetId)</span></div>
|
|
<div class="block">Placeholder for listing evaluations within an evaluation set.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="runEval(java.lang.String,java.lang.String,com.google.adk.web.AdkWebServer.RunEvalRequest)">
|
|
<h3>runEval</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@PostMapping("/apps/{appName}/eval_sets/{evalSetId}/run-eval")
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="AdkWebServer.RunEvalResult.html" title="class in com.google.adk.web">AdkWebServer.RunEvalResult</a>></span> <span class="element-name">runEval</span><wbr><span class="parameters">(@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> evalSetId,
|
|
@RequestBody
|
|
<a href="AdkWebServer.RunEvalRequest.html" title="class in com.google.adk.web">AdkWebServer.RunEvalRequest</a> req)</span></div>
|
|
<div class="block">Placeholder for running evaluations.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getEvalResult(java.lang.String,java.lang.String)">
|
|
<h3>getEvalResult</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@GetMapping("/apps/{appName}/eval_results/{evalResultId}")
|
|
</span><span class="modifiers">public</span> <span class="return-type">org.springframework.http.ResponseEntity<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></span> <span class="element-name">getEvalResult</span><wbr><span class="parameters">(@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName,
|
|
@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> evalResultId)</span></div>
|
|
<div class="block">Gets a specific evaluation result. (STUB - Not Implemented)</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>appName</code> - The application name.</dd>
|
|
<dd><code>evalResultId</code> - The evaluation result ID.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>A ResponseEntity indicating the endpoint is not implemented.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="listEvalResults(java.lang.String)">
|
|
<h3>listEvalResults</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="annotations">@GetMapping("/apps/{appName}/eval_results")
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">listEvalResults</span><wbr><span class="parameters">(@PathVariable
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> appName)</span></div>
|
|
<div class="block">Lists all evaluation results for an app. (STUB - Not Implemented)</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>appName</code> - The application name.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>An empty list, as this endpoint is not implemented.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<footer role="contentinfo">
|
|
<hr>
|
|
<p class="legal-copy"><small>Copyright © 2025. All rights reserved.</small></p>
|
|
</footer>
|
|
</main>
|
|
</div>
|
|
</body>
|
|
</html>
|