Use kotlin's explicit API in vertexAI #6313
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Javadoc Changes:--- /home/runner/diff/original/firebase-kotlindoc/android/client/firebase-vertexai/_toc.yaml 2024-09-27 20:55:28.492099679 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/client/firebase-vertexai/_toc.yaml 2024-09-27 20:53:14.026620516 +0000
@@ -15,9 +15,6 @@
- title: "GenerativeModel"
path: "/docs/reference/android/com/google/firebase/vertexai/GenerativeModel.html"
-- title: "com.google.firebase.vertexai.common.shared"
- path: "/docs/reference/android/com/google/firebase/vertexai/common/shared/package-summary.html"
-
- title: "com.google.firebase.vertexai.java"
path: "/docs/reference/android/com/google/firebase/vertexai/java/package-summary.html"
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/GenerativeModel.Companion.html 2024-09-27 20:55:28.491099683 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/GenerativeModel.Companion.html 1970-01-01 00:00:00.000000000 +0000
@@ -1,16 +0,0 @@
-<html devsite="true">
- <head>
- <title>GenerativeModel.Companion</title>
-{% setvar book_path %}/_book.yaml{% endsetvar %}
-{% include "docs/reference/android/_reference-head-tags.html" %}
- </head>
- <body>
- <div id="metadata-info-block"></div>
- <h1>GenerativeModel.Companion</h1>
- <p>
- <pre>public static class <a href="/docs/reference/android/com/google/firebase/vertexai/GenerativeModel.Companion.html">GenerativeModel.Companion</a></pre>
- </p>
- <hr>
- </body>
-</html>
---- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/GenerativeModel.html 2024-09-27 20:55:28.485099705 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/GenerativeModel.html 2024-09-27 20:53:14.019620539 +0000
@@ -21,26 +21,6 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Nested types</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td>
- <div><code>public static class <a href="/docs/reference/android/com/google/firebase/vertexai/GenerativeModel.Companion.html">GenerativeModel.Companion</a></code></div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
<th colspan="100%"><h3>Public methods</h3></th>
</tr>
</thead>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/common/shared/package-summary.html 2024-09-27 20:55:28.491099683 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/common/shared/package-summary.html 1970-01-01 00:00:00.000000000 +0000
@@ -1,11 +0,0 @@
-<html devsite="true">
- <head>
- <title>com.google.firebase.vertexai.common.shared</title>
-{% setvar book_path %}/_book.yaml{% endsetvar %}
-{% include "docs/reference/android/_reference-head-tags.html" %}
- </head>
- <body>
- <h1>com.google.firebase.vertexai.common.shared</h1>
- </body>
-</html>
---- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/FirebaseVertexAIException.Companion.html 2024-09-27 20:55:28.487099698 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/FirebaseVertexAIException.Companion.html 1970-01-01 00:00:00.000000000 +0000
@@ -1,48 +0,0 @@
-<html devsite="true">
- <head>
- <title>FirebaseVertexAIException.Companion</title>
-{% setvar book_path %}/_book.yaml{% endsetvar %}
-{% include "docs/reference/android/_reference-head-tags.html" %}
- </head>
- <body>
- <div id="metadata-info-block"></div>
- <h1>FirebaseVertexAIException.Companion</h1>
- <p>
- <pre>public static class <a href="/docs/reference/android/com/google/firebase/vertexai/type/FirebaseVertexAIException.Companion.html">FirebaseVertexAIException.Companion</a></pre>
- </p>
- <hr>
- <h2>Summary</h2>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%"><h3>Public methods</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FirebaseVertexAIException.html">FirebaseVertexAIException</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FirebaseVertexAIException.Companion.html#from(kotlin.Throwable)">from</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Throwable.html">Throwable</a> cause)</code></div>
- <p>Converts a <code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a></code> to a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FirebaseVertexAIException.html">FirebaseVertexAIException</a></code>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="list">
- <h2>Public methods</h2>
- <div class="api-item"><a name="from-kotlin.Throwable-"></a><a name="from"></a>
- <h3 class="api-name" id="from(kotlin.Throwable)">from</h3>
- <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FirebaseVertexAIException.html">FirebaseVertexAIException</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FirebaseVertexAIException.Companion.html#from(kotlin.Throwable)">from</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Throwable.html">Throwable</a> cause)</pre>
- <p>Converts a <code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a></code> to a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FirebaseVertexAIException.html">FirebaseVertexAIException</a></code>.</p>
- <p>Will populate default messages as expected, and propagate the provided <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FirebaseVertexAIException.Companion.html#from(kotlin.Throwable)">cause</a></code> through the resulting exception.</p>
- </div>
- </div>
- </body>
-</html>
---- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/FirebaseVertexAIException.html 2024-09-27 20:55:28.488099694 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/FirebaseVertexAIException.html 2024-09-27 20:53:14.023620526 +0000
@@ -134,26 +134,6 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Nested types</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td>
- <div><code>public static class <a href="/docs/reference/android/com/google/firebase/vertexai/type/FirebaseVertexAIException.Companion.html">FirebaseVertexAIException.Companion</a></code></div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
<th colspan="100%"><h3>Protected constructors</h3></th>
</tr>
</thead>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/FunctionDeclaration.html 2024-09-27 20:55:28.487099698 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/FunctionDeclaration.html 2024-09-27 20:53:14.022620529 +0000
@@ -41,49 +41,6 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Public fields</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FunctionDeclaration.html#description()">description</a></code></div>
- <p>A description of what the function does and its output.</p>
- </td>
- </tr>
- <tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FunctionDeclaration.html#name()">name</a></code></div>
- <p>The name of the function call, this should be clear and descriptive for the model.</p>
- </td>
- </tr>
- <tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FunctionDeclaration.html#optionalParameters()">optionalParameters</a></code></div>
- <p>A list of parameters that can be omitted.</p>
- </td>
- </tr>
- <tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/Map.html">Map</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>, @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a>></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FunctionDeclaration.html#parameters()">parameters</a></code></div>
- <p>A list of parameters that the function accepts.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
<th colspan="100%"><h3>Public constructors</h3></th>
</tr>
</thead>
@@ -97,29 +54,6 @@
</table>
</div>
<div class="list">
- <h2>Public fields</h2>
- <div class="api-item"><a name="getDescription()"></a><a name="setDescription()"></a><a name="getDescription--"></a><a name="setDescription--"></a>
- <h3 class="api-name" id="description()">description</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FunctionDeclaration.html#description()">description</a></pre>
- <p>A description of what the function does and its output.</p>
- </div>
- <div class="api-item"><a name="getName()"></a><a name="setName()"></a><a name="getName--"></a><a name="setName--"></a>
- <h3 class="api-name" id="name()">name</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FunctionDeclaration.html#name()">name</a></pre>
- <p>The name of the function call, this should be clear and descriptive for the model.</p>
- </div>
- <div class="api-item"><a name="getOptionalParameters()"></a><a name="setOptionalParameters()"></a><a name="getOptionalParameters--"></a><a name="setOptionalParameters--"></a>
- <h3 class="api-name" id="optionalParameters()">optionalParameters</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FunctionDeclaration.html#optionalParameters()">optionalParameters</a></pre>
- <p>A list of parameters that can be omitted.</p>
- </div>
- <div class="api-item"><a name="getParameters()"></a><a name="setParameters()"></a><a name="getParameters--"></a><a name="setParameters--"></a>
- <h3 class="api-name" id="parameters()">parameters</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/Map.html">Map</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>, @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a>> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FunctionDeclaration.html#parameters()">parameters</a></pre>
- <p>A list of parameters that the function accepts.</p>
- </div>
- </div>
- <div class="list">
<h2>Public constructors</h2>
<div class="api-item"><a name="FunctionDeclaration(kotlin.String, kotlin.String, kotlin.collections.Map, kotlin.collections.List)"></a><a name="FunctionDeclaration-kotlin.String-kotlin.String-kotlin.collections.Map-kotlin.collections.List-"></a><a name="functiondeclaration"></a>
<h3 class="api-name" id="FunctionDeclaration(kotlin.String,kotlin.String,kotlin.collections.Map,kotlin.collections.List)">FunctionDeclaration</h3>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/GenerationConfig.html 2024-09-27 20:55:28.490099687 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/GenerationConfig.html 2024-09-27 20:53:14.024620523 +0000
@@ -39,165 +39,6 @@
</tbody>
</table>
</div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%"><h3>Public fields</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>final <a href="https://developer.android.com/reference/kotlin/java/lang/Integer.html">Integer</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#candidateCount()">candidateCount</a></code></div>
- <p>The maximum number of generated response messages to return.</p>
- </td>
- </tr>
- <tr>
- <td><code>final <a href="https://developer.android.com/reference/kotlin/java/lang/Float.html">Float</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#frequencyPenalty()">frequencyPenalty</a></code></div>
- <p>Frequency penalties.</p>
- </td>
- </tr>
- <tr>
- <td><code>final <a href="https://developer.android.com/reference/kotlin/java/lang/Integer.html">Integer</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#maxOutputTokens()">maxOutputTokens</a></code></div>
- <p>Specifies the maximum number of tokens that can be generated in the response.</p>
- </td>
- </tr>
- <tr>
- <td><code>final <a href="https://developer.android.com/reference/kotlin/java/lang/Float.html">Float</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#presencePenalty()">presencePenalty</a></code></div>
- <p>Positive penalties.</p>
- </td>
- </tr>
- <tr>
- <td><code>final <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#responseMimeType()">responseMimeType</a></code></div>
- <p>Output response MIME type of the generated candidate text (IANA standard).</p>
- </td>
- </tr>
- <tr>
- <td><code>final <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#responseSchema()">responseSchema</a></code></div>
- <p>Output schema of the generated candidate text.</p>
- </td>
- </tr>
- <tr>
- <td><code>final <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#stopSequences()">stopSequences</a></code></div>
- <p>A set of up to 5 <code>String</code>s that will stop output generation.</p>
- </td>
- </tr>
- <tr>
- <td><code>final <a href="https://developer.android.com/reference/kotlin/java/lang/Float.html">Float</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#temperature()">temperature</a></code></div>
- <p>A parameter controlling the degree of randomness in token selection.</p>
- </td>
- </tr>
- <tr>
- <td><code>final <a href="https://developer.android.com/reference/kotlin/java/lang/Integer.html">Integer</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#topK()">topK</a></code></div>
- <p>The <code>topK</code> parameter changes how the model selects tokens for output.</p>
- </td>
- </tr>
- <tr>
- <td><code>final <a href="https://developer.android.com/reference/kotlin/java/lang/Float.html">Float</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#topP()">topP</a></code></div>
- <p>The <code>topP</code> parameter changes how the model selects tokens for output.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="list">
- <h2>Public fields</h2>
- <div class="api-item"><a name="getCandidateCount()"></a><a name="setCandidateCount()"></a><a name="getCandidateCount--"></a><a name="setCandidateCount--"></a>
- <h3 class="api-name" id="candidateCount()">candidateCount</h3>
- <pre class="api-signature no-pretty-print">public final <a href="https://developer.android.com/reference/kotlin/java/lang/Integer.html">Integer</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#candidateCount()">candidateCount</a></pre>
- <p>The maximum number of generated response messages to return. This value must be between 1, 8, inclusive. If unset, this will default to 1.</p>
- <ul>
- <li>
- <p>Note: Only unique candidates are returned. Higher temperatures are more likely to produce unique candidates. Setting <code>temperature</code> to 0 will always produce exactly one candidate regardless of the <code>candidateCount</code>.</p>
- </li>
- </ul>
- </div>
- <div class="api-item"><a name="getFrequencyPenalty()"></a><a name="setFrequencyPenalty()"></a><a name="getFrequencyPenalty--"></a><a name="setFrequencyPenalty--"></a>
- <h3 class="api-name" id="frequencyPenalty()">frequencyPenalty</h3>
- <pre class="api-signature no-pretty-print">public final <a href="https://developer.android.com/reference/kotlin/java/lang/Float.html">Float</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#frequencyPenalty()">frequencyPenalty</a></pre>
- <p>Frequency penalties.</p>
- </div>
- <div class="api-item"><a name="getMaxOutputTokens()"></a><a name="setMaxOutputTokens()"></a><a name="getMaxOutputTokens--"></a><a name="setMaxOutputTokens--"></a>
- <h3 class="api-name" id="maxOutputTokens()">maxOutputTokens</h3>
- <pre class="api-signature no-pretty-print">public final <a href="https://developer.android.com/reference/kotlin/java/lang/Integer.html">Integer</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#maxOutputTokens()">maxOutputTokens</a></pre>
- <p>Specifies the maximum number of tokens that can be generated in the response. The number of tokens per word varies depending on the language outputted. Defaults to 0 (unbounded).</p>
- </div>
- <div class="api-item"><a name="getPresencePenalty()"></a><a name="setPresencePenalty()"></a><a name="getPresencePenalty--"></a><a name="setPresencePenalty--"></a>
- <h3 class="api-name" id="presencePenalty()">presencePenalty</h3>
- <pre class="api-signature no-pretty-print">public final <a href="https://developer.android.com/reference/kotlin/java/lang/Float.html">Float</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#presencePenalty()">presencePenalty</a></pre>
- <p>Positive penalties.</p>
- </div>
- <div class="api-item"><a name="getResponseMimeType()"></a><a name="setResponseMimeType()"></a><a name="getResponseMimeType--"></a><a name="setResponseMimeType--"></a>
- <h3 class="api-name" id="responseMimeType()">responseMimeType</h3>
- <pre class="api-signature no-pretty-print">public final <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#responseMimeType()">responseMimeType</a></pre>
- <p>Output response MIME type of the generated candidate text (IANA standard).</p>
- <p>Supported MIME types depend on the model used, but could include:</p>
- <ul>
- <li>
- <p><code>text/plain</code>: Text output; the default behavior if unspecified.</p>
- </li>
- <li>
- <p><code>application/json</code>: JSON response in the candidates.</p>
- </li>
- </ul>
- </div>
- <div class="api-item"><a name="getResponseSchema()"></a><a name="setResponseSchema()"></a><a name="getResponseSchema--"></a><a name="setResponseSchema--"></a>
- <h3 class="api-name" id="responseSchema()">responseSchema</h3>
- <pre class="api-signature no-pretty-print">public final <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#responseSchema()">responseSchema</a></pre>
- <p>Output schema of the generated candidate text. If set, a compatible <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#responseMimeType()">responseMimeType</a></code> must also be set.</p>
- <p>Compatible MIME types:</p>
- <ul>
- <li>
- <p><code>application/json</code>: Schema for JSON response.</p>
- </li>
- </ul>
- <p>Refer to the <a href="https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/control-generated-output">Control generated output</a> guide for more details.</p>
- </div>
- <div class="api-item"><a name="getStopSequences()"></a><a name="setStopSequences()"></a><a name="getStopSequences--"></a><a name="setStopSequences--"></a>
- <h3 class="api-name" id="stopSequences()">stopSequences</h3>
- <pre class="api-signature no-pretty-print">public final <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>> <a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#stopSequences()">stopSequences</a></pre>
- <p>A set of up to 5 <code>String</code>s that will stop output generation. If specified, the API will stop at the first appearance of a stop sequence. The stop sequence will not be included as part of the response.</p>
- </div>
- <div class="api-item"><a name="getTemperature()"></a><a name="setTemperature()"></a><a name="getTemperature--"></a><a name="setTemperature--"></a>
- <h3 class="api-name" id="temperature()">temperature</h3>
- <pre class="api-signature no-pretty-print">public final <a href="https://developer.android.com/reference/kotlin/java/lang/Float.html">Float</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#temperature()">temperature</a></pre>
- <p>A parameter controlling the degree of randomness in token selection. A temperature of 0 means that the highest probability tokens are always selected. In this case, responses for a given prompt are mostly deterministic, but a small amount of variation is still possible.</p>
- </div>
- <div class="api-item"><a name="getTopK()"></a><a name="setTopK()"></a><a name="getTopK--"></a><a name="setTopK--"></a>
- <h3 class="api-name" id="topK()">topK</h3>
- <pre class="api-signature no-pretty-print">public final <a href="https://developer.android.com/reference/kotlin/java/lang/Integer.html">Integer</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#topK()">topK</a></pre>
- <p>The <code>topK</code> parameter changes how the model selects tokens for output. A <code>topK</code> of 1 means the selected token is the most probable among all the tokens in the model's vocabulary, while a <code>topK</code> of 3 means that the next token is selected from among the 3 most probable using the <code>temperature</code>. For each token selection step, the <code>topK</code> tokens with the highest probabilities are sampled. Tokens are then further filtered based on <code>topP</code> with the final token selected using <code>temperature</code> sampling. Defaults to 40 if unspecified.</p>
- </div>
- <div class="api-item"><a name="getTopP()"></a><a name="setTopP()"></a><a name="getTopP--"></a><a name="setTopP--"></a>
- <h3 class="api-name" id="topP()">topP</h3>
- <pre class="api-signature no-pretty-print">public final <a href="https://developer.android.com/reference/kotlin/java/lang/Float.html">Float</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#topP()">topP</a></pre>
- <p>The <code>topP</code> parameter changes how the model selects tokens for output. Tokens are selected from the most to least probable until the sum of their probabilities equals the <code>topP</code> value. For example, if tokens A, B, and C have probabilities of 0.3, 0.2, and 0.1 respectively and the topP value is 0.5, then the model will select either A or B as the next token by using the <code>temperature</code> and exclude C as a candidate. Defaults to 0.95 if unset.</p>
- </div>
- </div>
</body>
</html>
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/SafetySetting.html 2024-09-27 20:55:28.489099690 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/SafetySetting.html 2024-09-27 20:53:14.023620526 +0000
@@ -21,42 +21,6 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Public fields</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetySetting.html#harmCategory()">harmCategory</a></code></div>
- <p>The relevant <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code>.</p>
- </td>
- </tr>
- <tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetySetting.html#method()">method</a></code></div>
- <p>Specify if the threshold is used for probability or severity score.</p>
- </td>
- </tr>
- <tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetySetting.html#threshold()">threshold</a></code></div>
- <p>The threshold form harm allowable.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
<th colspan="100%"><h3>Public constructors</h3></th>
</tr>
</thead>
@@ -70,24 +34,6 @@
</table>
</div>
<div class="list">
- <h2>Public fields</h2>
- <div class="api-item"><a name="getHarmCategory()"></a><a name="setHarmCategory()"></a><a name="getHarmCategory--"></a><a name="setHarmCategory--"></a>
- <h3 class="api-name" id="harmCategory()">harmCategory</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetySetting.html#harmCategory()">harmCategory</a></pre>
- <p>The relevant <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code>.</p>
- </div>
- <div class="api-item"><a name="getMethod()"></a><a name="setMethod()"></a><a name="getMethod--"></a><a name="setMethod--"></a>
- <h3 class="api-name" id="method()">method</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetySetting.html#method()">method</a></pre>
- <p>Specify if the threshold is used for probability or severity score.</p>
- </div>
- <div class="api-item"><a name="getThreshold()"></a><a name="setThreshold()"></a><a name="getThreshold--"></a><a name="setThreshold--"></a>
- <h3 class="api-name" id="threshold()">threshold</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetySetting.html#threshold()">threshold</a></pre>
- <p>The threshold form harm allowable.</p>
- </div>
- </div>
- <div class="list">
<h2>Public constructors</h2>
<div class="api-item"><a name="SafetySetting(com.google.firebase.vertexai.type.HarmCategory, com.google.firebase.vertexai.type.HarmBlockThreshold, com.google.firebase.vertexai.type.HarmBlockMethod)"></a><a name="SafetySetting-com.google.firebase.vertexai.type.HarmCategory-com.google.firebase.vertexai.type.HarmBlockThreshold-com.google.firebase.vertexai.type.HarmBlockMethod-"></a><a name="safetysetting"></a>
<h3 class="api-name" id="SafetySetting(com.google.firebase.vertexai.type.HarmCategory,com.google.firebase.vertexai.type.HarmBlockThreshold,com.google.firebase.vertexai.type.HarmBlockMethod)">SafetySetting</h3>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ToolConfig.html 2024-09-27 20:55:28.490099687 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ToolConfig.html 2024-09-27 20:53:14.025620519 +0000
@@ -21,28 +21,6 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Public fields</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FunctionCallingConfig.html">FunctionCallingConfig</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ToolConfig.html#functionCallingConfig()">functionCallingConfig</a></code></div>
- <p>The config for function calling</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
<th colspan="100%"><h3>Public constructors</h3></th>
</tr>
</thead>
@@ -56,14 +34,6 @@
</table>
</div>
<div class="list">
- <h2>Public fields</h2>
- <div class="api-item"><a name="getFunctionCallingConfig()"></a><a name="setFunctionCallingConfig()"></a><a name="getFunctionCallingConfig--"></a><a name="setFunctionCallingConfig--"></a>
- <h3 class="api-name" id="functionCallingConfig()">functionCallingConfig</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FunctionCallingConfig.html">FunctionCallingConfig</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ToolConfig.html#functionCallingConfig()">functionCallingConfig</a></pre>
- <p>The config for function calling</p>
- </div>
- </div>
- <div class="list">
<h2>Public constructors</h2>
<div class="api-item"><a name="ToolConfig-com.google.firebase.vertexai.type.FunctionCallingConfig-"></a><a name="toolconfig"></a>
<h3 class="api-name" id="ToolConfig(com.google.firebase.vertexai.type.FunctionCallingConfig)">ToolConfig</h3>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/client/firebase-vertexai/_toc.yaml 2024-09-27 20:55:28.485099705 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/client/firebase-vertexai/_toc.yaml 2024-09-27 20:53:14.019620539 +0000
@@ -13,9 +13,6 @@
- title: "GenerativeModel"
path: "/docs/reference/kotlin/com/google/firebase/vertexai/GenerativeModel.html"
-- title: "com.google.firebase.vertexai.common.shared"
- path: "/docs/reference/kotlin/com/google/firebase/vertexai/common/shared/package-summary.html"
-
- title: "com.google.firebase.vertexai.java"
path: "/docs/reference/kotlin/com/google/firebase/vertexai/java/package-summary.html"
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/common/shared/package-summary.html 2024-09-27 20:55:28.484099709 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/common/shared/package-summary.html 1970-01-01 00:00:00.000000000 +0000
@@ -1,26 +0,0 @@
-<html devsite="true">
- <head>
- <title>com.google.firebase.vertexai.common.shared</title>
-{% setvar book_path %}/_book.yaml{% endsetvar %}
-{% include "docs/reference/kotlin/_reference-head-tags.html" %}
- </head>
- <body>
- <h1>com.google.firebase.vertexai.common.shared</h1>
- <h2>Type aliases</h2>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <tbody class="list">
- <tr>
- <td><code>Base64</code></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- </div>
- </body>
-</html>
---- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/FirebaseVertexAIException.html 2024-09-27 20:55:28.482099716 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/FirebaseVertexAIException.html 2024-09-27 20:53:14.016620549 +0000
@@ -134,28 +134,6 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Public companion functions</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FirebaseVertexAIException.html">FirebaseVertexAIException</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FirebaseVertexAIException.Companion.html#from(kotlin.Throwable)">from</a>(cause: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a>)</code></div>
- <p>Converts a <code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a></code> to a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FirebaseVertexAIException.html">FirebaseVertexAIException</a></code>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
<th colspan="100%"><h3>Protected constructors</h3></th>
</tr>
</thead>
@@ -291,15 +269,6 @@
</table>
</div>
<div class="list">
- <h2>Public companion functions</h2>
- <div class="api-item"><a name="from-kotlin.Throwable-"></a><a name="from"></a>
- <h3 class="api-name" id="from(kotlin.Throwable)">from</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FirebaseVertexAIException.Companion.html#from(kotlin.Throwable)">from</a>(cause: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a>): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FirebaseVertexAIException.html">FirebaseVertexAIException</a></pre>
- <p>Converts a <code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a></code> to a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FirebaseVertexAIException.html">FirebaseVertexAIException</a></code>.</p>
- <p>Will populate default messages as expected, and propagate the provided <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FirebaseVertexAIException.Companion.html#from(kotlin.Throwable)">cause</a></code> through the resulting exception.</p>
- </div>
- </div>
- <div class="list">
<h2>Protected constructors</h2>
<div class="api-item"><a name="FirebaseVertexAIException(kotlin.String, kotlin.Throwable)"></a><a name="FirebaseVertexAIException-kotlin.String-kotlin.Throwable-"></a><a name="firebasevertexaiexception"></a>
<h3 class="api-name" id="FirebaseVertexAIException(kotlin.String,kotlin.Throwable)">FirebaseVertexAIException</h3>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/FunctionDeclaration.html 2024-09-27 20:55:28.481099720 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/FunctionDeclaration.html 2024-09-27 20:53:14.015620553 +0000
@@ -53,49 +53,6 @@
</tbody>
</table>
</div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%"><h3>Public properties</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FunctionDeclaration.html#description()">description</a></code></div>
- <p>A description of what the function does and its output.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FunctionDeclaration.html#name()">name</a></code></div>
- <p>The name of the function call, this should be clear and descriptive for the model.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FunctionDeclaration.html#optionalParameters()">optionalParameters</a></code></div>
- <p>A list of parameters that can be omitted.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a>></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FunctionDeclaration.html#parameters()">parameters</a></code></div>
- <p>A list of parameters that the function accepts.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
<div class="list">
<h2>Public constructors</h2>
<div class="api-item"><a name="FunctionDeclaration(kotlin.String, kotlin.String, kotlin.collections.Map, kotlin.collections.List)"></a><a name="FunctionDeclaration-kotlin.String-kotlin.String-kotlin.collections.Map-kotlin.collections.List-"></a><a name="functiondeclaration"></a>
@@ -142,29 +99,6 @@
</div>
</div>
</div>
- <div class="list">
- <h2>Public properties</h2>
- <div class="api-item"><a name="getDescription()"></a><a name="setDescription()"></a><a name="getDescription--"></a><a name="setDescription--"></a>
- <h3 class="api-name" id="description()">description</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FunctionDeclaration.html#description()">description</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></pre>
- <p>A description of what the function does and its output.</p>
- </div>
- <div class="api-item"><a name="getName()"></a><a name="setName()"></a><a name="getName--"></a><a name="setName--"></a>
- <h3 class="api-name" id="name()">name</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FunctionDeclaration.html#name()">name</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></pre>
- <p>The name of the function call, this should be clear and descriptive for the model.</p>
- </div>
- <div class="api-item"><a name="getOptionalParameters()"></a><a name="setOptionalParameters()"></a><a name="getOptionalParameters--"></a><a name="setOptionalParameters--"></a>
- <h3 class="api-name" id="optionalParameters()">optionalParameters</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FunctionDeclaration.html#optionalParameters()">optionalParameters</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>></pre>
- <p>A list of parameters that can be omitted.</p>
- </div>
- <div class="api-item"><a name="getParameters()"></a><a name="setParameters()"></a><a name="getParameters--"></a><a name="setParameters--"></a>
- <h3 class="api-name" id="parameters()">parameters</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FunctionDeclaration.html#parameters()">parameters</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a>></pre>
- <p>A list of parameters that the function accepts.</p>
- </div>
- </div>
</body>
</html>
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html 2024-09-27 20:55:28.483099713 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html 2024-09-27 20:53:14.018620543 +0000
@@ -56,91 +56,6 @@
</tbody>
</table>
</div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%"><h3>Public properties</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>?</code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#candidateCount()">candidateCount</a></code></div>
- <p>The maximum number of generated response messages to return.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>?</code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#frequencyPenalty()">frequencyPenalty</a></code></div>
- <p>Frequency penalties.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>?</code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#maxOutputTokens()">maxOutputTokens</a></code></div>
- <p>Specifies the maximum number of tokens that can be generated in the response.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>?</code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#presencePenalty()">presencePenalty</a></code></div>
- <p>Positive penalties.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?</code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#responseMimeType()">responseMimeType</a></code></div>
- <p>Output response MIME type of the generated candidate text (IANA standard).</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a>?</code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#responseSchema()">responseSchema</a></code></div>
- <p>Output schema of the generated candidate text.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>>?</code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#stopSequences()">stopSequences</a></code></div>
- <p>A set of up to 5 <code>String</code>s that will stop output generation.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>?</code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#temperature()">temperature</a></code></div>
- <p>A parameter controlling the degree of randomness in token selection.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>?</code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#topK()">topK</a></code></div>
- <p>The <code>topK</code> parameter changes how the model selects tokens for output.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>?</code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#topP()">topP</a></code></div>
- <p>The <code>topP</code> parameter changes how the model selects tokens for output.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
<div class="list">
<h2>Public companion functions</h2>
<div class="api-item"><a name="builder--"></a><a name="builder"></a>
@@ -150,80 +65,6 @@
<pre class="prettyprint">val config = GenerationConfig.builder()</pre>
</div>
</div>
- <div class="list">
- <h2>Public properties</h2>
- <div class="api-item"><a name="getCandidateCount()"></a><a name="setCandidateCount()"></a><a name="getCandidateCount--"></a><a name="setCandidateCount--"></a>
- <h3 class="api-name" id="candidateCount()">candidateCount</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#candidateCount()">candidateCount</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>?</pre>
- <p>The maximum number of generated response messages to return. This value must be between 1, 8, inclusive. If unset, this will default to 1.</p>
- <ul>
- <li>
- <p>Note: Only unique candidates are returned. Higher temperatures are more likely to produce unique candidates. Setting <code>temperature</code> to 0 will always produce exactly one candidate regardless of the <code>candidateCount</code>.</p>
- </li>
- </ul>
- </div>
- <div class="api-item"><a name="getFrequencyPenalty()"></a><a name="setFrequencyPenalty()"></a><a name="getFrequencyPenalty--"></a><a name="setFrequencyPenalty--"></a>
- <h3 class="api-name" id="frequencyPenalty()">frequencyPenalty</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#frequencyPenalty()">frequencyPenalty</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>?</pre>
- <p>Frequency penalties.</p>
- </div>
- <div class="api-item"><a name="getMaxOutputTokens()"></a><a name="setMaxOutputTokens()"></a><a name="getMaxOutputTokens--"></a><a name="setMaxOutputTokens--"></a>
- <h3 class="api-name" id="maxOutputTokens()">maxOutputTokens</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#maxOutputTokens()">maxOutputTokens</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>?</pre>
- <p>Specifies the maximum number of tokens that can be generated in the response. The number of tokens per word varies depending on the language outputted. Defaults to 0 (unbounded).</p>
- </div>
- <div class="api-item"><a name="getPresencePenalty()"></a><a name="setPresencePenalty()"></a><a name="getPresencePenalty--"></a><a name="setPresencePenalty--"></a>
- <h3 class="api-name" id="presencePenalty()">presencePenalty</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#presencePenalty()">presencePenalty</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>?</pre>
- <p>Positive penalties.</p>
- </div>
- <div class="api-item"><a name="getResponseMimeType()"></a><a name="setResponseMimeType()"></a><a name="getResponseMimeType--"></a><a name="setResponseMimeType--"></a>
- <h3 class="api-name" id="responseMimeType()">responseMimeType</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#responseMimeType()">responseMimeType</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?</pre>
- <p>Output response MIME type of the generated candidate text (IANA standard).</p>
- <p>Supported MIME types depend on the model used, but could include:</p>
- <ul>
- <li>
- <p><code>text/plain</code>: Text output; the default behavior if unspecified.</p>
- </li>
- <li>
- <p><code>application/json</code>: JSON response in the candidates.</p>
- </li>
- </ul>
- </div>
- <div class="api-item"><a name="getResponseSchema()"></a><a name="setResponseSchema()"></a><a name="getResponseSchema--"></a><a name="setResponseSchema--"></a>
- <h3 class="api-name" id="responseSchema()">responseSchema</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#responseSchema()">responseSchema</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a>?</pre>
- <p>Output schema of the generated candidate text. If set, a compatible <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#responseMimeType()">responseMimeType</a></code> must also be set.</p>
- <p>Compatible MIME types:</p>
- <ul>
- <li>
- <p><code>application/json</code>: Schema for JSON response.</p>
- </li>
- </ul>
- <p>Refer to the <a href="https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/control-generated-output">Control generated output</a> guide for more details.</p>
- </div>
- <div class="api-item"><a name="getStopSequences()"></a><a name="setStopSequences()"></a><a name="getStopSequences--"></a><a name="setStopSequences--"></a>
- <h3 class="api-name" id="stopSequences()">stopSequences</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#stopSequences()">stopSequences</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>>?</pre>
- <p>A set of up to 5 <code>String</code>s that will stop output generation. If specified, the API will stop at the first appearance of a stop sequence. The stop sequence will not be included as part of the response.</p>
- </div>
- <div class="api-item"><a name="getTemperature()"></a><a name="setTemperature()"></a><a name="getTemperature--"></a><a name="setTemperature--"></a>
- <h3 class="api-name" id="temperature()">temperature</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#temperature()">temperature</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>?</pre>
- <p>A parameter controlling the degree of randomness in token selection. A temperature of 0 means that the highest probability tokens are always selected. In this case, responses for a given prompt are mostly deterministic, but a small amount of variation is still possible.</p>
- </div>
- <div class="api-item"><a name="getTopK()"></a><a name="setTopK()"></a><a name="getTopK--"></a><a name="setTopK--"></a>
- <h3 class="api-name" id="topK()">topK</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#topK()">topK</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>?</pre>
- <p>The <code>topK</code> parameter changes how the model selects tokens for output. A <code>topK</code> of 1 means the selected token is the most probable among all the tokens in the model's vocabulary, while a <code>topK</code> of 3 means that the next token is selected from among the 3 most probable using the <code>temperature</code>. For each token selection step, the <code>topK</code> tokens with the highest probabilities are sampled. Tokens are then further filtered based on <code>topP</code> with the final token selected using <code>temperature</code> sampling. Defaults to 40 if unspecified.</p>
- </div>
- <div class="api-item"><a name="getTopP()"></a><a name="setTopP()"></a><a name="getTopP--"></a><a name="setTopP--"></a>
- <h3 class="api-name" id="topP()">topP</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#topP()">topP</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>?</pre>
- <p>The <code>topP</code> parameter changes how the model selects tokens for output. Tokens are selected from the most to least probable until the sum of their probabilities equals the <code>topP</code> value. For example, if tokens A, B, and C have probabilities of 0.3, 0.2, and 0.1 respectively and the topP value is 0.5, then the model will select either A or B as the next token by using the <code>temperature</code> and exclude C as a candidate. Defaults to 0.95 if unset.</p>
- </div>
- </div>
</body>
</html>
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/SafetySetting.html 2024-09-27 20:55:28.482099716 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/SafetySetting.html 2024-09-27 20:53:14.017620546 +0000
@@ -33,42 +33,6 @@
</tbody>
</table>
</div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%"><h3>Public properties</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetySetting.html#harmCategory()">harmCategory</a></code></div>
- <p>The relevant <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code>.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetySetting.html#method()">method</a></code></div>
- <p>Specify if the threshold is used for probability or severity score.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetySetting.html#threshold()">threshold</a></code></div>
- <p>The threshold form harm allowable.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
<div class="list">
<h2>Public constructors</h2>
<div class="api-item"><a name="SafetySetting(com.google.firebase.vertexai.type.HarmCategory, com.google.firebase.vertexai.type.HarmBlockThreshold, com.google.firebase.vertexai.type.HarmBlockMethod)"></a><a name="SafetySetting-com.google.firebase.vertexai.type.HarmCategory-com.google.firebase.vertexai.type.HarmBlockThreshold-com.google.firebase.vertexai.type.HarmBlockMethod-"></a><a name="safetysetting"></a>
@@ -109,24 +73,6 @@
</div>
</div>
</div>
- <div class="list">
- <h2>Public properties</h2>
- <div class="api-item"><a name="getHarmCategory()"></a><a name="setHarmCategory()"></a><a name="getHarmCategory--"></a><a name="setHarmCategory--"></a>
- <h3 class="api-name" id="harmCategory()">harmCategory</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetySetting.html#harmCategory()">harmCategory</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></pre>
- <p>The relevant <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code>.</p>
- </div>
- <div class="api-item"><a name="getMethod()"></a><a name="setMethod()"></a><a name="getMethod--"></a><a name="setMethod--"></a>
- <h3 class="api-name" id="method()">method</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetySetting.html#method()">method</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a></pre>
- <p>Specify if the threshold is used for probability or severity score.</p>
- </div>
- <div class="api-item"><a name="getThreshold()"></a><a name="setThreshold()"></a><a name="getThreshold--"></a><a name="setThreshold--"></a>
- <h3 class="api-name" id="threshold()">threshold</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetySetting.html#threshold()">threshold</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></pre>
- <p>The threshold form harm allowable.</p>
- </div>
- </div>
</body>
</html>
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ToolConfig.html 2024-09-27 20:55:28.484099709 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ToolConfig.html 2024-09-27 20:53:14.018620543 +0000
@@ -33,28 +33,6 @@
</tbody>
</table>
</div>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%"><h3>Public properties</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FunctionCallingConfig.html">FunctionCallingConfig</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ToolConfig.html#functionCallingConfig()">functionCallingConfig</a></code></div>
- <p>The config for function calling</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
<div class="list">
<h2>Public constructors</h2>
<div class="api-item"><a name="ToolConfig-com.google.firebase.vertexai.type.FunctionCallingConfig-"></a><a name="toolconfig"></a>
@@ -83,14 +61,6 @@
</div>
</div>
</div>
- <div class="list">
- <h2>Public properties</h2>
- <div class="api-item"><a name="getFunctionCallingConfig()"></a><a name="setFunctionCallingConfig()"></a><a name="getFunctionCallingConfig--"></a><a name="setFunctionCallingConfig--"></a>
- <h3 class="api-name" id="functionCallingConfig()">functionCallingConfig</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ToolConfig.html#functionCallingConfig()">functionCallingConfig</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FunctionCallingConfig.html">FunctionCallingConfig</a></pre>
- <p>The config for function calling</p>
- </div>
- </div>
</body>
</html>
|
Generated by 🚫 Danger |
Size Report 1Affected Products
Test Logs |
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/FunctionDeclaration.kt
Show resolved
Hide resolved
emilypgoogle
approved these changes
Sep 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This option forces you to define the visibility of your code in Kotlin, ignoring the default visibility of
publicFor more context, see
https://kotlinlang.org/docs/whatsnew14.html#explicit-api-mode-for-library-authors
https://umang91.medium.com/explicit-api-mode-kotlin-a527843d94f3