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

runs

Copy
runs(
  self,
  dataset_id: str,
  *,
  group_by: Literal['run_metadata', 'example_metadata'
View source on GitHub
]
,
metadata_key
:
str
,
session_ids
:
SequenceNotStr
[
str
]
,
filters
:
Optional
[
Dict
[
str
,
SequenceNotStr
[
str
]
]
]
|
Omit
=
omit
,
limit
:
int
|
Omit
=
omit
,
offset
:
int
|
Omit
=
omit
,
per_group_limit
:
int
|
Omit
=
omit
,
preview
:
bool
|
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
)
->
GroupRunsResponse

Parameters

NameTypeDescription
extra_headersHeaders | None
Default:None

Send extra headers

extra_queryQuery | None
Default:None

Add additional query parameters to the request

extra_bodyBody | None
Default:None
timeoutfloat | httpx.Timeout | None | NotGiven
Default:not_given

Fetch examples for a dataset, and fetch the runs for each example if they are associated with the given session_ids.

Add additional JSON properties to the request

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