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
@@ -1389,21 +1389,13 @@ export class StringSchema extends Schema {
1389
1389
toJSON():SchemaRequest;
1390
1390
}
1391
1391
1392
-
// Warning: (ae-incompatible-release-tags) The symbol "TemplateChatSession" is marked as @beta, but its signature references "TemplateRequestInternal" which is marked as @internal
// Warning: (ae-internal-missing-underscore) The name "TemplateGenerateContentRequest" should be prefixed with an underscore because the declaration is marked as @internal
// Warning: (ae-incompatible-release-tags) The symbol "Tool" is marked as @public, but its signature references "CodeExecutionTool" which is marked as @beta
1524
-
// Warning: (ae-incompatible-release-tags) The symbol "Tool" is marked as @public, but its signature references "URLContextTool" which is marked as @beta
Copy file name to clipboardExpand all lines: docs-devsite/ai.md
+4-5Lines changed: 4 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,7 +50,6 @@ The Firebase AI Web SDK.
50
50
|[ObjectSchema](./ai.objectschema.md#objectschema_class)| Schema class for "object" types. The <code>properties</code> param must be a map of <code>Schema</code> objects. |
51
51
|[Schema](./ai.schema.md#schema_class)| Parent class encompassing all Schema types, with static methods that allow building specific Schema types. This class can be converted with <code>JSON.stringify()</code> into a JSON string accepted by Vertex AI REST endpoints. (This string conversion is automatically done when calling SDK methods.) |
52
52
|[StringSchema](./ai.stringschema.md#stringschema_class)| Schema class for "string" types. Can be used with or without enum values. |
53
-
|[TemplateChatSession](./ai.templatechatsession.md#templatechatsession_class)| <b><i>(Public Preview)</i></b> <code>ChatSession</code> class for use with server prompt templates that enables sending chat messages and stores history of sent and received messages so far. |
54
53
|[TemplateGenerativeModel](./ai.templategenerativemodel.md#templategenerativemodel_class)| <b><i>(Public Preview)</i></b> [GenerativeModel](./ai.generativemodel.md#generativemodel_class) APIs that execute on a server-side template.<!---->This class should only be instantiated with [getTemplateGenerativeModel()](./ai.md#gettemplategenerativemodel_9476bbc)<!---->. |
55
54
|[TemplateImagenModel](./ai.templateimagenmodel.md#templateimagenmodel_class)| Class for Imagen model APIs that execute on a server-side template.<!---->This class should only be instantiated with [getTemplateImagenModel()](./ai.md#gettemplateimagenmodel_9476bbc)<!---->. |
56
55
|[VertexAIBackend](./ai.vertexaibackend.md#vertexaibackend_class)| Configuration class for the Vertex AI Gemini API.<!---->Use this with [AIOptions](./ai.aioptions.md#aioptions_interface) when initializing the AI service via [getAI()](./ai.md#getai_a94a413) to specify the Vertex AI Gemini API as the backend. |
@@ -69,7 +68,7 @@ The Firebase AI Web SDK.
69
68
|[CitationMetadata](./ai.citationmetadata.md#citationmetadata_interface)| Citation metadata that may be found on a [GenerateContentCandidate](./ai.generatecontentcandidate.md#generatecontentcandidate_interface)<!---->. |
70
69
|[CodeExecutionResult](./ai.codeexecutionresult.md#codeexecutionresult_interface)| The results of code execution run by the model. |
71
70
|[CodeExecutionResultPart](./ai.codeexecutionresultpart.md#codeexecutionresultpart_interface)| Represents the code execution result from the model. |
72
-
|[CodeExecutionTool](./ai.codeexecutiontool.md#codeexecutiontool_interface)|<b><i>(Public Preview)</i></b> A tool that enables the model to use code execution. |
71
+
|[CodeExecutionTool](./ai.codeexecutiontool.md#codeexecutiontool_interface)| A tool that enables the model to use code execution. |
73
72
|[Content](./ai.content.md#content_interface)| Content type for both prompts and response candidates. |
74
73
|[CountTokensRequest](./ai.counttokensrequest.md#counttokensrequest_interface)| Params for calling [GenerativeModel.countTokens()](./ai.generativemodel.md#generativemodelcounttokens)|
75
74
|[CountTokensResponse](./ai.counttokensresponse.md#counttokensresponse_interface)| Response from calling [GenerativeModel.countTokens()](./ai.generativemodel.md#generativemodelcounttokens)<!---->. |
@@ -141,16 +140,16 @@ The Firebase AI Web SDK.
141
140
|[StartAudioConversationOptions](./ai.startaudioconversationoptions.md#startaudioconversationoptions_interface)| <b><i>(Public Preview)</i></b> Options for [startAudioConversation()](./ai.md#startaudioconversation_01c8e7f)<!---->. |
142
141
|[StartChatParams](./ai.startchatparams.md#startchatparams_interface)| Params for [GenerativeModel.startChat()](./ai.generativemodel.md#generativemodelstartchat)<!---->. |
143
142
|[StartTemplateChatParams](./ai.starttemplatechatparams.md#starttemplatechatparams_interface)| <b><i>(Public Preview)</i></b> Params for [TemplateGenerativeModel.startChat()](./ai.templategenerativemodel.md#templategenerativemodelstartchat)<!---->. |
143
+
|[TemplateChatSession](./ai.templatechatsession.md#templatechatsession_interface)| <b><i>(Public Preview)</i></b> Interface representing a <code>ChatSession</code> class for use with server prompt templates that enables sending chat messages and stores history of sent and received messages so far. |
144
144
|[TemplateFunctionDeclaration](./ai.templatefunctiondeclaration.md#templatefunctiondeclaration_interface)| <b><i>(Public Preview)</i></b> Structured representation of a template function declaration. Included in this declaration are the function name and parameters. This <code>TemplateFunctionDeclaration</code> is a representation of a block of code that can be used as a Tool by the model and executed by the client. Note: Template function declarations do not support description fields. |
145
145
|[TemplateFunctionDeclarationsTool](./ai.templatefunctiondeclarationstool.md#templatefunctiondeclarationstool_interface)| <b><i>(Public Preview)</i></b> A piece of code that enables the system to interact with external systems. |
146
-
|[TemplateGenerateContentRequest](./ai.templategeneratecontentrequest.md#templategeneratecontentrequest_interface)| <b><i>(Public Preview)</i></b> Request sent through [TemplateGenerativeModel.generateContent()](./ai.templategenerativemodel.md#templategenerativemodelgeneratecontent)|
147
146
|[TextPart](./ai.textpart.md#textpart_interface)| Content part interface if the part represents a text string. |
148
147
|[ThinkingConfig](./ai.thinkingconfig.md#thinkingconfig_interface)| Configuration for "thinking" behavior of compatible Gemini models.<!---->Certain models utilize a thinking process before generating a response. This allows them to reason through complex problems and plan a more coherent and accurate answer. |
149
148
|[ToolConfig](./ai.toolconfig.md#toolconfig_interface)| Tool config. This config is shared for all tools provided in the request. |
150
149
|[Transcription](./ai.transcription.md#transcription_interface)| <b><i>(Public Preview)</i></b> Transcription of audio. This can be returned from a [LiveGenerativeModel](./ai.livegenerativemodel.md#livegenerativemodel_class) if transcription is enabled with the <code>inputAudioTranscription</code> or <code>outputAudioTranscription</code> properties on the [LiveGenerationConfig](./ai.livegenerationconfig.md#livegenerationconfig_interface)<!---->. |
151
-
|[URLContext](./ai.urlcontext.md#urlcontext_interface)|<b><i>(Public Preview)</i></b> Specifies the URL Context configuration. |
150
+
|[URLContext](./ai.urlcontext.md#urlcontext_interface)| Specifies the URL Context configuration. |
152
151
|[URLContextMetadata](./ai.urlcontextmetadata.md#urlcontextmetadata_interface)| Metadata related to [URLContextTool](./ai.urlcontexttool.md#urlcontexttool_interface)<!---->. |
153
-
|[URLContextTool](./ai.urlcontexttool.md#urlcontexttool_interface)|<b><i>(Public Preview)</i></b> A tool that allows you to provide additional context to the models in the form of public web URLs. By including URLs in your request, the Gemini model will access the content from those pages to inform and enhance its response. |
152
+
|[URLContextTool](./ai.urlcontexttool.md#urlcontexttool_interface)| A tool that allows you to provide additional context to the models in the form of public web URLs. By including URLs in your request, the Gemini model will access the content from those pages to inform and enhance its response. |
154
153
|[URLMetadata](./ai.urlmetadata.md#urlmetadata_interface)| Metadata for a single URL retrieved by the [URLContextTool](./ai.urlcontexttool.md#urlcontexttool_interface) tool. |
155
154
|[UsageMetadata](./ai.usagemetadata.md#usagemetadata_interface)| Usage metadata about a [GenerateContentResponse](./ai.generatecontentresponse.md#generatecontentresponse_interface)<!---->. |
156
155
|[VideoMetadata](./ai.videometadata.md#videometadata_interface)| Describes the input video content. |
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
14
14
>
15
15
16
-
`ChatSession` class for use with server prompt templates that enables sending chat messages and stores history of sent and received messages so far.
16
+
Interface representing a `ChatSession` class for use with server prompt templates that enables sending chat messages and stores history of sent and received messages so far.
| [(constructor)(apiSettings, params, requestOptions)](./ai.templatechatsession.md#templatechatsessionconstructor) | | <b><i>(Public Preview)</i></b> Constructs a new instance of the <code>TemplateChatSession</code> class |
| [sendMessage(request, singleRequestOptions)](./ai.templatechatsession.md#templatechatsessionsendmessage) | | <b><i>(Public Preview)</i></b> Sends a chat message and receives a non-streaming [GenerateContentResult](./ai.generatecontentresult.md#generatecontentresult_interface) |
43
-
| [sendMessageStream(request, singleRequestOptions)](./ai.templatechatsession.md#templatechatsessionsendmessagestream) | | <b><i>(Public Preview)</i></b> Sends a chat message and receives the response as a [GenerateContentStreamResult](./ai.generatecontentstreamresult.md#generatecontentstreamresult_interface) containing an iterable stream and a response promise. |
0 commit comments