langsmith 0.8.8 → 0.8.10

package/dist/client.d.ts

@@ -20,11 +20,11 @@ export interface ClientConfig {
     timeout_ms?: number;
     webUrl?: string;
     /**
-     * A function applied for masking serialized run inputs and outputs,
-     * before sending to the API. Can be called with raw inputs, raw
-     * outputs, or a nested `{ error: string }` object for errors.
+     * A function applied for masking serialized run inputs, outputs and
+     * metadata, before sending to the API. Can be called with raw inputs, raw
+     * outputs, raw metadata, or a nested `{ error: string }` object for errors.
      *
-     * If a `hideInputs` or `hideOutputs` function is present,
+     * If a `hideInputs`, `hideOutputs` or `hideMetadata` function is present,
      * the client will call it instead of the anonymizer as appropriate.
      */
     anonymizer?: (values: KVMap) => KVMap | Promise<KVMap>;
@@ -413,6 +413,7 @@ export type CreateProjectParams = {
     numExamples?: number | null;
     numRepetitions?: number | null;
     evaluatorKeys?: string[] | null;
+    tagValueIds?: string[] | null;
 };
 type AutoBatchQueueItem = {
     action: "create" | "update";
@@ -501,8 +502,11 @@ 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;
@@ -555,7 +559,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).
@@ -564,6 +594,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;
@@ -630,6 +671,8 @@ export declare class Client implements LangSmithTracingClientInterface {
     private static _writeTraceToFallbackDir;
     private _processBatch;
     private _sendBatchToOTELTranslator;
+    private _maskRunMetadata;
+    private _mergeRuntimeEnvAndMaskMetadata;
     private processRunOperation;
     protected _getServerInfo(): Promise<any>;
     private _checkStainlessVersion;
@@ -687,9 +730,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;
@@ -698,6 +743,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.
@@ -780,7 +826,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[];
@@ -800,11 +848,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[]>;
@@ -823,7 +875,7 @@ export declare class Client implements LangSmithTracingClientInterface {
     listSharedExamples(shareToken: string, options?: {
         exampleIds?: string[];
     }): Promise<Example[]>;
-    createProject({ projectName, description, metadata, upsert, projectExtra, referenceDatasetId, numExamples, numRepetitions, evaluatorKeys, }: CreateProjectParams): Promise<TracerSession>;
+    createProject({ projectName, description, metadata, upsert, projectExtra, referenceDatasetId, numExamples, numRepetitions, evaluatorKeys, tagValueIds, }: CreateProjectParams): Promise<TracerSession>;
     updateProject(projectId: string, { name, description, metadata, projectExtra, endTime, }: {
         name?: string | null;
         description?: string | null;
@@ -865,12 +917,13 @@ export declare class Client implements LangSmithTracingClientInterface {
         projectName?: string;
     }): Promise<void>;
     uploadCsv({ csvFile, fileName, inputKeys, outputKeys, description, dataType, name, }: UploadCSVParams): Promise<Dataset>;
-    createDataset(name: string, { description, dataType, inputsSchema, outputsSchema, metadata, }?: {
+    createDataset(name: string, { description, dataType, inputsSchema, outputsSchema, metadata, tagValueIds, }?: {
         description?: string;
         dataType?: DataType;
         inputsSchema?: KVMap;
         outputsSchema?: KVMap;
         metadata?: RecordStringAny;
+        tagValueIds?: string[];
     }): Promise<Dataset>;
     readDataset({ datasetId, datasetName, }: {
         datasetId?: string;
@@ -1196,8 +1249,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.