langsmith 0.5.16 → 0.5.17

package/dist/client.d.ts

@@ -1,6 +1,6 @@
 import type { OTELContext } from "./experimental/otel/types.js";
 import { AsyncCallerParams } from "./utils/async_caller.js";
-import { ComparativeExperiment, DataType, Dataset, DatasetDiffInfo, DatasetShareSchema, Example, ExampleCreate, ExampleUpdate, ExampleUpdateWithoutId, Feedback, FeedbackConfig, FeedbackIngestToken, KVMap, LangChainBaseMessage, LangSmithSettings, LikePromptResponse, Prompt, PromptCommit, PromptSortField, Run, RunCreate, RunUpdate, ScoreType, ExampleSearch, TimeDelta, TracerSession, TracerSessionResult, ValueType, AnnotationQueue, RunWithAnnotationQueueInfo, Attachments, UploadExamplesResponse, UpdateExamplesResponse, DatasetVersion, AnnotationQueueWithDetails, AnnotationQueueRubricItem, FeedbackConfigSchema } from "./schemas.js";
+import { ComparativeExperiment, DataType, Dataset, DatasetDiffInfo, DatasetShareSchema, Example, ExampleCreate, ExampleUpdate, ExampleUpdateWithoutId, Feedback, FeedbackConfig, FeedbackIngestToken, KVMap, LangChainBaseMessage, LangSmithSettings, LikePromptResponse, Prompt, PromptCommit, PromptSortField, Run, RunCreate, RunUpdate, ScoreType, TimeDelta, TracerSession, TracerSessionResult, ValueType, AnnotationQueue, RunWithAnnotationQueueInfo, Attachments, UploadExamplesResponse, UpdateExamplesResponse, DatasetVersion, AnnotationQueueWithDetails, AnnotationQueueRubricItem, FeedbackConfigSchema } from "./schemas.js";
 import { EvaluationResult, EvaluationResults } from "./evaluation/evaluator.js";
 import { PromptCache } from "./utils/prompt_cache/index.js";
 export interface ClientConfig {
@@ -55,6 +55,13 @@ export interface ClientConfig {
      * By default, prompt caching is enabled globally.
      */
     disablePromptCache?: boolean;
+    /**
+     * Additional HTTP headers to include in all requests.
+     * These headers will be merged with the default headers (User-Agent,
+     * x-api-key, x-tenant-id, etc.). Custom headers will not override
+     * the default required headers.
+     */
+    headers?: Record<string, string>;
     /**
      * @deprecated Use `configureGlobalPromptCache()` to configure caching, or
      * `disablePromptCache: true` to disable it. This parameter is deprecated.
@@ -416,6 +423,7 @@ export declare class Client implements LangSmithTracingClientInterface {
     private failedTracesDir;
     private failedTracesMaxBytes;
     private static _fallbackDirsCreated;
+    private _customHeaders;
     debug: boolean;
     constructor(config?: ClientConfig);
     static getDefaultClientConfig(): {
@@ -426,7 +434,14 @@ export declare class Client implements LangSmithTracingClientInterface {
         hideOutputs?: boolean;
     };
     getHostUrl(): string;
-    private get headers();
+    private get _mergedHeaders();
+    /**
+     * Get or set custom headers for the client.
+     * Custom headers are merged with default headers (User-Agent, x-api-key, x-tenant-id).
+     * Custom headers will not override the default required headers.
+     */
+    get headers(): Record<string, string>;
+    set headers(value: Record<string, string> | undefined);
     private _getPlatformEndpointPath;
     private processInputs;
     private processOutputs;
@@ -754,44 +769,6 @@ export declare class Client implements LangSmithTracingClientInterface {
         datasetId?: string;
         datasetName?: string;
     }): Promise<void>;
-    indexDataset({ datasetId, datasetName, tag, }: {
-        datasetId?: string;
-        datasetName?: string;
-        tag?: string;
-    }): Promise<void>;
-    /**
-     * Lets you run a similarity search query on a dataset.
-     *
-     * Requires the dataset to be indexed. Please see the `indexDataset` method to set up indexing.
-     *
-     * @param inputs      The input on which to run the similarity search. Must have the
-     *                    same schema as the dataset.
-     *
-     * @param datasetId   The dataset to search for similar examples.
-     *
-     * @param limit       The maximum number of examples to return. Will return the top `limit` most
-     *                    similar examples in order of most similar to least similar. If no similar
-     *                    examples are found, random examples will be returned.
-     *
-     * @param filter      A filter string to apply to the search. Only examples will be returned that
-     *                    match the filter string. Some examples of filters
-     *
-     *                    - eq(metadata.mykey, "value")
-     *                    - and(neq(metadata.my.nested.key, "value"), neq(metadata.mykey, "value"))
-     *                    - or(eq(metadata.mykey, "value"), eq(metadata.mykey, "othervalue"))
-     *
-     * @returns           A list of similar examples.
-     *
-     *
-     * @example
-     * 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)
-     */
-    similarExamples(inputs: KVMap, datasetId: string, limit: number, { filter, }?: {
-        filter?: string;
-    }): Promise<ExampleSearch[]>;
     createExample(update: ExampleCreate): Promise<Example>;
     /**
      * @deprecated This signature is deprecated, use createExample(update: ExampleCreate) instead
@@ -1264,6 +1241,7 @@ export declare class Client implements LangSmithTracingClientInterface {
      */
     createCommit(promptIdentifier: string, object: any, options?: {
         parentCommitHash?: string;
+        description?: string;
     }): Promise<string>;
     /**
      * Update examples with attachments using multipart form data.
@@ -1317,6 +1295,7 @@ export declare class Client implements LangSmithTracingClientInterface {
         description?: string;
         readme?: string;
         tags?: string[];
+        commitDescription?: string;
     }): Promise<string>;
     /**
      * Clone a public dataset to your own langsmith tenant.