| Name | Type | Description |
|---|---|---|
dataset_id | Optional[Union[UUID, str]] | Default: NoneThe ID of the dataset to filter by. |
dataset_name | Optional[str] | Default: None |
example_ids | Optional[Sequence[Union[UUID, str]] | Default: None |
as_of | Optional[Union[datetime.datetime, str]] | Default: None |
splits | Optional[Sequence[str]] | Default: None |
inline_s3_urls | bool, default=True | Default: True |
offset | int, default=0 | Default: 0 |
limit | Optional[int] | Default: None |
metadata | Optional[dict] | Default: None |
filter | Optional[str] | Default: None |
include_attachments | bool, default=False | Default: False |
**kwargs | Any | Default: {} |
Retrieve the example rows of the specified dataset.
The name of the dataset to filter by.
The IDs of the examples to filter by.
The dataset version tag OR timestamp to retrieve the examples as of. Response examples will only be those that were present at the time of the tagged (or timestamped) version.
A list of dataset splits, which are divisions of your dataset such as 'train', 'test', or 'validation'. Returns examples only from the specified splits.
Whether to inline S3 URLs.
The offset to start from. Defaults to 0.
The maximum number of examples to return.
A dictionary of metadata to filter by.
A structured filter string to apply to the examples.
Whether to include the attachments in the response.
Additional keyword arguments are ignored.
