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.
Parameters for starting a template-based chat session with TemplateGenerativeModel.startChat().
Signature:
export interface StartTemplateChatParams extends Omit<StartChatParams, 'tools'>
Extends: Omit<StartChatParams, 'tools'>
Properties
| Property | Type | Description |
|---|---|---|
| templateId | string | (Public Preview) The ID of the server prompt template to use. |
| templateVariables | Record<string, unknown> | (Public Preview) A key-value map of variables to populate the template with. |
| tools | TemplateTool[] | (Public Preview) Optional. A list of template tools that the model can use to access external systems or execute client functions. |
StartTemplateChatParams.templateId
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.
The ID of the server prompt template to use.
Signature:
templateId: string;
StartTemplateChatParams.templateVariables
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.
A key-value map of variables to populate the template with.
Signature:
templateVariables: Record<string, unknown>;
StartTemplateChatParams.tools
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.
Optional. A list of template tools that the model can use to access external systems or execute client functions.
Signature:
tools?: TemplateTool[];