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 %}

GenerativeModel class

Class for generative model APIs.

Signature:

typescript

export declare class GenerativeModel extends AIModel

Extends: AIModel

Constructors

Constructor	Modifiers	Description
(constructor)(ai, modelParams, requestOptions, chromeAdapter)		Constructs a new instance of the <code>GenerativeModel</code> class

Properties

Property	Modifiers	Type	Description
generationConfig		GenerationConfig
requestOptions		RequestOptions
safetySettings		SafetySetting<!-- -->[]
systemInstruction		Content
toolConfig		ToolConfig
tools		Tool<!-- -->[]

Methods

Method	Modifiers	Description
countTokens(request, singleRequestOptions)		Counts the tokens in the provided request.
generateContent(request, singleRequestOptions)		Makes a single non-streaming call to the model and returns an object containing a single GenerateContentResponse<!-- -->.
generateContentStream(request, singleRequestOptions)		Makes a single streaming call to the model and returns an object containing an iterable stream that iterates over all chunks in the streaming response as well as a promise that returns the final aggregated response.
startChat(startChatParams)		Gets a new ChatSession instance which can be used for multi-turn chats.

GenerativeModel.(constructor)

Constructs a new instance of the GenerativeModel class

Signature:

typescript

constructor(ai: AI, modelParams: ModelParams, requestOptions?: RequestOptions, chromeAdapter?: ChromeAdapter | undefined);

Parameters

Parameter	Type	Description
ai	AI
modelParams	ModelParams
requestOptions	RequestOptions
chromeAdapter	ChromeAdapter \| undefined

GenerativeModel.generationConfig

Signature:

typescript

generationConfig: GenerationConfig;

GenerativeModel.requestOptions

Signature:

typescript

requestOptions?: RequestOptions;

GenerativeModel.safetySettings

Signature:

typescript

safetySettings: SafetySetting[];

GenerativeModel.systemInstruction

Signature:

typescript

systemInstruction?: Content;

GenerativeModel.toolConfig

Signature:

typescript

toolConfig?: ToolConfig;

GenerativeModel.tools

Signature:

typescript

tools?: Tool[];

GenerativeModel.countTokens()

Counts the tokens in the provided request.

Signature:

typescript

countTokens(request: CountTokensRequest | string | Array<string | Part>, singleRequestOptions?: SingleRequestOptions): Promise<CountTokensResponse>;

Parameters

Parameter	Type	Description
request	CountTokensRequest \| string \| Array<string \| Part<!-- -->>
singleRequestOptions	SingleRequestOptions

Returns:

Promise<CountTokensResponse>

GenerativeModel.generateContent()

Makes a single non-streaming call to the model and returns an object containing a single GenerateContentResponse.

Signature:

typescript

generateContent(request: GenerateContentRequest | string | Array<string | Part>, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentResult>;

Parameters

Parameter	Type	Description
request	GenerateContentRequest \| string \| Array<string \| Part<!-- -->>
singleRequestOptions	SingleRequestOptions

Returns:

Promise<GenerateContentResult>

GenerativeModel.generateContentStream()

Makes a single streaming call to the model and returns an object containing an iterable stream that iterates over all chunks in the streaming response as well as a promise that returns the final aggregated response.

Signature:

typescript

generateContentStream(request: GenerateContentRequest | string | Array<string | Part>, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentStreamResult>;

Parameters

Parameter	Type	Description
request	GenerateContentRequest \| string \| Array<string \| Part<!-- -->>
singleRequestOptions	SingleRequestOptions

Returns:

Promise<GenerateContentStreamResult>

GenerativeModel.startChat()

Gets a new ChatSession instance which can be used for multi-turn chats.

Signature:

typescript

startChat(startChatParams?: StartChatParams): ChatSession;

Parameters

Parameter	Type	Description
startChatParams	StartChatParams

Returns:

ChatSession