langsmith 0.1.43 → 0.1.44

package/dist/client.cjs

@@ -32,6 +32,7 @@ const index_js_1 = require("./index.cjs");
 const _uuid_js_1 = require("./utils/_uuid.cjs");
 const warn_js_1 = require("./utils/warn.cjs");
 const prompts_js_1 = require("./utils/prompts.cjs");
+const error_js_1 = require("./utils/error.cjs");
 async function mergeRuntimeEnvIntoRunCreates(runs) {
     const runtimeEnv = await (0, env_js_1.getRuntimeEnvironment)();
     const envVars = (0, env_js_1.getLangChainEnvVarsMetadata)();
@@ -72,14 +73,6 @@ const isLocalhost = (url) => {
     const hostname = strippedUrl.split("/")[0].split(":")[0];
     return (hostname === "localhost" || hostname === "127.0.0.1" || hostname === "::1");
 };
-const raiseForStatus = async (response, operation) => {
-    // consume the response body to release the connection
-    // https://undici.nodejs.org/#/?id=garbage-collection
-    const body = await response.text();
-    if (!response.ok) {
-        throw new Error(`Failed to ${operation}: ${response.status} ${response.statusText} ${body}`);
-    }
-};
 async function toArray(iterable) {
     const result = [];
     for await (const item of iterable) {
@@ -387,9 +380,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        if (!response.ok) {
-            throw new Error(`Failed to fetch ${path}: ${response.status} ${response.statusText}`);
-        }
+        await (0, error_js_1.raiseForStatus)(response, `Failed to fetch ${path}`);
         return response;
     }
     async _get(path, queryParams) {
@@ -409,9 +400,7 @@ class Client {
                 signal: AbortSignal.timeout(this.timeout_ms),
                 ...this.fetchOptions,
             });
-            if (!response.ok) {
-                throw new Error(`Failed to fetch ${path}: ${response.status} ${response.statusText}`);
-            }
+            await (0, error_js_1.raiseForStatus)(response, `Failed to fetch ${path}`);
             const items = transform
                 ? transform(await response.json())
                 : await response.json();
@@ -528,12 +517,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        if (!response.ok) {
-            // consume the response body to release the connection
-            // https://undici.nodejs.org/#/?id=garbage-collection
-            await response.text();
-            throw new Error("Failed to retrieve server info.");
-        }
+        await (0, error_js_1.raiseForStatus)(response, "get server info");
         return response.json();
     }
     async batchEndpointIsSupported() {
@@ -582,7 +566,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        await raiseForStatus(response, "create run");
+        await (0, error_js_1.raiseForStatus)(response, "create run", true);
     }
     /**
      * Batch ingest/upsert multiple runs in the Langsmith system.
@@ -682,7 +666,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        await raiseForStatus(response, "batch create run");
+        await (0, error_js_1.raiseForStatus)(response, "batch create run", true);
     }
     async updateRun(runId, run) {
         (0, _uuid_js_1.assertUuid)(runId);
@@ -719,7 +703,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        await raiseForStatus(response, "update run");
+        await (0, error_js_1.raiseForStatus)(response, "update run", true);
     }
     async readRun(runId, { loadChildRuns } = { loadChildRuns: false }) {
         (0, _uuid_js_1.assertUuid)(runId);
@@ -1012,7 +996,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        await raiseForStatus(response, "unshare run");
+        await (0, error_js_1.raiseForStatus)(response, "unshare run", true);
     }
     async readRunSharedLink(runId) {
         (0, _uuid_js_1.assertUuid)(runId);
@@ -1097,7 +1081,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        await raiseForStatus(response, "unshare dataset");
+        await (0, error_js_1.raiseForStatus)(response, "unshare dataset", true);
     }
     async readSharedDataset(shareToken) {
         (0, _uuid_js_1.assertUuid)(shareToken);
@@ -1110,6 +1094,46 @@ class Client {
         const dataset = await response.json();
         return dataset;
     }
+    /**
+     * Get shared examples.
+     *
+     * @param {string} shareToken The share token to get examples for. A share token is the UUID (or LangSmith URL, including UUID) generated when explicitly marking an example as public.
+     * @param {Object} [options] Additional options for listing the examples.
+     * @param {string[] | undefined} [options.exampleIds] A list of example IDs to filter by.
+     * @returns {Promise<Example[]>} The shared examples.
+     */
+    async listSharedExamples(shareToken, options) {
+        const params = {};
+        if (options?.exampleIds) {
+            params.id = options.exampleIds;
+        }
+        const urlParams = new URLSearchParams();
+        Object.entries(params).forEach(([key, value]) => {
+            if (Array.isArray(value)) {
+                value.forEach((v) => urlParams.append(key, v));
+            }
+            else {
+                urlParams.append(key, value);
+            }
+        });
+        const response = await this.caller.call(fetch, `${this.apiUrl}/public/${shareToken}/examples?${urlParams.toString()}`, {
+            method: "GET",
+            headers: this.headers,
+            signal: AbortSignal.timeout(this.timeout_ms),
+            ...this.fetchOptions,
+        });
+        const result = await response.json();
+        if (!response.ok) {
+            if ("detail" in result) {
+                throw new Error(`Failed to list shared examples.\nStatus: ${response.status}\nMessage: ${result.detail.join("\n")}`);
+            }
+            throw new Error(`Failed to list shared examples: ${response.status} ${response.statusText}`);
+        }
+        return result.map((example) => ({
+            ...example,
+            _hostUrl: this.getHostUrl(),
+        }));
+    }
     async createProject({ projectName, description = null, metadata = null, upsert = false, projectExtra = null, referenceDatasetId = null, }) {
         const upsert_ = upsert ? `?upsert=true` : "";
         const endpoint = `${this.apiUrl}/sessions${upsert_}`;
@@ -1132,10 +1156,8 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
+        await (0, error_js_1.raiseForStatus)(response, "create project");
         const result = await response.json();
-        if (!response.ok) {
-            throw new Error(`Failed to create session ${projectName}: ${response.status} ${response.statusText}`);
-        }
         return result;
     }
     async updateProject(projectId, { name = null, description = null, metadata = null, projectExtra = null, endTime = null, }) {
@@ -1157,10 +1179,8 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
+        await (0, error_js_1.raiseForStatus)(response, "update project");
         const result = await response.json();
-        if (!response.ok) {
-            throw new Error(`Failed to update project ${projectId}: ${response.status} ${response.statusText}`);
-        }
         return result;
     }
     async hasProject({ projectId, projectName, }) {
@@ -1316,7 +1336,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        await raiseForStatus(response, `delete session ${projectId_} (${projectName})`);
+        await (0, error_js_1.raiseForStatus)(response, `delete session ${projectId_} (${projectName})`, true);
     }
     async uploadCsv({ csvFile, fileName, inputKeys, outputKeys, description, dataType, name, }) {
         const url = `${this.apiUrl}/datasets/upload`;
@@ -1344,13 +1364,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        if (!response.ok) {
-            const result = await response.json();
-            if (result.detail && result.detail.includes("already exists")) {
-                throw new Error(`Dataset ${fileName} already exists`);
-            }
-            throw new Error(`Failed to upload CSV: ${response.status} ${response.statusText}`);
-        }
+        await (0, error_js_1.raiseForStatus)(response, "upload CSV");
         const result = await response.json();
         return result;
     }
@@ -1375,13 +1389,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        if (!response.ok) {
-            const result = await response.json();
-            if (result.detail && result.detail.includes("already exists")) {
-                throw new Error(`Dataset ${name} already exists`);
-            }
-            throw new Error(`Failed to create dataset ${response.status} ${response.statusText}`);
-        }
+        await (0, error_js_1.raiseForStatus)(response, "create dataset");
         const result = await response.json();
         return result;
     }
@@ -1510,9 +1518,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        if (!response.ok) {
-            throw new Error(`Failed to update dataset ${_datasetId}: ${response.status} ${response.statusText}`);
-        }
+        await (0, error_js_1.raiseForStatus)(response, "update dataset");
         return (await response.json());
     }
     async deleteDataset({ datasetId, datasetName, }) {
@@ -1538,9 +1544,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        if (!response.ok) {
-            throw new Error(`Failed to delete ${path}: ${response.status} ${response.statusText}`);
-        }
+        await (0, error_js_1.raiseForStatus)(response, `delete ${path}`);
         await response.json();
     }
     async indexDataset({ datasetId, datasetName, tag, }) {
@@ -1566,9 +1570,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        if (!response.ok) {
-            throw new Error(`Failed to index dataset ${datasetId_}: ${response.status} ${response.statusText}`);
-        }
+        await (0, error_js_1.raiseForStatus)(response, "index dataset");
         await response.json();
     }
     /**
@@ -1607,9 +1609,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        if (!response.ok) {
-            throw new Error(`Failed to fetch similar examples: ${response.status} ${response.statusText}`);
-        }
+        await (0, error_js_1.raiseForStatus)(response, "fetch similar examples");
         const result = await response.json();
         return result["examples"];
     }
@@ -1642,9 +1642,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        if (!response.ok) {
-            throw new Error(`Failed to create example: ${response.status} ${response.statusText}`);
-        }
+        await (0, error_js_1.raiseForStatus)(response, "create example");
         const result = await response.json();
         return result;
     }
@@ -1679,9 +1677,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        if (!response.ok) {
-            throw new Error(`Failed to create examples: ${response.status} ${response.statusText}`);
-        }
+        await (0, error_js_1.raiseForStatus)(response, "create examples");
         const result = await response.json();
         return result;
     }
@@ -1774,9 +1770,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        if (!response.ok) {
-            throw new Error(`Failed to delete ${path}: ${response.status} ${response.statusText}`);
-        }
+        await (0, error_js_1.raiseForStatus)(response, `delete ${path}`);
         await response.json();
     }
     async updateExample(exampleId, update) {
@@ -1788,9 +1782,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        if (!response.ok) {
-            throw new Error(`Failed to update example ${exampleId}: ${response.status} ${response.statusText}`);
-        }
+        await (0, error_js_1.raiseForStatus)(response, "update example");
         const result = await response.json();
         return result;
     }
@@ -1802,9 +1794,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        if (!response.ok) {
-            throw new Error(`Failed to update examples: ${response.status} ${response.statusText}`);
-        }
+        await (0, error_js_1.raiseForStatus)(response, "update examples");
         const result = await response.json();
         return result;
     }
@@ -1867,7 +1857,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        await raiseForStatus(response, "update dataset splits");
+        await (0, error_js_1.raiseForStatus)(response, "update dataset splits", true);
     }
     /**
      * @deprecated This method is deprecated and will be removed in future LangSmith versions, use `evaluate` from `langsmith/evaluation` instead.
@@ -1933,7 +1923,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        await raiseForStatus(response, "create feedback");
+        await (0, error_js_1.raiseForStatus)(response, "create feedback", true);
         return feedback;
     }
     async updateFeedback(feedbackId, { score, value, correction, comment, }) {
@@ -1958,7 +1948,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        await raiseForStatus(response, "update feedback");
+        await (0, error_js_1.raiseForStatus)(response, "update feedback", true);
     }
     async readFeedback(feedbackId) {
         (0, _uuid_js_1.assertUuid)(feedbackId);
@@ -1975,9 +1965,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        if (!response.ok) {
-            throw new Error(`Failed to delete ${path}: ${response.status} ${response.statusText}`);
-        }
+        await (0, error_js_1.raiseForStatus)(response, `delete ${path}`);
         await response.json();
     }
     async *listFeedback({ runIds, feedbackKeys, feedbackSourceTypes, } = {}) {
@@ -2170,9 +2158,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        if (!response.ok) {
-            throw new Error(`Failed to ${like ? "like" : "unlike"} prompt: ${response.status} ${await response.text()}`);
-        }
+        await (0, error_js_1.raiseForStatus)(response, `${like ? "like" : "unlike"} prompt`);
         return await response.json();
     }
     async _getPromptUrl(promptIdentifier) {
@@ -2236,9 +2222,7 @@ class Client {
         if (response.status === 404) {
             return null;
         }
-        if (!response.ok) {
-            throw new Error(`Failed to get prompt: ${response.status} ${await response.text()}`);
-        }
+        await (0, error_js_1.raiseForStatus)(response, "get prompt");
         const result = await response.json();
         if (result.repo) {
             return result.repo;
@@ -2273,9 +2257,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        if (!response.ok) {
-            throw new Error(`Failed to create prompt: ${response.status} ${await response.text()}`);
-        }
+        await (0, error_js_1.raiseForStatus)(response, "create prompt");
         const { repo } = await response.json();
         return repo;
     }
@@ -2298,9 +2280,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        if (!response.ok) {
-            throw new Error(`Failed to create commit: ${response.status} ${await response.text()}`);
-        }
+        await (0, error_js_1.raiseForStatus)(response, "create commit");
         const result = await response.json();
         return this._getPromptUrl(`${owner}/${promptName}${result.commit_hash ? `:${result.commit_hash}` : ""}`);
     }
@@ -2337,9 +2317,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        if (!response.ok) {
-            throw new Error(`HTTP Error: ${response.status} - ${await response.text()}`);
-        }
+        await (0, error_js_1.raiseForStatus)(response, "update prompt");
         return response.json();
     }
     async deletePrompt(promptIdentifier) {
@@ -2378,9 +2356,7 @@ class Client {
             signal: AbortSignal.timeout(this.timeout_ms),
             ...this.fetchOptions,
         });
-        if (!response.ok) {
-            throw new Error(`Failed to pull prompt commit: ${response.status} ${response.statusText}`);
-        }
+        await (0, error_js_1.raiseForStatus)(response, "pull prompt commit");
         const result = await response.json();
         return {
             owner,
@@ -2433,5 +2409,86 @@ class Client {
         });
         return url;
     }
+    /**
+     * Clone a public dataset to your own langsmith tenant.
+     * This operation is idempotent. If you already have a dataset with the given name,
+     * this function will do nothing.
+  
+     * @param {string} tokenOrUrl The token of the public dataset to clone.
+     * @param {Object} [options] Additional options for cloning the dataset.
+     * @param {string} [options.sourceApiUrl] The URL of the langsmith server where the data is hosted. Defaults to the API URL of your current client.
+     * @param {string} [options.datasetName] The name of the dataset to create in your tenant. Defaults to the name of the public dataset.
+     * @returns {Promise<void>}
+     */
+    async clonePublicDataset(tokenOrUrl, options = {}) {
+        const { sourceApiUrl = this.apiUrl, datasetName } = options;
+        const [parsedApiUrl, tokenUuid] = this.parseTokenOrUrl(tokenOrUrl, sourceApiUrl);
+        const sourceClient = new Client({
+            apiUrl: parsedApiUrl,
+            // Placeholder API key not needed anymore in most cases, but
+            // some private deployments may have API key-based rate limiting
+            // that would cause this to fail if we provide no value.
+            apiKey: "placeholder",
+        });
+        const ds = await sourceClient.readSharedDataset(tokenUuid);
+        const finalDatasetName = datasetName || ds.name;
+        try {
+            if (await this.hasDataset({ datasetId: finalDatasetName })) {
+                console.log(`Dataset ${finalDatasetName} already exists in your tenant. Skipping.`);
+                return;
+            }
+        }
+        catch (_) {
+            // `.hasDataset` will throw an error if the dataset does not exist.
+            // no-op in that case
+        }
+        // Fetch examples first, then create the dataset
+        const examples = await sourceClient.listSharedExamples(tokenUuid);
+        const dataset = await this.createDataset(finalDatasetName, {
+            description: ds.description,
+            dataType: ds.data_type || "kv",
+            inputsSchema: ds.inputs_schema_definition ?? undefined,
+            outputsSchema: ds.outputs_schema_definition ?? undefined,
+        });
+        try {
+            await this.createExamples({
+                inputs: examples.map((e) => e.inputs),
+                outputs: examples.flatMap((e) => (e.outputs ? [e.outputs] : [])),
+                datasetId: dataset.id,
+            });
+        }
+        catch (e) {
+            console.error(`An error occurred while creating dataset ${finalDatasetName}. ` +
+                "You should delete it manually.");
+            throw e;
+        }
+    }
+    parseTokenOrUrl(urlOrToken, apiUrl, numParts = 2, kind = "dataset") {
+        // Try parsing as UUID
+        try {
+            (0, _uuid_js_1.assertUuid)(urlOrToken); // Will throw if it's not a UUID.
+            return [apiUrl, urlOrToken];
+        }
+        catch (_) {
+            // no-op if it's not a uuid
+        }
+        // Parse as URL
+        try {
+            const parsedUrl = new URL(urlOrToken);
+            const pathParts = parsedUrl.pathname
+                .split("/")
+                .filter((part) => part !== "");
+            if (pathParts.length >= numParts) {
+                const tokenUuid = pathParts[pathParts.length - numParts];
+                return [apiUrl, tokenUuid];
+            }
+            else {
+                throw new Error(`Invalid public ${kind} URL: ${urlOrToken}`);
+            }
+        }
+        catch (error) {
+            throw new Error(`Invalid public ${kind} URL or token: ${urlOrToken}`);
+        }
+    }
 }
 exports.Client = Client;

package/dist/client.d.ts

@@ -1,7 +1,7 @@
 import { AsyncCallerParams } from "./utils/async_caller.js";
 import { ComparativeExperiment, DataType, Dataset, DatasetDiffInfo, DatasetShareSchema, Example, ExampleUpdate, ExampleUpdateWithId, Feedback, FeedbackConfig, FeedbackIngestToken, KVMap, LangChainBaseMessage, LangSmithSettings, LikePromptResponse, Prompt, PromptCommit, PromptSortField, Run, RunCreate, RunUpdate, ScoreType, ExampleSearch, TimeDelta, TracerSession, TracerSessionResult, ValueType } from "./schemas.js";
 import { EvaluationResult, EvaluationResults, RunEvaluator } from "./evaluation/evaluator.js";
-interface ClientConfig {
+export interface ClientConfig {
     apiUrl?: string;
     apiKey?: string;
     callerOptions?: AsyncCallerParams;
@@ -332,6 +332,17 @@ export declare class Client {
     shareDataset(datasetId?: string, datasetName?: string): Promise<DatasetShareSchema>;
     unshareDataset(datasetId: string): Promise<void>;
     readSharedDataset(shareToken: string): Promise<Dataset>;
+    /**
+     * Get shared examples.
+     *
+     * @param {string} shareToken The share token to get examples for. A share token is the UUID (or LangSmith URL, including UUID) generated when explicitly marking an example as public.
+     * @param {Object} [options] Additional options for listing the examples.
+     * @param {string[] | undefined} [options.exampleIds] A list of example IDs to filter by.
+     * @returns {Promise<Example[]>} The shared examples.
+     */
+    listSharedExamples(shareToken: string, options?: {
+        exampleIds?: string[];
+    }): Promise<Example[]>;
     createProject({ projectName, description, metadata, upsert, projectExtra, referenceDatasetId, }: {
         projectName: string;
         description?: string | null;
@@ -625,5 +636,21 @@ export declare class Client {
         readme?: string;
         tags?: string[];
     }): Promise<string>;
+    /**
+     * Clone a public dataset to your own langsmith tenant.
+     * This operation is idempotent. If you already have a dataset with the given name,
+     * this function will do nothing.
+  
+     * @param {string} tokenOrUrl The token of the public dataset to clone.
+     * @param {Object} [options] Additional options for cloning the dataset.
+     * @param {string} [options.sourceApiUrl] The URL of the langsmith server where the data is hosted. Defaults to the API URL of your current client.
+     * @param {string} [options.datasetName] The name of the dataset to create in your tenant. Defaults to the name of the public dataset.
+     * @returns {Promise<void>}
+     */
+    clonePublicDataset(tokenOrUrl: string, options?: {
+        sourceApiUrl?: string;
+        datasetName?: string;
+    }): Promise<void>;
+    private parseTokenOrUrl;
 }
 export {};