Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
148 changes: 55 additions & 93 deletions docs-devsite/_toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -469,144 +469,106 @@ toc:
path: /docs/reference/js/storage.uploadtask.md
- title: UploadTaskSnapshot
path: /docs/reference/js/storage.uploadtasksnapshot.md
- title: vertexai
path: /docs/reference/js/vertexai.md
- title: vertexai-preview
path: /docs/reference/js/vertexai-preview.md
section:
- title: ArraySchema
path: /docs/reference/js/vertexai.arrayschema.md
- title: BaseParams
path: /docs/reference/js/vertexai.baseparams.md
- title: BooleanSchema
path: /docs/reference/js/vertexai.booleanschema.md
path: /docs/reference/js/vertexai-preview.baseparams.md
- title: ChatSession
path: /docs/reference/js/vertexai.chatsession.md
path: /docs/reference/js/vertexai-preview.chatsession.md
- title: Citation
path: /docs/reference/js/vertexai.citation.md
path: /docs/reference/js/vertexai-preview.citation.md
- title: CitationMetadata
path: /docs/reference/js/vertexai.citationmetadata.md
path: /docs/reference/js/vertexai-preview.citationmetadata.md
- title: Content
path: /docs/reference/js/vertexai.content.md
path: /docs/reference/js/vertexai-preview.content.md
- title: CountTokensRequest
path: /docs/reference/js/vertexai.counttokensrequest.md
path: /docs/reference/js/vertexai-preview.counttokensrequest.md
- title: CountTokensResponse
path: /docs/reference/js/vertexai.counttokensresponse.md
path: /docs/reference/js/vertexai-preview.counttokensresponse.md
- title: CustomErrorData
path: /docs/reference/js/vertexai.customerrordata.md
path: /docs/reference/js/vertexai-preview.customerrordata.md
- title: Date_2
path: /docs/reference/js/vertexai.date_2.md
path: /docs/reference/js/vertexai-preview.date_2.md
- title: EnhancedGenerateContentResponse
path: /docs/reference/js/vertexai.enhancedgeneratecontentresponse.md
path: /docs/reference/js/vertexai-preview.enhancedgeneratecontentresponse.md
- title: ErrorDetails
path: /docs/reference/js/vertexai.errordetails.md
path: /docs/reference/js/vertexai-preview.errordetails.md
- title: FileData
path: /docs/reference/js/vertexai.filedata.md
path: /docs/reference/js/vertexai-preview.filedata.md
- title: FileDataPart
path: /docs/reference/js/vertexai.filedatapart.md
path: /docs/reference/js/vertexai-preview.filedatapart.md
- title: FunctionCall
path: /docs/reference/js/vertexai.functioncall.md
path: /docs/reference/js/vertexai-preview.functioncall.md
- title: FunctionCallingConfig
path: /docs/reference/js/vertexai.functioncallingconfig.md
path: /docs/reference/js/vertexai-preview.functioncallingconfig.md
- title: FunctionCallPart
path: /docs/reference/js/vertexai.functioncallpart.md
path: /docs/reference/js/vertexai-preview.functioncallpart.md
- title: FunctionDeclaration
path: /docs/reference/js/vertexai.functiondeclaration.md
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.functiondeclarationstool.md
path: /docs/reference/js/vertexai-preview.functiondeclarationstool.md
- title: FunctionResponse
path: /docs/reference/js/vertexai.functionresponse.md
path: /docs/reference/js/vertexai-preview.functionresponse.md
- title: FunctionResponsePart
path: /docs/reference/js/vertexai.functionresponsepart.md
path: /docs/reference/js/vertexai-preview.functionresponsepart.md
- title: GenerateContentCandidate
path: /docs/reference/js/vertexai.generatecontentcandidate.md
path: /docs/reference/js/vertexai-preview.generatecontentcandidate.md
- title: GenerateContentRequest
path: /docs/reference/js/vertexai.generatecontentrequest.md
path: /docs/reference/js/vertexai-preview.generatecontentrequest.md
- title: GenerateContentResponse
path: /docs/reference/js/vertexai.generatecontentresponse.md
path: /docs/reference/js/vertexai-preview.generatecontentresponse.md
- title: GenerateContentResult
path: /docs/reference/js/vertexai.generatecontentresult.md
path: /docs/reference/js/vertexai-preview.generatecontentresult.md
- title: GenerateContentStreamResult
path: /docs/reference/js/vertexai.generatecontentstreamresult.md
path: /docs/reference/js/vertexai-preview.generatecontentstreamresult.md
- title: GenerationConfig
path: /docs/reference/js/vertexai.generationconfig.md
path: /docs/reference/js/vertexai-preview.generationconfig.md
- title: GenerativeContentBlob
path: /docs/reference/js/vertexai.generativecontentblob.md
path: /docs/reference/js/vertexai-preview.generativecontentblob.md
- title: GenerativeModel
path: /docs/reference/js/vertexai.generativemodel.md
path: /docs/reference/js/vertexai-preview.generativemodel.md
- title: GroundingAttribution
path: /docs/reference/js/vertexai.groundingattribution.md
path: /docs/reference/js/vertexai-preview.groundingattribution.md
- title: GroundingMetadata
path: /docs/reference/js/vertexai.groundingmetadata.md
- title: ImagenGCSImage
path: /docs/reference/js/vertexai.imagengcsimage.md
- title: ImagenGenerationConfig
path: /docs/reference/js/vertexai.imagengenerationconfig.md
- title: ImagenGenerationResponse
path: /docs/reference/js/vertexai.imagengenerationresponse.md
- title: ImagenImageFormat
path: /docs/reference/js/vertexai.imagenimageformat.md
- title: ImagenInlineImage
path: /docs/reference/js/vertexai.imageninlineimage.md
- title: ImagenModel
path: /docs/reference/js/vertexai.imagenmodel.md
- title: ImagenModelParams
path: /docs/reference/js/vertexai.imagenmodelparams.md
- title: ImagenSafetySettings
path: /docs/reference/js/vertexai.imagensafetysettings.md
path: /docs/reference/js/vertexai-preview.groundingmetadata.md
- title: HybridParams
path: /docs/reference/js/vertexai-preview.hybridparams.md
- title: InlineDataPart
path: /docs/reference/js/vertexai.inlinedatapart.md
- title: IntegerSchema
path: /docs/reference/js/vertexai.integerschema.md
- title: ModalityTokenCount
path: /docs/reference/js/vertexai.modalitytokencount.md
path: /docs/reference/js/vertexai-preview.inlinedatapart.md
- title: ModelParams
path: /docs/reference/js/vertexai.modelparams.md
- title: NumberSchema
path: /docs/reference/js/vertexai.numberschema.md
- title: ObjectSchema
path: /docs/reference/js/vertexai.objectschema.md
- title: ObjectSchemaInterface
path: /docs/reference/js/vertexai.objectschemainterface.md
path: /docs/reference/js/vertexai-preview.modelparams.md
- title: PromptFeedback
path: /docs/reference/js/vertexai.promptfeedback.md
path: /docs/reference/js/vertexai-preview.promptfeedback.md
- title: RequestOptions
path: /docs/reference/js/vertexai.requestoptions.md
path: /docs/reference/js/vertexai-preview.requestoptions.md
- title: RetrievedContextAttribution
path: /docs/reference/js/vertexai.retrievedcontextattribution.md
path: /docs/reference/js/vertexai-preview.retrievedcontextattribution.md
- title: SafetyRating
path: /docs/reference/js/vertexai.safetyrating.md
path: /docs/reference/js/vertexai-preview.safetyrating.md
- title: SafetySetting
path: /docs/reference/js/vertexai.safetysetting.md
- title: Schema
path: /docs/reference/js/vertexai.schema.md
- title: SchemaInterface
path: /docs/reference/js/vertexai.schemainterface.md
- title: SchemaParams
path: /docs/reference/js/vertexai.schemaparams.md
- title: SchemaRequest
path: /docs/reference/js/vertexai.schemarequest.md
- title: SchemaShared
path: /docs/reference/js/vertexai.schemashared.md
path: /docs/reference/js/vertexai-preview.safetysetting.md
- title: Segment
path: /docs/reference/js/vertexai.segment.md
path: /docs/reference/js/vertexai-preview.segment.md
- title: StartChatParams
path: /docs/reference/js/vertexai.startchatparams.md
- title: StringSchema
path: /docs/reference/js/vertexai.stringschema.md
path: /docs/reference/js/vertexai-preview.startchatparams.md
- title: TextPart
path: /docs/reference/js/vertexai.textpart.md
path: /docs/reference/js/vertexai-preview.textpart.md
- title: ToolConfig
path: /docs/reference/js/vertexai.toolconfig.md
path: /docs/reference/js/vertexai-preview.toolconfig.md
- title: UsageMetadata
path: /docs/reference/js/vertexai.usagemetadata.md
path: /docs/reference/js/vertexai-preview.usagemetadata.md
- title: VertexAI
path: /docs/reference/js/vertexai.vertexai.md
path: /docs/reference/js/vertexai-preview.vertexai.md
- title: VertexAIError
path: /docs/reference/js/vertexai.vertexaierror.md
- title: VertexAIModel
path: /docs/reference/js/vertexai.vertexaimodel.md
path: /docs/reference/js/vertexai-preview.vertexaierror.md
- title: VertexAIOptions
path: /docs/reference/js/vertexai.vertexaioptions.md
path: /docs/reference/js/vertexai-preview.vertexaioptions.md
- title: VideoMetadata
path: /docs/reference/js/vertexai.videometadata.md
path: /docs/reference/js/vertexai-preview.videometadata.md
- title: WebAttribution
path: /docs/reference/js/vertexai.webattribution.md
path: /docs/reference/js/vertexai-preview.webattribution.md
2 changes: 1 addition & 1 deletion docs-devsite/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,5 @@ https://github.com/firebase/firebase-js-sdk
| [@firebase/performance](./performance.md#performance_package) | The Firebase Performance Monitoring Web SDK. This SDK does not work in a Node.js environment. |
| [@firebase/remote-config](./remote-config.md#remote-config_package) | The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environment. |
| [@firebase/storage](./storage.md#storage_package) | Cloud Storage for Firebase |
| [@firebase/vertexai](./vertexai.md#vertexai_package) | The Vertex AI in Firebase Web SDK. |
| [@firebase/vertexai-preview](./vertexai-preview.md#vertexai-preview_package) | The Vertex AI in Firebase Web SDK. |

Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ export interface BaseParams

| Property | Type | Description |
| --- | --- | --- |
| [generationConfig](./vertexai.baseparams.md#baseparamsgenerationconfig) | [GenerationConfig](./vertexai.generationconfig.md#generationconfig_interface) | |
| [safetySettings](./vertexai.baseparams.md#baseparamssafetysettings) | [SafetySetting](./vertexai.safetysetting.md#safetysetting_interface)<!-- -->\[\] | |
| [generationConfig](./vertexai-preview.baseparams.md#baseparamsgenerationconfig) | [GenerationConfig](./vertexai-preview.generationconfig.md#generationconfig_interface) | |
| [safetySettings](./vertexai-preview.baseparams.md#baseparamssafetysettings) | [SafetySetting](./vertexai-preview.safetysetting.md#safetysetting_interface)<!-- -->\[\] | |

## BaseParams.generationConfig

Expand Down
139 changes: 139 additions & 0 deletions docs-devsite/vertexai-preview.chatsession.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
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 %}

# ChatSession class
ChatSession class that enables sending chat messages and stores history of sent and received messages so far.

<b>Signature:</b>

```typescript
export declare class ChatSession
```

## Constructors

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(apiSettings, model, chromeAdapter, params, requestOptions)](./vertexai-preview.chatsession.md#chatsessionconstructor) | | Constructs a new instance of the <code>ChatSession</code> class |

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [model](./vertexai-preview.chatsession.md#chatsessionmodel) | | string | |
| [params](./vertexai-preview.chatsession.md#chatsessionparams) | | [StartChatParams](./vertexai-preview.startchatparams.md#startchatparams_interface) \| undefined | |
| [requestOptions](./vertexai-preview.chatsession.md#chatsessionrequestoptions) | | [RequestOptions](./vertexai-preview.requestoptions.md#requestoptions_interface) \| undefined | |

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [getHistory()](./vertexai-preview.chatsession.md#chatsessiongethistory) | | Gets the chat history so far. Blocked prompts are not added to history. Neither blocked candidates nor the prompts that generated them are added to history. |
| [sendMessage(request)](./vertexai-preview.chatsession.md#chatsessionsendmessage) | | Sends a chat message and receives a non-streaming [GenerateContentResult](./vertexai-preview.generatecontentresult.md#generatecontentresult_interface) |
| [sendMessageStream(request)](./vertexai-preview.chatsession.md#chatsessionsendmessagestream) | | Sends a chat message and receives the response as a [GenerateContentStreamResult](./vertexai-preview.generatecontentstreamresult.md#generatecontentstreamresult_interface) containing an iterable stream and a response promise. |

## ChatSession.(constructor)

Constructs a new instance of the `ChatSession` class

<b>Signature:</b>

```typescript
constructor(apiSettings: ApiSettings, model: string, chromeAdapter: ChromeAdapter, params?: StartChatParams | undefined, requestOptions?: RequestOptions | undefined);
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| apiSettings | ApiSettings | |
| model | string | |
| chromeAdapter | ChromeAdapter | |
| params | [StartChatParams](./vertexai-preview.startchatparams.md#startchatparams_interface) \| undefined | |
| requestOptions | [RequestOptions](./vertexai-preview.requestoptions.md#requestoptions_interface) \| undefined | |

## ChatSession.model

<b>Signature:</b>

```typescript
model: string;
```

## ChatSession.params

<b>Signature:</b>

```typescript
params?: StartChatParams | undefined;
```

## ChatSession.requestOptions

<b>Signature:</b>

```typescript
requestOptions?: RequestOptions | undefined;
```

## ChatSession.getHistory()

Gets the chat history so far. Blocked prompts are not added to history. Neither blocked candidates nor the prompts that generated them are added to history.

<b>Signature:</b>

```typescript
getHistory(): Promise<Content[]>;
```
<b>Returns:</b>

Promise&lt;[Content](./vertexai-preview.content.md#content_interface)<!-- -->\[\]&gt;

## ChatSession.sendMessage()

Sends a chat message and receives a non-streaming [GenerateContentResult](./vertexai-preview.generatecontentresult.md#generatecontentresult_interface)

<b>Signature:</b>

```typescript
sendMessage(request: string | Array<string | Part>): Promise<GenerateContentResult>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| request | string \| Array&lt;string \| [Part](./vertexai-preview.md#part)<!-- -->&gt; | |

<b>Returns:</b>

Promise&lt;[GenerateContentResult](./vertexai-preview.generatecontentresult.md#generatecontentresult_interface)<!-- -->&gt;

## ChatSession.sendMessageStream()

Sends a chat message and receives the response as a [GenerateContentStreamResult](./vertexai-preview.generatecontentstreamresult.md#generatecontentstreamresult_interface) containing an iterable stream and a response promise.

<b>Signature:</b>

```typescript
sendMessageStream(request: string | Array<string | Part>): Promise<GenerateContentStreamResult>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| request | string \| Array&lt;string \| [Part](./vertexai-preview.md#part)<!-- -->&gt; | |

<b>Returns:</b>

Promise&lt;[GenerateContentStreamResult](./vertexai-preview.generatecontentstreamresult.md#generatecontentstreamresult_interface)<!-- -->&gt;

Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ export interface Citation

| Property | Type | Description |
| --- | --- | --- |
| [endIndex](./vertexai.citation.md#citationendindex) | number | |
| [license](./vertexai.citation.md#citationlicense) | string | |
| [publicationDate](./vertexai.citation.md#citationpublicationdate) | Date | |
| [startIndex](./vertexai.citation.md#citationstartindex) | number | |
| [title](./vertexai.citation.md#citationtitle) | string | |
| [uri](./vertexai.citation.md#citationuri) | string | |
| [endIndex](./vertexai-preview.citation.md#citationendindex) | number | |
| [license](./vertexai-preview.citation.md#citationlicense) | string | |
| [publicationDate](./vertexai-preview.citation.md#citationpublicationdate) | Date | |
| [startIndex](./vertexai-preview.citation.md#citationstartindex) | number | |
| [title](./vertexai-preview.citation.md#citationtitle) | string | |
| [uri](./vertexai-preview.citation.md#citationuri) | string | |

## Citation.endIndex

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# CitationMetadata interface
Citation metadata that may be found on a <code>[GenerateContentCandidate](./vertexai.generatecontentcandidate.md#generatecontentcandidate_interface)</code>.
Citation metadata that may be found on a [GenerateContentCandidate](./vertexai-preview.generatecontentcandidate.md#generatecontentcandidate_interface)<!-- -->.

<b>Signature:</b>

Expand All @@ -22,7 +22,7 @@ export interface CitationMetadata

| Property | Type | Description |
| --- | --- | --- |
| [citations](./vertexai.citationmetadata.md#citationmetadatacitations) | [Citation](./vertexai.citation.md#citation_interface)<!-- -->\[\] | |
| [citations](./vertexai-preview.citationmetadata.md#citationmetadatacitations) | [Citation](./vertexai-preview.citation.md#citation_interface)<!-- -->\[\] | |

## CitationMetadata.citations

Expand Down
Loading
Loading