update javadocs #6848
Merged
update javadocs #6848
Conversation
This file contains hidden or 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/com/google/firebase/vertexai/type/LiveContentResponse.Status.Companion.html 2025-04-11 15:42:59.026190913 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/LiveContentResponse.Status.Companion.html 2025-04-11 15:40:44.176439399 +0000
@@ -28,18 +28,21 @@
<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/LiveContentResponse.Status.html">LiveContentResponse.Status</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveContentResponse.Status.Companion.html#INTERRUPTED()">INTERRUPTED</a></code></div>
+ <p>The server was interrupted while generating data.</p>
</td>
</tr>
<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/LiveContentResponse.Status.html">LiveContentResponse.Status</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveContentResponse.Status.Companion.html#NORMAL()">NORMAL</a></code></div>
+ <p>The server is actively sending data for the current interaction.</p>
</td>
</tr>
<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/LiveContentResponse.Status.html">LiveContentResponse.Status</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveContentResponse.Status.Companion.html#TURN_COMPLETE()">TURN_COMPLETE</a></code></div>
+ <p>The model has finished sending data in the current interaction.</p>
</td>
</tr>
</tbody>
@@ -50,14 +53,19 @@
<div class="api-item"><a name="getINTERRUPTED()"></a><a name="setINTERRUPTED()"></a><a name="getINTERRUPTED--"></a><a name="setINTERRUPTED--"></a>
<h3 class="api-name" id="INTERRUPTED()">INTERRUPTED</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/LiveContentResponse.Status.html">LiveContentResponse.Status</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveContentResponse.Status.Companion.html#INTERRUPTED()">INTERRUPTED</a></pre>
+ <p>The server was interrupted while generating data.</p>
+ <p>An interruption occurs when the client sends a message while the server is <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveContentResponse.Status.Companion.html#NORMAL()">actively</a></code> sending data.</p>
</div>
<div class="api-item"><a name="getNORMAL()"></a><a name="setNORMAL()"></a><a name="getNORMAL--"></a><a name="setNORMAL--"></a>
<h3 class="api-name" id="NORMAL()">NORMAL</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/LiveContentResponse.Status.html">LiveContentResponse.Status</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveContentResponse.Status.Companion.html#NORMAL()">NORMAL</a></pre>
+ <p>The server is actively sending data for the current interaction.</p>
</div>
<div class="api-item"><a name="getTURN_COMPLETE()"></a><a name="setTURN_COMPLETE()"></a><a name="getTURN_COMPLETE--"></a><a name="setTURN_COMPLETE--"></a>
<h3 class="api-name" id="TURN_COMPLETE()">TURN_COMPLETE</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/LiveContentResponse.Status.html">LiveContentResponse.Status</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveContentResponse.Status.Companion.html#TURN_COMPLETE()">TURN_COMPLETE</a></pre>
+ <p>The model has finished sending data in the current interaction.</p>
+ <p>Can be set alongside content, signifying that the content is the last in the turn.</p>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/LiveContentResponse.Status.html 2025-04-11 15:42:59.024190931 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/LiveContentResponse.Status.html 2025-04-11 15:40:44.174439418 +0000
@@ -11,6 +11,7 @@
<pre>value public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveContentResponse.Status.html">LiveContentResponse.Status</a></pre>
</p>
<hr>
+ <p>Represents the status of a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveContentResponse.html">LiveContentResponse</a></code>, within a single interaction.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/LiveContentResponse.html 2025-04-11 15:42:59.021190959 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/LiveContentResponse.html 2025-04-11 15:40:44.172439436 +0000
@@ -11,6 +11,8 @@
<pre>@<a href="/docs/reference/android/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveContentResponse.html">LiveContentResponse</a></pre>
</p>
<hr>
+ <p>Represents the response from the model for live content updates.</p>
+ <p>This class encapsulates the content data, the status of the response, and any function calls included in the response.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -27,6 +29,7 @@
<tr>
<td>
<div><code>value public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveContentResponse.Status.html">LiveContentResponse.Status</a></code></div>
+ <p>Represents the status of a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveContentResponse.html">LiveContentResponse</a></code>, within a single interaction.</p>
</td>
</tr>
<tr>
@@ -53,18 +56,21 @@
<td><code>final <a href="/docs/reference/android/com/google/firebase/vertexai/type/Content.html">Content</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveContentResponse.html#data()">data</a></code></div>
+ <p>The main content data of the response.</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="/docs/reference/android/com/google/firebase/vertexai/type/FunctionCallPart.html">FunctionCallPart</a>></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveContentResponse.html#functionCalls()">functionCalls</a></code></div>
+ <p>A list of <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FunctionCallPart.html">FunctionCallPart</a></code> included in the response, if any.</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/LiveContentResponse.Status.html">LiveContentResponse.Status</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveContentResponse.html#status()">status</a></code></div>
+ <p>The status of the live content response.</p>
</td>
</tr>
<tr>
@@ -82,14 +88,18 @@
<div class="api-item"><a name="getData()"></a><a name="setData()"></a><a name="getData--"></a><a name="setData--"></a>
<h3 class="api-name" id="data()">data</h3>
<pre class="api-signature no-pretty-print">public final <a href="/docs/reference/android/com/google/firebase/vertexai/type/Content.html">Content</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveContentResponse.html#data()">data</a></pre>
+ <p>The main content data of the response. This can be <code>null</code> if there is no content.</p>
</div>
<div class="api-item"><a name="getFunctionCalls()"></a><a name="setFunctionCalls()"></a><a name="getFunctionCalls--"></a><a name="setFunctionCalls--"></a>
<h3 class="api-name" id="functionCalls()">functionCalls</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="/docs/reference/android/com/google/firebase/vertexai/type/FunctionCallPart.html">FunctionCallPart</a>> <a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveContentResponse.html#functionCalls()">functionCalls</a></pre>
+ <p>A list of <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FunctionCallPart.html">FunctionCallPart</a></code> included in the response, if any.</p>
+ <p>This list can be null or empty if no function calls are present.</p>
</div>
<div class="api-item"><a name="getStatus()"></a><a name="setStatus()"></a><a name="getStatus--"></a><a name="setStatus--"></a>
<h3 class="api-name" id="status()">status</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/LiveContentResponse.Status.html">LiveContentResponse.Status</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveContentResponse.html#status()">status</a></pre>
+ <p>The status of the live content response. Indicates whether the response is normal, was interrupted, or signifies the completion of a turn.</p>
</div>
<div class="api-item"><a name="getText()"></a><a name="setText()"></a><a name="getText--"></a><a name="setText--"></a>
<h3 class="api-name" id="text()">text</h3>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/LiveSession.html 2025-04-11 15:42:59.022190950 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/LiveSession.html 2025-04-11 15:40:44.173439427 +0000
@@ -85,7 +85,7 @@
<td><code>final void</code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveSession.html#stopReceiving()">stopReceiving</a>()</code></div>
- <p>Stops receiving from the server.</p>
+ <p>Stops receiving from the model.</p>
</td>
</tr>
</tbody>
@@ -97,6 +97,7 @@
<h3 class="api-name" id="close()">close</h3>
<pre class="api-signature no-pretty-print">public final void <a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveSession.html#close()">close</a>()</pre>
<p>Closes the client session.</p>
+ <p>After this is called, the session object becomes unusable. To interact with the server again, you must create a new session using <code><a href="/docs/reference/android/com/google/firebase/vertexai/LiveGenerativeModel.html">LiveGenerativeModel</a></code>.</p>
</div>
<div class="api-item"><a name="receive--"></a><a name="receive"></a>
<h3 class="api-name" id="receive()">receive</h3>
@@ -283,7 +284,9 @@
<div class="api-item"><a name="stopReceiving--"></a><a name="stopreceiving"></a>
<h3 class="api-name" id="stopReceiving()">stopReceiving</h3>
<pre class="api-signature no-pretty-print">public final void <a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveSession.html#stopReceiving()">stopReceiving</a>()</pre>
- <p>Stops receiving from the server. If this function is called during an ongoing audio conversation, the server's response will not be received, and no audio will be played.</p>
+ <p>Stops receiving from the model.</p>
+ <p>If this function is called during an ongoing audio conversation, the model's response will not be received, and no audio will be played; the live session object will no longer receive data from the server.</p>
+ <p>To resume receiving data, you must either handle it directly using <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveSession.html#receive()">receive</a></code>, or indirectly by using <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveSession.html#startAudioConversation(kotlin.Function1)">startAudioConversation</a></code>.</p>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ResponseModality.html 2025-04-11 15:42:59.028190894 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ResponseModality.html 2025-04-11 15:40:44.179439371 +0000
@@ -11,7 +11,7 @@
<pre>@<a href="/docs/reference/android/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ResponseModality.html">ResponseModality</a></pre>
</p>
<hr>
- <p>Modality for bidirectional streaming.</p>
+ <p>Represents the type of content present in a response (e.g., text, image, audio).</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -49,21 +49,21 @@
<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/ResponseModality.html">ResponseModality</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ResponseModality.Companion.html#AUDIO()">AUDIO</a></code></div>
- <p>Audio.</p>
+ <p>Represents an audio response modality.</p>
</td>
</tr>
<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/ResponseModality.html">ResponseModality</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ResponseModality.Companion.html#IMAGE()">IMAGE</a></code></div>
- <p>Image.</p>
+ <p>Represents an image response modality.</p>
</td>
</tr>
<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/ResponseModality.html">ResponseModality</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ResponseModality.Companion.html#TEXT()">TEXT</a></code></div>
- <p>Plain text.</p>
+ <p>Represents a plain text response modality.</p>
</td>
</tr>
<tr>
@@ -87,17 +87,17 @@
<div class="api-item"><a name="getAUDIO()"></a><a name="setAUDIO()"></a><a name="getAUDIO--"></a><a name="setAUDIO--"></a>
<h3 class="api-name" id="AUDIO()">AUDIO</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/ResponseModality.html">ResponseModality</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ResponseModality.Companion.html#AUDIO()">AUDIO</a></pre>
- <p>Audio.</p>
+ <p>Represents an audio response modality.</p>
</div>
<div class="api-item"><a name="getIMAGE()"></a><a name="setIMAGE()"></a><a name="getIMAGE--"></a><a name="setIMAGE--"></a>
<h3 class="api-name" id="IMAGE()">IMAGE</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/ResponseModality.html">ResponseModality</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ResponseModality.Companion.html#IMAGE()">IMAGE</a></pre>
- <p>Image.</p>
+ <p>Represents an image response modality.</p>
</div>
<div class="api-item"><a name="getTEXT()"></a><a name="setTEXT()"></a><a name="getTEXT--"></a><a name="setTEXT--"></a>
<h3 class="api-name" id="TEXT()">TEXT</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/ResponseModality.html">ResponseModality</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ResponseModality.Companion.html#TEXT()">TEXT</a></pre>
- <p>Plain text.</p>
+ <p>Represents a plain text response modality.</p>
</div>
<div class="api-item"><a name="getUNSPECIFIED()"></a><a name="setUNSPECIFIED()"></a><a name="getUNSPECIFIED--"></a><a name="setUNSPECIFIED--"></a>
<h3 class="api-name" id="UNSPECIFIED()">UNSPECIFIED</h3>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/SpeechConfig.html 2025-04-11 15:42:59.028190894 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/SpeechConfig.html 2025-04-11 15:40:44.178439381 +0000
@@ -29,6 +29,7 @@
<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/Voices.html">Voices</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SpeechConfig.html#voice()">voice</a></code></div>
+ <p>The voice to be used for the server's speech response.</p>
</td>
</tr>
</tbody>
@@ -59,6 +60,7 @@
<div class="api-item"><a name="getVoice()"></a><a name="setVoice()"></a><a name="getVoice--"></a><a name="setVoice--"></a>
<h3 class="api-name" id="voice()">voice</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/Voices.html">Voices</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/SpeechConfig.html#voice()">voice</a></pre>
+ <p>The voice to be used for the server's speech response.</p>
</div>
</div>
<div class="list">--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/Voices.html 2025-04-11 15:42:59.031190866 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/Voices.html 2025-04-11 15:40:44.181439353 +0000
@@ -49,37 +49,42 @@
<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/Voices.html">Voices</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Voices.Companion.html#AOEDE()">AOEDE</a></code></div>
+ <p>Represents the Aoede voice.</p>
</td>
</tr>
<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/Voices.html">Voices</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Voices.Companion.html#CHARON()">CHARON</a></code></div>
+ <p>Represents the Charon voice.</p>
</td>
</tr>
<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/Voices.html">Voices</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Voices.Companion.html#FENRIR()">FENRIR</a></code></div>
+ <p>Represents the Fenrir voice.</p>
</td>
</tr>
<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/Voices.html">Voices</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Voices.Companion.html#KORE()">KORE</a></code></div>
+ <p>Represents the Kore voice.</p>
</td>
</tr>
<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/Voices.html">Voices</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Voices.Companion.html#PUCK()">PUCK</a></code></div>
+ <p>Represents the Puck voice.</p>
</td>
</tr>
<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/Voices.html">Voices</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Voices.Companion.html#UNSPECIFIED()">UNSPECIFIED</a></code></div>
- <p>Unspecified modality.</p>
+ <p>Unspecified voice.</p>
</td>
</tr>
<tr>
@@ -96,27 +101,33 @@
<div class="api-item"><a name="getAOEDE()"></a><a name="setAOEDE()"></a><a name="getAOEDE--"></a><a name="setAOEDE--"></a>
<h3 class="api-name" id="AOEDE()">AOEDE</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/Voices.html">Voices</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Voices.Companion.html#AOEDE()">AOEDE</a></pre>
+ <p>Represents the Aoede voice.</p>
</div>
<div class="api-item"><a name="getCHARON()"></a><a name="setCHARON()"></a><a name="getCHARON--"></a><a name="setCHARON--"></a>
<h3 class="api-name" id="CHARON()">CHARON</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/Voices.html">Voices</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Voices.Companion.html#CHARON()">CHARON</a></pre>
+ <p>Represents the Charon voice.</p>
</div>
<div class="api-item"><a name="getFENRIR()"></a><a name="setFENRIR()"></a><a name="getFENRIR--"></a><a name="setFENRIR--"></a>
<h3 class="api-name" id="FENRIR()">FENRIR</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/Voices.html">Voices</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Voices.Companion.html#FENRIR()">FENRIR</a></pre>
+ <p>Represents the Fenrir voice.</p>
</div>
<div class="api-item"><a name="getKORE()"></a><a name="setKORE()"></a><a name="getKORE--"></a><a name="setKORE--"></a>
<h3 class="api-name" id="KORE()">KORE</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/Voices.html">Voices</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Voices.Companion.html#KORE()">KORE</a></pre>
+ <p>Represents the Kore voice.</p>
</div>
<div class="api-item"><a name="getPUCK()"></a><a name="setPUCK()"></a><a name="getPUCK--"></a><a name="setPUCK--"></a>
<h3 class="api-name" id="PUCK()">PUCK</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/Voices.html">Voices</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Voices.Companion.html#PUCK()">PUCK</a></pre>
+ <p>Represents the Puck voice.</p>
</div>
<div class="api-item"><a name="getUNSPECIFIED()"></a><a name="setUNSPECIFIED()"></a><a name="getUNSPECIFIED--"></a><a name="setUNSPECIFIED--"></a>
<h3 class="api-name" id="UNSPECIFIED()">UNSPECIFIED</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/Voices.html">Voices</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Voices.Companion.html#UNSPECIFIED()">UNSPECIFIED</a></pre>
- <p>Unspecified modality.</p>
+ <p>Unspecified voice.</p>
+ <p>Will use the default voice of the model.</p>
</div>
<div class="api-item"><a name="getOrdinal()"></a><a name="setOrdinal()"></a><a name="getOrdinal--"></a><a name="setOrdinal--"></a>
<h3 class="api-name" id="ordinal()">ordinal</h3>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/package-summary.html 2025-04-11 15:42:59.026190913 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/package-summary.html 2025-04-11 15:40:44.176439399 +0000
@@ -256,11 +256,15 @@
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveContentResponse.html">LiveContentResponse</a></code></td>
- <td></td>
+ <td>
+ <p>Represents the response from the model for live content updates.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveContentResponse.Status.html">LiveContentResponse.Status</a></code></td>
- <td></td>
+ <td>
+ <p>Represents the status of a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveContentResponse.html">LiveContentResponse</a></code>, within a single interaction.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/LiveGenerationConfig.html">LiveGenerationConfig</a></code></td>
@@ -315,7 +319,7 @@
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ResponseModality.html">ResponseModality</a></code></td>
<td>
- <p>Modality for bidirectional streaming.</p>
+ <p>Represents the type of content present in a response (e.g., text, image, audio).</p>
</td>
</tr>
<tr>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.Status.html 2025-04-11 15:42:59.011191052 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.Status.html 2025-04-11 15:40:44.164439511 +0000
@@ -11,6 +11,7 @@
<pre>value class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.Status.html">LiveContentResponse.Status</a></pre>
</p>
<hr>
+ <p>Represents the status of a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.html">LiveContentResponse</a></code>, within a single interaction.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -28,18 +29,21 @@
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.Status.html">LiveContentResponse.Status</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.Status.Companion.html#INTERRUPTED()">INTERRUPTED</a></code></div>
+ <p>The server was interrupted while generating data.</p>
</td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.Status.html">LiveContentResponse.Status</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.Status.Companion.html#NORMAL()">NORMAL</a></code></div>
+ <p>The server is actively sending data for the current interaction.</p>
</td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.Status.html">LiveContentResponse.Status</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.Status.Companion.html#TURN_COMPLETE()">TURN_COMPLETE</a></code></div>
+ <p>The model has finished sending data in the current interaction.</p>
</td>
</tr>
</tbody>
@@ -50,14 +54,19 @@
<div class="api-item"><a name="getINTERRUPTED()"></a><a name="setINTERRUPTED()"></a><a name="getINTERRUPTED--"></a><a name="setINTERRUPTED--"></a>
<h3 class="api-name" id="INTERRUPTED()">INTERRUPTED</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.Status.Companion.html#INTERRUPTED()">INTERRUPTED</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.Status.html">LiveContentResponse.Status</a></pre>
+ <p>The server was interrupted while generating data.</p>
+ <p>An interruption occurs when the client sends a message while the server is <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.Status.Companion.html#NORMAL()">actively</a></code> sending data.</p>
</div>
<div class="api-item"><a name="getNORMAL()"></a><a name="setNORMAL()"></a><a name="getNORMAL--"></a><a name="setNORMAL--"></a>
<h3 class="api-name" id="NORMAL()">NORMAL</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.Status.Companion.html#NORMAL()">NORMAL</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.Status.html">LiveContentResponse.Status</a></pre>
+ <p>The server is actively sending data for the current interaction.</p>
</div>
<div class="api-item"><a name="getTURN_COMPLETE()"></a><a name="setTURN_COMPLETE()"></a><a name="getTURN_COMPLETE--"></a><a name="setTURN_COMPLETE--"></a>
<h3 class="api-name" id="TURN_COMPLETE()">TURN_COMPLETE</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.Status.Companion.html#TURN_COMPLETE()">TURN_COMPLETE</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.Status.html">LiveContentResponse.Status</a></pre>
+ <p>The model has finished sending data in the current interaction.</p>
+ <p>Can be set alongside content, signifying that the content is the last in the turn.</p>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.html 2025-04-11 15:42:59.009191070 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.html 2025-04-11 15:40:44.162439529 +0000
@@ -11,6 +11,8 @@
<pre>@<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.html">LiveContentResponse</a></pre>
</p>
<hr>
+ <p>Represents the response from the model for live content updates.</p>
+ <p>This class encapsulates the content data, the status of the response, and any function calls included in the response.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -27,6 +29,7 @@
<tr>
<td>
<div><code>value class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.Status.html">LiveContentResponse.Status</a></code></div>
+ <p>Represents the status of a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.html">LiveContentResponse</a></code>, within a single interaction.</p>
</td>
</tr>
</tbody>
@@ -48,18 +51,21 @@
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Content.html">Content</a>?</code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.html#data()">data</a></code></div>
+ <p>The main content data of the response.</p>
</td>
</tr>
<tr>
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FunctionCallPart.html">FunctionCallPart</a>>?</code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.html#functionCalls()">functionCalls</a></code></div>
+ <p>A list of <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FunctionCallPart.html">FunctionCallPart</a></code> included in the response, if any.</p>
</td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.Status.html">LiveContentResponse.Status</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.html#status()">status</a></code></div>
+ <p>The status of the live content response.</p>
</td>
</tr>
<tr>
@@ -77,14 +83,18 @@
<div class="api-item"><a name="getData()"></a><a name="setData()"></a><a name="getData--"></a><a name="setData--"></a>
<h3 class="api-name" id="data()">data</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.html#data()">data</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Content.html">Content</a>?</pre>
+ <p>The main content data of the response. This can be <code>null</code> if there is no content.</p>
</div>
<div class="api-item"><a name="getFunctionCalls()"></a><a name="setFunctionCalls()"></a><a name="getFunctionCalls--"></a><a name="setFunctionCalls--"></a>
<h3 class="api-name" id="functionCalls()">functionCalls</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.html#functionCalls()">functionCalls</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FunctionCallPart.html">FunctionCallPart</a>>?</pre>
+ <p>A list of <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FunctionCallPart.html">FunctionCallPart</a></code> included in the response, if any.</p>
+ <p>This list can be null or empty if no function calls are present.</p>
</div>
<div class="api-item"><a name="getStatus()"></a><a name="setStatus()"></a><a name="getStatus--"></a><a name="setStatus--"></a>
<h3 class="api-name" id="status()">status</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.html#status()">status</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.Status.html">LiveContentResponse.Status</a></pre>
+ <p>The status of the live content response. Indicates whether the response is normal, was interrupted, or signifies the completion of a turn.</p>
</div>
<div class="api-item"><a name="getText()"></a><a name="setText()"></a><a name="getText--"></a><a name="setText--"></a>
<h3 class="api-name" id="text()">text</h3>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/LiveSession.html 2025-04-11 15:42:59.009191070 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/LiveSession.html 2025-04-11 15:40:44.163439520 +0000
@@ -85,7 +85,7 @@
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveSession.html#stopReceiving()">stopReceiving</a>()</code></div>
- <p>Stops receiving from the server.</p>
+ <p>Stops receiving from the model.</p>
</td>
</tr>
</tbody>
@@ -97,6 +97,7 @@
<h3 class="api-name" id="close()">close</h3>
<pre class="api-signature no-pretty-print">suspend fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveSession.html#close()">close</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></pre>
<p>Closes the client session.</p>
+ <p>After this is called, the session object becomes unusable. To interact with the server again, you must create a new session using <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/LiveGenerativeModel.html">LiveGenerativeModel</a></code>.</p>
</div>
<div class="api-item"><a name="receive--"></a><a name="receive"></a>
<h3 class="api-name" id="receive()">receive</h3>
@@ -283,7 +284,9 @@
<div class="api-item"><a name="stopReceiving--"></a><a name="stopreceiving"></a>
<h3 class="api-name" id="stopReceiving()">stopReceiving</h3>
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveSession.html#stopReceiving()">stopReceiving</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></pre>
- <p>Stops receiving from the server. If this function is called during an ongoing audio conversation, the server's response will not be received, and no audio will be played.</p>
+ <p>Stops receiving from the model.</p>
+ <p>If this function is called during an ongoing audio conversation, the model's response will not be received, and no audio will be played; the live session object will no longer receive data from the server.</p>
+ <p>To resume receiving data, you must either handle it directly using <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveSession.html#receive()">receive</a></code>, or indirectly by using <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveSession.html#startAudioConversation(kotlin.Function1)">startAudioConversation</a></code>.</p>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ResponseModality.html 2025-04-11 15:42:59.015191014 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ResponseModality.html 2025-04-11 15:40:44.168439474 +0000
@@ -11,7 +11,7 @@
<pre>@<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ResponseModality.html">ResponseModality</a></pre>
</p>
<hr>
- <p>Modality for bidirectional streaming.</p>
+ <p>Represents the type of content present in a response (e.g., text, image, audio).</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -29,21 +29,21 @@
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ResponseModality.html">ResponseModality</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ResponseModality.Companion.html#AUDIO()">AUDIO</a></code></div>
- <p>Audio.</p>
+ <p>Represents an audio response modality.</p>
</td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ResponseModality.html">ResponseModality</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ResponseModality.Companion.html#IMAGE()">IMAGE</a></code></div>
- <p>Image.</p>
+ <p>Represents an image response modality.</p>
</td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ResponseModality.html">ResponseModality</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ResponseModality.Companion.html#TEXT()">TEXT</a></code></div>
- <p>Plain text.</p>
+ <p>Represents a plain text response modality.</p>
</td>
</tr>
<tr>
@@ -82,17 +82,17 @@
<div class="api-item"><a name="getAUDIO()"></a><a name="setAUDIO()"></a><a name="getAUDIO--"></a><a name="setAUDIO--"></a>
<h3 class="api-name" id="AUDIO()">AUDIO</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ResponseModality.Companion.html#AUDIO()">AUDIO</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ResponseModality.html">ResponseModality</a></pre>
- <p>Audio.</p>
+ <p>Represents an audio response modality.</p>
</div>
<div class="api-item"><a name="getIMAGE()"></a><a name="setIMAGE()"></a><a name="getIMAGE--"></a><a name="setIMAGE--"></a>
<h3 class="api-name" id="IMAGE()">IMAGE</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ResponseModality.Companion.html#IMAGE()">IMAGE</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ResponseModality.html">ResponseModality</a></pre>
- <p>Image.</p>
+ <p>Represents an image response modality.</p>
</div>
<div class="api-item"><a name="getTEXT()"></a><a name="setTEXT()"></a><a name="getTEXT--"></a><a name="setTEXT--"></a>
<h3 class="api-name" id="TEXT()">TEXT</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ResponseModality.Companion.html#TEXT()">TEXT</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ResponseModality.html">ResponseModality</a></pre>
- <p>Plain text.</p>
+ <p>Represents a plain text response modality.</p>
</div>
<div class="api-item"><a name="getUNSPECIFIED()"></a><a name="setUNSPECIFIED()"></a><a name="getUNSPECIFIED--"></a><a name="setUNSPECIFIED--"></a>
<h3 class="api-name" id="UNSPECIFIED()">UNSPECIFIED</h3>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/SpeechConfig.html 2025-04-11 15:42:59.015191014 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/SpeechConfig.html 2025-04-11 15:40:44.167439483 +0000
@@ -49,6 +49,7 @@
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.html">Voices</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SpeechConfig.html#voice()">voice</a></code></div>
+ <p>The voice to be used for the server's speech response.</p>
</td>
</tr>
</tbody>
@@ -66,6 +67,7 @@
<div class="api-item"><a name="getVoice()"></a><a name="setVoice()"></a><a name="getVoice--"></a><a name="setVoice--"></a>
<h3 class="api-name" id="voice()">voice</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SpeechConfig.html#voice()">voice</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.html">Voices</a></pre>
+ <p>The voice to be used for the server's speech response.</p>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/Voices.html 2025-04-11 15:42:59.018190987 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/Voices.html 2025-04-11 15:40:44.169439464 +0000
@@ -29,37 +29,42 @@
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.html">Voices</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.Companion.html#AOEDE()">AOEDE</a></code></div>
+ <p>Represents the Aoede voice.</p>
</td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.html">Voices</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.Companion.html#CHARON()">CHARON</a></code></div>
+ <p>Represents the Charon voice.</p>
</td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.html">Voices</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.Companion.html#FENRIR()">FENRIR</a></code></div>
+ <p>Represents the Fenrir voice.</p>
</td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.html">Voices</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.Companion.html#KORE()">KORE</a></code></div>
+ <p>Represents the Kore voice.</p>
</td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.html">Voices</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.Companion.html#PUCK()">PUCK</a></code></div>
+ <p>Represents the Puck voice.</p>
</td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.html">Voices</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.Companion.html#UNSPECIFIED()">UNSPECIFIED</a></code></div>
- <p>Unspecified modality.</p>
+ <p>Unspecified voice.</p>
</td>
</tr>
</tbody>
@@ -91,27 +96,33 @@
<div class="api-item"><a name="getAOEDE()"></a><a name="setAOEDE()"></a><a name="getAOEDE--"></a><a name="setAOEDE--"></a>
<h3 class="api-name" id="AOEDE()">AOEDE</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.Companion.html#AOEDE()">AOEDE</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.html">Voices</a></pre>
+ <p>Represents the Aoede voice.</p>
</div>
<div class="api-item"><a name="getCHARON()"></a><a name="setCHARON()"></a><a name="getCHARON--"></a><a name="setCHARON--"></a>
<h3 class="api-name" id="CHARON()">CHARON</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.Companion.html#CHARON()">CHARON</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.html">Voices</a></pre>
+ <p>Represents the Charon voice.</p>
</div>
<div class="api-item"><a name="getFENRIR()"></a><a name="setFENRIR()"></a><a name="getFENRIR--"></a><a name="setFENRIR--"></a>
<h3 class="api-name" id="FENRIR()">FENRIR</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.Companion.html#FENRIR()">FENRIR</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.html">Voices</a></pre>
+ <p>Represents the Fenrir voice.</p>
</div>
<div class="api-item"><a name="getKORE()"></a><a name="setKORE()"></a><a name="getKORE--"></a><a name="setKORE--"></a>
<h3 class="api-name" id="KORE()">KORE</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.Companion.html#KORE()">KORE</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.html">Voices</a></pre>
+ <p>Represents the Kore voice.</p>
</div>
<div class="api-item"><a name="getPUCK()"></a><a name="setPUCK()"></a><a name="getPUCK--"></a><a name="setPUCK--"></a>
<h3 class="api-name" id="PUCK()">PUCK</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.Companion.html#PUCK()">PUCK</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.html">Voices</a></pre>
+ <p>Represents the Puck voice.</p>
</div>
<div class="api-item"><a name="getUNSPECIFIED()"></a><a name="setUNSPECIFIED()"></a><a name="getUNSPECIFIED--"></a><a name="setUNSPECIFIED--"></a>
<h3 class="api-name" id="UNSPECIFIED()">UNSPECIFIED</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.Companion.html#UNSPECIFIED()">UNSPECIFIED</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Voices.html">Voices</a></pre>
- <p>Unspecified modality.</p>
+ <p>Unspecified voice.</p>
+ <p>Will use the default voice of the model.</p>
</div>
</div>
<div class="list">--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/package-summary.html 2025-04-11 15:42:59.012191042 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/package-summary.html 2025-04-11 15:40:44.165439501 +0000
@@ -229,11 +229,15 @@
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.html">LiveContentResponse</a></code></td>
- <td></td>
+ <td>
+ <p>Represents the response from the model for live content updates.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.Status.html">LiveContentResponse.Status</a></code></td>
- <td></td>
+ <td>
+ <p>Represents the status of a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.html">LiveContentResponse</a></code>, within a single interaction.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/LiveGenerationConfig.html">LiveGenerationConfig</a></code></td>
@@ -280,7 +284,7 @@
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ResponseModality.html">ResponseModality</a></code></td>
<td>
- <p>Modality for bidirectional streaming.</p>
+ <p>Represents the type of content present in a response (e.g., text, image, audio).</p>
</td>
</tr>
<tr> |
Generated by 🚫 Danger |
Test Results 18 files - 168 18 suites - 168 14s ⏱️ - 4m 26s Results for commit d75be4c. ± Comparison against base commit edcea54. This pull request removes 1235 and adds 86 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
Size Report 1Affected Products
Test Logs |
rlazo
reviewed
Apr 8, 2025
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.kt
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.kt
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/LiveSession.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/LiveSession.kt
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/Voices.kt
Outdated
Show resolved
Hide resolved
…/type/LiveContentResponse.kt Co-authored-by: Rodrigo Lazo <rlazo@users.noreply.github.com>
daymxn
approved these changes
Apr 8, 2025
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ResponseModality.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ResponseModality.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/Voices.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/Voices.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/Voices.kt
Outdated
Show resolved
Hide resolved
…/type/LiveContentResponse.kt Co-authored-by: Daymon <17409137+daymxn@users.noreply.github.com>
…/type/LiveContentResponse.kt Co-authored-by: Daymon <17409137+daymxn@users.noreply.github.com>
…/type/LiveContentResponse.kt Co-authored-by: Rodrigo Lazo <rlazo@users.noreply.github.com>
…/type/LiveSession.kt Co-authored-by: Daymon <17409137+daymxn@users.noreply.github.com>
…/type/ResponseModality.kt Co-authored-by: Daymon <17409137+daymxn@users.noreply.github.com>
…/type/Voices.kt Co-authored-by: Daymon <17409137+daymxn@users.noreply.github.com>
…/type/LiveSession.kt Co-authored-by: Daymon <17409137+daymxn@users.noreply.github.com>
…/type/LiveContentResponse.kt Co-authored-by: Daymon <17409137+daymxn@users.noreply.github.com>
…/type/LiveContentResponse.kt Co-authored-by: Daymon <17409137+daymxn@users.noreply.github.com>
|
The public api surface has changed for the subproject firebase-vertexai: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
2 similar comments
|
The public api surface has changed for the subproject firebase-vertexai: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
|
The public api surface has changed for the subproject firebase-vertexai: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
rlazo
reviewed
Apr 8, 2025
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/LiveSession.kt
Outdated
Show resolved
Hide resolved
|
The public api surface has changed for the subproject firebase-vertexai: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
rlazo
approved these changes
Apr 8, 2025
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/LiveContentResponse.kt
Show resolved
Hide resolved
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
No description provided.