Add support for blockReasonMessage #6268
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Part of PromptFeedback
Javadoc Changes:--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/PromptFeedback.html 2024-09-17 21:33:32.344423588 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/PromptFeedback.html 2024-09-17 21:31:27.501144661 +0000
@@ -33,6 +33,13 @@
</td>
</tr>
<tr>
+ <td><code>final <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/PromptFeedback.html#blockReasonMessage()">blockReasonMessage</a></code></div>
+ <p>A message describing the reason that content was blocked, 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="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/SafetyRating.html">SafetyRating</a>></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/PromptFeedback.html#safetyRatings()">safetyRatings</a></code></div>
@@ -56,7 +63,7 @@
<tbody class="list">
<tr>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/PromptFeedback.html#PromptFeedback(com.google.firebase.vertexai.type.BlockReason,kotlin.collections.List)">PromptFeedback</a>(<br> <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a> blockReason,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetyRating.html">SafetyRating</a>> safetyRatings<br>)</code></div>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/PromptFeedback.html#PromptFeedback(com.google.firebase.vertexai.type.BlockReason,kotlin.collections.List,kotlin.String)">PromptFeedback</a>(<br> <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a> blockReason,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetyRating.html">SafetyRating</a>> safetyRatings,<br> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> blockReasonMessage<br>)</code></div>
</td>
</tr>
</tbody>
@@ -69,6 +76,11 @@
<pre class="api-signature no-pretty-print">public final <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/PromptFeedback.html#blockReason()">blockReason</a></pre>
<p>The reason that content was blocked, if at all.</p>
</div>
+ <div class="api-item"><a name="getBlockReasonMessage()"></a><a name="setBlockReasonMessage()"></a><a name="getBlockReasonMessage--"></a><a name="setBlockReasonMessage--"></a>
+ <h3 class="api-name" id="blockReasonMessage()">blockReasonMessage</h3>
+ <pre class="api-signature no-pretty-print">public final <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/PromptFeedback.html#blockReasonMessage()">blockReasonMessage</a></pre>
+ <p>A message describing the reason that content was blocked, if any.</p>
+ </div>
<div class="api-item"><a name="getSafetyRatings()"></a><a name="setSafetyRatings()"></a><a name="getSafetyRatings--"></a><a name="setSafetyRatings--"></a>
<h3 class="api-name" id="safetyRatings()">safetyRatings</h3>
<pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetyRating.html">SafetyRating</a>> <a href="/docs/reference/android/com/google/firebase/vertexai/type/PromptFeedback.html#safetyRatings()">safetyRatings</a></pre>
@@ -77,9 +89,9 @@
</div>
<div class="list">
<h2>Public constructors</h2>
- <div class="api-item"><a name="PromptFeedback(com.google.firebase.vertexai.type.BlockReason, kotlin.collections.List)"></a><a name="PromptFeedback-com.google.firebase.vertexai.type.BlockReason-kotlin.collections.List-"></a><a name="promptfeedback"></a>
- <h3 class="api-name" id="PromptFeedback(com.google.firebase.vertexai.type.BlockReason,kotlin.collections.List)">PromptFeedback</h3>
- <pre class="api-signature no-pretty-print">public <a href="/docs/reference/android/com/google/firebase/vertexai/type/PromptFeedback.html#PromptFeedback(com.google.firebase.vertexai.type.BlockReason,kotlin.collections.List)">PromptFeedback</a>(<br> <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a> blockReason,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetyRating.html">SafetyRating</a>> safetyRatings<br>)</pre>
+ <div class="api-item"><a name="PromptFeedback(com.google.firebase.vertexai.type.BlockReason, kotlin.collections.List, kotlin.String)"></a><a name="PromptFeedback-com.google.firebase.vertexai.type.BlockReason-kotlin.collections.List-kotlin.String-"></a><a name="promptfeedback"></a>
+ <h3 class="api-name" id="PromptFeedback(com.google.firebase.vertexai.type.BlockReason,kotlin.collections.List,kotlin.String)">PromptFeedback</h3>
+ <pre class="api-signature no-pretty-print">public <a href="/docs/reference/android/com/google/firebase/vertexai/type/PromptFeedback.html#PromptFeedback(com.google.firebase.vertexai.type.BlockReason,kotlin.collections.List,kotlin.String)">PromptFeedback</a>(<br> <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a> blockReason,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetyRating.html">SafetyRating</a>> safetyRatings,<br> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> blockReasonMessage<br>)</pre>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -104,6 +116,12 @@
<p>A list of relevant <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetyRating.html">SafetyRating</a></code>.</p>
</td>
</tr>
+ <tr>
+ <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> blockReasonMessage</code></td>
+ <td>
+ <p>A message describing the reason that content was blocked, if any.</p>
+ </td>
+ </tr>
</tbody>
</table>
</div>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/PromptFeedback.html 2024-09-17 21:33:32.340423611 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/PromptFeedback.html 2024-09-17 21:31:27.493144707 +0000
@@ -27,7 +27,7 @@
<tbody class="list">
<tr>
<td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PromptFeedback.html#PromptFeedback(com.google.firebase.vertexai.type.BlockReason,kotlin.collections.List)">PromptFeedback</a>(<br> blockReason: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a>?,<br> safetyRatings: <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/SafetyRating.html">SafetyRating</a>><br>)</code></div>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PromptFeedback.html#PromptFeedback(com.google.firebase.vertexai.type.BlockReason,kotlin.collections.List,kotlin.String)">PromptFeedback</a>(<br> blockReason: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a>?,<br> safetyRatings: <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/SafetyRating.html">SafetyRating</a>>,<br> blockReasonMessage: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?<br>)</code></div>
</td>
</tr>
</tbody>
@@ -53,6 +53,13 @@
</td>
</tr>
<tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?</code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PromptFeedback.html#blockReasonMessage()">blockReasonMessage</a></code></div>
+ <p>A message describing the reason that content was blocked, if any.</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/SafetyRating.html">SafetyRating</a>></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PromptFeedback.html#safetyRatings()">safetyRatings</a></code></div>
@@ -64,9 +71,9 @@
</div>
<div class="list">
<h2>Public constructors</h2>
- <div class="api-item"><a name="PromptFeedback(com.google.firebase.vertexai.type.BlockReason, kotlin.collections.List)"></a><a name="PromptFeedback-com.google.firebase.vertexai.type.BlockReason-kotlin.collections.List-"></a><a name="promptfeedback"></a>
- <h3 class="api-name" id="PromptFeedback(com.google.firebase.vertexai.type.BlockReason,kotlin.collections.List)">PromptFeedback</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PromptFeedback.html#PromptFeedback(com.google.firebase.vertexai.type.BlockReason,kotlin.collections.List)">PromptFeedback</a>(<br> blockReason: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a>?,<br> safetyRatings: <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/SafetyRating.html">SafetyRating</a>><br>)</pre>
+ <div class="api-item"><a name="PromptFeedback(com.google.firebase.vertexai.type.BlockReason, kotlin.collections.List, kotlin.String)"></a><a name="PromptFeedback-com.google.firebase.vertexai.type.BlockReason-kotlin.collections.List-kotlin.String-"></a><a name="promptfeedback"></a>
+ <h3 class="api-name" id="PromptFeedback(com.google.firebase.vertexai.type.BlockReason,kotlin.collections.List,kotlin.String)">PromptFeedback</h3>
+ <pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PromptFeedback.html#PromptFeedback(com.google.firebase.vertexai.type.BlockReason,kotlin.collections.List,kotlin.String)">PromptFeedback</a>(<br> blockReason: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a>?,<br> safetyRatings: <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/SafetyRating.html">SafetyRating</a>>,<br> blockReasonMessage: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?<br>)</pre>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -91,6 +98,12 @@
<p>A list of relevant <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetyRating.html">SafetyRating</a></code>.</p>
</td>
</tr>
+ <tr>
+ <td><code>blockReasonMessage: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?</code></td>
+ <td>
+ <p>A message describing the reason that content was blocked, if any.</p>
+ </td>
+ </tr>
</tbody>
</table>
</div>
@@ -103,6 +116,11 @@
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PromptFeedback.html#blockReason()">blockReason</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a>?</pre>
<p>The reason that content was blocked, if at all.</p>
</div>
+ <div class="api-item"><a name="getBlockReasonMessage()"></a><a name="setBlockReasonMessage()"></a><a name="getBlockReasonMessage--"></a><a name="setBlockReasonMessage--"></a>
+ <h3 class="api-name" id="blockReasonMessage()">blockReasonMessage</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PromptFeedback.html#blockReasonMessage()">blockReasonMessage</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?</pre>
+ <p>A message describing the reason that content was blocked, if any.</p>
+ </div>
<div class="api-item"><a name="getSafetyRatings()"></a><a name="setSafetyRatings()"></a><a name="getSafetyRatings--"></a><a name="setSafetyRatings--"></a>
<h3 class="api-name" id="safetyRatings()">safetyRatings</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PromptFeedback.html#safetyRatings()">safetyRatings</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/SafetyRating.html">SafetyRating</a>></pre> |
|
cc @andrewheard |
Generated by 🚫 Danger |
emilypgoogle
approved these changes
Sep 17, 2024
daymxn
approved these changes
Sep 17, 2024
Coverage Report 1Affected ProductsNo changes between base commit (e6b4ace) and merge commit (454f63e).Test Logs |
Unit Test Results 14 files - 74 14 suites - 74 15s ⏱️ - 2m 24s Results for commit 7505ed4. ± Comparison against base commit e6b4ace. This pull request removes 289 and adds 2 tests. Note that renamed tests count towards both. |
Size Report 1Affected Products
Test Logs |
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.
b/367673161