google-adk-kotlin-core/com.google.adk.kt.models/LlmResponse

LlmResponse

data class LlmResponse @JvmOverloads constructor(val content: Content? = null, val usageMetadata: UsageMetadata? = null, val finishReason: FinishReason? = null, val errorMessage: String? = null, val partial: Boolean = false, val interrupted: Boolean = false, val modelVersion: String? = null, val citationMetadata: CitationMetadata? = null, val groundingMetadata: GroundingMetadata? = null, val errorCode: String? = null, val customMetadata: Map<String, Any?>? = null, val avgLogprobs: Double? = null, val logprobsResult: LogprobsResult? = null, val cacheMetadata: CacheMetadata? = null, val turnComplete: Boolean? = null, val turnCompleteReason: TurnCompleteReason? = null, val interactionStatus: InteractionStatus? = null, val inputTranscription: Transcription? = null, val outputTranscription: Transcription? = null, val liveSessionId: String? = null, val liveSessionResumptionUpdate: LiveServerSessionResumptionUpdate? = null, val goAway: LiveServerGoAway? = null, val voiceActivity: VoiceActivity? = null)

LLM response class that provides the first candidate response from the model if available. Otherwise, contains the error code and message.

Constructors

LlmResponse

@JvmOverloads

constructor(content: Content? = null, usageMetadata: UsageMetadata? = null, finishReason: FinishReason? = null, errorMessage: String? = null, partial: Boolean = false, interrupted: Boolean = false, modelVersion: String? = null, citationMetadata: CitationMetadata? = null, groundingMetadata: GroundingMetadata? = null, errorCode: String? = null, customMetadata: Map<String, Any?>? = null, avgLogprobs: Double? = null, logprobsResult: LogprobsResult? = null, cacheMetadata: CacheMetadata? = null, turnComplete: Boolean? = null, turnCompleteReason: TurnCompleteReason? = null, interactionStatus: InteractionStatus? = null, inputTranscription: Transcription? = null, outputTranscription: Transcription? = null, liveSessionId: String? = null, liveSessionResumptionUpdate: LiveServerSessionResumptionUpdate? = null, goAway: LiveServerGoAway? = null, voiceActivity: VoiceActivity? = null)

Types

Builder

class Builder

Fluent builder for LlmResponse, provided primarily for Java callers. Any property left unset falls back to the same default as the constructor.

Companion

object Companion

Properties

avgLogprobs

val avgLogprobs: Double?

cacheMetadata

val cacheMetadata: CacheMetadata?

Context cache metadata for this response, populated when context caching is enabled. null when caching is disabled or no cache information is available.

citationMetadata

val citationMetadata: CitationMetadata?

The citation metadata of the response.

content

val content: Content?

The generative content of the response. This should only contain content from the user or the model, and not any framework or system-generated data.

customMetadata

val customMetadata: Map<String, Any?>?

Optional key-value pairs labeling the response. The entire map must be JSON serializable.

errorCode

val errorCode: String?

Error code if the response is an error. The code varies by model.

errorMessage

val errorMessage: String?

Error message if the response is an error.

finishReason

val finishReason: FinishReason?

The finish reason of the response.

goAway

val goAway: LiveServerGoAway?

Warning that the server will stop serving this connection shortly. Live only.

groundingMetadata

val groundingMetadata: GroundingMetadata?

The grounding metadata of the response.

inputTranscription

val inputTranscription: Transcription?

Transcription of the audio the user sent. Live only.

interactionStatus

val interactionStatus: InteractionStatus?

Whether the model is still working on the prompt, reported only with turnComplete; see InteractionStatus. On a completed turn, null means the model does not report it and is done. Live only.

interrupted

val interrupted: Boolean

Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming.

liveSessionId

val liveSessionId: String?

Identifier of the live session this response came from. Live only.

liveSessionResumptionUpdate

val liveSessionResumptionUpdate: LiveServerSessionResumptionUpdate?

A handle for resuming this session on a later connection. Live only.

logprobsResult

val logprobsResult: LogprobsResult?

modelVersion

val modelVersion: String?

The model version used to generate the response.

outputTranscription

val outputTranscription: Transcription?

Transcription of the audio the model returned. Live only.

partial

val partial: Boolean

Whether this response is an incomplete fragment of a streamed response, such as a text chunk or an unfinished transcription. Only used in streaming mode.

turnComplete

val turnComplete: Boolean?

Whether the model has finished its turn. Live only.

turnCompleteReason

val turnCompleteReason: TurnCompleteReason?

Why the turn ended, when it ended for a reason other than ordinary completion. Live only.

usageMetadata

val usageMetadata: UsageMetadata?

The usage metadata of the LlmResponse.

voiceActivity

val voiceActivity: VoiceActivity?

A server-detected change in whether the user is speaking. Live only.

Functions

toBuilder

fun toBuilder(): LlmResponse.Builder

Returns a Builder initialized with this instance's properties, primarily for Java callers. Prefer it over copy from Java: copy takes every property positionally, so its signature changes whenever a property is added.