Skip to main content
GET
/
v1
/
retrievers
/
evaluations
/
datasets
List evaluation datasets
curl --request GET \
  --url https://api.mixpeek.com/v1/retrievers/evaluations/datasets \
  --header 'Authorization: <authorization>' \
  --header 'X-Namespace: <x-namespace>'
{
  "datasets": [
    {
      "dataset_id": "<string>",
      "dataset_name": "<string>",
      "queries": [
        {
          "query_id": "<string>",
          "query_input": {},
          "relevant_documents": [
            "<string>"
          ],
          "relevance_scores": {}
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "namespace_id": "<string>",
      "internal_id": "<string>",
      "query_count": 123,
      "description": "<string>",
      "metadata": {}
    }
  ],
  "total": 123,
  "page": 123,
  "page_size": 123
}

Headers

Authorization
string
required

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

X-Namespace
string
required

REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'

Query Parameters

page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
page_size
integer
default:20

Items per page

Required range: 1 <= x <= 100

Response

Successful Response

Response model for listing datasets.

datasets
EvaluationDataset · object[]
required

List of datasets

total
integer
required

Total number of datasets

page
integer
required

Current page number

page_size
integer
required

Items per page