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
  • Traceable
  • Jestlike
  • Vercel
  • Anthropic
  • Sandbox
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

LangSmith
ClientRun TreesTraceableEvaluationSchemasLangchainJestVitestWrappersAnonymizerTraceableJestlikeVercelAnthropicSandbox
Language
Theme
JavaScriptlangsmithclientClient
Class●Since v0.0

Client

Copy
class Client

Used in Docs

  • Call agents from code
  • Custom instrumentation
  • Dynamic few shot example selection
  • Evaluate a RAG application
  • Evaluate agent performance
(16 more not shown)

Constructors

constructor
constructor

Properties

property
debug: boolean

Methods

method
_currentTenantIsOwner
method
_ensureServerInfo
method
_getLatestCommitHash
method
_getPromptUrl
method
_getServerInfo
method
_getSettings
method
_likeOrUnlikePrompt
method
_logEvaluationFeedback→ Promise<[EvaluationResult[], Feedback[]]>
method
_ownerConflictError
method
_selectEvalResults→ EvaluationResult[]
method
addRunsToAnnotationQueue→ Promise<void>

Add runs to an annotation queue with the specified queue ID.

method
awaitPendingTraceBatches→ Promise<void>

Awaits all pending trace batches. Useful for environments where you need to be sure that all tracing requests finish before execution ends, such as serverless environments.

method
batchIngestRuns→ Promise<void>

Batch ingest/upsert multiple runs in the Langsmith system.

method
cleanup

Cleanup resources held by the client. Stops the cache's background refresh timer.

method
clonePublicDataset→ Promise<void>

Clone a public dataset to your own langsmith tenant. This operation is idempotent. If you already have a dataset with the given name, this function will do nothing.

method
createAnnotationQueue→ Promise<AnnotationQueueWithDetails>

Create an annotation queue on the LangSmith API.

method
createChatExample→ Promise<Example>
method
createCommit→ Promise<string>
method
createComparativeExperiment→ Promise<ComparativeExperiment>
method
createDataset→ Promise<Dataset>
method
createFeedback→ Promise<Feedback>
method
createFeedbackConfig→ Promise<FeedbackConfigSchema>

Create a feedback configuration on the LangSmith API.

This upserts: if an identical config already exists, it returns it. If a conflicting config exists for the same key, a 400 error is raised.

method
createLLMExample→ Promise<Example>
method
createPresignedFeedbackToken→ Promise<FeedbackIngestToken>

Creates a presigned feedback token and URL.

The token can be used to authorize feedback metrics without needing an API key. This is useful for giving browser-based applications the ability to submit feedback without needing to expose an API key.

method
createProject→ Promise<TracerSession>
method
createPrompt→ Promise<Prompt>
method
createRun→ Promise<void>
method
deleteAnnotationQueue→ Promise<void>

Delete an annotation queue with the specified queue ID.

method
deleteDataset→ Promise<void>
method
deleteExample→ Promise<void>
method
deleteExamples→ Promise<void>

Delete multiple examples by ID.

method
deleteFeedback→ Promise<void>
method
deleteFeedbackConfig→ Promise<void>

Delete a feedback configuration on the LangSmith API.

method
deleteProject→ Promise<void>
method
deletePrompt→ Promise<void>
method
deleteRunFromAnnotationQueue→ Promise<void>

Delete a run from an an annotation queue.

method
diffDatasetVersions→ Promise<DatasetDiffInfo>
method
flush→ Promise<void>

Flushes current queued traces.

method
getDatasetUrl→ Promise<string>
method
getHostUrl→ string
method
getProjectUrl→ Promise<string>
method
getPrompt→ Promise<Prompt | null>
method
getRunFromAnnotationQueue→ Promise<RunWithAnnotationQueueInfo>

Get a run from an annotation queue at the specified index.

method
getRunStats→ Promise<any>
method
getRunUrl→ Promise<string>
method
getSizeFromAnnotationQueue→ Promise<__type>

Get the size of an annotation queue.

method
hasDataset→ Promise<boolean>
method
hasProject→ Promise<boolean>
method
indexDataset→ Promise<void>
method
likePrompt→ Promise<LikePromptResponse>
method
listAnnotationQueues→ AsyncIterableIterator<AnnotationQueue>

List the annotation queues on the LangSmith API.

method
listCommits→ AsyncIterableIterator<PromptCommit>
method
listDatasets→ AsyncIterable<Dataset>
method
listDatasetSplits→ Promise<string[]>
method
listExamples→ AsyncIterable<Example>
method
listFeedback→ AsyncIterable<Feedback>
method
listFeedbackConfigs→ AsyncIterableIterator<FeedbackConfigSchema>

List feedback configurations on the LangSmith API.

method
listGroupRuns→ AsyncIterable<Thread>
method
listPresignedFeedbackTokens→ AsyncIterable<FeedbackIngestToken>

Retrieves a list of presigned feedback tokens for a given run ID.

method
listProjects→ AsyncIterable<TracerSessionResult>
method
listPrompts→ AsyncIterableIterator<Prompt>
method
listRuns→ AsyncIterable<Run>

List runs from the LangSmith server.

method
listSharedExamples→ Promise<Example[]>

Get shared examples.

method
listSharedRuns→ Promise<Run[]>
method
logEvaluationFeedback→ Promise<EvaluationResult[]>
method
multipartIngestRuns→ Promise<void>

Batch ingest/upsert multiple runs in the Langsmith system.

method
promptExists→ Promise<boolean>
method
pullPromptCommit→ Promise<PromptCommit>
method
pushPrompt→ Promise<string>
method
readAnnotationQueue→ Promise<AnnotationQueueWithDetails>

Read an annotation queue with the specified queue ID.

method
readDataset→ Promise<Dataset>
method
readDatasetOpenaiFinetuning→ Promise<any[]>
method
readDatasetSharedSchema→ Promise<DatasetShareSchema>
method
readDatasetVersion→ Promise<DatasetVersion>

Get dataset version by closest date or exact tag.

Use this to resolve the nearest version to a given timestamp or for a given tag.

method
readExample→ Promise<Example>
method
readFeedback→ Promise<Feedback>
method
readProject→ Promise<TracerSessionResult>
method
readRun→ Promise<Run>
method
readRunSharedLink→ Promise<string | undefined>
method
readSharedDataset→ Promise<Dataset>
method
shareDataset→ Promise<DatasetShareSchema>
method
shareRun→ Promise<string>
method
similarExamples→ Promise<ExampleSearch[]>

Lets you run a similarity search query on a dataset.

Requires the dataset to be indexed. Please see the indexDataset method to set up indexing.

method
unlikePrompt→ Promise<LikePromptResponse>
method
unshareDataset→ Promise<void>
method
unshareRun→ Promise<void>
method
updateAnnotationQueue→ Promise<void>

Update an annotation queue with the specified queue ID.

method
updateDataset→ Promise<Dataset>

Update a dataset

method
updateDatasetSplits→ Promise<void>
method
updateDatasetTag→ Promise<void>

Updates a tag on a dataset.

If the tag is already assigned to a different version of this dataset, the tag will be moved to the new version. The as_of parameter is used to determine which version of the dataset to apply the new tags to.

It must be an exact version of the dataset to succeed. You can use the "readDatasetVersion" method to find the exact version to apply the tags to.

method
updateExamples→ Promise<object>
method
updateExamplesMultipart→ Promise<UpdateExamplesResponse>

Update examples with attachments using multipart form data.

method
updateFeedback→ Promise<void>
method
updateFeedbackConfig→ Promise<FeedbackConfigSchema>

Update a feedback configuration on the LangSmith API.

method
updateProject→ Promise<TracerSession>
method
updatePrompt→ Promise<Record<string, any>>
method
updateRun→ Promise<void>
method
uploadCsv→ Promise<Dataset>
method
getDefaultClientConfig→ __type
deprecatedmethod
createExample→ Promise<Example>
deprecatedmethod
createExamples→ Promise<Example[]>
deprecatedmethod
updateExample→ Promise<object>
deprecatedmethod
uploadExamplesMultipart→ Promise<UploadExamplesResponse>

Upload examples with attachments using multipart form data.

View source on GitHub