Skip to content

Commit f235bb8

Browse files
hsubox76hsubox76
committed
Address comments
1 parent 9af2001 commit f235bb8

27 files changed

+63
-63
lines changed

‎docs-devsite/vertexai.chatsession.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ export declare class ChatSession
3737
| Method | Modifiers | Description |
3838
| --- | --- | --- |
3939
| [getHistory()](./vertexai.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. |
40-
| [sendMessage(request)](./vertexai.chatsession.md#chatsessionsendmessage) | | Sends a chat message and receives a non-streaming [GenerateContentResult](./vertexai.generatecontentresult.md#generatecontentresult_interface) |
41-
| [sendMessageStream(request)](./vertexai.chatsession.md#chatsessionsendmessagestream) | | Sends a chat message and receives the response as a [GenerateContentStreamResult](./vertexai.generatecontentstreamresult.md#generatecontentstreamresult_interface) containing an iterable stream and a response promise. |
40+
| [sendMessage(request)](./vertexai.chatsession.md#chatsessionsendmessage) | | Sends a chat message and receives a non-streaming <code>[GenerateContentResult](./vertexai.generatecontentresult.md#generatecontentresult_interface)</code> |
41+
| [sendMessageStream(request)](./vertexai.chatsession.md#chatsessionsendmessagestream) | | Sends a chat message and receives the response as a <code>[GenerateContentStreamResult](./vertexai.generatecontentstreamresult.md#generatecontentstreamresult_interface)</code> containing an iterable stream and a response promise. |
4242

4343
## ChatSession.(constructor)
4444

@@ -98,7 +98,7 @@ Promise&lt;[Content](./vertexai.content.md#content_interface)<!-- -->\[\]&gt;
9898

9999
## ChatSession.sendMessage()
100100

101-
Sends a chat message and receives a non-streaming [GenerateContentResult](./vertexai.generatecontentresult.md#generatecontentresult_interface)
101+
Sends a chat message and receives a non-streaming <code>[GenerateContentResult](./vertexai.generatecontentresult.md#generatecontentresult_interface)</code>
102102

103103
<b>Signature:</b>
104104

@@ -118,7 +118,7 @@ Promise&lt;[GenerateContentResult](./vertexai.generatecontentresult.md#generatec
118118

119119
## ChatSession.sendMessageStream()
120120

121-
Sends a chat message and receives the response as a [GenerateContentStreamResult](./vertexai.generatecontentstreamresult.md#generatecontentstreamresult_interface) containing an iterable stream and a response promise.
121+
Sends a chat message and receives the response as a <code>[GenerateContentStreamResult](./vertexai.generatecontentstreamresult.md#generatecontentstreamresult_interface)</code> containing an iterable stream and a response promise.
122122

123123
<b>Signature:</b>
124124

‎docs-devsite/vertexai.citationmetadata.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

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

1515
<b>Signature:</b>
1616

‎docs-devsite/vertexai.customerrordata.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export interface CustomErrorData
2323
| Property | Type | Description |
2424
| --- | --- | --- |
2525
| [errorDetails](./vertexai.customerrordata.md#customerrordataerrordetails) | [ErrorDetails](./vertexai.errordetails.md#errordetails_interface)<!-- -->\[\] | Optional additional details about the error. |
26-
| [response](./vertexai.customerrordata.md#customerrordataresponse) | [GenerateContentResponse](./vertexai.generatecontentresponse.md#generatecontentresponse_interface) | Response from a [GenerateContentRequest](./vertexai.generatecontentrequest.md#generatecontentrequest_interface) |
26+
| [response](./vertexai.customerrordata.md#customerrordataresponse) | [GenerateContentResponse](./vertexai.generatecontentresponse.md#generatecontentresponse_interface) | Response from a <code>[GenerateContentRequest](./vertexai.generatecontentrequest.md#generatecontentrequest_interface)</code> |
2727
| [status](./vertexai.customerrordata.md#customerrordatastatus) | number | HTTP status code of the error response. |
2828
| [statusText](./vertexai.customerrordata.md#customerrordatastatustext) | string | HTTP status text of the error response. |
2929

@@ -39,7 +39,7 @@ errorDetails?: ErrorDetails[];
3939

4040
## CustomErrorData.response
4141

42-
Response from a [GenerateContentRequest](./vertexai.generatecontentrequest.md#generatecontentrequest_interface)
42+
Response from a <code>[GenerateContentRequest](./vertexai.generatecontentrequest.md#generatecontentrequest_interface)</code>
4343

4444
<b>Signature:</b>
4545

‎docs-devsite/vertexai.filedatapart.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# FileDataPart interface
13-
Content part interface if the part represents [FileData](./vertexai.filedata.md#filedata_interface)
13+
Content part interface if the part represents <code>[FileData](./vertexai.filedata.md#filedata_interface)</code>
1414

1515
<b>Signature:</b>
1616

‎docs-devsite/vertexai.functioncall.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# FunctionCall interface
13-
A predicted [FunctionCall](./vertexai.functioncall.md#functioncall_interface) returned from the model that contains a string representing the [FunctionDeclaration.name](./vertexai.functiondeclaration.md#functiondeclarationname) and a structured JSON object containing the parameters and their values.
13+
A predicted <code>[FunctionCall](./vertexai.functioncall.md#functioncall_interface)</code> returned from the model that contains a string representing the [FunctionDeclaration.name](./vertexai.functiondeclaration.md#functiondeclarationname) and a structured JSON object containing the parameters and their values.
1414

1515
<b>Signature:</b>
1616

‎docs-devsite/vertexai.functioncallpart.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# FunctionCallPart interface
13-
Content part interface if the part represents a [FunctionCall](./vertexai.functioncall.md#functioncall_interface)<!-- -->.
13+
Content part interface if the part represents a <code>[FunctionCall](./vertexai.functioncall.md#functioncall_interface)</code>.
1414

1515
<b>Signature:</b>
1616

‎docs-devsite/vertexai.functiondeclarationstool.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ export declare interface FunctionDeclarationsTool
2222

2323
| Property | Type | Description |
2424
| --- | --- | --- |
25-
| [functionDeclarations](./vertexai.functiondeclarationstool.md#functiondeclarationstoolfunctiondeclarations) | [FunctionDeclaration](./vertexai.functiondeclaration.md#functiondeclaration_interface)<!-- -->\[\] | Optional. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating [FunctionCall](./vertexai.functioncall.md#functioncall_interface) in the response. User should provide a [FunctionResponse](./vertexai.functionresponse.md#functionresponse_interface) for each function call in the next turn. Based on the function responses, the model will generate the final response back to the user. Maximum 64 function declarations can be provided. |
25+
| [functionDeclarations](./vertexai.functiondeclarationstool.md#functiondeclarationstoolfunctiondeclarations) | [FunctionDeclaration](./vertexai.functiondeclaration.md#functiondeclaration_interface)<!-- -->\[\] | Optional. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating <code>[FunctionCall](./vertexai.functioncall.md#functioncall_interface)</code> in the response. User should provide a <code>[FunctionResponse](./vertexai.functionresponse.md#functionresponse_interface)</code> for each function call in the next turn. Based on the function responses, the model will generate the final response back to the user. Maximum 64 function declarations can be provided. |
2626

2727
## FunctionDeclarationsTool.functionDeclarations
2828

29-
Optional. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating [FunctionCall](./vertexai.functioncall.md#functioncall_interface) in the response. User should provide a [FunctionResponse](./vertexai.functionresponse.md#functionresponse_interface) for each function call in the next turn. Based on the function responses, the model will generate the final response back to the user. Maximum 64 function declarations can be provided.
29+
Optional. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating <code>[FunctionCall](./vertexai.functioncall.md#functioncall_interface)</code> in the response. User should provide a <code>[FunctionResponse](./vertexai.functionresponse.md#functionresponse_interface)</code> for each function call in the next turn. Based on the function responses, the model will generate the final response back to the user. Maximum 64 function declarations can be provided.
3030

3131
<b>Signature:</b>
3232

‎docs-devsite/vertexai.functionresponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# FunctionResponse interface
13-
The result output from a [FunctionCall](./vertexai.functioncall.md#functioncall_interface) that contains a string representing the [FunctionDeclaration.name](./vertexai.functiondeclaration.md#functiondeclarationname) and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall](./vertexai.functioncall.md#functioncall_interface) made based on model prediction.
13+
The result output from a <code>[FunctionCall](./vertexai.functioncall.md#functioncall_interface)</code> that contains a string representing the [FunctionDeclaration.name](./vertexai.functiondeclaration.md#functiondeclarationname) and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a <code>[FunctionCall](./vertexai.functioncall.md#functioncall_interface)</code> made based on model prediction.
1414

1515
<b>Signature:</b>
1616

‎docs-devsite/vertexai.functionresponsepart.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# FunctionResponsePart interface
13-
Content part interface if the part represents [FunctionResponse](./vertexai.functionresponse.md#functionresponse_interface)<!-- -->.
13+
Content part interface if the part represents <code>[FunctionResponse](./vertexai.functionresponse.md#functionresponse_interface)</code>.
1414

1515
<b>Signature:</b>
1616

‎docs-devsite/vertexai.generatecontentcandidate.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# GenerateContentCandidate interface
13-
A candidate returned as part of a [GenerateContentResponse](./vertexai.generatecontentresponse.md#generatecontentresponse_interface)<!-- -->.
13+
A candidate returned as part of a <code>[GenerateContentResponse](./vertexai.generatecontentresponse.md#generatecontentresponse_interface)</code>.
1414

1515
<b>Signature:</b>
1616

‎docs-devsite/vertexai.generationconfig.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ export interface GenerationConfig
2626
| [frequencyPenalty](./vertexai.generationconfig.md#generationconfigfrequencypenalty) | number | |
2727
| [maxOutputTokens](./vertexai.generationconfig.md#generationconfigmaxoutputtokens) | number | |
2828
| [presencePenalty](./vertexai.generationconfig.md#generationconfigpresencepenalty) | number | |
29-
| [responseMimeType](./vertexai.generationconfig.md#generationconfigresponsemimetype) | string | Output response MIME type of the generated candidate text. Supported MIME types are <code>text/plain</code> (default, text output) and <code>application/json</code> (JSON response in the candidates). |
30-
| [responseSchema](./vertexai.generationconfig.md#generationconfigresponseschema) | [TypedSchema](./vertexai.md#typedschema) \| [SchemaRequest](./vertexai.schemarequest.md#schemarequest_interface) | Output response schema of the generated candidate text. This value can be a class generated with a <code>{@link Schema}</code> static method like <code>Schema.string()</code> or <code>Schema.object()</code> or it can be a plain JS object matching the <code>[SchemaRequest](./vertexai.schemarequest.md#schemarequest_interface)</code> interface. <br/>Note: This only applies when the specified <code>responseMIMEType</code> supports a schema; currently this is limited to <code>application/json</code>. |
29+
| [responseMimeType](./vertexai.generationconfig.md#generationconfigresponsemimetype) | string | Output response MIME type of the generated candidate text. Supported MIME types are <code>text/plain</code> (default, text output), <code>application/json</code> (JSON response in the candidates), and <code>text/x.enum</code>. |
30+
| [responseSchema](./vertexai.generationconfig.md#generationconfigresponseschema) | [TypedSchema](./vertexai.md#typedschema) \| [SchemaRequest](./vertexai.schemarequest.md#schemarequest_interface) | Output response schema of the generated candidate text. This value can be a class generated with a <code>[Schema](./vertexai.schema.md#schema_class)</code> static method like <code>Schema.string()</code> or <code>Schema.object()</code> or it can be a plain JS object matching the <code>[SchemaRequest](./vertexai.schemarequest.md#schemarequest_interface)</code> interface. <br/>Note: This only applies when the specified <code>responseMIMEType</code> supports a schema; currently this is limited to <code>application/json</code> and <code>text/x.enum</code>. |
3131
| [stopSequences](./vertexai.generationconfig.md#generationconfigstopsequences) | string\[\] | |
3232
| [temperature](./vertexai.generationconfig.md#generationconfigtemperature) | number | |
3333
| [topK](./vertexai.generationconfig.md#generationconfigtopk) | number | |
@@ -67,7 +67,7 @@ presencePenalty?: number;
6767

6868
## GenerationConfig.responseMimeType
6969

70-
Output response MIME type of the generated candidate text. Supported MIME types are `text/plain` (default, text output) and `application/json` (JSON response in the candidates).
70+
Output response MIME type of the generated candidate text. Supported MIME types are `text/plain` (default, text output), `application/json` (JSON response in the candidates), and `text/x.enum`<!-- -->.
7171

7272
<b>Signature:</b>
7373

@@ -77,7 +77,7 @@ responseMimeType?: string;
7777

7878
## GenerationConfig.responseSchema
7979

80-
Output response schema of the generated candidate text. This value can be a class generated with a `{@link Schema}` static method like `Schema.string()` or `Schema.object()` or it can be a plain JS object matching the <code>[SchemaRequest](./vertexai.schemarequest.md#schemarequest_interface)</code> interface. <br/>Note: This only applies when the specified `responseMIMEType` supports a schema; currently this is limited to `application/json`<!-- -->.
80+
Output response schema of the generated candidate text. This value can be a class generated with a <code>[Schema](./vertexai.schema.md#schema_class)</code> static method like `Schema.string()` or `Schema.object()` or it can be a plain JS object matching the <code>[SchemaRequest](./vertexai.schemarequest.md#schemarequest_interface)</code> interface. <br/>Note: This only applies when the specified `responseMIMEType` supports a schema; currently this is limited to `application/json` and `text/x.enum`<!-- -->.
8181

8282
<b>Signature:</b>
8383

‎docs-devsite/vertexai.generativemodel.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ export declare class GenerativeModel
4141
| Method | Modifiers | Description |
4242
| --- | --- | --- |
4343
| [countTokens(request)](./vertexai.generativemodel.md#generativemodelcounttokens) | | Counts the tokens in the provided request. |
44-
| [generateContent(request)](./vertexai.generativemodel.md#generativemodelgeneratecontent) | | Makes a single non-streaming call to the model and returns an object containing a single [GenerateContentResponse](./vertexai.generatecontentresponse.md#generatecontentresponse_interface)<!-- -->. |
44+
| [generateContent(request)](./vertexai.generativemodel.md#generativemodelgeneratecontent) | | Makes a single non-streaming call to the model and returns an object containing a single <code>[GenerateContentResponse](./vertexai.generatecontentresponse.md#generatecontentresponse_interface)</code>. |
4545
| [generateContentStream(request)](./vertexai.generativemodel.md#generativemodelgeneratecontentstream) | | Makes a single streaming call to the model and returns an object containing an iterable stream that iterates over all chunks in the streaming response as well as a promise that returns the final aggregated response. |
46-
| [startChat(startChatParams)](./vertexai.generativemodel.md#generativemodelstartchat) | | Gets a new [ChatSession](./vertexai.chatsession.md#chatsession_class) instance which can be used for multi-turn chats. |
46+
| [startChat(startChatParams)](./vertexai.generativemodel.md#generativemodelstartchat) | | Gets a new <code>[ChatSession](./vertexai.chatsession.md#chatsession_class)</code> instance which can be used for multi-turn chats. |
4747

4848
## GenerativeModel.(constructor)
4949

@@ -141,7 +141,7 @@ Promise&lt;[CountTokensResponse](./vertexai.counttokensresponse.md#counttokensre
141141

142142
## GenerativeModel.generateContent()
143143

144-
Makes a single non-streaming call to the model and returns an object containing a single [GenerateContentResponse](./vertexai.generatecontentresponse.md#generatecontentresponse_interface)<!-- -->.
144+
Makes a single non-streaming call to the model and returns an object containing a single <code>[GenerateContentResponse](./vertexai.generatecontentresponse.md#generatecontentresponse_interface)</code>.
145145

146146
<b>Signature:</b>
147147

@@ -181,7 +181,7 @@ Promise&lt;[GenerateContentStreamResult](./vertexai.generatecontentstreamresult.
181181

182182
## GenerativeModel.startChat()
183183

184-
Gets a new [ChatSession](./vertexai.chatsession.md#chatsession_class) instance which can be used for multi-turn chats.
184+
Gets a new <code>[ChatSession](./vertexai.chatsession.md#chatsession_class)</code> instance which can be used for multi-turn chats.
185185

186186
<b>Signature:</b>
187187

0 commit comments

Comments
 (0)