@langwatch/scenario
    Preparing search index...

    Interface ScenarioConfigFinalInternal

    Final, normalized scenario configuration. All optional fields are filled with default values.

    interface ScenarioConfigFinal {
        agents: AgentAdapter[];
        description: string;
        id: string;
        maxTurns: number;
        metadata?: Record<string, unknown>;
        name: string;
        script: ScriptStep[];
        setId?: string;
        threadId: string;
        verbose: boolean;
    }

    Hierarchy

    • Omit<ScenarioConfig, "id" | "script" | "threadId" | "verbose" | "maxTurns">
      • ScenarioConfigFinal
    Index

    Properties

    agents description id maxTurns metadata? name script setId? threadId verbose

    Properties

    agents: AgentAdapter[]

    The agents participating in the scenario.

    description: string

    A description of what the scenario tests.

    id: string
    maxTurns: number
    metadata?: Record<string, unknown>

    Optional metadata to attach to the scenario run. Accepts arbitrary key-value pairs (e.g. prompt IDs, environments, versions). The langwatch key is reserved for platform-internal use.

    name: string

    The name of the scenario.

    script: ScriptStep[]
    setId?: string

    Optional identifier to group this scenario into a set ("Simulation Set"). This is useful for organizing related scenarios in the UI and for reporting. If not provided, the scenario will not be grouped into a set.

    threadId: string
    verbose: boolean

    Settings

    Member Visibility

    On This Page

    Properties