Datasets

Search dataset examples

Changed on

Search examples for a given dataset with an optional SQL-like filter.

Examples are returned in ascending order of created_at, with id as a tiebreaker. This order is stable across pages. Pagination uses the cursor returned in pagination.next_cursor; keep the filter unchanged when requesting subsequent pages.

The filter language supports unprefixed example columns, id, and annotation.<name>.* when those columns are present in the example schema.

Payload Requirements

  • filter is optional. Omitting it returns all examples. A present empty or whitespace-only value is invalid.
  • limit is optional and defaults to 50; valid values are 1 through 500.
  • cursor is optional; omitting it starts at the first page.
  • dataset_version_id is optional; omitting it searches the latest version.

Valid example

{
  "filter": "topic = 'arithmetic'",
  "limit": 50,
  "cursor": "opaque-cursor"
}

Invalid example (limit is outside the supported range)

{
  "filter": "topic = 'arithmetic'",
  "limit": 501
}

<Warning>This endpoint is in alpha, read more here.</Warning>

post/v2/datasets/{dataset_id}/examples/search

Request

  • Base URL
    https://api.arize.com
  • URL
    https://api.arize.com/v2/datasets/{dataset_id}/examples/search
  • Auth
    HTTP bearer

Path parameters

dataset_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique dataset identifier (base64)

Request body

filterstring

SQL-like filter expression. Omit to search all examples; an empty or whitespace-only value is invalid.

limitinteger

Maximum number of examples to return. Defaults to 50 and must be between 1 and 500.

cursorstring

Opaque cursor from pagination.next_cursor. Omit to start at the first page; keep the filter unchanged while paging.

dataset_version_idstring

Unique identifier of the dataset version to search. If omitted, the latest version is selected.

Example request

{
  "filter": "topic = 'arithmetic'",
  "limit": 50,
  "cursor": "opaque-cursor",
  "dataset_version_id": "RGF0YXNldFZlcnNpb246MTIzNDU="
}

Response

Returns a list of dataset examples as structured objects

Example response

{
  "examples": [
    {
      "annotations": [
        {
          "annotator": {
            "email": "user@example.com"
          }
        }
      ]
    }
  ]
}

Changes