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

    Interface BenchmarkView

    A BenchmarkDefinitionView represents a grouped set of Scenarios that together form a Benchmark.

    interface BenchmarkView {
        id: string;
        metadata: { [key: string]: string };
        name: string;
        scenarioIds: string[];
        attribution?: string;
        description?: string;
        is_public?: boolean;
        required_environment_variables?: string[];
        required_secret_names?: string[];
    }
    Index

    Properties

    id: string

    The ID of the Benchmark.

    metadata: { [key: string]: string }

    User defined metadata to attach to the benchmark for organization.

    name: string

    The name of the Benchmark.

    scenarioIds: string[]

    List of Scenario IDs that make up the benchmark.

    attribution?: string

    Attribution information for the benchmark.

    description?: string

    Detailed description of the benchmark.

    is_public?: boolean

    Whether this benchmark is public.

    required_environment_variables?: string[]

    Required environment variables used to run the benchmark. If any required environment variables are missing, the benchmark will fail to start.

    required_secret_names?: string[]

    Required secrets used to run the benchmark. If any required secrets are missing, the benchmark will fail to start.