langsmith.client.Client.list_examples#

Client.list_examples(dataset_id: UUID | str | None = None, dataset_name: str | None = None, example_ids: Sequence[UUID | str] | None = None, as_of: str | datetime | None = None, splits: Sequence[str] | None = None, inline_s3_urls: bool = True, *, offset: int = 0, limit: int | None = None, metadata: dict | None = None, filter: str | None = None, **kwargs: Any) → Iterator[Example][source]#

Retrieve the example rows of the specified dataset.

Parameters:

  • dataset_id (UUID, optional) – The ID of the dataset to filter by. Defaults to None.

  • dataset_name (str, optional) – The name of the dataset to filter by. Defaults to None.

  • example_ids (List[UUID], optional) – The IDs of the examples to filter by. Defaults to None.

  • as_of (datetime, str, or optional) – 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.

  • splits (List[str], optional) – A 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, optional) – Whether to inline S3 URLs. Defaults to True.

  • offset (int) – The offset to start from. Defaults to 0.

  • limit (int, optional) – The maximum number of examples to return.

  • filter (str, optional) – A structured fileter string to apply to the examples.

  • metadata (dict | None) –

  • kwargs (Any) –

Yields:

Example – The examples.

Return type:

Iterator[Example]

On this page