google-adk-kotlin-core/com.google.adk.kt.agents/RunConfig

RunConfig

data class RunConfig @JvmOverloads constructor(val streamingMode: StreamingMode = StreamingMode.NONE, val maxLlmCalls: Int = 500, val customMetadata: Map<String, Any>? = null, val responseModalities: List<Modality> = emptyList(), val speechConfig: SpeechConfig? = null, val outputAudioTranscription: AudioTranscriptionConfig? = AudioTranscriptionConfig(), val inputAudioTranscription: AudioTranscriptionConfig? = AudioTranscriptionConfig(), val realtimeInputConfig: RealtimeInputConfig? = null, val explicitVadSignal: Boolean? = null, val translationConfig: TranslationConfig? = null, val enableAffectiveDialog: Boolean? = null, val proactivity: ProactivityConfig? = null, val sessionResumption: SessionResumptionConfig? = null, val contextWindowCompression: ContextWindowCompressionConfig? = null)

Configs for runtime behavior of agents.

Properties from responseModalities onwards apply only to a live connection, which is configured once when it opens and cannot be changed per turn. They only take effect through the experimental live API.

Constructors

RunConfig

@JvmOverloads

constructor(streamingMode: StreamingMode = StreamingMode.NONE, maxLlmCalls: Int = 500, customMetadata: Map<String, Any>? = null, responseModalities: List<Modality> = emptyList(), speechConfig: SpeechConfig? = null, outputAudioTranscription: AudioTranscriptionConfig? = AudioTranscriptionConfig(), inputAudioTranscription: AudioTranscriptionConfig? = AudioTranscriptionConfig(), realtimeInputConfig: RealtimeInputConfig? = null, explicitVadSignal: Boolean? = null, translationConfig: TranslationConfig? = null, enableAffectiveDialog: Boolean? = null, proactivity: ProactivityConfig? = null, sessionResumption: SessionResumptionConfig? = null, contextWindowCompression: ContextWindowCompressionConfig? = null)

Types

Builder

class Builder

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

Companion

object Companion

Properties

contextWindowCompression

val contextWindowCompression: ContextWindowCompressionConfig?

Keeps the session's context below a given length.

customMetadata

val customMetadata: Map<String, Any>?

Custom metadata for the current invocation.

enableAffectiveDialog

val enableAffectiveDialog: Boolean?

Whether the model detects emotion and adapts its responses.

explicitVadSignal

val explicitVadSignal: Boolean?

Whether the model sends its voice activity detection signals. Only the Vertex AI backend accepts true; Gemini API clients reject it.

inputAudioTranscription

val inputAudioTranscription: AudioTranscriptionConfig?

Transcription of the audio the user sends. Enabled by default with automatic language detection; set to null to disable it.

maxLlmCalls

val maxLlmCalls: Int

Limit on the total number of LLM calls per run. A positive value is enforced, except by a live run, which ignores it; a value <= 0 means unbounded.

outputAudioTranscription

val outputAudioTranscription: AudioTranscriptionConfig?

Transcription of the audio the model returns. Enabled by default with automatic language detection; set to null to disable it.

proactivity

val proactivity: ProactivityConfig?

Whether the model may decline to respond to a prompt.

realtimeInputConfig

val realtimeInputConfig: RealtimeInputConfig?

How realtime input is interpreted as turns, including voice activity detection.

responseModalities

val responseModalities: List<Modality>

The modalities the model may return. Empty leaves it unset, and the SDK then asks for audio on a live connection, as unset does in ADK Python. A value set here is sent as is, as in ADK Python, so a modality the model cannot answer in fails the connection.

sessionResumption

val sessionResumption: SessionResumptionConfig?

Configuration of the session resumption mechanism.

speechConfig

val speechConfig: SpeechConfig?

The speech generation configuration.

streamingMode

val streamingMode: StreamingMode

Streaming mode, NONE, SSE or BIDI.

translationConfig

val translationConfig: TranslationConfig?

Real-time speech-to-speech translation. Only translation models support it.

Functions

toBuilder

fun toBuilder(): RunConfig.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.