Class GenerativeModel

Class for generative model APIs.

Hierarchy (View Summary)

AIModel
- GenerativeModel

Index

Constructors

Methods

countTokens generateContent generateContentStream startChat normalizeModelName

Properties

_apiSettings generationConfig model requestOptions? safetySettings systemInstruction? toolConfig? tools?

Constructors

constructor

new GenerativeModel(
    ai: AI,
    modelParams: ModelParams,
    requestOptions?: RequestOptions,
): GenerativeModel
Parameters
- ai: AI
- modelParams: ModelParams
- OptionalrequestOptions: RequestOptions
Returns GenerativeModel
Overrides AIModel.constructor
- Defined in models/generative-model.ts:53

Methods

countTokens

countTokens(
request: string | CountTokensRequest | (string | Part)[],
): Promise<CountTokensResponse>
Counts the tokens in the provided request.
Parameters
- request: string | CountTokensRequest | (string | Part)[]
Returns Promise<CountTokensResponse>
- Defined in models/generative-model.ts:139

generateContent

generateContent(
request: string | GenerateContentRequest | (string | Part)[],
): Promise<GenerateContentResult>
Makes a single non-streaming call to the model and returns an object containing a single GenerateContentResponse.
Parameters
- request: string | GenerateContentRequest | (string | Part)[]
Returns Promise<GenerateContentResult>
- Defined in models/generative-model.ts:67

generateContentStream

generateContentStream(
request: string | GenerateContentRequest | (string | Part)[],
): 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 | GenerateContentRequest | (string | Part)[]
Returns Promise<GenerateContentStreamResult>
- Defined in models/generative-model.ts:92

startChat

startChat(startChatParams?: StartChatParams): ChatSession
Gets a new ChatSession instance which can be used for multi-turn chats.
Parameters
- OptionalstartChatParams: StartChatParams
Returns ChatSession
- Defined in models/generative-model.ts:115

`Static`normalizeModelName

normalizeModelName(modelName: string, backendType: BackendType): string
Internal
Normalizes the given model name to a fully qualified model resource name.
Parameters
- modelName: string
  The model name to normalize.
- backendType: BackendType
Returns string
The fully qualified model resource name.
Inherited from AIModel.normalizeModelName
- Defined in models/ai-model.ts:72

Properties

`Protected` `Internal`_apiSettings

_apiSettings: ApiSettings

generationConfig

generationConfig: GenerationConfig

`Readonly`model

model: string

The fully qualified model resource name to use for generating images (for example, publishers/google/models/imagen-3.0-generate-002).

`Optional`requestOptions

requestOptions?: RequestOptions

safetySettings

safetySettings: SafetySetting[]

`Optional`systemInstruction

systemInstruction?: Content

`Optional`toolConfig

toolConfig?: ToolConfig

`Optional`tools

tools?: Tool[]