Interface GeminiParams

The parameters for creating a Gemini instance.

interface GeminiParams {
    apiKey?: string;
    headers?: Record<string, string>;
    location?: string;
    model?: string;
    project?: string;
    useInteractionsApi?: boolean;
    vertexai?: boolean;
}

Properties

apiKey?: string

The API key to use for the Gemini API. If not provided, it will look for the GOOGLE_GENAI_API_KEY or GEMINI_API_KEY environment variable.

headers?: Record<string, string>

Headers to merge with internally crafted headers.

location?: string

The Vertex AI location. Required if vertexai is true.

model?: string

The name of the model to use. Defaults to 'gemini-2.5-flash'.

project?: string

The Vertex AI project ID. Required if vertexai is true.

useInteractionsApi?: boolean

Whether to use the Interactions API for stateful conversations.

vertexai?: boolean

Whether to use Vertex AI. If true, project, location should be provided.