langsmith.client.Client.read_dataset_shared_schema#

Client.read_dataset_shared_schema(dataset_id: UUID | str | None = None, *, dataset_name: str | None = None) → DatasetShareSchema[source]#

Retrieve the shared schema of a dataset.

Parameters:

  • dataset_id (Optional[ID_TYPE]) – The ID of the dataset. Either dataset_id or dataset_name must be given.

  • dataset_name (Optional[str]) – The name of the dataset. Either dataset_id or dataset_name must be given.

Returns:

The shared schema of the dataset.

Return type:

ls_schemas.DatasetShareSchema

Raises:

ValueError – If neither dataset_id nor dataset_name is given.