@runloop/api-client - v1.4.0
    Preparing search index...

    Interface ScenarioView

    A ScenarioDefinitionView represents a repeatable AI coding evaluation test, complete with initial environment and scoring contract.

    interface ScenarioView {
        id: string;
        input_context: InputContext;
        metadata: { [key: string]: string };
        name: string;
        scoring_contract: ScoringContract;
        environment?: ScenarioEnvironment | null;
        is_public?: boolean;
        reference_output?: string | null;
        required_environment_variables?: string[];
        required_secret_names?: string[];
        validation_type?:
            | "UNSPECIFIED"
            | "FORWARD"
            | "REVERSE"
            | "EVALUATION"
            | null;
    }
    Index

    Properties

    id input_context metadata name scoring_contract environment? is_public? reference_output? required_environment_variables? required_secret_names? validation_type?

    Properties

    id: string

    The ID of the Scenario.

    input_context: InputContext

    The input context for the Scenario.

    metadata: { [key: string]: string }

    User defined metadata to attach to the scenario for organization.

    name: string

    The name of the Scenario.

    scoring_contract: ScoringContract

    The scoring contract for the Scenario.

    environment?: ScenarioEnvironment | null

    The Environment in which the Scenario is run.

    is_public?: boolean

    Whether this scenario is public.

    reference_output?: string | null

    A string representation of the reference output to solve the scenario. Commonly can be the result of a git diff or a sequence of command actions to apply to the environment.

    required_environment_variables?: string[]

    Environment variables required to run the scenario. If any required environment variables are missing, the scenario will fail to start.

    required_secret_names?: string[]

    Environment variables required to run the scenario. If any required secrets are missing, the scenario will fail to start.

    validation_type?: "UNSPECIFIED" | "FORWARD" | "REVERSE" | "EVALUATION" | null

    Validation strategy.

    Settings

    Member Visibility

    On This Page

    Properties