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_clientresourcespublicrunsAsyncRunsResourcequery
Method●Since v0.10

query

Copy
query(
  self,
  share_token: str,
  *,
  selects: List[
View source on GitHub
Literal
[
'ID'
,
'NAME'
,
'RUN_TYPE'
,
'STATUS'
,
'START_TIME'
,
'END_TIME'
,
'LATENCY_SECONDS'
,
'FIRST_TOKEN_TIME'
,
'ERROR'
,
'ERROR_PREVIEW'
,
'EXTRA'
,
'METADATA'
,
'INPUTS_PREVIEW'
,
'OUTPUTS_PREVIEW'
,
'PARENT_RUN_ID'
,
'PARENT_RUN_IDS'
,
'PROJECT_ID'
,
'TRACE_ID'
,
'THREAD_ID'
,
'DOTTED_ORDER'
,
'IS_ROOT'
,
'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'
,
'THREAD_EVALUATION_TIME'
]
]
|
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
)
->
RunQueryResponse

Parameters

NameTypeDescription
selectsList[Literal['ID', 'NAME', 'RUN_TYPE', 'STATUS', 'START_TIME', 'END_TIME', 'LATENCY_SECONDS', 'FIRST_TOKEN_TIME', 'ERROR', 'ERROR_PREVIEW', 'EXTRA', 'METADATA', 'INPUTS_PREVIEW', 'OUTPUTS_PREVIEW', 'PARENT_RUN_ID', 'PARENT_RUN_IDS', 'PROJECT_ID', 'TRACE_ID', 'THREAD_ID', 'DOTTED_ORDER', 'IS_ROOT', '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', 'THREAD_EVALUATION_TIME']] | 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 all runs within the trace identified by the share token. The share token supplies the tenant, project, and trace scope.

selects lists which public run properties to include on each returned run.

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