langsmith.client.Client.read_project#

Client.read_project(*, project_id: str | None = None, project_name: str | None = None, include_stats: bool = False) TracerSessionResult[source]#

Read a project from the LangSmith API.

Parameters:
  • project_id (str or None, default=None) – The ID of the project to read.

  • project_name (str or None, default=None) –

    The name of the project to read.

    Note: Only one of project_id or project_name may be given.

  • include_stats (bool, default=False) – Whether to include a project’s aggregate statistics in the response.

  • Returns

  • -------

  • TracerSessionResult – The project.

Return type:

TracerSessionResult