Skip to content

Commit d0531ec

Browse files
ricticrictic
committed
Update docs
1 parent 8a2ac58 commit d0531ec

8 files changed

+31
-34
lines changed

‎docs/reference/main/generative-ai.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@
2929
| [HarmCategory](./generative-ai.harmcategory.md) | Harm categories that would cause prompts or candidates to be blocked. |
3030
| [HarmProbability](./generative-ai.harmprobability.md) | Probability that a prompt or candidate matches a harm category. |
3131
| [Outcome](./generative-ai.outcome.md) | Possible outcomes of code execution. |
32-
| [SchemaType](./generative-ai.schematype.md) | Contains the list of OpenAPI data types as defined by https://swagger.io/docs/specification/data-models/data-types/ |
3332
| [TaskType](./generative-ai.tasktype.md) | Task type for embedding content. |
3433

3534
## Interfaces
@@ -106,11 +105,13 @@
106105
| Variable | Description |
107106
| --- | --- |
108107
| [POSSIBLE\_ROLES](./generative-ai.possible_roles.md) | Possible roles. |
108+
| [SchemaType](./generative-ai.schematype.md) | Contains the list of OpenAPI data types as defined by https://swagger.io/docs/specification/data-models/data-types/ |
109109

110110
## Type Aliases
111111

112112
| Type Alias | Description |
113113
| --- | --- |
114114
| [Part](./generative-ai.part.md) | Content part - includes text or image part types. |
115+
| [SchemaType](./generative-ai.schematype.md) | |
115116
| [Tool](./generative-ai.tool.md) | Defines a tool that model can call to access external knowledge. |
116117

‎docs/reference/main/generative-ai.schema.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ export interface Schema
2424
| [nullable?](./generative-ai.schema.nullable.md) | | boolean | _(Optional)_ Optional. Whether the property is nullable. |
2525
| [properties?](./generative-ai.schema.properties.md) | | { \[k: string\]: [Schema](./generative-ai.schema.md)<!-- -->; } | _(Optional)_ Optional. Map of [Schema](./generative-ai.schema.md)<!-- -->. |
2626
| [required?](./generative-ai.schema.required.md) | | string\[\] | _(Optional)_ Optional. Array of required property. |
27-
| [type?](./generative-ai.schema.type.md) | | [SchemaType](./generative-ai.schematype.md) | _(Optional)_ Optional. The type of the property. [SchemaType](./generative-ai.schematype.md)<!-- -->. |
27+
| [type?](./generative-ai.schema.type.md) | | [SchemaType](./generative-ai.schematype.md) | _(Optional)_ Optional. The type of the property. . |
2828

‎docs/reference/main/generative-ai.schema.type.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Schema.type property
66

7-
Optional. The type of the property. [SchemaType](./generative-ai.schematype.md)<!-- -->.
7+
Optional. The type of the property. .
88

99
**Signature:**
1010

‎docs/reference/main/generative-ai.schematype.md

+9-14
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,19 @@
22

33
[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [SchemaType](./generative-ai.schematype.md)
44

5-
## SchemaType enum
5+
## SchemaType variable
66

77
Contains the list of OpenAPI data types as defined by https://swagger.io/docs/specification/data-models/data-types/
88

99
**Signature:**
1010

1111
```typescript
12-
export declare enum SchemaType
12+
SchemaType: {
13+
readonly STRING: "string";
14+
readonly NUMBER: "number";
15+
readonly INTEGER: "integer";
16+
readonly BOOLEAN: "boolean";
17+
readonly ARRAY: "array";
18+
readonly OBJECT: "object";
19+
}
1320
```
14-
15-
## Enumeration Members
16-
17-
| Member | Value | Description |
18-
| --- | --- | --- |
19-
| ARRAY | <code>&quot;array&quot;</code> | Array type. |
20-
| BOOLEAN | <code>&quot;boolean&quot;</code> | Boolean type. |
21-
| INTEGER | <code>&quot;integer&quot;</code> | Integer type. |
22-
| NUMBER | <code>&quot;number&quot;</code> | Number type. |
23-
| OBJECT | <code>&quot;object&quot;</code> | Object type. |
24-
| STRING | <code>&quot;string&quot;</code> | String type. |
25-

‎docs/reference/server/generative-ai.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
| [FileState](./generative-ai.filestate.md) | Processing state of the <code>File</code>. |
2020
| [FunctionCallingMode](./generative-ai.functioncallingmode.md) | |
2121
| [Outcome](./generative-ai.outcome.md) | Possible outcomes of code execution. |
22-
| [SchemaType](./generative-ai.schematype.md) | Contains the list of OpenAPI data types as defined by https://swagger.io/docs/specification/data-models/data-types/ |
2322

2423
## Interfaces
2524

@@ -65,10 +64,17 @@
6564
| [UploadFileResponse](./generative-ai.uploadfileresponse.md) | Response from calling [GoogleAIFileManager.uploadFile()](./generative-ai.googleaifilemanager.uploadfile.md) |
6665
| [VideoMetadata](./generative-ai.videometadata.md) | Metadata populated when video has been processed. |
6766

67+
## Variables
68+
69+
| Variable | Description |
70+
| --- | --- |
71+
| [SchemaType](./generative-ai.schematype.md) | Contains the list of OpenAPI data types as defined by https://swagger.io/docs/specification/data-models/data-types/ |
72+
6873
## Type Aliases
6974

7075
| Type Alias | Description |
7176
| --- | --- |
7277
| [Part](./generative-ai.part.md) | Content part - includes text or image part types. |
78+
| [SchemaType](./generative-ai.schematype.md) | |
7379
| [Tool](./generative-ai.tool.md) | Defines a tool that model can call to access external knowledge. |
7480

‎docs/reference/server/generative-ai.schema.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ export interface Schema
2424
| [nullable?](./generative-ai.schema.nullable.md) | | boolean | _(Optional)_ Optional. Whether the property is nullable. |
2525
| [properties?](./generative-ai.schema.properties.md) | | { \[k: string\]: [Schema](./generative-ai.schema.md)<!-- -->; } | _(Optional)_ Optional. Map of [Schema](./generative-ai.schema.md)<!-- -->. |
2626
| [required?](./generative-ai.schema.required.md) | | string\[\] | _(Optional)_ Optional. Array of required property. |
27-
| [type?](./generative-ai.schema.type.md) | | [SchemaType](./generative-ai.schematype.md) | _(Optional)_ Optional. The type of the property. [SchemaType](./generative-ai.schematype.md)<!-- -->. |
27+
| [type?](./generative-ai.schema.type.md) | | [SchemaType](./generative-ai.schematype.md) | _(Optional)_ Optional. The type of the property. . |
2828

‎docs/reference/server/generative-ai.schema.type.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Schema.type property
66

7-
Optional. The type of the property. [SchemaType](./generative-ai.schematype.md)<!-- -->.
7+
Optional. The type of the property. .
88

99
**Signature:**
1010

‎docs/reference/server/generative-ai.schematype.md

+9-14
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,19 @@
22

33
[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [SchemaType](./generative-ai.schematype.md)
44

5-
## SchemaType enum
5+
## SchemaType variable
66

77
Contains the list of OpenAPI data types as defined by https://swagger.io/docs/specification/data-models/data-types/
88

99
**Signature:**
1010

1111
```typescript
12-
export declare enum SchemaType
12+
SchemaType: {
13+
readonly STRING: "string";
14+
readonly NUMBER: "number";
15+
readonly INTEGER: "integer";
16+
readonly BOOLEAN: "boolean";
17+
readonly ARRAY: "array";
18+
readonly OBJECT: "object";
19+
}
1320
```
14-
15-
## Enumeration Members
16-
17-
| Member | Value | Description |
18-
| --- | --- | --- |
19-
| ARRAY | <code>&quot;array&quot;</code> | Array type. |
20-
| BOOLEAN | <code>&quot;boolean&quot;</code> | Boolean type. |
21-
| INTEGER | <code>&quot;integer&quot;</code> | Integer type. |
22-
| NUMBER | <code>&quot;number&quot;</code> | Number type. |
23-
| OBJECT | <code>&quot;object&quot;</code> | Object type. |
24-
| STRING | <code>&quot;string&quot;</code> | String type. |
25-

0 commit comments

Comments
 (0)