Retrieve the example rows of the specified dataset.
list_examples(
self,
dataset_id: Optional[ID_TYPE] = None,
dataset_name: Optional[str] = None,
example_ids: Optional[Sequence[ID_TYPE]] = None,
as_of: Optional[Union[datetime.datetime, str]] = None,
splits: Optional[Sequence[str]] = None,
inline_s3_urls: bool = True,
*,
offset: int = 0,
limit: Optional[int] = None,
metadata: Optional[dict] = None,
filter: Optional[str] = None,
include_attachments: bool = False,
**kwargs: Any = {}
) -> Iterator[ls_schemas.Example]| Name | Type | Description |
|---|---|---|
dataset_id | Optional[Union[UUID, str]] | Default: NoneThe ID of the dataset to filter by. |
dataset_name | Optional[str] | Default: NoneThe name of the dataset to filter by. |
example_ids | Optional[Sequence[Union[UUID, str]] | Default: NoneThe IDs of the examples to filter by. |
as_of | Optional[Union[datetime.datetime, str]] | Default: NoneThe 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. |
splits | Optional[Sequence[str]] | Default: NoneA list of dataset splits, which are divisions of your dataset such as 'train', 'test', or 'validation'. Returns examples only from the specified splits. |
inline_s3_urls | bool, default=True | Default: TrueWhether to inline S3 URLs. |
offset | int, default=0 | Default: 0The offset to start from. Defaults to 0. |
limit | Optional[int] | Default: NoneThe maximum number of examples to return. |
metadata | Optional[dict] | Default: NoneA dictionary of metadata to filter by. |
filter | Optional[str] | Default: NoneA structured filter string to apply to the examples. |
include_attachments | bool, default=False | Default: FalseWhether to include the attachments in the response. |
**kwargs | Any | Default: {}Additional keyword arguments are ignored. |