OpenAPI::Client::OpenAI::Path::evals-eval_id(3)

NAME
OpenAPI::Client::OpenAI::Path::evals-eval_id - Documentation for the /evals/{eval_id} path.

DESCRIPTION
This document describes the API endpoint at "/evals/{eval_id}".

PATHS

  "DELETE /evals/{eval_id}"
Delete an evaluation.

Operation ID

"deleteEval"

    $client->deleteEval( ... );

Parameters

•   "eval_id" (in path) (Required) - The ID of the evaluation to delete.

    Type: "string"

Responses

Status Code: 200

Successfully deleted the evaluation.

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

        {
           "deleted" : true,
           "eval_id" : "eval_abc123",
           "object" : "eval.deleted"
        }

Status Code: 404

Evaluation not found.

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

  "GET /evals/{eval_id}"
Get an evaluation by ID.

Operation ID

"getEval"

    $client->getEval( ... );

Parameters

•   "eval_id" (in path) (Required) - The ID of the evaluation to retrieve.

    Type: "string"

Responses

Status Code: 200

The evaluation

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

        {
          "object": "eval",
          "id": "eval_67abd54d9b0081909a86353f6fb9317a",
          "data_source_config": {
            "type": "custom",
            "item_schema": {
              "type": "object",
              "properties": {
                "label": {"type": "string"},
              },
              "required": ["label"]
            },
            "include_sample_schema": true
          },
          "testing_criteria": [
            {
              "name": "My string check grader",
              "type": "string_check",
              "input": "{{sample.output_text}}",
              "reference": "{{item.label}}",
              "operation": "eq",
            }
          ],
          "name": "External Data Eval",
          "created_at": 1739314509,
          "metadata": {
            "test": "synthetics",
          }
        }

  "POST /evals/{eval_id}"
Update certain properties of an evaluation.

Operation ID

"updateEval"

    $client->updateEval( ... );

Parameters

•   "eval_id" (in path) (Required) - The ID of the evaluation to update.

    Type: "string"

Request Body

Content Type: "application/json"

Responses

Status Code: 200

The updated evaluation

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

        {
          "object": "eval",
          "id": "eval_67abd54d9b0081909a86353f6fb9317a",
          "data_source_config": {
            "type": "custom",
            "item_schema": {
              "type": "object",
              "properties": {
                "label": {"type": "string"},
              },
              "required": ["label"]
            },
            "include_sample_schema": true
          },
          "testing_criteria": [
            {
              "name": "My string check grader",
              "type": "string_check",
              "input": "{{sample.output_text}}",
              "reference": "{{item.label}}",
              "operation": "eq",
            }
          ],
          "name": "External Data Eval",
          "created_at": 1739314509,
          "metadata": {
            "test": "synthetics",
          }
        }

SEE ALSO
OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE
Copyright (C) 2023-2025 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.