Client 类

实现

LangSmithTracingClientInterface

索引

构造函数

属性

方法

addRunsToAnnotationQueue awaitPendingTraceBatches batchIngestRuns clonePublicDataset createAnnotationQueue createChatExample createCommit createComparativeExperiment createDataset createExample createExamples createFeedback createLLMExample createPresignedFeedbackToken createProject createPrompt createRun deleteAnnotationQueue deleteDataset deleteExample deleteFeedback deleteProject deletePrompt deleteRunFromAnnotationQueue diffDatasetVersions evaluateRun flush getDatasetUrl getHostUrl getProjectUrl getPrompt getRunFromAnnotationQueue getRunStats getRunUrl getSizeFromAnnotationQueue hasDataset hasProject indexDataset likePrompt listAnnotationQueues listCommits listDatasets listDatasetSplits listExamples listFeedback listGroupRuns listPresignedFeedbackTokens listProjects listPrompts listRuns listSharedExamples listSharedRuns logEvaluationFeedback multipartIngestRuns promptExists pullPromptCommit pushPrompt readAnnotationQueue readDataset readDatasetOpenaiFinetuning readDatasetSharedSchema readDatasetVersion readExample readFeedback readProject readRun readRunSharedLink readSharedDataset shareDataset shareRun similarExamples unlikePrompt unshareDataset unshareRun updateAnnotationQueue updateDataset updateDatasetSplits updateDatasetTag updateExample updateExamples updateExamplesMultipart updateFeedback updateProject updatePrompt updateRun uploadCsv uploadExamplesMultipart getDefaultClientConfig

构造函数

new Client(config?: ClientConfig): Client
参数
- config: ClientConfig = {}
返回 Client
- 定义于 src/client.ts:613

属性

debug

debug: boolean = ...

方法

addRunsToAnnotationQueue

addRunsToAnnotationQueue(queueId: string, runIds: string[]): Promise<void>
将运行添加到具有指定队列 ID 的注释队列。
参数
- queueId: string
  注释队列的 ID
- runIds: string[]
  要添加到注释队列的运行 ID
返回 Promise<void>
- 定义于 src/client.ts:4165

awaitPendingTraceBatches

awaitPendingTraceBatches(): Promise<void> | Promise<[...void[], void]>
等待所有挂起的跟踪批次。在需要确保所有跟踪请求在执行结束前完成的环境中（例如无服务器环境）非常有用。

返回 Promise<void> | Promise<[...void[], void]>
一个 Promise，当所有当前挂起的跟踪都已发送时解析。
示例
```
import { Client } from "langsmith";

const client = new Client();

try {
  // Tracing happens here
  ...
} finally {
  await client.awaitPendingTraceBatches();
}
```
- 定义于 src/client.ts:5058

batchIngestRuns

batchIngestRuns(
runs: { runCreates?: RunCreate[]; runUpdates?: RunUpdate[] },
): Promise<void>
在 Langsmith 系统中批量摄取/插入多个运行。
参数
- runs: { runCreates?: RunCreate[]; runUpdates?: RunUpdate[] }
返回 Promise<void>
- 定义于 src/client.ts:1113

clonePublicDataset

clonePublicDataset(
tokenOrUrl: string,
options?: { datasetName?: string; sourceApiUrl?: string },
): Promise<void>
将公共数据集克隆到您自己的 Langsmith 租户。此操作是幂等的。如果您已经有同名数据集，此函数将不执行任何操作。
参数
- tokenOrUrl: string
  要克隆的公共数据集的令牌。
- 可选options: { datasetName?: string; sourceApiUrl?: string } = {}
  克隆数据集的其他选项。
  - 可选datasetName?: string
    要在您的租户中创建的数据集名称。默认为公共数据集的名称。
  - 可选sourceApiUrl?: string
    托管数据的 Langsmith 服务器的 URL。默认为您当前客户端的 API URL。
返回 Promise<void>
- 定义于 src/client.ts:4947

createAnnotationQueue

createAnnotationQueue(
    options: {
        name: string;
        description?: string;
        queueId?: string;
        rubricInstructions?: string;
    },
): Promise<AnnotationQueueWithDetails>
在 LangSmith API 上创建一个注释队列。
参数
- options: {
      name: string;
      description?: string;
      queueId?: string;
      rubricInstructions?: string;
  }
  创建注释队列的选项
  - name: string
    注释队列的名称
  - 可选description?: string
    注释队列的描述
  - 可选queueId?: string
    注释队列的 ID
  - 可选rubricInstructions?: string
返回 Promise<AnnotationQueueWithDetails>
创建的 AnnotationQueue 对象
- 定义于 src/client.ts:4051

createChatExample

createChatExample(
    input: KVMap[] | LangChainBaseMessage[],
    generations: undefined | KVMap | LangChainBaseMessage,
    options: CreateExampleOptions,
): Promise<Example>
参数
- input: KVMap[] | LangChainBaseMessage[]
- generations: undefined | KVMap | LangChainBaseMessage
- options: CreateExampleOptions
返回 Promise<Example>
- 定义于 src/client.ts:3192

createCommit

createCommit(
    promptIdentifier: string,
    object: any,
    options?: { parentCommitHash?: string },
): Promise<string>
参数
- promptIdentifier: string
- object: any
- 可选options: { parentCommitHash?: string }
返回 Promise<string>
- 定义于 src/client.ts:4494

createComparativeExperiment

createComparativeExperiment(
    __namedParameters: {
        experimentIds: string[];
        name: string;
        createdAt?: Date;
        description?: string;
        id?: string;
        metadata?: Record<string, unknown>;
        referenceDatasetId?: string;
    },
): Promise<ComparativeExperiment>
参数
- __namedParameters: {
      experimentIds: string[];
      name: string;
      createdAt?: Date;
      description?: string;
      id?: string;
      metadata?: Record<string, unknown>;
      referenceDatasetId?: string;
  }
返回 Promise<ComparativeExperiment>
- 定义于 src/client.ts:3847

createDataset

createDataset(
    name: string,
    __namedParameters?: {
        dataType?: DataType;
        description?: string;
        inputsSchema?: KVMap;
        metadata?: RecordStringAny;
        outputsSchema?: KVMap;
    },
): Promise<Dataset>
参数
- name: string
- __namedParameters: {
      dataType?: DataType;
      description?: string;
      inputsSchema?: KVMap;
      metadata?: RecordStringAny;
      outputsSchema?: KVMap;
  } = {}
返回 Promise<Dataset>
- 定义于 src/client.ts:2582

createExample

createExample(update: ExampleCreate): Promise<Example>
参数
- update: ExampleCreate
返回 Promise<Example>
- 定义于 src/client.ts:3006
createExample(
    inputs: KVMap,
    outputs: KVMap,
    options: CreateExampleOptions,
): Promise<Example>
参数
- inputs: KVMap
- outputs: KVMap
- options: CreateExampleOptions
返回 Promise<Example>
已弃用
此签名已弃用，请改用 createExample(update: ExampleCreate)
- 定义于 src/client.ts:3011

createExamples

createExamples(uploads: ExampleCreate[]): Promise<Example[]>
参数
- uploads: ExampleCreate[]
返回 Promise<Example[]>
- 定义于 src/client.ts:3070
createExamples(
    props: {
        attachments?: Attachments[];
        datasetId?: string;
        datasetName?: string;
        exampleIds?: string[];
        inputs?: KVMap[];
        metadata?: KVMap[];
        outputs?: KVMap[];
        sourceRunIds?: string[];
        splits?: (string | string[])[];
        useSourceRunAttachments?: string[][];
        useSourceRunIOs?: boolean[];
    },
): Promise<Example[]>
参数
- props: {
      attachments?: Attachments[];
      datasetId?: string;
      datasetName?: string;
      exampleIds?: string[];
      inputs?: KVMap[];
      metadata?: KVMap[];
      outputs?: KVMap[];
      sourceRunIds?: string[];
      splits?: (string | string[])[];
      useSourceRunAttachments?: string[][];
      useSourceRunIOs?: boolean[];
  }
返回 Promise<Example[]>
已弃用
请改用仅上传的重载
- 定义于 src/client.ts:3072

createFeedback

createFeedback(
    runId: null | string,
    key: string,
    __namedParameters: {
        comment?: string;
        comparativeExperimentId?: string;
        correction?: object;
        eager?: boolean;
        feedbackConfig?: FeedbackConfig;
        feedbackId?: string;
        feedbackSourceType?: FeedbackSourceType;
        projectId?: string;
        score?: ScoreType;
        sourceInfo?: object;
        sourceRunId?: string;
        value?: ValueType;
    },
): Promise<Feedback>
参数
- runId: null | string
- key: string
- __namedParameters: {
      comment?: string;
      comparativeExperimentId?: string;
      correction?: object;
      eager?: boolean;
      feedbackConfig?: FeedbackConfig;
      feedbackId?: string;
      feedbackSourceType?: FeedbackSourceType;
      projectId?: string;
      score?: ScoreType;
      sourceInfo?: object;
      sourceRunId?: string;
      value?: ValueType;
  }
返回 Promise<Feedback>
- 定义于 src/client.ts:3610

createLLMExample

createLLMExample(
    input: string,
    generation: undefined | string,
    options: CreateExampleOptions,
): Promise<Example>
参数
- input: string
- generation: undefined | string
- options: CreateExampleOptions
返回 Promise<Example>
- 定义于 src/client.ts:3184

createPresignedFeedbackToken

createPresignedFeedbackToken(
    runId: string,
    feedbackKey: string,
    options?: {
        expiration?: string | TimeDelta;
        feedbackConfig?: FeedbackConfig;
    },
): Promise<FeedbackIngestToken>
创建预签名反馈令牌和 URL。

该令牌可用于授权反馈指标，而无需 API 密钥。这对于使基于浏览器的应用程序能够提交反馈而无需暴露 API 密钥非常有用。
参数
- runId: string
  运行的 ID。
- feedbackKey: string
  反馈密钥。
- options: { expiration?: string | TimeDelta; feedbackConfig?: FeedbackConfig } = {}
  令牌的其他选项。
  - 可选expiration?: string | TimeDelta
    令牌的过期时间。
  - 可选feedbackConfig?: FeedbackConfig
返回 Promise<FeedbackIngestToken>
解析为 FeedbackIngestToken 的 Promise。
- 定义于 src/client.ts:3804

createProject

createProject(__namedParameters: CreateProjectParams): Promise<TracerSession>
参数
- __namedParameters: CreateProjectParams
返回 Promise<TracerSession>
- 定义于 src/client.ts:2233

createPrompt

createPrompt(
    promptIdentifier: string,
    options?: {
        description?: string;
        isPublic?: boolean;
        readme?: string;
        tags?: string[];
    },
): Promise<Prompt>
参数
- promptIdentifier: string
- 可选options: { description?: string; isPublic?: boolean; readme?: string; tags?: string[] }
返回 Promise<Prompt>
- 定义于 src/client.ts:4444

createRun

createRun(run: CreateRunParams): Promise<void>
参数
- run: CreateRunParams
返回 Promise<void>
实现 LangSmithTracingClientInterface.createRun
- 定义于 src/client.ts:1066

deleteAnnotationQueue

deleteAnnotationQueue(queueId: string): Promise<void>
删除具有指定队列 ID 的注释队列。
参数
- queueId: string
  要删除的注释队列的 ID
返回 Promise<void>
- 定义于 src/client.ts:4146

deleteDataset

deleteDataset(
__namedParameters: { datasetId?: string; datasetName?: string },
): Promise<void>
参数
- __namedParameters: { datasetId?: string; datasetName?: string }
返回 Promise<void>
- 定义于 src/client.ts:2866

deleteExample

deleteExample(exampleId: string): Promise<void>
参数
- exampleId: string
返回 Promise<void>
- 定义于 src/client.ts:3338

deleteFeedback

deleteFeedback(feedbackId: string): Promise<void>
参数
- feedbackId: string
返回 Promise<void>
- 定义于 src/client.ts:3741

deleteProject

deleteProject(
__namedParameters: { projectId?: string; projectName?: string },
): Promise<void>
参数
- __namedParameters: { projectId?: string; projectName?: string }
返回 Promise<void>
- 定义于 src/client.ts:2501

deletePrompt

deletePrompt(promptIdentifier: string): Promise<void>
参数
- promptIdentifier: string
返回 Promise<void>
- 定义于 src/client.ts:4818

deleteRunFromAnnotationQueue

deleteRunFromAnnotationQueue(queueId: string, queueRunId: string): Promise<void>
从注释队列中删除运行。
参数
- queueId: string
  要删除运行的注释队列的 ID
- queueRunId: string
  要从注释队列中删除的运行 ID
返回 Promise<void>
- 定义于 src/client.ts:4217

diffDatasetVersions

diffDatasetVersions(
    __namedParameters: {
        fromVersion: string | Date;
        toVersion: string | Date;
        datasetId?: string;
        datasetName?: string;
    },
): Promise<DatasetDiffInfo>
参数
- __namedParameters: {
      fromVersion: string | Date;
      toVersion: string | Date;
      datasetId?: string;
      datasetName?: string;
  }
返回 Promise<DatasetDiffInfo>
- 定义于 src/client.ts:2685

evaluateRun

evaluateRun(
    run: string | Run,
    evaluator: RunEvaluator,
    __namedParameters?: {
        loadChildRuns: boolean;
        referenceExample?: Example;
        sourceInfo?: KVMap;
    },
): Promise<Feedback>
参数
- run: string | Run
- evaluator: RunEvaluator
- __namedParameters: { loadChildRuns: boolean; referenceExample?: Example; sourceInfo?: KVMap } = ...
返回 Promise<Feedback>
已弃用
此方法已弃用，并将在未来的 LangSmith 版本中删除，请改用 langsmith/evaluation 中的 evaluate。
- 定义于 src/client.ts:3569

flush

flush(): Promise<void>
刷新当前排队的跟踪。

返回 Promise<void>
- 定义于 src/client.ts:1061

getDatasetUrl

getDatasetUrl(
__namedParameters: { datasetId?: string; datasetName?: string },
): Promise<string>
参数
- __namedParameters: { datasetId?: string; datasetName?: string }
返回 Promise<string>
- 定义于 src/client.ts:2420

getHostUrl

getHostUrl(): string
返回 string
- 定义于 src/client.ts:682

getProjectUrl

getProjectUrl(
__namedParameters: { projectId?: string; projectName?: string },
): Promise<string>
参数
- __namedParameters: { projectId?: string; projectName?: string }
返回 Promise<string>
- 定义于 src/client.ts:2405

getPrompt

getPrompt(promptIdentifier: string): Promise<null | Prompt>
参数
- promptIdentifier: string
返回 Promise<null | Prompt>
- 定义于 src/client.ts:4418

getRunFromAnnotationQueue

getRunFromAnnotationQueue(
queueId: string,
index: number,
): Promise<RunWithAnnotationQueueInfo>
从指定索引的标注队列中获取一个运行（run）。
参数
- queueId: string
  注释队列的 ID
- index: number
  要检索的运行（run）的索引
返回 Promise<RunWithAnnotationQueueInfo>
解析为 `RunWithAnnotationQueueInfo` 对象的 Promise

抛出
如果在给定索引处未找到运行（run）或因其他 API 相关错误
- 定义于 src/client.ts:4192

getRunStats

getRunStats(
    __namedParameters: {
        dataSourceType?: string;
        endTime?: string;
        error?: boolean;
        filter?: string;
        id?: string[];
        isRoot?: boolean;
        parentRun?: string;
        projectIds?: string[];
        projectNames?: string[];
        query?: string;
        referenceExampleIds?: string[];
        runType?: string;
        startTime?: string;
        trace?: string;
        traceFilter?: string;
        treeFilter?: string;
    },
): Promise<any>
参数
- __namedParameters: {
      dataSourceType?: string;
      endTime?: string;
      error?: boolean;
      filter?: string;
      id?: string[];
      isRoot?: boolean;
      parentRun?: string;
      projectIds?: string[];
      projectNames?: string[];
      query?: string;
      referenceExampleIds?: string[];
      runType?: string;
      startTime?: string;
      trace?: string;
      traceFilter?: string;
      treeFilter?: string;
  }
返回 Promise<any>
- 定义于 src/client.ts:1901

getRunUrl

getRunUrl(
    __namedParameters: {
        projectOpts?: ProjectOptions;
        run?: Run;
        runId?: string;
    },
): Promise<string>
参数
- __namedParameters: { projectOpts?: ProjectOptions; run?: Run; runId?: string }
返回 Promise<string>
- 定义于 src/client.ts:1563

getSizeFromAnnotationQueue

getSizeFromAnnotationQueue(queueId: string): Promise<{ size: number }>
获取标注队列的大小。
参数
- queueId: string
  注释队列的 ID
返回 Promise<{ size: number }>
- 定义于 src/client.ts:4241

hasDataset

hasDataset(
__namedParameters: { datasetId?: string; datasetName?: string },
): Promise<boolean>
参数
- __namedParameters: { datasetId?: string; datasetName?: string }
返回 Promise<boolean>
- 定义于 src/client.ts:2663

hasProject

hasProject(
__namedParameters: { projectId?: string; projectName?: string },
): Promise<boolean>
参数
- __namedParameters: { projectId?: string; projectName?: string }
返回 Promise<boolean>
- 定义于 src/client.ts:2314

indexDataset

indexDataset(
    __namedParameters: {
        datasetId?: string;
        datasetName?: string;
        tag?: string;
    },
): Promise<void>
参数
- __namedParameters: { datasetId?: string; datasetName?: string; tag?: string }
返回 Promise<void>
- 定义于 src/client.ts:2902

likePrompt

likePrompt(promptIdentifier: string): Promise<LikePromptResponse>
参数
- promptIdentifier: string
返回 Promise<LikePromptResponse>
- 定义于 src/client.ts:4363

listAnnotationQueues

listAnnotationQueues(
    options?: {
        limit?: number;
        name?: string;
        nameContains?: string;
        queueIds?: string[];
    },
): AsyncIterableIterator<AnnotationQueue>
列出 LangSmith API 上的标注队列。
参数
- options: { limit?: number; name?: string; nameContains?: string; queueIds?: string[] } = {}
  列出标注队列的选项
  - 可选limit?: number
    要返回的最大队列数
  - 可选name?: string
    用于过滤队列的名称
  - 可选nameContains?: string
    队列名称应包含的子字符串
  - 可选queueIds?: string[]
    用于过滤队列的 ID
返回 AsyncIterableIterator<AnnotationQueue>
AnnotationQueue 对象的迭代器
- 定义于 src/client.ts:4009

listCommits

listCommits(promptOwnerAndName: string): AsyncIterableIterator<PromptCommit>
参数
- promptOwnerAndName: string
返回 AsyncIterableIterator<PromptCommit>
- 定义于 src/client.ts:4375

listDatasets

listDatasets(
    __namedParameters?: {
        datasetIds?: string[];
        datasetName?: string;
        datasetNameContains?: string;
        limit?: number;
        metadata?: RecordStringAny;
        offset?: number;
    },
): AsyncIterable<Dataset>
参数
- __namedParameters: {
      datasetIds?: string[];
      datasetName?: string;
      datasetNameContains?: string;
      limit?: number;
      metadata?: RecordStringAny;
      offset?: number;
  } = {}
返回 AsyncIterable<Dataset>
- 定义于 src/client.ts:2745

listDatasetSplits

listDatasetSplits(
    __namedParameters: {
        asOf?: string | Date;
        datasetId?: string;
        datasetName?: string;
    },
): Promise<string[]>
参数
- __namedParameters: { asOf?: string | Date; datasetId?: string; datasetName?: string }
返回 Promise<string[]>
- 定义于 src/client.ts:3475

listExamples

listExamples(
    __namedParameters?: {
        asOf?: string | Date;
        datasetId?: string;
        datasetName?: string;
        exampleIds?: string[];
        filter?: string;
        includeAttachments?: boolean;
        inlineS3Urls?: boolean;
        limit?: number;
        metadata?: KVMap;
        offset?: number;
        splits?: string[];
    },
): AsyncIterable<Example>
参数
- __namedParameters: {
      asOf?: string | Date;
      datasetId?: string;
      datasetName?: string;
      exampleIds?: string[];
      filter?: string;
      includeAttachments?: boolean;
      inlineS3Urls?: boolean;
      limit?: number;
      metadata?: KVMap;
      offset?: number;
      splits?: string[];
  } = {}
返回 AsyncIterable<Example>
- 定义于 src/client.ts:3234

listFeedback

listFeedback(
    __namedParameters?: {
        feedbackKeys?: string[];
        feedbackSourceTypes?: FeedbackSourceType[];
        runIds?: string[];
    },
): AsyncIterable<Feedback>
参数
- __namedParameters: {
      feedbackKeys?: string[];
      feedbackSourceTypes?: FeedbackSourceType[];
      runIds?: string[];
  } = {}
返回 AsyncIterable<Feedback>
- 定义于 src/client.ts:3758

listGroupRuns

listGroupRuns(props: GroupRunsParams): AsyncIterable<Thread>
参数
- props: GroupRunsParams
返回 AsyncIterable<Thread>
- 定义于 src/client.ts:1834

listPresignedFeedbackTokens

listPresignedFeedbackTokens(runId: string): AsyncIterable<FeedbackIngestToken>
检索给定运行（run）ID 的预签名反馈令牌列表。
参数
- runId: string
  运行的 ID。
返回 AsyncIterable<FeedbackIngestToken>
FeedbackIngestToken 对象的异步迭代器。
- 定义于 src/client.ts:3911

listProjects

listProjects(
    __namedParameters?: {
        metadata?: RecordStringAny;
        name?: string;
        nameContains?: string;
        projectIds?: string[];
        referenceDatasetId?: string;
        referenceDatasetName?: string;
        referenceFree?: boolean;
    },
): AsyncIterable<TracerSession>
参数
- __namedParameters: {
      metadata?: RecordStringAny;
      name?: string;
      nameContains?: string;
      projectIds?: string[];
      referenceDatasetId?: string;
      referenceDatasetName?: string;
      referenceFree?: boolean;
  } = {}
返回 AsyncIterable<TracerSession>
- 定义于 src/client.ts:2450

listPrompts

listPrompts(
    options?: {
        isArchived?: boolean;
        isPublic?: boolean;
        query?: string;
        sortField?: PromptSortField;
    },
): AsyncIterableIterator<Prompt>
参数
- 可选options: {
      isArchived?: boolean;
      isPublic?: boolean;
      query?: string;
      sortField?: PromptSortField;
  }
返回 AsyncIterableIterator<Prompt>
- 定义于 src/client.ts:4390

listRuns

listRuns(props: ListRunsParams): AsyncIterable<Run>

从 LangSmith 服务器列出运行（run）。

参数

props: ListRunsParams

返回 AsyncIterable<Run>

运行（run）列表。

示例

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

示例

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

示例

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

示例

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

示例

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

示例

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

示例

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

示例

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

示例

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

listSharedExamples

listSharedExamples(
shareToken: string,
options?: { exampleIds?: string[] },
): Promise<Example[]>
获取共享示例。
参数
- shareToken: string
  用于获取示例的共享令牌。共享令牌是明确将示例标记为公开时生成的 UUID（或包含 UUID 的 LangSmith URL）。
- 可选options: { exampleIds?: string[] }
  列出示例的其他选项。
  - 可选exampleIds?: string[]
    用于过滤的示例 ID 列表。
返回 Promise<Example[]>
共享示例。
- 定义于 src/client.ts:2182

listSharedRuns

listSharedRuns(
shareToken: string,
__namedParameters?: { runIds?: string[] },
): Promise<Run[]>
参数
- shareToken: string
- __namedParameters: { runIds?: string[] } = {}
返回 Promise<Run[]>
- 定义于 src/client.ts:2050

logEvaluationFeedback

logEvaluationFeedback(
    evaluatorResponse:
        | EvaluationResult
        | EvaluationResult[]
        | EvaluationResults,
    run?: Run,
    sourceInfo?: { [key: string]: any },
): Promise<EvaluationResult[]>
参数
- evaluatorResponse: EvaluationResult | EvaluationResult[] | EvaluationResults
- 可选run: Run
- 可选sourceInfo: { [key: string]: any }
返回 Promise<EvaluationResult[]>
- 定义于 src/client.ts:3980

multipartIngestRuns

multipartIngestRuns(
runs: { runCreates?: RunCreate[]; runUpdates?: RunUpdate[] },
): Promise<void>
在 Langsmith 系统中批量摄取/插入多个运行。
参数
- runs: { runCreates?: RunCreate[]; runUpdates?: RunUpdate[] }
返回 Promise<void>
- 定义于 src/client.ts:1218

promptExists

promptExists(promptIdentifier: string): Promise<boolean>
参数
- promptIdentifier: string
返回 Promise<boolean>
- 定义于 src/client.ts:4358

pullPromptCommit

pullPromptCommit(
promptIdentifier: string,
options?: { includeModel?: boolean },
): Promise<PromptCommit>
参数
- promptIdentifier: string
- 可选options: { includeModel?: boolean }
返回 Promise<PromptCommit>
- 定义于 src/client.ts:4843

pushPrompt

pushPrompt(
    promptIdentifier: string,
    options?: {
        description?: string;
        isPublic?: boolean;
        object?: any;
        parentCommitHash?: string;
        readme?: string;
        tags?: string[];
    },
): Promise<string>
参数
- promptIdentifier: string
- 可选options: {
      description?: string;
      isPublic?: boolean;
      object?: any;
      parentCommitHash?: string;
      readme?: string;
      tags?: string[];
  }
返回 Promise<string>
- 定义于 src/client.ts:4895

readAnnotationQueue

readAnnotationQueue(queueId: string): Promise<AnnotationQueueWithDetails>
读取具有指定队列 ID 的标注队列。
参数
- queueId: string
  要读取的标注队列的 ID
返回 Promise<AnnotationQueueWithDetails>
AnnotationQueueWithDetails 对象
- 定义于 src/client.ts:4090

readDataset

readDataset(
__namedParameters: { datasetId?: string; datasetName?: string },
): Promise<Dataset>
参数
- __namedParameters: { datasetId?: string; datasetName?: string }
返回 Promise<Dataset>
- 定义于 src/client.ts:2628

readDatasetOpenaiFinetuning

readDatasetOpenaiFinetuning(
__namedParameters: { datasetId?: string; datasetName?: string },
): Promise<any[]>
参数
- __namedParameters: { datasetId?: string; datasetName?: string }
返回 Promise<any[]>
- 定义于 src/client.ts:2720

readDatasetSharedSchema

readDatasetSharedSchema(
datasetId?: string,
datasetName?: string,
): Promise<DatasetShareSchema>
参数
- 可选datasetId: string
- 可选datasetName: string
返回 Promise<DatasetShareSchema>
- 定义于 src/client.ts:2081

readDatasetVersion

readDatasetVersion(
    options: {
        asOf?: string | Date;
        datasetId?: string;
        datasetName?: string;
        tag?: string;
    },
): Promise<DatasetVersion>
按最近日期或精确标签获取数据集版本。

使用此方法解析给定时间戳或给定标签的最近版本。
参数
- options: { asOf?: string | Date; datasetId?: string; datasetName?: string; tag?: string }
  获取数据集版本的选项
  - 可选asOf?: string | Date
    要检索的数据集的时间戳
  - 可选datasetId?: string
    数据集的 ID
  - 可选datasetName?: string
    数据集的名称
  - 可选tag?: string
    要检索的数据集的标签
返回 Promise<DatasetVersion>
数据集版本
- 定义于 src/client.ts:3421

readExample

readExample(exampleId: string): Promise<Example>
参数
- exampleId: string
返回 Promise<Example>
- 定义于 src/client.ts:3213

readFeedback

readFeedback(feedbackId: string): Promise<Feedback>
参数
- feedbackId: string
返回 Promise<Feedback>
- 定义于 src/client.ts:3734

readProject

readProject(
    __namedParameters: {
        includeStats?: boolean;
        projectId?: string;
        projectName?: string;
    },
): Promise<TracerSessionResult>
参数
- __namedParameters: { includeStats?: boolean; projectId?: string; projectName?: string }
返回 Promise<TracerSessionResult>
- 定义于 src/client.ts:2362

readRun

readRun(
runId: string,
__namedParameters?: { loadChildRuns: boolean },
): Promise<Run>
参数
- runId: string
- __namedParameters: { loadChildRuns: boolean } = ...
返回 Promise<Run>
- 定义于 src/client.ts:1551

readRunSharedLink

readRunSharedLink(runId: string): Promise<undefined | string>
参数
- runId: string
返回 Promise<undefined | string>
- 定义于 src/client.ts:2031

readSharedDataset

readSharedDataset(shareToken: string): Promise<Dataset>
参数
- shareToken: string
返回 Promise<Dataset>
- 定义于 src/client.ts:2158

shareDataset

shareDataset(
datasetId?: string,
datasetName?: string,
): Promise<DatasetShareSchema>
参数
- 可选datasetId: string
- 可选datasetName: string
返回 Promise<DatasetShareSchema>
- 定义于 src/client.ts:2110

shareRun

shareRun(
runId: string,
__namedParameters?: { shareId?: string },
): Promise<string>
参数
- runId: string
- __namedParameters: { shareId?: string } = {}
返回 Promise<string>
- 定义于 src/client.ts:1989

similarExamples

similarExamples(
    inputs: KVMap,
    datasetId: string,
    limit: number,
    filter?: { filter?: string },
): Promise<ExampleSearch[]>
允许您在数据集上运行相似性搜索查询。

要求数据集已编入索引。请参阅 indexDataset 方法以设置索引。
参数
- inputs: KVMap
  用于运行相似性搜索的输入。必须与数据集具有相同的 schema。
- datasetId: string
  用于搜索相似示例的数据集。
- limit: number
  要返回的最大示例数。将按从最相似到最不相似的顺序返回前 limit 个最相似的示例。如果没有找到相似的示例，将返回随机示例。
- filter: { filter?: string } = {}
  要应用于搜索的筛选字符串。仅返回与筛选字符串匹配的示例。一些筛选器示例
  
  - eq(metadata.mykey, "value") - and(neq(metadata.my.nested.key, "value"), neq(metadata.mykey, "value")) - or(eq(metadata.mykey, "value"), eq(metadata.mykey, "othervalue"))
返回 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)
```
- 定义于 src/client.ts:2970

unlikePrompt

unlikePrompt(promptIdentifier: string): Promise<LikePromptResponse>
参数
- promptIdentifier: string
返回 Promise<LikePromptResponse>
- 定义于 src/client.ts:4369

unshareDataset

unshareDataset(datasetId: string): Promise<void>
参数
- datasetId: string
返回 Promise<void>
- 定义于 src/client.ts:2143

unshareRun

unshareRun(runId: string): Promise<void>
参数
- runId: string
返回 Promise<void>
- 定义于 src/client.ts:2016

updateAnnotationQueue

updateAnnotationQueue(
    queueId: string,
    options: {
        name: string;
        description?: string;
        rubricInstructions?: string;
    },
): Promise<void>
使用指定的队列ID更新标注队列。
参数
- queueId: string
  要更新的标注队列的ID
- options: { name: string; description?: string; rubricInstructions?: string }
  用于更新标注队列的选项
  - name: string
    标注队列的新名称
  - 可选description?: string
    标注队列的新描述
  - 可选rubricInstructions?: string
返回 Promise<void>
- 定义于 src/client.ts:4115

updateDataset

updateDataset(
    props: {
        datasetId?: string;
        datasetName?: string;
        description?: string;
        name?: string;
    },
): Promise<Dataset>
更新数据集
参数
- props: {
      datasetId?: string;
      datasetName?: string;
      description?: string;
      name?: string;
  }
  要更新的数据集详情
返回 Promise<Dataset>
更新后的数据集
- 定义于 src/client.ts:2789

updateDatasetSplits

updateDatasetSplits(
    __namedParameters: {
        exampleIds: string[];
        splitName: string;
        datasetId?: string;
        datasetName?: string;
        remove?: boolean;
    },
): Promise<void>
参数
- __namedParameters: {
      exampleIds: string[];
      splitName: string;
      datasetId?: string;
      datasetName?: string;
      remove?: boolean;
  }
返回 Promise<void>
- 定义于 src/client.ts:3515

updateDatasetTag

updateDatasetTag(
    props: {
        asOf: string | Date;
        tag: string;
        datasetId?: string;
        datasetName?: string;
    },
): Promise<void>
更新数据集上的标签。

如果标签已分配给此数据集的其他版本，则标签将移动到新版本。as_of 参数用于确定将新标签应用于哪个版本的数据集。

它必须是数据集的精确版本才能成功。您可以使用“readDatasetVersion”方法来查找要应用标签的精确版本。
参数
- props: { asOf: string | Date; tag: string; datasetId?: string; datasetName?: string }
返回 Promise<void>
- 定义于 src/client.ts:2834

updateExample

updateExample(
exampleId: string,
update: ExampleUpdateWithoutId,
): Promise<object>
参数
- exampleId: string
- update: ExampleUpdateWithoutId
返回 Promise<object>
已废弃
此签名已废弃，请改用 updateExample(update: ExampleUpdate)
- 定义于 src/client.ts:3358
updateExample(update: ExampleUpdate): Promise<object>
参数
- update: ExampleUpdate
返回 Promise<object>
已废弃
此签名已废弃，请改用 updateExample(update: ExampleUpdate)
- 定义于 src/client.ts:3363

updateExamples

updateExamples(update: ExampleUpdate[]): Promise<object>
参数
- update: ExampleUpdate[]
返回 Promise<object>
- 定义于 src/client.ts:3396

updateExamplesMultipart

updateExamplesMultipart(
datasetId: string,
updates?: ExampleUpdate[],
): Promise<UpdateExamplesResponse>
使用多部分表单数据更新带有附件的示例。
参数
- datasetId: string
- updates: ExampleUpdate[] = []
  要更新/插入的 ExampleUpdateWithAttachments 对象列表
返回 Promise<UpdateExamplesResponse>
带有更新响应的 Promise
- 定义于 src/client.ts:4543

updateFeedback

updateFeedback(
    feedbackId: string,
    __namedParameters: {
        comment?: null | string;
        correction?: null | object;
        score?: null | number | boolean;
        value?: null | string | number | boolean | object;
    },
): Promise<void>
参数
- feedbackId: string
- __namedParameters: {
      comment?: null | string;
      correction?: null | object;
      score?: null | number | boolean;
      value?: null | string | number | boolean | object;
  }
返回 Promise<void>
- 定义于 src/client.ts:3692

updateProject

updateProject(
    projectId: string,
    __namedParameters: {
        description?: null | string;
        endTime?: null | string;
        metadata?: null | RecordStringAny;
        name?: null | string;
        projectExtra?: null | RecordStringAny;
    },
): Promise<TracerSession>
参数
- projectId: string
- __namedParameters: {
      description?: null | string;
      endTime?: null | string;
      metadata?: null | RecordStringAny;
      name?: null | string;
      projectExtra?: null | RecordStringAny;
  }
返回 Promise<TracerSession>
- 定义于 src/client.ts:2271

updatePrompt

updatePrompt(
    promptIdentifier: string,
    options?: {
        description?: string;
        isArchived?: boolean;
        isPublic?: boolean;
        readme?: string;
        tags?: string[];
    },
): Promise<Record<string, any>>
参数
- promptIdentifier: string
- 可选options: {
      description?: string;
      isArchived?: boolean;
      isPublic?: boolean;
      readme?: string;
      tags?: string[];
  }
返回 Promise<Record<string, any>>
- 定义于 src/client.ts:4764

updateRun

updateRun(runId: string, run: RunUpdate): Promise<void>
参数
- runId: string
- run: RunUpdate
返回 Promise<void>
LangSmithTracingClientInterface.updateRun 的实现
- 定义于 src/client.ts:1495

uploadCsv

uploadCsv(__namedParameters: UploadCSVParams): Promise<Dataset>
参数
- __namedParameters: UploadCSVParams
返回 Promise<Dataset>
- 定义于 src/client.ts:2536

uploadExamplesMultipart

uploadExamplesMultipart(
datasetId: string,
uploads?: ExampleCreate[],
): Promise<UploadExamplesResponse>
使用多部分表单数据上传带有附件的示例。
参数
- datasetId: string
- uploads: ExampleCreate[] = []
  要上传的 ExampleUploadWithAttachments 对象列表
返回 Promise<UploadExamplesResponse>
带有上传响应的 Promise

已废弃
此方法已废弃，并将在未来的 LangSmith 版本中移除，请改用 createExamples
- 定义于 src/client.ts:4661

`Static`getDefaultClientConfig

getDefaultClientConfig(): {
    apiUrl: string;
    apiKey?: string;
    hideInputs?: boolean;
    hideOutputs?: boolean;
    webUrl?: string;
}
返回 {
    apiUrl: string;
    apiKey?: string;
    hideInputs?: boolean;
    hideOutputs?: boolean;
    webUrl?: string;
}
- 定义于 src/client.ts:658

Client 类

实现

索引

构造函数

属性

方法

构造函数

构造函数

参数

返回 Client

属性

debug

方法

addRunsToAnnotationQueue

参数

返回 Promise<void>

awaitPendingTraceBatches

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

示例

batchIngestRuns

参数

返回 Promise<void>

clonePublicDataset

参数

可选datasetName?: string

可选sourceApiUrl?: string

返回 Promise<void>

createAnnotationQueue

参数

name: string

可选description?: string

可选queueId?: string

可选rubricInstructions?: string

返回 Promise<AnnotationQueueWithDetails>

createChatExample

参数

返回 Promise<Example>

createCommit

参数

返回 Promise<string>

createComparativeExperiment

参数

返回 Promise<ComparativeExperiment>

createDataset

参数

返回 Promise<Dataset>

createExample

参数

返回 Promise<Example>

参数

返回 Promise<Example>

已弃用

createExamples

参数

返回 Promise<Example[]>

参数

返回 Promise<Example[]>

已弃用

createFeedback

参数

返回 Promise<Feedback>

createLLMExample

参数

返回 Promise<Example>

createPresignedFeedbackToken

参数

可选expiration?: string | TimeDelta

可选feedbackConfig?: FeedbackConfig

返回 Promise<FeedbackIngestToken>

createProject

参数

返回 Promise<TracerSession>

createPrompt

参数

返回 Promise<Prompt>

createRun

参数

返回 Promise<void>

deleteAnnotationQueue

参数

`可选`datasetName?: string

`可选`sourceApiUrl?: string

`可选`description?: string

`可选`queueId?: string

`可选`rubricInstructions?: string

`可选`expiration?: string | TimeDelta

`可选`feedbackConfig?: FeedbackConfig

`可选`limit?: number

`可选`name?: string

`可选`nameContains?: string

`可选`queueIds?: string[]