LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • Client
  • AsyncClient
  • Run Helpers
  • Run Trees
  • Evaluation
  • Schemas
  • Utilities
  • Wrappers
  • Anonymizer
  • Testing
  • Expect API
  • Middleware
  • Pytest Plugin
  • Deployment SDK
  • RemoteGraph
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

OverviewClientAsyncClientRun HelpersRun TreesEvaluationSchemasUtilitiesWrappersAnonymizerTestingExpect APIMiddlewarePytest PluginDeployment SDKRemoteGraph
Language
Theme
PythonlangsmithclientClientlist_datasets
Method●Since v0.0

list_datasets

List the datasets on the LangSmith API.

Copy
list_datasets(
  self,
  *,
  dataset_ids: Optional[list[ID_TYPE]] = None,
  data_type: Optional[str] = None,
  dataset_name: Optional[str] = None,
  dataset_name_contains: Optional[str] = None,
  metadata: Optional[dict[str, Any]] = None,
  limit: Optional[int] = None
) -> Iterator[ls_schemas.Dataset]

Parameters

NameTypeDescription
dataset_idsOptional[List[Union[UUID, str]]]
Default:None

A list of dataset IDs to filter the results by.

data_typeOptional[str]
Default:None

The data type of the datasets to filter the results by.

dataset_nameOptional[str]
Default:None

The name of the dataset to filter the results by.

dataset_name_containsOptional[str]
Default:None

A substring to search for in the dataset names.

metadataOptional[Dict[str, Any]]
Default:None

A dictionary of metadata to filter the results by.

limitOptional[int]
Default:None

The maximum number of datasets to return.

View source on GitHub