langsmith 0.0.47 → 0.0.49

package/dist/client.cjs

@@ -70,6 +70,11 @@ function hideOutputs(outputs) {
     }
     return outputs;
 }
+function assertUuid(str) {
+    if (!uuid.validate(str)) {
+        throw new Error(`Invalid UUID: ${str}`);
+    }
+}
 class Client {
     constructor(config = {}) {
         Object.defineProperty(this, "apiKey", {
@@ -229,6 +234,7 @@ class Client {
         await raiseForStatus(response, "create run");
     }
     async updateRun(runId, run) {
+        assertUuid(runId);
         if (run.inputs) {
             run.inputs = hideInputs(run.inputs);
         }
@@ -245,6 +251,7 @@ class Client {
         await raiseForStatus(response, "update run");
     }
     async readRun(runId, { loadChildRuns } = { loadChildRuns: false }) {
+        assertUuid(runId);
         let run = await this._get(`/runs/${runId}`);
         if (loadChildRuns && run.child_run_ids) {
             run = await this._loadChildRuns(run);
@@ -365,6 +372,7 @@ class Client {
             run_id: runId,
             share_token: shareId || uuid.v4(),
         };
+        assertUuid(runId);
         const response = await this.caller.call(fetch, `${this.apiUrl}/runs/${runId}/share`, {
             method: "PUT",
             headers: this.headers,
@@ -378,6 +386,7 @@ class Client {
         return `${this.getHostUrl()}/public/${result["share_token"]}/r`;
     }
     async unshareRun(runId) {
+        assertUuid(runId);
         const response = await this.caller.call(fetch, `${this.apiUrl}/runs/${runId}/share`, {
             method: "DELETE",
             headers: this.headers,
@@ -386,6 +395,7 @@ class Client {
         await raiseForStatus(response, "unshare run");
     }
     async readRunSharedLink(runId) {
+        assertUuid(runId);
         const response = await this.caller.call(fetch, `${this.apiUrl}/runs/${runId}/share`, {
             method: "GET",
             headers: this.headers,
@@ -406,6 +416,7 @@ class Client {
                 queryParams.append("id", runId);
             }
         }
+        assertUuid(shareToken);
         const response = await this.caller.call(fetch, `${this.apiUrl}/public/${shareToken}/runs${queryParams}`, {
             method: "GET",
             headers: this.headers,
@@ -422,6 +433,7 @@ class Client {
             const dataset = await this.readDataset({ datasetName });
             datasetId = dataset.id;
         }
+        assertUuid(datasetId);
         const response = await this.caller.call(fetch, `${this.apiUrl}/datasets/${datasetId}/share`, {
             method: "GET",
             headers: this.headers,
@@ -442,6 +454,7 @@ class Client {
         const data = {
             dataset_id: datasetId,
         };
+        assertUuid(datasetId);
         const response = await this.caller.call(fetch, `${this.apiUrl}/datasets/${datasetId}/share`, {
             method: "PUT",
             headers: this.headers,
@@ -453,6 +466,7 @@ class Client {
         return shareSchema;
     }
     async unshareDataset(datasetId) {
+        assertUuid(datasetId);
         const response = await this.caller.call(fetch, `${this.apiUrl}/datasets/${datasetId}/share`, {
             method: "DELETE",
             headers: this.headers,
@@ -461,6 +475,7 @@ class Client {
         await raiseForStatus(response, "unshare dataset");
     }
     async readSharedDataset(shareToken) {
+        assertUuid(shareToken);
         const response = await this.caller.call(fetch, `${this.apiUrl}/public/${shareToken}/datasets`, {
             method: "GET",
             headers: this.headers,
@@ -469,16 +484,19 @@ class Client {
         const dataset = await response.json();
         return dataset;
     }
-    async createProject({ projectName, projectExtra, upsert, referenceDatasetId, }) {
+    async createProject({ projectName, description = null, metadata = null, upsert = false, projectExtra = null, referenceDatasetId = null, }) {
         const upsert_ = upsert ? `?upsert=true` : "";
         const endpoint = `${this.apiUrl}/sessions${upsert_}`;
+        const extra = projectExtra || {};
+        if (metadata) {
+            extra["metadata"] = metadata;
+        }
         const body = {
             name: projectName,
+            extra,
+            description,
         };
-        if (projectExtra !== undefined) {
-            body["extra"] = projectExtra;
-        }
-        if (referenceDatasetId !== undefined) {
+        if (referenceDatasetId !== null) {
             body["reference_dataset_id"] = referenceDatasetId;
         }
         const response = await this.caller.call(fetch, endpoint, {
@@ -493,6 +511,30 @@ class Client {
         }
         return result;
     }
+    async updateProject(projectId, { name = null, description = null, metadata = null, projectExtra = null, endTime = null, }) {
+        const endpoint = `${this.apiUrl}/sessions/${projectId}`;
+        let extra = projectExtra;
+        if (metadata) {
+            extra = { ...(extra || {}), metadata };
+        }
+        const body = {
+            name,
+            extra,
+            description,
+            end_time: endTime ? new Date(endTime).toISOString() : null,
+        };
+        const response = await this.caller.call(fetch, endpoint, {
+            method: "PATCH",
+            headers: { ...this.headers, "Content-Type": "application/json" },
+            body: JSON.stringify(body),
+            signal: AbortSignal.timeout(this.timeout_ms),
+        });
+        const result = await response.json();
+        if (!response.ok) {
+            throw new Error(`Failed to update project ${projectId}: ${response.status} ${response.statusText}`);
+        }
+        return result;
+    }
     async readProject({ projectId, projectName, }) {
         let path = "/sessions";
         const params = new URLSearchParams();
@@ -500,6 +542,7 @@ class Client {
             throw new Error("Must provide either projectName or projectId, not both");
         }
         else if (projectId !== undefined) {
+            assertUuid(projectId);
             path += `/${projectId}`;
         }
         else if (projectName !== undefined) {
@@ -575,6 +618,7 @@ class Client {
         else {
             projectId_ = projectId;
         }
+        assertUuid(projectId_);
         const response = await this.caller.call(fetch, `${this.apiUrl}/sessions/${projectId_}`, {
             method: "DELETE",
             headers: this.headers,
@@ -649,6 +693,7 @@ class Client {
             throw new Error("Must provide either datasetName or datasetId, not both");
         }
         else if (datasetId !== undefined) {
+            assertUuid(datasetId);
             path += `/${datasetId}`;
         }
         else if (datasetName !== undefined) {
@@ -721,6 +766,7 @@ class Client {
             datasetId_ = dataset.id;
         }
         if (datasetId_ !== undefined) {
+            assertUuid(datasetId_);
             path += `/${datasetId_}`;
         }
         else {
@@ -784,6 +830,7 @@ class Client {
         return this.createExample({ input: finalInput }, { output: finalOutput }, options);
     }
     async readExample(exampleId) {
+        assertUuid(exampleId);
         const path = `/examples/${exampleId}`;
         return await this._get(path);
     }
@@ -813,6 +860,7 @@ class Client {
         }
     }
     async deleteExample(exampleId) {
+        assertUuid(exampleId);
         const path = `/examples/${exampleId}`;
         const response = await this.caller.call(fetch, this.apiUrl + path, {
             method: "DELETE",
@@ -825,6 +873,7 @@ class Client {
         await response.json();
     }
     async updateExample(exampleId, update) {
+        assertUuid(exampleId);
         const response = await this.caller.call(fetch, `${this.apiUrl}/examples/${exampleId}`, {
             method: "PATCH",
             headers: { ...this.headers, "Content-Type": "application/json" },
@@ -877,6 +926,10 @@ class Client {
             !feedback_source.metadata["__run"]) {
             feedback_source.metadata["__run"] = { run_id: sourceRunId };
         }
+        if (feedback_source?.metadata !== undefined &&
+            feedback_source.metadata["__run"]?.run_id !== undefined) {
+            assertUuid(feedback_source.metadata["__run"].run_id);
+        }
         const feedback = {
             id: feedbackId ?? uuid.v4(),
             run_id: runId,
@@ -911,6 +964,7 @@ class Client {
         if (comment !== undefined && comment !== null) {
             feedbackUpdate["comment"] = comment;
         }
+        assertUuid(feedbackId);
         const response = await this.caller.call(fetch, `${this.apiUrl}/feedback/${feedbackId}`, {
             method: "PATCH",
             headers: { ...this.headers, "Content-Type": "application/json" },
@@ -920,11 +974,13 @@ class Client {
         await raiseForStatus(response, "update feedback");
     }
     async readFeedback(feedbackId) {
+        assertUuid(feedbackId);
         const path = `/feedback/${feedbackId}`;
         const response = await this._get(path);
         return response;
     }
     async deleteFeedback(feedbackId) {
+        assertUuid(feedbackId);
         const path = `/feedback/${feedbackId}`;
         const response = await this.caller.call(fetch, this.apiUrl + path, {
             method: "DELETE",

package/dist/client.d.ts

@@ -103,11 +103,20 @@ export declare class Client {
     shareDataset(datasetId?: string, datasetName?: string): Promise<DatasetShareSchema>;
     unshareDataset(datasetId: string): Promise<void>;
     readSharedDataset(shareToken: string): Promise<Dataset>;
-    createProject({ projectName, projectExtra, upsert, referenceDatasetId, }: {
+    createProject({ projectName, description, metadata, upsert, projectExtra, referenceDatasetId, }: {
         projectName: string;
-        projectExtra?: object;
+        description?: string | null;
+        metadata?: Record<string, any> | null;
         upsert?: boolean;
-        referenceDatasetId?: string;
+        projectExtra?: Record<string, any> | null;
+        referenceDatasetId?: string | null;
+    }): Promise<TracerSession>;
+    updateProject(projectId: string, { name, description, metadata, projectExtra, endTime, }: {
+        name?: string | null;
+        description?: string | null;
+        metadata?: Record<string, any> | null;
+        projectExtra?: Record<string, any> | null;
+        endTime?: string | null;
     }): Promise<TracerSession>;
     readProject({ projectId, projectName, }: {
         projectId?: string;

package/dist/client.js

@@ -44,6 +44,11 @@ function hideOutputs(outputs) {
     }
     return outputs;
 }
+function assertUuid(str) {
+    if (!uuid.validate(str)) {
+        throw new Error(`Invalid UUID: ${str}`);
+    }
+}
 export class Client {
     constructor(config = {}) {
         Object.defineProperty(this, "apiKey", {
@@ -203,6 +208,7 @@ export class Client {
         await raiseForStatus(response, "create run");
     }
     async updateRun(runId, run) {
+        assertUuid(runId);
         if (run.inputs) {
             run.inputs = hideInputs(run.inputs);
         }
@@ -219,6 +225,7 @@ export class Client {
         await raiseForStatus(response, "update run");
     }
     async readRun(runId, { loadChildRuns } = { loadChildRuns: false }) {
+        assertUuid(runId);
         let run = await this._get(`/runs/${runId}`);
         if (loadChildRuns && run.child_run_ids) {
             run = await this._loadChildRuns(run);
@@ -339,6 +346,7 @@ export class Client {
             run_id: runId,
             share_token: shareId || uuid.v4(),
         };
+        assertUuid(runId);
         const response = await this.caller.call(fetch, `${this.apiUrl}/runs/${runId}/share`, {
             method: "PUT",
             headers: this.headers,
@@ -352,6 +360,7 @@ export class Client {
         return `${this.getHostUrl()}/public/${result["share_token"]}/r`;
     }
     async unshareRun(runId) {
+        assertUuid(runId);
         const response = await this.caller.call(fetch, `${this.apiUrl}/runs/${runId}/share`, {
             method: "DELETE",
             headers: this.headers,
@@ -360,6 +369,7 @@ export class Client {
         await raiseForStatus(response, "unshare run");
     }
     async readRunSharedLink(runId) {
+        assertUuid(runId);
         const response = await this.caller.call(fetch, `${this.apiUrl}/runs/${runId}/share`, {
             method: "GET",
             headers: this.headers,
@@ -380,6 +390,7 @@ export class Client {
                 queryParams.append("id", runId);
             }
         }
+        assertUuid(shareToken);
         const response = await this.caller.call(fetch, `${this.apiUrl}/public/${shareToken}/runs${queryParams}`, {
             method: "GET",
             headers: this.headers,
@@ -396,6 +407,7 @@ export class Client {
             const dataset = await this.readDataset({ datasetName });
             datasetId = dataset.id;
         }
+        assertUuid(datasetId);
         const response = await this.caller.call(fetch, `${this.apiUrl}/datasets/${datasetId}/share`, {
             method: "GET",
             headers: this.headers,
@@ -416,6 +428,7 @@ export class Client {
         const data = {
             dataset_id: datasetId,
         };
+        assertUuid(datasetId);
         const response = await this.caller.call(fetch, `${this.apiUrl}/datasets/${datasetId}/share`, {
             method: "PUT",
             headers: this.headers,
@@ -427,6 +440,7 @@ export class Client {
         return shareSchema;
     }
     async unshareDataset(datasetId) {
+        assertUuid(datasetId);
         const response = await this.caller.call(fetch, `${this.apiUrl}/datasets/${datasetId}/share`, {
             method: "DELETE",
             headers: this.headers,
@@ -435,6 +449,7 @@ export class Client {
         await raiseForStatus(response, "unshare dataset");
     }
     async readSharedDataset(shareToken) {
+        assertUuid(shareToken);
         const response = await this.caller.call(fetch, `${this.apiUrl}/public/${shareToken}/datasets`, {
             method: "GET",
             headers: this.headers,
@@ -443,16 +458,19 @@ export class Client {
         const dataset = await response.json();
         return dataset;
     }
-    async createProject({ projectName, projectExtra, upsert, referenceDatasetId, }) {
+    async createProject({ projectName, description = null, metadata = null, upsert = false, projectExtra = null, referenceDatasetId = null, }) {
         const upsert_ = upsert ? `?upsert=true` : "";
         const endpoint = `${this.apiUrl}/sessions${upsert_}`;
+        const extra = projectExtra || {};
+        if (metadata) {
+            extra["metadata"] = metadata;
+        }
         const body = {
             name: projectName,
+            extra,
+            description,
         };
-        if (projectExtra !== undefined) {
-            body["extra"] = projectExtra;
-        }
-        if (referenceDatasetId !== undefined) {
+        if (referenceDatasetId !== null) {
             body["reference_dataset_id"] = referenceDatasetId;
         }
         const response = await this.caller.call(fetch, endpoint, {
@@ -467,6 +485,30 @@ export class Client {
         }
         return result;
     }
+    async updateProject(projectId, { name = null, description = null, metadata = null, projectExtra = null, endTime = null, }) {
+        const endpoint = `${this.apiUrl}/sessions/${projectId}`;
+        let extra = projectExtra;
+        if (metadata) {
+            extra = { ...(extra || {}), metadata };
+        }
+        const body = {
+            name,
+            extra,
+            description,
+            end_time: endTime ? new Date(endTime).toISOString() : null,
+        };
+        const response = await this.caller.call(fetch, endpoint, {
+            method: "PATCH",
+            headers: { ...this.headers, "Content-Type": "application/json" },
+            body: JSON.stringify(body),
+            signal: AbortSignal.timeout(this.timeout_ms),
+        });
+        const result = await response.json();
+        if (!response.ok) {
+            throw new Error(`Failed to update project ${projectId}: ${response.status} ${response.statusText}`);
+        }
+        return result;
+    }
     async readProject({ projectId, projectName, }) {
         let path = "/sessions";
         const params = new URLSearchParams();
@@ -474,6 +516,7 @@ export class Client {
             throw new Error("Must provide either projectName or projectId, not both");
         }
         else if (projectId !== undefined) {
+            assertUuid(projectId);
             path += `/${projectId}`;
         }
         else if (projectName !== undefined) {
@@ -549,6 +592,7 @@ export class Client {
         else {
             projectId_ = projectId;
         }
+        assertUuid(projectId_);
         const response = await this.caller.call(fetch, `${this.apiUrl}/sessions/${projectId_}`, {
             method: "DELETE",
             headers: this.headers,
@@ -623,6 +667,7 @@ export class Client {
             throw new Error("Must provide either datasetName or datasetId, not both");
         }
         else if (datasetId !== undefined) {
+            assertUuid(datasetId);
             path += `/${datasetId}`;
         }
         else if (datasetName !== undefined) {
@@ -695,6 +740,7 @@ export class Client {
             datasetId_ = dataset.id;
         }
         if (datasetId_ !== undefined) {
+            assertUuid(datasetId_);
             path += `/${datasetId_}`;
         }
         else {
@@ -758,6 +804,7 @@ export class Client {
         return this.createExample({ input: finalInput }, { output: finalOutput }, options);
     }
     async readExample(exampleId) {
+        assertUuid(exampleId);
         const path = `/examples/${exampleId}`;
         return await this._get(path);
     }
@@ -787,6 +834,7 @@ export class Client {
         }
     }
     async deleteExample(exampleId) {
+        assertUuid(exampleId);
         const path = `/examples/${exampleId}`;
         const response = await this.caller.call(fetch, this.apiUrl + path, {
             method: "DELETE",
@@ -799,6 +847,7 @@ export class Client {
         await response.json();
     }
     async updateExample(exampleId, update) {
+        assertUuid(exampleId);
         const response = await this.caller.call(fetch, `${this.apiUrl}/examples/${exampleId}`, {
             method: "PATCH",
             headers: { ...this.headers, "Content-Type": "application/json" },
@@ -851,6 +900,10 @@ export class Client {
             !feedback_source.metadata["__run"]) {
             feedback_source.metadata["__run"] = { run_id: sourceRunId };
         }
+        if (feedback_source?.metadata !== undefined &&
+            feedback_source.metadata["__run"]?.run_id !== undefined) {
+            assertUuid(feedback_source.metadata["__run"].run_id);
+        }
         const feedback = {
             id: feedbackId ?? uuid.v4(),
             run_id: runId,
@@ -885,6 +938,7 @@ export class Client {
         if (comment !== undefined && comment !== null) {
             feedbackUpdate["comment"] = comment;
         }
+        assertUuid(feedbackId);
         const response = await this.caller.call(fetch, `${this.apiUrl}/feedback/${feedbackId}`, {
             method: "PATCH",
             headers: { ...this.headers, "Content-Type": "application/json" },
@@ -894,11 +948,13 @@ export class Client {
         await raiseForStatus(response, "update feedback");
     }
     async readFeedback(feedbackId) {
+        assertUuid(feedbackId);
         const path = `/feedback/${feedbackId}`;
         const response = await this._get(path);
         return response;
     }
     async deleteFeedback(feedbackId) {
+        assertUuid(feedbackId);
         const path = `/feedback/${feedbackId}`;
         const response = await this.caller.call(fetch, this.apiUrl + path, {
             method: "DELETE",

package/dist/schemas.d.ts

@@ -70,7 +70,7 @@ export interface Run extends BaseRun {
     /** A unique identifier for the run, mandatory when loaded from DB. */
     id: string;
     /** Defines the sequence in which the run was executed. */
-    execution_order: number;
+    execution_order?: number;
     /** The ID of the project that owns this run. */
     session_id?: string;
     /** IDs of any child runs spawned by this run. */

package/package.json

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