@langchain/langgraph-sdk 0.0.11 → 0.0.13

package/dist/client.cjs

@@ -167,8 +167,10 @@ class AssistantsClient extends BaseClient {
      * @param assistantId The ID of the assistant.
      * @returns Serialized graph
      */
-    async getGraph(assistantId) {
-        return this.fetch(`/assistants/${assistantId}/graph`);
+    async getGraph(assistantId, options) {
+        return this.fetch(`/assistants/${assistantId}/graph`, {
+            params: { xray: options?.xray },
+        });
     }
     /**
      * Get the state and config schema of the graph assigned to a runnable
@@ -178,6 +180,21 @@ class AssistantsClient extends BaseClient {
     async getSchemas(assistantId) {
         return this.fetch(`/assistants/${assistantId}/schemas`);
     }
+    /**
+     * Get the schemas of an assistant by ID.
+     *
+     * @param assistantId The ID of the assistant to get the schema of.
+     * @param options Additional options for getting subgraphs, such as namespace or recursion extraction.
+     * @returns The subgraphs of the assistant.
+     */
+    async getSubgraphs(assistantId, options) {
+        if (options?.namespace) {
+            return this.fetch(`/assistants/${assistantId}/subgraphs/${options.namespace}`, { params: { recurse: options?.recurse } });
+        }
+        return this.fetch(`/assistants/${assistantId}/subgraphs`, {
+            params: { recurse: options?.recurse },
+        });
+    }
     /**
      * Create a new assistant.
      * @param payload Payload for creating an assistant.
@@ -351,10 +368,20 @@ class ThreadsClient extends BaseClient {
      * @param threadId ID of the thread.
      * @returns Thread state.
      */
-    async getState(threadId, checkpointId) {
-        return this.fetch(checkpointId != null
-            ? `/threads/${threadId}/state/${checkpointId}`
-            : `/threads/${threadId}/state`);
+    async getState(threadId, checkpoint, options) {
+        if (checkpoint != null) {
+            if (typeof checkpoint !== "string") {
+                return this.fetch(`/threads/${threadId}/state/checkpoint`, {
+                    method: "POST",
+                    json: { checkpoint, subgraphs: options?.subgraphs },
+                });
+            }
+            // deprecated
+            return this.fetch(`/threads/${threadId}/state/${checkpoint}`, { params: { subgraphs: options?.subgraphs } });
+        }
+        return this.fetch(`/threads/${threadId}/state`, {
+            params: { subgraphs: options?.subgraphs },
+        });
     }
     /**
      * Add state to a thread.
@@ -368,6 +395,7 @@ class ThreadsClient extends BaseClient {
             json: {
                 values: options.values,
                 checkpoint_id: options.checkpointId,
+                checkpoint: options.checkpoint,
                 as_node: options?.asNode,
             },
         });
@@ -427,6 +455,7 @@ class RunsClient extends BaseClient {
             config: payload?.config,
             metadata: payload?.metadata,
             stream_mode: payload?.streamMode,
+            stream_subgraphs: payload?.streamSubgraphs,
             feedback_keys: payload?.feedbackKeys,
             assistant_id: assistantId,
             interrupt_before: payload?.interruptBefore,

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import { Assistant, AssistantGraph, Config, DefaultValues, GraphSchema, Metadata, Run, Thread, ThreadState, Cron, AssistantVersion } from "./schema.js";
+import { Assistant, AssistantGraph, Config, DefaultValues, GraphSchema, Metadata, Run, Thread, ThreadState, Cron, AssistantVersion, Subgraphs, Checkpoint } from "./schema.js";
 import { AsyncCaller, AsyncCallerParams } from "./utils/async_caller.js";
 import { RunsCreatePayload, RunsStreamPayload, RunsWaitPayload, StreamEvent, CronsCreatePayload, OnConflictBehavior } from "./types.js";
 interface ClientConfig {
@@ -69,13 +69,26 @@ export declare class AssistantsClient extends BaseClient {
      * @param assistantId The ID of the assistant.
      * @returns Serialized graph
      */
-    getGraph(assistantId: string): Promise<AssistantGraph>;
+    getGraph(assistantId: string, options?: {
+        xray?: boolean;
+    }): Promise<AssistantGraph>;
     /**
      * Get the state and config schema of the graph assigned to a runnable
      * @param assistantId The ID of the assistant.
      * @returns Graph schema
      */
     getSchemas(assistantId: string): Promise<GraphSchema>;
+    /**
+     * Get the schemas of an assistant by ID.
+     *
+     * @param assistantId The ID of the assistant to get the schema of.
+     * @param options Additional options for getting subgraphs, such as namespace or recursion extraction.
+     * @returns The subgraphs of the assistant.
+     */
+    getSubgraphs(assistantId: string, options?: {
+        namespace?: string;
+        recurse?: boolean;
+    }): Promise<Subgraphs>;
     /**
      * Create a new assistant.
      * @param payload Payload for creating an assistant.
@@ -212,7 +225,9 @@ export declare class ThreadsClient extends BaseClient {
      * @param threadId ID of the thread.
      * @returns Thread state.
      */
-    getState<ValuesType = DefaultValues>(threadId: string, checkpointId?: string): Promise<ThreadState<ValuesType>>;
+    getState<ValuesType = DefaultValues>(threadId: string, checkpoint?: Checkpoint | string, options?: {
+        subgraphs?: boolean;
+    }): Promise<ThreadState<ValuesType>>;
     /**
      * Add state to a thread.
      *
@@ -221,6 +236,7 @@ export declare class ThreadsClient extends BaseClient {
      */
     updateState<ValuesType = DefaultValues>(threadId: string, options: {
         values: ValuesType;
+        checkpoint?: Checkpoint;
         checkpointId?: string;
         asNode?: string;
     }): Promise<Pick<Config, "configurable">>;

package/dist/client.js

@@ -163,8 +163,10 @@ export class AssistantsClient extends BaseClient {
      * @param assistantId The ID of the assistant.
      * @returns Serialized graph
      */
-    async getGraph(assistantId) {
-        return this.fetch(`/assistants/${assistantId}/graph`);
+    async getGraph(assistantId, options) {
+        return this.fetch(`/assistants/${assistantId}/graph`, {
+            params: { xray: options?.xray },
+        });
     }
     /**
      * Get the state and config schema of the graph assigned to a runnable
@@ -174,6 +176,21 @@ export class AssistantsClient extends BaseClient {
     async getSchemas(assistantId) {
         return this.fetch(`/assistants/${assistantId}/schemas`);
     }
+    /**
+     * Get the schemas of an assistant by ID.
+     *
+     * @param assistantId The ID of the assistant to get the schema of.
+     * @param options Additional options for getting subgraphs, such as namespace or recursion extraction.
+     * @returns The subgraphs of the assistant.
+     */
+    async getSubgraphs(assistantId, options) {
+        if (options?.namespace) {
+            return this.fetch(`/assistants/${assistantId}/subgraphs/${options.namespace}`, { params: { recurse: options?.recurse } });
+        }
+        return this.fetch(`/assistants/${assistantId}/subgraphs`, {
+            params: { recurse: options?.recurse },
+        });
+    }
     /**
      * Create a new assistant.
      * @param payload Payload for creating an assistant.
@@ -346,10 +363,20 @@ export class ThreadsClient extends BaseClient {
      * @param threadId ID of the thread.
      * @returns Thread state.
      */
-    async getState(threadId, checkpointId) {
-        return this.fetch(checkpointId != null
-            ? `/threads/${threadId}/state/${checkpointId}`
-            : `/threads/${threadId}/state`);
+    async getState(threadId, checkpoint, options) {
+        if (checkpoint != null) {
+            if (typeof checkpoint !== "string") {
+                return this.fetch(`/threads/${threadId}/state/checkpoint`, {
+                    method: "POST",
+                    json: { checkpoint, subgraphs: options?.subgraphs },
+                });
+            }
+            // deprecated
+            return this.fetch(`/threads/${threadId}/state/${checkpoint}`, { params: { subgraphs: options?.subgraphs } });
+        }
+        return this.fetch(`/threads/${threadId}/state`, {
+            params: { subgraphs: options?.subgraphs },
+        });
     }
     /**
      * Add state to a thread.
@@ -363,6 +390,7 @@ export class ThreadsClient extends BaseClient {
             json: {
                 values: options.values,
                 checkpoint_id: options.checkpointId,
+                checkpoint: options.checkpoint,
                 as_node: options?.asNode,
             },
         });
@@ -421,6 +449,7 @@ export class RunsClient extends BaseClient {
             config: payload?.config,
             metadata: payload?.metadata,
             stream_mode: payload?.streamMode,
+            stream_subgraphs: payload?.streamSubgraphs,
             feedback_keys: payload?.feedbackKeys,
             assistant_id: assistantId,
             interrupt_before: payload?.interruptBefore,

package/dist/schema.d.ts

@@ -2,6 +2,7 @@ import type { JSONSchema7 } from "json-schema";
 type Optional<T> = T | null | undefined;
 type RunStatus = "pending" | "running" | "error" | "success" | "timeout" | "interrupted";
 type ThreadStatus = "idle" | "busy" | "interrupted";
+type MultitaskStrategy = "reject" | "interrupt" | "rollback" | "enqueue";
 export interface Config {
     /**
      * Tags for this call and any sub-calls (eg. a Chain calling an LLM).
@@ -54,56 +55,108 @@ export interface GraphSchema {
      */
     config_schema?: JSONSchema7;
 }
+export type Subgraphs = Record<string, GraphSchema>;
 export type Metadata = Optional<Record<string, unknown>>;
 export interface AssistantBase {
+    /** The ID of the assistant. */
     assistant_id: string;
+    /** The ID of the graph. */
     graph_id: string;
+    /** The assistant config. */
     config: Config;
+    /** The time the assistant was created. */
     created_at: string;
+    /** The assistant metadata. */
     metadata: Metadata;
+    /** The version of the assistant. */
     version: number;
 }
 export interface AssistantVersion extends AssistantBase {
 }
 export interface Assistant extends AssistantBase {
+    /** The last time the assistant was updated. */
     updated_at: string;
+    /** The name of the assistant */
     name: string;
 }
 export type AssistantGraph = Record<string, Array<Record<string, unknown>>>;
-export interface Thread {
+export interface Thread<ValuesType = DefaultValues> {
+    /** The ID of the thread. */
     thread_id: string;
+    /** The time the thread was created. */
     created_at: string;
+    /** The last time the thread was updated. */
     updated_at: string;
+    /** The thread metadata. */
     metadata: Metadata;
+    /** The status of the thread */
     status: ThreadStatus;
+    /** The current state of the thread. */
+    values: ValuesType;
 }
 export interface Cron {
+    /** The ID of the cron */
     cron_id: string;
+    /** The ID of the thread */
     thread_id: Optional<string>;
+    /** The end date to stop running the cron. */
     end_time: Optional<string>;
+    /** The schedule to run, cron format. */
     schedule: string;
+    /** The time the cron was created. */
     created_at: string;
+    /** The last time the cron was updated. */
     updated_at: string;
+    /** The run payload to use for creating new run. */
     payload: Record<string, unknown>;
 }
 export type DefaultValues = Record<string, unknown>[] | Record<string, unknown>;
 export interface ThreadState<ValuesType = DefaultValues> {
+    /** The state values */
     values: ValuesType;
+    /** The next nodes to execute. If empty, the thread is done until new input is received */
     next: string[];
-    checkpoint_id: string;
+    /** Checkpoint of the thread state */
+    checkpoint: Checkpoint;
+    /** Metadata for this state */
     metadata: Metadata;
+    /** Time of state creation  */
     created_at: Optional<string>;
-    parent_checkpoint_id: Optional<string>;
-    config: Config;
-    parent_config?: Config;
+    /** The parent checkpoint. If missing, this is the root checkpoint */
+    parent_checkpoint: Optional<Checkpoint>;
+    /** Tasks to execute in this step. If already attempted, may contain an error */
+    tasks: Array<ThreadTask>;
+}
+export interface ThreadTask {
+    id: string;
+    name: string;
+    error: Optional<string>;
+    interrupts: Array<Record<string, unknown>>;
+    checkpoint: Optional<Checkpoint>;
+    state: Optional<ThreadState>;
 }
 export interface Run {
+    /** The ID of the run */
     run_id: string;
+    /** The ID of the thread */
     thread_id: string;
+    /** The assistant that wwas used for this run */
     assistant_id: string;
+    /** The time the run was created */
     created_at: string;
+    /** The last time the run was updated */
     updated_at: string;
+    /** The status of the run. */
     status: RunStatus;
+    /** Run metadata */
     metadata: Metadata;
+    /** Strategy to handle concurrent runs on the same thread */
+    multitask_strategy: Optional<MultitaskStrategy>;
+}
+export interface Checkpoint {
+    thread_id: string;
+    checkpoint_ns: string;
+    checkpoint_id: Optional<string>;
+    checkpoint_map: Optional<Record<string, unknown>>;
 }
 export {};

package/dist/types.d.ts

@@ -75,6 +75,10 @@ export interface RunsStreamPayload extends RunsInvokePayload {
      *               afterwards using the `client.runs.listEvents()` method.
      */
     streamMode?: StreamMode | Array<StreamMode>;
+    /**
+     * Stream output from subgraphs. By default, streams only the top graph.
+     */
+    streamSubgraphs?: boolean;
     /**
      * Pass one or more feedbackKeys if you want to request short-lived signed URLs
      * for submitting feedback to LangSmith with this key for this run.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/langgraph-sdk",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "description": "Client library for interacting with the LangGraph API",
   "type": "module",
   "packageManager": "yarn@1.22.19",