Skip to main content
POST
/
v2
/
evaluate
Evaluate
curl --request POST \
  --url https://api.valiqor.com/v2/evaluate/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_name": "<string>",
  "dataset": [
    {}
  ],
  "metrics": [
    "<string>"
  ],
  "run_name": "<string>",
  "config": {},
  "metadata": {},
  "openai_api_key": "<string>"
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Valiqor API key. Pass as Bearer token: Authorization: Bearer vq-xxxxxxxxxxxxxxxxxxxx

Body

application/json

Request model for evaluation endpoint

project_name
string
required

Project name (will be created if doesn't exist)

dataset
Dataset · object[]
required

Dataset to evaluate

metrics
string[]
required

Metric keys to compute

run_name
string | null

Optional run name

config
Config · object

Evaluation configuration

metadata
Metadata · object

Additional metadata

openai_api_key
string | null

Optional OpenAI key override

Response

Successful Response