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

Chat LangChain

What can I help with?

Enter to sendยทShift+Enter new line

Menu

OverviewClientAsyncClientRun HelpersRun TreesEvaluationSchemasUtilitiesWrappersAnonymizerTestingExpect APIMiddlewarePytest PluginDeployment SDK
Language
Theme
Pythonlangsmithasync_clientAsyncClientlist_examples
Methodโ—Since v0.14

list_examples

Copy
list_examples(
  self,
  *,
  dataset_id: Optional[ls_client.ID_TYPE] = None,
  dataset_name:
View source on GitHub
Optional
[
str
]
=
None
,
select
:
Optional
[
Sequence
[
str
]
]
=
None
,
exclude_default_fields
:
bool
=
False
,
kwargs
:
Any
=
{
}
)
->
AsyncIterator
[
ls_schemas
.
Example
]

Parameters

NameTypeDescription
dataset_idOptional[ls_client.ID_TYPE]
Default:None

The ID of the dataset to filter by.

dataset_nameOptional[str]
Default:None

The name of the dataset to filter by.

selectOptional[Sequence[str]]
Default:None
exclude_default_fieldsbool
Default:False
**kwargsAny
Default:{}

List examples.

Fields to include in each example, such as "id" or "outputs".

Return only the fields in select, plus id. Other default fields (created_at, modified_at, inputs, name, dataset_id) are absent unless selected. Select dataset_id if you need Example.url.

Additional query parameters.