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

create

Copy
create(
  self,
  dataset_id: str,
  *,
  comparative_experiment_id:
View source on GitHub
str
|
Omit
=
omit
,
cursor
:
str
|
Omit
=
omit
,
example_ids
:
SequenceNotStr
[
str
]
|
Omit
=
omit
,
experiment_ids
:
SequenceNotStr
[
str
]
|
Omit
=
omit
,
filters
:
Dict
[
str
,
SequenceNotStr
[
str
]
]
|
Omit
=
omit
,
page_size
:
int
|
Omit
=
omit
,
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
,
sort
:
experiment_run_create_params
.
Sort
|
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
)
->
SyncItemsCursorPostPagination
[
ExperimentRunCreateResponse
]

Parameters

NameTypeDescription
comparative_experiment_idstr | Omit
Default:omit

comparative_experiment_id scopes pairwise-annotation feedback (optional).

cursorstr | Omit
Default:omit

cursor is the opaque string from a previous response's next_cursor. Absent for the first page.

example_idsSequenceNotStr[str] | Omit
Default:omit
experiment_idsSequenceNotStr[str] | Omit
Default:omit
filtersDict[str, SequenceNotStr[str]] | Omit
Default:omit
page_sizeint | Omit
Default:omit
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'
sortexperiment_run_create_params.Sort | 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

Returns a paginated page of dataset examples with runs from the requested experiments. Response uses the canonical {items, next_cursor} envelope.

,
'PRICE_MODEL_ID'
,
'TAGS'
,
'APP_PATH'
,
'ATTACHMENTS'
,
'THREAD_EVALUATION_TIME'
,
'IS_IN_DATASET'
,
'SHARE_URL'
,
'FEEDBACK_STATS'
]] |
Omit
Default:omit

example_ids optionally restricts the page to these dataset example UUIDs (max 1000).

experiment_ids lists the experiment (tracing session) UUIDs to query. Required, non-empty.

filters maps a project (session) UUID string to a list of filter expressions (optional).

page_size is the maximum number of examples to return. Defaults to 20, max 100.

sort controls feedback-score sorting (single project only).

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

selects lists which run properties to include. Omitted => only id. Tokens mirror /v2/runs/query.