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
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

OverviewClientAsyncClientRun HelpersRun TreesEvaluationSchemasUtilitiesWrappersAnonymizerTestingExpect APIMiddlewarePytest PluginDeployment SDK
Language
Theme
PythonlangsmithclientClientlist_projects
Method●Since v0.0

list_projects

List projects from the LangSmith API.

Copy
list_projects( self, project_ids: Optional[list[ID_TYPE]] = None, name: Optional[str] = None, name_contains: Optional[str] = None, reference_dataset_id: Optional[ID_TYPE] = None, reference_dataset_name: Optional[str] = None, reference_free: Optional[bool] = None, include_stats: Optional[bool] = None, dataset_version: Optional[str] = None, limit: Optional[int] = None, metadata: Optional[dict[str, Any]] = None ) -> Iterator[ls_schemas.TracerSessionResult]

Parameters

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

A list of project IDs to filter by, by default None

nameOptional[str]
Default:None

The name of the project to filter by, by default None

name_containsOptional[str]
Default:None

A string to search for in the project name, by default None

reference_dataset_idOptional[List[Union[UUID, str]]]
Default:None

A dataset ID to filter by, by default None

reference_dataset_nameOptional[str]
Default:None

The name of the reference dataset to filter by, by default None

reference_freeOptional[bool]
Default:None

Whether to filter for only projects not associated with a dataset.

limitOptional[int]
Default:None

The maximum number of projects to return, by default None

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

Metadata to filter by.

View source on GitHub