LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
LangSmith
  • Client
  • Run Trees
  • Traceable
  • Evaluation
  • Schemas
  • Langchain
  • Jest
  • Vitest
  • Wrappers
  • Anonymizer
  • Jestlike
  • Vercel
  • Anthropic
  • Sandbox
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

LangSmith
ClientRun TreesTraceableEvaluationSchemasLangchainJestVitestWrappersAnonymizerJestlikeVercelAnthropicSandbox
Language
Theme
JavaScriptlangsmithindexExample
Interface●Since v0.1

Example

Copy
interface Example

Bases

BaseExample

Used in Docs

  • How to define a code evaluator
  • How to evaluate agents
  • How to evaluate an application's intermediate steps
  • How to fetch performance metrics for an experiment
  • How to return categorical vs numerical metrics

Properties

property
attachments: Record<string, AttachmentInfo>

attachments maps each attachment file name to a pre-signed HTTPS download URL.

property
created_at: string

created_at is when the example was created (RFC3339 date-time).

property
dataset_id: string

dataset_id is the parent dataset UUID.

property
id: string

id is the dataset example UUID.

property
inputs: KVMap

inputs is the example input payload (arbitrary JSON object).

property
metadata: KVMap

metadata is arbitrary user-defined JSON metadata on the example.

property
modified_at: string

modified_at is when the example was last modified (RFC3339 date-time).

property
outputs: KVMap

outputs is the example reference-output payload (arbitrary JSON object).

property
runs: Run[]
property
source_run_id: string

source_run_id is the run UUID the example was created from, if any.

property
split: string | string[]

The split(s) to assign the example to.

Inherited fromBaseExample

Properties

Pdataset_id: string
—

dataset_id is the parent dataset UUID.

Pinputs: unknown
—

inputs is the example input payload (arbitrary JSON object).

Pmetadata: unknown
—

metadata is arbitrary user-defined JSON metadata on the example.

Poutputs: unknown
—

outputs is the example reference-output payload (arbitrary JSON object).

Psource_run_id: string
—

source_run_id is the run UUID the example was created from, if any.

View source on GitHub