Improved refdocs for Schema #6420
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
The improvements include: - Clarify that `integer` and `float` types are hints to the model, and the returned data could potentially overflow the respective native types. - Include missing parameters for some of the functions. - Add examples for `enumerations` and `obj`
Javadoc Changes:--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/Schema.Companion.html 2024-11-01 16:12:48.517033544 +0000 +++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/Schema.Companion.html 2024-11-01 16:10:43.394591397 +0000 @@ -28,63 +28,63 @@ <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/Schema.html">Schema</a></code></td> <td> <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#array(com.google.firebase.vertexai.type.Schema,kotlin.String,kotlin.Boolean)">array</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/Schema.html">Schema</a> items, <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</code></div> - <p>Returns a schema for an array.</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for an array.</p> </td> </tr> <tr> <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/Schema.html">Schema</a></code></td> <td> <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#boolean(kotlin.String,kotlin.Boolean)">boolean</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</code></div> - <p>Returns a schema for a boolean</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> representing a boolean value.</p> </td> </tr> <tr> <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/Schema.html">Schema</a></code></td> <td> <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#enumeration(kotlin.collections.List,kotlin.String,kotlin.Boolean)">enumeration</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>> values,<br> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description,<br> boolean nullable<br>)</code></div> - <p>Returns a schema for an enumeration</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for an enumeration.</p> </td> </tr> <tr> <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/Schema.html">Schema</a></code></td> <td> <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#numDouble(kotlin.String,kotlin.Boolean)">numDouble</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</code></div> - <p>Returns a schema for a floating point number</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a double-precision floating-point number.</p> </td> </tr> <tr> <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/Schema.html">Schema</a></code></td> <td> <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#numFloat(kotlin.String,kotlin.Boolean)">numFloat</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</code></div> - <p>Returns a schema for a floating point number</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a single-precision floating-point number.</p> </td> </tr> <tr> <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/Schema.html">Schema</a></code></td> <td> <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#numInt(kotlin.String,kotlin.Boolean)">numInt</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</code></div> - <p>Returns a schema for a 32-bit integer number</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a 32-bit signed integer number.</p> </td> </tr> <tr> <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/Schema.html">Schema</a></code></td> <td> <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#numLong(kotlin.String,kotlin.Boolean)">numLong</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</code></div> - <p>Returns a schema for a 64-bit integer number</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a 64-bit signed integer number.</p> </td> </tr> <tr> <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/Schema.html">Schema</a></code></td> <td> <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#obj(kotlin.collections.Map,kotlin.collections.List,kotlin.String,kotlin.Boolean)">obj</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/Map.html">Map</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>, @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a>> properties,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>> optionalProperties,<br> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description,<br> boolean nullable<br>)</code></div> - <p>Returns a schema for a complex object.</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a complex data type.</p> </td> </tr> <tr> <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/Schema.html">Schema</a></code></td> <td> <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#str(kotlin.String,kotlin.Boolean,com.google.firebase.vertexai.type.StringFormat)">str</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable, <a href="/docs/reference/android/com/google/firebase/vertexai/type/StringFormat.html">StringFormat</a> format)</code></div> - <p>Returns a schema for a string</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a string.</p> </td> </tr> </tbody> @@ -95,7 +95,7 @@ <div class="api-item"><a name="array(com.google.firebase.vertexai.type.Schema, kotlin.String, kotlin.Boolean)"></a><a name="array-com.google.firebase.vertexai.type.Schema-kotlin.String-kotlin.Boolean-"></a><a name="array"></a> <h3 class="api-name" id="array(com.google.firebase.vertexai.type.Schema,kotlin.String,kotlin.Boolean)">array</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/Schema.html">Schema</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#array(com.google.firebase.vertexai.type.Schema,kotlin.String,kotlin.Boolean)">array</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/Schema.html">Schema</a> items, <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</pre> - <p>Returns a schema for an array.</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for an array.</p> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -111,19 +111,19 @@ <tr> <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a> items</code></td> <td> - <p>: The schema of the elements of this array</p> + <p>The <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> of the elements stored in the array.</p> </td> </tr> <tr> <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>An optional description of what the array represents.</p> </td> </tr> <tr> <td><code>boolean nullable</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> </tbody> @@ -133,12 +133,41 @@ <div class="api-item"><a name="boolean(kotlin.String, kotlin.Boolean)"></a><a name="boolean-kotlin.String-kotlin.Boolean-"></a><a name="boolean"></a> <h3 class="api-name" id="boolean(kotlin.String,kotlin.Boolean)">boolean</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/Schema.html">Schema</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#boolean(kotlin.String,kotlin.Boolean)">boolean</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</pre> - <p>Returns a schema for a boolean</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> representing a boolean value.</p> + <div class="devsite-table-wrapper"> + <table class="responsive"> + <colgroup> + <col width="40%"> + <col> + </colgroup> + <thead> + <tr> + <th colspan="100%">Parameters</th> + </tr> + </thead> + <tbody class="list"> + <tr> + <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description</code></td> + <td> + <p>An optional description of what the boolean should contain or represent.</p> + </td> + </tr> + <tr> + <td><code>boolean nullable</code></td> + <td> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> + </td> + </tr> + </tbody> + </table> + </div> </div> <div class="api-item"><a name="enumeration(kotlin.collections.List, kotlin.String, kotlin.Boolean)"></a><a name="enumeration-kotlin.collections.List-kotlin.String-kotlin.Boolean-"></a><a name="enumeration"></a> <h3 class="api-name" id="enumeration(kotlin.collections.List,kotlin.String,kotlin.Boolean)">enumeration</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/Schema.html">Schema</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#enumeration(kotlin.collections.List,kotlin.String,kotlin.Boolean)">enumeration</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>> values,<br> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description,<br> boolean nullable<br>)</pre> - <p>Returns a schema for an enumeration</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for an enumeration.</p> + <p>For example, the cardinal directions can be represented as:</p> + <pre class="prettyprint">Schema.enumeration(listOf("north", "east", "south", "west"), "Cardinal directions")</pre> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -154,19 +183,19 @@ <tr> <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>> values</code></td> <td> - <p>: The list of valid values for this enumeration</p> + <p>The list of valid values for this enumeration</p> </td> </tr> <tr> <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>The description of what the parameter should contain or represent</p> </td> </tr> <tr> <td><code>boolean nullable</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> </tbody> @@ -176,7 +205,7 @@ <div class="api-item"><a name="numDouble(kotlin.String, kotlin.Boolean)"></a><a name="numDouble-kotlin.String-kotlin.Boolean-"></a><a name="numdouble"></a> <h3 class="api-name" id="numDouble(kotlin.String,kotlin.Boolean)">numDouble</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/Schema.html">Schema</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#numDouble(kotlin.String,kotlin.Boolean)">numDouble</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</pre> - <p>Returns a schema for a floating point number</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a double-precision floating-point number.</p> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -192,13 +221,13 @@ <tr> <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>An optional description of what the number should contain or represent.</p> </td> </tr> <tr> <td><code>boolean nullable</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> </tbody> @@ -208,7 +237,8 @@ <div class="api-item"><a name="numFloat(kotlin.String, kotlin.Boolean)"></a><a name="numFloat-kotlin.String-kotlin.Boolean-"></a><a name="numfloat"></a> <h3 class="api-name" id="numFloat(kotlin.String,kotlin.Boolean)">numFloat</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/Schema.html">Schema</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#numFloat(kotlin.String,kotlin.Boolean)">numFloat</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</pre> - <p>Returns a schema for a floating point number</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a single-precision floating-point number.</p> + <p><b>Important:</b> This <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> provides a hint to the model that it should generate a single-precision floating-point number, but only guarantees that the value will be a number. Therefore it's <em>possible</em> that decoding it as a <code>Float</code> variable (or <code>float</code> in Java) could overflow.</p> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -224,13 +254,13 @@ <tr> <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>An optional description of what the number should contain or represent.</p> </td> </tr> <tr> <td><code>boolean nullable</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> </tbody> @@ -240,7 +270,8 @@ <div class="api-item"><a name="numInt(kotlin.String, kotlin.Boolean)"></a><a name="numInt-kotlin.String-kotlin.Boolean-"></a><a name="numint"></a> <h3 class="api-name" id="numInt(kotlin.String,kotlin.Boolean)">numInt</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/Schema.html">Schema</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#numInt(kotlin.String,kotlin.Boolean)">numInt</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</pre> - <p>Returns a schema for a 32-bit integer number</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a 32-bit signed integer number.</p> + <p><b>Important:</b> This <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> provides a hint to the model that it should generate a 32-bit integer, but only guarantees that the value will be an integer. Therefore it's <em>possible</em> that decoding it as an <code>Int</code> variable (or <code>int</code> in Java) could overflow.</p> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -256,13 +287,13 @@ <tr> <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>An optional description of what the integer should contain or represent.</p> </td> </tr> <tr> <td><code>boolean nullable</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> </tbody> @@ -272,7 +303,7 @@ <div class="api-item"><a name="numLong(kotlin.String, kotlin.Boolean)"></a><a name="numLong-kotlin.String-kotlin.Boolean-"></a><a name="numlong"></a> <h3 class="api-name" id="numLong(kotlin.String,kotlin.Boolean)">numLong</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/Schema.html">Schema</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#numLong(kotlin.String,kotlin.Boolean)">numLong</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</pre> - <p>Returns a schema for a 64-bit integer number</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a 64-bit signed integer number.</p> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -288,13 +319,13 @@ <tr> <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>An optional description of what the number should contain or represent.</p> </td> </tr> <tr> <td><code>boolean nullable</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> </tbody> @@ -304,7 +335,10 @@ <div class="api-item"><a name="obj(kotlin.collections.Map, kotlin.collections.List, kotlin.String, kotlin.Boolean)"></a><a name="obj-kotlin.collections.Map-kotlin.collections.List-kotlin.String-kotlin.Boolean-"></a><a name="obj"></a> <h3 class="api-name" id="obj(kotlin.collections.Map,kotlin.collections.List,kotlin.String,kotlin.Boolean)">obj</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/Schema.html">Schema</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#obj(kotlin.collections.Map,kotlin.collections.List,kotlin.String,kotlin.Boolean)">obj</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/Map.html">Map</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>, @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a>> properties,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>> optionalProperties,<br> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description,<br> boolean nullable<br>)</pre> - <p>Returns a schema for a complex object. In a function, it will be returned as a JSONObject.</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a complex data type.</p> + <p>This schema instructs the model to produce data of type object, which has keys of type <code>String</code> and values of type <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code>.</p> + <p><b>Example:</b> A <code>city</code> could be represented with the following object <code>Schema</code>.</p> + <pre class="prettyprint">Schema.obj(mapOf(<br> "name" to Schema.string(),<br> "population" to Schema.integer()<br>))</pre> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -320,19 +354,25 @@ <tr> <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/Map.html">Map</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>, @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a>> properties</code></td> <td> - <p>: The map of the object's fields to their schema</p> + <p>The map of the object's property names to their <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code>s.</p> + </td> + </tr> + <tr> + <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>> optionalProperties</code></td> + <td> + <p>The list of optional properties. They must correspond to the keys provided in the <code>properties</code> map. By default it's empty, signaling the model that all properties are to be included.</p> </td> </tr> <tr> <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>An optional description of what the object represents.</p> </td> </tr> <tr> <td><code>boolean nullable</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> </tbody> @@ -342,7 +382,7 @@ <div class="api-item"><a name="str(kotlin.String, kotlin.Boolean, com.google.firebase.vertexai.type.StringFormat)"></a><a name="str-kotlin.String-kotlin.Boolean-com.google.firebase.vertexai.type.StringFormat-"></a><a name="str"></a> <h3 class="api-name" id="str(kotlin.String,kotlin.Boolean,com.google.firebase.vertexai.type.StringFormat)">str</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/Schema.html">Schema</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#str(kotlin.String,kotlin.Boolean,com.google.firebase.vertexai.type.StringFormat)">str</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable, <a href="/docs/reference/android/com/google/firebase/vertexai/type/StringFormat.html">StringFormat</a> format)</pre> - <p>Returns a schema for a string</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a string.</p> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -358,19 +398,19 @@ <tr> <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>An optional description of what the string should contain or represent.</p> </td> </tr> <tr> <td><code>boolean nullable</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> <tr> <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/StringFormat.html">StringFormat</a> format</code></td> <td> - <p>: The pattern that values need to adhere to</p> + <p>An optional pattern that values need to adhere to.</p> </td> </tr> </tbody>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/Schema.html 2024-11-01 16:12:48.513033458 +0000 +++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/Schema.html 2024-11-01 16:10:43.390591330 +0000 @@ -11,7 +11,9 @@ <pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></pre> </p> <hr> - <p>Represents a schema</p> + <p>Definition of a data type.</p> + <p>These types can be objects, but also primitives and arrays. Represents a select subset of an <a href="https://spec.openapis.org/oas/v3.0.3#schema">OpenAPI 3.0 schema object</a>.</p> + <p><b>Note:</b> While optional, including a <code>description</code> field in your <code>Schema</code> is strongly encouraged. The more information the model has about what it's expected to generate, the better the results.</p> <h2>Summary</h2> <div class="devsite-table-wrapper"> <table class="responsive"> @@ -112,63 +114,63 @@ <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/Schema.html">Schema</a></code></td> <td> <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#array(com.google.firebase.vertexai.type.Schema,kotlin.String,kotlin.Boolean)">array</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/Schema.html">Schema</a> items, <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</code></div> - <p>Returns a schema for an array.</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for an array.</p> </td> </tr> <tr> <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/Schema.html">Schema</a></code></td> <td> <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#boolean(kotlin.String,kotlin.Boolean)">boolean</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</code></div> - <p>Returns a schema for a boolean</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> representing a boolean value.</p> </td> </tr> <tr> <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/Schema.html">Schema</a></code></td> <td> <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#double(kotlin.String,kotlin.Boolean)">double</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</code></div> - <p>Returns a schema for a floating point number</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a double-precision floating-point number.</p> </td> </tr> <tr> <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/Schema.html">Schema</a></code></td> <td> <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#enumeration(kotlin.collections.List,kotlin.String,kotlin.Boolean)">enumeration</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>> values,<br> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description,<br> boolean nullable<br>)</code></div> - <p>Returns a schema for an enumeration</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for an enumeration.</p> </td> </tr> <tr> <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/Schema.html">Schema</a></code></td> <td> <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#float(kotlin.String,kotlin.Boolean)">float</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</code></div> - <p>Returns a schema for a floating point number</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a single-precision floating-point number.</p> </td> </tr> <tr> <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/Schema.html">Schema</a></code></td> <td> <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#integer(kotlin.String,kotlin.Boolean)">integer</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</code></div> - <p>Returns a schema for a 32-bit integer number</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a 32-bit signed integer number.</p> </td> </tr> <tr> <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/Schema.html">Schema</a></code></td> <td> <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#long(kotlin.String,kotlin.Boolean)">long</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</code></div> - <p>Returns a schema for a 64-bit integer number</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a 64-bit signed integer number.</p> </td> </tr> <tr> <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/Schema.html">Schema</a></code></td> <td> <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#obj(kotlin.collections.Map,kotlin.collections.List,kotlin.String,kotlin.Boolean)">obj</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/Map.html">Map</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>, @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a>> properties,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>> optionalProperties,<br> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description,<br> boolean nullable<br>)</code></div> - <p>Returns a schema for a complex object.</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a complex data type.</p> </td> </tr> <tr> <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/Schema.html">Schema</a></code></td> <td> <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#string(kotlin.String,kotlin.Boolean,com.google.firebase.vertexai.type.StringFormat)">string</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable, <a href="/docs/reference/android/com/google/firebase/vertexai/type/StringFormat.html">StringFormat</a> format)</code></div> - <p>Returns a schema for a string</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a string.</p> </td> </tr> </tbody> @@ -214,7 +216,7 @@ <div class="api-item"><a name="array(com.google.firebase.vertexai.type.Schema, kotlin.String, kotlin.Boolean)"></a><a name="array-com.google.firebase.vertexai.type.Schema-kotlin.String-kotlin.Boolean-"></a><a name="array"></a> <h3 class="api-name" id="array(com.google.firebase.vertexai.type.Schema,kotlin.String,kotlin.Boolean)">array</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/Schema.html">Schema</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#array(com.google.firebase.vertexai.type.Schema,kotlin.String,kotlin.Boolean)">array</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/Schema.html">Schema</a> items, <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</pre> - <p>Returns a schema for an array.</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for an array.</p> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -230,19 +232,19 @@ <tr> <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a> items</code></td> <td> - <p>: The schema of the elements of this array</p> + <p>The <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> of the elements stored in the array.</p> </td> </tr> <tr> <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>An optional description of what the array represents.</p> </td> </tr> <tr> <td><code>boolean nullable</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> </tbody> @@ -252,12 +254,39 @@ <div class="api-item"><a name="boolean(kotlin.String, kotlin.Boolean)"></a><a name="boolean-kotlin.String-kotlin.Boolean-"></a><a name="boolean"></a> <h3 class="api-name" id="boolean(kotlin.String,kotlin.Boolean)">boolean</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/Schema.html">Schema</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#boolean(kotlin.String,kotlin.Boolean)">boolean</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</pre> - <p>Returns a schema for a boolean</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> representing a boolean value.</p> + <div class="devsite-table-wrapper"> + <table class="responsive"> + <colgroup> + <col width="40%"> + <col> + </colgroup> + <thead> + <tr> + <th colspan="100%">Parameters</th> + </tr> + </thead> + <tbody class="list"> + <tr> + <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description</code></td> + <td> + <p>An optional description of what the boolean should contain or represent.</p> + </td> + </tr> + <tr> + <td><code>boolean nullable</code></td> + <td> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> + </td> + </tr> + </tbody> + </table> + </div> </div> <div class="api-item"><a name="double(kotlin.String, kotlin.Boolean)"></a><a name="double-kotlin.String-kotlin.Boolean-"></a><a name="double"></a> <h3 class="api-name" id="double(kotlin.String,kotlin.Boolean)">double</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/Schema.html">Schema</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#double(kotlin.String,kotlin.Boolean)">double</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</pre> - <p>Returns a schema for a floating point number</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a double-precision floating-point number.</p> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -273,13 +302,13 @@ <tr> <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>An optional description of what the number should contain or represent.</p> </td> </tr> <tr> <td><code>boolean nullable</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> </tbody> @@ -289,7 +318,9 @@ <div class="api-item"><a name="enumeration(kotlin.collections.List, kotlin.String, kotlin.Boolean)"></a><a name="enumeration-kotlin.collections.List-kotlin.String-kotlin.Boolean-"></a><a name="enumeration"></a> <h3 class="api-name" id="enumeration(kotlin.collections.List,kotlin.String,kotlin.Boolean)">enumeration</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/Schema.html">Schema</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#enumeration(kotlin.collections.List,kotlin.String,kotlin.Boolean)">enumeration</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>> values,<br> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description,<br> boolean nullable<br>)</pre> - <p>Returns a schema for an enumeration</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for an enumeration.</p> + <p>For example, the cardinal directions can be represented as:</p> + <pre class="prettyprint">Schema.enumeration(listOf("north", "east", "south", "west"), "Cardinal directions")</pre> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -305,19 +336,19 @@ <tr> <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>> values</code></td> <td> - <p>: The list of valid values for this enumeration</p> + <p>The list of valid values for this enumeration</p> </td> </tr> <tr> <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>The description of what the parameter should contain or represent</p> </td> </tr> <tr> <td><code>boolean nullable</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> </tbody> @@ -327,7 +358,8 @@ <div class="api-item"><a name="float(kotlin.String, kotlin.Boolean)"></a><a name="float-kotlin.String-kotlin.Boolean-"></a><a name="float"></a> <h3 class="api-name" id="float(kotlin.String,kotlin.Boolean)">float</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/Schema.html">Schema</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#float(kotlin.String,kotlin.Boolean)">float</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</pre> - <p>Returns a schema for a floating point number</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a single-precision floating-point number.</p> + <p><b>Important:</b> This <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> provides a hint to the model that it should generate a single-precision floating-point number, but only guarantees that the value will be a number. Therefore it's <em>possible</em> that decoding it as a <code>Float</code> variable (or <code>float</code> in Java) could overflow.</p> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -343,13 +375,13 @@ <tr> <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>An optional description of what the number should contain or represent.</p> </td> </tr> <tr> <td><code>boolean nullable</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> </tbody> @@ -359,7 +391,8 @@ <div class="api-item"><a name="integer(kotlin.String, kotlin.Boolean)"></a><a name="integer-kotlin.String-kotlin.Boolean-"></a><a name="integer"></a> <h3 class="api-name" id="integer(kotlin.String,kotlin.Boolean)">integer</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/Schema.html">Schema</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#integer(kotlin.String,kotlin.Boolean)">integer</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</pre> - <p>Returns a schema for a 32-bit integer number</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a 32-bit signed integer number.</p> + <p><b>Important:</b> This <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> provides a hint to the model that it should generate a 32-bit integer, but only guarantees that the value will be an integer. Therefore it's <em>possible</em> that decoding it as an <code>Int</code> variable (or <code>int</code> in Java) could overflow.</p> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -375,13 +408,13 @@ <tr> <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>An optional description of what the integer should contain or represent.</p> </td> </tr> <tr> <td><code>boolean nullable</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> </tbody> @@ -391,7 +424,7 @@ <div class="api-item"><a name="long(kotlin.String, kotlin.Boolean)"></a><a name="long-kotlin.String-kotlin.Boolean-"></a><a name="long"></a> <h3 class="api-name" id="long(kotlin.String,kotlin.Boolean)">long</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/Schema.html">Schema</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#long(kotlin.String,kotlin.Boolean)">long</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable)</pre> - <p>Returns a schema for a 64-bit integer number</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a 64-bit signed integer number.</p> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -407,13 +440,13 @@ <tr> <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>An optional description of what the number should contain or represent.</p> </td> </tr> <tr> <td><code>boolean nullable</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> </tbody> @@ -423,7 +456,10 @@ <div class="api-item"><a name="obj(kotlin.collections.Map, kotlin.collections.List, kotlin.String, kotlin.Boolean)"></a><a name="obj-kotlin.collections.Map-kotlin.collections.List-kotlin.String-kotlin.Boolean-"></a><a name="obj"></a> <h3 class="api-name" id="obj(kotlin.collections.Map,kotlin.collections.List,kotlin.String,kotlin.Boolean)">obj</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/Schema.html">Schema</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#obj(kotlin.collections.Map,kotlin.collections.List,kotlin.String,kotlin.Boolean)">obj</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/Map.html">Map</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>, @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a>> properties,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>> optionalProperties,<br> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description,<br> boolean nullable<br>)</pre> - <p>Returns a schema for a complex object. In a function, it will be returned as a JSONObject.</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a complex data type.</p> + <p>This schema instructs the model to produce data of type object, which has keys of type <code>String</code> and values of type <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code>.</p> + <p><b>Example:</b> A <code>city</code> could be represented with the following object <code>Schema</code>.</p> + <pre class="prettyprint">Schema.obj(mapOf(<br> "name" to Schema.string(),<br> "population" to Schema.integer()<br>))</pre> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -439,19 +475,25 @@ <tr> <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/Map.html">Map</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>, @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a>> properties</code></td> <td> - <p>: The map of the object's fields to their schema</p> + <p>The map of the object's property names to their <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code>s.</p> + </td> + </tr> + <tr> + <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>> optionalProperties</code></td> + <td> + <p>The list of optional properties. They must correspond to the keys provided in the <code>properties</code> map. By default it's empty, signaling the model that all properties are to be included.</p> </td> </tr> <tr> <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>An optional description of what the object represents.</p> </td> </tr> <tr> <td><code>boolean nullable</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> </tbody> @@ -461,7 +503,7 @@ <div class="api-item"><a name="string(kotlin.String, kotlin.Boolean, com.google.firebase.vertexai.type.StringFormat)"></a><a name="string-kotlin.String-kotlin.Boolean-com.google.firebase.vertexai.type.StringFormat-"></a><a name="string"></a> <h3 class="api-name" id="string(kotlin.String,kotlin.Boolean,com.google.firebase.vertexai.type.StringFormat)">string</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/Schema.html">Schema</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.Companion.html#string(kotlin.String,kotlin.Boolean,com.google.firebase.vertexai.type.StringFormat)">string</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description, boolean nullable, <a href="/docs/reference/android/com/google/firebase/vertexai/type/StringFormat.html">StringFormat</a> format)</pre> - <p>Returns a schema for a string</p> + <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a string.</p> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -477,19 +519,19 @@ <tr> <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> description</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>An optional description of what the string should contain or represent.</p> </td> </tr> <tr> <td><code>boolean nullable</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> <tr> <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/StringFormat.html">StringFormat</a> format</code></td> <td> - <p>: The pattern that values need to adhere to</p> + <p>An optional pattern that values need to adhere to.</p> </td> </tr> </tbody>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/package-summary.html 2024-11-01 16:12:48.517033544 +0000 +++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/package-summary.html 2024-11-01 16:10:43.390591330 +0000 @@ -208,7 +208,7 @@ <tr> <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Schema.html">Schema</a></code></td> <td> - <p>Represents a schema</p> + <p>Definition of a data type.</p> </td> </tr> <tr>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/Schema.html 2024-11-01 16:12:48.505033283 +0000 +++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/Schema.html 2024-11-01 16:10:43.382591195 +0000 @@ -11,7 +11,9 @@ <pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></pre> </p> <hr> - <p>Represents a schema</p> + <p>Definition of a data type.</p> + <p>These types can be objects, but also primitives and arrays. Represents a select subset of an <a href="https://spec.openapis.org/oas/v3.0.3#schema">OpenAPI 3.0 schema object</a>.</p> + <p><b>Note:</b> While optional, including a <code>description</code> field in your <code>Schema</code> is strongly encouraged. The more information the model has about what it's expected to generate, the better the results.</p> <h2>Summary</h2> <div class="devsite-table-wrapper"> <table class="responsive"> @@ -29,63 +31,63 @@ <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/Schema.Companion.html#array(com.google.firebase.vertexai.type.Schema,kotlin.String,kotlin.Boolean)">array</a>(items: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a>, description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?, nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>)</code></div> - <p>Returns a schema for an array.</p> + <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for an array.</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/Schema.Companion.html#boolean(kotlin.String,kotlin.Boolean)">boolean</a>(description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?, nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>)</code></div> - <p>Returns a schema for a boolean</p> + <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> representing a boolean value.</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/Schema.Companion.html#double(kotlin.String,kotlin.Boolean)">double</a>(description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?, nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>)</code></div> - <p>Returns a schema for a floating point number</p> + <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a double-precision floating-point number.</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/Schema.Companion.html#enumeration(kotlin.collections.List,kotlin.String,kotlin.Boolean)">enumeration</a>(values: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>>, description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?, nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>)</code></div> - <p>Returns a schema for an enumeration</p> + <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for an enumeration.</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/Schema.Companion.html#float(kotlin.String,kotlin.Boolean)">float</a>(description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?, nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>)</code></div> - <p>Returns a schema for a floating point number</p> + <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a single-precision floating-point number.</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/Schema.Companion.html#integer(kotlin.String,kotlin.Boolean)">integer</a>(description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?, nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>)</code></div> - <p>Returns a schema for a 32-bit integer number</p> + <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a 32-bit signed integer number.</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/Schema.Companion.html#long(kotlin.String,kotlin.Boolean)">long</a>(description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?, nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>)</code></div> - <p>Returns a schema for a 64-bit integer number</p> + <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a 64-bit signed integer number.</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/Schema.Companion.html#obj(kotlin.collections.Map,kotlin.collections.List,kotlin.String,kotlin.Boolean)">obj</a>(<br> properties: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><<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/Schema.html">Schema</a>>,<br> optionalProperties: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>>,<br> description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?,<br> nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><br>)</code></div> - <p>Returns a schema for a complex object.</p> + <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a complex data type.</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/Schema.Companion.html#string(kotlin.String,kotlin.Boolean,com.google.firebase.vertexai.type.StringFormat)">string</a>(description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?, nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>, format: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/StringFormat.html">StringFormat</a>?)</code></div> - <p>Returns a schema for a string</p> + <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a string.</p> </td> </tr> </tbody> @@ -159,7 +161,7 @@ <div class="api-item"><a name="array(com.google.firebase.vertexai.type.Schema, kotlin.String, kotlin.Boolean)"></a><a name="array-com.google.firebase.vertexai.type.Schema-kotlin.String-kotlin.Boolean-"></a><a name="array"></a> <h3 class="api-name" id="array(com.google.firebase.vertexai.type.Schema,kotlin.String,kotlin.Boolean)">array</h3> <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.Companion.html#array(com.google.firebase.vertexai.type.Schema,kotlin.String,kotlin.Boolean)">array</a>(items: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a>, description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null, nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></pre> - <p>Returns a schema for an array.</p> + <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for an array.</p> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -175,19 +177,19 @@ <tr> <td><code>items: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code></td> <td> - <p>: The schema of the elements of this array</p> + <p>The <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> of the elements stored in the array.</p> </td> </tr> <tr> <td><code>description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>An optional description of what the array represents.</p> </td> </tr> <tr> <td><code>nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> </tbody> @@ -197,12 +199,39 @@ <div class="api-item"><a name="boolean(kotlin.String, kotlin.Boolean)"></a><a name="boolean-kotlin.String-kotlin.Boolean-"></a><a name="boolean"></a> <h3 class="api-name" id="boolean(kotlin.String,kotlin.Boolean)">boolean</h3> <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.Companion.html#boolean(kotlin.String,kotlin.Boolean)">boolean</a>(description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null, nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></pre> - <p>Returns a schema for a boolean</p> + <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> representing a boolean value.</p> + <div class="devsite-table-wrapper"> + <table class="responsive"> + <colgroup> + <col width="40%"> + <col> + </colgroup> + <thead> + <tr> + <th colspan="100%">Parameters</th> + </tr> + </thead> + <tbody class="list"> + <tr> + <td><code>description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null</code></td> + <td> + <p>An optional description of what the boolean should contain or represent.</p> + </td> + </tr> + <tr> + <td><code>nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false</code></td> + <td> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> + </td> + </tr> + </tbody> + </table> + </div> </div> <div class="api-item"><a name="double(kotlin.String, kotlin.Boolean)"></a><a name="double-kotlin.String-kotlin.Boolean-"></a><a name="double"></a> <h3 class="api-name" id="double(kotlin.String,kotlin.Boolean)">double</h3> <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.Companion.html#double(kotlin.String,kotlin.Boolean)">double</a>(description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null, nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></pre> - <p>Returns a schema for a floating point number</p> + <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a double-precision floating-point number.</p> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -218,13 +247,13 @@ <tr> <td><code>description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>An optional description of what the number should contain or represent.</p> </td> </tr> <tr> <td><code>nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> </tbody> @@ -234,7 +263,9 @@ <div class="api-item"><a name="enumeration(kotlin.collections.List, kotlin.String, kotlin.Boolean)"></a><a name="enumeration-kotlin.collections.List-kotlin.String-kotlin.Boolean-"></a><a name="enumeration"></a> <h3 class="api-name" id="enumeration(kotlin.collections.List,kotlin.String,kotlin.Boolean)">enumeration</h3> <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.Companion.html#enumeration(kotlin.collections.List,kotlin.String,kotlin.Boolean)">enumeration</a>(<br> values: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>>,<br> description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null,<br> nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false<br>): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></pre> - <p>Returns a schema for an enumeration</p> + <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for an enumeration.</p> + <p>For example, the cardinal directions can be represented as:</p> + <pre class="prettyprint">Schema.enumeration(listOf("north", "east", "south", "west"), "Cardinal directions")</pre> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -250,19 +281,19 @@ <tr> <td><code>values: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>></code></td> <td> - <p>: The list of valid values for this enumeration</p> + <p>The list of valid values for this enumeration</p> </td> </tr> <tr> <td><code>description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>The description of what the parameter should contain or represent</p> </td> </tr> <tr> <td><code>nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> </tbody> @@ -272,7 +303,8 @@ <div class="api-item"><a name="float(kotlin.String, kotlin.Boolean)"></a><a name="float-kotlin.String-kotlin.Boolean-"></a><a name="float"></a> <h3 class="api-name" id="float(kotlin.String,kotlin.Boolean)">float</h3> <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.Companion.html#float(kotlin.String,kotlin.Boolean)">float</a>(description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null, nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></pre> - <p>Returns a schema for a floating point number</p> + <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a single-precision floating-point number.</p> + <p><b>Important:</b> This <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> provides a hint to the model that it should generate a single-precision floating-point number, but only guarantees that the value will be a number. Therefore it's <em>possible</em> that decoding it as a <code>Float</code> variable (or <code>float</code> in Java) could overflow.</p> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -288,13 +320,13 @@ <tr> <td><code>description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>An optional description of what the number should contain or represent.</p> </td> </tr> <tr> <td><code>nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> </tbody> @@ -304,7 +336,8 @@ <div class="api-item"><a name="integer(kotlin.String, kotlin.Boolean)"></a><a name="integer-kotlin.String-kotlin.Boolean-"></a><a name="integer"></a> <h3 class="api-name" id="integer(kotlin.String,kotlin.Boolean)">integer</h3> <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.Companion.html#integer(kotlin.String,kotlin.Boolean)">integer</a>(description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null, nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></pre> - <p>Returns a schema for a 32-bit integer number</p> + <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a 32-bit signed integer number.</p> + <p><b>Important:</b> This <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> provides a hint to the model that it should generate a 32-bit integer, but only guarantees that the value will be an integer. Therefore it's <em>possible</em> that decoding it as an <code>Int</code> variable (or <code>int</code> in Java) could overflow.</p> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -320,13 +353,13 @@ <tr> <td><code>description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>An optional description of what the integer should contain or represent.</p> </td> </tr> <tr> <td><code>nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> </tbody> @@ -336,7 +369,7 @@ <div class="api-item"><a name="long(kotlin.String, kotlin.Boolean)"></a><a name="long-kotlin.String-kotlin.Boolean-"></a><a name="long"></a> <h3 class="api-name" id="long(kotlin.String,kotlin.Boolean)">long</h3> <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.Companion.html#long(kotlin.String,kotlin.Boolean)">long</a>(description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null, nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></pre> - <p>Returns a schema for a 64-bit integer number</p> + <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a 64-bit signed integer number.</p> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -352,13 +385,13 @@ <tr> <td><code>description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>An optional description of what the number should contain or represent.</p> </td> </tr> <tr> <td><code>nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> </tbody> @@ -368,7 +401,10 @@ <div class="api-item"><a name="obj(kotlin.collections.Map, kotlin.collections.List, kotlin.String, kotlin.Boolean)"></a><a name="obj-kotlin.collections.Map-kotlin.collections.List-kotlin.String-kotlin.Boolean-"></a><a name="obj"></a> <h3 class="api-name" id="obj(kotlin.collections.Map,kotlin.collections.List,kotlin.String,kotlin.Boolean)">obj</h3> <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.Companion.html#obj(kotlin.collections.Map,kotlin.collections.List,kotlin.String,kotlin.Boolean)">obj</a>(<br> properties: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><<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/Schema.html">Schema</a>>,<br> optionalProperties: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>> = emptyList(),<br> description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null,<br> nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false<br>): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></pre> - <p>Returns a schema for a complex object. In a function, it will be returned as a JSONObject.</p> + <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a complex data type.</p> + <p>This schema instructs the model to produce data of type object, which has keys of type <code>String</code> and values of type <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code>.</p> + <p><b>Example:</b> A <code>city</code> could be represented with the following object <code>Schema</code>.</p> + <pre class="prettyprint">Schema.obj(mapOf(<br> "name" to Schema.string(),<br> "population" to Schema.integer()<br>))</pre> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -384,19 +420,25 @@ <tr> <td><code>properties: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><<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/Schema.html">Schema</a>></code></td> <td> - <p>: The map of the object's fields to their schema</p> + <p>The map of the object's property names to their <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code>s.</p> + </td> + </tr> + <tr> + <td><code>optionalProperties: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>> = emptyList()</code></td> + <td> + <p>The list of optional properties. They must correspond to the keys provided in the <code>properties</code> map. By default it's empty, signaling the model that all properties are to be included.</p> </td> </tr> <tr> <td><code>description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>An optional description of what the object represents.</p> </td> </tr> <tr> <td><code>nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> </tbody> @@ -406,7 +448,7 @@ <div class="api-item"><a name="string(kotlin.String, kotlin.Boolean, com.google.firebase.vertexai.type.StringFormat)"></a><a name="string-kotlin.String-kotlin.Boolean-com.google.firebase.vertexai.type.StringFormat-"></a><a name="string"></a> <h3 class="api-name" id="string(kotlin.String,kotlin.Boolean,com.google.firebase.vertexai.type.StringFormat)">string</h3> <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.Companion.html#string(kotlin.String,kotlin.Boolean,com.google.firebase.vertexai.type.StringFormat)">string</a>(<br> description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null,<br> nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false,<br> format: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/StringFormat.html">StringFormat</a>? = null<br>): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></pre> - <p>Returns a schema for a string</p> + <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code> for a string.</p> <div class="devsite-table-wrapper"> <table class="responsive"> <colgroup> @@ -422,19 +464,19 @@ <tr> <td><code>description: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null</code></td> <td> - <p>: The description of what the parameter should contain or represent</p> + <p>An optional description of what the string should contain or represent.</p> </td> </tr> <tr> <td><code>nullable: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false</code></td> <td> - <p>: Whether null is a valid value for this schema</p> + <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p> </td> </tr> <tr> <td><code>format: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/StringFormat.html">StringFormat</a>? = null</code></td> <td> - <p>: The pattern that values need to adhere to</p> + <p>An optional pattern that values need to adhere to.</p> </td> </tr> </tbody>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/package-summary.html 2024-11-01 16:12:48.509033369 +0000 +++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/package-summary.html 2024-11-01 16:10:43.386591262 +0000 @@ -196,7 +196,7 @@ <tr> <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Schema.html">Schema</a></code></td> <td> - <p>Represents a schema</p> + <p>Definition of a data type.</p> </td> </tr> <tr> |
Vertex AI Mock Responses Check |
| cc @andrewheard |
emilypgoogle approved these changes Oct 31, 2024
rachelsaunders requested changes Oct 31, 2024
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/Schema.kt Outdated Show resolved Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/Schema.kt Outdated Show resolved Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/Schema.kt Outdated Show resolved Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/Schema.kt Outdated Show resolved Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/Schema.kt Outdated Show resolved Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/Schema.kt Outdated Show resolved Hide resolved
Co-authored-by: rachelsaunders <52258509+rachelsaunders@users.noreply.github.com>
rachelsaunders previously requested changes Nov 1, 2024
Co-authored-by: rachelsaunders <52258509+rachelsaunders@users.noreply.github.com>
rachelsaunders approved these changes Nov 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
4 participants
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.
The improvements include:
integerandfloattypes are hints to the model, and the returned data could potentially overflow the respective native types.enumerationsandobj.