mirror of
https://github.com/google/adk-docs.git
synced 2026-09-14 16:16:59 +08:00
382 lines
29 KiB
HTML
382 lines
29 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>GeminiUtil (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: GeminiUtil">
|
|
<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/GeminiUtil.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="GeminiUtil.html" class="current-selection">GeminiUtil</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="#field-summary" tabindex="0">Field Summary</a></li>
|
|
<li><a href="#method-summary" tabindex="0">Method Summary</a></li>
|
|
<li><a href="#field-detail" tabindex="0">Field Details</a>
|
|
<ol class="toc-list">
|
|
<li><a href="#CONTINUE_OUTPUT_MESSAGE" tabindex="0">CONTINUE_OUTPUT_MESSAGE</a></li>
|
|
</ol>
|
|
</li>
|
|
<li><a href="#method-detail" tabindex="0">Method Details</a>
|
|
<ol class="toc-list">
|
|
<li><a href="#prepareGenenerateContentRequest(com.google.adk.models.LlmRequest,boolean)" tabindex="0">prepareGenenerateContentRequest(LlmRequest, boolean)</a></li>
|
|
<li><a href="#prepareGenenerateContentRequest(com.google.adk.models.LlmRequest,boolean,boolean)" tabindex="0">prepareGenenerateContentRequest(LlmRequest, boolean, boolean)</a></li>
|
|
<li><a href="#sanitizeRequestForGeminiApi(com.google.adk.models.LlmRequest)" tabindex="0">sanitizeRequestForGeminiApi(LlmRequest)</a></li>
|
|
<li><a href="#removeClientFunctionCallId(com.google.adk.models.LlmRequest)" tabindex="0">removeClientFunctionCallId(LlmRequest)</a></li>
|
|
<li><a href="#getPart0FromLlmResponse(com.google.adk.models.LlmResponse)" tabindex="0">getPart0FromLlmResponse(LlmResponse)</a></li>
|
|
<li><a href="#getTextFromLlmResponse(com.google.adk.models.LlmResponse)" tabindex="0">getTextFromLlmResponse(LlmResponse)</a></li>
|
|
<li><a href="#shouldEmitAccumulatedText(com.google.adk.models.LlmResponse)" tabindex="0">shouldEmitAccumulatedText(LlmResponse)</a></li>
|
|
<li><a href="#stripThoughts(java.util.List)" tabindex="0">stripThoughts(List)</a></li>
|
|
<li><a href="#toGenerateContentResponseUsageMetadata(com.google.genai.types.UsageMetadata)" tabindex="0">toGenerateContentResponseUsageMetadata(UsageMetadata)</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 GeminiUtil" class="title">Class GeminiUtil</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">java.lang.Object</a>
|
|
<div class="inheritance">com.google.adk.models.GeminiUtil</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<hr>
|
|
<div class="horizontal-scroll">
|
|
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">GeminiUtil</span>
|
|
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a></span></div>
|
|
<div class="block">Request / Response utilities for <a href="Gemini.html" title="class in com.google.adk.models"><code>Gemini</code></a>.</div>
|
|
</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<li>
|
|
<section class="field-summary" id="field-summary">
|
|
<h2>Field Summary</h2>
|
|
<div class="caption"><span>Fields</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">Field</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code>static final <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"><code><a href="#CONTINUE_OUTPUT_MESSAGE" class="member-name-link">CONTINUE_OUTPUT_MESSAGE</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-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="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.Part></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getPart0FromLlmResponse(com.google.adk.models.LlmResponse)" class="member-name-link">getPart0FromLlmResponse</a><wbr>(<a href="LlmResponse.html" title="class in com.google.adk.models">LlmResponse</a> llmResponse)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Extracts the first part of an LlmResponse, if available.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><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 method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getTextFromLlmResponse(com.google.adk.models.LlmResponse)" class="member-name-link">getTextFromLlmResponse</a><wbr>(<a href="LlmResponse.html" title="class in com.google.adk.models">LlmResponse</a> llmResponse)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Extracts text content from the first part of an LlmResponse, if available.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="LlmRequest.html" title="class in com.google.adk.models">LlmRequest</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#prepareGenenerateContentRequest(com.google.adk.models.LlmRequest,boolean)" class="member-name-link">prepareGenenerateContentRequest</a><wbr>(<a href="LlmRequest.html" title="class in com.google.adk.models">LlmRequest</a> llmRequest,
|
|
boolean sanitize)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Prepares an <a href="LlmRequest.html" title="class in com.google.adk.models"><code>LlmRequest</code></a> for the GenerateContent API.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="LlmRequest.html" title="class in com.google.adk.models">LlmRequest</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#prepareGenenerateContentRequest(com.google.adk.models.LlmRequest,boolean,boolean)" class="member-name-link">prepareGenenerateContentRequest</a><wbr>(<a href="LlmRequest.html" title="class in com.google.adk.models">LlmRequest</a> llmRequest,
|
|
boolean sanitize,
|
|
boolean stripThoughts)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Prepares an <a href="LlmRequest.html" title="class in com.google.adk.models"><code>LlmRequest</code></a> for the GenerateContent API.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="LlmRequest.html" title="class in com.google.adk.models">LlmRequest</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#removeClientFunctionCallId(com.google.adk.models.LlmRequest)" class="member-name-link">removeClientFunctionCallId</a><wbr>(<a href="LlmRequest.html" title="class in com.google.adk.models">LlmRequest</a> llmRequest)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Removes client-side function call IDs from the request.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="LlmRequest.html" title="class in com.google.adk.models">LlmRequest</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#sanitizeRequestForGeminiApi(com.google.adk.models.LlmRequest)" class="member-name-link">sanitizeRequestForGeminiApi</a><wbr>(<a href="LlmRequest.html" title="class in com.google.adk.models">LlmRequest</a> llmRequest)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Sanitizes the request to ensure it is compatible with the Gemini API backend.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#shouldEmitAccumulatedText(com.google.adk.models.LlmResponse)" class="member-name-link">shouldEmitAccumulatedText</a><wbr>(<a href="LlmResponse.html" title="class in com.google.adk.models">LlmResponse</a> currentLlmResponse)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Determines if accumulated text should be emitted based on the current LlmResponse.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static com.google.common.collect.ImmutableList<wbr><com.google.genai.types.Content></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#stripThoughts(java.util.List)" class="member-name-link">stripThoughts</a><wbr>(<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> originalContents)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Removes any `Part` that contains only a `thought` from the content list.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static com.google.genai.types.GenerateContentResponseUsageMetadata</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toGenerateContentResponseUsageMetadata(com.google.genai.types.UsageMetadata)" class="member-name-link">toGenerateContentResponseUsageMetadata</a><wbr>(com.google.genai.types.UsageMetadata usageMetadata)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary" title="class in java.lang" class="external-link">Object</a></h3>
|
|
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="clone()" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="equals(Object)" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="finalize()" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="getClass()" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="hashCode()" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="notify()" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="notifyAll()" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="toString()" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="wait()" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="wait(long)" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="wait(long, int)" class="external-link">wait</a></code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
<li>
|
|
<section class="field-details" id="field-detail">
|
|
<h2>Field Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="CONTINUE_OUTPUT_MESSAGE">
|
|
<h3>CONTINUE_OUTPUT_MESSAGE</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a></span> <span class="element-name">CONTINUE_OUTPUT_MESSAGE</span></div>
|
|
<dl class="notes">
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="tag-list">
|
|
<li><a href="../../../../constant-values.html#com.google.adk.models.GeminiUtil.CONTINUE_OUTPUT_MESSAGE">Constant Field Values</a></li>
|
|
</ul>
|
|
</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="prepareGenenerateContentRequest(com.google.adk.models.LlmRequest,boolean)">
|
|
<h3>prepareGenenerateContentRequest</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="LlmRequest.html" title="class in com.google.adk.models">LlmRequest</a></span> <span class="element-name">prepareGenenerateContentRequest</span><wbr><span class="parameters">(<a href="LlmRequest.html" title="class in com.google.adk.models">LlmRequest</a> llmRequest,
|
|
boolean sanitize)</span></div>
|
|
<div class="block">Prepares an <a href="LlmRequest.html" title="class in com.google.adk.models"><code>LlmRequest</code></a> for the GenerateContent API.
|
|
|
|
<p>This method can optionally sanitize the request and ensures that the last content part is
|
|
from the user to prompt a model response.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>llmRequest</code> - The original <a href="LlmRequest.html" title="class in com.google.adk.models"><code>LlmRequest</code></a>.</dd>
|
|
<dd><code>sanitize</code> - Whether to sanitize the request to be compatible with the Gemini API backend.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The prepared <a href="LlmRequest.html" title="class in com.google.adk.models"><code>LlmRequest</code></a>.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="prepareGenenerateContentRequest(com.google.adk.models.LlmRequest,boolean,boolean)">
|
|
<h3>prepareGenenerateContentRequest</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="LlmRequest.html" title="class in com.google.adk.models">LlmRequest</a></span> <span class="element-name">prepareGenenerateContentRequest</span><wbr><span class="parameters">(<a href="LlmRequest.html" title="class in com.google.adk.models">LlmRequest</a> llmRequest,
|
|
boolean sanitize,
|
|
boolean stripThoughts)</span></div>
|
|
<div class="block">Prepares an <a href="LlmRequest.html" title="class in com.google.adk.models"><code>LlmRequest</code></a> for the GenerateContent API.
|
|
|
|
<p>This method can optionally sanitize the request and ensures that the last content part is
|
|
from the user to prompt a model response. It also strips out any parts marked as "thoughts" and
|
|
removes client-side function call IDs as some LLM APIs reject requests with client-side
|
|
function call IDs.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>llmRequest</code> - The original <a href="LlmRequest.html" title="class in com.google.adk.models"><code>LlmRequest</code></a>.</dd>
|
|
<dd><code>sanitize</code> - Whether to sanitize the request to be compatible with the Gemini API backend.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The prepared <a href="LlmRequest.html" title="class in com.google.adk.models"><code>LlmRequest</code></a>.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="sanitizeRequestForGeminiApi(com.google.adk.models.LlmRequest)">
|
|
<h3>sanitizeRequestForGeminiApi</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="LlmRequest.html" title="class in com.google.adk.models">LlmRequest</a></span> <span class="element-name">sanitizeRequestForGeminiApi</span><wbr><span class="parameters">(<a href="LlmRequest.html" title="class in com.google.adk.models">LlmRequest</a> llmRequest)</span></div>
|
|
<div class="block">Sanitizes the request to ensure it is compatible with the Gemini API backend. Required as there
|
|
are some parameters that if included in the request will raise a runtime error if sent to the
|
|
wrong backend (e.g. image names only work on Vertex AI).</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>llmRequest</code> - The request to sanitize.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The sanitized request.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="removeClientFunctionCallId(com.google.adk.models.LlmRequest)">
|
|
<h3>removeClientFunctionCallId</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="LlmRequest.html" title="class in com.google.adk.models">LlmRequest</a></span> <span class="element-name">removeClientFunctionCallId</span><wbr><span class="parameters">(<a href="LlmRequest.html" title="class in com.google.adk.models">LlmRequest</a> llmRequest)</span></div>
|
|
<div class="block">Removes client-side function call IDs from the request.
|
|
|
|
<p>Client-side function call IDs are internal to the ADK and should not be sent to the model.
|
|
This method iterates through the contents and parts, removing the ID from any <code>FunctionCall</code> or <code>FunctionResponse</code> parts.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>llmRequest</code> - The request to process.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>A new <a href="LlmRequest.html" title="class in com.google.adk.models"><code>LlmRequest</code></a> with function call IDs removed.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getPart0FromLlmResponse(com.google.adk.models.LlmResponse)">
|
|
<h3>getPart0FromLlmResponse</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public static</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.Part></span> <span class="element-name">getPart0FromLlmResponse</span><wbr><span class="parameters">(<a href="LlmResponse.html" title="class in com.google.adk.models">LlmResponse</a> llmResponse)</span></div>
|
|
<div class="block">Extracts the first part of an LlmResponse, if available.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>llmResponse</code> - The LlmResponse to extract the first part from.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The first part, or an empty optional if not found.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getTextFromLlmResponse(com.google.adk.models.LlmResponse)">
|
|
<h3>getTextFromLlmResponse</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a></span> <span class="element-name">getTextFromLlmResponse</span><wbr><span class="parameters">(<a href="LlmResponse.html" title="class in com.google.adk.models">LlmResponse</a> llmResponse)</span></div>
|
|
<div class="block">Extracts text content from the first part of an LlmResponse, if available.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>llmResponse</code> - The LlmResponse to extract text from.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The text content, or an empty string if not found.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="shouldEmitAccumulatedText(com.google.adk.models.LlmResponse)">
|
|
<h3>shouldEmitAccumulatedText</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">shouldEmitAccumulatedText</span><wbr><span class="parameters">(<a href="LlmResponse.html" title="class in com.google.adk.models">LlmResponse</a> currentLlmResponse)</span></div>
|
|
<div class="block">Determines if accumulated text should be emitted based on the current LlmResponse. We flush if
|
|
current response is not a text continuation (e.g., no content, no parts, or the first part is
|
|
not inline_data, meaning it's something else or just empty, thereby warranting a flush of
|
|
preceding text).</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>currentLlmResponse</code> - The current LlmResponse being processed.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>True if accumulated text should be emitted, false otherwise.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="stripThoughts(java.util.List)">
|
|
<h3>stripThoughts</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">com.google.common.collect.ImmutableList<com.google.genai.types.Content></span> <span class="element-name">stripThoughts</span><wbr><span class="parameters">(<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> originalContents)</span></div>
|
|
<div class="block">Removes any `Part` that contains only a `thought` from the content list.</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="toGenerateContentResponseUsageMetadata(com.google.genai.types.UsageMetadata)">
|
|
<h3>toGenerateContentResponseUsageMetadata</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">com.google.genai.types.GenerateContentResponseUsageMetadata</span> <span class="element-name">toGenerateContentResponseUsageMetadata</span><wbr><span class="parameters">(com.google.genai.types.UsageMetadata usageMetadata)</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>
|