langsmith.client.Client.list_projects#

Client.list_projects(project_ids: List[UUID | str] | None = None, name: str | None = None, name_contains: str | None = None, reference_dataset_id: UUID | str | None = None, reference_dataset_name: str | None = None, reference_free: bool | None = None, limit: int | None = None, metadata: Dict[str, Any] | None = None) → Iterator[TracerSession][source]#

List projects from the LangSmith API.

Parameters:

  • project_ids (Optional[List[ID_TYPE]], optional) – A list of project IDs to filter by, by default None

  • name (Optional[str], optional) – The name of the project to filter by, by default None

  • name_contains (Optional[str], optional) – A string to search for in the project name, by default None

  • reference_dataset_id (Optional[List[ID_TYPE]], optional) – A dataset ID to filter by, by default None

  • reference_dataset_name (Optional[str], optional) – The name of the reference dataset to filter by, by default None

  • reference_free (Optional[bool], optional) – Whether to filter for only projects not associated with a dataset.

  • limit (Optional[int], optional) – The maximum number of projects to return, by default None

  • metadata (Optional[Dict[str, Any]], optional) – Metadata to filter by.

  • Yields –

  • ------ –

  • TracerSession – The projects.

Return type:

Iterator[TracerSession]

On this page