Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Vertex AI] Add apiVersion parameter to RequestOptions #6636

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

andrewheard
Copy link
Collaborator

@andrewheard andrewheard commented Jan 20, 2025

WIP - See go/firebase-vertex-set-api-version (Google-internal only) for more details.

Added the ability to specify an API version (e.g., v1 or v1beta) when initializing RequestOptions. This is the Android equivalent of firebase/firebase-ios-sdk#14356.

TODOs:

  • API review and approval
  • Add a CHANGELOG entry

Copy link
Contributor

github-actions bot commented Jan 20, 2025

Javadoc Changes:
--- /home/runner/diff/original/firebase-kotlindoc/android/client/firebase-vertexai/_toc.yaml	2025-01-22 22:36:21.083410579 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/client/firebase-vertexai/_toc.yaml	2025-01-22 22:34:10.629294763 +0000
@@ -40,6 +40,8 @@
   - title: "Classes"
 
     section:
+    - title: "ApiVersion"
+      path: "/docs/reference/android/com/google/firebase/vertexai/type/ApiVersion.html"
     - title: "BlockReason"
       path: "/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html"
     - title: "Candidate"
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ApiVersion.Companion.html	1970-01-01 00:00:00.000000000 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ApiVersion.Companion.html	2025-01-22 22:34:10.630294757 +0000
@@ -0,0 +1,16 @@
+<html devsite="true">
+  <head>
+    <title>ApiVersion.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>ApiVersion.Companion</h1>
+    <p>
+      <pre>public static class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ApiVersion.Companion.html">ApiVersion.Companion</a></pre>
+    </p>
+    <hr>
+  </body>
+</html>
+
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ApiVersion.html	1970-01-01 00:00:00.000000000 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ApiVersion.html	2025-01-22 22:34:10.631294750 +0000
@@ -0,0 +1,80 @@
+<html devsite="true">
+  <head>
+    <title>ApiVersion</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/android/_reference-head-tags.html" %}
+  </head>
+  <body>
+    <div id="metadata-info-block"></div>
+    <h1>ApiVersion</h1>
+    <p>
+      <pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ApiVersion.html">ApiVersion</a></pre>
+    </p>
+    <hr>
+    <p>Versions of the Vertex AI in Firebase server API.</p>
+    <h2>Summary</h2>
+    <div class="devsite-table-wrapper">
+      <table class="responsive">
+        <colgroup>
+          <col width="40%">
+          <col>
+        </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/ApiVersion.Companion.html">ApiVersion.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 fields</h3></th>
+          </tr>
+        </thead>
+        <tbody class="list">
+          <tr>
+            <td><code>static&nbsp;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/ApiVersion.html">ApiVersion</a></code></td>
+            <td>
+              <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ApiVersion.Companion.html#V1()">V1</a></code></div>
+              <p>The stable channel for version 1 of the API.</p>
+            </td>
+          </tr>
+          <tr>
+            <td><code>static&nbsp;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/ApiVersion.html">ApiVersion</a></code></td>
+            <td>
+              <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ApiVersion.Companion.html#V1BETA()">V1BETA</a></code></div>
+              <p>The beta channel for version 1 of the API.</p>
+            </td>
+          </tr>
+        </tbody>
+      </table>
+    </div>
+    <div class="list">
+      <h2>Public fields</h2>
+      <div class="api-item"><a name="getV1()"></a><a name="setV1()"></a><a name="getV1--"></a><a name="setV1--"></a>
+        <h3 class="api-name" id="V1()">V1</h3>
+        <pre class="api-signature no-pretty-print">public&nbsp;static&nbsp;final&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ApiVersion.html">ApiVersion</a>&nbsp;<a href="/docs/reference/android/com/google/firebase/vertexai/type/ApiVersion.Companion.html#V1()">V1</a></pre>
+        <p>The stable channel for version 1 of the API.</p>
+      </div>
+      <div class="api-item"><a name="getV1BETA()"></a><a name="setV1BETA()"></a><a name="getV1BETA--"></a><a name="setV1BETA--"></a>
+        <h3 class="api-name" id="V1BETA()">V1BETA</h3>
+        <pre class="api-signature no-pretty-print">public&nbsp;static&nbsp;final&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ApiVersion.html">ApiVersion</a>&nbsp;<a href="/docs/reference/android/com/google/firebase/vertexai/type/ApiVersion.Companion.html#V1BETA()">V1BETA</a></pre>
+        <p>The beta channel for version 1 of the API.</p>
+      </div>
+    </div>
+  </body>
+</html>
+
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/RequestOptions.html	2025-01-22 22:36:21.086410558 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/RequestOptions.html	2025-01-22 22:34:10.632294743 +0000
@@ -27,7 +27,13 @@
         <tbody class="list">
           <tr>
             <td>
-              <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/RequestOptions.html#RequestOptions(kotlin.Long)">RequestOptions</a>(long&nbsp;timeoutInMillis)</code></div>
+              <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/RequestOptions.html#RequestOptions(com.google.firebase.vertexai.type.ApiVersion)">RequestOptions</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/ApiVersion.html">ApiVersion</a>&nbsp;apiVersion)</code></div>
+              <p>Constructor for RequestOptions.</p>
+            </td>
+          </tr>
+          <tr>
+            <td>
+              <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/RequestOptions.html#RequestOptions(kotlin.Long,com.google.firebase.vertexai.type.ApiVersion)">RequestOptions</a>(long&nbsp;timeoutInMillis,&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ApiVersion.html">ApiVersion</a>&nbsp;apiVersion)</code></div>
               <p>Constructor for RequestOptions.</p>
             </td>
           </tr>
@@ -36,9 +42,35 @@
     </div>
     <div class="list">
       <h2>Public constructors</h2>
-      <div class="api-item"><a name="RequestOptions-kotlin.Long-"></a><a name="requestoptions"></a>
-        <h3 class="api-name" id="RequestOptions(kotlin.Long)">RequestOptions</h3>
-        <pre class="api-signature no-pretty-print">public&nbsp;<a href="/docs/reference/android/com/google/firebase/vertexai/type/RequestOptions.html#RequestOptions(kotlin.Long)">RequestOptions</a>(long&nbsp;timeoutInMillis)</pre>
+      <div class="api-item"><a name="RequestOptions-com.google.firebase.vertexai.type.ApiVersion-"></a><a name="requestoptions"></a>
+        <h3 class="api-name" id="RequestOptions(com.google.firebase.vertexai.type.ApiVersion)">RequestOptions</h3>
+        <pre class="api-signature no-pretty-print">public&nbsp;<a href="/docs/reference/android/com/google/firebase/vertexai/type/RequestOptions.html#RequestOptions(com.google.firebase.vertexai.type.ApiVersion)">RequestOptions</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/ApiVersion.html">ApiVersion</a>&nbsp;apiVersion)</pre>
+        <p>Constructor for RequestOptions.</p>
+        <div class="devsite-table-wrapper">
+          <table class="responsive">
+            <colgroup>
+              <col width="40%">
+              <col>
+            </colgroup>
+            <thead>
+              <tr>
+                <th colspan="100%">Parameters</th>
+              </tr>
+            </thead>
+            <tbody class="list">
+              <tr>
+                <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ApiVersion.html">ApiVersion</a>&nbsp;apiVersion</code></td>
+                <td>
+                  <p>the version of the Vertex AI in Firebase API; defaults to <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ApiVersion.Companion.html#V1BETA()">ApiVersion.V1BETA</a></code> if not specified.</p>
+                </td>
+              </tr>
+            </tbody>
+          </table>
+        </div>
+      </div>
+      <div class="api-item"><a name="RequestOptions(kotlin.Long, com.google.firebase.vertexai.type.ApiVersion)"></a><a name="RequestOptions-kotlin.Long-com.google.firebase.vertexai.type.ApiVersion-"></a><a name="requestoptions"></a>
+        <h3 class="api-name" id="RequestOptions(kotlin.Long,com.google.firebase.vertexai.type.ApiVersion)">RequestOptions</h3>
+        <pre class="api-signature no-pretty-print">public&nbsp;<a href="/docs/reference/android/com/google/firebase/vertexai/type/RequestOptions.html#RequestOptions(kotlin.Long,com.google.firebase.vertexai.type.ApiVersion)">RequestOptions</a>(long&nbsp;timeoutInMillis,&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ApiVersion.html">ApiVersion</a>&nbsp;apiVersion)</pre>
         <p>Constructor for RequestOptions.</p>
         <div class="devsite-table-wrapper">
           <table class="responsive">
@@ -58,6 +90,12 @@
                   <p>the maximum amount of time, in milliseconds, for a request to take, from the first request to first response.</p>
                 </td>
               </tr>
+              <tr>
+                <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ApiVersion.html">ApiVersion</a>&nbsp;apiVersion</code></td>
+                <td>
+                  <p>the version of the Vertex AI in Firebase API; defaults to <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ApiVersion.Companion.html#V1BETA()">ApiVersion.V1BETA</a></code> if not specified.</p>
+                </td>
+              </tr>
             </tbody>
           </table>
         </div>
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/package-summary.html	2025-01-22 22:36:21.085410565 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/package-summary.html	2025-01-22 22:34:10.631294750 +0000
@@ -32,6 +32,12 @@
         </colgroup>
         <tbody class="list">
           <tr>
+            <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ApiVersion.html">ApiVersion</a></code></td>
+            <td>
+              <p>Versions of the Vertex AI in Firebase server API.</p>
+            </td>
+          </tr>
+          <tr>
             <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a></code></td>
             <td>
               <p>Describes why content was blocked.</p>
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/client/firebase-vertexai/_toc.yaml	2025-01-22 22:36:21.091410524 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/client/firebase-vertexai/_toc.yaml	2025-01-22 22:34:10.637294709 +0000
@@ -38,6 +38,8 @@
   - title: "Classes"
 
     section:
+    - title: "ApiVersion"
+      path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/ApiVersion.html"
     - title: "BlockReason"
       path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html"
     - title: "Candidate"
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ApiVersion.html	1970-01-01 00:00:00.000000000 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ApiVersion.html	2025-01-22 22:34:10.639294696 +0000
@@ -0,0 +1,60 @@
+<html devsite="true">
+  <head>
+    <title>ApiVersion</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/kotlin/_reference-head-tags.html" %}
+  </head>
+  <body>
+    <div id="metadata-info-block"></div>
+    <h1>ApiVersion</h1>
+    <p>
+      <pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ApiVersion.html">ApiVersion</a></pre>
+    </p>
+    <hr>
+    <p>Versions of the Vertex AI in Firebase server API.</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 companion properties</h3></th>
+          </tr>
+        </thead>
+        <tbody class="list">
+          <tr>
+            <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ApiVersion.html">ApiVersion</a></code></td>
+            <td>
+              <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ApiVersion.Companion.html#V1()">V1</a></code></div>
+              <p>The stable channel for version 1 of the API.</p>
+            </td>
+          </tr>
+          <tr>
+            <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ApiVersion.html">ApiVersion</a></code></td>
+            <td>
+              <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ApiVersion.Companion.html#V1BETA()">V1BETA</a></code></div>
+              <p>The beta channel for version 1 of the API.</p>
+            </td>
+          </tr>
+        </tbody>
+      </table>
+    </div>
+    <div class="list">
+      <h2>Public companion properties</h2>
+      <div class="api-item"><a name="getV1()"></a><a name="setV1()"></a><a name="getV1--"></a><a name="setV1--"></a>
+        <h3 class="api-name" id="V1()">V1</h3>
+        <pre class="api-signature no-pretty-print">val&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ApiVersion.Companion.html#V1()">V1</a>:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ApiVersion.html">ApiVersion</a></pre>
+        <p>The stable channel for version 1 of the API.</p>
+      </div>
+      <div class="api-item"><a name="getV1BETA()"></a><a name="setV1BETA()"></a><a name="getV1BETA--"></a><a name="setV1BETA--"></a>
+        <h3 class="api-name" id="V1BETA()">V1BETA</h3>
+        <pre class="api-signature no-pretty-print">val&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ApiVersion.Companion.html#V1BETA()">V1BETA</a>:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ApiVersion.html">ApiVersion</a></pre>
+        <p>The beta channel for version 1 of the API.</p>
+      </div>
+    </div>
+  </body>
+</html>
+
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/RequestOptions.html	2025-01-22 22:36:21.093410510 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/RequestOptions.html	2025-01-22 22:34:10.640294689 +0000
@@ -27,7 +27,13 @@
         <tbody class="list">
           <tr>
             <td>
-              <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/RequestOptions.html#RequestOptions(kotlin.Long)">RequestOptions</a>(timeoutInMillis:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>)</code></div>
+              <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/RequestOptions.html#RequestOptions(com.google.firebase.vertexai.type.ApiVersion)">RequestOptions</a>(apiVersion:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ApiVersion.html">ApiVersion</a>)</code></div>
+              <p>Constructor for RequestOptions.</p>
+            </td>
+          </tr>
+          <tr>
+            <td>
+              <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/RequestOptions.html#RequestOptions(kotlin.Long,com.google.firebase.vertexai.type.ApiVersion)">RequestOptions</a>(timeoutInMillis:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>,&nbsp;apiVersion:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ApiVersion.html">ApiVersion</a>)</code></div>
               <p>Constructor for RequestOptions.</p>
             </td>
           </tr>
@@ -36,9 +42,35 @@
     </div>
     <div class="list">
       <h2>Public constructors</h2>
-      <div class="api-item"><a name="RequestOptions-kotlin.Long-"></a><a name="requestoptions"></a>
-        <h3 class="api-name" id="RequestOptions(kotlin.Long)">RequestOptions</h3>
-        <pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/RequestOptions.html#RequestOptions(kotlin.Long)">RequestOptions</a>(timeoutInMillis:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a> = 180.seconds.inWholeMilliseconds)</pre>
+      <div class="api-item"><a name="RequestOptions-com.google.firebase.vertexai.type.ApiVersion-"></a><a name="requestoptions"></a>
+        <h3 class="api-name" id="RequestOptions(com.google.firebase.vertexai.type.ApiVersion)">RequestOptions</h3>
+        <pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/RequestOptions.html#RequestOptions(com.google.firebase.vertexai.type.ApiVersion)">RequestOptions</a>(apiVersion:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ApiVersion.html">ApiVersion</a>)</pre>
+        <p>Constructor for RequestOptions.</p>
+        <div class="devsite-table-wrapper">
+          <table class="responsive">
+            <colgroup>
+              <col width="40%">
+              <col>
+            </colgroup>
+            <thead>
+              <tr>
+                <th colspan="100%">Parameters</th>
+              </tr>
+            </thead>
+            <tbody class="list">
+              <tr>
+                <td><code>apiVersion:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ApiVersion.html">ApiVersion</a></code></td>
+                <td>
+                  <p>the version of the Vertex AI in Firebase API; defaults to <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ApiVersion.Companion.html#V1BETA()">ApiVersion.V1BETA</a></code> if not specified.</p>
+                </td>
+              </tr>
+            </tbody>
+          </table>
+        </div>
+      </div>
+      <div class="api-item"><a name="RequestOptions(kotlin.Long, com.google.firebase.vertexai.type.ApiVersion)"></a><a name="RequestOptions-kotlin.Long-com.google.firebase.vertexai.type.ApiVersion-"></a><a name="requestoptions"></a>
+        <h3 class="api-name" id="RequestOptions(kotlin.Long,com.google.firebase.vertexai.type.ApiVersion)">RequestOptions</h3>
+        <pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/RequestOptions.html#RequestOptions(kotlin.Long,com.google.firebase.vertexai.type.ApiVersion)">RequestOptions</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;timeoutInMillis:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a> = DEFAULT_TIMEOUT_IN_MILLIS,<br>&nbsp;&nbsp;&nbsp;&nbsp;apiVersion:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ApiVersion.html">ApiVersion</a> = DEFAULT_API_VERSION<br>)</pre>
         <p>Constructor for RequestOptions.</p>
         <div class="devsite-table-wrapper">
           <table class="responsive">
@@ -53,11 +85,17 @@
             </thead>
             <tbody class="list">
               <tr>
-                <td><code>timeoutInMillis:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a> = 180.seconds.inWholeMilliseconds</code></td>
+                <td><code>timeoutInMillis:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a> = DEFAULT_TIMEOUT_IN_MILLIS</code></td>
                 <td>
                   <p>the maximum amount of time, in milliseconds, for a request to take, from the first request to first response.</p>
                 </td>
               </tr>
+              <tr>
+                <td><code>apiVersion:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ApiVersion.html">ApiVersion</a> = DEFAULT_API_VERSION</code></td>
+                <td>
+                  <p>the version of the Vertex AI in Firebase API; defaults to <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ApiVersion.Companion.html#V1BETA()">ApiVersion.V1BETA</a></code> if not specified.</p>
+                </td>
+              </tr>
             </tbody>
           </table>
         </div>
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/package-summary.html	2025-01-22 22:36:21.092410517 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/package-summary.html	2025-01-22 22:34:10.638294703 +0000
@@ -32,6 +32,12 @@
         </colgroup>
         <tbody class="list">
           <tr>
+            <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ApiVersion.html">ApiVersion</a></code></td>
+            <td>
+              <p>Versions of the Vertex AI in Firebase server API.</p>
+            </td>
+          </tr>
+          <tr>
             <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a></code></td>
             <td>
               <p>Describes why content was blocked.</p>

@google-oss-bot
Copy link
Contributor

1 Warning
⚠️ Did you forget to add a changelog entry? (Add the 'no-changelog' label to the PR to silence this warning.)

Generated by 🚫 Danger

Copy link
Contributor

github-actions bot commented Jan 20, 2025

Test Results

 22 files   -  42   22 suites   - 42   12s ⏱️ - 1m 0s
119 tests  - 423  119 ✅  - 422  0 💤  - 1  0 ❌ ±0 
238 runs   - 846  238 ✅  - 844  0 💤  - 2  0 ❌ ±0 

Results for commit 98b5c02. ± Comparison against base commit 8e61ec2.

This pull request removes 542 and adds 119 tests. Note that renamed tests count towards both.
com.google.firebase.dataconnect.AnyValueSerializerUnitTest ‑ descriptor should have expected values
com.google.firebase.dataconnect.AnyValueSerializerUnitTest ‑ deserialize() should throw UnsupportedOperationException
com.google.firebase.dataconnect.AnyValueSerializerUnitTest ‑ serialize() should throw UnsupportedOperationException
com.google.firebase.dataconnect.AnyValueUnitTest ‑ constructor(Boolean) creates an object with the expected value
com.google.firebase.dataconnect.AnyValueUnitTest ‑ constructor(Double) creates an object with the expected value (edge cases)
com.google.firebase.dataconnect.AnyValueUnitTest ‑ constructor(Double) creates an object with the expected value (normal cases)
com.google.firebase.dataconnect.AnyValueUnitTest ‑ constructor(List) creates an object with the expected value (edge cases)
com.google.firebase.dataconnect.AnyValueUnitTest ‑ constructor(List) creates an object with the expected value (normal cases)
com.google.firebase.dataconnect.AnyValueUnitTest ‑ constructor(Map) creates an object with the expected value (edge cases)
com.google.firebase.dataconnect.AnyValueUnitTest ‑ constructor(Map) creates an object with the expected value (normal cases)
…
com.google.firebase.vertexai.GenerativeModelTesting ‑ exception thrown when using invalid location
com.google.firebase.vertexai.GenerativeModelTesting ‑ system calling in request
com.google.firebase.vertexai.SchemaTests ‑ basic schema declaration
com.google.firebase.vertexai.SchemaTests ‑ full schema declaration
com.google.firebase.vertexai.StreamingSnapshotTests ‑ citation parsed correctly
com.google.firebase.vertexai.StreamingSnapshotTests ‑ empty content
com.google.firebase.vertexai.StreamingSnapshotTests ‑ http errors
com.google.firebase.vertexai.StreamingSnapshotTests ‑ image rejected
com.google.firebase.vertexai.StreamingSnapshotTests ‑ invalid api key
com.google.firebase.vertexai.StreamingSnapshotTests ‑ invalid json
…

♻️ This comment has been updated with latest results.

@google-oss-bot
Copy link
Contributor

google-oss-bot commented Jan 20, 2025

Size Report 1

Affected Products

  • base

    TypeBase (cf5fe2e)Merge (191299b)Diff
    apk (aggressive)?8.80 kB? (?)
    apk (release)?9.77 kB? (?)
  • firebase-vertexai

    TypeBase (cf5fe2e)Merge (191299b)Diff
    aar?480 kB? (?)
    apk (aggressive)?1.09 MB? (?)
    apk (release)?9.15 MB? (?)

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/O0Fy3TQljI.html

@google-oss-bot
Copy link
Contributor

google-oss-bot commented Jan 22, 2025

Coverage Report 1

Affected Products

No changes between base commit (cf5fe2e) and merge commit (191299b).

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/y65mET7q3f.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants