Get dataset items | Opik Documentation

import requests
url = "http://localhost:5173/api/v1/private/datasets/id/items"
payload = {}
headers = {"Content-Type": "application/json"}
response = requests.get(url, json=payload, headers=headers)
print(response.json())

{
  "content": [
    {
      "source": "manual",
      "data": {
        "image_url": "https://example.com/images/sample1.png",
        "label": "cat",
        "metadata": {
          "resolution": "1024x768",
          "format": "png"
        }
      },
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "dataset_item_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "trace_id": "1c6b147e-8f3a-4d2a-9f3e-2a1b9f4c5d6e",
      "span_id": "9f8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
      "description": "Image of a domestic cat sitting on a windowsill.",
      "tags": [
        "animal",
        "cat",
        "indoor"
      ],
      "evaluators": [
        {
          "name": "Image Quality Judge",
          "type": "llm_judge",
          "config": {
            "criteria": [
              "sharpness",
              "lighting",
              "composition"
            ]
          }
        }
      ],
      "execution_policy": {
        "runs_per_item": 3,
        "pass_threshold": 2
      },
      "experiment_items": [
        {
          "experiment_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
          "dataset_item_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
          "trace_id": "1c6b147e-8f3a-4d2a-9f3e-2a1b9f4c5d6e",
          "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "project_id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
          "created_at": "2024-01-15T09:30:00Z",
          "last_updated_at": "2024-01-15T09:30:00Z",
          "created_by": "jane.doe@example.com",
          "last_updated_by": "jane.doe@example.com",
          "trace_visibility_mode": "default",
          "execution_policy": {
            "runs_per_item": 3,
            "pass_threshold": 2
          }
        }
      ],
      "dataset_id": "5b1e2d3c-4f6a-7b8c-9d0e-1f2a3b4c5d6e",
      "created_at": "2024-01-15T09:30:00Z",
      "last_updated_at": "2024-01-15T09:30:00Z",
      "created_by": "jane.doe@example.com",
      "last_updated_by": "jane.doe@example.com"
    }
  ],
  "page": 1,
  "size": 1,
  "total": 1,
  "columns": [
    {
      "name": "label",
      "types": [
        "string"
      ],
      "filter_field_prefix": "data.label",
      "filterField": "data.label"
    }
  ],
  "sortableBy": [
    "created_at",
    "last_updated_at",
    "label"
  ]
}

Get dataset items

Path parameters

idstringRequiredformat: "uuid"

Query parameters

pageintegerOptional>=1Defaults to 1

sizeintegerOptional>=1Defaults to 10

versionstringOptional

filtersstringOptional

truncatebooleanOptional

Response

Dataset items resource

contentlist of objects or null

pageinteger or null

sizeinteger or null

totallong or null

columnslist of objects or null

sortableBylist of strings or null