File tree Expand file tree Collapse file tree 4 files changed +15
-13
lines changed Expand file tree Collapse file tree 4 files changed +15
-13
lines changed Original file line number Diff line number Diff line change @@ -20,7 +20,7 @@ import { FirebaseApp } from '@firebase/app';
20
20
export * from './types' ;
21
21
22
22
/**
23
- * An instance of Firebase Vertex AI.
23
+ * An instance of the Vertex AI for Firebase SDK .
24
24
* @public
25
25
*/
26
26
export interface VertexAI {
Original file line number Diff line number Diff line change @@ -27,7 +27,8 @@ export interface Content {
27
27
}
28
28
29
29
/**
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.
31
32
* @public
32
33
*/
33
34
export type Part =
@@ -115,8 +116,8 @@ export interface FileDataPart {
115
116
}
116
117
117
118
/**
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}
120
121
* and a structured JSON object containing the parameters and their values.
121
122
* @public
122
123
*/
@@ -126,11 +127,11 @@ export interface FunctionCall {
126
127
}
127
128
128
129
/**
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}
131
132
* and a structured JSON object containing any output
132
133
* 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}
134
135
* made based on model prediction.
135
136
* @public
136
137
*/
Original file line number Diff line number Diff line change @@ -44,7 +44,7 @@ export interface ModelParams extends BaseParams {
44
44
}
45
45
46
46
/**
47
- * Request sent to `generateContent` endpoint.
47
+ * Request sent through { @link GenerativeModel.generateContent}
48
48
* @public
49
49
*/
50
50
export interface GenerateContentRequest extends BaseParams {
@@ -121,9 +121,10 @@ export declare type Tool = FunctionDeclarationsTool;
121
121
122
122
/**
123
123
* 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
125
126
* 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
127
128
* as a Tool by the model and executed by the client.
128
129
* @public
129
130
*/
@@ -148,7 +149,7 @@ export declare interface FunctionDeclaration {
148
149
}
149
150
150
151
/**
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
152
153
* interact with external systems to perform an action, or set of actions,
153
154
* outside of knowledge and scope of the model.
154
155
* @public
Original file line number Diff line number Diff line change @@ -25,7 +25,7 @@ import {
25
25
} from './enums' ;
26
26
27
27
/**
28
- * Result object returned from generateContent() call.
28
+ * Result object returned from { @link GenerativeModel. generateContent} call.
29
29
*
30
30
* @public
31
31
*/
@@ -34,7 +34,7 @@ export interface GenerateContentResult {
34
34
}
35
35
36
36
/**
37
- * Result object returned from generateContentStream() call.
37
+ * Result object returned from { @link GenerativeModel. generateContentStream} call.
38
38
* Iterate over `stream` to get chunks as they come in and/or
39
39
* use the `response` promise to get the aggregated response when
40
40
* the stream is done.
You can’t perform that action at this time.
0 commit comments