Class GenerativeModel

constructor

• new GenerativeModel(apiKey, modelParams, requestOptions?): GenerativeModel

• Parameters

  • apiKey: string

  • modelParams: ModelParams

  • Optional requestOptions: RequestOptions

  Returns GenerativeModel

batchEmbedContents

• batchEmbedContents(batchEmbedContentRequest): Promise<BatchEmbedContentsResponse>

• Embeds an array of EmbedContentRequests.

  Parameters

  • batchEmbedContentRequest: BatchEmbedContentsRequest

  Returns Promise<BatchEmbedContentsResponse>

countTokens

• countTokens(request): Promise<CountTokensResponse>

• Counts the tokens in the provided request.

  Parameters

  • request: string | (string | Part)[] | CountTokensRequest

  Returns Promise<CountTokensResponse>

embedContent

• embedContent(request): Promise<EmbedContentResponse>

• Embeds the provided content.

  Parameters

  • request: string | EmbedContentRequest | (string | Part)[]

  Returns Promise<EmbedContentResponse>

generateContent

• generateContent(request): Promise<GenerateContentResult>

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

  Parameters

  • request: string | (string | Part)[] | GenerateContentRequest

  Returns Promise<GenerateContentResult>

generateContentStream

• generateContentStream(request): Promise<GenerateContentStreamResult>

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

  Parameters

  • request: string | (string | Part)[] | GenerateContentRequest

  Returns Promise<GenerateContentStreamResult>

startChat

• startChat(startChatParams?): ChatSession

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

  Parameters

  • Optional startChatParams: StartChatParams

  Returns ChatSession

apiKey

generationConfig

model

requestOptions

safetySettings

Optional systemInstruction

Optional toolConfig

Optional tools