mirror of
https://github.com/google/adk-docs.git
synced 2026-09-14 16:16:59 +08:00
791 lines
60 KiB
HTML
791 lines
60 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>ChatCompletionsRequest (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.chat, class: ChatCompletionsRequest">
|
|
<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/ChatCompletionsRequest.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.chat</a></li>
|
|
<li><a href="ChatCompletionsRequest.html" class="current-selection">ChatCompletionsRequest</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="#constructor-summary" tabindex="0">Constructor 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="#messages" tabindex="0">messages</a></li>
|
|
<li><a href="#model" tabindex="0">model</a></li>
|
|
<li><a href="#audio" tabindex="0">audio</a></li>
|
|
<li><a href="#frequencyPenalty" tabindex="0">frequencyPenalty</a></li>
|
|
<li><a href="#logitBias" tabindex="0">logitBias</a></li>
|
|
<li><a href="#logprobs" tabindex="0">logprobs</a></li>
|
|
<li><a href="#maxCompletionTokens" tabindex="0">maxCompletionTokens</a></li>
|
|
<li><a href="#metadata" tabindex="0">metadata</a></li>
|
|
<li><a href="#modalities" tabindex="0">modalities</a></li>
|
|
<li><a href="#n" tabindex="0">n</a></li>
|
|
<li><a href="#parallelToolCalls" tabindex="0">parallelToolCalls</a></li>
|
|
<li><a href="#prediction" tabindex="0">prediction</a></li>
|
|
<li><a href="#presencePenalty" tabindex="0">presencePenalty</a></li>
|
|
<li><a href="#promptCacheKey" tabindex="0">promptCacheKey</a></li>
|
|
<li><a href="#promptCacheRetention" tabindex="0">promptCacheRetention</a></li>
|
|
<li><a href="#reasoningEffort" tabindex="0">reasoningEffort</a></li>
|
|
<li><a href="#responseFormat" tabindex="0">responseFormat</a></li>
|
|
<li><a href="#safetyIdentifier" tabindex="0">safetyIdentifier</a></li>
|
|
<li><a href="#seed" tabindex="0">seed</a></li>
|
|
<li><a href="#serviceTier" tabindex="0">serviceTier</a></li>
|
|
<li><a href="#stop" tabindex="0">stop</a></li>
|
|
<li><a href="#store" tabindex="0">store</a></li>
|
|
<li><a href="#stream" tabindex="0">stream</a></li>
|
|
<li><a href="#streamOptions" tabindex="0">streamOptions</a></li>
|
|
<li><a href="#temperature" tabindex="0">temperature</a></li>
|
|
<li><a href="#toolChoice" tabindex="0">toolChoice</a></li>
|
|
<li><a href="#tools" tabindex="0">tools</a></li>
|
|
<li><a href="#topLogprobs" tabindex="0">topLogprobs</a></li>
|
|
<li><a href="#topP" tabindex="0">topP</a></li>
|
|
<li><a href="#user" tabindex="0">user</a></li>
|
|
<li><a href="#verbosity" tabindex="0">verbosity</a></li>
|
|
<li><a href="#webSearchOptions" tabindex="0">webSearchOptions</a></li>
|
|
<li><a href="#extraBody" tabindex="0">extraBody</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">ChatCompletionsRequest()</a></li>
|
|
</ol>
|
|
</li>
|
|
<li><a href="#method-detail" tabindex="0">Method Details</a>
|
|
<ol class="toc-list">
|
|
<li><a href="#fromLlmRequest(com.google.adk.models.LlmRequest,boolean)" tabindex="0">fromLlmRequest(LlmRequest, boolean)</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 ChatCompletionsRequest" class="title">Class ChatCompletionsRequest</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.chat.ChatCompletionsRequest</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">ChatCompletionsRequest</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">Data Transfer Objects for Chat Completion API requests.
|
|
|
|
<p>Can be used to translate from a <a href="../LlmRequest.html" title="class in com.google.adk.models"><code>LlmRequest</code></a> into a <a href="ChatCompletionsRequest.html" title="class in com.google.adk.models.chat"><code>ChatCompletionsRequest</code></a> using
|
|
<a href="#fromLlmRequest(com.google.adk.models.LlmRequest,boolean)"><code>fromLlmRequest(LlmRequest, boolean)</code></a>.
|
|
|
|
<p>See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create</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>com.google.adk.models.chat.ChatCompletionsRequest.AudioParam</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#audio" class="member-name-link">audio</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20audio%20%3E%20(schema)</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/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="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>></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#extraBody" class="member-name-link">extraBody</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Additional body parameters used for specific models, for example:
|
|
https://ai.google.dev/gemini-api/docs/openai#extra-body</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class in java.lang" class="external-link">Double</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#frequencyPenalty" class="member-name-link">frequencyPenalty</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20frequency_penalty%20%3E%20(schema)</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/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="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class in java.lang" class="external-link">Double</a>></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#logitBias" class="member-name-link">logitBias</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20logit_bias%20%3E%20(schema)</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class in java.lang" class="external-link">Boolean</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#logprobs" class="member-name-link">logprobs</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20logprobs%20%3E%20(schema)</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/Integer.html" title="class in java.lang" class="external-link">Integer</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#maxCompletionTokens" class="member-name-link">maxCompletionTokens</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20max_completion_tokens%20%3E%20(schema)</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><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.adk.models.chat.ChatCompletionsRequest.Message></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#messages" class="member-name-link">messages</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20messages%20%3E%20(schema)</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/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="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="#metadata" class="member-name-link">metadata</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20metadata%20%3E%20(schema)</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><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><<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="#modalities" class="member-name-link">modalities</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20modalities%20%3E%20(schema)</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="#model" class="member-name-link">model</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20model%20%3E%20(schema)</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class in java.lang" class="external-link">Integer</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#n" class="member-name-link">n</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20n%20%3E%20(schema)</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/Boolean.html" title="class in java.lang" class="external-link">Boolean</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#parallelToolCalls" class="member-name-link">parallelToolCalls</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20parallel_tool_calls%20%3E%20(schema)</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>com.google.adk.models.chat.ChatCompletionsRequest.Prediction</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#prediction" class="member-name-link">prediction</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20prediction%20%3E%20(schema)</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/Double.html" title="class in java.lang" class="external-link">Double</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#presencePenalty" class="member-name-link">presencePenalty</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20presence_penalty%20%3E%20(schema)</div>
|
|
</div>
|
|
<div class="col-first even-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 even-row-color"><code><a href="#promptCacheKey" class="member-name-link">promptCacheKey</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20prompt_cache_key%20%3E%20(schema)</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="#promptCacheRetention" class="member-name-link">promptCacheRetention</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20prompt_cache_retention%20%3E%20(schema)</div>
|
|
</div>
|
|
<div class="col-first even-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 even-row-color"><code><a href="#reasoningEffort" class="member-name-link">reasoningEffort</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20reasoning_effort%20%3E%20(schema)</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>com.google.adk.models.chat.ChatCompletionsRequest.ResponseFormat</code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#responseFormat" class="member-name-link">responseFormat</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20response_format%20%3E%20(schema)</div>
|
|
</div>
|
|
<div class="col-first even-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 even-row-color"><code><a href="#safetyIdentifier" class="member-name-link">safetyIdentifier</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20safety_identifier%20%3E%20(schema)</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/Long.html" title="class in java.lang" class="external-link">Long</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#seed" class="member-name-link">seed</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Deprecated.</div>
|
|
</div>
|
|
<div class="col-first even-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 even-row-color"><code><a href="#serviceTier" class="member-name-link">serviceTier</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20service_tier%20%3E%20(schema)</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>com.google.adk.models.chat.ChatCompletionsRequest.StopCondition</code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#stop" class="member-name-link">stop</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20stop%20%3E%20(schema)</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class in java.lang" class="external-link">Boolean</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#store" class="member-name-link">store</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20store%20%3E%20(schema)</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/Boolean.html" title="class in java.lang" class="external-link">Boolean</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#stream" class="member-name-link">stream</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20stream%20%3E%20(schema)</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>com.google.adk.models.chat.ChatCompletionsRequest.StreamOptions</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#streamOptions" class="member-name-link">streamOptions</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20stream_options%20%3E%20(schema)</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/Double.html" title="class in java.lang" class="external-link">Double</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#temperature" class="member-name-link">temperature</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20temperature%20%3E%20(schema)</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>com.google.adk.models.chat.ChatCompletionsRequest.ToolChoice</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#toolChoice" class="member-name-link">toolChoice</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20tool_choice%20%3E%20(schema)</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/util/List.html" title="interface in java.util" class="external-link">List</a><wbr><com.google.adk.models.chat.ChatCompletionsRequest.Tool></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#tools" class="member-name-link">tools</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20tools%20%3E%20(schema)</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class in java.lang" class="external-link">Integer</a></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#topLogprobs" class="member-name-link">topLogprobs</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20top_logprobs%20%3E%20(schema)</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/Double.html" title="class in java.lang" class="external-link">Double</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#topP" class="member-name-link">topP</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20top_p%20%3E%20(schema)</div>
|
|
</div>
|
|
<div class="col-first even-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 even-row-color"><code><a href="#user" class="member-name-link">user</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Deprecated, use safety_identifier and prompt_cache_key instead.</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="#verbosity" class="member-name-link">verbosity</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20verbosity%20%3E%20(schema)</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>com.google.adk.models.chat.ChatCompletionsRequest.WebSearchOptions</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#webSearchOptions" class="member-name-link">webSearchOptions</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20web_search_options%20%3E%20(schema)</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">ChatCompletionsRequest</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="ChatCompletionsRequest.html" title="class in com.google.adk.models.chat">ChatCompletionsRequest</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#fromLlmRequest(com.google.adk.models.LlmRequest,boolean)" class="member-name-link">fromLlmRequest</a><wbr>(<a href="../LlmRequest.html" title="class in com.google.adk.models">LlmRequest</a> llmRequest,
|
|
boolean responseStreaming)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Converts a standard <a href="../LlmRequest.html" title="class in com.google.adk.models"><code>LlmRequest</code></a> into a <a href="ChatCompletionsRequest.html" title="class in com.google.adk.models.chat"><code>ChatCompletionsRequest</code></a> for
|
|
/chat/completions compatible endpoints.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#method-summary" title="class in java.lang" class="external-link">Object</a></h3>
|
|
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="clone()" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="equals(Object)" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="finalize()" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="getClass()" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="hashCode()" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="notify()" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="notifyAll()" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="toString()" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="wait()" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="wait(long)" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="wait(long, int)" class="external-link">wait</a></code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
<li>
|
|
<section class="field-details" id="field-detail">
|
|
<h2>Field Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="messages">
|
|
<h3>messages</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/List.html" title="interface in java.util" class="external-link">List</a><com.google.adk.models.chat.ChatCompletionsRequest.Message></span> <span class="element-name">messages</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20messages%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="model">
|
|
<h3>model</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a></span> <span class="element-name">model</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20model%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="audio">
|
|
<h3>audio</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.google.adk.models.chat.ChatCompletionsRequest.AudioParam</span> <span class="element-name">audio</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20audio%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="frequencyPenalty">
|
|
<h3>frequencyPenalty</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class in java.lang" class="external-link">Double</a></span> <span class="element-name">frequencyPenalty</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20frequency_penalty%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="logitBias">
|
|
<h3>logitBias</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/Map.html" title="interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class in java.lang" class="external-link">Double</a>></span> <span class="element-name">logitBias</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20logit_bias%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="logprobs">
|
|
<h3>logprobs</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class in java.lang" class="external-link">Boolean</a></span> <span class="element-name">logprobs</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20logprobs%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="maxCompletionTokens">
|
|
<h3>maxCompletionTokens</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class in java.lang" class="external-link">Integer</a></span> <span class="element-name">maxCompletionTokens</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20max_completion_tokens%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="metadata">
|
|
<h3>metadata</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/Map.html" title="interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>></span> <span class="element-name">metadata</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20metadata%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="modalities">
|
|
<h3>modalities</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/List.html" title="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 in java.lang" class="external-link">String</a>></span> <span class="element-name">modalities</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20modalities%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="n">
|
|
<h3>n</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class in java.lang" class="external-link">Integer</a></span> <span class="element-name">n</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20n%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="parallelToolCalls">
|
|
<h3>parallelToolCalls</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class in java.lang" class="external-link">Boolean</a></span> <span class="element-name">parallelToolCalls</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20parallel_tool_calls%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="prediction">
|
|
<h3>prediction</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.google.adk.models.chat.ChatCompletionsRequest.Prediction</span> <span class="element-name">prediction</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20prediction%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="presencePenalty">
|
|
<h3>presencePenalty</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class in java.lang" class="external-link">Double</a></span> <span class="element-name">presencePenalty</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20presence_penalty%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="promptCacheKey">
|
|
<h3>promptCacheKey</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a></span> <span class="element-name">promptCacheKey</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20prompt_cache_key%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="promptCacheRetention">
|
|
<h3>promptCacheRetention</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a></span> <span class="element-name">promptCacheRetention</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20prompt_cache_retention%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="reasoningEffort">
|
|
<h3>reasoningEffort</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a></span> <span class="element-name">reasoningEffort</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20reasoning_effort%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="responseFormat">
|
|
<h3>responseFormat</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.google.adk.models.chat.ChatCompletionsRequest.ResponseFormat</span> <span class="element-name">responseFormat</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20response_format%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="safetyIdentifier">
|
|
<h3>safetyIdentifier</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a></span> <span class="element-name">safetyIdentifier</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20safety_identifier%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="seed">
|
|
<h3>seed</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class in java.lang" class="external-link">Long</a></span> <span class="element-name">seed</span></div>
|
|
<div class="block">Deprecated. Use temperature instead. See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20seed%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="serviceTier">
|
|
<h3>serviceTier</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a></span> <span class="element-name">serviceTier</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20service_tier%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="stop">
|
|
<h3>stop</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.google.adk.models.chat.ChatCompletionsRequest.StopCondition</span> <span class="element-name">stop</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20stop%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="store">
|
|
<h3>store</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class in java.lang" class="external-link">Boolean</a></span> <span class="element-name">store</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20store%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="stream">
|
|
<h3>stream</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class in java.lang" class="external-link">Boolean</a></span> <span class="element-name">stream</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20stream%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="streamOptions">
|
|
<h3>streamOptions</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.google.adk.models.chat.ChatCompletionsRequest.StreamOptions</span> <span class="element-name">streamOptions</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20stream_options%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="temperature">
|
|
<h3>temperature</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class in java.lang" class="external-link">Double</a></span> <span class="element-name">temperature</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20temperature%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="toolChoice">
|
|
<h3>toolChoice</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.google.adk.models.chat.ChatCompletionsRequest.ToolChoice</span> <span class="element-name">toolChoice</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20tool_choice%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="tools">
|
|
<h3>tools</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/List.html" title="interface in java.util" class="external-link">List</a><com.google.adk.models.chat.ChatCompletionsRequest.Tool></span> <span class="element-name">tools</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20tools%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="topLogprobs">
|
|
<h3>topLogprobs</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class in java.lang" class="external-link">Integer</a></span> <span class="element-name">topLogprobs</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20top_logprobs%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="topP">
|
|
<h3>topP</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class in java.lang" class="external-link">Double</a></span> <span class="element-name">topP</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20top_p%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="user">
|
|
<h3>user</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a></span> <span class="element-name">user</span></div>
|
|
<div class="block">Deprecated, use safety_identifier and prompt_cache_key instead. See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20user%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="verbosity">
|
|
<h3>verbosity</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a></span> <span class="element-name">verbosity</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20verbosity%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="webSearchOptions">
|
|
<h3>webSearchOptions</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.google.adk.models.chat.ChatCompletionsRequest.WebSearchOptions</span> <span class="element-name">webSearchOptions</span></div>
|
|
<div class="block">See
|
|
https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create#(resource)%20chat.completions%20%3E%20(method)%20create%20%3E%20(params)%200.non_streaming%20%3E%20(param)%20web_search_options%20%3E%20(schema)</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="extraBody">
|
|
<h3>extraBody</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/Map.html" title="interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class in java.lang" class="external-link">Object</a>></span> <span class="element-name">extraBody</span></div>
|
|
<div class="block">Additional body parameters used for specific models, for example:
|
|
https://ai.google.dev/gemini-api/docs/openai#extra-body</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ========= 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>ChatCompletionsRequest</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ChatCompletionsRequest</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="fromLlmRequest(com.google.adk.models.LlmRequest,boolean)">
|
|
<h3>fromLlmRequest</h3>
|
|
<div class="horizontal-scroll">
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ChatCompletionsRequest.html" title="class in com.google.adk.models.chat">ChatCompletionsRequest</a></span> <span class="element-name">fromLlmRequest</span><wbr><span class="parameters">(<a href="../LlmRequest.html" title="class in com.google.adk.models">LlmRequest</a> llmRequest,
|
|
boolean responseStreaming)</span></div>
|
|
<div class="block">Converts a standard <a href="../LlmRequest.html" title="class in com.google.adk.models"><code>LlmRequest</code></a> into a <a href="ChatCompletionsRequest.html" title="class in com.google.adk.models.chat"><code>ChatCompletionsRequest</code></a> for
|
|
/chat/completions compatible endpoints.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>llmRequest</code> - The internal source request containing contents, configuration, and tool
|
|
definitions.</dd>
|
|
<dd><code>responseStreaming</code> - True if the request asks for a streaming response.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>A populated ChatCompletionsRequest ready for JSON serialization.</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<footer>
|
|
<hr>
|
|
<p class="legal-copy"><small>Copyright © 1980. All rights reserved.</small></p>
|
|
</footer>
|
|
</main>
|
|
</div>
|
|
</body>
|
|
</html>
|