Search dataset examples
Changed onSearch 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>
Request
- Base URLhttps://api.arize.com
- URLhttps://api.arize.com/v2/datasets/{dataset_id}/examples/search
- AuthHTTP bearer
Path parameters
A universally unique identifier (base64-encoded opaque string).
The unique dataset identifier (base64)
Request body
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
- info
endpoint added
- info