Interface Sample

A sample containing the input and output of the evaluation run.

interface Sample {
    error: EvalAPIError;
    finish_reason: string;
    input: OpenAIClient.Evals.Runs.OutputItems.OutputItemListResponse.Sample.Input[];
    max_completion_tokens: number;
    model: string;
    output: OpenAIClient.Evals.Runs.OutputItems.OutputItemListResponse.Sample.Output[];
    seed: number;
    temperature: number;
    top_p: number;
    usage: OpenAIClient.Evals.Runs.OutputItems.OutputItemListResponse.Sample.Usage;
}

Properties

error finish_reason input max_completion_tokens model output seed temperature top_p usage

Properties

error

error: EvalAPIError

An object representing an error response from the Eval API.

finish_reason

finish_reason: string

The reason why the sample generation was finished.

input

input: OpenAIClient.Evals.Runs.OutputItems.OutputItemListResponse.Sample.Input[]

An array of input messages.

max_completion_tokens

max_completion_tokens: number

The maximum number of tokens allowed for completion.

model

model: string

The model used for generating the sample.

output

output: OpenAIClient.Evals.Runs.OutputItems.OutputItemListResponse.Sample.Output[]

An array of output messages.

seed

seed: number

The seed used for generating the sample.

temperature

temperature: number

The sampling temperature used.

top_p

top_p: number

The top_p value used for sampling.

usage

usage: OpenAIClient.Evals.Runs.OutputItems.OutputItemListResponse.Sample.Usage

Token usage details for the sample.

Settings

Member Visibility

On This Page

Properties