langsmith 0.0.31 → 0.0.33

package/dist/schemas.d.ts

@@ -26,32 +26,75 @@ export interface BaseExample {
     inputs: KVMap;
     outputs?: KVMap;
 }
+/**
+ * A run can represent either a trace (root run)
+ * or a child run (~span).
+ */
 export interface BaseRun {
+    /** Optionally, a unique identifier for the run. */
     id?: string;
+    /** A human-readable name for the run. */
     name: string;
-    serialized?: object;
-    inputs: KVMap;
-    run_type: string;
+    /** Defines the sequence in which the run was executed. */
+    execution_order?: number;
+    /** The epoch time at which the run started, if available. */
     start_time?: number;
+    /** Specifies the type of run (tool, chain, llm, etc.). */
+    run_type: string;
+    /** The epoch time at which the run ended, if applicable. */
     end_time?: number;
+    /** Any additional metadata or settings for the run. */
     extra?: KVMap;
+    /** Error message, captured if the run faces any issues. */
     error?: string;
-    execution_order?: number;
+    /** Serialized state of the run for potential future use. */
+    serialized?: object;
+    /** Events like 'start', 'end' linked to the run. */
+    events?: KVMap[];
+    /** Inputs that were used to initiate the run. */
+    inputs: KVMap;
+    /** Outputs produced by the run, if any. */
     outputs?: KVMap;
+    /** ID of an example that might be related to this run. */
     reference_example_id?: string;
+    /** ID of a parent run, if this run is part of a larger operation. */
     parent_run_id?: string;
-    events?: KVMap[];
+    /** Tags for further categorizing or annotating the run. */
     tags?: string[];
 }
+/**
+ * Describes properties of a run when loaded from the database.
+ * Extends the BaseRun interface.
+ */
 export interface Run extends BaseRun {
+    /** A unique identifier for the run, mandatory when loaded from DB. */
     id: string;
-    session_id?: string;
+    /** Defines the sequence in which the run was executed. */
     execution_order: number;
-    start_time: number;
+    /** The ID of the project that owns this run. */
+    session_id?: string;
+    /** IDs of any child runs spawned by this run. */
     child_run_ids?: string[];
-    feedback_stats?: KVMap;
+    /** Child runs, loaded explicitly via a heavier query. */
     child_runs?: Run[];
+    /** Stats capturing feedback for this run. */
+    feedback_stats?: KVMap;
+    /** The URL path where this run is accessible within the app. */
     app_path?: string;
+    /** The manifest ID that correlates with this run. */
+    manifest_id?: string;
+    /** The current status of the run, such as 'success'. */
+    status?: string;
+    /** Number of tokens used in the prompt. */
+    prompt_tokens?: number;
+    /** Number of tokens generated in the completion. */
+    completion_tokens?: number;
+    /** Total token count, combining prompt and completion. */
+    total_tokens?: number;
+    /** Time when the first token was processed. */
+    first_token_time?: number;
+    /** IDs of parent runs, if multiple exist. */
+    parent_run_ids?: string[];
 }
 export interface RunCreate extends BaseRun {
     child_runs?: this[];
@@ -61,6 +104,7 @@ export interface RunUpdate {
     end_time?: number;
     extra?: KVMap;
     error?: string;
+    inputs?: KVMap;
     outputs?: KVMap;
     parent_run_id?: string;
     reference_example_id?: string;

package/dist/utils/env.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setEnvironmentVariable = exports.getEnvironmentVariable = exports.getRuntimeEnvironment = exports.getEnv = exports.isNode = exports.isDeno = exports.isJsDom = exports.isWebWorker = exports.isBrowser = void 0;
+exports.getShas = exports.setEnvironmentVariable = exports.getEnvironmentVariable = exports.getRuntimeEnvironment = exports.getEnv = exports.isNode = exports.isDeno = exports.isJsDom = exports.isWebWorker = exports.isBrowser = void 0;
 const isBrowser = () => typeof window !== "undefined" && typeof window.document !== "undefined";
 exports.isBrowser = isBrowser;
 const isWebWorker = () => typeof globalThis === "object" &&
@@ -49,9 +49,11 @@ let runtimeEnvironment;
 async function getRuntimeEnvironment() {
     if (runtimeEnvironment === undefined) {
         const env = (0, exports.getEnv)();
+        const releaseEnv = getShas();
         runtimeEnvironment = {
             library: "langsmith",
             runtime: env,
+            ...releaseEnv,
         };
     }
     return runtimeEnvironment;
@@ -78,3 +80,45 @@ function setEnvironmentVariable(name, value) {
     }
 }
 exports.setEnvironmentVariable = setEnvironmentVariable;
+let cachedCommitSHAs;
+/**
+ * Get the Git commit SHA from common environment variables
+ * used by different CI/CD platforms.
+ * @returns {string | undefined} The Git commit SHA or undefined if not found.
+ */
+function getShas() {
+    if (cachedCommitSHAs !== undefined) {
+        return cachedCommitSHAs;
+    }
+    const common_release_envs = [
+        "VERCEL_GIT_COMMIT_SHA",
+        "NEXT_PUBLIC_VERCEL_GIT_COMMIT_SHA",
+        "COMMIT_REF",
+        "RENDER_GIT_COMMIT",
+        "CI_COMMIT_SHA",
+        "CIRCLE_SHA1",
+        "CF_PAGES_COMMIT_SHA",
+        "REACT_APP_GIT_SHA",
+        "SOURCE_VERSION",
+        "GITHUB_SHA",
+        "TRAVIS_COMMIT",
+        "GIT_COMMIT",
+        "BUILD_VCS_NUMBER",
+        "bamboo_planRepository_revision",
+        "Build.SourceVersion",
+        "BITBUCKET_COMMIT",
+        "DRONE_COMMIT_SHA",
+        "SEMAPHORE_GIT_SHA",
+        "BUILDKITE_COMMIT",
+    ];
+    const shas = {};
+    for (const env of common_release_envs) {
+        const envVar = getEnvironmentVariable(env);
+        if (envVar !== undefined) {
+            shas[env] = envVar;
+        }
+    }
+    cachedCommitSHAs = shas;
+    return shas;
+}
+exports.getShas = getShas;

package/dist/utils/env.d.ts

@@ -20,3 +20,13 @@ export type RuntimeEnvironment = {
 export declare function getRuntimeEnvironment(): Promise<RuntimeEnvironment>;
 export declare function getEnvironmentVariable(name: string): string | undefined;
 export declare function setEnvironmentVariable(name: string, value: string): void;
+interface ICommitSHAs {
+    [key: string]: string;
+}
+/**
+ * Get the Git commit SHA from common environment variables
+ * used by different CI/CD platforms.
+ * @returns {string | undefined} The Git commit SHA or undefined if not found.
+ */
+export declare function getShas(): ICommitSHAs;
+export {};

package/dist/utils/env.js

@@ -40,9 +40,11 @@ let runtimeEnvironment;
 export async function getRuntimeEnvironment() {
     if (runtimeEnvironment === undefined) {
         const env = getEnv();
+        const releaseEnv = getShas();
         runtimeEnvironment = {
             library: "langsmith",
             runtime: env,
+            ...releaseEnv,
         };
     }
     return runtimeEnvironment;
@@ -66,3 +68,44 @@ export function setEnvironmentVariable(name, value) {
         process.env[name] = value;
     }
 }
+let cachedCommitSHAs;
+/**
+ * Get the Git commit SHA from common environment variables
+ * used by different CI/CD platforms.
+ * @returns {string | undefined} The Git commit SHA or undefined if not found.
+ */
+export function getShas() {
+    if (cachedCommitSHAs !== undefined) {
+        return cachedCommitSHAs;
+    }
+    const common_release_envs = [
+        "VERCEL_GIT_COMMIT_SHA",
+        "NEXT_PUBLIC_VERCEL_GIT_COMMIT_SHA",
+        "COMMIT_REF",
+        "RENDER_GIT_COMMIT",
+        "CI_COMMIT_SHA",
+        "CIRCLE_SHA1",
+        "CF_PAGES_COMMIT_SHA",
+        "REACT_APP_GIT_SHA",
+        "SOURCE_VERSION",
+        "GITHUB_SHA",
+        "TRAVIS_COMMIT",
+        "GIT_COMMIT",
+        "BUILD_VCS_NUMBER",
+        "bamboo_planRepository_revision",
+        "Build.SourceVersion",
+        "BITBUCKET_COMMIT",
+        "DRONE_COMMIT_SHA",
+        "SEMAPHORE_GIT_SHA",
+        "BUILDKITE_COMMIT",
+    ];
+    const shas = {};
+    for (const env of common_release_envs) {
+        const envVar = getEnvironmentVariable(env);
+        if (envVar !== undefined) {
+            shas[env] = envVar;
+        }
+    }
+    cachedCommitSHAs = shas;
+    return shas;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "langsmith",
-  "version": "0.0.31",
+  "version": "0.0.33",
   "description": "Client library to connect to the LangSmith LLM Tracing and Evaluation Platform.",
   "files": [
     "dist/",