langsmith 0.2.12 → 0.2.14-beta.0

package/dist/client.cjs

@@ -308,6 +308,12 @@ class Client {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "manualFlushMode", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
         const defaultConfig = Client.getDefaultClientConfig();
         this.tracingSampleRate = getTracingSamplingRate();
         this.apiUrl = trimQuotes(config.apiUrl ?? defaultConfig.apiUrl) ?? "";
@@ -341,6 +347,7 @@ class Client {
             config.blockOnRootRunFinalization ?? this.blockOnRootRunFinalization;
         this.batchSizeBytesLimit = config.batchSizeBytesLimit;
         this.fetchOptions = config.fetchOptions || {};
+        this.manualFlushMode = config.manualFlushMode ?? this.manualFlushMode;
     }
     static getDefaultClientConfig() {
         const apiKey = (0, env_js_1.getLangSmithEnvironmentVariable)("API_KEY");
@@ -538,14 +545,17 @@ class Client {
         return (serverInfo.instance_flags?.dataset_examples_multipart_enabled ?? false);
     }
     drainAutoBatchQueue(batchSizeLimit) {
+        const promises = [];
         while (this.autoBatchQueue.items.length > 0) {
             const [batch, done] = this.autoBatchQueue.pop(batchSizeLimit);
             if (!batch.length) {
                 done();
                 break;
             }
-            void this._processBatch(batch, done).catch(console.error);
+            const batchPromise = this._processBatch(batch, done).catch(console.error);
+            promises.push(batchPromise);
         }
+        return Promise.all(promises);
     }
     async _processBatch(batch, done) {
         if (!batch.length) {
@@ -580,14 +590,18 @@ class Client {
             item.item = mergeRuntimeEnvIntoRunCreate(item.item);
         }
         const itemPromise = this.autoBatchQueue.push(item);
+        if (this.manualFlushMode) {
+            // Rely on manual flushing in serverless environments
+            return itemPromise;
+        }
         const sizeLimitBytes = await this._getBatchSizeLimitBytes();
         if (this.autoBatchQueue.sizeBytes > sizeLimitBytes) {
-            this.drainAutoBatchQueue(sizeLimitBytes);
+            void this.drainAutoBatchQueue(sizeLimitBytes);
         }
         if (this.autoBatchQueue.items.length > 0) {
             this.autoBatchTimeout = setTimeout(() => {
                 this.autoBatchTimeout = undefined;
-                this.drainAutoBatchQueue(sizeLimitBytes);
+                void this.drainAutoBatchQueue(sizeLimitBytes);
             }, this.autoBatchAggregationDelayMs);
         }
         return itemPromise;
@@ -629,6 +643,13 @@ class Client {
         }
         return await this.settings;
     }
+    /**
+     * Flushes current queued traces.
+     */
+    async flush() {
+        const sizeLimitBytes = await this._getBatchSizeLimitBytes();
+        await this.drainAutoBatchQueue(sizeLimitBytes);
+    }
     async createRun(run) {
         if (!this._filterForSampling([run]).length) {
             return;
@@ -834,7 +855,16 @@ class Client {
                     const attachments = allAttachments[payload.id];
                     if (attachments) {
                         delete allAttachments[payload.id];
-                        for (const [name, [contentType, content]] of Object.entries(attachments)) {
+                        for (const [name, attachment] of Object.entries(attachments)) {
+                            let contentType;
+                            let content;
+                            if (Array.isArray(attachment)) {
+                                [contentType, content] = attachment;
+                            }
+                            else {
+                                contentType = attachment.mimeType;
+                                content = attachment.data;
+                            }
                             // Validate that the attachment name doesn't contain a '.'
                             if (name.includes(".")) {
                                 console.warn(`Skipping attachment '${name}' for run ${payload.id}: Invalid attachment name. ` +
@@ -912,7 +942,8 @@ class Client {
             data.dotted_order !== undefined) {
             if (run.end_time !== undefined &&
                 data.parent_run_id === undefined &&
-                this.blockOnRootRunFinalization) {
+                this.blockOnRootRunFinalization &&
+                !this.manualFlushMode) {
                 // Trigger batches as soon as a root trace ends and wait to ensure trace finishes
                 // in serverless environments.
                 await this.processRunOperation({ action: "update", item: data }).catch(console.error);
@@ -1948,7 +1979,7 @@ class Client {
         if (attachment_urls) {
             // add attachments back to the example
             example.attachments = Object.entries(attachment_urls).reduce((acc, [key, value]) => {
-                acc[key] = {
+                acc[key.slice("attachment.".length)] = {
                     presigned_url: value.presigned_url,
                 };
                 return acc;
@@ -2015,7 +2046,7 @@ class Client {
                 const example = rest;
                 if (attachment_urls) {
                     example.attachments = Object.entries(attachment_urls).reduce((acc, [key, value]) => {
-                        acc[key] = {
+                        acc[key.slice("attachment.".length)] = {
                             presigned_url: value.presigned_url,
                         };
                         return acc;
@@ -2732,7 +2763,16 @@ class Client {
             }
             // Add attachments if present
             if (example.attachments) {
-                for (const [name, [mimeType, data]] of Object.entries(example.attachments)) {
+                for (const [name, attachment] of Object.entries(example.attachments)) {
+                    let mimeType;
+                    let data;
+                    if (Array.isArray(attachment)) {
+                        [mimeType, data] = attachment;
+                    }
+                    else {
+                        mimeType = attachment.mimeType;
+                        data = attachment.data;
+                    }
                     const attachmentBlob = new Blob([data], {
                         type: `${mimeType}; length=${data.byteLength}`,
                     });
@@ -2795,7 +2835,16 @@ class Client {
             }
             // Add attachments if present
             if (example.attachments) {
-                for (const [name, [mimeType, data]] of Object.entries(example.attachments)) {
+                for (const [name, attachment] of Object.entries(example.attachments)) {
+                    let mimeType;
+                    let data;
+                    if (Array.isArray(attachment)) {
+                        [mimeType, data] = attachment;
+                    }
+                    else {
+                        mimeType = attachment.mimeType;
+                        data = attachment.data;
+                    }
                     const attachmentBlob = new Blob([data], {
                         type: `${mimeType}; length=${data.byteLength}`,
                     });
@@ -3025,6 +3074,10 @@ class Client {
      * @returns A promise that resolves once all currently pending traces have sent.
      */
     awaitPendingTraceBatches() {
+        if (this.manualFlushMode) {
+            console.warn("[WARNING]: When tracing in manual flush mode, you must call `await client.flush()` manually to submit trace batches.");
+            return Promise.resolve();
+        }
         return Promise.all([
             ...this.autoBatchQueue.items.map(({ itemPromise }) => itemPromise),
             this.batchIngestCaller.queue.onIdle(),

package/dist/client.d.ts

@@ -15,6 +15,11 @@ export interface ClientConfig {
     blockOnRootRunFinalization?: boolean;
     traceBatchConcurrency?: number;
     fetchOptions?: RequestInit;
+    /**
+     * Whether to require manual .flush() calls before sending traces.
+     * Useful if encountering network rate limits at trace high volumes.
+     */
+    manualFlushMode?: boolean;
 }
 /**
  * Represents the parameters for listing runs (spans) from the Langsmith server.
@@ -207,6 +212,7 @@ export declare class Client implements LangSmithTracingClientInterface {
     private traceBatchConcurrency;
     private _serverInfo;
     private _getServerInfoPromise?;
+    private manualFlushMode;
     constructor(config?: ClientConfig);
     static getDefaultClientConfig(): {
         apiUrl: string;
@@ -233,6 +239,10 @@ export declare class Client implements LangSmithTracingClientInterface {
     protected _getServerInfo(): Promise<any>;
     protected _ensureServerInfo(): Promise<Record<string, any>>;
     protected _getSettings(): Promise<LangSmithSettings>;
+    /**
+     * Flushes current queued traces.
+     */
+    flush(): Promise<void>;
     createRun(run: CreateRunParams): Promise<void>;
     /**
      * Batch ingest/upsert multiple runs in the Langsmith system.
@@ -804,7 +814,7 @@ export declare class Client implements LangSmithTracingClientInterface {
      *
      * @returns A promise that resolves once all currently pending traces have sent.
      */
-    awaitPendingTraceBatches(): Promise<[...void[], void]>;
+    awaitPendingTraceBatches(): Promise<void> | Promise<[...void[], void]>;
 }
 export interface LangSmithTracingClientInterface {
     createRun: (run: CreateRunParams) => Promise<void>;

package/dist/client.js

@@ -280,6 +280,12 @@ export class Client {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "manualFlushMode", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
         const defaultConfig = Client.getDefaultClientConfig();
         this.tracingSampleRate = getTracingSamplingRate();
         this.apiUrl = trimQuotes(config.apiUrl ?? defaultConfig.apiUrl) ?? "";
@@ -313,6 +319,7 @@ export class Client {
             config.blockOnRootRunFinalization ?? this.blockOnRootRunFinalization;
         this.batchSizeBytesLimit = config.batchSizeBytesLimit;
         this.fetchOptions = config.fetchOptions || {};
+        this.manualFlushMode = config.manualFlushMode ?? this.manualFlushMode;
     }
     static getDefaultClientConfig() {
         const apiKey = getLangSmithEnvironmentVariable("API_KEY");
@@ -510,14 +517,17 @@ export class Client {
         return (serverInfo.instance_flags?.dataset_examples_multipart_enabled ?? false);
     }
     drainAutoBatchQueue(batchSizeLimit) {
+        const promises = [];
         while (this.autoBatchQueue.items.length > 0) {
             const [batch, done] = this.autoBatchQueue.pop(batchSizeLimit);
             if (!batch.length) {
                 done();
                 break;
             }
-            void this._processBatch(batch, done).catch(console.error);
+            const batchPromise = this._processBatch(batch, done).catch(console.error);
+            promises.push(batchPromise);
         }
+        return Promise.all(promises);
     }
     async _processBatch(batch, done) {
         if (!batch.length) {
@@ -552,14 +562,18 @@ export class Client {
             item.item = mergeRuntimeEnvIntoRunCreate(item.item);
         }
         const itemPromise = this.autoBatchQueue.push(item);
+        if (this.manualFlushMode) {
+            // Rely on manual flushing in serverless environments
+            return itemPromise;
+        }
         const sizeLimitBytes = await this._getBatchSizeLimitBytes();
         if (this.autoBatchQueue.sizeBytes > sizeLimitBytes) {
-            this.drainAutoBatchQueue(sizeLimitBytes);
+            void this.drainAutoBatchQueue(sizeLimitBytes);
         }
         if (this.autoBatchQueue.items.length > 0) {
             this.autoBatchTimeout = setTimeout(() => {
                 this.autoBatchTimeout = undefined;
-                this.drainAutoBatchQueue(sizeLimitBytes);
+                void this.drainAutoBatchQueue(sizeLimitBytes);
             }, this.autoBatchAggregationDelayMs);
         }
         return itemPromise;
@@ -601,6 +615,13 @@ export class Client {
         }
         return await this.settings;
     }
+    /**
+     * Flushes current queued traces.
+     */
+    async flush() {
+        const sizeLimitBytes = await this._getBatchSizeLimitBytes();
+        await this.drainAutoBatchQueue(sizeLimitBytes);
+    }
     async createRun(run) {
         if (!this._filterForSampling([run]).length) {
             return;
@@ -806,7 +827,16 @@ export class Client {
                     const attachments = allAttachments[payload.id];
                     if (attachments) {
                         delete allAttachments[payload.id];
-                        for (const [name, [contentType, content]] of Object.entries(attachments)) {
+                        for (const [name, attachment] of Object.entries(attachments)) {
+                            let contentType;
+                            let content;
+                            if (Array.isArray(attachment)) {
+                                [contentType, content] = attachment;
+                            }
+                            else {
+                                contentType = attachment.mimeType;
+                                content = attachment.data;
+                            }
                             // Validate that the attachment name doesn't contain a '.'
                             if (name.includes(".")) {
                                 console.warn(`Skipping attachment '${name}' for run ${payload.id}: Invalid attachment name. ` +
@@ -884,7 +914,8 @@ export class Client {
             data.dotted_order !== undefined) {
             if (run.end_time !== undefined &&
                 data.parent_run_id === undefined &&
-                this.blockOnRootRunFinalization) {
+                this.blockOnRootRunFinalization &&
+                !this.manualFlushMode) {
                 // Trigger batches as soon as a root trace ends and wait to ensure trace finishes
                 // in serverless environments.
                 await this.processRunOperation({ action: "update", item: data }).catch(console.error);
@@ -1920,7 +1951,7 @@ export class Client {
         if (attachment_urls) {
             // add attachments back to the example
             example.attachments = Object.entries(attachment_urls).reduce((acc, [key, value]) => {
-                acc[key] = {
+                acc[key.slice("attachment.".length)] = {
                     presigned_url: value.presigned_url,
                 };
                 return acc;
@@ -1987,7 +2018,7 @@ export class Client {
                 const example = rest;
                 if (attachment_urls) {
                     example.attachments = Object.entries(attachment_urls).reduce((acc, [key, value]) => {
-                        acc[key] = {
+                        acc[key.slice("attachment.".length)] = {
                             presigned_url: value.presigned_url,
                         };
                         return acc;
@@ -2704,7 +2735,16 @@ export class Client {
             }
             // Add attachments if present
             if (example.attachments) {
-                for (const [name, [mimeType, data]] of Object.entries(example.attachments)) {
+                for (const [name, attachment] of Object.entries(example.attachments)) {
+                    let mimeType;
+                    let data;
+                    if (Array.isArray(attachment)) {
+                        [mimeType, data] = attachment;
+                    }
+                    else {
+                        mimeType = attachment.mimeType;
+                        data = attachment.data;
+                    }
                     const attachmentBlob = new Blob([data], {
                         type: `${mimeType}; length=${data.byteLength}`,
                     });
@@ -2767,7 +2807,16 @@ export class Client {
             }
             // Add attachments if present
             if (example.attachments) {
-                for (const [name, [mimeType, data]] of Object.entries(example.attachments)) {
+                for (const [name, attachment] of Object.entries(example.attachments)) {
+                    let mimeType;
+                    let data;
+                    if (Array.isArray(attachment)) {
+                        [mimeType, data] = attachment;
+                    }
+                    else {
+                        mimeType = attachment.mimeType;
+                        data = attachment.data;
+                    }
                     const attachmentBlob = new Blob([data], {
                         type: `${mimeType}; length=${data.byteLength}`,
                     });
@@ -2997,6 +3046,10 @@ export class Client {
      * @returns A promise that resolves once all currently pending traces have sent.
      */
     awaitPendingTraceBatches() {
+        if (this.manualFlushMode) {
+            console.warn("[WARNING]: When tracing in manual flush mode, you must call `await client.flush()` manually to submit trace batches.");
+            return Promise.resolve();
+        }
         return Promise.all([
             ...this.autoBatchQueue.items.map(({ itemPromise }) => itemPromise),
             this.batchIngestCaller.queue.onIdle(),

package/dist/index.cjs

@@ -8,4 +8,4 @@ Object.defineProperty(exports, "RunTree", { enumerable: true, get: function () {
 var fetch_js_1 = require("./singletons/fetch.cjs");
 Object.defineProperty(exports, "overrideFetchImplementation", { enumerable: true, get: function () { return fetch_js_1.overrideFetchImplementation; } });
 // Update using yarn bump-version
-exports.__version__ = "0.2.12";
+exports.__version__ = "0.2.14-beta.0";

package/dist/index.d.ts

@@ -2,4 +2,4 @@ export { Client, type ClientConfig, type LangSmithTracingClientInterface, } from
 export type { Dataset, Example, TracerSession, Run, Feedback, RetrieverOutput, } from "./schemas.js";
 export { RunTree, type RunTreeConfig } from "./run_trees.js";
 export { overrideFetchImplementation } from "./singletons/fetch.js";
-export declare const __version__ = "0.2.12";
+export declare const __version__ = "0.2.14-beta.0";

package/dist/index.js

@@ -2,4 +2,4 @@ export { Client, } from "./client.js";
 export { RunTree } from "./run_trees.js";
 export { overrideFetchImplementation } from "./singletons/fetch.js";
 // Update using yarn bump-version
-export const __version__ = "0.2.12";
+export const __version__ = "0.2.14-beta.0";

package/dist/schemas.d.ts

@@ -36,7 +36,14 @@ export interface AttachmentInfo {
     presigned_url: string;
 }
 export type AttachmentData = Uint8Array | ArrayBuffer;
-export type Attachments = Record<string, [string, AttachmentData]>;
+export type AttachmentDescription = {
+    mimeType: string;
+    data: AttachmentData;
+};
+export type Attachments = Record<string, [
+    string,
+    AttachmentData
+] | AttachmentDescription>;
 /**
  * A run can represent either a trace (root run)
  * or a child run (~span).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "langsmith",
-  "version": "0.2.12",
+  "version": "0.2.14-beta.0",
   "description": "Client library to connect to the LangSmith LLM Tracing and Evaluation Platform.",
   "packageManager": "yarn@1.22.19",
   "files": [