Migrate away from enums #6340
Merged
Migrate away from enums #6340
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
Javadoc Changes:--- /home/runner/diff/original/firebase-kotlindoc/android/client/firebase-vertexai/_toc.yaml 2024-10-04 17:26:34.409120307 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/client/firebase-vertexai/_toc.yaml 2024-10-04 17:24:16.322268710 +0000
@@ -40,6 +40,8 @@
- title: "Classes"
section:
+ - title: "BlockReason"
+ path: "/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html"
- title: "Candidate"
path: "/docs/reference/android/com/google/firebase/vertexai/type/Candidate.html"
- title: "Citation"
@@ -56,6 +58,8 @@
path: "/docs/reference/android/com/google/firebase/vertexai/type/CountTokensResponse.html"
- title: "FileDataPart"
path: "/docs/reference/android/com/google/firebase/vertexai/type/FileDataPart.html"
+ - title: "FinishReason"
+ path: "/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html"
- title: "FunctionCall"
path: "/docs/reference/android/com/google/firebase/vertexai/type/FunctionCall.html"
- title: "FunctionCallPart"
@@ -76,6 +80,16 @@
path: "/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.Builder.html"
- title: "GenerationConfigKt"
path: "/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfigKt.html"
+ - title: "HarmBlockMethod"
+ path: "/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html"
+ - title: "HarmBlockThreshold"
+ path: "/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html"
+ - title: "HarmCategory"
+ path: "/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html"
+ - title: "HarmProbability"
+ path: "/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html"
+ - title: "HarmSeverity"
+ path: "/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html"
- title: "ImagePart"
path: "/docs/reference/android/com/google/firebase/vertexai/type/ImagePart.html"
- title: "InlineDataPart"
@@ -105,24 +119,6 @@
- title: "UsageMetadata"
path: "/docs/reference/android/com/google/firebase/vertexai/type/UsageMetadata.html"
- - title: "Enums"
-
- section:
- - title: "BlockReason"
- path: "/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html"
- - title: "FinishReason"
- path: "/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html"
- - title: "HarmBlockMethod"
- path: "/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html"
- - title: "HarmBlockThreshold"
- path: "/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html"
- - title: "HarmCategory"
- path: "/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html"
- - title: "HarmProbability"
- path: "/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html"
- - title: "HarmSeverity"
- path: "/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html"
-
- title: "Exceptions"
section:--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/BlockReason.Companion.html 1970-01-01 00:00:00.000000000 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/BlockReason.Companion.html 2024-10-04 17:24:16.316268629 +0000
@@ -0,0 +1,16 @@
+<html devsite="true">
+ <head>
+ <title>BlockReason.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>BlockReason.Companion</h1>
+ <p>
+ <pre>public static class <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.Companion.html">BlockReason.Companion</a></pre>
+ </p>
+ <hr>
+ </body>
+</html>
+--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/BlockReason.html 2024-10-04 17:26:34.407120280 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/BlockReason.html 2024-10-04 17:24:16.320268683 +0000
@@ -8,29 +8,31 @@
<div id="metadata-info-block"></div>
<h1>BlockReason</h1>
<p>
- <pre>public enum <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a> extends <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a></pre>
+ <pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a></pre>
</p>
+ <hr>
+ <p>Describes why content was blocked.</p>
+ <h2>Summary</h2>
<div class="devsite-table-wrapper">
- <table class="jd-inheritance-table">
- <tbody>
- <tr>
- <td colspan="3"><a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">java.lang.Object</a></td>
- </tr>
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
<tr>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="2"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">kotlin.Enum</a></td>
+ <th colspan="100%"><h3>Nested types</h3></th>
</tr>
+ </thead>
+ <tbody class="list">
<tr>
- <td> </td>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="1"><a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html">com.google.firebase.vertexai.type.BlockReason</a></td>
+ <td>
+ <div><code>public static class <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.Companion.html">BlockReason.Companion</a></code></div>
+ </td>
</tr>
</tbody>
</table>
</div>
- <hr>
- <p>Describes why content was blocked.</p>
- <h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -39,111 +41,70 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Enum Values</h3></th>
+ <th colspan="100%"><h3>Public fields</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html#OTHER">OTHER</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/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>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html#SAFETY">SAFETY</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/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>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html#UNKNOWN">UNKNOWN</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.Companion.html#UNKNOWN()">UNKNOWN</a></code></div>
<p>A new and not yet supported value.</p>
</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 methods</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="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a></code></td>
+ <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/vertexai/type/BlockReason.html#valueOf(kotlin.String)">valueOf</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> value)</code></div>
- <p>Returns the enum constant of this type with the specified name.</p>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html#name()">name</a></code></div>
</td>
</tr>
<tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> BlockReason[]</code></td>
+ <td><code>final int</code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html#values()">values</a>()</code></div>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html#ordinal()">ordinal</a></code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="list">
- <h2>Enum Values</h2>
- <div class="api-item">
- <h3 class="api-name" id="OTHER">OTHER</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html#OTHER">BlockReason.OTHER</a></pre>
+ <h2>Public fields</h2>
+ <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 static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a> <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">
- <h3 class="api-name" id="SAFETY">SAFETY</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html#SAFETY">BlockReason.SAFETY</a></pre>
+ <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 static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.Companion.html#SAFETY()">SAFETY</a></pre>
<p>Content was blocked for violating provided <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code>.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="UNKNOWN">UNKNOWN</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html#UNKNOWN">BlockReason.UNKNOWN</a></pre>
+ <div class="api-item"><a name="getUNKNOWN()"></a><a name="setUNKNOWN()"></a><a name="getUNKNOWN--"></a><a name="setUNKNOWN--"></a>
+ <h3 class="api-name" id="UNKNOWN()">UNKNOWN</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.Companion.html#UNKNOWN()">UNKNOWN</a></pre>
<p>A new and not yet supported value.</p>
</div>
- </div>
- <div class="list">
- <h2>Public methods</h2>
- <div class="api-item"><a name="valueOf-kotlin.String-"></a><a name="valueof"></a>
- <h3 class="api-name" id="valueOf(kotlin.String)">valueOf</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html#valueOf(kotlin.String)">valueOf</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> value)</pre>
- <p>Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Throws</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html">kotlin.IllegalArgumentException</a> kotlin.IllegalArgumentException</code></td>
- <td>
- <p>if this enum type has no constant with the specified name</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="values--"></a><a name="values"></a>
- <h3 class="api-name" id="values()">values</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> BlockReason[] <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html#values()">values</a>()</pre>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
- <p>This method may be used to iterate over the constants.</p>
+ <div class="api-item"><a name="getName()"></a><a name="setName()"></a><a name="getName--"></a><a name="setName--"></a>
+ <h3 class="api-name" id="name()">name</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/vertexai/type/BlockReason.html#name()">name</a></pre>
+ </div>
+ <div class="api-item"><a name="getOrdinal()"></a><a name="setOrdinal()"></a><a name="getOrdinal--"></a><a name="setOrdinal--"></a>
+ <h3 class="api-name" id="ordinal()">ordinal</h3>
+ <pre class="api-signature no-pretty-print">public final int <a href="/docs/reference/android/com/google/firebase/vertexai/type/BlockReason.html#ordinal()">ordinal</a></pre>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/FinishReason.Companion.html 1970-01-01 00:00:00.000000000 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/FinishReason.Companion.html 2024-10-04 17:24:16.320268683 +0000
@@ -0,0 +1,16 @@
+<html devsite="true">
+ <head>
+ <title>FinishReason.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>FinishReason.Companion</h1>
+ <p>
+ <pre>public static class <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html">FinishReason.Companion</a></pre>
+ </p>
+ <hr>
+ </body>
+</html>
+--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/FinishReason.html 2024-10-04 17:26:34.406120266 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/FinishReason.html 2024-10-04 17:24:16.318268656 +0000
@@ -8,29 +8,31 @@
<div id="metadata-info-block"></div>
<h1>FinishReason</h1>
<p>
- <pre>public enum <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> extends <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a></pre>
+ <pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>
</p>
+ <hr>
+ <p>The reason for content finishing.</p>
+ <h2>Summary</h2>
<div class="devsite-table-wrapper">
- <table class="jd-inheritance-table">
- <tbody>
- <tr>
- <td colspan="3"><a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">java.lang.Object</a></td>
- </tr>
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
<tr>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="2"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">kotlin.Enum</a></td>
+ <th colspan="100%"><h3>Nested types</h3></th>
</tr>
+ </thead>
+ <tbody class="list">
<tr>
- <td> </td>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="1"><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">com.google.firebase.vertexai.type.FinishReason</a></td>
+ <td>
+ <div><code>public static class <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html">FinishReason.Companion</a></code></div>
+ </td>
</tr>
</tbody>
</table>
</div>
- <hr>
- <p>The reason for content finishing.</p>
- <h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -39,144 +41,106 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Enum Values</h3></th>
+ <th colspan="100%"><h3>Public fields</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html#MAX_TOKENS">MAX_TOKENS</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/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>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html#OTHER">OTHER</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#OTHER()">OTHER</a></code></div>
<p>Model stopped for another reason.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html#RECITATION">RECITATION</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/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>Model began looping.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html#SAFETY">SAFETY</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#SAFETY()">SAFETY</a></code></div>
<p><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code> prevented the model from outputting content.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html#STOP">STOP</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/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>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html#UNKNOWN">UNKNOWN</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#UNKNOWN()">UNKNOWN</a></code></div>
<p>A new and not yet supported value.</p>
</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 methods</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="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
+ <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/vertexai/type/FinishReason.html#valueOf(kotlin.String)">valueOf</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> value)</code></div>
- <p>Returns the enum constant of this type with the specified name.</p>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html#name()">name</a></code></div>
</td>
</tr>
<tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> FinishReason[]</code></td>
+ <td><code>final int</code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html#values()">values</a>()</code></div>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html#ordinal()">ordinal</a></code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="list">
- <h2>Enum Values</h2>
- <div class="api-item">
- <h3 class="api-name" id="MAX_TOKENS">MAX_TOKENS</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html#MAX_TOKENS">FinishReason.MAX_TOKENS</a></pre>
+ <h2>Public fields</h2>
+ <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 static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#MAX_TOKENS()">MAX_TOKENS</a></pre>
<p>Model hit the token limit.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="OTHER">OTHER</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html#OTHER">FinishReason.OTHER</a></pre>
+ <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 static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <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">
- <h3 class="api-name" id="RECITATION">RECITATION</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html#RECITATION">FinishReason.RECITATION</a></pre>
+ <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 static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#RECITATION()">RECITATION</a></pre>
<p>Model began looping.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="SAFETY">SAFETY</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html#SAFETY">FinishReason.SAFETY</a></pre>
+ <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 static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <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">
- <h3 class="api-name" id="STOP">STOP</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html#STOP">FinishReason.STOP</a></pre>
+ <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 static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#STOP()">STOP</a></pre>
<p>Model finished successfully and stopped.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="UNKNOWN">UNKNOWN</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html#UNKNOWN">FinishReason.UNKNOWN</a></pre>
+ <div class="api-item"><a name="getUNKNOWN()"></a><a name="setUNKNOWN()"></a><a name="getUNKNOWN--"></a><a name="setUNKNOWN--"></a>
+ <h3 class="api-name" id="UNKNOWN()">UNKNOWN</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#UNKNOWN()">UNKNOWN</a></pre>
<p>A new and not yet supported value.</p>
</div>
- </div>
- <div class="list">
- <h2>Public methods</h2>
- <div class="api-item"><a name="valueOf-kotlin.String-"></a><a name="valueof"></a>
- <h3 class="api-name" id="valueOf(kotlin.String)">valueOf</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html#valueOf(kotlin.String)">valueOf</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> value)</pre>
- <p>Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Throws</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html">kotlin.IllegalArgumentException</a> kotlin.IllegalArgumentException</code></td>
- <td>
- <p>if this enum type has no constant with the specified name</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="values--"></a><a name="values"></a>
- <h3 class="api-name" id="values()">values</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> FinishReason[] <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html#values()">values</a>()</pre>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
- <p>This method may be used to iterate over the constants.</p>
+ <div class="api-item"><a name="getName()"></a><a name="setName()"></a><a name="getName--"></a><a name="setName--"></a>
+ <h3 class="api-name" id="name()">name</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/vertexai/type/FinishReason.html#name()">name</a></pre>
+ </div>
+ <div class="api-item"><a name="getOrdinal()"></a><a name="setOrdinal()"></a><a name="getOrdinal--"></a><a name="setOrdinal--"></a>
+ <h3 class="api-name" id="ordinal()">ordinal</h3>
+ <pre class="api-signature no-pretty-print">public final int <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html#ordinal()">ordinal</a></pre>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/HarmBlockMethod.Companion.html 1970-01-01 00:00:00.000000000 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/HarmBlockMethod.Companion.html 2024-10-04 17:24:16.321268696 +0000
@@ -0,0 +1,16 @@
+<html devsite="true">
+ <head>
+ <title>HarmBlockMethod.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>HarmBlockMethod.Companion</h1>
+ <p>
+ <pre>public static class <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.Companion.html">HarmBlockMethod.Companion</a></pre>
+ </p>
+ <hr>
+ </body>
+</html>
+--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/HarmBlockMethod.html 2024-10-04 17:26:34.407120280 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/HarmBlockMethod.html 2024-10-04 17:24:16.320268683 +0000
@@ -8,26 +8,8 @@
<div id="metadata-info-block"></div>
<h1>HarmBlockMethod</h1>
<p>
- <pre>public enum <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a> extends <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a></pre>
+ <pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a></pre>
</p>
- <div class="devsite-table-wrapper">
- <table class="jd-inheritance-table">
- <tbody>
- <tr>
- <td colspan="3"><a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">java.lang.Object</a></td>
- </tr>
- <tr>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="2"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">kotlin.Enum</a></td>
- </tr>
- <tr>
- <td> </td>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="1"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html">com.google.firebase.vertexai.type.HarmBlockMethod</a></td>
- </tr>
- </tbody>
- </table>
- </div>
<hr>
<p>Specifies how the block method computes the score that will be compared against the <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code> in <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code>.</p>
<h2>Summary</h2>
@@ -39,20 +21,13 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Enum Values</h3></th>
+ <th colspan="100%"><h3>Nested types</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html#PROBABILITY">PROBABILITY</a></code></td>
- <td>
- <p>The harm block method uses the probability score.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html#SEVERITY">SEVERITY</a></code></td>
<td>
- <p>The harm block method uses both probability and severity scores.</p>
+ <div><code>public static class <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.Companion.html">HarmBlockMethod.Companion</a></code></div>
</td>
</tr>
</tbody>
@@ -66,73 +41,48 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Public methods</h3></th>
+ <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="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a></code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html#valueOf(kotlin.String)">valueOf</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> value)</code></div>
- <p>Returns the enum constant of this type with the specified name.</p>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.Companion.html#PROBABILITY()">PROBABILITY</a></code></div>
+ <p>The harm block method uses the probability score.</p>
</td>
</tr>
<tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> HarmBlockMethod[]</code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a></code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html#values()">values</a>()</code></div>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.Companion.html#SEVERITY()">SEVERITY</a></code></div>
+ <p>The harm block method uses both probability and severity scores.</p>
</td>
</tr>
- </tbody>
- </table>
- </div>
- <div class="list">
- <h2>Enum Values</h2>
- <div class="api-item">
- <h3 class="api-name" id="PROBABILITY">PROBABILITY</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html#PROBABILITY">HarmBlockMethod.PROBABILITY</a></pre>
- <p>The harm block method uses the probability score. See <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code>.</p>
- </div>
- <div class="api-item">
- <h3 class="api-name" id="SEVERITY">SEVERITY</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html#SEVERITY">HarmBlockMethod.SEVERITY</a></pre>
- <p>The harm block method uses both probability and severity scores. See <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></code> and <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code>.</p>
- </div>
- </div>
- <div class="list">
- <h2>Public methods</h2>
- <div class="api-item"><a name="valueOf-kotlin.String-"></a><a name="valueof"></a>
- <h3 class="api-name" id="valueOf(kotlin.String)">valueOf</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html#valueOf(kotlin.String)">valueOf</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> value)</pre>
- <p>Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Throws</th>
- </tr>
- </thead>
- <tbody class="list">
<tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html">kotlin.IllegalArgumentException</a> kotlin.IllegalArgumentException</code></td>
+ <td><code>final int</code></td>
<td>
- <p>if this enum type has no constant with the specified name</p>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html#ordinal()">ordinal</a></code></div>
</td>
</tr>
</tbody>
</table>
</div>
+ <div class="list">
+ <h2>Public fields</h2>
+ <div class="api-item"><a name="getPROBABILITY()"></a><a name="setPROBABILITY()"></a><a name="getPROBABILITY--"></a><a name="setPROBABILITY--"></a>
+ <h3 class="api-name" id="PROBABILITY()">PROBABILITY</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.Companion.html#PROBABILITY()">PROBABILITY</a></pre>
+ <p>The harm block method uses the probability score. See <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code>.</p>
+ </div>
+ <div class="api-item"><a name="getSEVERITY()"></a><a name="setSEVERITY()"></a><a name="getSEVERITY--"></a><a name="setSEVERITY--"></a>
+ <h3 class="api-name" id="SEVERITY()">SEVERITY</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.Companion.html#SEVERITY()">SEVERITY</a></pre>
+ <p>The harm block method uses both probability and severity scores. See <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></code> and <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code>.</p>
</div>
- <div class="api-item"><a name="values--"></a><a name="values"></a>
- <h3 class="api-name" id="values()">values</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> HarmBlockMethod[] <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html#values()">values</a>()</pre>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
- <p>This method may be used to iterate over the constants.</p>
+ <div class="api-item"><a name="getOrdinal()"></a><a name="setOrdinal()"></a><a name="getOrdinal--"></a><a name="setOrdinal--"></a>
+ <h3 class="api-name" id="ordinal()">ordinal</h3>
+ <pre class="api-signature no-pretty-print">public final int <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html#ordinal()">ordinal</a></pre>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/HarmBlockThreshold.Companion.html 1970-01-01 00:00:00.000000000 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/HarmBlockThreshold.Companion.html 2024-10-04 17:24:16.321268696 +0000
@@ -0,0 +1,16 @@
+<html devsite="true">
+ <head>
+ <title>HarmBlockThreshold.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>HarmBlockThreshold.Companion</h1>
+ <p>
+ <pre>public static class <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.Companion.html">HarmBlockThreshold.Companion</a></pre>
+ </p>
+ <hr>
+ </body>
+</html>
+--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html 2024-10-04 17:26:34.407120280 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html 2024-10-04 17:24:16.319268669 +0000
@@ -8,29 +8,31 @@
<div id="metadata-info-block"></div>
<h1>HarmBlockThreshold</h1>
<p>
- <pre>public enum <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a> extends <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a></pre>
+ <pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></pre>
</p>
+ <hr>
+ <p>Represents the threshold for a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code> to be allowed by <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code>.</p>
+ <h2>Summary</h2>
<div class="devsite-table-wrapper">
- <table class="jd-inheritance-table">
- <tbody>
- <tr>
- <td colspan="3"><a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">java.lang.Object</a></td>
- </tr>
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
<tr>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="2"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">kotlin.Enum</a></td>
+ <th colspan="100%"><h3>Nested types</h3></th>
</tr>
+ </thead>
+ <tbody class="list">
<tr>
- <td> </td>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="1"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">com.google.firebase.vertexai.type.HarmBlockThreshold</a></td>
+ <td>
+ <div><code>public static class <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.Companion.html">HarmBlockThreshold.Companion</a></code></div>
+ </td>
</tr>
</tbody>
</table>
</div>
- <hr>
- <p>Represents the threshold for a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code> to be allowed by <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code>.</p>
- <h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -39,122 +41,72 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Enum Values</h3></th>
+ <th colspan="100%"><h3>Public fields</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html#LOW_AND_ABOVE">LOW_AND_ABOVE</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.Companion.html#LOW_AND_ABOVE()">LOW_AND_ABOVE</a></code></div>
<p>Content with negligible harm is allowed.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html#MEDIUM_AND_ABOVE">MEDIUM_AND_ABOVE</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.Companion.html#MEDIUM_AND_ABOVE()">MEDIUM_AND_ABOVE</a></code></div>
<p>Content with negligible to low harm is allowed.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html#NONE">NONE</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.Companion.html#NONE()">NONE</a></code></div>
<p>All content is allowed regardless of harm.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html#ONLY_HIGH">ONLY_HIGH</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.Companion.html#ONLY_HIGH()">ONLY_HIGH</a></code></div>
<p>Content with negligible to medium harm is allowed.</p>
</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 methods</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="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html#valueOf(kotlin.String)">valueOf</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> value)</code></div>
- <p>Returns the enum constant of this type with the specified name.</p>
- </td>
- </tr>
- <tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> HarmBlockThreshold[]</code></td>
+ <td><code>final int</code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html#values()">values</a>()</code></div>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html#ordinal()">ordinal</a></code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="list">
- <h2>Enum Values</h2>
- <div class="api-item">
- <h3 class="api-name" id="LOW_AND_ABOVE">LOW_AND_ABOVE</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html#LOW_AND_ABOVE">HarmBlockThreshold.LOW_AND_ABOVE</a></pre>
+ <h2>Public fields</h2>
+ <div class="api-item"><a name="getLOW_AND_ABOVE()"></a><a name="setLOW_AND_ABOVE()"></a><a name="getLOW_AND_ABOVE--"></a><a name="setLOW_AND_ABOVE--"></a>
+ <h3 class="api-name" id="LOW_AND_ABOVE()">LOW_AND_ABOVE</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.Companion.html#LOW_AND_ABOVE()">LOW_AND_ABOVE</a></pre>
<p>Content with negligible harm is allowed.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="MEDIUM_AND_ABOVE">MEDIUM_AND_ABOVE</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html#MEDIUM_AND_ABOVE">HarmBlockThreshold.MEDIUM_AND_ABOVE</a></pre>
+ <div class="api-item"><a name="getMEDIUM_AND_ABOVE()"></a><a name="setMEDIUM_AND_ABOVE()"></a><a name="getMEDIUM_AND_ABOVE--"></a><a name="setMEDIUM_AND_ABOVE--"></a>
+ <h3 class="api-name" id="MEDIUM_AND_ABOVE()">MEDIUM_AND_ABOVE</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.Companion.html#MEDIUM_AND_ABOVE()">MEDIUM_AND_ABOVE</a></pre>
<p>Content with negligible to low harm is allowed.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="NONE">NONE</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html#NONE">HarmBlockThreshold.NONE</a></pre>
+ <div class="api-item"><a name="getNONE()"></a><a name="setNONE()"></a><a name="getNONE--"></a><a name="setNONE--"></a>
+ <h3 class="api-name" id="NONE()">NONE</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.Companion.html#NONE()">NONE</a></pre>
<p>All content is allowed regardless of harm.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="ONLY_HIGH">ONLY_HIGH</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html#ONLY_HIGH">HarmBlockThreshold.ONLY_HIGH</a></pre>
+ <div class="api-item"><a name="getONLY_HIGH()"></a><a name="setONLY_HIGH()"></a><a name="getONLY_HIGH--"></a><a name="setONLY_HIGH--"></a>
+ <h3 class="api-name" id="ONLY_HIGH()">ONLY_HIGH</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.Companion.html#ONLY_HIGH()">ONLY_HIGH</a></pre>
<p>Content with negligible to medium harm is allowed.</p>
</div>
- </div>
- <div class="list">
- <h2>Public methods</h2>
- <div class="api-item"><a name="valueOf-kotlin.String-"></a><a name="valueof"></a>
- <h3 class="api-name" id="valueOf(kotlin.String)">valueOf</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html#valueOf(kotlin.String)">valueOf</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> value)</pre>
- <p>Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Throws</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html">kotlin.IllegalArgumentException</a> kotlin.IllegalArgumentException</code></td>
- <td>
- <p>if this enum type has no constant with the specified name</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="values--"></a><a name="values"></a>
- <h3 class="api-name" id="values()">values</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> HarmBlockThreshold[] <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html#values()">values</a>()</pre>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
- <p>This method may be used to iterate over the constants.</p>
+ <div class="api-item"><a name="getOrdinal()"></a><a name="setOrdinal()"></a><a name="getOrdinal--"></a><a name="setOrdinal--"></a>
+ <h3 class="api-name" id="ordinal()">ordinal</h3>
+ <pre class="api-signature no-pretty-print">public final int <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html#ordinal()">ordinal</a></pre>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/HarmCategory.Companion.html 1970-01-01 00:00:00.000000000 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/HarmCategory.Companion.html 2024-10-04 17:24:16.319268669 +0000
@@ -0,0 +1,16 @@
+<html devsite="true">
+ <head>
+ <title>HarmCategory.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>HarmCategory.Companion</h1>
+ <p>
+ <pre>public static class <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.Companion.html">HarmCategory.Companion</a></pre>
+ </p>
+ <hr>
+ </body>
+</html>
+--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/HarmCategory.html 2024-10-04 17:26:34.405120253 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/HarmCategory.html 2024-10-04 17:24:16.317268642 +0000
@@ -8,29 +8,31 @@
<div id="metadata-info-block"></div>
<h1>HarmCategory</h1>
<p>
- <pre>public enum <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a> extends <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a></pre>
+ <pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></pre>
</p>
+ <hr>
+ <p>Category for a given harm rating.</p>
+ <h2>Summary</h2>
<div class="devsite-table-wrapper">
- <table class="jd-inheritance-table">
- <tbody>
- <tr>
- <td colspan="3"><a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">java.lang.Object</a></td>
- </tr>
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
<tr>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="2"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">kotlin.Enum</a></td>
+ <th colspan="100%"><h3>Nested types</h3></th>
</tr>
+ </thead>
+ <tbody class="list">
<tr>
- <td> </td>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="1"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">com.google.firebase.vertexai.type.HarmCategory</a></td>
+ <td>
+ <div><code>public static class <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.Companion.html">HarmCategory.Companion</a></code></div>
+ </td>
</tr>
</tbody>
</table>
</div>
- <hr>
- <p>Category for a given harm rating.</p>
- <h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -39,133 +41,84 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Enum Values</h3></th>
+ <th colspan="100%"><h3>Public fields</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html#DANGEROUS_CONTENT">DANGEROUS_CONTENT</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.Companion.html#DANGEROUS_CONTENT()">DANGEROUS_CONTENT</a></code></div>
<p>Dangerous content.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html#HARASSMENT">HARASSMENT</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.Companion.html#HARASSMENT()">HARASSMENT</a></code></div>
<p>Harassment content.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html#HATE_SPEECH">HATE_SPEECH</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.Companion.html#HATE_SPEECH()">HATE_SPEECH</a></code></div>
<p>Hate speech and content.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html#SEXUALLY_EXPLICIT">SEXUALLY_EXPLICIT</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.Companion.html#SEXUALLY_EXPLICIT()">SEXUALLY_EXPLICIT</a></code></div>
<p>Sexually explicit content.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html#UNKNOWN">UNKNOWN</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.Companion.html#UNKNOWN()">UNKNOWN</a></code></div>
<p>A new and not yet supported value.</p>
</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 methods</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="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html#valueOf(kotlin.String)">valueOf</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> value)</code></div>
- <p>Returns the enum constant of this type with the specified name.</p>
- </td>
- </tr>
- <tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> HarmCategory[]</code></td>
+ <td><code>final int</code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html#values()">values</a>()</code></div>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html#ordinal()">ordinal</a></code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="list">
- <h2>Enum Values</h2>
- <div class="api-item">
- <h3 class="api-name" id="DANGEROUS_CONTENT">DANGEROUS_CONTENT</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html#DANGEROUS_CONTENT">HarmCategory.DANGEROUS_CONTENT</a></pre>
+ <h2>Public fields</h2>
+ <div class="api-item"><a name="getDANGEROUS_CONTENT()"></a><a name="setDANGEROUS_CONTENT()"></a><a name="getDANGEROUS_CONTENT--"></a><a name="setDANGEROUS_CONTENT--"></a>
+ <h3 class="api-name" id="DANGEROUS_CONTENT()">DANGEROUS_CONTENT</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.Companion.html#DANGEROUS_CONTENT()">DANGEROUS_CONTENT</a></pre>
<p>Dangerous content.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="HARASSMENT">HARASSMENT</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html#HARASSMENT">HarmCategory.HARASSMENT</a></pre>
+ <div class="api-item"><a name="getHARASSMENT()"></a><a name="setHARASSMENT()"></a><a name="getHARASSMENT--"></a><a name="setHARASSMENT--"></a>
+ <h3 class="api-name" id="HARASSMENT()">HARASSMENT</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.Companion.html#HARASSMENT()">HARASSMENT</a></pre>
<p>Harassment content.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="HATE_SPEECH">HATE_SPEECH</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html#HATE_SPEECH">HarmCategory.HATE_SPEECH</a></pre>
+ <div class="api-item"><a name="getHATE_SPEECH()"></a><a name="setHATE_SPEECH()"></a><a name="getHATE_SPEECH--"></a><a name="setHATE_SPEECH--"></a>
+ <h3 class="api-name" id="HATE_SPEECH()">HATE_SPEECH</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.Companion.html#HATE_SPEECH()">HATE_SPEECH</a></pre>
<p>Hate speech and content.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="SEXUALLY_EXPLICIT">SEXUALLY_EXPLICIT</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html#SEXUALLY_EXPLICIT">HarmCategory.SEXUALLY_EXPLICIT</a></pre>
+ <div class="api-item"><a name="getSEXUALLY_EXPLICIT()"></a><a name="setSEXUALLY_EXPLICIT()"></a><a name="getSEXUALLY_EXPLICIT--"></a><a name="setSEXUALLY_EXPLICIT--"></a>
+ <h3 class="api-name" id="SEXUALLY_EXPLICIT()">SEXUALLY_EXPLICIT</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.Companion.html#SEXUALLY_EXPLICIT()">SEXUALLY_EXPLICIT</a></pre>
<p>Sexually explicit content.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="UNKNOWN">UNKNOWN</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html#UNKNOWN">HarmCategory.UNKNOWN</a></pre>
+ <div class="api-item"><a name="getUNKNOWN()"></a><a name="setUNKNOWN()"></a><a name="getUNKNOWN--"></a><a name="setUNKNOWN--"></a>
+ <h3 class="api-name" id="UNKNOWN()">UNKNOWN</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.Companion.html#UNKNOWN()">UNKNOWN</a></pre>
<p>A new and not yet supported value.</p>
</div>
- </div>
- <div class="list">
- <h2>Public methods</h2>
- <div class="api-item"><a name="valueOf-kotlin.String-"></a><a name="valueof"></a>
- <h3 class="api-name" id="valueOf(kotlin.String)">valueOf</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html#valueOf(kotlin.String)">valueOf</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> value)</pre>
- <p>Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Throws</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html">kotlin.IllegalArgumentException</a> kotlin.IllegalArgumentException</code></td>
- <td>
- <p>if this enum type has no constant with the specified name</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="values--"></a><a name="values"></a>
- <h3 class="api-name" id="values()">values</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> HarmCategory[] <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html#values()">values</a>()</pre>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
- <p>This method may be used to iterate over the constants.</p>
+ <div class="api-item"><a name="getOrdinal()"></a><a name="setOrdinal()"></a><a name="getOrdinal--"></a><a name="setOrdinal--"></a>
+ <h3 class="api-name" id="ordinal()">ordinal</h3>
+ <pre class="api-signature no-pretty-print">public final int <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html#ordinal()">ordinal</a></pre>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/HarmProbability.Companion.html 1970-01-01 00:00:00.000000000 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/HarmProbability.Companion.html 2024-10-04 17:24:16.319268669 +0000
@@ -0,0 +1,16 @@
+<html devsite="true">
+ <head>
+ <title>HarmProbability.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>HarmProbability.Companion</h1>
+ <p>
+ <pre>public static class <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.Companion.html">HarmProbability.Companion</a></pre>
+ </p>
+ <hr>
+ </body>
+</html>
+--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/HarmProbability.html 2024-10-04 17:26:34.405120253 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/HarmProbability.html 2024-10-04 17:24:16.318268656 +0000
@@ -8,29 +8,31 @@
<div id="metadata-info-block"></div>
<h1>HarmProbability</h1>
<p>
- <pre>public enum <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a> extends <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a></pre>
+ <pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></pre>
</p>
+ <hr>
+ <p>Represents the probability that some <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code> is applicable in a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetyRating.html">SafetyRating</a></code>.</p>
+ <h2>Summary</h2>
<div class="devsite-table-wrapper">
- <table class="jd-inheritance-table">
- <tbody>
- <tr>
- <td colspan="3"><a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">java.lang.Object</a></td>
- </tr>
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
<tr>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="2"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">kotlin.Enum</a></td>
+ <th colspan="100%"><h3>Nested types</h3></th>
</tr>
+ </thead>
+ <tbody class="list">
<tr>
- <td> </td>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="1"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">com.google.firebase.vertexai.type.HarmProbability</a></td>
+ <td>
+ <div><code>public static class <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.Companion.html">HarmProbability.Companion</a></code></div>
+ </td>
</tr>
</tbody>
</table>
</div>
- <hr>
- <p>Represents the probability that some <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code> is applicable in a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetyRating.html">SafetyRating</a></code>.</p>
- <h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -39,133 +41,84 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Enum Values</h3></th>
+ <th colspan="100%"><h3>Public fields</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html#HIGH">HIGH</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.Companion.html#HIGH()">HIGH</a></code></div>
<p>Probability for harm is high.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html#LOW">LOW</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.Companion.html#LOW()">LOW</a></code></div>
<p>Probability for harm is low.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html#MEDIUM">MEDIUM</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.Companion.html#MEDIUM()">MEDIUM</a></code></div>
<p>Probability for harm is medium.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html#NEGLIGIBLE">NEGLIGIBLE</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.Companion.html#NEGLIGIBLE()">NEGLIGIBLE</a></code></div>
<p>Probability for harm is negligible.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html#UNKNOWN">UNKNOWN</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.Companion.html#UNKNOWN()">UNKNOWN</a></code></div>
<p>A new and not yet supported value.</p>
</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 methods</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="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html#valueOf(kotlin.String)">valueOf</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> value)</code></div>
- <p>Returns the enum constant of this type with the specified name.</p>
- </td>
- </tr>
- <tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> HarmProbability[]</code></td>
+ <td><code>final int</code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html#values()">values</a>()</code></div>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html#ordinal()">ordinal</a></code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="list">
- <h2>Enum Values</h2>
- <div class="api-item">
- <h3 class="api-name" id="HIGH">HIGH</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html#HIGH">HarmProbability.HIGH</a></pre>
+ <h2>Public fields</h2>
+ <div class="api-item"><a name="getHIGH()"></a><a name="setHIGH()"></a><a name="getHIGH--"></a><a name="setHIGH--"></a>
+ <h3 class="api-name" id="HIGH()">HIGH</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.Companion.html#HIGH()">HIGH</a></pre>
<p>Probability for harm is high.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="LOW">LOW</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html#LOW">HarmProbability.LOW</a></pre>
+ <div class="api-item"><a name="getLOW()"></a><a name="setLOW()"></a><a name="getLOW--"></a><a name="setLOW--"></a>
+ <h3 class="api-name" id="LOW()">LOW</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.Companion.html#LOW()">LOW</a></pre>
<p>Probability for harm is low.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="MEDIUM">MEDIUM</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html#MEDIUM">HarmProbability.MEDIUM</a></pre>
+ <div class="api-item"><a name="getMEDIUM()"></a><a name="setMEDIUM()"></a><a name="getMEDIUM--"></a><a name="setMEDIUM--"></a>
+ <h3 class="api-name" id="MEDIUM()">MEDIUM</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.Companion.html#MEDIUM()">MEDIUM</a></pre>
<p>Probability for harm is medium.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="NEGLIGIBLE">NEGLIGIBLE</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html#NEGLIGIBLE">HarmProbability.NEGLIGIBLE</a></pre>
+ <div class="api-item"><a name="getNEGLIGIBLE()"></a><a name="setNEGLIGIBLE()"></a><a name="getNEGLIGIBLE--"></a><a name="setNEGLIGIBLE--"></a>
+ <h3 class="api-name" id="NEGLIGIBLE()">NEGLIGIBLE</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.Companion.html#NEGLIGIBLE()">NEGLIGIBLE</a></pre>
<p>Probability for harm is negligible.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="UNKNOWN">UNKNOWN</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html#UNKNOWN">HarmProbability.UNKNOWN</a></pre>
+ <div class="api-item"><a name="getUNKNOWN()"></a><a name="setUNKNOWN()"></a><a name="getUNKNOWN--"></a><a name="setUNKNOWN--"></a>
+ <h3 class="api-name" id="UNKNOWN()">UNKNOWN</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.Companion.html#UNKNOWN()">UNKNOWN</a></pre>
<p>A new and not yet supported value.</p>
</div>
- </div>
- <div class="list">
- <h2>Public methods</h2>
- <div class="api-item"><a name="valueOf-kotlin.String-"></a><a name="valueof"></a>
- <h3 class="api-name" id="valueOf(kotlin.String)">valueOf</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html#valueOf(kotlin.String)">valueOf</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> value)</pre>
- <p>Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Throws</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html">kotlin.IllegalArgumentException</a> kotlin.IllegalArgumentException</code></td>
- <td>
- <p>if this enum type has no constant with the specified name</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="values--"></a><a name="values"></a>
- <h3 class="api-name" id="values()">values</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> HarmProbability[] <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html#values()">values</a>()</pre>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
- <p>This method may be used to iterate over the constants.</p>
+ <div class="api-item"><a name="getOrdinal()"></a><a name="setOrdinal()"></a><a name="getOrdinal--"></a><a name="setOrdinal--"></a>
+ <h3 class="api-name" id="ordinal()">ordinal</h3>
+ <pre class="api-signature no-pretty-print">public final int <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html#ordinal()">ordinal</a></pre>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/HarmSeverity.Companion.html 1970-01-01 00:00:00.000000000 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/HarmSeverity.Companion.html 2024-10-04 17:24:16.316268629 +0000
@@ -0,0 +1,16 @@
+<html devsite="true">
+ <head>
+ <title>HarmSeverity.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>HarmSeverity.Companion</h1>
+ <p>
+ <pre>public static class <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.Companion.html">HarmSeverity.Companion</a></pre>
+ </p>
+ <hr>
+ </body>
+</html>
+--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/HarmSeverity.html 2024-10-04 17:26:34.405120253 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/HarmSeverity.html 2024-10-04 17:24:16.317268642 +0000
@@ -8,29 +8,31 @@
<div id="metadata-info-block"></div>
<h1>HarmSeverity</h1>
<p>
- <pre>public enum <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a> extends <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a></pre>
+ <pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></pre>
</p>
+ <hr>
+ <p>Represents the severity of a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code> being applicable in a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetyRating.html">SafetyRating</a></code>.</p>
+ <h2>Summary</h2>
<div class="devsite-table-wrapper">
- <table class="jd-inheritance-table">
- <tbody>
- <tr>
- <td colspan="3"><a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">java.lang.Object</a></td>
- </tr>
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
<tr>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="2"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">kotlin.Enum</a></td>
+ <th colspan="100%"><h3>Nested types</h3></th>
</tr>
+ </thead>
+ <tbody class="list">
<tr>
- <td> </td>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="1"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">com.google.firebase.vertexai.type.HarmSeverity</a></td>
+ <td>
+ <div><code>public static class <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.Companion.html">HarmSeverity.Companion</a></code></div>
+ </td>
</tr>
</tbody>
</table>
</div>
- <hr>
- <p>Represents the severity of a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code> being applicable in a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetyRating.html">SafetyRating</a></code>.</p>
- <h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -39,133 +41,84 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Enum Values</h3></th>
+ <th colspan="100%"><h3>Public fields</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html#HIGH">HIGH</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.Companion.html#HIGH()">HIGH</a></code></div>
<p>High level of harm severity.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html#LOW">LOW</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.Companion.html#LOW()">LOW</a></code></div>
<p>Low level of harm severity.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html#MEDIUM">MEDIUM</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.Companion.html#MEDIUM()">MEDIUM</a></code></div>
<p>Medium level of harm severity.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html#NEGLIGIBLE">NEGLIGIBLE</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.Companion.html#NEGLIGIBLE()">NEGLIGIBLE</a></code></div>
<p>Severity for harm is negligible.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html#UNKNOWN">UNKNOWN</a></code></td>
+ <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.Companion.html#UNKNOWN()">UNKNOWN</a></code></div>
<p>A new and not yet supported value.</p>
</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 methods</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="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html#valueOf(kotlin.String)">valueOf</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> value)</code></div>
- <p>Returns the enum constant of this type with the specified name.</p>
- </td>
- </tr>
- <tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> HarmSeverity[]</code></td>
+ <td><code>final int</code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html#values()">values</a>()</code></div>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html#ordinal()">ordinal</a></code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="list">
- <h2>Enum Values</h2>
- <div class="api-item">
- <h3 class="api-name" id="HIGH">HIGH</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html#HIGH">HarmSeverity.HIGH</a></pre>
+ <h2>Public fields</h2>
+ <div class="api-item"><a name="getHIGH()"></a><a name="setHIGH()"></a><a name="getHIGH--"></a><a name="setHIGH--"></a>
+ <h3 class="api-name" id="HIGH()">HIGH</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.Companion.html#HIGH()">HIGH</a></pre>
<p>High level of harm severity.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="LOW">LOW</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html#LOW">HarmSeverity.LOW</a></pre>
+ <div class="api-item"><a name="getLOW()"></a><a name="setLOW()"></a><a name="getLOW--"></a><a name="setLOW--"></a>
+ <h3 class="api-name" id="LOW()">LOW</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.Companion.html#LOW()">LOW</a></pre>
<p>Low level of harm severity.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="MEDIUM">MEDIUM</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html#MEDIUM">HarmSeverity.MEDIUM</a></pre>
+ <div class="api-item"><a name="getMEDIUM()"></a><a name="setMEDIUM()"></a><a name="getMEDIUM--"></a><a name="setMEDIUM--"></a>
+ <h3 class="api-name" id="MEDIUM()">MEDIUM</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.Companion.html#MEDIUM()">MEDIUM</a></pre>
<p>Medium level of harm severity.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="NEGLIGIBLE">NEGLIGIBLE</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html#NEGLIGIBLE">HarmSeverity.NEGLIGIBLE</a></pre>
+ <div class="api-item"><a name="getNEGLIGIBLE()"></a><a name="setNEGLIGIBLE()"></a><a name="getNEGLIGIBLE--"></a><a name="setNEGLIGIBLE--"></a>
+ <h3 class="api-name" id="NEGLIGIBLE()">NEGLIGIBLE</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.Companion.html#NEGLIGIBLE()">NEGLIGIBLE</a></pre>
<p>Severity for harm is negligible.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="UNKNOWN">UNKNOWN</h3>
- <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html#UNKNOWN">HarmSeverity.UNKNOWN</a></pre>
+ <div class="api-item"><a name="getUNKNOWN()"></a><a name="setUNKNOWN()"></a><a name="getUNKNOWN--"></a><a name="setUNKNOWN--"></a>
+ <h3 class="api-name" id="UNKNOWN()">UNKNOWN</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.Companion.html#UNKNOWN()">UNKNOWN</a></pre>
<p>A new and not yet supported value.</p>
</div>
- </div>
- <div class="list">
- <h2>Public methods</h2>
- <div class="api-item"><a name="valueOf-kotlin.String-"></a><a name="valueof"></a>
- <h3 class="api-name" id="valueOf(kotlin.String)">valueOf</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html#valueOf(kotlin.String)">valueOf</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> value)</pre>
- <p>Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Throws</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html">kotlin.IllegalArgumentException</a> kotlin.IllegalArgumentException</code></td>
- <td>
- <p>if this enum type has no constant with the specified name</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="values--"></a><a name="values"></a>
- <h3 class="api-name" id="values()">values</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> HarmSeverity[] <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html#values()">values</a>()</pre>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
- <p>This method may be used to iterate over the constants.</p>
+ <div class="api-item"><a name="getOrdinal()"></a><a name="setOrdinal()"></a><a name="getOrdinal--"></a><a name="setOrdinal--"></a>
+ <h3 class="api-name" id="ordinal()">ordinal</h3>
+ <pre class="api-signature no-pretty-print">public final int <a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html#ordinal()">ordinal</a></pre>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/package-summary.html 2024-10-04 17:26:34.405120253 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/package-summary.html 2024-10-04 17:24:16.317268642 +0000
@@ -32,6 +32,12 @@
</colgroup>
<tbody class="list">
<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>
+ </td>
+ </tr>
+ <tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Candidate.html">Candidate</a></code></td>
<td>
<p>A response generated by the model.</p>
@@ -78,6 +84,12 @@
</td>
</tr>
<tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
+ <td>
+ <p>The reason for content finishing.</p>
+ </td>
+ </tr>
+ <tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FunctionCall.html">FunctionCall</a></code></td>
<td>
<p>The data necessary to invoke function <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FunctionCall.html#name()">name</a></code> using the arguments <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FunctionCall.html#args()">args</a></code>.</p>
@@ -136,6 +148,36 @@
<td></td>
</tr>
<tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a></code></td>
+ <td>
+ <p>Specifies how the block method computes the score that will be compared against the <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code> in <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code>.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code></td>
+ <td>
+ <p>Represents the threshold for a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code> to be allowed by <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code>.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code></td>
+ <td>
+ <p>Category for a given harm rating.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code></td>
+ <td>
+ <p>Represents the probability that some <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code> is applicable in a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetyRating.html">SafetyRating</a></code>.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></code></td>
+ <td>
+ <p>Represents the severity of a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code> being applicable in a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetyRating.html">SafetyRating</a></code>.</p>
+ </td>
+ </tr>
+ <tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagePart.html">ImagePart</a></code></td>
<td>
<p>Represents image data sent to and received from requests.</p>
@@ -214,59 +256,6 @@
</td>
</tr>
</tbody>
- </table>
- </div>
- <h2>Enums</h2>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <tbody class="list">
- <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>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
- <td>
- <p>The reason for content finishing.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a></code></td>
- <td>
- <p>Specifies how the block method computes the score that will be compared against the <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code> in <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code>.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code></td>
- <td>
- <p>Represents the threshold for a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code> to be allowed by <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code>.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code></td>
- <td>
- <p>Category for a given harm rating.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code></td>
- <td>
- <p>Represents the probability that some <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code> is applicable in a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetyRating.html">SafetyRating</a></code>.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></code></td>
- <td>
- <p>Represents the severity of a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code> being applicable in a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetyRating.html">SafetyRating</a></code>.</p>
- </td>
- </tr>
- </tbody>
</table>
</div>
<h2>Exceptions</h2>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/client/firebase-vertexai/_toc.yaml 2024-10-04 17:26:34.403120226 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/client/firebase-vertexai/_toc.yaml 2024-10-04 17:24:16.315268616 +0000
@@ -38,6 +38,8 @@
- title: "Classes"
section:
+ - title: "BlockReason"
+ path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html"
- title: "Candidate"
path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/Candidate.html"
- title: "Citation"
@@ -52,6 +54,8 @@
path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/CountTokensResponse.html"
- title: "FileDataPart"
path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/FileDataPart.html"
+ - title: "FinishReason"
+ path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html"
- title: "FunctionCall"
path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/FunctionCall.html"
- title: "FunctionCallPart"
@@ -70,6 +74,16 @@
path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html"
- title: "GenerationConfig.Builder"
path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.Builder.html"
+ - title: "HarmBlockMethod"
+ path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html"
+ - title: "HarmBlockThreshold"
+ path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html"
+ - title: "HarmCategory"
+ path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html"
+ - title: "HarmProbability"
+ path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html"
+ - title: "HarmSeverity"
+ path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html"
- title: "ImagePart"
path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagePart.html"
- title: "InlineDataPart"
@@ -97,24 +111,6 @@
- title: "UsageMetadata"
path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/UsageMetadata.html"
- - title: "Enums"
-
- section:
- - title: "BlockReason"
- path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html"
- - title: "FinishReason"
- path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html"
- - title: "HarmBlockMethod"
- path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html"
- - title: "HarmBlockThreshold"
- path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html"
- - title: "HarmCategory"
- path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html"
- - title: "HarmProbability"
- path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html"
- - title: "HarmSeverity"
- path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html"
-
- title: "Exceptions"
section:--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/BlockReason.html 2024-10-04 17:26:34.400120185 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/BlockReason.html 2024-10-04 17:24:16.313268589 +0000
@@ -8,26 +8,8 @@
<div id="metadata-info-block"></div>
<h1>BlockReason</h1>
<p>
- <pre>enum <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a></pre>
+ <pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a></pre>
</p>
- <div class="devsite-table-wrapper">
- <table class="jd-inheritance-table">
- <tbody>
- <tr>
- <td colspan="3"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">kotlin.Any</a></td>
- </tr>
- <tr>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="2"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">kotlin.Enum</a></td>
- </tr>
- <tr>
- <td> </td>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="1"><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">com.google.firebase.vertexai.type.BlockReason</a></td>
- </tr>
- </tbody>
- </table>
- </div>
<hr>
<p>Describes why content was blocked.</p>
<h2>Summary</h2>
@@ -39,25 +21,28 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Enum Values</h3></th>
+ <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/BlockReason.html#OTHER">OTHER</a></code></td>
+ <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>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html#SAFETY">SAFETY</a></code></td>
+ <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>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html#UNKNOWN">UNKNOWN</a></code></td>
+ <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#UNKNOWN()">UNKNOWN</a></code></div>
<p>A new and not yet supported value.</p>
</td>
</tr>
@@ -72,78 +57,52 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Public functions</h3></th>
+ <th colspan="100%"><h3>Public properties</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a></code></td>
+ <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/BlockReason.html#valueOf(kotlin.String)">valueOf</a>(value: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
- <p>Returns the enum constant of this type with the specified name.</p>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html#name()">name</a></code></div>
</td>
</tr>
<tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a>></code></td>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
<td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html#values()">values</a>()</code></div>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html#ordinal()">ordinal</a></code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="list">
- <h2>Enum Values</h2>
- <div class="api-item">
- <h3 class="api-name" id="OTHER">OTHER</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html#OTHER">BlockReason.OTHER</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a></pre>
+ <h2>Public companion properties</h2>
+ <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 <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.Companion.html#OTHER()">OTHER</a>: <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">
- <h3 class="api-name" id="SAFETY">SAFETY</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html#SAFETY">BlockReason.SAFETY</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a></pre>
+ <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 <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.Companion.html#SAFETY()">SAFETY</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a></pre>
<p>Content was blocked for violating provided <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code>.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="UNKNOWN">UNKNOWN</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html#UNKNOWN">BlockReason.UNKNOWN</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a></pre>
+ <div class="api-item"><a name="getUNKNOWN()"></a><a name="setUNKNOWN()"></a><a name="getUNKNOWN--"></a><a name="setUNKNOWN--"></a>
+ <h3 class="api-name" id="UNKNOWN()">UNKNOWN</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.Companion.html#UNKNOWN()">UNKNOWN</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a></pre>
<p>A new and not yet supported value.</p>
</div>
</div>
<div class="list">
- <h2>Public functions</h2>
- <div class="api-item"><a name="valueOf-kotlin.String-"></a><a name="valueof"></a>
- <h3 class="api-name" id="valueOf(kotlin.String)">valueOf</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html#valueOf(kotlin.String)">valueOf</a>(value: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a></pre>
- <p>Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Throws</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>kotlin.IllegalArgumentException: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html">kotlin.IllegalArgumentException</a></code></td>
- <td>
- <p>if this enum type has no constant with the specified name</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="values--"></a><a name="values"></a>
- <h3 class="api-name" id="values()">values</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html#values()">values</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html">BlockReason</a>></pre>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
- <p>This method may be used to iterate over the constants.</p>
+ <h2>Public properties</h2>
+ <div class="api-item"><a name="getName()"></a><a name="setName()"></a><a name="getName--"></a><a name="setName--"></a>
+ <h3 class="api-name" id="name()">name</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html#name()">name</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></pre>
+ </div>
+ <div class="api-item"><a name="getOrdinal()"></a><a name="setOrdinal()"></a><a name="getOrdinal--"></a><a name="setOrdinal--"></a>
+ <h3 class="api-name" id="ordinal()">ordinal</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/BlockReason.html#ordinal()">ordinal</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/FinishReason.html 2024-10-04 17:26:34.399120172 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/FinishReason.html 2024-10-04 17:24:16.311268561 +0000
@@ -8,26 +8,8 @@
<div id="metadata-info-block"></div>
<h1>FinishReason</h1>
<p>
- <pre>enum <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a></pre>
+ <pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>
</p>
- <div class="devsite-table-wrapper">
- <table class="jd-inheritance-table">
- <tbody>
- <tr>
- <td colspan="3"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">kotlin.Any</a></td>
- </tr>
- <tr>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="2"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">kotlin.Enum</a></td>
- </tr>
- <tr>
- <td> </td>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="1"><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">com.google.firebase.vertexai.type.FinishReason</a></td>
- </tr>
- </tbody>
- </table>
- </div>
<hr>
<p>The reason for content finishing.</p>
<h2>Summary</h2>
@@ -39,43 +21,49 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Enum Values</h3></th>
+ <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/FinishReason.html#MAX_TOKENS">MAX_TOKENS</a></code></td>
+ <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>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html#OTHER">OTHER</a></code></td>
+ <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#OTHER()">OTHER</a></code></div>
<p>Model stopped for another reason.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html#RECITATION">RECITATION</a></code></td>
+ <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>Model began looping.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html#SAFETY">SAFETY</a></code></td>
+ <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#SAFETY()">SAFETY</a></code></div>
<p><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code> prevented the model from outputting content.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html#STOP">STOP</a></code></td>
+ <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>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html#UNKNOWN">UNKNOWN</a></code></td>
+ <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#UNKNOWN()">UNKNOWN</a></code></div>
<p>A new and not yet supported value.</p>
</td>
</tr>
@@ -90,93 +78,67 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Public functions</h3></th>
+ <th colspan="100%"><h3>Public properties</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
+ <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/FinishReason.html#valueOf(kotlin.String)">valueOf</a>(value: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
- <p>Returns the enum constant of this type with the specified name.</p>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html#name()">name</a></code></div>
</td>
</tr>
<tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a>></code></td>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
<td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html#values()">values</a>()</code></div>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html#ordinal()">ordinal</a></code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="list">
- <h2>Enum Values</h2>
- <div class="api-item">
- <h3 class="api-name" id="MAX_TOKENS">MAX_TOKENS</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html#MAX_TOKENS">FinishReason.MAX_TOKENS</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>
+ <h2>Public companion properties</h2>
+ <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 <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#MAX_TOKENS()">MAX_TOKENS</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>
<p>Model hit the token limit.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="OTHER">OTHER</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html#OTHER">FinishReason.OTHER</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>
+ <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 <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#OTHER()">OTHER</a>: <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">
- <h3 class="api-name" id="RECITATION">RECITATION</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html#RECITATION">FinishReason.RECITATION</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>
+ <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 <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#RECITATION()">RECITATION</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>
<p>Model began looping.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="SAFETY">SAFETY</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html#SAFETY">FinishReason.SAFETY</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>
+ <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 <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#SAFETY()">SAFETY</a>: <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">
- <h3 class="api-name" id="STOP">STOP</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html#STOP">FinishReason.STOP</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>
+ <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 <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#STOP()">STOP</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>
<p>Model finished successfully and stopped.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="UNKNOWN">UNKNOWN</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html#UNKNOWN">FinishReason.UNKNOWN</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>
+ <div class="api-item"><a name="getUNKNOWN()"></a><a name="setUNKNOWN()"></a><a name="getUNKNOWN--"></a><a name="setUNKNOWN--"></a>
+ <h3 class="api-name" id="UNKNOWN()">UNKNOWN</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.Companion.html#UNKNOWN()">UNKNOWN</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>
<p>A new and not yet supported value.</p>
</div>
</div>
<div class="list">
- <h2>Public functions</h2>
- <div class="api-item"><a name="valueOf-kotlin.String-"></a><a name="valueof"></a>
- <h3 class="api-name" id="valueOf(kotlin.String)">valueOf</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html#valueOf(kotlin.String)">valueOf</a>(value: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></pre>
- <p>Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Throws</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>kotlin.IllegalArgumentException: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html">kotlin.IllegalArgumentException</a></code></td>
- <td>
- <p>if this enum type has no constant with the specified name</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="values--"></a><a name="values"></a>
- <h3 class="api-name" id="values()">values</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html#values()">values</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a>></pre>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
- <p>This method may be used to iterate over the constants.</p>
+ <h2>Public properties</h2>
+ <div class="api-item"><a name="getName()"></a><a name="setName()"></a><a name="getName--"></a><a name="setName--"></a>
+ <h3 class="api-name" id="name()">name</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html#name()">name</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></pre>
+ </div>
+ <div class="api-item"><a name="getOrdinal()"></a><a name="setOrdinal()"></a><a name="getOrdinal--"></a><a name="setOrdinal--"></a>
+ <h3 class="api-name" id="ordinal()">ordinal</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html#ordinal()">ordinal</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html 2024-10-04 17:26:34.401120199 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html 2024-10-04 17:24:16.313268589 +0000
@@ -8,26 +8,8 @@
<div id="metadata-info-block"></div>
<h1>HarmBlockMethod</h1>
<p>
- <pre>enum <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a></pre>
+ <pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a></pre>
</p>
- <div class="devsite-table-wrapper">
- <table class="jd-inheritance-table">
- <tbody>
- <tr>
- <td colspan="3"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">kotlin.Any</a></td>
- </tr>
- <tr>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="2"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">kotlin.Enum</a></td>
- </tr>
- <tr>
- <td> </td>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="1"><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html">com.google.firebase.vertexai.type.HarmBlockMethod</a></td>
- </tr>
- </tbody>
- </table>
- </div>
<hr>
<p>Specifies how the block method computes the score that will be compared against the <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code> in <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code>.</p>
<h2>Summary</h2>
@@ -39,19 +21,21 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Enum Values</h3></th>
+ <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/HarmBlockMethod.html#PROBABILITY">PROBABILITY</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.Companion.html#PROBABILITY()">PROBABILITY</a></code></div>
<p>The harm block method uses the probability score.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html#SEVERITY">SEVERITY</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.Companion.html#SEVERITY()">SEVERITY</a></code></div>
<p>The harm block method uses both probability and severity scores.</p>
</td>
</tr>
@@ -66,73 +50,37 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Public functions</h3></th>
+ <th colspan="100%"><h3>Public properties</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a></code></td>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
<td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html#valueOf(kotlin.String)">valueOf</a>(value: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
- <p>Returns the enum constant of this type with the specified name.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a>></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html#values()">values</a>()</code></div>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html#ordinal()">ordinal</a></code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="list">
- <h2>Enum Values</h2>
- <div class="api-item">
- <h3 class="api-name" id="PROBABILITY">PROBABILITY</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html#PROBABILITY">HarmBlockMethod.PROBABILITY</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a></pre>
+ <h2>Public companion properties</h2>
+ <div class="api-item"><a name="getPROBABILITY()"></a><a name="setPROBABILITY()"></a><a name="getPROBABILITY--"></a><a name="setPROBABILITY--"></a>
+ <h3 class="api-name" id="PROBABILITY()">PROBABILITY</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.Companion.html#PROBABILITY()">PROBABILITY</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a></pre>
<p>The harm block method uses the probability score. See <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code>.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="SEVERITY">SEVERITY</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html#SEVERITY">HarmBlockMethod.SEVERITY</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a></pre>
+ <div class="api-item"><a name="getSEVERITY()"></a><a name="setSEVERITY()"></a><a name="getSEVERITY--"></a><a name="setSEVERITY--"></a>
+ <h3 class="api-name" id="SEVERITY()">SEVERITY</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.Companion.html#SEVERITY()">SEVERITY</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a></pre>
<p>The harm block method uses both probability and severity scores. See <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></code> and <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code>.</p>
</div>
</div>
<div class="list">
- <h2>Public functions</h2>
- <div class="api-item"><a name="valueOf-kotlin.String-"></a><a name="valueof"></a>
- <h3 class="api-name" id="valueOf(kotlin.String)">valueOf</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html#valueOf(kotlin.String)">valueOf</a>(value: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a></pre>
- <p>Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Throws</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>kotlin.IllegalArgumentException: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html">kotlin.IllegalArgumentException</a></code></td>
- <td>
- <p>if this enum type has no constant with the specified name</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="values--"></a><a name="values"></a>
- <h3 class="api-name" id="values()">values</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html#values()">values</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a>></pre>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
- <p>This method may be used to iterate over the constants.</p>
+ <h2>Public properties</h2>
+ <div class="api-item"><a name="getOrdinal()"></a><a name="setOrdinal()"></a><a name="getOrdinal--"></a><a name="setOrdinal--"></a>
+ <h3 class="api-name" id="ordinal()">ordinal</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html#ordinal()">ordinal</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html 2024-10-04 17:26:34.400120185 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html 2024-10-04 17:24:16.312268575 +0000
@@ -8,26 +8,8 @@
<div id="metadata-info-block"></div>
<h1>HarmBlockThreshold</h1>
<p>
- <pre>enum <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a></pre>
+ <pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></pre>
</p>
- <div class="devsite-table-wrapper">
- <table class="jd-inheritance-table">
- <tbody>
- <tr>
- <td colspan="3"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">kotlin.Any</a></td>
- </tr>
- <tr>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="2"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">kotlin.Enum</a></td>
- </tr>
- <tr>
- <td> </td>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="1"><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">com.google.firebase.vertexai.type.HarmBlockThreshold</a></td>
- </tr>
- </tbody>
- </table>
- </div>
<hr>
<p>Represents the threshold for a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code> to be allowed by <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code>.</p>
<h2>Summary</h2>
@@ -39,31 +21,35 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Enum Values</h3></th>
+ <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/HarmBlockThreshold.html#LOW_AND_ABOVE">LOW_AND_ABOVE</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.Companion.html#LOW_AND_ABOVE()">LOW_AND_ABOVE</a></code></div>
<p>Content with negligible harm is allowed.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html#MEDIUM_AND_ABOVE">MEDIUM_AND_ABOVE</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.Companion.html#MEDIUM_AND_ABOVE()">MEDIUM_AND_ABOVE</a></code></div>
<p>Content with negligible to low harm is allowed.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html#NONE">NONE</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.Companion.html#NONE()">NONE</a></code></div>
<p>All content is allowed regardless of harm.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html#ONLY_HIGH">ONLY_HIGH</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.Companion.html#ONLY_HIGH()">ONLY_HIGH</a></code></div>
<p>Content with negligible to medium harm is allowed.</p>
</td>
</tr>
@@ -78,83 +64,47 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Public functions</h3></th>
+ <th colspan="100%"><h3>Public properties</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html#valueOf(kotlin.String)">valueOf</a>(value: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
- <p>Returns the enum constant of this type with the specified name.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a>></code></td>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
<td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html#values()">values</a>()</code></div>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html#ordinal()">ordinal</a></code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="list">
- <h2>Enum Values</h2>
- <div class="api-item">
- <h3 class="api-name" id="LOW_AND_ABOVE">LOW_AND_ABOVE</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html#LOW_AND_ABOVE">HarmBlockThreshold.LOW_AND_ABOVE</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></pre>
+ <h2>Public companion properties</h2>
+ <div class="api-item"><a name="getLOW_AND_ABOVE()"></a><a name="setLOW_AND_ABOVE()"></a><a name="getLOW_AND_ABOVE--"></a><a name="setLOW_AND_ABOVE--"></a>
+ <h3 class="api-name" id="LOW_AND_ABOVE()">LOW_AND_ABOVE</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.Companion.html#LOW_AND_ABOVE()">LOW_AND_ABOVE</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></pre>
<p>Content with negligible harm is allowed.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="MEDIUM_AND_ABOVE">MEDIUM_AND_ABOVE</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html#MEDIUM_AND_ABOVE">HarmBlockThreshold.MEDIUM_AND_ABOVE</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></pre>
+ <div class="api-item"><a name="getMEDIUM_AND_ABOVE()"></a><a name="setMEDIUM_AND_ABOVE()"></a><a name="getMEDIUM_AND_ABOVE--"></a><a name="setMEDIUM_AND_ABOVE--"></a>
+ <h3 class="api-name" id="MEDIUM_AND_ABOVE()">MEDIUM_AND_ABOVE</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.Companion.html#MEDIUM_AND_ABOVE()">MEDIUM_AND_ABOVE</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></pre>
<p>Content with negligible to low harm is allowed.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="NONE">NONE</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html#NONE">HarmBlockThreshold.NONE</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></pre>
+ <div class="api-item"><a name="getNONE()"></a><a name="setNONE()"></a><a name="getNONE--"></a><a name="setNONE--"></a>
+ <h3 class="api-name" id="NONE()">NONE</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.Companion.html#NONE()">NONE</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></pre>
<p>All content is allowed regardless of harm.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="ONLY_HIGH">ONLY_HIGH</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html#ONLY_HIGH">HarmBlockThreshold.ONLY_HIGH</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></pre>
+ <div class="api-item"><a name="getONLY_HIGH()"></a><a name="setONLY_HIGH()"></a><a name="getONLY_HIGH--"></a><a name="setONLY_HIGH--"></a>
+ <h3 class="api-name" id="ONLY_HIGH()">ONLY_HIGH</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.Companion.html#ONLY_HIGH()">ONLY_HIGH</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></pre>
<p>Content with negligible to medium harm is allowed.</p>
</div>
</div>
<div class="list">
- <h2>Public functions</h2>
- <div class="api-item"><a name="valueOf-kotlin.String-"></a><a name="valueof"></a>
- <h3 class="api-name" id="valueOf(kotlin.String)">valueOf</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html#valueOf(kotlin.String)">valueOf</a>(value: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></pre>
- <p>Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Throws</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>kotlin.IllegalArgumentException: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html">kotlin.IllegalArgumentException</a></code></td>
- <td>
- <p>if this enum type has no constant with the specified name</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="values--"></a><a name="values"></a>
- <h3 class="api-name" id="values()">values</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html#values()">values</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a>></pre>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
- <p>This method may be used to iterate over the constants.</p>
+ <h2>Public properties</h2>
+ <div class="api-item"><a name="getOrdinal()"></a><a name="setOrdinal()"></a><a name="getOrdinal--"></a><a name="setOrdinal--"></a>
+ <h3 class="api-name" id="ordinal()">ordinal</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html#ordinal()">ordinal</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/HarmCategory.html 2024-10-04 17:26:34.398120158 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/HarmCategory.html 2024-10-04 17:24:16.310268548 +0000
@@ -8,26 +8,8 @@
<div id="metadata-info-block"></div>
<h1>HarmCategory</h1>
<p>
- <pre>enum <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a></pre>
+ <pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></pre>
</p>
- <div class="devsite-table-wrapper">
- <table class="jd-inheritance-table">
- <tbody>
- <tr>
- <td colspan="3"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">kotlin.Any</a></td>
- </tr>
- <tr>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="2"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">kotlin.Enum</a></td>
- </tr>
- <tr>
- <td> </td>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="1"><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">com.google.firebase.vertexai.type.HarmCategory</a></td>
- </tr>
- </tbody>
- </table>
- </div>
<hr>
<p>Category for a given harm rating.</p>
<h2>Summary</h2>
@@ -39,37 +21,42 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Enum Values</h3></th>
+ <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/HarmCategory.html#DANGEROUS_CONTENT">DANGEROUS_CONTENT</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.Companion.html#DANGEROUS_CONTENT()">DANGEROUS_CONTENT</a></code></div>
<p>Dangerous content.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html#HARASSMENT">HARASSMENT</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.Companion.html#HARASSMENT()">HARASSMENT</a></code></div>
<p>Harassment content.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html#HATE_SPEECH">HATE_SPEECH</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.Companion.html#HATE_SPEECH()">HATE_SPEECH</a></code></div>
<p>Hate speech and content.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html#SEXUALLY_EXPLICIT">SEXUALLY_EXPLICIT</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.Companion.html#SEXUALLY_EXPLICIT()">SEXUALLY_EXPLICIT</a></code></div>
<p>Sexually explicit content.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html#UNKNOWN">UNKNOWN</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.Companion.html#UNKNOWN()">UNKNOWN</a></code></div>
<p>A new and not yet supported value.</p>
</td>
</tr>
@@ -84,88 +71,52 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Public functions</h3></th>
+ <th colspan="100%"><h3>Public properties</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html#valueOf(kotlin.String)">valueOf</a>(value: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
- <p>Returns the enum constant of this type with the specified name.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a>></code></td>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
<td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html#values()">values</a>()</code></div>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html#ordinal()">ordinal</a></code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="list">
- <h2>Enum Values</h2>
- <div class="api-item">
- <h3 class="api-name" id="DANGEROUS_CONTENT">DANGEROUS_CONTENT</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html#DANGEROUS_CONTENT">HarmCategory.DANGEROUS_CONTENT</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></pre>
+ <h2>Public companion properties</h2>
+ <div class="api-item"><a name="getDANGEROUS_CONTENT()"></a><a name="setDANGEROUS_CONTENT()"></a><a name="getDANGEROUS_CONTENT--"></a><a name="setDANGEROUS_CONTENT--"></a>
+ <h3 class="api-name" id="DANGEROUS_CONTENT()">DANGEROUS_CONTENT</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.Companion.html#DANGEROUS_CONTENT()">DANGEROUS_CONTENT</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></pre>
<p>Dangerous content.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="HARASSMENT">HARASSMENT</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html#HARASSMENT">HarmCategory.HARASSMENT</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></pre>
+ <div class="api-item"><a name="getHARASSMENT()"></a><a name="setHARASSMENT()"></a><a name="getHARASSMENT--"></a><a name="setHARASSMENT--"></a>
+ <h3 class="api-name" id="HARASSMENT()">HARASSMENT</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.Companion.html#HARASSMENT()">HARASSMENT</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></pre>
<p>Harassment content.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="HATE_SPEECH">HATE_SPEECH</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html#HATE_SPEECH">HarmCategory.HATE_SPEECH</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></pre>
+ <div class="api-item"><a name="getHATE_SPEECH()"></a><a name="setHATE_SPEECH()"></a><a name="getHATE_SPEECH--"></a><a name="setHATE_SPEECH--"></a>
+ <h3 class="api-name" id="HATE_SPEECH()">HATE_SPEECH</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.Companion.html#HATE_SPEECH()">HATE_SPEECH</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></pre>
<p>Hate speech and content.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="SEXUALLY_EXPLICIT">SEXUALLY_EXPLICIT</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html#SEXUALLY_EXPLICIT">HarmCategory.SEXUALLY_EXPLICIT</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></pre>
+ <div class="api-item"><a name="getSEXUALLY_EXPLICIT()"></a><a name="setSEXUALLY_EXPLICIT()"></a><a name="getSEXUALLY_EXPLICIT--"></a><a name="setSEXUALLY_EXPLICIT--"></a>
+ <h3 class="api-name" id="SEXUALLY_EXPLICIT()">SEXUALLY_EXPLICIT</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.Companion.html#SEXUALLY_EXPLICIT()">SEXUALLY_EXPLICIT</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></pre>
<p>Sexually explicit content.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="UNKNOWN">UNKNOWN</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html#UNKNOWN">HarmCategory.UNKNOWN</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></pre>
+ <div class="api-item"><a name="getUNKNOWN()"></a><a name="setUNKNOWN()"></a><a name="getUNKNOWN--"></a><a name="setUNKNOWN--"></a>
+ <h3 class="api-name" id="UNKNOWN()">UNKNOWN</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.Companion.html#UNKNOWN()">UNKNOWN</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></pre>
<p>A new and not yet supported value.</p>
</div>
</div>
<div class="list">
- <h2>Public functions</h2>
- <div class="api-item"><a name="valueOf-kotlin.String-"></a><a name="valueof"></a>
- <h3 class="api-name" id="valueOf(kotlin.String)">valueOf</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html#valueOf(kotlin.String)">valueOf</a>(value: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></pre>
- <p>Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Throws</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>kotlin.IllegalArgumentException: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html">kotlin.IllegalArgumentException</a></code></td>
- <td>
- <p>if this enum type has no constant with the specified name</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="values--"></a><a name="values"></a>
- <h3 class="api-name" id="values()">values</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html#values()">values</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a>></pre>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
- <p>This method may be used to iterate over the constants.</p>
+ <h2>Public properties</h2>
+ <div class="api-item"><a name="getOrdinal()"></a><a name="setOrdinal()"></a><a name="getOrdinal--"></a><a name="setOrdinal--"></a>
+ <h3 class="api-name" id="ordinal()">ordinal</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html#ordinal()">ordinal</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/HarmProbability.html 2024-10-04 17:26:34.398120158 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/HarmProbability.html 2024-10-04 17:24:16.311268561 +0000
@@ -8,26 +8,8 @@
<div id="metadata-info-block"></div>
<h1>HarmProbability</h1>
<p>
- <pre>enum <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a></pre>
+ <pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></pre>
</p>
- <div class="devsite-table-wrapper">
- <table class="jd-inheritance-table">
- <tbody>
- <tr>
- <td colspan="3"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">kotlin.Any</a></td>
- </tr>
- <tr>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="2"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">kotlin.Enum</a></td>
- </tr>
- <tr>
- <td> </td>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="1"><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">com.google.firebase.vertexai.type.HarmProbability</a></td>
- </tr>
- </tbody>
- </table>
- </div>
<hr>
<p>Represents the probability that some <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code> is applicable in a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetyRating.html">SafetyRating</a></code>.</p>
<h2>Summary</h2>
@@ -39,37 +21,42 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Enum Values</h3></th>
+ <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/HarmProbability.html#HIGH">HIGH</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.Companion.html#HIGH()">HIGH</a></code></div>
<p>Probability for harm is high.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html#LOW">LOW</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.Companion.html#LOW()">LOW</a></code></div>
<p>Probability for harm is low.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html#MEDIUM">MEDIUM</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.Companion.html#MEDIUM()">MEDIUM</a></code></div>
<p>Probability for harm is medium.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html#NEGLIGIBLE">NEGLIGIBLE</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.Companion.html#NEGLIGIBLE()">NEGLIGIBLE</a></code></div>
<p>Probability for harm is negligible.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html#UNKNOWN">UNKNOWN</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.Companion.html#UNKNOWN()">UNKNOWN</a></code></div>
<p>A new and not yet supported value.</p>
</td>
</tr>
@@ -84,88 +71,52 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Public functions</h3></th>
+ <th colspan="100%"><h3>Public properties</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html#valueOf(kotlin.String)">valueOf</a>(value: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
- <p>Returns the enum constant of this type with the specified name.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a>></code></td>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
<td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html#values()">values</a>()</code></div>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html#ordinal()">ordinal</a></code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="list">
- <h2>Enum Values</h2>
- <div class="api-item">
- <h3 class="api-name" id="HIGH">HIGH</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html#HIGH">HarmProbability.HIGH</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></pre>
+ <h2>Public companion properties</h2>
+ <div class="api-item"><a name="getHIGH()"></a><a name="setHIGH()"></a><a name="getHIGH--"></a><a name="setHIGH--"></a>
+ <h3 class="api-name" id="HIGH()">HIGH</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.Companion.html#HIGH()">HIGH</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></pre>
<p>Probability for harm is high.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="LOW">LOW</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html#LOW">HarmProbability.LOW</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></pre>
+ <div class="api-item"><a name="getLOW()"></a><a name="setLOW()"></a><a name="getLOW--"></a><a name="setLOW--"></a>
+ <h3 class="api-name" id="LOW()">LOW</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.Companion.html#LOW()">LOW</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></pre>
<p>Probability for harm is low.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="MEDIUM">MEDIUM</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html#MEDIUM">HarmProbability.MEDIUM</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></pre>
+ <div class="api-item"><a name="getMEDIUM()"></a><a name="setMEDIUM()"></a><a name="getMEDIUM--"></a><a name="setMEDIUM--"></a>
+ <h3 class="api-name" id="MEDIUM()">MEDIUM</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.Companion.html#MEDIUM()">MEDIUM</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></pre>
<p>Probability for harm is medium.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="NEGLIGIBLE">NEGLIGIBLE</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html#NEGLIGIBLE">HarmProbability.NEGLIGIBLE</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></pre>
+ <div class="api-item"><a name="getNEGLIGIBLE()"></a><a name="setNEGLIGIBLE()"></a><a name="getNEGLIGIBLE--"></a><a name="setNEGLIGIBLE--"></a>
+ <h3 class="api-name" id="NEGLIGIBLE()">NEGLIGIBLE</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.Companion.html#NEGLIGIBLE()">NEGLIGIBLE</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></pre>
<p>Probability for harm is negligible.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="UNKNOWN">UNKNOWN</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html#UNKNOWN">HarmProbability.UNKNOWN</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></pre>
+ <div class="api-item"><a name="getUNKNOWN()"></a><a name="setUNKNOWN()"></a><a name="getUNKNOWN--"></a><a name="setUNKNOWN--"></a>
+ <h3 class="api-name" id="UNKNOWN()">UNKNOWN</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.Companion.html#UNKNOWN()">UNKNOWN</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></pre>
<p>A new and not yet supported value.</p>
</div>
</div>
<div class="list">
- <h2>Public functions</h2>
- <div class="api-item"><a name="valueOf-kotlin.String-"></a><a name="valueof"></a>
- <h3 class="api-name" id="valueOf(kotlin.String)">valueOf</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html#valueOf(kotlin.String)">valueOf</a>(value: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></pre>
- <p>Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Throws</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>kotlin.IllegalArgumentException: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html">kotlin.IllegalArgumentException</a></code></td>
- <td>
- <p>if this enum type has no constant with the specified name</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="values--"></a><a name="values"></a>
- <h3 class="api-name" id="values()">values</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html#values()">values</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a>></pre>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
- <p>This method may be used to iterate over the constants.</p>
+ <h2>Public properties</h2>
+ <div class="api-item"><a name="getOrdinal()"></a><a name="setOrdinal()"></a><a name="getOrdinal--"></a><a name="setOrdinal--"></a>
+ <h3 class="api-name" id="ordinal()">ordinal</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html#ordinal()">ordinal</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html 2024-10-04 17:26:34.397120145 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html 2024-10-04 17:24:16.310268548 +0000
@@ -8,26 +8,8 @@
<div id="metadata-info-block"></div>
<h1>HarmSeverity</h1>
<p>
- <pre>enum <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a></pre>
+ <pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></pre>
</p>
- <div class="devsite-table-wrapper">
- <table class="jd-inheritance-table">
- <tbody>
- <tr>
- <td colspan="3"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">kotlin.Any</a></td>
- </tr>
- <tr>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="2"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">kotlin.Enum</a></td>
- </tr>
- <tr>
- <td> </td>
- <td class="jd-inheritance-space"> ↳</td>
- <td colspan="1"><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">com.google.firebase.vertexai.type.HarmSeverity</a></td>
- </tr>
- </tbody>
- </table>
- </div>
<hr>
<p>Represents the severity of a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code> being applicable in a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetyRating.html">SafetyRating</a></code>.</p>
<h2>Summary</h2>
@@ -39,37 +21,42 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Enum Values</h3></th>
+ <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/HarmSeverity.html#HIGH">HIGH</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.Companion.html#HIGH()">HIGH</a></code></div>
<p>High level of harm severity.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html#LOW">LOW</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.Companion.html#LOW()">LOW</a></code></div>
<p>Low level of harm severity.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html#MEDIUM">MEDIUM</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.Companion.html#MEDIUM()">MEDIUM</a></code></div>
<p>Medium level of harm severity.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html#NEGLIGIBLE">NEGLIGIBLE</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.Companion.html#NEGLIGIBLE()">NEGLIGIBLE</a></code></div>
<p>Severity for harm is negligible.</p>
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html#UNKNOWN">UNKNOWN</a></code></td>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.Companion.html#UNKNOWN()">UNKNOWN</a></code></div>
<p>A new and not yet supported value.</p>
</td>
</tr>
@@ -84,88 +71,52 @@
</colgroup>
<thead>
<tr>
- <th colspan="100%"><h3>Public functions</h3></th>
+ <th colspan="100%"><h3>Public properties</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html#valueOf(kotlin.String)">valueOf</a>(value: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
- <p>Returns the enum constant of this type with the specified name.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a>></code></td>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
<td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html#values()">values</a>()</code></div>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html#ordinal()">ordinal</a></code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="list">
- <h2>Enum Values</h2>
- <div class="api-item">
- <h3 class="api-name" id="HIGH">HIGH</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html#HIGH">HarmSeverity.HIGH</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></pre>
+ <h2>Public companion properties</h2>
+ <div class="api-item"><a name="getHIGH()"></a><a name="setHIGH()"></a><a name="getHIGH--"></a><a name="setHIGH--"></a>
+ <h3 class="api-name" id="HIGH()">HIGH</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.Companion.html#HIGH()">HIGH</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></pre>
<p>High level of harm severity.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="LOW">LOW</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html#LOW">HarmSeverity.LOW</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></pre>
+ <div class="api-item"><a name="getLOW()"></a><a name="setLOW()"></a><a name="getLOW--"></a><a name="setLOW--"></a>
+ <h3 class="api-name" id="LOW()">LOW</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.Companion.html#LOW()">LOW</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></pre>
<p>Low level of harm severity.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="MEDIUM">MEDIUM</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html#MEDIUM">HarmSeverity.MEDIUM</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></pre>
+ <div class="api-item"><a name="getMEDIUM()"></a><a name="setMEDIUM()"></a><a name="getMEDIUM--"></a><a name="setMEDIUM--"></a>
+ <h3 class="api-name" id="MEDIUM()">MEDIUM</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.Companion.html#MEDIUM()">MEDIUM</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></pre>
<p>Medium level of harm severity.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="NEGLIGIBLE">NEGLIGIBLE</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html#NEGLIGIBLE">HarmSeverity.NEGLIGIBLE</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></pre>
+ <div class="api-item"><a name="getNEGLIGIBLE()"></a><a name="setNEGLIGIBLE()"></a><a name="getNEGLIGIBLE--"></a><a name="setNEGLIGIBLE--"></a>
+ <h3 class="api-name" id="NEGLIGIBLE()">NEGLIGIBLE</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.Companion.html#NEGLIGIBLE()">NEGLIGIBLE</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></pre>
<p>Severity for harm is negligible.</p>
</div>
- <div class="api-item">
- <h3 class="api-name" id="UNKNOWN">UNKNOWN</h3>
- <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html#UNKNOWN">HarmSeverity.UNKNOWN</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></pre>
+ <div class="api-item"><a name="getUNKNOWN()"></a><a name="setUNKNOWN()"></a><a name="getUNKNOWN--"></a><a name="setUNKNOWN--"></a>
+ <h3 class="api-name" id="UNKNOWN()">UNKNOWN</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.Companion.html#UNKNOWN()">UNKNOWN</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></pre>
<p>A new and not yet supported value.</p>
</div>
</div>
<div class="list">
- <h2>Public functions</h2>
- <div class="api-item"><a name="valueOf-kotlin.String-"></a><a name="valueof"></a>
- <h3 class="api-name" id="valueOf(kotlin.String)">valueOf</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html#valueOf(kotlin.String)">valueOf</a>(value: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></pre>
- <p>Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Throws</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>kotlin.IllegalArgumentException: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html">kotlin.IllegalArgumentException</a></code></td>
- <td>
- <p>if this enum type has no constant with the specified name</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="values--"></a><a name="values"></a>
- <h3 class="api-name" id="values()">values</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html#values()">values</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a>></pre>
- <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
- <p>This method may be used to iterate over the constants.</p>
+ <h2>Public properties</h2>
+ <div class="api-item"><a name="getOrdinal()"></a><a name="setOrdinal()"></a><a name="getOrdinal--"></a><a name="setOrdinal--"></a>
+ <h3 class="api-name" id="ordinal()">ordinal</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html#ordinal()">ordinal</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/package-summary.html 2024-10-04 17:26:34.398120158 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/package-summary.html 2024-10-04 17:24:16.311268561 +0000
@@ -32,6 +32,12 @@
</colgroup>
<tbody class="list">
<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>
+ </td>
+ </tr>
+ <tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Candidate.html">Candidate</a></code></td>
<td>
<p>A response generated by the model.</p>
@@ -74,6 +80,12 @@
</td>
</tr>
<tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
+ <td>
+ <p>The reason for content finishing.</p>
+ </td>
+ </tr>
+ <tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FunctionCall.html">FunctionCall</a></code></td>
<td>
<p>The data necessary to invoke function <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FunctionCall.html#name()">name</a></code> using the arguments <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FunctionCall.html#args()">args</a></code>.</p>
@@ -128,6 +140,36 @@
</td>
</tr>
<tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a></code></td>
+ <td>
+ <p>Specifies how the block method computes the score that will be compared against the <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code> in <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code>.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code></td>
+ <td>
+ <p>Represents the threshold for a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code> to be allowed by <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code>.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code></td>
+ <td>
+ <p>Category for a given harm rating.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code></td>
+ <td>
+ <p>Represents the probability that some <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code> is applicable in a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetyRating.html">SafetyRating</a></code>.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></code></td>
+ <td>
+ <p>Represents the severity of a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code> being applicable in a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetyRating.html">SafetyRating</a></code>.</p>
+ </td>
+ </tr>
+ <tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagePart.html">ImagePart</a></code></td>
<td>
<p>Represents image data sent to and received from requests.</p>
@@ -285,59 +327,6 @@
</td>
</tr>
</tbody>
- </table>
- </div>
- <h2>Enums</h2>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <tbody class="list">
- <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>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
- <td>
- <p>The reason for content finishing.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockMethod.html">HarmBlockMethod</a></code></td>
- <td>
- <p>Specifies how the block method computes the score that will be compared against the <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code> in <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code>.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmBlockThreshold.html">HarmBlockThreshold</a></code></td>
- <td>
- <p>Represents the threshold for a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code> to be allowed by <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code>.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code></td>
- <td>
- <p>Category for a given harm rating.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmProbability.html">HarmProbability</a></code></td>
- <td>
- <p>Represents the probability that some <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code> is applicable in a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetyRating.html">SafetyRating</a></code>.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmSeverity.html">HarmSeverity</a></code></td>
- <td>
- <p>Represents the severity of a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/HarmCategory.html">HarmCategory</a></code> being applicable in a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/SafetyRating.html">SafetyRating</a></code>.</p>
- </td>
- </tr>
- </tbody>
</table>
</div>
<h2>Top-level functions summary</h2> |
|
CI tests are broken |
…irebase/firebase-android-sdk into daymon-migrate-away-from-enums
rlazo
reviewed
Oct 3, 2024
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/internal/util/conversions.kt
Outdated
Show resolved
Hide resolved
rlazo
approved these changes
Oct 3, 2024
Test Results 18 files - 192 18 suites - 192 16s ⏱️ - 14m 56s Results for commit ad5566c. ± Comparison against base commit f761b2c. This pull request removes 1196 and adds 3 tests. Note that renamed tests count towards both. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Per b/370771226,
This refactors all our enums in vertex to be classes instead. While this means no more exhaustive
when, this allows us to add new values in the future without breaking the API.Since we (android) can only perform breaking changes [effectively] every six months, this will allow us to align with the [evolving] backend significantly faster.
This also adds a test to ensure the conversion layer is updated whenever any of these values are updated- since we no longer have the exhaustive
whento catch such cases.