You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| BLOCK\_MEDIUM\_AND\_ABOVE | <code>"BLOCK_MEDIUM_AND_ABOVE"</code> | Content with <code>NEGLIGIBLE</code> and <code>LOW</code> will be allowed. |
552
552
| BLOCK\_NONE | <code>"BLOCK_NONE"</code> | All content will be allowed. |
553
553
| BLOCK\_ONLY\_HIGH | <code>"BLOCK_ONLY_HIGH"</code> | Content with <code>NEGLIGIBLE</code>, <code>LOW</code>, and <code>MEDIUM</code> will be allowed. |
554
+
| OFF | <code>"OFF"</code> | All content will be allowed. This is the same as <code>BLOCK_NONE</code>, but the metadata corresponding to the [HarmCategory](./ai.md#harmcategory) will not be present in the response. |
| [description](./ai.schema.md#schemadescription) | | string | Optional. The description of the property. |
33
33
| [example](./ai.schema.md#schemaexample) | | unknown | Optional. The example of the property. |
34
34
| [format](./ai.schema.md#schemaformat) | | string | Optional. The format of the property. Supported formats:<br/> <ul> <li>for NUMBER type: "float", "double"</li> <li>for INTEGER type: "int32", "int64"</li> <li>for STRING type: "email", "byte", etc</li> </ul> |
35
+
| [items](./ai.schema.md#schemaitems) | | [SchemaInterface](./ai.schemainterface.md#schemainterface_interface) | Optional. The items of the property. |
36
+
| [maxItems](./ai.schema.md#schemamaxitems) | | number | The maximum number of items (elements) in a schema of type [SchemaType.ARRAY](./ai.md#schematypearray_enummember)<!-- -->. |
37
+
| [minItems](./ai.schema.md#schemaminitems) | | number | The minimum number of items (elements) in a schema of type [SchemaType.ARRAY](./ai.md#schematypearray_enummember)<!-- -->. |
35
38
| [nullable](./ai.schema.md#schemanullable) | | boolean | Optional. Whether the property is nullable. Defaults to false. |
36
39
| [type](./ai.schema.md#schematype) | | [SchemaType](./ai.md#schematype) | Optional. The type of the property. [SchemaType](./ai.md#schematype)<!-- -->. |
37
40
@@ -93,6 +96,36 @@ Optional. The format of the property. Supported formats:<br/> <ul> <li>for NUMBE
93
96
format?:string;
94
97
```
95
98
99
+
## Schema.items
100
+
101
+
Optional. The items of the property.
102
+
103
+
<b>Signature:</b>
104
+
105
+
```typescript
106
+
items?:SchemaInterface;
107
+
```
108
+
109
+
## Schema.maxItems
110
+
111
+
The maximum number of items (elements) in a schema of type [SchemaType.ARRAY](./ai.md#schematypearray_enummember)<!-- -->.
112
+
113
+
<b>Signature:</b>
114
+
115
+
```typescript
116
+
maxItems?:number;
117
+
```
118
+
119
+
## Schema.minItems
120
+
121
+
The minimum number of items (elements) in a schema of type [SchemaType.ARRAY](./ai.md#schematypearray_enummember)<!-- -->.
122
+
123
+
<b>Signature:</b>
124
+
125
+
```typescript
126
+
minItems?:number;
127
+
```
128
+
96
129
## Schema.nullable
97
130
98
131
Optional. Whether the property is nullable. Defaults to false.
| [title](./ai.schemashared.md#schemasharedtitle) |string|Thetitleoftheproperty. Thishelpsdocumenttheschema's purpose but does not typically constrain the generated value. It can subtly guide the model by clarifying the intent of a field. |
32
38
33
39
## SchemaShared.description
34
40
@@ -80,6 +86,46 @@ Optional. The items of the property.
80
86
items?: T;
81
87
```
82
88
89
+
## SchemaShared.maximum
90
+
91
+
The maximum value of a numeric type.
92
+
93
+
<b>Signature:</b>
94
+
95
+
```typescript
96
+
maximum?: number;
97
+
```
98
+
99
+
## SchemaShared.maxItems
100
+
101
+
The maximum number of items (elements) in a schema of type [SchemaType.ARRAY](./ai.md#schematypearray_enummember)<!-- -->.
102
+
103
+
<b>Signature:</b>
104
+
105
+
```typescript
106
+
maxItems?: number;
107
+
```
108
+
109
+
## SchemaShared.minimum
110
+
111
+
The minimum value of a numeric type.
112
+
113
+
<b>Signature:</b>
114
+
115
+
```typescript
116
+
minimum?: number;
117
+
```
118
+
119
+
## SchemaShared.minItems
120
+
121
+
The minimum number of items (elements) in a schema of type [SchemaType.ARRAY](./ai.md#schematypearray_enummember)<!-- -->.
122
+
123
+
<b>Signature:</b>
124
+
125
+
```typescript
126
+
minItems?: number;
127
+
```
128
+
83
129
## SchemaShared.nullable
84
130
85
131
Optional. Whether the property is nullable.
@@ -101,3 +147,23 @@ properties?: {
101
147
[k: string]: T;
102
148
};
103
149
```
150
+
151
+
## SchemaShared.propertyOrdering
152
+
153
+
A hint suggesting the order in which the keys should appear in the generated JSON string.
154
+
155
+
<b>Signature:</b>
156
+
157
+
```typescript
158
+
propertyOrdering?:string[];
159
+
```
160
+
161
+
## SchemaShared.title
162
+
163
+
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.
0 commit comments