langsmith 0.7.4 → 0.7.5

package/dist/client.cjs

@@ -4103,6 +4103,23 @@ class Client {
         }
         return json.commits[0].commit_hash;
     }
+    async _createCommitTags(promptOwnerAndName, commitId, tags) {
+        const tagList = typeof tags === "string" ? [tags] : tags;
+        await Promise.all(tagList.map(async (tag) => this.caller.call(async () => {
+            const res = await this._fetch(`${this.apiUrl}/repos/${promptOwnerAndName}/tags`, {
+                method: "POST",
+                headers: {
+                    ...this._mergedHeaders,
+                    "Content-Type": "application/json",
+                },
+                signal: AbortSignal.timeout(this.timeout_ms),
+                ...this.fetchOptions,
+                body: JSON.stringify({ tag_name: tag, commit_id: commitId }),
+            });
+            await (0, error_js_1.raiseForStatus)(res, "create commit tag");
+            return res;
+        })));
+    }
     async _likeOrUnlikePrompt(promptIdentifier, like) {
         const [owner, promptName, _] = (0, prompts_js_1.parseHubIdentifier)(promptIdentifier);
         const body = JSON.stringify({ like: like });
@@ -4369,6 +4386,8 @@ class Client {
      * @param object - The prompt object/manifest to commit (e.g., ChatPromptTemplate, messages array, etc.)
      * @param options - Optional configuration for the commit
      * @param options.parentCommitHash - The parent commit hash. Defaults to "latest" (the most recent commit).
+     * @param options.tags - A tag or list of tags to apply to the commit.
+     * @param options.description - A description for the commit.
      * @returns A Promise that resolves to the URL of the newly created commit
      * @throws {Error} If the prompt does not exist
      * @example
@@ -4384,9 +4403,9 @@ class Client {
      * const commitUrl = await client.createCommit("my-prompt", template);
      * console.log(`Commit created: ${commitUrl}`);
      *
-     * // Create a commit based on a specific parent commit
+     * // Create a commit with tags
      * const commitUrl2 = await client.createCommit("my-prompt", template, {
-     *   parentCommitHash: "abc123def456"
+     *   tags: ["production", "v1"]
      * });
      * ```
      */
@@ -4421,7 +4440,11 @@ class Client {
             return res;
         });
         const result = await response.json();
-        return this._getPromptUrl(`${owner}/${promptName}${result.commit_hash ? `:${result.commit_hash}` : ""}`);
+        const commit = result.commit ?? result;
+        if (options?.tags) {
+            await this._createCommitTags(`${owner}/${promptName}`, commit.id, options.tags);
+        }
+        return this._getPromptUrl(`${owner}/${promptName}${commit.commit_hash ? `:${commit.commit_hash}` : ""}`);
     }
     /**
      * Update examples with attachments using multipart form data.
@@ -4756,7 +4779,8 @@ class Client {
     async pushPrompt(promptIdentifier, options) {
         // Create or update prompt metadata
         if (await this.promptExists(promptIdentifier)) {
-            if (options && Object.keys(options).some((key) => key !== "object")) {
+            if (options &&
+                ["description", "readme", "tags", "isPublic"].some((key) => options[key] !== undefined)) {
                 await this.updatePrompt(promptIdentifier, {
                     description: options?.description,
                     readme: options?.readme,
@@ -4779,6 +4803,7 @@ class Client {
         // Create a commit with the new manifest
         const url = await this.createCommit(promptIdentifier, options?.object, {
             parentCommitHash: options?.parentCommitHash,
+            tags: options?.commitTags,
             description: options?.commitDescription,
         });
         return url;

package/dist/client.d.ts

@@ -1129,6 +1129,7 @@ export declare class Client implements LangSmithTracingClientInterface {
     protected _currentTenantIsOwner(owner: string): Promise<boolean>;
     protected _ownerConflictError(action: string, owner: string): Promise<Error>;
     protected _getLatestCommitHash(promptOwnerAndName: string): Promise<string | undefined>;
+    protected _createCommitTags(promptOwnerAndName: string, commitId: string, tags: string | string[]): Promise<void>;
     protected _likeOrUnlikePrompt(promptIdentifier: string, like: boolean): Promise<LikePromptResponse>;
     protected _getPromptUrl(promptIdentifier: string): Promise<string>;
     /**
@@ -1287,6 +1288,8 @@ export declare class Client implements LangSmithTracingClientInterface {
      * @param object - The prompt object/manifest to commit (e.g., ChatPromptTemplate, messages array, etc.)
      * @param options - Optional configuration for the commit
      * @param options.parentCommitHash - The parent commit hash. Defaults to "latest" (the most recent commit).
+     * @param options.tags - A tag or list of tags to apply to the commit.
+     * @param options.description - A description for the commit.
      * @returns A Promise that resolves to the URL of the newly created commit
      * @throws {Error} If the prompt does not exist
      * @example
@@ -1302,14 +1305,15 @@ export declare class Client implements LangSmithTracingClientInterface {
      * const commitUrl = await client.createCommit("my-prompt", template);
      * console.log(`Commit created: ${commitUrl}`);
      *
-     * // Create a commit based on a specific parent commit
+     * // Create a commit with tags
      * const commitUrl2 = await client.createCommit("my-prompt", template, {
-     *   parentCommitHash: "abc123def456"
+     *   tags: ["production", "v1"]
      * });
      * ```
      */
     createCommit(promptIdentifier: string, object: any, options?: {
         parentCommitHash?: string;
+        tags?: string | string[];
         description?: string;
     }): Promise<string>;
     /**
@@ -1413,6 +1417,7 @@ export declare class Client implements LangSmithTracingClientInterface {
         description?: string;
         readme?: string;
         tags?: string[];
+        commitTags?: string | string[];
         commitDescription?: string;
     }): Promise<string>;
     /**

package/dist/client.js

@@ -4065,6 +4065,23 @@ export class Client {
         }
         return json.commits[0].commit_hash;
     }
+    async _createCommitTags(promptOwnerAndName, commitId, tags) {
+        const tagList = typeof tags === "string" ? [tags] : tags;
+        await Promise.all(tagList.map(async (tag) => this.caller.call(async () => {
+            const res = await this._fetch(`${this.apiUrl}/repos/${promptOwnerAndName}/tags`, {
+                method: "POST",
+                headers: {
+                    ...this._mergedHeaders,
+                    "Content-Type": "application/json",
+                },
+                signal: AbortSignal.timeout(this.timeout_ms),
+                ...this.fetchOptions,
+                body: JSON.stringify({ tag_name: tag, commit_id: commitId }),
+            });
+            await raiseForStatus(res, "create commit tag");
+            return res;
+        })));
+    }
     async _likeOrUnlikePrompt(promptIdentifier, like) {
         const [owner, promptName, _] = parseHubIdentifier(promptIdentifier);
         const body = JSON.stringify({ like: like });
@@ -4331,6 +4348,8 @@ export class Client {
      * @param object - The prompt object/manifest to commit (e.g., ChatPromptTemplate, messages array, etc.)
      * @param options - Optional configuration for the commit
      * @param options.parentCommitHash - The parent commit hash. Defaults to "latest" (the most recent commit).
+     * @param options.tags - A tag or list of tags to apply to the commit.
+     * @param options.description - A description for the commit.
      * @returns A Promise that resolves to the URL of the newly created commit
      * @throws {Error} If the prompt does not exist
      * @example
@@ -4346,9 +4365,9 @@ export class Client {
      * const commitUrl = await client.createCommit("my-prompt", template);
      * console.log(`Commit created: ${commitUrl}`);
      *
-     * // Create a commit based on a specific parent commit
+     * // Create a commit with tags
      * const commitUrl2 = await client.createCommit("my-prompt", template, {
-     *   parentCommitHash: "abc123def456"
+     *   tags: ["production", "v1"]
      * });
      * ```
      */
@@ -4383,7 +4402,11 @@ export class Client {
             return res;
         });
         const result = await response.json();
-        return this._getPromptUrl(`${owner}/${promptName}${result.commit_hash ? `:${result.commit_hash}` : ""}`);
+        const commit = result.commit ?? result;
+        if (options?.tags) {
+            await this._createCommitTags(`${owner}/${promptName}`, commit.id, options.tags);
+        }
+        return this._getPromptUrl(`${owner}/${promptName}${commit.commit_hash ? `:${commit.commit_hash}` : ""}`);
     }
     /**
      * Update examples with attachments using multipart form data.
@@ -4718,7 +4741,8 @@ export class Client {
     async pushPrompt(promptIdentifier, options) {
         // Create or update prompt metadata
         if (await this.promptExists(promptIdentifier)) {
-            if (options && Object.keys(options).some((key) => key !== "object")) {
+            if (options &&
+                ["description", "readme", "tags", "isPublic"].some((key) => options[key] !== undefined)) {
                 await this.updatePrompt(promptIdentifier, {
                     description: options?.description,
                     readme: options?.readme,
@@ -4741,6 +4765,7 @@ export class Client {
         // Create a commit with the new manifest
         const url = await this.createCommit(promptIdentifier, options?.object, {
             parentCommitHash: options?.parentCommitHash,
+            tags: options?.commitTags,
             description: options?.commitDescription,
         });
         return url;

package/dist/evaluation/evaluate_comparative.cjs

@@ -224,5 +224,5 @@ async function evaluateComparative(experiments, options) {
     });
     const results = await Promise.all(promises);
     await client.awaitPendingTraceBatches();
-    return { experimentName, results };
+    return { experimentName, results, url: viewUrl, comparativeExperiment };
 }

package/dist/evaluation/evaluate_comparative.d.ts

@@ -1,5 +1,5 @@
 import { Client } from "../index.js";
-import { ComparisonEvaluationResult as ComparisonEvaluationResultRow, Example, Run } from "../schemas.js";
+import { ComparativeExperiment, ComparisonEvaluationResult as ComparisonEvaluationResultRow, Example, Run } from "../schemas.js";
 import { evaluate } from "./index.js";
 type ExperimentResults = Awaited<ReturnType<typeof evaluate>>;
 /** @deprecated Use ComparativeEvaluatorNew instead: (args: { runs, example, inputs, outputs, referenceOutputs }) => ... */
@@ -54,8 +54,14 @@ export interface EvaluateComparativeOptions {
     maxConcurrency?: number;
 }
 export interface ComparisonEvaluationResults {
+    /** The name of the comparative experiment. */
     experimentName: string;
+    /** The per-example comparison results. */
     results: ComparisonEvaluationResultRow[];
+    /** URL of the pairwise comparison view in the LangSmith UI, if available. */
+    url: string | null;
+    /** The comparative experiment, exposing its id, dataset, and metadata. */
+    comparativeExperiment: ComparativeExperiment;
 }
 /** @deprecated Use `evaluate` and pass two experiments as targets. */
 export declare function evaluateComparative(experiments: Array<string> | Array<Promise<ExperimentResults> | ExperimentResults>, options: EvaluateComparativeOptions): Promise<ComparisonEvaluationResults>;

package/dist/evaluation/evaluate_comparative.js

@@ -218,5 +218,5 @@ export async function evaluateComparative(experiments, options) {
     });
     const results = await Promise.all(promises);
     await client.awaitPendingTraceBatches();
-    return { experimentName, results };
+    return { experimentName, results, url: viewUrl, comparativeExperiment };
 }

package/dist/index.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.__version__ = exports.promptCacheSingleton = exports.configureGlobalPromptCache = exports.PromptCache = exports.Cache = exports.uuid7FromTime = exports.uuid7 = exports.getDefaultProjectName = exports.overrideFetchImplementation = exports.RunTree = exports.Client = void 0;
+exports.LS_MESSAGE_VIEW_EXCLUDE = exports.__version__ = exports.promptCacheSingleton = exports.configureGlobalPromptCache = exports.PromptCache = exports.Cache = exports.uuid7FromTime = exports.uuid7 = exports.getDefaultProjectName = exports.overrideFetchImplementation = exports.RunTree = exports.Client = void 0;
 var client_js_1 = require("./client.cjs");
 Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return client_js_1.Client; } });
 var run_trees_js_1 = require("./run_trees.cjs");
@@ -18,4 +18,6 @@ Object.defineProperty(exports, "PromptCache", { enumerable: true, get: function
 Object.defineProperty(exports, "configureGlobalPromptCache", { enumerable: true, get: function () { return index_js_1.configureGlobalPromptCache; } });
 Object.defineProperty(exports, "promptCacheSingleton", { enumerable: true, get: function () { return index_js_1.promptCacheSingleton; } });
 // Update using pnpm bump-version
-exports.__version__ = "0.7.4";
+exports.__version__ = "0.7.5";
+// Metadata key to hide a traced run from LangSmith's Messages View.
+exports.LS_MESSAGE_VIEW_EXCLUDE = "ls_message_view_exclude";

package/dist/index.d.ts

@@ -5,4 +5,5 @@ export { overrideFetchImplementation } from "./singletons/fetch.js";
 export { getDefaultProjectName } from "./utils/project.js";
 export { uuid7, uuid7FromTime } from "./uuid.js";
 export { Cache, PromptCache, type CacheConfig, type CacheMetrics, configureGlobalPromptCache, promptCacheSingleton, } from "./utils/prompt_cache/index.js";
-export declare const __version__ = "0.7.4";
+export declare const __version__ = "0.7.5";
+export declare const LS_MESSAGE_VIEW_EXCLUDE: "ls_message_view_exclude";

package/dist/index.js

@@ -5,4 +5,6 @@ export { getDefaultProjectName } from "./utils/project.js";
 export { uuid7, uuid7FromTime } from "./uuid.js";
 export { Cache, PromptCache, configureGlobalPromptCache, promptCacheSingleton, } from "./utils/prompt_cache/index.js";
 // Update using pnpm bump-version
-export const __version__ = "0.7.4";
+export const __version__ = "0.7.5";
+// Metadata key to hide a traced run from LangSmith's Messages View.
+export const LS_MESSAGE_VIEW_EXCLUDE = "ls_message_view_exclude";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "langsmith",
-  "version": "0.7.4",
+  "version": "0.7.5",
   "description": "Client library to connect to the LangSmith Observability and Evaluation Platform.",
   "packageManager": "pnpm@10.33.0",
   "files": [