类 Client

返回值 Client

返回值 Promise<void>

返回值 Promise<void> | Promise<[...void[], void]>

一个 promise，一旦所有当前待处理的 traces 发送完毕，promise 将会 resolve。

import { Client } from "langsmith";

const client = new Client();

try {
  // Tracing happens here
  ...
} finally {
  await client.awaitPendingTraceBatches();
}
Copy

返回值 Promise<void>

返回值 Promise<void>

返回 Promise<AnnotationQueue>

已创建的 AnnotationQueue 对象

返回 Promise<Example>

返回 Promise<string>

返回 Promise<ComparativeExperiment>

返回 Promise<Dataset>

返回 Promise<Example>

返回 Promise<Example>

返回 Promise<Example[]>

返回 Promise<Example[]>

返回 Promise<Feedback>

返回 Promise<Example>

返回 Promise<FeedbackIngestToken>

一个 Promise，它解析为 FeedbackIngestToken。

返回 Promise<TracerSession>

返回 Promise<Prompt>

返回值 Promise<void>

返回值 Promise<void>

返回值 Promise<void>

返回值 Promise<void>

返回值 Promise<void>

返回值 Promise<void>

返回值 Promise<void>

返回值 Promise<void>

返回值 Promise<DatasetDiffInfo>

返回 Promise<Feedback>

返回值 Promise<void>

返回 Promise<string>

返回值 string

返回 Promise<string>

返回值 Promise<null | Prompt>

返回值 Promise<RunWithAnnotationQueueInfo>

解析为 RunWithAnnotationQueueInfo 对象的 Promise

返回值 Promise<any>

返回 Promise<string>

返回值 Promise<{ size: number }>

返回值 Promise<boolean>

返回值 Promise<boolean>

返回值 Promise<void>

返回值 Promise<LikePromptResponse>

返回值 AsyncIterableIterator<AnnotationQueue>

AnnotationQueue 对象的迭代器

返回值 AsyncIterableIterator<PromptCommit>

返回 AsyncIterable<Dataset>

返回 Promise<string[]>

返回 AsyncIterable<Example>

返回 AsyncIterable<Feedback>

返回 AsyncIterable<FeedbackIngestToken>

FeedbackIngestToken 对象的异步可迭代对象。

返回 AsyncIterable<TracerSession>

返回 AsyncIterableIterator<Prompt>

返回 AsyncIterable<Run>

• Runs。

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

// 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",
});
Copy

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

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

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

// 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))',
});
Copy

// 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))',
});
Copy

// 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))))',
});
Copy

// 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))',
});
Copy

返回 Promise<Example[]>

共享示例。

返回 Promise<Run[]>

返回 Promise<EvaluationResult[]>

返回值 Promise<void>

返回值 Promise<boolean>

返回 Promise<PromptCommit>

返回 Promise<string>

返回 Promise<AnnotationQueue>

AnnotationQueue 对象

返回 Promise<Dataset>

返回 Promise<any[]>

返回 Promise<DatasetShareSchema>

返回 Promise<DatasetVersion>

数据集版本

返回 Promise<Example>

返回 Promise<Feedback>

返回 Promise<TracerSessionResult>

返回 Promise<Run>

返回 Promise<undefined | string>

返回 Promise<Dataset>

返回 Promise<DatasetShareSchema>

返回 Promise<string>

返回 Promise<ExampleSearch[]>

相似示例的列表。

dataset_id = "123e4567-e89b-12d3-a456-426614174000"
inputs = {"text": "How many people live in Berlin?"}
limit = 5
examples = await client.similarExamples(inputs, dataset_id, limit)
Copy

返回值 Promise<LikePromptResponse>

返回值 Promise<void>

返回值 Promise<void>

返回值 Promise<void>

返回 Promise<Dataset>

更新后的数据集

返回值 Promise<void>

返回值 Promise<void>

返回 Promise<object>

返回 Promise<object>

返回 Promise<object>

返回 Promise<UpdateExamplesResponse>

包含更新响应的 Promise

返回值 Promise<void>

返回 Promise<TracerSession>

返回 Promise<Record<string, any>>

返回值 Promise<void>

返回 Promise<Dataset>

返回 Promise<UploadExamplesResponse>

包含上传响应的 Promise

返回 {
    apiUrl: string;
    apiKey?: string;
    hideInputs?: boolean;
    hideOutputs?: boolean;
    webUrl?: string;
}