Class: Client

Constructors

constructor

• new Client(config?): Client

Parameters

Name	Type
`config`	`ClientConfig`

Returns

Client

Defined in

client.ts:415

Methods

_selectEvalResults

▸ _selectEvalResults(results): EvaluationResult[]

Parameters

Name	Type
`results`	`EvaluationResult` \| `EvaluationResults`

Returns

EvaluationResult[]

Defined in

client.ts:2442

batchIngestRuns

▸ batchIngestRuns(runs): Promise<void>

Batch ingest/upsert multiple runs in the Langsmith system.

Parameters

Name	Type
`runs`	`Object`
`runs.runCreates?`	`RunCreate`[]
`runs.runUpdates?`	`RunUpdate`[]

Returns

Promise<void>

Defined in

client.ts:778

createChatExample

▸ createChatExample(input, generations, options): Promise<Example>

Parameters

Name	Type
`input`	`KVMap`[] \| `LangChainBaseMessage`[]
`generations`	`undefined` \| `KVMap` \| `LangChainBaseMessage`
`options`	`CreateExampleOptions`

Returns

Promise<Example>

Defined in

client.ts:2033

createDataset

▸ createDataset(name, «destructured»?): Promise<Dataset>

Parameters

Name	Type
`name`	`string`
`«destructured»`	`Object`
› `dataType?`	`DataType`
› `description?`	`string`

Returns

Promise<Dataset>

Defined in

client.ts:1715

createExample

▸ createExample(inputs, outputs, «destructured»): Promise<Example>

Parameters

Name	Type
`inputs`	`KVMap`
`outputs`	`KVMap`
`«destructured»`	`CreateExampleOptions`

Returns

Promise<Example>

Defined in

client.ts:1915

createExamples

▸ createExamples(props): Promise<Example[]>

Parameters

Name	Type
`props`	`Object`
`props.inputs`	`KVMap`[]
`props.datasetId?`	`string`
`props.datasetName?`	`string`
`props.exampleIds?`	`string`[]
`props.metadata?`	`KVMap`[]
`props.outputs?`	`KVMap`[]
`props.sourceRunIds?`	`string`[]

Returns

Promise<Example[]>

Defined in

client.ts:1964

createFeedback

▸ createFeedback(runId, key, «destructured»): Promise<Feedback>

Parameters

Name	Type	Default value
`runId`	`null` \| `string`	`undefined`
`key`	`string`	`undefined`
`«destructured»`	`Object`	`undefined`
› `comment?`	`string`	`undefined`
› `correction?`	`object`	`undefined`
› `eager?`	`boolean`	`undefined`
› `feedbackConfig?`	`FeedbackConfig`	`undefined`
› `feedbackId?`	`string`	`undefined`
› `feedbackSourceType?`	`FeedbackSourceType`	`"api"`
› `projectId?`	`string`	`undefined`
› `score?`	`ScoreType`	`undefined`
› `sourceInfo?`	`object`	`undefined`
› `sourceRunId?`	`string`	`undefined`
› `value?`	`ValueType`	`undefined`

Returns

Promise<Feedback>

Defined in

client.ts:2194

createLLMExample

▸ createLLMExample(input, generation, options): Promise<Example>

Parameters

Name	Type
`input`	`string`
`generation`	`undefined` \| `string`
`options`	`CreateExampleOptions`

Returns

Promise<Example>

Defined in

client.ts:2025

createPresignedFeedbackToken

▸ createPresignedFeedbackToken(runId, feedbackKey, options?): 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.

Parameters

Name	Type	Description
`runId`	`string`	The ID of the run.
`feedbackKey`	`string`	The feedback key.
`options`	`Object`	Additional options for the token.
`options.expiration?`	`string` \| `TimeDelta`	The expiration time for the token.
`options.feedbackConfig?`	`FeedbackConfig`	-

Returns

Promise<FeedbackIngestToken>

A promise that resolves to a FeedbackIngestToken.

Defined in

client.ts:2381

createProject

▸ createProject(«destructured»): Promise<TracerSession>

Parameters

Name	Type	Default value
`«destructured»`	`Object`	`undefined`
› `projectName`	`string`	`undefined`
› `description?`	`null` \| `string`	`null`
› `metadata?`	`null` \| `RecordStringAny`	`null`
› `projectExtra?`	`null` \| `RecordStringAny`	`null`
› `referenceDatasetId?`	`null` \| `string`	`null`
› `upsert?`	`boolean`	`false`

Returns

Promise<TracerSession>

Defined in

client.ts:1390

createRun

▸ createRun(run): Promise<void>

Parameters

Name	Type
`run`	`CreateRunParams`

Returns

Promise<void>

Defined in

client.ts:736

deleteDataset

▸ deleteDataset(«destructured»): Promise<void>

Parameters

Name	Type
`«destructured»`	`Object`
› `datasetId?`	`string`
› `datasetName?`	`string`

Returns

Promise<void>

Defined in

client.ts:1880

deleteExample

▸ deleteExample(exampleId): Promise<void>

Parameters

Name	Type
`exampleId`	`string`

Returns

Promise<void>

Defined in

client.ts:2108

deleteFeedback

▸ deleteFeedback(feedbackId): Promise<void>

Parameters

Name	Type
`feedbackId`	`string`

Returns

Promise<void>

Defined in

client.ts:2318

deleteProject

▸ deleteProject(«destructured»): Promise<void>

Parameters

Name	Type
`«destructured»`	`Object`
› `projectId?`	`string`
› `projectName?`	`string`

Returns

Promise<void>

Defined in

client.ts:1630

diffDatasetVersions

▸ diffDatasetVersions(«destructured»): Promise<DatasetDiffInfo>

Parameters

Name	Type
`«destructured»`	`Object`
› `fromVersion`	`string` \| `Date`
› `toVersion`	`string` \| `Date`
› `datasetId?`	`string`
› `datasetName?`	`string`

Returns

Promise<DatasetDiffInfo>

Defined in

client.ts:1786

evaluateRun

▸ evaluateRun(run, evaluator, «destructured»?): Promise<Feedback>

Parameters

Name	Type
`run`	`string` \| `Run`
`evaluator`	`RunEvaluator`
`«destructured»`	`Object`
› `loadChildRuns`	`boolean`
› `referenceExample?`	`Example`
› `sourceInfo?`	`KVMap`

Returns

Promise<Feedback>

Defined in

client.ts:2150

getRunUrl

▸ getRunUrl(«destructured»): Promise<string>

Parameters

Name	Type
`«destructured»`	`Object`
› `projectOpts?`	`ProjectOptions`
› `run?`	`Run`
› `runId?`	`string`

Returns

Promise<string>

Defined in

client.ts:961

hasProject

▸ hasProject(«destructured»): Promise<boolean>

Parameters

Name	Type
`«destructured»`	`Object`
› `projectId?`	`string`
› `projectName?`	`string`

Returns

Promise<boolean>

Defined in

client.ts:1478

listDatasets

▸ listDatasets(«destructured»?): AsyncIterable<Dataset>

Parameters

Name	Type	Default value
`«destructured»`	`Object`	`{}`
› `datasetIds?`	`string`[]	`undefined`
› `datasetName?`	`string`	`undefined`
› `datasetNameContains?`	`string`	`undefined`
› `limit?`	`number`	`100`
› `offset?`	`number`	`0`

Returns

AsyncIterable<Dataset>

Defined in

client.ts:1846

listExamples

▸ listExamples(«destructured»?): AsyncIterable<Example>

Parameters

Name	Type
`«destructured»`	`Object`
› `asOf?`	`string` \| `Date`
› `datasetId?`	`string`
› `datasetName?`	`string`
› `exampleIds?`	`string`[]
› `inlineS3Urls?`	`boolean`

Returns

AsyncIterable<Example>

Defined in

client.ts:2060

listFeedback

▸ listFeedback(«destructured»?): AsyncIterable<Feedback>

Parameters

Name	Type
`«destructured»`	`Object`
› `feedbackKeys?`	`string`[]
› `feedbackSourceTypes?`	`FeedbackSourceType`[]
› `runIds?`	`string`[]

Returns

AsyncIterable<Feedback>

Defined in

client.ts:2335

listPresignedFeedbackTokens

▸ listPresignedFeedbackTokens(runId): AsyncIterable<FeedbackIngestToken>

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

Parameters

Name	Type	Description
`runId`	`string`	The ID of the run.

Returns

AsyncIterable<FeedbackIngestToken>

An async iterable of FeedbackIngestToken objects.

Defined in

client.ts:2429

listProjects

▸ listProjects(«destructured»?): AsyncIterable<TracerSession>

Parameters

Name	Type
`«destructured»`	`Object`
› `name?`	`string`
› `nameContains?`	`string`
› `projectIds?`	`string`[]
› `referenceDatasetId?`	`string`
› `referenceDatasetName?`	`string`
› `referenceFree?`	`boolean`

Returns

AsyncIterable<TracerSession>

Defined in

client.ts:1584

listRuns

▸ listRuns(props): AsyncIterable<Run>

List runs from the LangSmith server.

Parameters

Name	Type
`props`	`ListRunsParams`

Returns

AsyncIterable<Run>

The runs.

Example

// List all runs in a project
const projectRuns = client.listRuns({ projectName: "<your_project>" });

Example

// List LLM and Chat runs in the last 24 hours
const todaysLLMRuns = client.listRuns({
  projectName: "<your_project>",
  start_time: new Date(Date.now() - 24 * 60 * 60 * 1000),
  run_type: "llm",
});

Example

// List traces in a project
const rootRuns = client.listRuns({
  projectName: "<your_project>",
  execution_order: 1,
});

Example

// List runs without errors
const correctRuns = client.listRuns({
  projectName: "<your_project>",
  error: false,
});

Example

// List runs by run ID
const runIds = [
  "a36092d2-4ad5-4fb4-9c0d-0dba9a2ed836",
  "9398e6be-964f-4aa4-8ae9-ad78cd4b7074",
];
const selectedRuns = client.listRuns({ run_ids: runIds });

Example

// List all "chain" type runs that took more than 10 seconds and had `total_tokens` greater than 5000
const chainRuns = client.listRuns({
  projectName: "<your_project>",
  filter: 'and(eq(run_type, "chain"), gt(latency, 10), gt(total_tokens, 5000))',
});

Example

// List all runs called "extractor" whose root of the trace was assigned feedback "user_score" score of 1
const goodExtractorRuns = client.listRuns({
  projectName: "<your_project>",
  filter: 'eq(name, "extractor")',
  traceFilter: 'and(eq(feedback_key, "user_score"), eq(feedback_score, 1))',
});

Example

// List all runs that started after a specific timestamp and either have "error" not equal to null or a "Correctness" feedback score equal to 0
const complexRuns = client.listRuns({
  projectName: "<your_project>",
  filter: 'and(gt(start_time, "2023-07-15T12:34:56Z"), or(neq(error, null), and(eq(feedback_key, "Correctness"), eq(feedback_score, 0.0))))',
});

Example

// List all runs where `tags` include "experimental" or "beta" and `latency` is greater than 2 seconds
const taggedRuns = client.listRuns({
  projectName: "<your_project>",
  filter: 'and(or(has(tags, "experimental"), has(tags, "beta")), gt(latency, 2))',
});

Defined in

client.ts:1113

listSharedRuns

▸ listSharedRuns(shareToken, «destructured»?): Promise<Run[]>

Parameters

Name	Type
`shareToken`	`string`
`«destructured»`	`Object`
› `runIds?`	`string`[]

Returns

Promise<Run[]>

Defined in

client.ts:1266

logEvaluationFeedback

▸ logEvaluationFeedback(evaluatorResponse, run?, sourceInfo?): Promise<EvaluationResult[]>

Parameters

Name	Type
`evaluatorResponse`	`EvaluationResult` \| `EvaluationResults`
`run?`	`Run`
`sourceInfo?`	`Object`

Returns

Promise<EvaluationResult[]>

Defined in

client.ts:2454

readDataset

▸ readDataset(«destructured»): Promise<Dataset>

Parameters

Name	Type
`«destructured»`	`Object`
› `datasetId?`	`string`
› `datasetName?`	`string`

Returns

Promise<Dataset>

Defined in

client.ts:1751

readDatasetOpenaiFinetuning

▸ readDatasetOpenaiFinetuning(«destructured»): Promise<any[]>

Parameters

Name	Type
`«destructured»`	`Object`
› `datasetId?`	`string`
› `datasetName?`	`string`

Returns

Promise<any[]>

Defined in

client.ts:1821

readDatasetSharedSchema

▸ readDatasetSharedSchema(datasetId?, datasetName?): Promise<DatasetShareSchema>

Parameters

Name	Type
`datasetId?`	`string`
`datasetName?`	`string`

Returns

Promise<DatasetShareSchema>

Defined in

client.ts:1297

readExample

▸ readExample(exampleId): Promise<Example>

Parameters

Name	Type
`exampleId`	`string`

Returns

Promise<Example>

Defined in

client.ts:2054

readFeedback

▸ readFeedback(feedbackId): Promise<Feedback>

Parameters

Name	Type
`feedbackId`	`string`

Returns

Promise<Feedback>

Defined in

client.ts:2311

readProject

▸ readProject(«destructured»): Promise<TracerSessionResult>

Parameters

Name	Type
`«destructured»`	`Object`
› `includeStats?`	`boolean`
› `projectId?`	`string`
› `projectName?`	`string`

Returns

Promise<TracerSessionResult>

Defined in

client.ts:1526

readRun

▸ readRun(runId, «destructured»?): Promise<Run>

Parameters

Name	Type
`runId`	`string`
`«destructured»`	`Object`
› `loadChildRuns`	`boolean`

Returns

Promise<Run>

Defined in

client.ts:949

readRunSharedLink

▸ readRunSharedLink(runId): Promise<undefined | string>

Parameters

Name	Type
`runId`	`string`

Returns

Promise<undefined | string>

Defined in

client.ts:1247

readSharedDataset

▸ readSharedDataset(shareToken): Promise<Dataset>

Parameters

Name	Type
`shareToken`	`string`

Returns

Promise<Dataset>

Defined in

client.ts:1374

shareDataset

▸ shareDataset(datasetId?, datasetName?): Promise<DatasetShareSchema>

Parameters

Name	Type
`datasetId?`	`string`
`datasetName?`	`string`

Returns

Promise<DatasetShareSchema>

Defined in

client.ts:1326

shareRun

▸ shareRun(runId, «destructured»?): Promise<string>

Parameters

Name	Type
`runId`	`string`
`«destructured»`	`Object`
› `shareId?`	`string`

Returns

Promise<string>

Defined in

client.ts:1205

unshareDataset

▸ unshareDataset(datasetId): Promise<void>

Parameters

Name	Type
`datasetId`	`string`

Returns

Promise<void>

Defined in

client.ts:1359

unshareRun

▸ unshareRun(runId): Promise<void>

Parameters

Name	Type
`runId`	`string`

Returns

Promise<void>

Defined in

client.ts:1232

updateExample

▸ updateExample(exampleId, update): Promise<object>

Parameters

Name	Type
`exampleId`	`string`
`update`	`ExampleUpdate`

Returns

Promise<object>

Defined in

client.ts:2125

updateFeedback

▸ updateFeedback(feedbackId, «destructured»): Promise<void>

Parameters

Name	Type
`feedbackId`	`string`
`«destructured»`	`Object`
› `comment?`	`null` \| `string`
› `correction?`	`null` \| `object`
› `score?`	`null` \| `number` \| `boolean`
› `value?`	`null` \| `string` \| `number` \| `boolean` \| `object`

Returns

Promise<void>

Defined in

client.ts:2269

updateProject

▸ updateProject(projectId, «destructured»): Promise<TracerSession>

Parameters

Name	Type	Default value
`projectId`	`string`	`undefined`
`«destructured»`	`Object`	`undefined`
› `description?`	`null` \| `string`	`null`
› `endTime?`	`null` \| `string`	`null`
› `metadata?`	`null` \| `RecordStringAny`	`null`
› `name?`	`null` \| `string`	`null`
› `projectExtra?`	`null` \| `RecordStringAny`	`null`

Returns

Promise<TracerSession>

Defined in

client.ts:1435

updateRun

▸ updateRun(runId, run): Promise<void>

Parameters

Name	Type
`runId`	`string`
`run`	`RunUpdate`

Returns

Promise<void>

Defined in

client.ts:903

uploadCsv

▸ uploadCsv(«destructured»): Promise<Dataset>

Parameters

Name	Type
`«destructured»`	`UploadCSVParams`

Returns

Promise<Dataset>

Defined in

client.ts:1664

getDefaultClientConfig

▸ getDefaultClientConfig(): Object

Returns

Object

Name	Type
`apiUrl`	`string`
`apiKey?`	`string`
`hideInputs?`	`boolean`
`hideOutputs?`	`boolean`
`webUrl?`	`string`

Defined in

client.ts:436

_getServerInfo

▸ _getServerInfo(): Promise<any>

Returns

Promise<any>

Defined in

client.ts:711

batchEndpointIsSupported

▸ batchEndpointIsSupported(): Promise<boolean>

Returns

Promise<boolean>

Defined in

client.ts:727

Constructors​

constructor​

Parameters​

Returns​

Defined in​

Methods​

_selectEvalResults​

Parameters​

Returns​

Defined in​

batchIngestRuns​

Parameters​

Returns​

Defined in​

createChatExample​

Parameters​

Returns​

Defined in​

createDataset​

Parameters​

Returns​

Defined in​

createExample​

Parameters​

Returns​

Defined in​

createExamples​

Parameters​

Returns​

Defined in​

createFeedback​

Parameters​

Returns​

Defined in​

createLLMExample​

Parameters​

Returns​

Defined in​

createPresignedFeedbackToken​

Parameters​

Returns​

Defined in​

createProject​

Parameters​

Returns​

Defined in​

createRun​

Parameters​

Returns​

Defined in​

deleteDataset​

Parameters​

Returns​

Defined in​

deleteExample​

Parameters​

Returns​

Defined in​

deleteFeedback​

Parameters​

Returns​

Defined in​

deleteProject​

Parameters​

Returns​

Defined in​

diffDatasetVersions​

Parameters​

Returns​

Defined in​

evaluateRun​

Parameters​

Returns​

Defined in​

getRunUrl​

Parameters​

Returns​

Defined in​

hasProject​

Parameters​

Constructors

constructor

Parameters

Returns

Defined in

Methods

_selectEvalResults

Parameters

Returns

Defined in

batchIngestRuns

Parameters

Returns

Defined in

createChatExample

Parameters

Returns

Defined in

createDataset

Parameters

Returns

Defined in

createExample

Parameters

Returns

Defined in

createExamples

Parameters

Returns

Defined in

createFeedback

Parameters

Returns

Defined in

createLLMExample

Parameters

Returns

Defined in

createPresignedFeedbackToken

Parameters

Returns

Defined in

createProject

Parameters

Returns

Defined in

createRun

Parameters

Returns

Defined in

deleteDataset

Parameters

Returns

Defined in

deleteExample

Parameters

Returns

Defined in

deleteFeedback

Parameters

Returns

Defined in

deleteProject

Parameters

Returns

Defined in

diffDatasetVersions

Parameters

Returns

Defined in

evaluateRun

Parameters

Returns

Defined in

getRunUrl

Parameters

Returns

Defined in

hasProject

Parameters