Skip to content

Commit 7ce1711

Browse files
committed
fix circular dependency
1 parent 2d93fc2 commit 7ce1711

15 files changed

+634
-132
lines changed

docs-devsite/_toc.yaml

Lines changed: 50 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -461,124 +461,98 @@ toc:
461461
path: /docs/reference/js/storage.uploadtask.md
462462
- title: UploadTaskSnapshot
463463
path: /docs/reference/js/storage.uploadtasksnapshot.md
464-
- title: vertexai
465-
path: /docs/reference/js/vertexai.md
464+
- title: vertexai-preview
465+
path: /docs/reference/js/vertexai-preview.md
466466
section:
467-
- title: ArraySchema
468-
path: /docs/reference/js/vertexai.arrayschema.md
469467
- title: BaseParams
470-
path: /docs/reference/js/vertexai.baseparams.md
471-
- title: BooleanSchema
472-
path: /docs/reference/js/vertexai.booleanschema.md
468+
path: /docs/reference/js/vertexai-preview.baseparams.md
473469
- title: ChatSession
474-
path: /docs/reference/js/vertexai.chatsession.md
470+
path: /docs/reference/js/vertexai-preview.chatsession.md
475471
- title: Citation
476-
path: /docs/reference/js/vertexai.citation.md
472+
path: /docs/reference/js/vertexai-preview.citation.md
477473
- title: CitationMetadata
478-
path: /docs/reference/js/vertexai.citationmetadata.md
474+
path: /docs/reference/js/vertexai-preview.citationmetadata.md
479475
- title: Content
480-
path: /docs/reference/js/vertexai.content.md
476+
path: /docs/reference/js/vertexai-preview.content.md
481477
- title: CountTokensRequest
482-
path: /docs/reference/js/vertexai.counttokensrequest.md
478+
path: /docs/reference/js/vertexai-preview.counttokensrequest.md
483479
- title: CountTokensResponse
484-
path: /docs/reference/js/vertexai.counttokensresponse.md
485-
- title: CustomErrorData
486-
path: /docs/reference/js/vertexai.customerrordata.md
480+
path: /docs/reference/js/vertexai-preview.counttokensresponse.md
487481
- title: Date_2
488-
path: /docs/reference/js/vertexai.date_2.md
482+
path: /docs/reference/js/vertexai-preview.date_2.md
489483
- title: EnhancedGenerateContentResponse
490-
path: /docs/reference/js/vertexai.enhancedgeneratecontentresponse.md
491-
- title: ErrorDetails
492-
path: /docs/reference/js/vertexai.errordetails.md
484+
path: /docs/reference/js/vertexai-preview.enhancedgeneratecontentresponse.md
493485
- title: FileData
494-
path: /docs/reference/js/vertexai.filedata.md
486+
path: /docs/reference/js/vertexai-preview.filedata.md
495487
- title: FileDataPart
496-
path: /docs/reference/js/vertexai.filedatapart.md
488+
path: /docs/reference/js/vertexai-preview.filedatapart.md
497489
- title: FunctionCall
498-
path: /docs/reference/js/vertexai.functioncall.md
490+
path: /docs/reference/js/vertexai-preview.functioncall.md
499491
- title: FunctionCallingConfig
500-
path: /docs/reference/js/vertexai.functioncallingconfig.md
492+
path: /docs/reference/js/vertexai-preview.functioncallingconfig.md
501493
- title: FunctionCallPart
502-
path: /docs/reference/js/vertexai.functioncallpart.md
494+
path: /docs/reference/js/vertexai-preview.functioncallpart.md
503495
- title: FunctionDeclaration
504-
path: /docs/reference/js/vertexai.functiondeclaration.md
496+
path: /docs/reference/js/vertexai-preview.functiondeclaration.md
497+
- title: FunctionDeclarationSchema
498+
path: /docs/reference/js/vertexai-preview.functiondeclarationschema.md
499+
- title: FunctionDeclarationSchemaProperty
500+
path: /docs/reference/js/vertexai-preview.functiondeclarationschemaproperty.md
505501
- title: FunctionDeclarationsTool
506-
path: /docs/reference/js/vertexai.functiondeclarationstool.md
502+
path: /docs/reference/js/vertexai-preview.functiondeclarationstool.md
507503
- title: FunctionResponse
508-
path: /docs/reference/js/vertexai.functionresponse.md
504+
path: /docs/reference/js/vertexai-preview.functionresponse.md
509505
- title: FunctionResponsePart
510-
path: /docs/reference/js/vertexai.functionresponsepart.md
506+
path: /docs/reference/js/vertexai-preview.functionresponsepart.md
511507
- title: GenerateContentCandidate
512-
path: /docs/reference/js/vertexai.generatecontentcandidate.md
508+
path: /docs/reference/js/vertexai-preview.generatecontentcandidate.md
513509
- title: GenerateContentRequest
514-
path: /docs/reference/js/vertexai.generatecontentrequest.md
510+
path: /docs/reference/js/vertexai-preview.generatecontentrequest.md
515511
- title: GenerateContentResponse
516-
path: /docs/reference/js/vertexai.generatecontentresponse.md
512+
path: /docs/reference/js/vertexai-preview.generatecontentresponse.md
517513
- title: GenerateContentResult
518-
path: /docs/reference/js/vertexai.generatecontentresult.md
514+
path: /docs/reference/js/vertexai-preview.generatecontentresult.md
519515
- title: GenerateContentStreamResult
520-
path: /docs/reference/js/vertexai.generatecontentstreamresult.md
516+
path: /docs/reference/js/vertexai-preview.generatecontentstreamresult.md
521517
- title: GenerationConfig
522-
path: /docs/reference/js/vertexai.generationconfig.md
518+
path: /docs/reference/js/vertexai-preview.generationconfig.md
523519
- title: GenerativeContentBlob
524-
path: /docs/reference/js/vertexai.generativecontentblob.md
520+
path: /docs/reference/js/vertexai-preview.generativecontentblob.md
525521
- title: GenerativeModel
526-
path: /docs/reference/js/vertexai.generativemodel.md
522+
path: /docs/reference/js/vertexai-preview.generativemodel.md
527523
- title: GroundingAttribution
528-
path: /docs/reference/js/vertexai.groundingattribution.md
524+
path: /docs/reference/js/vertexai-preview.groundingattribution.md
529525
- title: GroundingMetadata
530-
path: /docs/reference/js/vertexai.groundingmetadata.md
526+
path: /docs/reference/js/vertexai-preview.groundingmetadata.md
531527
- title: InlineDataPart
532-
path: /docs/reference/js/vertexai.inlinedatapart.md
533-
- title: IntegerSchema
534-
path: /docs/reference/js/vertexai.integerschema.md
528+
path: /docs/reference/js/vertexai-preview.inlinedatapart.md
535529
- title: ModelParams
536-
path: /docs/reference/js/vertexai.modelparams.md
537-
- title: NumberSchema
538-
path: /docs/reference/js/vertexai.numberschema.md
539-
- title: ObjectSchema
540-
path: /docs/reference/js/vertexai.objectschema.md
541-
- title: ObjectSchemaInterface
542-
path: /docs/reference/js/vertexai.objectschemainterface.md
530+
path: /docs/reference/js/vertexai-preview.modelparams.md
543531
- title: PromptFeedback
544-
path: /docs/reference/js/vertexai.promptfeedback.md
532+
path: /docs/reference/js/vertexai-preview.promptfeedback.md
545533
- title: RequestOptions
546-
path: /docs/reference/js/vertexai.requestoptions.md
534+
path: /docs/reference/js/vertexai-preview.requestoptions.md
547535
- title: RetrievedContextAttribution
548-
path: /docs/reference/js/vertexai.retrievedcontextattribution.md
536+
path: /docs/reference/js/vertexai-preview.retrievedcontextattribution.md
549537
- title: SafetyRating
550-
path: /docs/reference/js/vertexai.safetyrating.md
538+
path: /docs/reference/js/vertexai-preview.safetyrating.md
551539
- title: SafetySetting
552-
path: /docs/reference/js/vertexai.safetysetting.md
553-
- title: Schema
554-
path: /docs/reference/js/vertexai.schema.md
555-
- title: SchemaInterface
556-
path: /docs/reference/js/vertexai.schemainterface.md
557-
- title: SchemaParams
558-
path: /docs/reference/js/vertexai.schemaparams.md
559-
- title: SchemaRequest
560-
path: /docs/reference/js/vertexai.schemarequest.md
561-
- title: SchemaShared
562-
path: /docs/reference/js/vertexai.schemashared.md
540+
path: /docs/reference/js/vertexai-preview.safetysetting.md
563541
- title: Segment
564-
path: /docs/reference/js/vertexai.segment.md
542+
path: /docs/reference/js/vertexai-preview.segment.md
565543
- title: StartChatParams
566-
path: /docs/reference/js/vertexai.startchatparams.md
567-
- title: StringSchema
568-
path: /docs/reference/js/vertexai.stringschema.md
544+
path: /docs/reference/js/vertexai-preview.startchatparams.md
569545
- title: TextPart
570-
path: /docs/reference/js/vertexai.textpart.md
546+
path: /docs/reference/js/vertexai-preview.textpart.md
571547
- title: ToolConfig
572-
path: /docs/reference/js/vertexai.toolconfig.md
548+
path: /docs/reference/js/vertexai-preview.toolconfig.md
573549
- title: UsageMetadata
574-
path: /docs/reference/js/vertexai.usagemetadata.md
550+
path: /docs/reference/js/vertexai-preview.usagemetadata.md
575551
- title: VertexAI
576-
path: /docs/reference/js/vertexai.vertexai.md
577-
- title: VertexAIError
578-
path: /docs/reference/js/vertexai.vertexaierror.md
552+
path: /docs/reference/js/vertexai-preview.vertexai.md
579553
- title: VertexAIOptions
580-
path: /docs/reference/js/vertexai.vertexaioptions.md
554+
path: /docs/reference/js/vertexai-preview.vertexaioptions.md
581555
- title: VideoMetadata
582-
path: /docs/reference/js/vertexai.videometadata.md
556+
path: /docs/reference/js/vertexai-preview.videometadata.md
583557
- title: WebAttribution
584-
path: /docs/reference/js/vertexai.webattribution.md
558+
path: /docs/reference/js/vertexai-preview.webattribution.md

docs-devsite/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,5 @@ https://github.com/firebase/firebase-js-sdk
2727
| [@firebase/performance](./performance.md#performance_package) | The Firebase Performance Monitoring Web SDK. This SDK does not work in a Node.js environment. |
2828
| [@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. |
2929
| [@firebase/storage](./storage.md#storage_package) | Cloud Storage for Firebase |
30-
| [@firebase/vertexai](./vertexai.md#vertexai_package) | The Vertex AI in Firebase Web SDK. |
30+
| [@firebase/vertexai-preview](./vertexai-preview.md#vertexai-preview_package) | The Vertex AI For Firebase Web SDK. |
3131

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# BaseParams interface
13+
Base parameters for a number of methods.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export interface BaseParams
19+
```
20+
21+
## Properties
22+
23+
| Property | Type | Description |
24+
| --- | --- | --- |
25+
| [generationConfig](./vertexai-preview.baseparams.md#baseparamsgenerationconfig) | [GenerationConfig](./vertexai-preview.generationconfig.md#generationconfig_interface) | |
26+
| [safetySettings](./vertexai-preview.baseparams.md#baseparamssafetysettings) | [SafetySetting](./vertexai-preview.safetysetting.md#safetysetting_interface)<!-- -->\[\] | |
27+
28+
## BaseParams.generationConfig
29+
30+
<b>Signature:</b>
31+
32+
```typescript
33+
generationConfig?: GenerationConfig;
34+
```
35+
36+
## BaseParams.safetySettings
37+
38+
<b>Signature:</b>
39+
40+
```typescript
41+
safetySettings?: SafetySetting[];
42+
```
Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# ChatSession class
13+
ChatSession class that enables sending chat messages and stores history of sent and received messages so far.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export declare class ChatSession
19+
```
20+
21+
## Constructors
22+
23+
| Constructor | Modifiers | Description |
24+
| --- | --- | --- |
25+
| [(constructor)(apiSettings, model, params, requestOptions)](./vertexai-preview.chatsession.md#chatsessionconstructor) | | Constructs a new instance of the <code>ChatSession</code> class |
26+
27+
## Properties
28+
29+
| Property | Modifiers | Type | Description |
30+
| --- | --- | --- | --- |
31+
| [model](./vertexai-preview.chatsession.md#chatsessionmodel) | | string | |
32+
| [params](./vertexai-preview.chatsession.md#chatsessionparams) | | [StartChatParams](./vertexai-preview.startchatparams.md#startchatparams_interface) \| undefined | |
33+
| [requestOptions](./vertexai-preview.chatsession.md#chatsessionrequestoptions) | | [RequestOptions](./vertexai-preview.requestoptions.md#requestoptions_interface) \| undefined | |
34+
35+
## Methods
36+
37+
| Method | Modifiers | Description |
38+
| --- | --- | --- |
39+
| [getHistory()](./vertexai-preview.chatsession.md#chatsessiongethistory) | | Gets the chat history so far. Blocked prompts are not added to history. Blocked candidates are not added to history, nor are the prompts that generated them. |
40+
| [sendMessage(request)](./vertexai-preview.chatsession.md#chatsessionsendmessage) | | Sends a chat message and receives a non-streaming [GenerateContentResult](./vertexai-preview.generatecontentresult.md#generatecontentresult_interface) |
41+
| [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. |
42+
43+
## ChatSession.(constructor)
44+
45+
Constructs a new instance of the `ChatSession` class
46+
47+
<b>Signature:</b>
48+
49+
```typescript
50+
constructor(apiSettings: ApiSettings, model: string, params?: StartChatParams | undefined, requestOptions?: RequestOptions | undefined);
51+
```
52+
53+
#### Parameters
54+
55+
| Parameter | Type | Description |
56+
| --- | --- | --- |
57+
| apiSettings | ApiSettings | |
58+
| model | string | |
59+
| params | [StartChatParams](./vertexai-preview.startchatparams.md#startchatparams_interface) \| undefined | |
60+
| requestOptions | [RequestOptions](./vertexai-preview.requestoptions.md#requestoptions_interface) \| undefined | |
61+
62+
## ChatSession.model
63+
64+
<b>Signature:</b>
65+
66+
```typescript
67+
model: string;
68+
```
69+
70+
## ChatSession.params
71+
72+
<b>Signature:</b>
73+
74+
```typescript
75+
params?: StartChatParams | undefined;
76+
```
77+
78+
## ChatSession.requestOptions
79+
80+
<b>Signature:</b>
81+
82+
```typescript
83+
requestOptions?: RequestOptions | undefined;
84+
```
85+
86+
## ChatSession.getHistory()
87+
88+
Gets the chat history so far. Blocked prompts are not added to history. Blocked candidates are not added to history, nor are the prompts that generated them.
89+
90+
<b>Signature:</b>
91+
92+
```typescript
93+
getHistory(): Promise<Content[]>;
94+
```
95+
<b>Returns:</b>
96+
97+
Promise&lt;[Content](./vertexai-preview.content.md#content_interface)<!-- -->\[\]&gt;
98+
99+
## ChatSession.sendMessage()
100+
101+
Sends a chat message and receives a non-streaming [GenerateContentResult](./vertexai-preview.generatecontentresult.md#generatecontentresult_interface)
102+
103+
<b>Signature:</b>
104+
105+
```typescript
106+
sendMessage(request: string | Array<string | Part>): Promise<GenerateContentResult>;
107+
```
108+
109+
#### Parameters
110+
111+
| Parameter | Type | Description |
112+
| --- | --- | --- |
113+
| request | string \| Array&lt;string \| [Part](./vertexai-preview.md#part)<!-- -->&gt; | |
114+
115+
<b>Returns:</b>
116+
117+
Promise&lt;[GenerateContentResult](./vertexai-preview.generatecontentresult.md#generatecontentresult_interface)<!-- -->&gt;
118+
119+
## ChatSession.sendMessageStream()
120+
121+
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.
122+
123+
<b>Signature:</b>
124+
125+
```typescript
126+
sendMessageStream(request: string | Array<string | Part>): Promise<GenerateContentStreamResult>;
127+
```
128+
129+
#### Parameters
130+
131+
| Parameter | Type | Description |
132+
| --- | --- | --- |
133+
| request | string \| Array&lt;string \| [Part](./vertexai-preview.md#part)<!-- -->&gt; | |
134+
135+
<b>Returns:</b>
136+
137+
Promise&lt;[GenerateContentStreamResult](./vertexai-preview.generatecontentstreamresult.md#generatecontentstreamresult_interface)<!-- -->&gt;
138+

0 commit comments

Comments
 (0)