Back to Firebase Js Sdk

StartTemplateChatParams interface

docs-devsite/ai.starttemplatechatparams.md

12.12.12.3 KB
Original Source

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

StartTemplateChatParams interface

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.

Params for TemplateGenerativeModel.startChat()<!-- -->.

<b>Signature:</b>

typescript
export interface StartTemplateChatParams extends Omit<StartChatParams, 'tools'> 

<b>Extends:</b> Omit<StartChatParams<!-- -->, 'tools'>

Properties

PropertyTypeDescription
templateIdstring<b><i>(Public Preview)</i></b> The ID of the server-side template to execute.
templateVariablesRecord<string, unknown><b><i>(Public Preview)</i></b> A key-value map of variables to populate the template with.
toolsTemplateTool<!-- -->[]<b><i>(Public Preview)</i></b>

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-side template to execute.

<b>Signature:</b>

typescript
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.

<b>Signature:</b>

typescript
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.

<b>Signature:</b>

typescript
tools?: TemplateTool[];