Class for generative model APIs.

Signature:

exportdeclareclassGenerativeModelextendsAIModel

Extends:AIModel

Constructors

Properties

Methods

GenerativeModel.(constructor)

Constructs a new instance of theGenerativeModel class

Signature:

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

Parameters

GenerativeModel.generationConfig

Signature:

generationConfig:GenerationConfig;

GenerativeModel.requestOptions

Signature:

requestOptions?:RequestOptions;

GenerativeModel.safetySettings

Signature:

safetySettings:SafetySetting[];

GenerativeModel.systemInstruction

Signature:

systemInstruction?:Content;

GenerativeModel.toolConfig

Signature:

toolConfig?:ToolConfig;

GenerativeModel.tools

Signature:

tools?:Tool[];

GenerativeModel.countTokens()

Counts the tokens in the provided request.

Signature:

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

Parameters

Returns:

Promise<CountTokensResponse>

GenerativeModel.generateContent()

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

Signature:

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

Parameters

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:

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

Parameters

Returns:

Promise<GenerateContentStreamResult>

GenerativeModel.startChat()

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

Signature:

startChat(startChatParams?:StartChatParams):ChatSession;

Parameters

Returns:

ChatSession