langsmith.client.Client.index_dataset#

Client.index_dataset(*, dataset_id: UUID | str, tag: str = 'latest', **kwargs: Any) → None[source]#

Enable dataset indexing. Examples are indexed by their inputs.

This enables searching for similar examples by inputs with client.similar_examples().

Parameters:

dataset_id (UUID) – The ID of the dataset to index.
tag (str, optional) – The version of the dataset to index. If ‘latest’ then any updates to the dataset (additions, updates, deletions of examples) will be reflected in the index.
kwargs (Any) –

Returns:

None

Raises:

requests.HTTPError –

Return type:

None