Skip to content

Conversation

davidmotson
Copy link
Collaborator

No description provided.

Copy link
Contributor

github-actions bot commented Feb 7, 2025

Javadoc Changes:
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/BlockReason.html	2025-02-10 20:47:30.506673365 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/BlockReason.html	2025-02-10 20:45:23.282734369 +0000
@@ -48,6 +48,13 @@
           <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/BlockReason.html">BlockReason</a></code></td>
             <td>
+              <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.Companion.html#BLOCKLIST()">BLOCKLIST</a></code></div>
+              <p>Content was blocked for another reason.</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/BlockReason.html">BlockReason</a></code></td>
+            <td>
               <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.Companion.html#OTHER()">OTHER</a></code></div>
               <p>Content was blocked for another reason.</p>
             </td>
@@ -55,6 +62,13 @@
           <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/BlockReason.html">BlockReason</a></code></td>
             <td>
+              <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.Companion.html#PROHIBITED_CONTENT()">PROHIBITED_CONTENT</a></code></div>
+              <p>Candidates blocked due to the terms which are included from the terminology blocklist.</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/BlockReason.html">BlockReason</a></code></td>
+            <td>
               <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.Companion.html#SAFETY()">SAFETY</a></code></div>
               <p>Content was blocked for violating provided <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code>.</p>
             </td>
@@ -83,11 +97,21 @@
     </div>
     <div class="list">
       <h2>Public fields</h2>
+      <div class="api-item"><a name="getBLOCKLIST()"></a><a name="setBLOCKLIST()"></a><a name="getBLOCKLIST--"></a><a name="setBLOCKLIST--"></a>
+        <h3 class="api-name" id="BLOCKLIST()">BLOCKLIST</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/BlockReason.html">BlockReason</a>&nbsp;<a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.Companion.html#BLOCKLIST()">BLOCKLIST</a></pre>
+        <p>Content was blocked for another reason.</p>
+      </div>
       <div class="api-item"><a name="getOTHER()"></a><a name="setOTHER()"></a><a name="getOTHER--"></a><a name="setOTHER--"></a>
         <h3 class="api-name" id="OTHER()">OTHER</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/BlockReason.html">BlockReason</a>&nbsp;<a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.Companion.html#OTHER()">OTHER</a></pre>
         <p>Content was blocked for another reason.</p>
       </div>
+      <div class="api-item"><a name="getPROHIBITED_CONTENT()"></a><a name="setPROHIBITED_CONTENT()"></a><a name="getPROHIBITED_CONTENT--"></a><a name="setPROHIBITED_CONTENT--"></a>
+        <h3 class="api-name" id="PROHIBITED_CONTENT()">PROHIBITED_CONTENT</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/BlockReason.html">BlockReason</a>&nbsp;<a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.Companion.html#PROHIBITED_CONTENT()">PROHIBITED_CONTENT</a></pre>
+        <p>Candidates blocked due to the terms which are included from the terminology blocklist.</p>
+      </div>
       <div class="api-item"><a name="getSAFETY()"></a><a name="setSAFETY()"></a><a name="getSAFETY--"></a><a name="setSAFETY--"></a>
         <h3 class="api-name" id="SAFETY()">SAFETY</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/BlockReason.html">BlockReason</a>&nbsp;<a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.Companion.html#SAFETY()">SAFETY</a></pre>
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/FinishReason.html	2025-02-10 20:47:30.504673365 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/FinishReason.html	2025-02-10 20:45:23.280734372 +0000
@@ -48,6 +48,20 @@
           <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/FinishReason.html">FinishReason</a></code></td>
             <td>
+              <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#BLOCKLIST()">BLOCKLIST</a></code></div>
+              <p>Token generation stopped because the content contains forbidden terms.</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/FinishReason.html">FinishReason</a></code></td>
+            <td>
+              <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#MALFORMED_FUNCTION_CALL()">MALFORMED_FUNCTION_CALL</a></code></div>
+              <p>The function call generated by the model is invalid.</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/FinishReason.html">FinishReason</a></code></td>
+            <td>
               <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#MAX_TOKENS()">MAX_TOKENS</a></code></div>
               <p>Model hit the token limit.</p>
             </td>
@@ -62,6 +76,13 @@
           <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/FinishReason.html">FinishReason</a></code></td>
             <td>
+              <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#PROHIBITED_CONTENT()">PROHIBITED_CONTENT</a></code></div>
+              <p>Token generation stopped for potentially containing prohibited content.</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/FinishReason.html">FinishReason</a></code></td>
+            <td>
               <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#RECITATION()">RECITATION</a></code></div>
               <p>The token generation was stopped because the response was flagged for unauthorized citations.</p>
             </td>
@@ -76,6 +97,13 @@
           <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/FinishReason.html">FinishReason</a></code></td>
             <td>
+              <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#SPII()">SPII</a></code></div>
+              <p>Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).</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/FinishReason.html">FinishReason</a></code></td>
+            <td>
               <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#STOP()">STOP</a></code></div>
               <p>Model finished successfully and stopped.</p>
             </td>
@@ -106,6 +134,16 @@
     </div>
     <div class="list">
       <h2>Public fields</h2>
+      <div class="api-item"><a name="getBLOCKLIST()"></a><a name="setBLOCKLIST()"></a><a name="getBLOCKLIST--"></a><a name="setBLOCKLIST--"></a>
+        <h3 class="api-name" id="BLOCKLIST()">BLOCKLIST</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/FinishReason.html">FinishReason</a>&nbsp;<a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#BLOCKLIST()">BLOCKLIST</a></pre>
+        <p>Token generation stopped because the content contains forbidden terms.</p>
+      </div>
+      <div class="api-item"><a name="getMALFORMED_FUNCTION_CALL()"></a><a name="setMALFORMED_FUNCTION_CALL()"></a><a name="getMALFORMED_FUNCTION_CALL--"></a><a name="setMALFORMED_FUNCTION_CALL--"></a>
+        <h3 class="api-name" id="MALFORMED_FUNCTION_CALL()">MALFORMED_FUNCTION_CALL</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/FinishReason.html">FinishReason</a>&nbsp;<a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#MALFORMED_FUNCTION_CALL()">MALFORMED_FUNCTION_CALL</a></pre>
+        <p>The function call generated by the model is invalid.</p>
+      </div>
       <div class="api-item"><a name="getMAX_TOKENS()"></a><a name="setMAX_TOKENS()"></a><a name="getMAX_TOKENS--"></a><a name="setMAX_TOKENS--"></a>
         <h3 class="api-name" id="MAX_TOKENS()">MAX_TOKENS</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/FinishReason.html">FinishReason</a>&nbsp;<a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#MAX_TOKENS()">MAX_TOKENS</a></pre>
@@ -116,6 +154,11 @@
         <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/FinishReason.html">FinishReason</a>&nbsp;<a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#OTHER()">OTHER</a></pre>
         <p>Model stopped for another reason.</p>
       </div>
+      <div class="api-item"><a name="getPROHIBITED_CONTENT()"></a><a name="setPROHIBITED_CONTENT()"></a><a name="getPROHIBITED_CONTENT--"></a><a name="setPROHIBITED_CONTENT--"></a>
+        <h3 class="api-name" id="PROHIBITED_CONTENT()">PROHIBITED_CONTENT</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/FinishReason.html">FinishReason</a>&nbsp;<a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#PROHIBITED_CONTENT()">PROHIBITED_CONTENT</a></pre>
+        <p>Token generation stopped for potentially containing prohibited content.</p>
+      </div>
       <div class="api-item"><a name="getRECITATION()"></a><a name="setRECITATION()"></a><a name="getRECITATION--"></a><a name="setRECITATION--"></a>
         <h3 class="api-name" id="RECITATION()">RECITATION</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/FinishReason.html">FinishReason</a>&nbsp;<a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#RECITATION()">RECITATION</a></pre>
@@ -126,6 +169,11 @@
         <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/FinishReason.html">FinishReason</a>&nbsp;<a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#SAFETY()">SAFETY</a></pre>
         <p><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code> prevented the model from outputting content.</p>
       </div>
+      <div class="api-item"><a name="getSPII()"></a><a name="setSPII()"></a><a name="getSPII--"></a><a name="setSPII--"></a>
+        <h3 class="api-name" id="SPII()">SPII</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/FinishReason.html">FinishReason</a>&nbsp;<a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#SPII()">SPII</a></pre>
+        <p>Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).</p>
+      </div>
       <div class="api-item"><a name="getSTOP()"></a><a name="setSTOP()"></a><a name="getSTOP--"></a><a name="setSTOP--"></a>
         <h3 class="api-name" id="STOP()">STOP</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/FinishReason.html">FinishReason</a>&nbsp;<a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#STOP()">STOP</a></pre>
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/BlockReason.html	2025-02-10 20:47:30.512673365 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/BlockReason.html	2025-02-10 20:45:23.289734361 +0000
@@ -28,6 +28,13 @@
           <tr>
             <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a></code></td>
             <td>
+              <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.Companion.html#BLOCKLIST()">BLOCKLIST</a></code></div>
+              <p>Content was blocked for another reason.</p>
+            </td>
+          </tr>
+          <tr>
+            <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a></code></td>
+            <td>
               <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.Companion.html#OTHER()">OTHER</a></code></div>
               <p>Content was blocked for another reason.</p>
             </td>
@@ -35,6 +42,13 @@
           <tr>
             <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a></code></td>
             <td>
+              <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.Companion.html#PROHIBITED_CONTENT()">PROHIBITED_CONTENT</a></code></div>
+              <p>Candidates blocked due to the terms which are included from the terminology blocklist.</p>
+            </td>
+          </tr>
+          <tr>
+            <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a></code></td>
+            <td>
               <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.Companion.html#SAFETY()">SAFETY</a></code></div>
               <p>Content was blocked for violating provided <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code>.</p>
             </td>
@@ -78,11 +92,21 @@
     </div>
     <div class="list">
       <h2>Public companion properties</h2>
+      <div class="api-item"><a name="getBLOCKLIST()"></a><a name="setBLOCKLIST()"></a><a name="getBLOCKLIST--"></a><a name="setBLOCKLIST--"></a>
+        <h3 class="api-name" id="BLOCKLIST()">BLOCKLIST</h3>
+        <pre class="api-signature no-pretty-print">val&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.Companion.html#BLOCKLIST()">BLOCKLIST</a>:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a></pre>
+        <p>Content was blocked for another reason.</p>
+      </div>
       <div class="api-item"><a name="getOTHER()"></a><a name="setOTHER()"></a><a name="getOTHER--"></a><a name="setOTHER--"></a>
         <h3 class="api-name" id="OTHER()">OTHER</h3>
         <pre class="api-signature no-pretty-print">val&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.Companion.html#OTHER()">OTHER</a>:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a></pre>
         <p>Content was blocked for another reason.</p>
       </div>
+      <div class="api-item"><a name="getPROHIBITED_CONTENT()"></a><a name="setPROHIBITED_CONTENT()"></a><a name="getPROHIBITED_CONTENT--"></a><a name="setPROHIBITED_CONTENT--"></a>
+        <h3 class="api-name" id="PROHIBITED_CONTENT()">PROHIBITED_CONTENT</h3>
+        <pre class="api-signature no-pretty-print">val&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.Companion.html#PROHIBITED_CONTENT()">PROHIBITED_CONTENT</a>:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a></pre>
+        <p>Candidates blocked due to the terms which are included from the terminology blocklist.</p>
+      </div>
       <div class="api-item"><a name="getSAFETY()"></a><a name="setSAFETY()"></a><a name="getSAFETY--"></a><a name="setSAFETY--"></a>
         <h3 class="api-name" id="SAFETY()">SAFETY</h3>
         <pre class="api-signature no-pretty-print">val&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.Companion.html#SAFETY()">SAFETY</a>:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a></pre>
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/FinishReason.html	2025-02-10 20:47:30.511673365 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/FinishReason.html	2025-02-10 20:45:23.288734362 +0000
@@ -28,6 +28,20 @@
           <tr>
             <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
             <td>
+              <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#BLOCKLIST()">BLOCKLIST</a></code></div>
+              <p>Token generation stopped because the content contains forbidden terms.</p>
+            </td>
+          </tr>
+          <tr>
+            <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
+            <td>
+              <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#MALFORMED_FUNCTION_CALL()">MALFORMED_FUNCTION_CALL</a></code></div>
+              <p>The function call generated by the model is invalid.</p>
+            </td>
+          </tr>
+          <tr>
+            <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
+            <td>
               <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#MAX_TOKENS()">MAX_TOKENS</a></code></div>
               <p>Model hit the token limit.</p>
             </td>
@@ -42,6 +56,13 @@
           <tr>
             <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
             <td>
+              <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#PROHIBITED_CONTENT()">PROHIBITED_CONTENT</a></code></div>
+              <p>Token generation stopped for potentially containing prohibited content.</p>
+            </td>
+          </tr>
+          <tr>
+            <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
+            <td>
               <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#RECITATION()">RECITATION</a></code></div>
               <p>The token generation was stopped because the response was flagged for unauthorized citations.</p>
             </td>
@@ -56,6 +77,13 @@
           <tr>
             <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
             <td>
+              <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#SPII()">SPII</a></code></div>
+              <p>Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).</p>
+            </td>
+          </tr>
+          <tr>
+            <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
+            <td>
               <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#STOP()">STOP</a></code></div>
               <p>Model finished successfully and stopped.</p>
             </td>
@@ -101,6 +129,16 @@
     </div>
     <div class="list">
       <h2>Public companion properties</h2>
+      <div class="api-item"><a name="getBLOCKLIST()"></a><a name="setBLOCKLIST()"></a><a name="getBLOCKLIST--"></a><a name="setBLOCKLIST--"></a>
+        <h3 class="api-name" id="BLOCKLIST()">BLOCKLIST</h3>
+        <pre class="api-signature no-pretty-print">val&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#BLOCKLIST()">BLOCKLIST</a>:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>
+        <p>Token generation stopped because the content contains forbidden terms.</p>
+      </div>
+      <div class="api-item"><a name="getMALFORMED_FUNCTION_CALL()"></a><a name="setMALFORMED_FUNCTION_CALL()"></a><a name="getMALFORMED_FUNCTION_CALL--"></a><a name="setMALFORMED_FUNCTION_CALL--"></a>
+        <h3 class="api-name" id="MALFORMED_FUNCTION_CALL()">MALFORMED_FUNCTION_CALL</h3>
+        <pre class="api-signature no-pretty-print">val&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#MALFORMED_FUNCTION_CALL()">MALFORMED_FUNCTION_CALL</a>:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>
+        <p>The function call generated by the model is invalid.</p>
+      </div>
       <div class="api-item"><a name="getMAX_TOKENS()"></a><a name="setMAX_TOKENS()"></a><a name="getMAX_TOKENS--"></a><a name="setMAX_TOKENS--"></a>
         <h3 class="api-name" id="MAX_TOKENS()">MAX_TOKENS</h3>
         <pre class="api-signature no-pretty-print">val&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#MAX_TOKENS()">MAX_TOKENS</a>:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>
@@ -111,6 +149,11 @@
         <pre class="api-signature no-pretty-print">val&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#OTHER()">OTHER</a>:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>
         <p>Model stopped for another reason.</p>
       </div>
+      <div class="api-item"><a name="getPROHIBITED_CONTENT()"></a><a name="setPROHIBITED_CONTENT()"></a><a name="getPROHIBITED_CONTENT--"></a><a name="setPROHIBITED_CONTENT--"></a>
+        <h3 class="api-name" id="PROHIBITED_CONTENT()">PROHIBITED_CONTENT</h3>
+        <pre class="api-signature no-pretty-print">val&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#PROHIBITED_CONTENT()">PROHIBITED_CONTENT</a>:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>
+        <p>Token generation stopped for potentially containing prohibited content.</p>
+      </div>
       <div class="api-item"><a name="getRECITATION()"></a><a name="setRECITATION()"></a><a name="getRECITATION--"></a><a name="setRECITATION--"></a>
         <h3 class="api-name" id="RECITATION()">RECITATION</h3>
         <pre class="api-signature no-pretty-print">val&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#RECITATION()">RECITATION</a>:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>
@@ -121,6 +164,11 @@
         <pre class="api-signature no-pretty-print">val&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#SAFETY()">SAFETY</a>:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>
         <p><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code> prevented the model from outputting content.</p>
       </div>
+      <div class="api-item"><a name="getSPII()"></a><a name="setSPII()"></a><a name="getSPII--"></a><a name="setSPII--"></a>
+        <h3 class="api-name" id="SPII()">SPII</h3>
+        <pre class="api-signature no-pretty-print">val&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#SPII()">SPII</a>:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>
+        <p>Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).</p>
+      </div>
       <div class="api-item"><a name="getSTOP()"></a><a name="setSTOP()"></a><a name="getSTOP--"></a><a name="setSTOP--"></a>
         <h3 class="api-name" id="STOP()">STOP</h3>
         <pre class="api-signature no-pretty-print">val&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#STOP()">STOP</a>:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>

@google-oss-bot
Copy link
Contributor

google-oss-bot commented Feb 7, 2025

@google-oss-bot
Copy link
Contributor

The public api surface has changed for the subproject firebase-vertexai:
error: Added field com.google.firebase.vertexai.type.BlockReason.BLOCKLIST [AddedField]
error: Added field com.google.firebase.vertexai.type.BlockReason.IMAGE_SAFETY [AddedField]
error: Added field com.google.firebase.vertexai.type.BlockReason.MODEL_ARMOR [AddedField]
error: Added field com.google.firebase.vertexai.type.BlockReason.PROHIBITED_CONTENT [AddedField]
error: Added field com.google.firebase.vertexai.type.FinishReason.BLOCKLIST [AddedField]
error: Added field com.google.firebase.vertexai.type.FinishReason.IMAGE_SAFETY [AddedField]
error: Added field com.google.firebase.vertexai.type.FinishReason.MALFORMED_FUNCTION_CALL [AddedField]
error: Added field com.google.firebase.vertexai.type.FinishReason.MODEL_ARMOR [AddedField]
error: Added field com.google.firebase.vertexai.type.FinishReason.PROHIBITED_CONTENT [AddedField]
error: Added field com.google.firebase.vertexai.type.FinishReason.SPII [AddedField]

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.

Copy link
Contributor

github-actions bot commented Feb 7, 2025

Test Results

 20 files  ±0   20 suites  ±0   12s ⏱️ -1s
114 tests ±0  114 ✅ ±0  0 💤 ±0  0 ❌ ±0 
228 runs  ±0  228 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 3df0343. ± Comparison against base commit d9baf9e.

♻️ This comment has been updated with latest results.

@google-oss-bot
Copy link
Contributor

google-oss-bot commented Feb 7, 2025

Size Report 1

Affected Products

  • firebase-vertexai

    TypeBase (d9baf9e)Merge (5c65b01)Diff
    aar508 kB509 kB+913 B (+0.2%)
    apk (aggressive)1.37 MB1.37 MB+732 B (+0.1%)
    apk (release)9.31 MB9.31 MB+892 B (+0.0%)

Test Logs

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

@google-oss-bot
Copy link
Contributor

The public api surface has changed for the subproject firebase-vertexai:
error: Added field com.google.firebase.vertexai.type.BlockReason.BLOCKLIST [AddedField]
error: Added field com.google.firebase.vertexai.type.BlockReason.PROHIBITED_CONTENT [AddedField]
error: Added field com.google.firebase.vertexai.type.FinishReason.BLOCKLIST [AddedField]
error: Added field com.google.firebase.vertexai.type.FinishReason.MALFORMED_FUNCTION_CALL [AddedField]
error: Added field com.google.firebase.vertexai.type.FinishReason.PROHIBITED_CONTENT [AddedField]
error: Added field com.google.firebase.vertexai.type.FinishReason.SPII [AddedField]

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
@google-oss-bot
Copy link
Contributor

The public api surface has changed for the subproject firebase-vertexai:
error: Added field com.google.firebase.vertexai.type.BlockReason.BLOCKLIST [AddedField]
error: Added field com.google.firebase.vertexai.type.BlockReason.PROHIBITED_CONTENT [AddedField]
error: Added field com.google.firebase.vertexai.type.FinishReason.BLOCKLIST [AddedField]
error: Added field com.google.firebase.vertexai.type.FinishReason.MALFORMED_FUNCTION_CALL [AddedField]
error: Added field com.google.firebase.vertexai.type.FinishReason.PROHIBITED_CONTENT [AddedField]
error: Added field com.google.firebase.vertexai.type.FinishReason.SPII [AddedField]

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.

@davidmotson davidmotson requested a review from rlazo February 10, 2025 18:49
@davidmotson davidmotson enabled auto-merge (squash) February 10, 2025 20:40
@davidmotson davidmotson merged commit 301d37a into main Feb 10, 2025
30 checks passed
@davidmotson davidmotson deleted the davidmotson.update_vertex_enums branch February 10, 2025 20:49
@firebase firebase locked and limited conversation to collaborators Mar 13, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants