update voice #6996
Merged
update voice #6996
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/client/firebase-ai/_toc.yaml 2025-05-28 20:24:27.412098962 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/client/firebase-ai/_toc.yaml 2025-05-28 20:20:44.383024759 +0000
@@ -174,6 +174,8 @@
path: "/docs/reference/android/com/google/firebase/ai/type/ToolConfig.html"
- title: "UsageMetadata"
path: "/docs/reference/android/com/google/firebase/ai/type/UsageMetadata.html"
+ - title: "Voice"
+ path: "/docs/reference/android/com/google/firebase/ai/type/Voice.html"
- title: "Voices"
path: "/docs/reference/android/com/google/firebase/ai/type/Voices.html"
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/ai/type/SpeechConfig.html 2025-05-28 20:24:27.419099019 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/ai/type/SpeechConfig.html 2025-05-28 20:20:44.390024801 +0000
@@ -26,7 +26,7 @@
</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/ai/type/Voices.html">Voices</a></code></td>
+ <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/ai/type/Voice.html">Voice</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/ai/type/SpeechConfig.html#voice()">voice</a></code></div>
<p>The voice to be used for the server's speech response.</p>
@@ -49,7 +49,7 @@
<tbody class="list">
<tr>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/ai/type/SpeechConfig.html#SpeechConfig(com.google.firebase.ai.type.Voices)">SpeechConfig</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/ai/type/Voices.html">Voices</a> voice)</code></div>
+ <div><code><a href="/docs/reference/android/com/google/firebase/ai/type/SpeechConfig.html#SpeechConfig(com.google.firebase.ai.type.Voice)">SpeechConfig</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/ai/type/Voice.html">Voice</a> voice)</code></div>
</td>
</tr>
</tbody>
@@ -59,15 +59,15 @@
<h2>Public fields</h2>
<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/ai/type/Voices.html">Voices</a> <a href="/docs/reference/android/com/google/firebase/ai/type/SpeechConfig.html#voice()">voice</a></pre>
+ <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/ai/type/Voice.html">Voice</a> <a href="/docs/reference/android/com/google/firebase/ai/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">
<h2>Public constructors</h2>
- <div class="api-item"><a name="SpeechConfig-com.google.firebase.ai.type.Voices-"></a><a name="speechconfig"></a>
- <h3 class="api-name" id="SpeechConfig(com.google.firebase.ai.type.Voices)">SpeechConfig</h3>
- <pre class="api-signature no-pretty-print">public <a href="/docs/reference/android/com/google/firebase/ai/type/SpeechConfig.html#SpeechConfig(com.google.firebase.ai.type.Voices)">SpeechConfig</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/ai/type/Voices.html">Voices</a> voice)</pre>
+ <div class="api-item"><a name="SpeechConfig-com.google.firebase.ai.type.Voice-"></a><a name="speechconfig"></a>
+ <h3 class="api-name" id="SpeechConfig(com.google.firebase.ai.type.Voice)">SpeechConfig</h3>
+ <pre class="api-signature no-pretty-print">public <a href="/docs/reference/android/com/google/firebase/ai/type/SpeechConfig.html#SpeechConfig(com.google.firebase.ai.type.Voice)">SpeechConfig</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/ai/type/Voice.html">Voice</a> voice)</pre>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/ai/type/Voice.html 1970-01-01 00:00:00.000000000 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/ai/type/Voice.html 2025-05-28 20:20:44.395024832 +0000
@@ -0,0 +1,73 @@
+<html devsite="true">
+ <head>
+ <title>Voice</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/android/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>Voice</h1>
+ <p>
+ <pre>@<a href="/docs/reference/android/com/google/firebase/ai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br>public final class <a href="/docs/reference/android/com/google/firebase/ai/type/Voice.html">Voice</a></pre>
+ </p>
+ <hr>
+ <p>Various voices supported by the server. The list of all voices can be found <a href="https://cloud.google.com/text-to-speech/docs/chirp3-hd">here</a></p>
+ <h2>Summary</h2>
+ <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/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/ai/type/Voice.html#voiceName()">voiceName</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 constructors</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/ai/type/Voice.html#Voice(kotlin.String)">Voice</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> voiceName)</code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public fields</h2>
+ <div class="api-item"><a name="getVoiceName()"></a><a name="setVoiceName()"></a><a name="getVoiceName--"></a><a name="setVoiceName--"></a>
+ <h3 class="api-name" id="voiceName()">voiceName</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/ai/type/Voice.html#voiceName()">voiceName</a></pre>
+ </div>
+ </div>
+ <div class="list">
+ <h2>Public constructors</h2>
+ <div class="api-item"><a name="Voice-kotlin.String-"></a><a name="voice"></a>
+ <h3 class="api-name" id="Voice(kotlin.String)">Voice</h3>
+ <pre class="api-signature no-pretty-print">public <a href="/docs/reference/android/com/google/firebase/ai/type/Voice.html#Voice(kotlin.String)">Voice</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> voiceName)</pre>
+ </div>
+ </div>
+ </body>
+</html>
+--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/ai/type/Voices.html 2025-05-28 20:24:27.447099248 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/ai/type/Voices.html 2025-05-28 20:20:44.420024984 +0000
@@ -11,6 +11,7 @@
<pre>@<a href="/docs/reference/android/com/google/firebase/ai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br>public final class <a href="/docs/reference/android/com/google/firebase/ai/type/Voices.html">Voices</a></pre>
</p>
<hr>
+ <aside class="caution"><strong>This class is deprecated.</strong><br>Please use the Voice class instead.</aside>
<p>Various voices supported by the server</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/ai/type/package-summary.html 2025-05-28 20:24:27.430099109 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/ai/type/package-summary.html 2025-05-28 20:20:44.396024838 +0000
@@ -403,9 +403,15 @@
</td>
</tr>
<tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/ai/type/Voice.html">Voice</a></code></td>
+ <td>
+ <p>Various voices supported by the server.</p>
+ </td>
+ </tr>
+ <tr>
<td><code><a href="/docs/reference/android/com/google/firebase/ai/type/Voices.html">Voices</a></code></td>
<td>
- <p>Various voices supported by the server</p>
+ <p><strong>This class is deprecated.</strong> Please use the Voice class instead.</p>
</td>
</tr>
</tbody>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/client/firebase-ai/_toc.yaml 2025-05-28 20:24:27.485099558 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/client/firebase-ai/_toc.yaml 2025-05-28 20:20:44.439025099 +0000
@@ -162,6 +162,8 @@
path: "/docs/reference/kotlin/com/google/firebase/ai/type/ToolConfig.html"
- title: "UsageMetadata"
path: "/docs/reference/kotlin/com/google/firebase/ai/type/UsageMetadata.html"
+ - title: "Voice"
+ path: "/docs/reference/kotlin/com/google/firebase/ai/type/Voice.html"
- title: "Voices"
path: "/docs/reference/kotlin/com/google/firebase/ai/type/Voices.html"
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/ai/type/SpeechConfig.html 2025-05-28 20:24:27.487099575 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/ai/type/SpeechConfig.html 2025-05-28 20:20:44.441025111 +0000
@@ -27,7 +27,7 @@
<tbody class="list">
<tr>
<td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/ai/type/SpeechConfig.html#SpeechConfig(com.google.firebase.ai.type.Voices)">SpeechConfig</a>(voice: <a href="/docs/reference/kotlin/com/google/firebase/ai/type/Voices.html">Voices</a>)</code></div>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/ai/type/SpeechConfig.html#SpeechConfig(com.google.firebase.ai.type.Voice)">SpeechConfig</a>(voice: <a href="/docs/reference/kotlin/com/google/firebase/ai/type/Voice.html">Voice</a>)</code></div>
</td>
</tr>
</tbody>
@@ -46,7 +46,7 @@
</thead>
<tbody class="list">
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/ai/type/Voices.html">Voices</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/ai/type/Voice.html">Voice</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/ai/type/SpeechConfig.html#voice()">voice</a></code></div>
<p>The voice to be used for the server's speech response.</p>
@@ -57,16 +57,16 @@
</div>
<div class="list">
<h2>Public constructors</h2>
- <div class="api-item"><a name="SpeechConfig-com.google.firebase.ai.type.Voices-"></a><a name="speechconfig"></a>
- <h3 class="api-name" id="SpeechConfig(com.google.firebase.ai.type.Voices)">SpeechConfig</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/ai/type/SpeechConfig.html#SpeechConfig(com.google.firebase.ai.type.Voices)">SpeechConfig</a>(voice: <a href="/docs/reference/kotlin/com/google/firebase/ai/type/Voices.html">Voices</a>)</pre>
+ <div class="api-item"><a name="SpeechConfig-com.google.firebase.ai.type.Voice-"></a><a name="speechconfig"></a>
+ <h3 class="api-name" id="SpeechConfig(com.google.firebase.ai.type.Voice)">SpeechConfig</h3>
+ <pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/ai/type/SpeechConfig.html#SpeechConfig(com.google.firebase.ai.type.Voice)">SpeechConfig</a>(voice: <a href="/docs/reference/kotlin/com/google/firebase/ai/type/Voice.html">Voice</a>)</pre>
</div>
</div>
<div class="list">
<h2>Public properties</h2>
<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/ai/type/SpeechConfig.html#voice()">voice</a>: <a href="/docs/reference/kotlin/com/google/firebase/ai/type/Voices.html">Voices</a></pre>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/ai/type/SpeechConfig.html#voice()">voice</a>: <a href="/docs/reference/kotlin/com/google/firebase/ai/type/Voice.html">Voice</a></pre>
<p>The voice to be used for the server's speech response.</p>
</div>
</div>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/ai/type/Voice.html 1970-01-01 00:00:00.000000000 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/ai/type/Voice.html 2025-05-28 20:20:44.449025160 +0000
@@ -0,0 +1,73 @@
+<html devsite="true">
+ <head>
+ <title>Voice</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/kotlin/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>Voice</h1>
+ <p>
+ <pre>@<a href="/docs/reference/kotlin/com/google/firebase/ai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br>class <a href="/docs/reference/kotlin/com/google/firebase/ai/type/Voice.html">Voice</a></pre>
+ </p>
+ <hr>
+ <p>Various voices supported by the server. The list of all voices can be found <a href="https://cloud.google.com/text-to-speech/docs/chirp3-hd">here</a></p>
+ <h2>Summary</h2>
+ <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>
+ <tbody class="list">
+ <tr>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/ai/type/Voice.html#Voice(kotlin.String)">Voice</a>(voiceName: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</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 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/ai/type/Voice.html#voiceName()">voiceName</a></code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public constructors</h2>
+ <div class="api-item"><a name="Voice-kotlin.String-"></a><a name="voice"></a>
+ <h3 class="api-name" id="Voice(kotlin.String)">Voice</h3>
+ <pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/ai/type/Voice.html#Voice(kotlin.String)">Voice</a>(voiceName: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</pre>
+ </div>
+ </div>
+ <div class="list">
+ <h2>Public properties</h2>
+ <div class="api-item"><a name="getVoiceName()"></a><a name="setVoiceName()"></a><a name="getVoiceName--"></a><a name="setVoiceName--"></a>
+ <h3 class="api-name" id="voiceName()">voiceName</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/ai/type/Voice.html#voiceName()">voiceName</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></pre>
+ </div>
+ </div>
+ </body>
+</html>
+--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/ai/type/Voices.html 2025-05-28 20:24:27.527099901 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/ai/type/Voices.html 2025-05-28 20:20:44.465025257 +0000
@@ -11,6 +11,7 @@
<pre>@<a href="/docs/reference/kotlin/com/google/firebase/ai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br>class <a href="/docs/reference/kotlin/com/google/firebase/ai/type/Voices.html">Voices</a></pre>
</p>
<hr>
+ <aside class="caution"><strong>This class is deprecated.</strong><br>Please use the Voice class instead.</aside>
<p>Various voices supported by the server</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/ai/type/package-summary.html 2025-05-28 20:24:27.501099689 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/ai/type/package-summary.html 2025-05-28 20:20:44.450025166 +0000
@@ -368,9 +368,15 @@
</td>
</tr>
<tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/ai/type/Voice.html">Voice</a></code></td>
+ <td>
+ <p>Various voices supported by the server.</p>
+ </td>
+ </tr>
+ <tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/ai/type/Voices.html">Voices</a></code></td>
<td>
- <p>Various voices supported by the server</p>
+ <p><strong>This class is deprecated.</strong> Please use the Voice class instead.</p>
</td>
</tr>
</tbody> |
Coverage Report 1Affected ProductsNo changes between base commit (366095f) and merge commit (19e7dbd).Test Logs |
Test Results 24 files - 40 24 suites - 40 34s ⏱️ - 5m 29s Results for commit 7c66918. ± Comparison against base commit 366095f. This pull request removes 487 and adds 102 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
|
The public api surface has changed for the subproject firebase-ai: 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. |
1 similar comment
|
The public api surface has changed for the subproject firebase-ai: 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. |
Size Report 1Affected Products
Test Logs |
rlazo
reviewed
May 28, 2025
firebase-ai/src/main/kotlin/com/google/firebase/ai/type/Voices.kt
Outdated
Show resolved
Hide resolved
rlazo
approved these changes
May 28, 2025
emilypgoogle
pushed a commit
that referenced
this pull request
May 28, 2025
This pr updates the Voice class to take in a string as an attribute instead of just an enum. This is a breaking change since it breaks binary compatibility however I don't think there is any changes that need to be done by the developer
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 pr updates the Voice class to take in a string as an attribute instead of just an enum. This is a breaking change since it breaks binary compatibility however I don't think there is any changes that need to be done by the developer