Skip to content

Commit 8bb66c2

Browse files
authored
docs(vertexai): remove HTML <code> tags (#8900)
We wrap links that reference public APIs with `<code>` tags so that they can be rendered as code in devsite. Unfortunately, VSCode's hover feature can not render these links at all. Since there are no other alternatives for creating code-formatted links, we should remove the problematic HTML `<code>` tags.
1 parent e055e90 commit 8bb66c2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+146
-146
lines changed

docs-devsite/vertexai.chatsession.md

Lines changed: 4 additions & 4 deletions
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 <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. |
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. |
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 <code>[GenerateContentResult](./vertexai.generatecontentresult.md#generatecontentresult_interface)</code>
101+
Sends a chat message and receives a non-streaming [GenerateContentResult](./vertexai.generatecontentresult.md#generatecontentresult_interface)
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 <code>[GenerateContentStreamResult](./vertexai.generatecontentstreamresult.md#generatecontentstreamresult_interface)</code> containing an iterable stream and a response promise.
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.
122122

123123
<b>Signature:</b>
124124

docs-devsite/vertexai.citationmetadata.md

Lines changed: 1 addition & 1 deletion
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 <code>[GenerateContentCandidate](./vertexai.generatecontentcandidate.md#generatecontentcandidate_interface)</code>.
13+
Citation metadata that may be found on a [GenerateContentCandidate](./vertexai.generatecontentcandidate.md#generatecontentcandidate_interface)<!-- -->.
1414

1515
<b>Signature:</b>
1616

docs-devsite/vertexai.counttokensrequest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export interface CountTokensRequest
2525
| [contents](./vertexai.counttokensrequest.md#counttokensrequestcontents) | [Content](./vertexai.content.md#content_interface)<!-- -->\[\] | |
2626
| [generationConfig](./vertexai.counttokensrequest.md#counttokensrequestgenerationconfig) | [GenerationConfig](./vertexai.generationconfig.md#generationconfig_interface) | Configuration options that control how the model generates a response. |
2727
| [systemInstruction](./vertexai.counttokensrequest.md#counttokensrequestsysteminstruction) | string \| [Part](./vertexai.md#part) \| [Content](./vertexai.content.md#content_interface) | Instructions that direct the model to behave a certain way. |
28-
| [tools](./vertexai.counttokensrequest.md#counttokensrequesttools) | [Tool](./vertexai.md#tool)<!-- -->\[\] | <code>[Tool](./vertexai.md#tool)</code> configuration. |
28+
| [tools](./vertexai.counttokensrequest.md#counttokensrequesttools) | [Tool](./vertexai.md#tool)<!-- -->\[\] | [Tool](./vertexai.md#tool) configuration. |
2929

3030
## CountTokensRequest.contents
3131

@@ -57,7 +57,7 @@ systemInstruction?: string | Part | Content;
5757

5858
## CountTokensRequest.tools
5959

60-
<code>[Tool](./vertexai.md#tool)</code> configuration.
60+
[Tool](./vertexai.md#tool) configuration.
6161

6262
<b>Signature:</b>
6363

docs-devsite/vertexai.customerrordata.md

Lines changed: 2 additions & 2 deletions
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 <code>[GenerateContentRequest](./vertexai.generatecontentrequest.md#generatecontentrequest_interface)</code> |
26+
| [response](./vertexai.customerrordata.md#customerrordataresponse) | [GenerateContentResponse](./vertexai.generatecontentresponse.md#generatecontentresponse_interface) | Response from a [GenerateContentRequest](./vertexai.generatecontentrequest.md#generatecontentrequest_interface) |
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 <code>[GenerateContentRequest](./vertexai.generatecontentrequest.md#generatecontentrequest_interface)</code>
42+
Response from a [GenerateContentRequest](./vertexai.generatecontentrequest.md#generatecontentrequest_interface)
4343

4444
<b>Signature:</b>
4545

docs-devsite/vertexai.filedatapart.md

Lines changed: 1 addition & 1 deletion
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 <code>[FileData](./vertexai.filedata.md#filedata_interface)</code>
13+
Content part interface if the part represents [FileData](./vertexai.filedata.md#filedata_interface)
1414

1515
<b>Signature:</b>
1616

docs-devsite/vertexai.functioncall.md

Lines changed: 1 addition & 1 deletion
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 <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.
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.
1414

1515
<b>Signature:</b>
1616

docs-devsite/vertexai.functioncallpart.md

Lines changed: 1 addition & 1 deletion
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 <code>[FunctionCall](./vertexai.functioncall.md#functioncall_interface)</code>.
13+
Content part interface if the part represents a [FunctionCall](./vertexai.functioncall.md#functioncall_interface)<!-- -->.
1414

1515
<b>Signature:</b>
1616

docs-devsite/vertexai.functiondeclarationstool.md

Lines changed: 2 additions & 2 deletions
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 <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. |
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. |
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 <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.
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.
3030

3131
<b>Signature:</b>
3232

docs-devsite/vertexai.functionresponse.md

Lines changed: 1 addition & 1 deletion
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 <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.
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.
1414

1515
<b>Signature:</b>
1616

docs-devsite/vertexai.functionresponsepart.md

Lines changed: 1 addition & 1 deletion
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 <code>[FunctionResponse](./vertexai.functionresponse.md#functionresponse_interface)</code>.
13+
Content part interface if the part represents [FunctionResponse](./vertexai.functionresponse.md#functionresponse_interface)<!-- -->.
1414

1515
<b>Signature:</b>
1616

0 commit comments

Comments
 (0)