Update docs

google-gemini · Nov 20, 2024 · 33f7e00 · 33f7e00
1 parent edb854e
commit 33f7e00
Show file tree

Hide file tree

Showing 16 changed files with 39 additions and 42 deletions.
diff --git a/docs/reference/main/generative-ai.arrayschema.md b/docs/reference/main/generative-ai.arrayschema.md
@@ -20,5 +20,5 @@ export interface ArraySchema extends BaseSchema
 |  [items](./generative-ai.arrayschema.items.md) |  | [Schema](./generative-ai.schema.md) | A schema describing the entries in the array. |
 |  [maxItems?](./generative-ai.arrayschema.maxitems.md) |  | number | _(Optional)_ The maximum number of items in the array. |
 |  [minItems?](./generative-ai.arrayschema.minitems.md) |  | number | _(Optional)_ The minimum number of items in the array. |
-|  [type](./generative-ai.arrayschema.type.md) |  | typeof [SchemaType.ARRAY](./generative-ai.schematype.md) |  |
+|  [type](./generative-ai.arrayschema.type.md) |  | typeof SchemaType.ARRAY |  |
 
diff --git a/docs/reference/main/generative-ai.booleanschema.md b/docs/reference/main/generative-ai.booleanschema.md
@@ -17,5 +17,5 @@ export interface BooleanSchema extends BaseSchema
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [type](./generative-ai.booleanschema.type.md) |  | typeof [SchemaType.BOOLEAN](./generative-ai.schematype.md) |  |
+|  [type](./generative-ai.booleanschema.type.md) |  | typeof SchemaType.BOOLEAN |  |
 
diff --git a/docs/reference/main/generative-ai.integerschema.md b/docs/reference/main/generative-ai.integerschema.md
@@ -18,5 +18,5 @@ export interface IntegerSchema extends BaseSchema
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [format?](./generative-ai.integerschema.format.md) |  | "int32" \| "int64" | _(Optional)_ Optional. The format of the number. |
-|  [type](./generative-ai.integerschema.type.md) |  | typeof [SchemaType.INTEGER](./generative-ai.schematype.md) |  |
+|  [type](./generative-ai.integerschema.type.md) |  | typeof SchemaType.INTEGER |  |
 
diff --git a/docs/reference/main/generative-ai.md b/docs/reference/main/generative-ai.md
@@ -29,7 +29,6 @@
 |  [HarmCategory](./generative-ai.harmcategory.md) | Harm categories that would cause prompts or candidates to be blocked. |
 |  [HarmProbability](./generative-ai.harmprobability.md) | Probability that a prompt or candidate matches a harm category. |
 |  [Outcome](./generative-ai.outcome.md) | Possible outcomes of code execution. |
-|  [SchemaType](./generative-ai.schematype.md) | Contains the list of OpenAPI data types as defined by https://swagger.io/docs/specification/data-models/data-types/ |
 |  [TaskType](./generative-ai.tasktype.md) | Task type for embedding content. |
 
 ## Interfaces
@@ -109,6 +108,7 @@
 |  Variable | Description |
 |  --- | --- |
 |  [POSSIBLE\_ROLES](./generative-ai.possible_roles.md) | Possible roles. |
+|  [SchemaType](./generative-ai.schematype.md) | Contains the list of OpenAPI data types as defined by https://swagger.io/docs/specification/data-models/data-types/ |
 
 ## Type Aliases
 
@@ -118,5 +118,6 @@
 |  [Part](./generative-ai.part.md) | Content part - includes text or image part types. |
 |  [ResponseSchema](./generative-ai.responseschema.md) | Schema passed to <code>GenerationConfig.responseSchema</code> |
 |  [Schema](./generative-ai.schema.md) | Schema is used to define the format of input/output data. Represents a select subset of an OpenAPI 3.0 schema object. More fields may be added in the future as needed. |
+|  [SchemaType](./generative-ai.schematype.md) |  |
 |  [Tool](./generative-ai.tool.md) | Defines a tool that model can call to access external knowledge. |
 
diff --git a/docs/reference/main/generative-ai.numberschema.md b/docs/reference/main/generative-ai.numberschema.md
@@ -18,5 +18,5 @@ export interface NumberSchema extends BaseSchema
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [format?](./generative-ai.numberschema.format.md) |  | "float" \| "double" | _(Optional)_ Optional. The format of the number. |
-|  [type](./generative-ai.numberschema.type.md) |  | typeof [SchemaType.NUMBER](./generative-ai.schematype.md) |  |
+|  [type](./generative-ai.numberschema.type.md) |  | typeof SchemaType.NUMBER |  |
 
diff --git a/docs/reference/main/generative-ai.objectschema.md b/docs/reference/main/generative-ai.objectschema.md
@@ -19,5 +19,5 @@ export interface ObjectSchema extends BaseSchema
 |  --- | --- | --- | --- |
 |  [properties](./generative-ai.objectschema.properties.md) |  | { \[k: string\]: [Schema](./generative-ai.schema.md)<!-- -->; } | Describes the properties of the JSON object. Must not be empty. |
 |  [required?](./generative-ai.objectschema.required.md) |  | string\[\] | _(Optional)_ A list of keys declared in the properties object. Required properties will always be present in the generated object. |
-|  [type](./generative-ai.objectschema.type.md) |  | typeof [SchemaType.OBJECT](./generative-ai.schematype.md) |  |
+|  [type](./generative-ai.objectschema.type.md) |  | typeof SchemaType.OBJECT |  |
 
diff --git a/docs/reference/main/generative-ai.schematype.md b/docs/reference/main/generative-ai.schematype.md
@@ -2,24 +2,19 @@
 
 [Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [SchemaType](./generative-ai.schematype.md)
 
-## SchemaType enum
+## SchemaType variable
 
 Contains the list of OpenAPI data types as defined by https://swagger.io/docs/specification/data-models/data-types/
 
 **Signature:**
 
 ```typescript
-export declare enum SchemaType 
+SchemaType: {
+    readonly STRING: "string";
+    readonly NUMBER: "number";
+    readonly INTEGER: "integer";
+    readonly BOOLEAN: "boolean";
+    readonly ARRAY: "array";
+    readonly OBJECT: "object";
+}
 ```
-
-## Enumeration Members
-
-|  Member | Value | Description |
-|  --- | --- | --- |
-|  ARRAY | <code>&quot;array&quot;</code> | Array type. |
-|  BOOLEAN | <code>&quot;boolean&quot;</code> | Boolean type. |
-|  INTEGER | <code>&quot;integer&quot;</code> | Integer type. |
-|  NUMBER | <code>&quot;number&quot;</code> | Number type. |
-|  OBJECT | <code>&quot;object&quot;</code> | Object type. |
-|  STRING | <code>&quot;string&quot;</code> | String type. |
-
diff --git a/docs/reference/main/generative-ai.stringschema.md b/docs/reference/main/generative-ai.stringschema.md
@@ -18,5 +18,5 @@ export interface StringSchema extends BaseSchema
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [enum?](./generative-ai.stringschema.enum.md) |  | string\[\] | _(Optional)_ If present, limits the result to one of the given values. |
-|  [type](./generative-ai.stringschema.type.md) |  | typeof [SchemaType.STRING](./generative-ai.schematype.md) |  |
+|  [type](./generative-ai.stringschema.type.md) |  | typeof SchemaType.STRING |  |
 
diff --git a/docs/reference/server/generative-ai.arrayschema.md b/docs/reference/server/generative-ai.arrayschema.md
@@ -20,5 +20,5 @@ export interface ArraySchema extends BaseSchema
 |  [items](./generative-ai.arrayschema.items.md) |  | [Schema](./generative-ai.schema.md) | A schema describing the entries in the array. |
 |  [maxItems?](./generative-ai.arrayschema.maxitems.md) |  | number | _(Optional)_ The maximum number of items in the array. |
 |  [minItems?](./generative-ai.arrayschema.minitems.md) |  | number | _(Optional)_ The minimum number of items in the array. |
-|  [type](./generative-ai.arrayschema.type.md) |  | typeof [SchemaType.ARRAY](./generative-ai.schematype.md) |  |
+|  [type](./generative-ai.arrayschema.type.md) |  | typeof SchemaType.ARRAY |  |
 
diff --git a/docs/reference/server/generative-ai.booleanschema.md b/docs/reference/server/generative-ai.booleanschema.md
@@ -17,5 +17,5 @@ export interface BooleanSchema extends BaseSchema
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [type](./generative-ai.booleanschema.type.md) |  | typeof [SchemaType.BOOLEAN](./generative-ai.schematype.md) |  |
+|  [type](./generative-ai.booleanschema.type.md) |  | typeof SchemaType.BOOLEAN |  |
 
diff --git a/docs/reference/server/generative-ai.integerschema.md b/docs/reference/server/generative-ai.integerschema.md
@@ -18,5 +18,5 @@ export interface IntegerSchema extends BaseSchema
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [format?](./generative-ai.integerschema.format.md) |  | "int32" \| "int64" | _(Optional)_ Optional. The format of the number. |
-|  [type](./generative-ai.integerschema.type.md) |  | typeof [SchemaType.INTEGER](./generative-ai.schematype.md) |  |
+|  [type](./generative-ai.integerschema.type.md) |  | typeof SchemaType.INTEGER |  |
 
diff --git a/docs/reference/server/generative-ai.md b/docs/reference/server/generative-ai.md
@@ -19,7 +19,6 @@
 |  [FileState](./generative-ai.filestate.md) | Processing state of the <code>File</code>. |
 |  [FunctionCallingMode](./generative-ai.functioncallingmode.md) |  |
 |  [Outcome](./generative-ai.outcome.md) | Possible outcomes of code execution. |
-|  [SchemaType](./generative-ai.schematype.md) | Contains the list of OpenAPI data types as defined by https://swagger.io/docs/specification/data-models/data-types/ |
 
 ## Interfaces
 
@@ -68,6 +67,12 @@
 |  [UploadFileResponse](./generative-ai.uploadfileresponse.md) | Response from calling [GoogleAIFileManager.uploadFile()](./generative-ai.googleaifilemanager.uploadfile.md) |
 |  [VideoMetadata](./generative-ai.videometadata.md) | Metadata populated when video has been processed. |
 
+## Variables
+
+|  Variable | Description |
+|  --- | --- |
+|  [SchemaType](./generative-ai.schematype.md) | Contains the list of OpenAPI data types as defined by https://swagger.io/docs/specification/data-models/data-types/ |
+
 ## Type Aliases
 
 |  Type Alias | Description |
@@ -76,5 +81,6 @@
 |  [Part](./generative-ai.part.md) | Content part - includes text or image part types. |
 |  [ResponseSchema](./generative-ai.responseschema.md) | Schema passed to <code>GenerationConfig.responseSchema</code> |
 |  [Schema](./generative-ai.schema.md) | Schema is used to define the format of input/output data. Represents a select subset of an OpenAPI 3.0 schema object. More fields may be added in the future as needed. |
+|  [SchemaType](./generative-ai.schematype.md) |  |
 |  [Tool](./generative-ai.tool.md) | Defines a tool that model can call to access external knowledge. |
 
diff --git a/docs/reference/server/generative-ai.numberschema.md b/docs/reference/server/generative-ai.numberschema.md
@@ -18,5 +18,5 @@ export interface NumberSchema extends BaseSchema
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [format?](./generative-ai.numberschema.format.md) |  | "float" \| "double" | _(Optional)_ Optional. The format of the number. |
-|  [type](./generative-ai.numberschema.type.md) |  | typeof [SchemaType.NUMBER](./generative-ai.schematype.md) |  |
+|  [type](./generative-ai.numberschema.type.md) |  | typeof SchemaType.NUMBER |  |
 
diff --git a/docs/reference/server/generative-ai.objectschema.md b/docs/reference/server/generative-ai.objectschema.md
@@ -19,5 +19,5 @@ export interface ObjectSchema extends BaseSchema
 |  --- | --- | --- | --- |
 |  [properties](./generative-ai.objectschema.properties.md) |  | { \[k: string\]: [Schema](./generative-ai.schema.md)<!-- -->; } | Describes the properties of the JSON object. Must not be empty. |
 |  [required?](./generative-ai.objectschema.required.md) |  | string\[\] | _(Optional)_ A list of keys declared in the properties object. Required properties will always be present in the generated object. |
-|  [type](./generative-ai.objectschema.type.md) |  | typeof [SchemaType.OBJECT](./generative-ai.schematype.md) |  |
+|  [type](./generative-ai.objectschema.type.md) |  | typeof SchemaType.OBJECT |  |
 
diff --git a/docs/reference/server/generative-ai.schematype.md b/docs/reference/server/generative-ai.schematype.md
@@ -2,24 +2,19 @@
 
 [Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [SchemaType](./generative-ai.schematype.md)
 
-## SchemaType enum
+## SchemaType variable
 
 Contains the list of OpenAPI data types as defined by https://swagger.io/docs/specification/data-models/data-types/
 
 **Signature:**
 
 ```typescript
-export declare enum SchemaType 
+SchemaType: {
+    readonly STRING: "string";
+    readonly NUMBER: "number";
+    readonly INTEGER: "integer";
+    readonly BOOLEAN: "boolean";
+    readonly ARRAY: "array";
+    readonly OBJECT: "object";
+}
 ```
-
-## Enumeration Members
-
-|  Member | Value | Description |
-|  --- | --- | --- |
-|  ARRAY | <code>&quot;array&quot;</code> | Array type. |
-|  BOOLEAN | <code>&quot;boolean&quot;</code> | Boolean type. |
-|  INTEGER | <code>&quot;integer&quot;</code> | Integer type. |
-|  NUMBER | <code>&quot;number&quot;</code> | Number type. |
-|  OBJECT | <code>&quot;object&quot;</code> | Object type. |
-|  STRING | <code>&quot;string&quot;</code> | String type. |
-
diff --git a/docs/reference/server/generative-ai.stringschema.md b/docs/reference/server/generative-ai.stringschema.md
@@ -18,5 +18,5 @@ export interface StringSchema extends BaseSchema
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [enum?](./generative-ai.stringschema.enum.md) |  | string\[\] | _(Optional)_ If present, limits the result to one of the given values. |
-|  [type](./generative-ai.stringschema.type.md) |  | typeof [SchemaType.STRING](./generative-ai.schematype.md) |  |
+|  [type](./generative-ai.stringschema.type.md) |  | typeof SchemaType.STRING |  |