update vertex javadocs to match what's live #6149
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Javadoc Changes:--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/GenerationConfig.html 2024-08-01 18:37:30.672455161 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/GenerationConfig.html 2024-08-01 18:35:27.743356257 +0000
@@ -69,14 +69,14 @@
<td><code>final <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#responseMimeType()">responseMimeType</a></code></div>
- <p>Response type for generated candidate text.</p>
+ <p>Response MIME type for the generated candidate text.</p>
</td>
</tr>
<tr>
<td><code>final <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> ?></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#responseSchema()">responseSchema</a></code></div>
- <p>A schema that the response must adhere to, used with the <code>application/json</code> mimeType.</p>
+ <p>A schema that the response must adhere to, used with the <code>application/json</code> MINE type.</p>
</td>
</tr>
<tr>
@@ -125,12 +125,12 @@
<div class="api-item"><a name="getResponseMimeType()"></a><a name="setResponseMimeType()"></a><a name="getResponseMimeType--"></a><a name="setResponseMimeType--"></a>
<h3 class="api-name" id="responseMimeType()">responseMimeType</h3>
<pre class="api-signature no-pretty-print">public final <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#responseMimeType()">responseMimeType</a></pre>
- <p>Response type for generated candidate text. See the <a href="https://cloud.google.com/vertex-ai/docs/reference/rest/v1beta1/GenerationConfig">vertex docs</a> for a list of supported types.</p>
+ <p>Response MIME type for the generated candidate text. For a list of supported response MIME types, see the <a href="https://cloud.google.com/vertex-ai/docs/reference/rest/v1beta1/GenerationConfig#FIELDS.response_mime_type">Vertex AI documentation</a> for a list of supported types.</p>
</div>
<div class="api-item"><a name="getResponseSchema()"></a><a name="setResponseSchema()"></a><a name="getResponseSchema--"></a><a name="setResponseSchema--"></a>
<h3 class="api-name" id="responseSchema()">responseSchema</h3>
<pre class="api-signature no-pretty-print">public final <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> ?> <a href="/docs/reference/android/com/google/firebase/vertexai/type/GenerationConfig.html#responseSchema()">responseSchema</a></pre>
- <p>A schema that the response must adhere to, used with the <code>application/json</code> mimeType.</p>
+ <p>A schema that the response must adhere to, used with the <code>application/json</code> MINE type.</p>
</div>
<div class="api-item"><a name="getStopSequences()"></a><a name="setStopSequences()"></a><a name="getStopSequences--"></a><a name="setStopSequences--"></a>
<h3 class="api-name" id="stopSequences()">stopSequences</h3>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html 2024-08-01 18:37:30.664455092 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html 2024-08-01 18:35:27.735356180 +0000
@@ -86,14 +86,14 @@
<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/GenerationConfig.html#responseMimeType()">responseMimeType</a></code></div>
- <p>Response type for generated candidate text.</p>
+ <p>Response MIME type for the generated candidate text.</p>
</td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a><*>?</code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#responseSchema()">responseSchema</a></code></div>
- <p>A schema that the response must adhere to, used with the <code>application/json</code> mimeType.</p>
+ <p>A schema that the response must adhere to, used with the <code>application/json</code> MINE type.</p>
</td>
</tr>
<tr>
@@ -151,12 +151,12 @@
<div class="api-item"><a name="getResponseMimeType()"></a><a name="setResponseMimeType()"></a><a name="getResponseMimeType--"></a><a name="setResponseMimeType--"></a>
<h3 class="api-name" id="responseMimeType()">responseMimeType</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#responseMimeType()">responseMimeType</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?</pre>
- <p>Response type for generated candidate text. See the <a href="https://cloud.google.com/vertex-ai/docs/reference/rest/v1beta1/GenerationConfig">vertex docs</a> for a list of supported types.</p>
+ <p>Response MIME type for the generated candidate text. For a list of supported response MIME types, see the <a href="https://cloud.google.com/vertex-ai/docs/reference/rest/v1beta1/GenerationConfig#FIELDS.response_mime_type">Vertex AI documentation</a> for a list of supported types.</p>
</div>
<div class="api-item"><a name="getResponseSchema()"></a><a name="setResponseSchema()"></a><a name="getResponseSchema--"></a><a name="setResponseSchema--"></a>
<h3 class="api-name" id="responseSchema()">responseSchema</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/GenerationConfig.html#responseSchema()">responseSchema</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a><*>?</pre>
- <p>A schema that the response must adhere to, used with the <code>application/json</code> mimeType.</p>
+ <p>A schema that the response must adhere to, used with the <code>application/json</code> MINE type.</p>
</div>
<div class="api-item"><a name="getStopSequences()"></a><a name="setStopSequences()"></a><a name="getStopSequences--"></a><a name="setStopSequences--"></a>
<h3 class="api-name" id="stopSequences()">stopSequences</h3> |
Generated by 🚫 Danger |
Coverage Report 1Affected ProductsNo changes between base commit (99a9d93) and merge commit (c1db585).Test Logs |
VinayGuthal
approved these changes
Aug 1, 2024
Unit Test Results 4 files - 4 4 suites - 4 3s ⏱️ -23s Results for commit 99d9eb5. ± Comparison against base commit 99a9d93. This pull request removes 22 and adds 50 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
Size Report 1Affected ProductsTest Logs |
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.
No description provided.