google-genai-kotlin/com.google.genai.kotlin.types/LiveServerMessage

LiveServerMessage

@Serializable

data class LiveServerMessage(val setupComplete: LiveServerSetupComplete? = null, val serverContent: LiveServerContent? = null, val toolCall: LiveServerToolCall? = null, val toolCallCancellation: LiveServerToolCallCancellation? = null, val usageMetadata: UsageMetadata? = null, val goAway: LiveServerGoAway? = null, val sessionResumptionUpdate: LiveServerSessionResumptionUpdate? = null, val voiceActivityDetectionSignal: VoiceActivityDetectionSignal? = null, val voiceActivity: VoiceActivity? = null)

Response message for API call.

Constructors

LiveServerMessage

constructor(setupComplete: LiveServerSetupComplete? = null, serverContent: LiveServerContent? = null, toolCall: LiveServerToolCall? = null, toolCallCancellation: LiveServerToolCallCancellation? = null, usageMetadata: UsageMetadata? = null, goAway: LiveServerGoAway? = null, sessionResumptionUpdate: LiveServerSessionResumptionUpdate? = null, voiceActivityDetectionSignal: VoiceActivityDetectionSignal? = null, voiceActivity: VoiceActivity? = null)

Properties

val data: ByteArray?

Returns the concatenation of all inline data parts in the LiveServerContent.modelTurn.

val goAway: LiveServerGoAway? = null

Server will disconnect soon.

val serverContent: LiveServerContent? = null

Content generated by the model in response to client messages.

sessionResumptionUpdate

val sessionResumptionUpdate: LiveServerSessionResumptionUpdate? = null

Update of the session resumption state.

val setupComplete: LiveServerSetupComplete? = null

Sent in response to a LiveClientSetup message from the client.

val text: String?

Returns the concatenation of all text parts in the LiveServerContent.modelTurn.

val toolCall: LiveServerToolCall? = null

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

toolCallCancellation

val toolCallCancellation: LiveServerToolCallCancellation? = null

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

val usageMetadata: UsageMetadata? = null

Usage metadata about model response(s).

val voiceActivity: VoiceActivity? = null

Voice activity signal.

voiceActivityDetectionSignal

val voiceActivityDetectionSignal: VoiceActivityDetectionSignal? = null

Voice activity detection signal. Allowlisted only.