List Evaluations

GET

///apis/intake/v2/workspaces/:workspace/evaluations

GET

/apis/intake/v2/workspaces/:workspace/evaluations

curl /apis/intake/v2/workspaces/workspace/evaluations

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "workspace": "string",
      "experiment_ids": [
        "string"
      ],
      "dataset_name": "string",
      "experiment_group_id": "string",
      "dataset_version": "string",
      "source_link": "string",
      "metadata": {},
      "description": "string",
      "parent_evaluation_id": "string",
      "status": "string",
      "root_cause": "string",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "pinned_at": "2024-01-15T09:30:00Z",
      "evaluator_names": [
        "string"
      ],
      "model_names": [
        "string"
      ],
      "agent_names": [
        "string"
      ],
      "agent_versions": [
        "string"
      ],
      "aggregate_scores": {},
      "run_count": 0,
      "test_case_count": 0,
      "cost_usd": {
        "sum": 1.1,
        "mean": 1.1,
        "median": 1.1,
        "p90": 1.1,
        "p95": 1.1,
        "p99": 1.1,
        "count": 0,
        "failed_count": 0
      },
      "latency_ms": {
        "sum": 1.1,
        "mean": 1.1,
        "median": 1.1,
        "p90": 1.1,
        "p95": 1.1,
        "p99": 1.1,
        "count": 0,
        "failed_count": 0
      },
      "tokens": {
        "sum": 1.1,
        "mean": 1.1,
        "median": 1.1,
        "p90": 1.1,
        "p95": 1.1,
        "p99": 1.1,
        "count": 0,
        "failed_count": 0
      }
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 1,
    "current_page_size": 1,
    "total_pages": 1,
    "total_results": 1
  },
  "sort": "string",
  "filter": {}
}

Path parameters

workspacestringRequired

Query parameters

pageintegerOptional>=1Defaults to 1

Page number.

page_sizeintegerOptional1-1000Defaults to 100

Page size.

sortstringOptional

Comma-separated list of fields to sort by, applied in order (the first field dominates); prefix any field with ’-’ for descending — e.g. ‘-evaluators.reward.mean,cost_usd.mean’. Each field is an evaluation attribute (name, created_at, updated_at, pinned_at) or an aggregate metric: run_count, test_case_count, cost_usd.<stat>, latency_ms.<stat>, tokens.<stat>, or evaluators.<name>.<stat>, where <stat> is one of mean, median, p90, p95, p99, sum, count. When omitted, defaults to -created_at with pinned evaluations first.

filterobjectOptional

Filter evaluations by name, experiment_id (experiment group membership; experiment_group_id is a deprecated alias), dataset_name, dataset_version, created_by, created_at, or updated_at. Pass is_deleted=true to return only soft-deleted evaluations; omit to see only live ones. Pass is_pinned=true (or false) to filter by pinned state; omit to return both. Filter by a metadata key/value: filter[metadata.<key>]=<value>. Filter by a rollup metric with numeric range operators ($gte/$lte/$gt/$lt/$eq): filter[run_count][$gte]=5, filter[cost_usd.mean][$lte]=0.5, filter[latency_ms.p95][$lte]=1000, filter[tokens.mean][$lte]=5000, or filter[evaluators.<name>.mean][$gte]=0.8.

Response

Successful Response

datalist of objects

paginationobjectOptional

Pagination information.

sortstringOptional

The field on which the results are sorted.

filtermap from strings to anyOptional

Filtering information.

Errors

400

Bad Request Error

413

Content Too Large Error

422

Unprocessable Entity Error

503

Service Unavailable Error