Evals

Create eval

Changed on

Create the structure of an evaluation that can be used to test a model's performance. An evaluation is a set of testing criteria and the config for a data source, which dictates the schema of the data used in the evaluation. After creating an evaluation, you can run it on different models and model parameters. We support several types of graders and datasources. For more information, see the Evals guide.

post/evals

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/evals
  • Auth
    HTTP bearer

Request body

namestring

The name of the evaluation.

metadataMetadata nullable

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.

Response

OK

object'eval' required

The object type.

idstring required

Unique identifier for the evaluation.

namestring required

The name of the evaluation.

created_atinteger required

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

metadataMetadata nullable required

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.

Changes

  • 6f5c52c2ff04Revision changes
    • info

      added the new optional request property //////////

    • info

      added the new optional request property ///////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property ///////////

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

  • e2f8d8cbc41fRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status