Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@rictic
rictic committed Nov 14, 2024
1 parent 8a2ac58 commit d0531ec
Show file tree
Hide file tree
Showing 8 changed files with 31 additions and 34 deletions.
3 changes: 2 additions & 1 deletion docs/reference/main/generative-ai.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -106,11 +105,13 @@
| 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

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

2 changes: 1 addition & 1 deletion docs/reference/main/generative-ai.schema.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ export interface Schema
| [nullable?](./generative-ai.schema.nullable.md) | | boolean | _(Optional)_ Optional. Whether the property is nullable. |
| [properties?](./generative-ai.schema.properties.md) | | { \[k: string\]: [Schema](./generative-ai.schema.md)<!-- -->; } | _(Optional)_ Optional. Map of [Schema](./generative-ai.schema.md)<!-- -->. |
| [required?](./generative-ai.schema.required.md) | | string\[\] | _(Optional)_ Optional. Array of required property. |
| [type?](./generative-ai.schema.type.md) | | [SchemaType](./generative-ai.schematype.md) | _(Optional)_ Optional. The type of the property. [SchemaType](./generative-ai.schematype.md)<!-- -->. |
| [type?](./generative-ai.schema.type.md) | | [SchemaType](./generative-ai.schematype.md) | _(Optional)_ Optional. The type of the property. . |

2 changes: 1 addition & 1 deletion docs/reference/main/generative-ai.schema.type.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Schema.type property

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

**Signature:**

Expand Down
23 changes: 9 additions & 14 deletions docs/reference/main/generative-ai.schematype.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

8 changes: 7 additions & 1 deletion docs/reference/server/generative-ai.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -65,10 +64,17 @@
| [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 |
| --- | --- |
| [Part](./generative-ai.part.md) | Content part - includes text or image part types. |
| [SchemaType](./generative-ai.schematype.md) | |
| [Tool](./generative-ai.tool.md) | Defines a tool that model can call to access external knowledge. |

2 changes: 1 addition & 1 deletion docs/reference/server/generative-ai.schema.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ export interface Schema
| [nullable?](./generative-ai.schema.nullable.md) | | boolean | _(Optional)_ Optional. Whether the property is nullable. |
| [properties?](./generative-ai.schema.properties.md) | | { \[k: string\]: [Schema](./generative-ai.schema.md)<!-- -->; } | _(Optional)_ Optional. Map of [Schema](./generative-ai.schema.md)<!-- -->. |
| [required?](./generative-ai.schema.required.md) | | string\[\] | _(Optional)_ Optional. Array of required property. |
| [type?](./generative-ai.schema.type.md) | | [SchemaType](./generative-ai.schematype.md) | _(Optional)_ Optional. The type of the property. [SchemaType](./generative-ai.schematype.md)<!-- -->. |
| [type?](./generative-ai.schema.type.md) | | [SchemaType](./generative-ai.schematype.md) | _(Optional)_ Optional. The type of the property. . |

2 changes: 1 addition & 1 deletion docs/reference/server/generative-ai.schema.type.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Schema.type property

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

**Signature:**

Expand Down
23 changes: 9 additions & 14 deletions docs/reference/server/generative-ai.schematype.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

0 comments on commit d0531ec

Please sign in to comment.