Class LiveServerMessage

Response message for API call.

Constructors

constructor

Properties

goAway? serverContent? sessionResumptionUpdate? setupComplete? toolCall? toolCallCancellation? usageMetadata? voiceActivity? voiceActivityDetectionSignal?

Accessors

data text

Constructors

constructor

Properties

OptionalgoAway

goAway?: LiveServerGoAway

Server will disconnect soon.

OptionalserverContent

serverContent?: LiveServerContent

Content generated by the model in response to client messages.

OptionalsessionResumptionUpdate

sessionResumptionUpdate?: LiveServerSessionResumptionUpdate

Update of the session resumption state.

OptionalsetupComplete

setupComplete?: LiveServerSetupComplete

Sent in response to a LiveClientSetup message from the client.

OptionaltoolCall

toolCall?: LiveServerToolCall

Request for the client to execute the function_calls and return the responses with the matching ids.

OptionaltoolCallCancellation

toolCallCancellation?: LiveServerToolCallCancellation

Notification for the client that a previously issued ToolCallMessage with the specified ids should have been not executed and should be cancelled.

OptionalusageMetadata

usageMetadata?: UsageMetadata

Usage metadata about model response(s).

OptionalvoiceActivity

voiceActivity?: VoiceActivity

Voice activity signal.

OptionalvoiceActivityDetectionSignal

voiceActivityDetectionSignal?: VoiceActivityDetectionSignal

Voice activity detection signal. Allowlisted only.

Accessors

data

  • get data(): undefined | string

    Returns the concatenation of all inline data parts from the server content if present.

    Returns undefined | string

    Remarks

    If there are non-inline data parts in the response, the concatenation of all inline data parts will be returned, and a warning will be logged.

text

  • get text(): undefined | string

    Returns the concatenation of all text parts from the server content if present.

    Returns undefined | string

    Remarks

    If there are non-text parts in the response, the concatenation of all text parts will be returned, and a warning will be logged.

Settings

On This Page

Constructors
Properties
Accessors