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

    Interface ScenarioUpdateParameters

    ScenarioUpdateParameters contain the set of parameters to update a Scenario. All fields are optional - null fields preserve existing values, provided fields replace entirely.

    interface ScenarioUpdateParameters {
        environment_parameters?: ScenarioEnvironment | null;
        input_context?: InputContextUpdate | null;
        metadata?: { [key: string]: string } | null;
        name?: string | null;
        reference_output?: string | null;
        required_environment_variables?: string[] | null;
        required_secret_names?: string[] | null;
        scoring_contract?: ScoringContractUpdate | null;
        validation_type?:
            | "UNSPECIFIED"
            | "FORWARD"
            | "REVERSE"
            | "EVALUATION"
            | null;
    }
    Index

    Properties

    environment_parameters? input_context? metadata? name? reference_output? required_environment_variables? required_secret_names? scoring_contract? validation_type?

    Properties

    environment_parameters?: ScenarioEnvironment | null

    The Environment in which the Scenario will run.

    input_context?: InputContextUpdate | null

    The input context for the Scenario.

    metadata?: { [key: string]: string } | null

    User defined metadata to attach to the scenario. Pass in empty map to clear.

    name?: string | null

    Name of the scenario. Cannot be blank.

    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. Pass in empty string to clear.

    required_environment_variables?: string[] | null

    Environment variables required to run the scenario. Pass in empty list to clear.

    required_secret_names?: string[] | null

    Secrets required to run the scenario. Pass in empty list to clear.

    scoring_contract?: ScoringContractUpdate | null

    The scoring contract for the Scenario.

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

    Validation strategy. Pass in empty string to clear.

    Settings

    Member Visibility

    On This Page

    Properties