Skip to content

Commit

Permalink
redo docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hsubox76 committed Sep 25, 2024
1 parent 5d5c425 commit 0b8615d
Show file tree
Hide file tree
Showing 23 changed files with 1,648 additions and 252 deletions.
742 changes: 742 additions & 0 deletions common/api-review/vertexai-preview.api.md

Large diffs are not rendered by default.

29 changes: 24 additions & 5 deletions docs-devsite/_toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -458,8 +458,12 @@ toc:
- title: vertexai-preview
path: /docs/reference/js/vertexai-preview.md
section:
- title: ArraySchema
path: /docs/reference/js/vertexai-preview.arrayschema.md
- title: BaseParams
path: /docs/reference/js/vertexai-preview.baseparams.md
- title: BooleanSchema
path: /docs/reference/js/vertexai-preview.booleanschema.md
- title: ChatSession
path: /docs/reference/js/vertexai-preview.chatsession.md
- title: Citation
Expand Down Expand Up @@ -492,11 +496,6 @@ toc:
path: /docs/reference/js/vertexai-preview.functioncallpart.md
- title: FunctionDeclaration
path: /docs/reference/js/vertexai-preview.functiondeclaration.md
- title: FunctionDeclarationSchema
path: /docs/reference/js/vertexai-preview.functiondeclarationschema.md
- title: FunctionDeclarationSchemaProperty
path: >-
/docs/reference/js/vertexai-preview.functiondeclarationschemaproperty.md
- title: FunctionDeclarationsTool
path: /docs/reference/js/vertexai-preview.functiondeclarationstool.md
- title: FunctionResponse
Expand Down Expand Up @@ -525,8 +524,16 @@ toc:
path: /docs/reference/js/vertexai-preview.groundingmetadata.md
- title: InlineDataPart
path: /docs/reference/js/vertexai-preview.inlinedatapart.md
- title: IntegerSchema
path: /docs/reference/js/vertexai-preview.integerschema.md
- title: ModelParams
path: /docs/reference/js/vertexai-preview.modelparams.md
- title: NumberSchema
path: /docs/reference/js/vertexai-preview.numberschema.md
- title: ObjectSchema
path: /docs/reference/js/vertexai-preview.objectschema.md
- title: ObjectSchemaInterface
path: /docs/reference/js/vertexai-preview.objectschemainterface.md
- title: PromptFeedback
path: /docs/reference/js/vertexai-preview.promptfeedback.md
- title: RequestOptions
Expand All @@ -537,10 +544,22 @@ toc:
path: /docs/reference/js/vertexai-preview.safetyrating.md
- title: SafetySetting
path: /docs/reference/js/vertexai-preview.safetysetting.md
- title: Schema
path: /docs/reference/js/vertexai-preview.schema.md
- title: SchemaInterface
path: /docs/reference/js/vertexai-preview.schemainterface.md
- title: SchemaParams
path: /docs/reference/js/vertexai-preview.schemaparams.md
- title: SchemaRequest
path: /docs/reference/js/vertexai-preview.schemarequest.md
- title: SchemaShared
path: /docs/reference/js/vertexai-preview.schemashared.md
- title: Segment
path: /docs/reference/js/vertexai-preview.segment.md
- title: StartChatParams
path: /docs/reference/js/vertexai-preview.startchatparams.md
- title: StringSchema
path: /docs/reference/js/vertexai-preview.stringschema.md
- title: TextPart
path: /docs/reference/js/vertexai-preview.textpart.md
- title: ToolConfig
Expand Down
57 changes: 57 additions & 0 deletions docs-devsite/vertexai-preview.arrayschema.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
Project: /docs/reference/js/_project.yaml
Book: /docs/reference/_book.yaml
page_type: reference

{% comment %}
DO NOT EDIT THIS FILE!
This is generated by the JS SDK team, and any local changes will be
overwritten. Changes should be made in the source code at
https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# ArraySchema class
Schema class for "array" types. The `items` param should refer to the type of item that can be a member of the array.

<b>Signature:</b>

```typescript
export declare class ArraySchema extends Schema
```
<b>Extends:</b> [Schema](./vertexai-preview.schema.md#schema_class)
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(schemaParams, items)](./vertexai-preview.arrayschema.md#arrayschemaconstructor) | | Constructs a new instance of the <code>ArraySchema</code> class |
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [items](./vertexai-preview.arrayschema.md#arrayschemaitems) | | [TypedSchema](./vertexai-preview.md#typedschema) | |
## ArraySchema.(constructor)
Constructs a new instance of the `ArraySchema` class
<b>Signature:</b>
```typescript
constructor(schemaParams: SchemaParams, items: TypedSchema);
```
#### Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| schemaParams | [SchemaParams](./vertexai-preview.schemaparams.md#schemaparams_interface) | |
| items | [TypedSchema](./vertexai-preview.md#typedschema) | |
## ArraySchema.items
<b>Signature:</b>
```typescript
items: TypedSchema;
```
43 changes: 43 additions & 0 deletions docs-devsite/vertexai-preview.booleanschema.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
Project: /docs/reference/js/_project.yaml
Book: /docs/reference/_book.yaml
page_type: reference

{% comment %}
DO NOT EDIT THIS FILE!
This is generated by the JS SDK team, and any local changes will be
overwritten. Changes should be made in the source code at
https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# BooleanSchema class
Schema class for "boolean" types.

<b>Signature:</b>

```typescript
export declare class BooleanSchema extends Schema
```
<b>Extends:</b> [Schema](./vertexai-preview.schema.md#schema_class)
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(schemaParams)](./vertexai-preview.booleanschema.md#booleanschemaconstructor) | | Constructs a new instance of the <code>BooleanSchema</code> class |
## BooleanSchema.(constructor)
Constructs a new instance of the `BooleanSchema` class
<b>Signature:</b>
```typescript
constructor(schemaParams?: SchemaParams);
```
#### Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| schemaParams | [SchemaParams](./vertexai-preview.schemaparams.md#schemaparams_interface) | |
10 changes: 5 additions & 5 deletions docs-devsite/vertexai-preview.functiondeclaration.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,18 @@ export declare interface FunctionDeclaration

| Property | Type | Description |
| --- | --- | --- |
| [description](./vertexai-preview.functiondeclaration.md#functiondeclarationdescription) | string | Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. |
| [description](./vertexai-preview.functiondeclaration.md#functiondeclarationdescription) | string | Description and purpose of the function. Model uses it to decide how and whether to call the function. |
| [name](./vertexai-preview.functiondeclaration.md#functiondeclarationname) | string | The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a max length of 64. |
| [parameters](./vertexai-preview.functiondeclaration.md#functiondeclarationparameters) | [FunctionDeclarationSchema](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschema_interface) | Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. Parameter names are case-sensitive. For a function with no parameters, this can be left unset. |
| [parameters](./vertexai-preview.functiondeclaration.md#functiondeclarationparameters) | [ObjectSchemaInterface](./vertexai-preview.objectschemainterface.md#objectschemainterface_interface) | Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. Parameter names are case-sensitive. For a function with no parameters, this can be left unset. |

## FunctionDeclaration.description

Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
Description and purpose of the function. Model uses it to decide how and whether to call the function.

<b>Signature:</b>

```typescript
description?: string;
description: string;
```

## FunctionDeclaration.name
Expand All @@ -53,5 +53,5 @@ Optional. Describes the parameters to this function in JSON Schema Object format
<b>Signature:</b>

```typescript
parameters?: FunctionDeclarationSchema;
parameters?: ObjectSchemaInterface;
```
70 changes: 0 additions & 70 deletions docs-devsite/vertexai-preview.functiondeclarationschema.md

This file was deleted.

125 changes: 0 additions & 125 deletions docs-devsite/vertexai-preview.functiondeclarationschemaproperty.md

This file was deleted.

Loading

0 comments on commit 0b8615d

Please sign in to comment.