Interface EvalCreateParams

interface EvalCreateParams {
    data_source_config: Custom | OpenAIClient.Evals.EvalCreateParams.StoredCompletions;
    metadata?: null | Metadata;
    name?: string;
    share_with_openai?: boolean;
    testing_criteria: (EvalStringCheckGrader | EvalTextSimilarityGrader | LabelModel)[];
}

Properties

data_source_config metadata? name? share_with_openai? testing_criteria

Properties

data_source_config

data_source_config: Custom | OpenAIClient.Evals.EvalCreateParams.StoredCompletions

The configuration for the data source used for the evaluation runs.

Optionalmetadata

metadata?: null | Metadata

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Optionalname

name?: string

The name of the evaluation.

Optionalshare_with_openai

share_with_openai?: boolean

Indicates whether the evaluation is shared with OpenAI.

testing_criteria

testing_criteria: (EvalStringCheckGrader | EvalTextSimilarityGrader | LabelModel)[]

A list of graders for all eval runs in this group.

Settings

Member Visibility

On This Page

Properties