@langwatch/scenario
    Preparing search index...

    Interface RunOptions

    Options for running a scenario.

    interface RunOptions {
        batchRunId?: string;
        langwatch?: LangwatchConfig;
        runId?: string;
        voice?: VoiceConfig;
    }
    Index

    Properties

    batchRunId? langwatch? runId? voice?

    Properties

    batchRunId?: string

    Batch run ID for grouping scenario runs. Overrides SCENARIO_BATCH_RUN_ID env var.

    langwatch?: LangwatchConfig

    LangWatch configuration for event reporting. Overrides environment variables.

    runId?: string

    Pre-assigned run ID for the scenario execution. When provided, the SDK uses this ID instead of generating a new one.

    Platform use only — not part of the public API.

    voice?: VoiceConfig

    Per-invocation voice config override (ADR-002). Seeds cfg.voice at the run() boundary (options?.voice ?? cfg.voice) so the carrier that reaches every call() — ScenarioConfig.voice — reflects the override. Unlike langwatch (read once here), voice config must ride on ScenarioConfig because its consumers (judge STT / simulator TTS) run inside call().

    Settings

    Member Visibility

    On This Page

    Properties