Interface GetGenerativeModelParams (1.7.0)

Params used to call the getGenerativeModel method.

Inheritance

BaseModelParams > ModelParams > GetGenerativeModelParams

Package

Properties

apiEndpoint

apiEndpoint?: string;

Optional. The base Vertex AI endpoint to use for the request. If not provided, the default regionalized endpoint (i.e. us-central1-aiplatform.googleapis.com) will be used.

generationConfig

generationConfig?: GenerationConfig;

Optional. The configuration to use for generation.

googleAuth

googleAuth: GoogleAuth;

GoogleAuth class instance that handles authentication. Details about GoogleAuth is referred to https://github.com/googleapis/google-auth-library-nodejs/blob/main/src/auth/googleauth.ts

location

location: string;

The Google Cloud project location to use for the request.

model

model: string;

The name of the model to get.

project

project: string;

The Google Cloud project to use for the request.

requestOptions

requestOptions?: RequestOptions;

Optional. The request options to use for generation.

safetySettings

safetySettings?: SafetySetting[];

Optional. The safety settings to use for generation.

systemInstruction

systemInstruction?: string | Content;

Optional. The user provided system instructions for the model. Note: only text should be used in parts of Content

toolConfig

toolConfig?: ToolConfig;

Optional. This config is shared for all tools provided in the request.

tools

tools?: Tool[];

Optional. The tools to use for generation.