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

    Interface BenchmarkCreateParameters

    BenchmarkCreateParameters contain the set of parameters to create a Benchmark.

    interface BenchmarkCreateParameters {
        name: string;
        attribution?: string | null;
        description?: string | null;
        metadata?: { [key: string]: string } | null;
        required_environment_variables?: string[] | null;
        required_secret_names?: string[];
        scenario_ids?: string[] | null;
    }
    Index

    Properties

    name attribution? description? metadata? required_environment_variables? required_secret_names? scenario_ids?

    Properties

    name: string

    The unique name of the Benchmark.

    attribution?: string | null

    Attribution information for the benchmark.

    description?: string | null

    Detailed description of the benchmark.

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

    User defined metadata to attach to the benchmark.

    required_environment_variables?: string[] | null

    Environment variables required to run the benchmark. If any required variables are not supplied, the benchmark will fail to start.

    required_secret_names?: string[]

    Secrets required to run the benchmark with (environment variable name will be mapped to the your user secret by name). If any of these secrets are not provided or the mapping is incorrect, the benchmark will fail to start.

    scenario_ids?: string[] | null

    The Scenario IDs that make up the Benchmark.

    Settings

    Member Visibility

    On This Page

    Properties