Class: Gemini
Defined in: src/ai/Gemini.ts:150
Extends
BaseAIModel
Constructors
Constructor
new Gemini(
options):Gemini
Defined in: src/ai/Gemini.ts:160
Parameters
options
Returns
Gemini
Overrides
BaseAIModel.constructor
Properties
ai?
optionalai:GoogleGenAI
Defined in: src/ai/Gemini.ts:155
inited
inited:
boolean=false
Defined in: src/ai/Gemini.ts:151
isLiveMode
isLiveMode:
boolean=false
Defined in: src/ai/Gemini.ts:153
liveCallbacks
liveCallbacks:
Partial<GoogleGenAITypes.LiveCallbacks> ={}
Defined in: src/ai/Gemini.ts:154
liveSession?
optionalliveSession:Session
Defined in: src/ai/Gemini.ts:152
options
protectedoptions:GeminiOptions
Defined in: src/ai/Gemini.ts:160
Methods
dispose()
dispose():
void
Defined in: src/ai/Gemini.ts:361
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:473
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:400
Returns
object
hasSession
hasSession:
boolean
isActive
isActive:
boolean
isAvailable
isAvailable:
boolean| typeofModality|undefined
hasApiKey()
hasApiKey():
Promise<boolean>
Defined in: src/ai/Gemini.ts:528
Returns
Promise<boolean>
Overrides
BaseAIModel.hasApiKey
init()
init():
Promise<void>
Defined in: src/ai/Gemini.ts:164
Returns
Promise<void>
Overrides
BaseAIModel.init
isAvailable()
isAvailable():
boolean
Defined in: src/ai/Gemini.ts:168
Returns
boolean
Overrides
BaseAIModel.isAvailable
isLiveAvailable()
isLiveAvailable():
false| typeofModality|undefined
Defined in: src/ai/Gemini.ts:180
Returns
false | typeof Modality | undefined
query()
query(
input):Promise<GeminiResponse|null>
Defined in: src/ai/Gemini.ts:408
Parameters
input
GeminiQueryInput | { prompt: string; }
Returns
Promise<GeminiResponse | null>
Overrides
BaseAIModel.query
queryOnce()
protectedqueryOnce(input):Promise<GeminiResponse|null>
Defined in: src/ai/Gemini.ts:422
Parameters
input
GeminiQueryInput | { prompt: string; }
Returns
Promise<GeminiResponse | null>
queryWithExponentialFalloff()
protectedqueryWithExponentialFalloff(input):Promise<GeminiResponse|null>
Defined in: src/ai/Gemini.ts:453
Parameters
input
GeminiQueryInput | { prompt: string; }
Returns
Promise<GeminiResponse | null>
sendRealtimeInput()
sendRealtimeInput(
input):void
Defined in: src/ai/Gemini.ts:387
Parameters
input
LiveSendRealtimeInputParameters
Returns
void
sendToolResponse()
sendToolResponse(
response):void
Defined in: src/ai/Gemini.ts:380
Parameters
response
LiveSendToolResponseParameters
Returns
void
setLiveCallbacks()
setLiveCallbacks(
callbacks):void
Defined in: src/ai/Gemini.ts:376
Parameters
callbacks
LiveCallbacks
Returns
void
startLiveSession()
startLiveSession(
params,model?):Promise<Session>
Defined in: src/ai/Gemini.ts:191
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. A socket close during setup rejects promptly even if the SDK's connect promise stalls. The token 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:356
Returns
Promise<void>