Datasets Client¶

The Datasets client provides methods for managing datasets in the Opik platform.

class opik.rest_api.datasets.client.DatasetsClient(*, client_wrapper: SyncClientWrapper)¶

Bases: object

Find datasets

Parameters:

page (Optional[int])
size (Optional[int])
with_experiments_only (Optional[bool])
with_optimizations_only (Optional[bool])
prompt_id (Optional[str])
name (Optional[str])
sorting (Optional[str])
request_options (Optional[RequestOptions]) – Request-specific configuration.

Returns:

Dataset resource

Return type:

DatasetPagePublic

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.datasets.find_datasets()

Create dataset

Parameters:

name (str)
id (Optional[str])
visibility (Optional[DatasetWriteVisibility])
description (Optional[str])
request_options (Optional[RequestOptions]) – Request-specific configuration.

Return type:

None

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.datasets.create_dataset(name=’name’, )

create_or_update_dataset_items(*, items: Sequence[DatasetItemWrite], dataset_name: str | None = OMIT, dataset_id: str | None = OMIT, request_options: RequestOptions | None = None) → None¶

Create/update dataset items based on dataset item id

Parameters:

items (Sequence[DatasetItemWrite])
dataset_name (Optional[str]) – If null, dataset_id must be provided
dataset_id (Optional[str]) – If null, dataset_name must be provided
request_options (Optional[RequestOptions]) – Request-specific configuration.

Return type:

None

Examples

from Opik import OpikApi from Opik import DatasetItemWrite client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.datasets.create_or_update_dataset_items(items=[DatasetItemWrite(source=”manual”, data={‘key’: ‘value’ }, )], )

get_dataset_by_id(id: str, *, request_options: RequestOptions | None = None) → DatasetPublic¶

Get dataset by id

Parameters:

id (str)
request_options (Optional[RequestOptions]) – Request-specific configuration.

Returns:

Dataset resource

Return type:

DatasetPublic

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.datasets.get_dataset_by_id(id=’id’, )

update_dataset(id: str, *, name: str, description: str | None = OMIT, visibility: Literal['private', 'public'] | Any | None = OMIT, request_options: RequestOptions | None = None) → None¶

Update dataset by id

Parameters:

id (str)
name (str)
description (Optional[str])
visibility (Optional[DatasetUpdateVisibility])
request_options (Optional[RequestOptions]) – Request-specific configuration.

Return type:

None

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.datasets.update_dataset(id=’id’, name=’name’, )

delete_dataset(id: str, *, request_options: RequestOptions | None = None) → None¶

Delete dataset by id

Parameters:

id (str)
request_options (Optional[RequestOptions]) – Request-specific configuration.

Return type:

None

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.datasets.delete_dataset(id=’id’, )

delete_dataset_by_name(*, dataset_name: str, request_options: RequestOptions | None = None) → None¶

Delete dataset by name

Parameters:

dataset_name (str)
request_options (Optional[RequestOptions]) – Request-specific configuration.

Return type:

None

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.datasets.delete_dataset_by_name(dataset_name=’dataset_name’, )

delete_dataset_items(*, item_ids: Sequence[str], request_options: RequestOptions | None = None) → None¶

Delete dataset items

Parameters:

item_ids (Sequence[str])
request_options (Optional[RequestOptions]) – Request-specific configuration.

Return type:

None

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.datasets.delete_dataset_items(item_ids=[‘item_ids’], )

delete_datasets_batch(*, ids: Sequence[str], request_options: RequestOptions | None = None) → None¶

Delete datasets batch

Parameters:

ids (Sequence[str])
request_options (Optional[RequestOptions]) – Request-specific configuration.

Return type:

None

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.datasets.delete_datasets_batch(ids=[‘ids’], )

find_dataset_items_with_experiment_items(id: str, *, experiment_ids: str, page: int | None = None, size: int | None = None, filters: str | None = None, truncate: bool | None = None, request_options: RequestOptions | None = None) → DatasetItemPageCompare¶

Find dataset items with experiment items

Parameters:

id (str)
experiment_ids (str)
page (Optional[int])
size (Optional[int])
filters (Optional[str])
truncate (Optional[bool])
request_options (Optional[RequestOptions]) – Request-specific configuration.

Returns:

Dataset item resource

Return type:

DatasetItemPageCompare

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.datasets.find_dataset_items_with_experiment_items(id=’id’, experiment_ids=’experiment_ids’, )

get_dataset_by_identifier(*, dataset_name: str, request_options: RequestOptions | None = None) → DatasetPublic¶

Get dataset by name

Parameters:

dataset_name (str)
request_options (Optional[RequestOptions]) – Request-specific configuration.

Returns:

Dataset resource

Return type:

DatasetPublic

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.datasets.get_dataset_by_identifier(dataset_name=’dataset_name’, )

get_dataset_item_by_id(item_id: str, *, request_options: RequestOptions | None = None) → DatasetItemPublic¶

Get dataset item by id

Parameters:

item_id (str)
request_options (Optional[RequestOptions]) – Request-specific configuration.

Returns:

Dataset item resource

Return type:

DatasetItemPublic

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.datasets.get_dataset_item_by_id(item_id=’itemId’, )

get_dataset_items(id: str, *, page: int | None = None, size: int | None = None, truncate: bool | None = None, request_options: RequestOptions | None = None) → DatasetItemPagePublic¶

Get dataset items

Parameters:

id (str)
page (Optional[int])
size (Optional[int])
truncate (Optional[bool])
request_options (Optional[RequestOptions]) – Request-specific configuration.

Returns:

Dataset items resource

Return type:

DatasetItemPagePublic

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.datasets.get_dataset_items(id=’id’, )

get_dataset_items_output_columns(id: str, *, experiment_ids: str | None = None, request_options: RequestOptions | None = None) → PageColumns¶

Get dataset items output columns

Parameters:

id (str)
experiment_ids (Optional[str])
request_options (Optional[RequestOptions]) – Request-specific configuration.

Returns:

Dataset item output columns

Return type:

PageColumns

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.datasets.get_dataset_items_output_columns(id=’id’, )

stream_dataset_items(*, dataset_name: str, last_retrieved_id: str | None = OMIT, steam_limit: int | None = OMIT, request_options: RequestOptions | None = None) → Iterator[bytes]¶

Stream dataset items

Parameters:

dataset_name (str)
last_retrieved_id (Optional[str])
steam_limit (Optional[int])
request_options (Optional[RequestOptions]) – Request-specific configuration. You can pass in configuration such as chunk_size, and more to customize the request and response.

Returns:

Dataset items stream or error during process

Return type:

Iterator[bytes]

Usage Example¶

import opik

client = opik.Opik()

# Find datasets
datasets = client.rest_client.datasets.find_datasets(
    page=0,
    size=10
)

# Get a dataset by ID
dataset = client.rest_client.datasets.get_dataset_by_id("dataset-id")

# Create a new dataset
client.rest_client.datasets.create_dataset(
    name="my-dataset",
    description="A test dataset"
)

# Get dataset items
items = client.rest_client.datasets.get_dataset_items(
    dataset_id="dataset-id",
    page=0,
    size=100
)