ADK for TypeScript: API Reference
    Preparing search index...

    Interface RunConfig

    Configs for runtime behavior of agents.

    interface RunConfig {
        enableAffectiveDialog?: boolean;
        inputAudioTranscription?: AudioTranscriptionConfig;
        maxLlmCalls?: number;
        outputAudioTranscription?: AudioTranscriptionConfig;
        proactivity?: ProactivityConfig;
        realtimeInputConfig?: RealtimeInputConfig;
        responseModalities?: Modality[];
        saveInputBlobsAsArtifacts?: boolean;
        speechConfig?: SpeechConfig;
        streamingMode?: StreamingMode;
        supportCfc?: boolean;
    }

    Properties

    enableAffectiveDialog?: boolean

    If enabled, the model will detect emotions and adapt its responses accordingly.

    inputAudioTranscription?: AudioTranscriptionConfig

    Input transcription for live agents with audio input from user.

    maxLlmCalls?: number

    A limit on the total number of llm calls for a given run.

    Valid Values:

    • More than 0 and less than sys.maxsize: The bound on the number of llm calls is enforced, if the value is set in this range.
    • Less than or equal to 0: This allows for unbounded number of llm calls.
    outputAudioTranscription?: AudioTranscriptionConfig

    Output audio transcription config.

    proactivity?: ProactivityConfig

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

    realtimeInputConfig?: RealtimeInputConfig

    Realtime input config for live agents with audio input from user.

    responseModalities?: Modality[]

    The output modalities. If not set, it's default to AUDIO.

    saveInputBlobsAsArtifacts?: boolean

    Whether or not to save the input blobs as artifacts.

    speechConfig?: SpeechConfig

    Speech configuration for the live agent.

    streamingMode?: StreamingMode

    Streaming mode, None or StreamingMode.SSE or StreamingMode.BIDI.

    supportCfc?: boolean

    Whether to support CFC (Compositional Function Calling). Only applicable for StreamingMode.SSE. If it's true. the LIVE API will be invoked. Since only LIVE API supports CFC

    WARNING: This feature is experimental and its API or behavior may change in future releases.

    Properties