Skip to main content

Class: Gemini

Defined in: src/ai/Gemini.ts:56

Extends​

  • BaseAIModel

Constructors​

Constructor​

new Gemini(options): Gemini

Defined in: src/ai/Gemini.ts:66

Parameters​

options​

GeminiOptions

Returns​

Gemini

Overrides​

BaseAIModel.constructor

Properties​

ai?​

optional ai: GoogleGenAI

Defined in: src/ai/Gemini.ts:61

inited​

inited: boolean = false

Defined in: src/ai/Gemini.ts:57

isLiveMode​

isLiveMode: boolean = false

Defined in: src/ai/Gemini.ts:59

liveCallbacks​

liveCallbacks: Partial<GoogleGenAITypes.LiveCallbacks> = {}

Defined in: src/ai/Gemini.ts:60

liveSession?​

optional liveSession: Session

Defined in: src/ai/Gemini.ts:58

options​

protected options: GeminiOptions

Defined in: src/ai/Gemini.ts:66

Methods​

dispose()​

dispose(): void

Defined in: src/ai/Gemini.ts:203

Invalidates live work synchronously without creating a teardown promise.

Returns​

void

generate()​

generate(prompt, type, systemInstruction, model): Promise<string | undefined>

Defined in: src/ai/Gemini.ts:358

Parameters​

prompt​

string | string[]

type​

"image" = 'image'

systemInstruction​

string = 'Generate an image'

model​

string = GEMINI_DEFAULT_IMAGE_MODEL

Returns​

Promise<string | undefined>

getLiveSessionStatus()​

getLiveSessionStatus(): object

Defined in: src/ai/Gemini.ts:242

Returns​

object

hasSession​

hasSession: boolean

isActive​

isActive: boolean

isAvailable​

isAvailable: boolean | typeof Modality | undefined

hasApiKey()​

hasApiKey(): Promise<boolean>

Defined in: src/ai/Gemini.ts:401

Returns​

Promise<boolean>

Overrides​

BaseAIModel.hasApiKey

init()​

init(): Promise<void>

Defined in: src/ai/Gemini.ts:70

Returns​

Promise<void>

Overrides​

BaseAIModel.init

isAvailable()​

isAvailable(): boolean

Defined in: src/ai/Gemini.ts:74

Returns​

boolean

Overrides​

BaseAIModel.isAvailable

isLiveAvailable()​

isLiveAvailable(): false | typeof Modality | undefined

Defined in: src/ai/Gemini.ts:86

Returns​

false | typeof Modality | undefined

query()​

query(input): Promise<GeminiResponse | null>

Defined in: src/ai/Gemini.ts:250

Parameters​

input​

GeminiQueryInput | { prompt: string; }

Returns​

Promise<GeminiResponse | null>

Overrides​

BaseAIModel.query

queryOnce()​

protected queryOnce(input): Promise<GeminiResponse | null>

Defined in: src/ai/Gemini.ts:264

Parameters​

input​

GeminiQueryInput | { prompt: string; }

Returns​

Promise<GeminiResponse | null>

queryWithExponentialFalloff()​

protected queryWithExponentialFalloff(input): Promise<GeminiResponse | null>

Defined in: src/ai/Gemini.ts:338

Parameters​

input​

GeminiQueryInput | { prompt: string; }

Returns​

Promise<GeminiResponse | null>

sendRealtimeInput()​

sendRealtimeInput(input): void

Defined in: src/ai/Gemini.ts:229

Parameters​

input​

LiveSendRealtimeInputParameters

Returns​

void

sendToolResponse()​

sendToolResponse(response): void

Defined in: src/ai/Gemini.ts:222

Parameters​

response​

LiveSendToolResponseParameters

Returns​

void

setLiveCallbacks()​

setLiveCallbacks(callbacks): void

Defined in: src/ai/Gemini.ts:218

Parameters​

callbacks​

LiveCallbacks

Returns​

void

startLiveSession()​

startLiveSession(params, model?): Promise<Session>

Defined in: src/ai/Gemini.ts:95

Shares a pending connection between concurrent starts. Stopping or disposing invalidates that start; any session returned later is closed and the start rejects with AbortError. The provider cannot be aborted before it returns.

Parameters​

params​

LiveConnectConfig = {}

model?​

string

Returns​

Promise<Session>

stopLiveSession()​

stopLiveSession(): Promise<void>

Defined in: src/ai/Gemini.ts:198

Returns​

Promise<void>