Files
firebase-js-sdk/docs-devsite/ai.starttemplatechatparams.md

2.3 KiB

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().

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-side template to execute.
templateVariables Record<string, unknown> (Public Preview) A key-value map of variables to populate the template with.
tools TemplateTool[] (Public Preview)

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.

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.

Signature:

tools?: TemplateTool[];