langsmith 0.8.7 → 0.8.9

package/dist/client.d.ts

@@ -7,6 +7,7 @@ import { OnlineEvaluators as Evaluators } from "./_openapi_client/resources/onli
 import { Runs as OpenAPIRuns } from "./_openapi_client/resources/runs.js";
 import { Sandboxes } from "./_openapi_client/resources/sandboxes/sandboxes.js";
 import { Datasets } from "./_openapi_client/resources/datasets/datasets.js";
+import { AnnotationQueues } from "./_openapi_client/resources/annotation-queues/annotation-queues.js";
 import { Threads } from "./_openapi_client/resources/threads.js";
 import { Traces } from "./_openapi_client/resources/traces.js";
 import { Public } from "./_openapi_client/resources/public/public.js";
@@ -335,6 +336,51 @@ interface ProjectOptions {
 }
 type RecordStringAny = Record<string, any>;
 export type FeedbackSourceType = "model" | "api" | "app";
+export type CreateFeedbackOptions = {
+    /** The metric name, tag, or aspect to provide feedback on. */
+    key: string;
+    score?: ScoreType;
+    value?: ValueType;
+    correction?: object;
+    comment?: string;
+    sourceInfo?: object;
+    feedbackSourceType?: FeedbackSourceType;
+    feedbackConfig?: FeedbackConfig;
+    sourceRunId?: string;
+    feedbackId?: string;
+    comparativeExperimentId?: string;
+    /**
+     * The run's start time, ISO string or epoch ms. Better performance if provided.
+     */
+    startTime?: number | string;
+    /** If false, create feedback without extending the trace's retention tier. */
+    extendTraceRetention?: boolean;
+};
+/** @deprecated Pass all params within an object and populate sessionId. */
+export type CreateFeedbackLegacyOptions = Omit<CreateFeedbackOptions, "key"> & {
+    /** @deprecated This option is no longer used. */
+    eager?: boolean;
+    /**
+     * The session (project) ID of the run. Required for run-level feedback;
+     * omitting it is deprecated. See
+     * https://docs.langchain.com/langsmith/smithdb-sdk-migration#feedback-create
+     */
+    sessionId?: string;
+    /** The project (or experiment) to provide feedback on, for session-level feedback. */
+    projectId?: string;
+};
+export type CreateFeedbackParams = CreateFeedbackOptions & ({
+    /** The run to provide feedback on. */
+    runId: string;
+    /** The session (project) ID of the run. */
+    sessionId: string;
+    projectId?: never;
+} | {
+    runId?: null;
+    /** The project (or experiment) to provide feedback on. */
+    projectId: string;
+    sessionId?: never;
+});
 export type CreateExampleOptions = {
     /** The ID of the dataset to create the example in. */
     datasetId?: string;
@@ -397,7 +443,7 @@ export interface ListThreadsItem extends Thread {
     runs: Run[];
 }
 export declare function mergeRuntimeEnvIntoRun<T extends RunCreate | RunUpdate>(run: T, cachedEnvVars?: Record<string, string>, omitTracedRuntimeInfo?: boolean): T;
-export declare function _checkBackendVersion(version: string, minVersion?: string): void;
+export declare function _checkBackendVersion(backendVersion: string, minVersion: string): void;
 export declare const DEFAULT_UNCOMPRESSED_BATCH_SIZE_LIMIT_BYTES: number;
 /** Default maximum memory (1GB) for queue size limits. */
 export declare const DEFAULT_MAX_SIZE_BYTES: number;
@@ -455,14 +501,17 @@ export declare class Client implements LangSmithTracingClientInterface {
     private autoBatchAggregationDelayMs;
     private batchSizeBytesLimit?;
     private batchSizeLimit?;
+    /** `config.fetchOptions` without its `headers`, which are merged separately. */
     private fetchOptions;
-    private openAPIClient;
+    private _fetchOptionsHeaders;
+    private _openAPIClient?;
+    private _openAPIClientSignature?;
     private settings;
     private blockOnRootRunFinalization;
     private traceBatchConcurrency;
     private _serverInfo;
     private _getServerInfoPromise?;
-    private _stainlessVersionChecked;
+    private _stainlessVersionsChecked;
     private manualFlushMode;
     private _serializeWorker?;
     /**
@@ -509,7 +558,33 @@ export declare class Client implements LangSmithTracingClientInterface {
     constructor(config?: ClientConfig);
     static getDefaultClientConfig(): DefaultClientConfig;
     getHostUrl(): string;
+    /**
+     * The headers this client sets from its own config, which a caller-supplied
+     * header must not replace.
+     *
+     * Only what the client *actually* supplies: passing an explicit `Authorization`
+     * or `x-api-key` header with no configured credential is a supported way to
+     * authenticate (see `hasExplicitAuthHeader`), so those must survive.
+     */
+    private get _sdkControlledHeaders();
+    /**
+     * Headers supplied by the caller, through either `config.headers` or
+     * `config.fetchOptions.headers`, with the ones this SDK sets removed.
+     *
+     * `_customHeaders` is normalized here rather than at assignment because it is
+     * public and mutable: `get headers` hands back the caller's own object, so its
+     * contents can change (and can become malformed) at any point.
+     */
+    private get _callerHeaders();
     private get _mergedHeaders();
+    /**
+     * The auth options and caller headers to build the generated client with.
+     *
+     * The generated client applies `defaultHeaders` *after* its own auth headers,
+     * so the ones this SDK sets are already dropped from `_callerHeaders` to keep
+     * the precedence of `_mergedHeaders`, where required headers win.
+     */
+    private get _openAPIAuth();
     /**
      * Get or set custom headers for the client.
      * Custom headers are merged with default headers (User-Agent, x-api-key, x-tenant-id).
@@ -518,6 +593,17 @@ export declare class Client implements LangSmithTracingClientInterface {
     get headers(): Record<string, string>;
     set headers(value: Record<string, string> | undefined);
     private _getOpenAPIBaseUrl;
+    /**
+     * The generated OpenAPI client, rebuilt whenever its auth or headers change.
+     *
+     * The generated client captures `defaultHeaders` and `apiKey` when it is
+     * built, while the handwritten paths recompute `_mergedHeaders` per request.
+     * Rebuilding on change keeps the two halves from diverging when the inputs
+     * move underneath us — a caller mutating the object returned by
+     * `get headers`, or a profile whose auth header only becomes available after
+     * its token is refreshed.
+     */
+    private get openAPIClient();
     private _newOpenAPIClient;
     private _getPlatformEndpointPath;
     get evaluators(): Evaluators;
@@ -526,6 +612,8 @@ export declare class Client implements LangSmithTracingClientInterface {
     get sandboxes(): Sandboxes;
     /** Access the v2 datasets resource (experimentRuns, etc.). */
     get datasets(): Datasets;
+    /** Access the annotation queues resource (runs, items). */
+    get annotationQueues(): AnnotationQueues;
     /** Access the threads resource (query, stats, listTraces). */
     get threads(): Threads;
     /** Access the traces resource (query, listRuns). */
@@ -587,6 +675,11 @@ export declare class Client implements LangSmithTracingClientInterface {
     private _checkStainlessVersion;
     protected _ensureServerInfo(): Promise<Record<string, any>>;
     _supportsSDBQuery(): Promise<boolean>;
+    /**
+     * Throw on SmithDB-only deployments, warn elsewhere. Call only when run-level
+     * feedback has no sessionId.
+     */
+    private _checkFeedbackSessionId;
     protected _getSettings(): Promise<LangSmithSettings>;
     /**
      * Flushes current queued traces.
@@ -634,9 +727,11 @@ export declare class Client implements LangSmithTracingClientInterface {
         apiUrl?: string;
         workspaceId?: string;
     }): Promise<void>;
+    /** @deprecated Use `client.runs.retrieve()` instead. See https://docs.langchain.com/langsmith/smithdb-sdk-migration#runs-retrieve for the migration guide. Will be removed after Jan 31, 2027. */
     readRun(runId: string, { loadChildRuns }?: {
         loadChildRuns: boolean;
     }): Promise<Run>;
+    /** @deprecated Use `client.runs.getURL()` instead. See https://docs.langchain.com/langsmith/smithdb-sdk-migration#runs-get-url for the migration guide. Will be removed after Jan 31, 2027. */
     getRunUrl({ runId, run, projectOpts, }: {
         runId?: string;
         run?: Run;
@@ -645,6 +740,7 @@ export declare class Client implements LangSmithTracingClientInterface {
     private _loadChildRuns;
     /**
      * List runs from the LangSmith server.
+     * @deprecated Use `client.runs.query()` instead. See https://docs.langchain.com/langsmith/smithdb-sdk-migration#runs-query for the migration guide. Will be removed after Jan 31, 2027.
      * @param projectId - The ID of the project to filter by.
      * @param projectName - The name of the project to filter by.
      * @param parentRunId - The ID of the parent run to filter by.
@@ -727,7 +823,9 @@ export declare class Client implements LangSmithTracingClientInterface {
      */
     listRuns(props: ListRunsParams): AsyncIterable<Run>;
     listGroupRuns(props: GroupRunsParams): AsyncIterable<Thread>;
+    /** @deprecated Use `client.threads.listTraces()` instead. See https://docs.langchain.com/langsmith/smithdb-sdk-migration#threads-list-traces for the migration guide. Will be removed after Jan 31, 2027. */
     readThread(props: ReadThreadParams): AsyncIterable<Run>;
+    /** @deprecated Use `client.threads.query()` instead. See https://docs.langchain.com/langsmith/smithdb-sdk-migration#threads-query for the migration guide. Will be removed after Jan 31, 2027. */
     listThreads(props: ListThreadsParams): Promise<ListThreadsItem[]>;
     getRunStats({ id, trace, parentRun, runType, projectNames, projectIds, referenceExampleIds, startTime, endTime, error, query, filter, traceFilter, treeFilter, isRoot, dataSourceType, }: {
         id?: string[];
@@ -747,11 +845,15 @@ export declare class Client implements LangSmithTracingClientInterface {
         isRoot?: boolean;
         dataSourceType?: string;
     }): Promise<any>;
+    /** @deprecated Use `client.runs.share.create()` instead. See https://docs.langchain.com/langsmith/smithdb-sdk-migration#share-and-read-public-runs for the migration guide. Will be removed after Jan 31, 2027. */
     shareRun(runId: string, { shareId }?: {
         shareId?: string;
     }): Promise<string>;
+    /** @deprecated Use `client.runs.share.delete()` instead. See https://docs.langchain.com/langsmith/smithdb-sdk-migration#share-and-read-public-runs for the migration guide. Will be removed after Jan 31, 2027. */
     unshareRun(runId: string): Promise<void>;
+    /** @deprecated Use `client.runs.retrieve({ selects: ["SHARE_URL"] })` instead. See https://docs.langchain.com/langsmith/smithdb-sdk-migration#share-and-read-public-runs for the migration guide. Will be removed after Jan 31, 2027. */
     readRunSharedLink(runId: string): Promise<string | undefined>;
+    /** @deprecated Use `client.public.runs.query()` instead. See https://docs.langchain.com/langsmith/smithdb-sdk-migration#share-and-read-public-runs for the migration guide. Will be removed after Jan 31, 2027. */
     listSharedRuns(shareToken: string, { runIds, }?: {
         runIds?: string[];
     }): Promise<Run[]>;
@@ -963,26 +1065,9 @@ export declare class Client implements LangSmithTracingClientInterface {
         exampleIds: string[];
         remove?: boolean;
     }): Promise<void>;
-    createFeedback(runId: string | null, key: string, { score, value, correction, comment, sourceInfo, feedbackSourceType, sourceRunId, feedbackId, feedbackConfig, projectId, comparativeExperimentId, sessionId, startTime, extendTraceRetention, }: {
-        score?: ScoreType;
-        value?: ValueType;
-        correction?: object;
-        comment?: string;
-        sourceInfo?: object;
-        feedbackSourceType?: FeedbackSourceType;
-        feedbackConfig?: FeedbackConfig;
-        sourceRunId?: string;
-        feedbackId?: string;
-        eager?: boolean;
-        projectId?: string;
-        comparativeExperimentId?: string;
-        /** The session (project) ID of the run this feedback is for. */
-        sessionId?: string;
-        /** The start time of the run this feedback is for. Accepts ISO string or epoch ms. */
-        startTime?: number | string;
-        /** If false, create feedback without extending the trace's retention tier. */
-        extendTraceRetention?: boolean;
-    }): Promise<Feedback>;
+    createFeedback(params: CreateFeedbackParams): Promise<Feedback>;
+    /** @deprecated Pass all params within an object and populate sessionId. */
+    createFeedback(runId: string | null, key: string, options: CreateFeedbackLegacyOptions): Promise<Feedback>;
     updateFeedback(feedbackId: string, { score, value, correction, comment, }: {
         score?: number | boolean | null;
         value?: number | boolean | string | object | null;
@@ -1160,8 +1245,9 @@ export declare class Client implements LangSmithTracingClientInterface {
      * - `RunKey[]` (preferred): each entry carries the run's full lookup key, so
      *   it can be located directly without a scan. Required for workspaces served
      *   by SmithDB; routes to `POST /runs/by-key`.
-     * - `string[]`: a plain list of run IDs. This path will be deprecated in a
-     *   future release; prefer the key form. Routes to `POST /runs`.
+     * - `string[]`: a plain list of run IDs. **Deprecated**: this path will be
+     *   removed after Jan 31, 2027; prefer the key form. Routes to `POST /runs`.
+     *   See https://docs.langchain.com/langsmith/smithdb-sdk-migration#annotation-queues-add-runs.
      *
      * If every element is a string (or the list is empty) it is treated as run
      * IDs; otherwise the list is treated as `RunKey` objects.