Evaluations

Update an eval

Updates an eval. Changing agent_id re-validates the scorers against the new agent, since an output_schema scorer that was legal against the old one may not be.

put/v1/projects/{project_id}/evals/{eval_id}

Request

  • Base URL: https://api.naturali.ai
  • URL: https://api.naturali.ai/v1/projects/{project_id}/evals/{eval_id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.naturali.ai/authorize, token URL https://api.naturali.ai/token, scopes: mcp:access)

Path parameters

eval_idstring required
Example:eval_V1StGXR8Z5jdHi6B

Eval ID

Request body

namestring
agent_idstring
dataset_idstring
pass_thresholdnumber nullable
group_bystring nullable

A key of the items' metadata to group run scores by; null clears it, omitting it leaves it unchanged.

Example request

{
  "name": "billing-regression-suite",
  "agent_id": "agent_V1StGXR8Z5jdHi6B",
  "dataset_id": "dset_V1StGXR8Z5jdHi6B",
  "scorers": [
    {
      "value": "invoice"
    }
  ],
  "pass_threshold": 0.8,
  "group_by": "kind"
}

Response

Eval updated successfully

idstring
project_idstring
namestring
agent_idstring
dataset_idstring
pass_thresholdnumber nullable
group_bystring nullable

The item metadata key a run rolls its scores up by; null when the eval groups nothing

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "eval_V1StGXR8Z5jdHi6B",
  "agent_id": "agent_V1StGXR8Z5jdHi6B",
  "dataset_id": "dset_V1StGXR8Z5jdHi6B",
  "scorers": [
    {
      "value": "invoice"
    }
  ],
  "group_by": "kind"
}

Changes

No recorded changes to this operation across all 1 revision of this API.