Get an eval

client.evals.retrieve(, ?): EvalRetrieveResponse { id, created_at, data_source_config, 4 more }

GET/evals/{eval_id}

Get an evaluation by ID.

ParametersExpand Collapse

evalID: string

ReturnsExpand Collapse

EvalRetrieveResponse { id, created_at, data_source_config, 4 more }

An Eval object with a data source config and testing criteria. An Eval represents a task to be done for your LLM integration. Like:

Improve the quality of my chatbot
See how well my chatbot handles customer support
Check if o4-mini is better at my usecase than gpt-4o

id: string

Unique identifier for the evaluation.

created_at: number

The Unix timestamp (in seconds) for when the eval was created.

data_source_config: EvalCustomDataSourceConfig { schema, type } | Logs { schema, type, metadata } | EvalStoredCompletionsDataSourceConfig { schema, type, metadata }

Configuration of data sources used in runs of the evaluation.

One of the following:

EvalCustomDataSourceConfig { schema, type }

A CustomDataSourceConfig which specifies the schema of your item and optionally sample namespaces. The response schema defines the shape of the data that will be:

Used to define your testing criteria and
What data is required when creating a run

schema: Record<string, unknown>

The json schema for the run data source items. Learn how to build JSON schemas here.

type: "custom"

The type of data source. Always custom.

Logs { schema, type, metadata }

A LogsDataSourceConfig which specifies the metadata property of your logs query. This is usually metadata like usecase=chatbot or prompt-version=v2, etc. The schema returned by this data source config is used to defined what variables are available in your evals. item and sample are both defined when using this data source config.

schema: Record<string, unknown>

The json schema for the run data source items. Learn how to build JSON schemas here.

type: "logs"

The type of data source. Always logs.

metadata?: Metadata | null

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.

EvalStoredCompletionsDataSourceConfig { schema, type, metadata }

Deprecated in favor of LogsDataSourceConfig.

schema: Record<string, unknown>

The json schema for the run data source items. Learn how to build JSON schemas here.

type: "stored_completions"

The type of data source. Always stored_completions.

metadata?: Metadata | null

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

metadata: Metadata | null

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

The name of the evaluation.

object: "eval"

The object type.

testing_criteria: Array<LabelModelGrader { input, labels, model, 3 more } | StringCheckGrader { input, name, operation, 2 more } | EvalGraderTextSimilarity { pass_threshold } | 2 more>

A list of testing criteria.

One of the following:

LabelModelGrader { input, labels, model, 3 more }

A LabelModelGrader object which uses a model to assign labels to each item in the evaluation.

input: Array<Input>

content: string | ResponseInputText { text, type } | OutputText { text, type } | 3 more

Inputs to the model - can contain template strings. Supports text, output text, input images, and input audio, either as a single item or an array of items.

One of the following:

string

ResponseInputText { text, type }

A text input to the model.

text: string

The text input to the model.

type: "input_text"

The type of the input item. Always input_text.

OutputText { text, type }

A text output from the model.

text: string

The text output from the model.

type: "output_text"

The type of the output text. Always output_text.

InputImage { image_url, type, detail }

An image input block used within EvalItem content arrays.

image_url: string

The URL of the image input.

type: "input_image"

The type of the image input. Always input_image.

detail?: string

The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.

ResponseInputAudio { input_audio, type }

An audio input to the model.

input_audio: InputAudio { data, format }

data: string

Base64-encoded audio data.

format: "mp3" | "wav"

The format of the audio data. Currently supported formats are mp3 and wav.

One of the following:

"mp3"

"wav"

type: "input_audio"

The type of the input item. Always input_audio.

GraderInputs = Array<string | ResponseInputText { text, type } | OutputText { text, type } | 2 more>

A list of inputs, each of which may be either an input text, output text, input image, or input audio object.

One of the following:

string

ResponseInputText { text, type }

A text input to the model.

text: string

The text input to the model.

type: "input_text"

The type of the input item. Always input_text.

OutputText { text, type }

A text output from the model.

text: string

The text output from the model.

type: "output_text"

The type of the output text. Always output_text.

InputImage { image_url, type, detail }

An image input block used within EvalItem content arrays.

image_url: string

The URL of the image input.

type: "input_image"

The type of the image input. Always input_image.

detail?: string

The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.

ResponseInputAudio { input_audio, type }

An audio input to the model.

input_audio: InputAudio { data, format }

data: string

Base64-encoded audio data.

format: "mp3" | "wav"

The format of the audio data. Currently supported formats are mp3 and wav.

One of the following:

"mp3"

"wav"

type: "input_audio"

The type of the input item. Always input_audio.

role: "user" | "assistant" | "system" | "developer"

The role of the message input. One of user, assistant, system, or developer.

One of the following:

"user"

"assistant"

"system"

"developer"

type?: "message"

The type of the message input. Always message.

labels: Array<string>

The labels to assign to each item in the evaluation.

model: string

The model to use for the evaluation. Must support structured outputs.

The name of the grader.

passing_labels: Array<string>

The labels that indicate a passing result. Must be a subset of labels.

type: "label_model"

The object type, which is always label_model.

StringCheckGrader { input, name, operation, 2 more }

A StringCheckGrader object that performs a string comparison between input and reference using a specified operation.

input: string

The input text. This may include template strings.

The name of the grader.

operation: "eq" | "ne" | "like" | "ilike"

The string check operation to perform. One of eq, ne, like, or ilike.

One of the following:

"eq"

"ne"

"like"

"ilike"

reference: string

The reference text. This may include template strings.

type: "string_check"

The object type, which is always string_check.

EvalGraderTextSimilarity extends TextSimilarityGrader { evaluation_metric, input, name, 2 more } { pass_threshold }

A TextSimilarityGrader object which grades text based on similarity metrics.

pass_threshold: number

The threshold for the score.

EvalGraderPython extends PythonGrader { name, source, type, image_tag } { pass_threshold }

A PythonGrader object that runs a python script on the input.

pass_threshold?: number

The threshold for the score.

EvalGraderScoreModel extends ScoreModelGrader { input, model, name, 3 more } { pass_threshold }

A ScoreModelGrader object that uses a model to assign a score to the input.

pass_threshold?: number

The threshold for the score.

Get an eval

import OpenAI from "openai";

const openai = new OpenAI();

const evalObj = await openai.evals.retrieve("eval_67abd54d9b0081909a86353f6fb9317a");
console.log(evalObj);

{
  "object": "eval",
  "id": "eval_67abd54d9b0081909a86353f6fb9317a",
  "data_source_config": {
    "type": "custom",
    "schema": {
      "type": "object",
      "properties": {
        "item": {
          "type": "object",
          "properties": {
            "input": {
              "type": "string"
            },
            "ground_truth": {
              "type": "string"
            }
          },
          "required": [
            "input",
            "ground_truth"
          ]
        }
      },
      "required": [
        "item"
      ]
    }
  },
  "testing_criteria": [
    {
      "name": "String check",
      "id": "String check-2eaf2d8d-d649-4335-8148-9535a7ca73c2",
      "type": "string_check",
      "input": "{{item.input}}",
      "reference": "{{item.ground_truth}}",
      "operation": "eq"
    }
  ],
  "name": "External Data Eval",
  "created_at": 1739314509,
  "metadata": {},
}

Returns Examples

{
  "object": "eval",
  "id": "eval_67abd54d9b0081909a86353f6fb9317a",
  "data_source_config": {
    "type": "custom",
    "schema": {
      "type": "object",
      "properties": {
        "item": {
          "type": "object",
          "properties": {
            "input": {
              "type": "string"
            },
            "ground_truth": {
              "type": "string"
            }
          },
          "required": [
            "input",
            "ground_truth"
          ]
        }
      },
      "required": [
        "item"
      ]
    }
  },
  "testing_criteria": [
    {
      "name": "String check",
      "id": "String check-2eaf2d8d-d649-4335-8148-9535a7ca73c2",
      "type": "string_check",
      "input": "{{item.input}}",
      "reference": "{{item.ground_truth}}",
      "operation": "eq"
    }
  ],
  "name": "External Data Eval",
  "created_at": 1739314509,
  "metadata": {},
}

Suggested

Get an eval

ParametersExpand Collapse

ReturnsExpand Collapse

Get an eval

Returns Examples