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
PythonlangsmithclientClientread_project
Method●Since v0.0

read_project

Copy
read_project(
  self,
  *,
  project_id: Optional[str] = None,
  project_name: Optional
View source on GitHub
[
str
]
=
None
,
include_stats
:
bool
=
False
)
->
ls_schemas
.
TracerSessionResult

Parameters

NameTypeDescription
project_idOptional[str]
Default:None

The ID of the project to read.

project_nameOptional[str]
Default:None

The name of the project to read. Only one of project_id or project_name may be given.

include_statsbool, default=False
Default:False

Read a project from the LangSmith API.

Whether to include a project's aggregate statistics in the response.