mirror of
https://github.com/google/adk-docs.git
synced 2026-09-14 16:16:59 +08:00
391 lines
30 KiB
HTML
391 lines
30 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>LlmRequest (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.models, class: LlmRequest">
|
|
<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/LlmRequest.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.models</a></li>
|
|
<li><a href="LlmRequest.html" class="current-selection">LlmRequest</a></li>
|
|
</ol>
|
|
<div class="nav-list-search"><input type="text" id="search-input" disabled placeholder="Search documentation (type /)" aria-label="Search in documentation" autocomplete="off" spellcheck="false"><input type="reset" id="reset-search" disabled value="Reset"></div>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
</header>
|
|
<div class="main-grid">
|
|
<nav role="navigation" class="toc" aria-label="Table of contents">
|
|
<div class="toc-header">Contents <input type="text" class="filter-input" disabled placeholder="Filter contents (type .)" aria-label="Filter table of contents" autocomplete="off" spellcheck="false"><input type="reset" class="reset-filter" disabled tabindex="-1" value="Reset"> <button class="toc-sort-toggle" id="toc-lexical-order-toggle"><img src="../../../../resource-files/sort-a-z.svg" alt="Sort member details in lexicographical order"></button></div>
|
|
<ol class="toc-list" tabindex="-1">
|
|
<li><a href="#" tabindex="0">Description</a></li>
|
|
<li><a href="#nested-class-summary" tabindex="0">Nested Class Summary</a></li>
|
|
<li><a href="#constructor-summary" tabindex="0">Constructor Summary</a></li>
|
|
<li><a href="#method-summary" tabindex="0">Method Summary</a>
|
|
<ol class="toc-list">
|
|
<li><a href="#methods-inherited-from-class-com.google.adk.JsonBaseModel" tabindex="0">Methods inherited from class JsonBaseModel</a></li>
|
|
<li><a href="#methods-inherited-from-class-java.lang.Object" tabindex="0">Methods inherited from class Object</a></li>
|
|
</ol>
|
|
</li>
|
|
<li><a href="#constructor-detail" tabindex="0">Constructor Details</a>
|
|
<ol class="toc-list">
|
|
<li><a href="#%3Cinit%3E()" tabindex="0">LlmRequest()</a></li>
|
|
</ol>
|
|
</li>
|
|
<li><a href="#method-detail" tabindex="0">Method Details</a>
|
|
<ol class="toc-list">
|
|
<li><a href="#model()" tabindex="0">model()</a></li>
|
|
<li><a href="#contents()" tabindex="0">contents()</a></li>
|
|
<li><a href="#config()" tabindex="0">config()</a></li>
|
|
<li><a href="#liveConnectConfig()" tabindex="0">liveConnectConfig()</a></li>
|
|
<li><a href="#tools()" tabindex="0">tools()</a></li>
|
|
<li><a href="#getFirstSystemInstruction()" tabindex="0">getFirstSystemInstruction()</a></li>
|
|
<li><a href="#getSystemInstructions()" tabindex="0">getSystemInstructions()</a></li>
|
|
<li><a href="#builder()" tabindex="0">builder()</a></li>
|
|
<li><a href="#toBuilder()" tabindex="0">toBuilder()</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 LlmRequest" class="title">Class LlmRequest</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">java.lang.Object</a>
|
|
<div class="inheritance"><a href="../JsonBaseModel.html" title="class in com.google.adk">com.google.adk.JsonBaseModel</a>
|
|
<div class="inheritance">com.google.adk.models.LlmRequest</div>
|
|
</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<hr>
|
|
<div class="horizontal-scroll">
|
|
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">LlmRequest</span>
|
|
<span class="extends-implements">extends <a href="../JsonBaseModel.html" title="class in com.google.adk">JsonBaseModel</a></span></div>
|
|
<div class="block">Represents a request to be sent to the LLM.</div>
|
|
</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
<li>
|
|
<section class="nested-class-summary" id="nested-class-summary">
|
|
<h2>Nested Class Summary</h2>
|
|
<div class="caption"><span>Nested Classes</span></div>
|
|
<div class="summary-table three-column-summary">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Class</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code>static class </code></div>
|
|
<div class="col-second even-row-color"><code><a href="LlmRequest.Builder.html" class="type-name-link" title="class in com.google.adk.models">LlmRequest.Builder</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Builder for constructing <a href="LlmRequest.html" title="class in com.google.adk.models"><code>LlmRequest</code></a> instances.</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<li>
|
|
<section class="constructor-summary" id="constructor-summary">
|
|
<h2>Constructor Summary</h2>
|
|
<div class="caption"><span>Constructors</span></div>
|
|
<div class="summary-table 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()" class="member-name-link">LlmRequest</a>()</code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method-summary">
|
|
<h2>Method Summary</h2>
|
|
<div id="method-summary-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-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-tab1 method-summary-table-tab4"><code>static <a href="LlmRequest.Builder.html" title="class in com.google.adk.models">LlmRequest.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#builder()" class="member-name-link">builder</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class in java.util" class="external-link">Optional</a><wbr><com.google.genai.types.GenerateContentConfig></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#config()" class="member-name-link">config</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Returns the configuration for content generation.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><wbr><com.google.genai.types.Content></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#contents()" class="member-name-link">contents</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Returns the list of content sent to the LLM.</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/Optional.html" title="class in java.util" class="external-link">Optional</a><wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFirstSystemInstruction()" class="member-name-link">getFirstSystemInstruction</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">returns the first system instruction text from the request if present.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>com.google.common.collect.ImmutableList<wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSystemInstructions()" class="member-name-link">getSystemInstructions</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Returns all system instruction texts from the request as an immutable list.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract com.google.genai.types.LiveConnectConfig</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#liveConnectConfig()" class="member-name-link">liveConnectConfig</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Returns the configuration for live connections.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class in java.util" class="external-link">Optional</a><wbr><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#model()" class="member-name-link">model</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Returns the name of the LLM model to be used.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="LlmRequest.Builder.html" title="class in com.google.adk.models">LlmRequest.Builder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toBuilder()" class="member-name-link">toBuilder</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <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><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>,<wbr><a href="../tools/BaseTool.html" title="class in com.google.adk.tools">BaseTool</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#tools()" class="member-name-link">tools</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Returns a map of tools available to the LLM.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-com.google.adk.JsonBaseModel">Methods inherited from class <a href="../JsonBaseModel.html#method-summary" title="class in com.google.adk">JsonBaseModel</a></h3>
|
|
<code><a href="../JsonBaseModel.html#fromJsonNode(com.fasterxml.jackson.databind.JsonNode,java.lang.Class)" title="fromJsonNode(JsonNode, Class)">fromJsonNode</a>, <a href="../JsonBaseModel.html#fromJsonString(java.lang.String,java.lang.Class)" title="fromJsonString(String, Class)">fromJsonString</a>, <a href="../JsonBaseModel.html#getMapper()" title="getMapper()">getMapper</a>, <a href="../JsonBaseModel.html#toJson()" title="toJson()">toJson</a>, <a href="../JsonBaseModel.html#toJsonNode(java.lang.Object)" title="toJsonNode(Object)">toJsonNode</a>, <a href="../JsonBaseModel.html#toJsonString(java.lang.Object)" title="toJsonString(Object)">toJsonString</a></code>
|
|
<div class="summary-table three-column-summary">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Method</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code>static <T extends <a href="../JsonBaseModel.html" title="class in com.google.adk">JsonBaseModel</a>><br>T</code></div>
|
|
<div class="col-second even-row-color"><code><a href="../JsonBaseModel.html#fromJsonNode(com.fasterxml.jackson.databind.JsonNode,java.lang.Class)" class="member-name-link">fromJsonNode</a><wbr>(com.fasterxml.jackson.databind.JsonNode jsonNode,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class in java.lang" class="external-link">Class</a><T> clazz)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Deserializes a JsonNode to an object of the given type.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static <T extends <a href="../JsonBaseModel.html" title="class in com.google.adk">JsonBaseModel</a>><br>T</code></div>
|
|
<div class="col-second odd-row-color"><code><a href="../JsonBaseModel.html#fromJsonString(java.lang.String,java.lang.Class)" class="member-name-link">fromJsonString</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> jsonString,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class in java.lang" class="external-link">Class</a><T> clazz)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Deserializes a Json string to an object of the given type.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>static com.fasterxml.jackson.databind.ObjectMapper</code></div>
|
|
<div class="col-second even-row-color"><code><a href="../JsonBaseModel.html#getMapper()" class="member-name-link">getMapper</a>()</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Returns the mutable ObjectMapper instance used by ADK.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="../JsonBaseModel.html#toJson()" class="member-name-link">toJson</a>()</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Serializes this object (i.e., the ObjectMappper instance used by ADK) to a Json string.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>protected static com.fasterxml.jackson.databind.JsonNode</code></div>
|
|
<div class="col-second even-row-color"><code><a href="../JsonBaseModel.html#toJsonNode(java.lang.Object)" class="member-name-link">toJsonNode</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> object)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Serializes an object to a JsonNode.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="../JsonBaseModel.html#toJsonString(java.lang.Object)" class="member-name-link">toJsonString</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> object)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Serializes an object to a Json string.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary" title="class in java.lang" class="external-link">Object</a></h3>
|
|
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="clone()" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="equals(Object)" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="finalize()" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="getClass()" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="hashCode()" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="notify()" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="notifyAll()" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="toString()" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="wait()" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="wait(long)" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="wait(long, int)" class="external-link">wait</a></code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li>
|
|
<section class="constructor-details" id="constructor-detail">
|
|
<h2>Constructor Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="<init>()">
|
|
<h3>LlmRequest</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">LlmRequest</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="model()">
|
|
<h3>model</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class in java.util" class="external-link">Optional</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>></span> <span class="element-name">model</span>()</div>
|
|
<div class="block">Returns the name of the LLM model to be used. If not set, the default model of the LLM class
|
|
will be used.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>An optional string representing the model name.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="contents()">
|
|
<h3>contents</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="interface in java.util" class="external-link">List</a><com.google.genai.types.Content></span> <span class="element-name">contents</span>()</div>
|
|
<div class="block">Returns the list of content sent to the LLM.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>A list of <code>Content</code> objects.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="config()">
|
|
<h3>config</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class in java.util" class="external-link">Optional</a><com.google.genai.types.GenerateContentConfig></span> <span class="element-name">config</span>()</div>
|
|
<div class="block">Returns the configuration for content generation.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>An optional <code>GenerateContentConfig</code> object containing the generation settings.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="liveConnectConfig()">
|
|
<h3>liveConnectConfig</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">com.google.genai.types.LiveConnectConfig</span> <span class="element-name">liveConnectConfig</span>()</div>
|
|
<div class="block">Returns the configuration for live connections. Populated using the RunConfig in the
|
|
InvocationContext.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>An optional <code>LiveConnectConfig</code> object containing the live connection settings.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="tools()">
|
|
<h3>tools</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><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="../tools/BaseTool.html" title="class in com.google.adk.tools">BaseTool</a>></span> <span class="element-name">tools</span>()</div>
|
|
<div class="block">Returns a map of tools available to the LLM.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>A map where keys are tool names and values are <a href="../tools/BaseTool.html" title="class in com.google.adk.tools"><code>BaseTool</code></a> instances.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getFirstSystemInstruction()">
|
|
<h3>getFirstSystemInstruction</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class in java.util" class="external-link">Optional</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>></span> <span class="element-name">getFirstSystemInstruction</span>()</div>
|
|
<div class="block">returns the first system instruction text from the request if present.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getSystemInstructions()">
|
|
<h3>getSystemInstructions</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.google.common.collect.ImmutableList<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>></span> <span class="element-name">getSystemInstructions</span>()</div>
|
|
<div class="block">Returns all system instruction texts from the request as an immutable list.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="builder()">
|
|
<h3>builder</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="LlmRequest.Builder.html" title="class in com.google.adk.models">LlmRequest.Builder</a></span> <span class="element-name">builder</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="toBuilder()">
|
|
<h3>toBuilder</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="LlmRequest.Builder.html" title="class in com.google.adk.models">LlmRequest.Builder</a></span> <span class="element-name">toBuilder</span>()</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<footer>
|
|
<hr>
|
|
<p class="legal-copy"><small>Copyright © 1980. All rights reserved.</small></p>
|
|
</footer>
|
|
</main>
|
|
</div>
|
|
</body>
|
|
</html>
|