Skip to content

Commit 0c5faf3

Browse files
committed
addressed PR comments
1 parent 73549fa commit 0c5faf3

File tree

4 files changed

+15
-13
lines changed

4 files changed

+15
-13
lines changed

packages/vertexai/src/public-types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import { FirebaseApp } from '@firebase/app';
2020
export * from './types';
2121

2222
/**
23-
* An instance of Firebase Vertex AI.
23+
* An instance of the Vertex AI for Firebase SDK.
2424
* @public
2525
*/
2626
export interface VertexAI {

packages/vertexai/src/types/content.ts

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ export interface Content {
2727
}
2828

2929
/**
30-
* Content part - includes text, image/video, or function call/response part types.
30+
* Content part - includes text, image/video, or function call/response
31+
* part types.
3132
* @public
3233
*/
3334
export type Part =
@@ -115,8 +116,8 @@ export interface FileDataPart {
115116
}
116117

117118
/**
118-
* A predicted [FunctionCall] returned from the model
119-
* that contains a string representing the [FunctionDeclaration.name]
119+
* A predicted {@link FunctionCall} returned from the model
120+
* that contains a string representing the {@link FunctionDeclaration.name}
120121
* and a structured JSON object containing the parameters and their values.
121122
* @public
122123
*/
@@ -126,11 +127,11 @@ export interface FunctionCall {
126127
}
127128

128129
/**
129-
* The result output from a [FunctionCall] that contains a string
130-
* representing the [FunctionDeclaration.name]
130+
* The result output from a {@link FunctionCall} that contains a string
131+
* representing the {@link FunctionDeclaration.name}
131132
* and a structured JSON object containing any output
132133
* from the function is used as context to the model.
133-
* This should contain the result of a [FunctionCall]
134+
* This should contain the result of a {@link FunctionCall}
134135
* made based on model prediction.
135136
* @public
136137
*/

packages/vertexai/src/types/requests.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export interface ModelParams extends BaseParams {
4444
}
4545

4646
/**
47-
* Request sent to `generateContent` endpoint.
47+
* Request sent through {@link GenerativeModel.generateContent}
4848
* @public
4949
*/
5050
export interface GenerateContentRequest extends BaseParams {
@@ -121,9 +121,10 @@ export declare type Tool = FunctionDeclarationsTool;
121121

122122
/**
123123
* Structured representation of a function declaration as defined by the
124-
* [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included
124+
* {@link https://spec.openapis.org/oas/v3.0.3 | OpenAPI 3.0 specification}.
125+
* Included
125126
* in this declaration are the function name and parameters. This
126-
* FunctionDeclaration is a representation of a block of code that can be used
127+
* `FunctionDeclaration` is a representation of a block of code that can be used
127128
* as a Tool by the model and executed by the client.
128129
* @public
129130
*/
@@ -148,7 +149,7 @@ export declare interface FunctionDeclaration {
148149
}
149150

150151
/**
151-
* A FunctionDeclarationsTool is a piece of code that enables the system to
152+
* A `FunctionDeclarationsTool` is a piece of code that enables the system to
152153
* interact with external systems to perform an action, or set of actions,
153154
* outside of knowledge and scope of the model.
154155
* @public

packages/vertexai/src/types/responses.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import {
2525
} from './enums';
2626

2727
/**
28-
* Result object returned from generateContent() call.
28+
* Result object returned from {@link GenerativeModel.generateContent} call.
2929
*
3030
* @public
3131
*/
@@ -34,7 +34,7 @@ export interface GenerateContentResult {
3434
}
3535

3636
/**
37-
* Result object returned from generateContentStream() call.
37+
* Result object returned from {@link GenerativeModel.generateContentStream} call.
3838
* Iterate over `stream` to get chunks as they come in and/or
3939
* use the `response` promise to get the aggregated response when
4040
* the stream is done.

0 commit comments

Comments
 (0)