Interface LiveClientSetup

Message contains configuration that will apply for the duration of the streaming session.

interface LiveClientSetup {
    contextWindowCompression?: ContextWindowCompressionConfig;
    generationConfig?: GenerationConfig;
    inputAudioTranscription?: AudioTranscriptionConfig;
    model?: string;
    outputAudioTranscription?: AudioTranscriptionConfig;
    proactivity?: ProactivityConfig;
    realtimeInputConfig?: RealtimeInputConfig;
    sessionResumption?: SessionResumptionConfig;
    systemInstruction?: ContentUnion;
    tools?: ToolListUnion;
}

Properties

contextWindowCompression? generationConfig? inputAudioTranscription? model? outputAudioTranscription? proactivity? realtimeInputConfig? sessionResumption? systemInstruction? tools?

Properties

OptionalcontextWindowCompression

contextWindowCompression?: ContextWindowCompressionConfig

Configures context window compression mechanism.

If included, server will compress context window to fit into given length.

OptionalgenerationConfig

generationConfig?: GenerationConfig

The generation configuration for the session. Note: only a subset of fields are supported.

OptionalinputAudioTranscription

inputAudioTranscription?: AudioTranscriptionConfig

The transcription of the input aligns with the input audio language.

Optionalmodel

model?: string

The fully qualified name of the publisher model or tuned model endpoint to use.

OptionaloutputAudioTranscription

outputAudioTranscription?: AudioTranscriptionConfig

The transcription of the output aligns with the language code specified for the output audio.

Optionalproactivity

proactivity?: ProactivityConfig

Configures the proactivity of the model. This allows the model to respond proactively to the input and to ignore irrelevant input.

OptionalrealtimeInputConfig

realtimeInputConfig?: RealtimeInputConfig

Configures the realtime input behavior in BidiGenerateContent.

OptionalsessionResumption

sessionResumption?: SessionResumptionConfig

Configures session resumption mechanism.

If included server will send SessionResumptionUpdate messages.

OptionalsystemInstruction

systemInstruction?: ContentUnion

The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.

Optionaltools

tools?: ToolListUnion

A list of Tools the model may use to generate the next response.

A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.

Settings

On This Page

Properties