Update an eval

POSThttps:/api.openai.com/v1/evals/{eval_id}

Update certain properties of an evaluation.

Path parameters

eval_id
string
Required
The ID of the evaluation to update.

Request body

name
string
Rename the evaluation.
metadata
object or 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.

Response

The Eval object matching the updated version.

Example request

1curl https://api.openai.com/v1/evals/eval_67abd54d9b0081909a86353f6fb9317a \
2  -H "Authorization: Bearer $OPENAI_API_KEY" \
3  -H "Content-Type: application/json" \
4  -d '{"name": "Updated Eval", "metadata": {"description": "Updated description"}}'

Example response

1{
2  "object": "eval",
3  "id": "eval_67abd54d9b0081909a86353f6fb9317a",
4  "data_source_config": {
5    "type": "custom",
6    "schema": {
7      "type": "object",
8      "properties": {
9        "item": {
10          "type": "object",
11          "properties": {
12            "input": {
13              "type": "string"
14            },
15            "ground_truth": {
16              "type": "string"
17            }
18          },
19          "required": [
20            "input",
21            "ground_truth"
22          ]
23        }
24      },
25      "required": [
26        "item"
27      ]
28    }
29  },
30  "testing_criteria": [
31    {
32      "name": "String check",
33      "id": "String check-2eaf2d8d-d649-4335-8148-9535a7ca73c2",
34      "type": "string_check",
35      "input": "{{item.input}}",
36      "reference": "{{item.ground_truth}}",
37      "operation": "eq"
38    }
39  ],
40  "name": "Updated Eval",
41  "created_at": 1739314509,
42  "metadata": {"description": "Updated description"},
43}

Built with