Skip to content

Commit 16742c9

Browse files
committed
Fix wording in docs
1 parent 9e5636a commit 16742c9

File tree

2 files changed

+3
-6
lines changed

2 files changed

+3
-6
lines changed

docs-devsite/ai.schemashared.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export interface SchemaShared<T>
3131
| [minimum](./ai.schemashared.md#schemasharedminimum) | number | The minimum value of a numeric type. |
3232
| [nullable](./ai.schemashared.md#schemasharednullable) | boolean | Optional. Whether the property is nullable. |
3333
| [properties](./ai.schemashared.md#schemasharedproperties) | { \[k: string\]: T; } | Optional. Map of <code>Schema</code> objects. |
34-
| [propertyOrdering](./ai.schemashared.md#schemasharedpropertyordering) | string\[\] | A hint to the gemini model, suggesting the order in which the keys should appear in the generated JSON string. |
34+
| [propertyOrdering](./ai.schemashared.md#schemasharedpropertyordering) | string\[\] | A hint suggesting the order in which the keys should appear in the generated JSON string. |
3535
| [title](./ai.schemashared.md#schemasharedtitle) | string | The title of the property. This helps document the schema's purpose but does not typically constrain the generated value. It can subtly guide the model by clarifying the intent of a field. |
3636

3737
## SchemaShared.description
@@ -128,7 +128,7 @@ properties?: {
128128

129129
## SchemaShared.propertyOrdering
130130

131-
A hint to the gemini model, suggesting the order in which the keys should appear in the generated JSON string.
131+
A hint suggesting the order in which the keys should appear in the generated JSON string.
132132

133133
<b>Signature:</b>
134134

packages/ai/src/types/schema.ts

+1-4
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,7 @@ export interface SchemaShared<T> {
6161
properties?: {
6262
[k: string]: T;
6363
};
64-
/**
65-
* A hint to the gemini model, suggesting the order in which the keys should appear in the
66-
* generated JSON string.
67-
*/
64+
/** A hint suggesting the order in which the keys should appear in the generated JSON string. */
6865
propertyOrdering?: string[];
6966
/** Optional. The enum of the property. */
7067
enum?: string[];

0 commit comments

Comments
 (0)