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
Pythonlangsmith_openapi_clientresourcesrunsRunsResourceretrieve_v2
Method●Since v0.9

retrieve_v2

Copy
retrieve_v2(
  self,
  run_id: str,
  *,
  project_id: str
View source on GitHub
,
start_time
:
Union
[
str
,
datetime
]
,
selects
:
List
[
Literal
[
'ID'
,
'NAME'
,
'RUN_TYPE'
,
'STATUS'
,
'START_TIME'
,
'END_TIME'
,
'LATENCY_SECONDS'
,
'FIRST_TOKEN_TIME'
,
'ERROR'
,
'ERROR_PREVIEW'
,
'EXTRA'
,
'METADATA'
,
'EVENTS'
,
'INPUTS'
,
'INPUTS_PREVIEW'
,
'OUTPUTS'
,
'OUTPUTS_PREVIEW'
,
'MANIFEST'
,
'PARENT_RUN_IDS'
,
'PROJECT_ID'
,
'TRACE_ID'
,
'THREAD_ID'
,
'DOTTED_ORDER'
,
'IS_ROOT'
,
'REFERENCE_EXAMPLE_ID'
,
'REFERENCE_DATASET_ID'
,
'TOTAL_TOKENS'
,
'PROMPT_TOKENS'
,
'COMPLETION_TOKENS'
,
'TOTAL_COST'
,
'PROMPT_COST'
,
'COMPLETION_COST'
,
'PROMPT_TOKEN_DETAILS'
,
'COMPLETION_TOKEN_DETAILS'
,
'PROMPT_COST_DETAILS'
,
'COMPLETION_COST_DETAILS'
,
'PRICE_MODEL_ID'
,
'TAGS'
,
'APP_PATH'
,
'ATTACHMENTS'
,
'THREAD_EVALUATION_TIME'
,
'IS_IN_DATASET'
,
'SHARE_URL'
,
'FEEDBACK_STATS'
]
]
|
Omit
=
omit
,
accept
:
str
|
Omit
=
omit
,
extra_headers
:
Headers
|
None
=
None
,
extra_query
:
Query
|
None
=
None
,
extra_body
:
Body
|
None
=
None
,
timeout
:
float
|
httpx
.
Timeout
|
None
|
NotGiven
=
not_given
)
->
QueryRunResponse

Parameters

NameTypeDescription
project_id*str

project_id is the UUID of the tracing project that owns the run.

start_time*Union[str, datetime]

start_time is the run's start_time (RFC3339 date-time), used together with project_id to locate the run.

selectsList[Literal['ID', 'NAME', 'RUN_TYPE', 'STATUS', 'START_TIME', 'END_TIME', 'LATENCY_SECONDS', 'FIRST_TOKEN_TIME', 'ERROR', 'ERROR_PREVIEW', 'EXTRA', 'METADATA', 'EVENTS', 'INPUTS', 'INPUTS_PREVIEW', 'OUTPUTS', 'OUTPUTS_PREVIEW', 'MANIFEST', 'PARENT_RUN_IDS', 'PROJECT_ID', 'TRACE_ID', 'THREAD_ID', 'DOTTED_ORDER', 'IS_ROOT', 'REFERENCE_EXAMPLE_ID', 'REFERENCE_DATASET_ID', 'TOTAL_TOKENS', 'PROMPT_TOKENS', 'COMPLETION_TOKENS', 'TOTAL_COST', 'PROMPT_COST', 'COMPLETION_COST', 'PROMPT_TOKEN_DETAILS', 'COMPLETION_TOKEN_DETAILS', 'PROMPT_COST_DETAILS', 'COMPLETION_COST_DETAILS', 'PRICE_MODEL_ID', 'TAGS', 'APP_PATH', 'ATTACHMENTS', 'THREAD_EVALUATION_TIME', 'IS_IN_DATASET', 'SHARE_URL', 'FEEDBACK_STATS']] | Omit
Default:omit
extra_headersHeaders | None
Default:None
extra_queryQuery | None
Default:None
extra_bodyBody | None
Default:None
timeoutfloat | httpx.Timeout | None | NotGiven
Default:not_given

Alpha: The request and response contract may change; Returns one run by ID for the given session and start_time. Use the selects query parameter (repeatable) to select fields to return.

selects lists which properties to include on the returned run (repeatable query parameter). Accepts any value of the RunSelectField enum. If omitted, only id is returned.

Send extra headers

Add additional query parameters to the request

Add additional JSON properties to the request

Override the client-level default timeout for this request, in seconds