You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|[@firebase/performance](./performance.md#performance_package)| The Firebase Performance Monitoring Web SDK. This SDK does not work in a Node.js environment. |
28
28
|[@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. |
29
29
|[@firebase/storage](./storage.md#storage_package)| Cloud Storage for Firebase |
30
-
|[@firebase/vertexai-preview](./vertexai-preview.md#vertexai-preview_package)| The Vertex AI for Firebase Web SDK. |
30
+
|[@firebase/vertexai-preview](./vertexai-preview.md#vertexai-preview_package)| The Firebase Vertex Web SDK. |
A predicted \[FunctionCall\] returned from the model that contains a string representing the \[FunctionDeclaration.name\] and a structured JSON object containing the parameters and their values.
13
+
A predicted [FunctionCall](./vertexai-preview.functioncall.md#functioncall_interface) returned from the model that contains a string representing the [FunctionDeclaration.name](./vertexai-preview.functiondeclaration.md#functiondeclarationname) and a structured JSON object containing the parameters and their values.
Structured representation of a function declaration as defined by the \[OpenAPI 3.0 specification\](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a Tool by the model and executed by the client.
13
+
Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3)<!---->. Included in this declaration are the function name and parameters. This `FunctionDeclaration` is a representation of a block of code that can be used as a Tool by the model and executed by the client.
A FunctionDeclarationsTool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
13
+
A `FunctionDeclarationsTool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
The result output from a \[FunctionCall\] that contains a string representing the \[FunctionDeclaration.name\] 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\] made based on model prediction.
13
+
The result output from a [FunctionCall](./vertexai-preview.functioncall.md#functioncall_interface) that contains a string representing the [FunctionDeclaration.name](./vertexai-preview.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-preview.functioncall.md#functioncall_interface) made based on model prediction.
Result object returned from generateContentStream() call. Iterate over `stream` to get chunks as they come in and/or use the `response` promise to get the aggregated response when the stream is done.
13
+
Result object returned from [GenerativeModel.generateContentStream()](./vertexai-preview.generativemodel.md#generativemodelgeneratecontentstream) call. Iterate over `stream` to get chunks as they come in and/or use the `response` promise to get the aggregated response when the stream is done.
Copy file name to clipboardExpand all lines: docs-devsite/vertexai-preview.md
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -56,20 +56,20 @@ The Firebase Vertex Web SDK.
56
56
|[EnhancedGenerateContentResponse](./vertexai-preview.enhancedgeneratecontentresponse.md#enhancedgeneratecontentresponse_interface)| Response object wrapped with helper methods. |
57
57
|[FileData](./vertexai-preview.filedata.md#filedata_interface)| Data pointing to a file uploaded on Google Cloud Storage. |
58
58
|[FileDataPart](./vertexai-preview.filedatapart.md#filedatapart_interface)| Content part interface if the part represents [FileData](./vertexai-preview.filedata.md#filedata_interface)|
59
-
|[FunctionCall](./vertexai-preview.functioncall.md#functioncall_interface)| A predicted \[FunctionCall\] returned from the model that contains a string representing the \[FunctionDeclaration.name\] and a structured JSON object containing the parameters and their values. |
59
+
|[FunctionCall](./vertexai-preview.functioncall.md#functioncall_interface)| A predicted [FunctionCall](./vertexai-preview.functioncall.md#functioncall_interface) returned from the model that contains a string representing the [FunctionDeclaration.name](./vertexai-preview.functiondeclaration.md#functiondeclarationname) and a structured JSON object containing the parameters and their values. |
|[FunctionCallPart](./vertexai-preview.functioncallpart.md#functioncallpart_interface)| Content part interface if the part represents a [FunctionCall](./vertexai-preview.functioncall.md#functioncall_interface)<!---->. |
62
-
|[FunctionDeclaration](./vertexai-preview.functiondeclaration.md#functiondeclaration_interface)| Structured representation of a function declaration as defined by the \[OpenAPI 3.0 specification\](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a Tool by the model and executed by the client. |
62
+
|[FunctionDeclaration](./vertexai-preview.functiondeclaration.md#functiondeclaration_interface)| Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3)<!---->. Included in this declaration are the function name and parameters. This <code>FunctionDeclaration</code> is a representation of a block of code that can be used as a Tool by the model and executed by the client. |
63
63
|[FunctionDeclarationSchema](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschema_interface)| Schema for parameters passed to [FunctionDeclaration.parameters](./vertexai-preview.functiondeclaration.md#functiondeclarationparameters)<!---->. |
64
64
|[FunctionDeclarationSchemaProperty](./vertexai-preview.functiondeclarationschemaproperty.md#functiondeclarationschemaproperty_interface)| Schema is used to define the format of input/output data. Represents a select subset of an OpenAPI 3.0 schema object. More fields may be added in the future as needed. |
65
-
|[FunctionDeclarationsTool](./vertexai-preview.functiondeclarationstool.md#functiondeclarationstool_interface)| A FunctionDeclarationsTool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. |
66
-
|[FunctionResponse](./vertexai-preview.functionresponse.md#functionresponse_interface)| The result output from a \[FunctionCall\] that contains a string representing the \[FunctionDeclaration.name\] 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\] made based on model prediction. |
65
+
|[FunctionDeclarationsTool](./vertexai-preview.functiondeclarationstool.md#functiondeclarationstool_interface)| A <code>FunctionDeclarationsTool</code> is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. |
66
+
|[FunctionResponse](./vertexai-preview.functionresponse.md#functionresponse_interface)| The result output from a [FunctionCall](./vertexai-preview.functioncall.md#functioncall_interface) that contains a string representing the [FunctionDeclaration.name](./vertexai-preview.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-preview.functioncall.md#functioncall_interface) made based on model prediction. |
67
67
|[FunctionResponsePart](./vertexai-preview.functionresponsepart.md#functionresponsepart_interface)| Content part interface if the part represents [FunctionResponse](./vertexai-preview.functionresponse.md#functionresponse_interface)<!---->. |
68
68
|[GenerateContentCandidate](./vertexai-preview.generatecontentcandidate.md#generatecontentcandidate_interface)| A candidate returned as part of a [GenerateContentResponse](./vertexai-preview.generatecontentresponse.md#generatecontentresponse_interface)<!---->. |
69
-
|[GenerateContentRequest](./vertexai-preview.generatecontentrequest.md#generatecontentrequest_interface)| Request sent to <code>generateContent</code> endpoint.|
69
+
|[GenerateContentRequest](./vertexai-preview.generatecontentrequest.md#generatecontentrequest_interface)| Request sent through [GenerativeModel.generateContent()](./vertexai-preview.generativemodel.md#generativemodelgeneratecontent)|
70
70
|[GenerateContentResponse](./vertexai-preview.generatecontentresponse.md#generatecontentresponse_interface)| Individual response from [GenerativeModel.generateContent()](./vertexai-preview.generativemodel.md#generativemodelgeneratecontent) and [GenerativeModel.generateContentStream()](./vertexai-preview.generativemodel.md#generativemodelgeneratecontentstream)<!---->. <code>generateContentStream()</code> will return one in each chunk until the stream is done. |
71
-
|[GenerateContentResult](./vertexai-preview.generatecontentresult.md#generatecontentresult_interface)| Result object returned from generateContent() call. |
72
-
|[GenerateContentStreamResult](./vertexai-preview.generatecontentstreamresult.md#generatecontentstreamresult_interface)| Result object returned from generateContentStream() call. Iterate over <code>stream</code> to get chunks as they come in and/or use the <code>response</code> promise to get the aggregated response when the stream is done. |
71
+
|[GenerateContentResult](./vertexai-preview.generatecontentresult.md#generatecontentresult_interface)| Result object returned from [GenerativeModel.generateContent()](./vertexai-preview.generativemodel.md#generativemodelgeneratecontent) call. |
72
+
|[GenerateContentStreamResult](./vertexai-preview.generatecontentstreamresult.md#generatecontentstreamresult_interface)| Result object returned from [GenerativeModel.generateContentStream()](./vertexai-preview.generativemodel.md#generativemodelgeneratecontentstream) call. Iterate over <code>stream</code> to get chunks as they come in and/or use the <code>response</code> promise to get the aggregated response when the stream is done. |
73
73
|[GenerationConfig](./vertexai-preview.generationconfig.md#generationconfig_interface)| Config options for content-related requests |
74
74
|[GenerativeContentBlob](./vertexai-preview.generativecontentblob.md#generativecontentblob_interface)| Interface for sending an image. |
|[TextPart](./vertexai-preview.textpart.md#textpart_interface)| Content part interface if the part represents a text string. |
87
87
|[ToolConfig](./vertexai-preview.toolconfig.md#toolconfig_interface)| Tool config. This config is shared for all tools provided in the request. |
88
88
|[UsageMetadata](./vertexai-preview.usagemetadata.md#usagemetadata_interface)| Usage metadata about a [GenerateContentResponse](./vertexai-preview.generatecontentresponse.md#generatecontentresponse_interface)<!---->. |
89
-
|[VertexAI](./vertexai-preview.vertexai.md#vertexai_interface)| An instance of Firebase Vertex AI. |
89
+
|[VertexAI](./vertexai-preview.vertexai.md#vertexai_interface)| An instance of the Vertex AI for Firebase SDK. |
90
90
|[VertexAIOptions](./vertexai-preview.vertexaioptions.md#vertexaioptions_interface)| Options when initializing the Firebase Vertex AI SDK. |
91
91
|[VideoMetadata](./vertexai-preview.videometadata.md#videometadata_interface)| Describes the input video content. |
0 commit comments