Dynamiq
Evaluations

List evaluations

Lists the evaluation runs of a project, ordered by name. The project_id query parameter is required.

GET
/v1/evaluations

Authorization

personalAccessToken
AuthorizationBearer <token>

Personal Access Token of a Dynamiq user — the only credential accepted by the management API (api.*). Prefix dyn_pat_ (legacy uak_ tokens still authenticate). Send as Authorization: Bearer <token>.

In: header

Query Parameters

project_id*string

Project UUID to list evaluations for.

page?integer

Page number (1-based).

page_size?integer

Number of items per page. Values below the minimum or above the maximum are clamped to the nearest bound.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/evaluations?project_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
      "status": "pending",
      "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
      "dataset_version_id": "04e89766-1052-429f-ac43-0b0a79802db7",
      "config": [
        {
          "workflow": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "version_id": "9e94c502-ca41-4342-a7f7-af96b444512c",
            "input_transformer": {
              "path": "string",
              "selector": {
                "property1": "string",
                "property2": "string"
              }
            }
          },
          "metrics": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "version_id": "9e94c502-ca41-4342-a7f7-af96b444512c",
              "input_transformer": {
                "path": "string",
                "selector": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            }
          ]
        }
      ],
      "started_at": "2019-08-24T14:15:22Z",
      "started_by": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "first_name": "string",
        "last_name": "string",
        "avatar_url": "string"
      },
      "ended_at": "2019-08-24T14:15:22Z",
      "ended_by": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "first_name": "string",
        "last_name": "string",
        "avatar_url": "string"
      }
    }
  ],
  "pagination": {
    "page": 0,
    "page_size": 0,
    "page_count": 0,
    "total_count": 0
  }
}
{
  "error": {
    "code": "bad_request",
    "message": "Bad Request",
    "details": {
      "input": "cannot be blank"
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

Resume a knowledge base source

Resumes automatic synchronization for a paused source. Its status returns to `active`.

Start an evaluation

Starts a batch evaluation run. Each workflow in `config` is executed against every item of the released dataset version, then the configured metrics score the outputs. The dataset version must be released. Execution is asynchronous: the run is persisted and fanned out onto a task queue, and the response is returned immediately with `status` `running`. Poll the run — or its results — for completion. Status is one of `pending`, `running`, `failed`, `succeeded`, or `canceled`.