@langchain/langgraph-sdk/dist/schema.d.cts

Client library for interacting with the LangGraph API

import { JSONSchema7 } from "json-schema";

//#region src/schema.d.ts
type Optional<T> = T | null | undefined;
type RunStatus = "pending" | "running" | "error" | "success" | "timeout" | "interrupted";
type ThreadStatus = "idle" | "busy" | "interrupted" | "error";
type MultitaskStrategy = "reject" | "interrupt" | "rollback" | "enqueue";
type CancelAction = "interrupt" | "rollback";
type Config = {
  /**
   * Tags for this call and any sub-calls (eg. a Chain calling an LLM).
   * You can use these to filter calls.
   */
  tags?: string[];
  /**
   * Maximum number of times a call can recurse.
   * If not provided, defaults to 25.
   */
  recursion_limit?: number;
  /**
   * Runtime values for attributes previously made configurable on this Runnable.
   */
  configurable?: {
    /**
     * ID of the thread
     */
    thread_id?: Optional<string>;
    /**
     * Timestamp of the state checkpoint
     */
    checkpoint_id?: Optional<string>;
    [key: string]: unknown;
  };
};
interface GraphSchema {
  /**
   * The ID of the graph.
   */
  graph_id: string;
  /**
   * The schema for the input state.
   * Missing if unable to generate JSON schema from graph.
   */
  input_schema?: JSONSchema7 | null | undefined;
  /**
   * The schema for the output state.
   * Missing if unable to generate JSON schema from graph.
   */
  output_schema?: JSONSchema7 | null | undefined;
  /**
   * The schema for the graph state.
   * Missing if unable to generate JSON schema from graph.
   */
  state_schema?: JSONSchema7 | null | undefined;
  /**
   * The schema for the graph config.
   * Missing if unable to generate JSON schema from graph.
   */
  config_schema?: JSONSchema7 | null | undefined;
  /**
   * The schema for the graph context.
   * Missing if unable to generate JSON schema from graph.
   */
  context_schema?: JSONSchema7 | null | undefined;
}
type Subgraphs = Record<string, GraphSchema>;
type Metadata = Optional<{
  source?: "input" | "loop" | "update" | (string & {});
  step?: number;
  writes?: Record<string, unknown> | null;
  parents?: Record<string, string>;
  [key: string]: unknown;
}>;
interface AssistantBase {
  /** The ID of the assistant. */
  assistant_id: string;
  /** The ID of the graph. */
  graph_id: string;
  /** The assistant config. */
  config: Config;
  /** The assistant context. */
  context: unknown;
  /** The time the assistant was created. */
  created_at: string;
  /** The assistant metadata. */
  metadata: Metadata;
  /** The version of the assistant. */
  version: number;
  /** The name of the assistant */
  name: string;
  /** The description of the assistant */
  description?: string;
}
interface AssistantVersion extends AssistantBase {}
interface Assistant extends AssistantBase {
  /** The last time the assistant was updated. */
  updated_at: string;
}
interface AssistantsSearchResponse {
  /** The assistants returned for the current search page. */
  assistants: Assistant[];
  /** Pagination cursor from the X-Pagination-Next response header. */
  next: string | null;
}
interface AssistantGraph {
  nodes: Array<{
    id: string | number;
    name?: string;
    data?: Record<string, any> | string;
    metadata?: unknown;
  }>;
  edges: Array<{
    source: string;
    target: string;
    data?: string;
    conditional?: boolean;
  }>;
}
/**
 * An interrupt thrown inside a thread.
 */
interface Interrupt<TValue = unknown> {
  /**
   * The ID of the interrupt.
   */
  id?: string;
  /**
   * The value of the interrupt.
   */
  value?: TValue;
  /**
   * Will be deprecated in the future.
   * @deprecated Will be removed in the future.
   */
  when?: "during" | (string & {});
  /**
   * Whether the interrupt can be resumed.
   * @deprecated Will be removed in the future.
   */
  resumable?: boolean;
  /**
   * The namespace of the interrupt.
   * @deprecated Replaced by `interrupt_id`
   */
  ns?: string[];
}
interface Thread<ValuesType = DefaultValues, TInterruptValue = unknown> {
  /** 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;
  /** Interrupts which were thrown in this thread */
  interrupts: Record<string, Array<Interrupt<TInterruptValue>>>;
  /** The config for the thread */
  config?: Config;
  /** The error for the thread (if status == "error") */
  error?: Optional<string | Record<string, unknown>>;
}
interface Cron {
  /** The ID of the cron */
  cron_id: string;
  /** The ID of the assistant */
  assistant_id: string;
  /** The ID of the thread */
  thread_id: Optional<string>;
  /** What to do with the thread after the run completes. Only applicable for stateless crons. */
  on_run_completed?: "delete" | "keep";
  /** 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>;
  /** The user ID of the cron */
  user_id: Optional<string>;
  /** The next run date of the cron */
  next_run_date: Optional<string>;
  /** The metadata of the cron */
  metadata: Record<string, unknown>;
}
type DefaultValues = Record<string, unknown>[] | Record<string, unknown>;
type ThreadValuesFilter = Record<string, unknown>;
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 of the thread state */
  checkpoint: Checkpoint;
  /** Metadata for this state */
  metadata: Metadata;
  /** Time of state creation  */
  created_at: Optional<string>;
  /** 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>;
}
interface ThreadTask<ValuesType = DefaultValues, TInterruptValue = unknown> {
  id: string;
  name: string;
  result?: unknown;
  error: Optional<string>;
  interrupts: Array<Interrupt<TInterruptValue>>;
  checkpoint: Optional<Checkpoint>;
  state: Optional<ThreadState<ValuesType>>;
}
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>;
}
type Checkpoint = {
  thread_id: string;
  checkpoint_ns: string;
  checkpoint_id: Optional<string>;
  checkpoint_map: Optional<Record<string, unknown>>;
};
interface ListNamespaceResponse {
  namespaces: string[][];
}
interface Item {
  namespace: string[];
  key: string;
  value: Record<string, any>;
  createdAt: string;
  updatedAt: string;
}
interface SearchItem extends Item {
  score?: number;
}
interface SearchItemsResponse {
  items: SearchItem[];
}
interface CronCreateResponse {
  cron_id: string;
  assistant_id: string;
  thread_id: string | undefined;
  user_id: string;
  payload: Record<string, unknown>;
  schedule: string;
  next_run_date: string;
  end_time: string | undefined;
  created_at: string;
  updated_at: string;
  metadata: Metadata;
}
interface CronCreateForThreadResponse extends Omit<CronCreateResponse, "thread_id"> {
  thread_id: string;
}
type AssistantSortBy = "assistant_id" | "graph_id" | "name" | "created_at" | "updated_at";
type ThreadSortBy = "thread_id" | "status" | "created_at" | "updated_at";
type CronSortBy = "cron_id" | "assistant_id" | "thread_id" | "created_at" | "updated_at" | "next_run_date";
type SortOrder = "asc" | "desc";
type AssistantSelectField = "assistant_id" | "graph_id" | "name" | "description" | "config" | "context" | "created_at" | "updated_at" | "metadata" | "version";
type ThreadSelectField = "thread_id" | "created_at" | "updated_at" | "metadata" | "config" | "context" | "status" | "values" | "interrupts";
type RunSelectField = "run_id" | "thread_id" | "assistant_id" | "created_at" | "updated_at" | "status" | "metadata" | "kwargs" | "multitask_strategy";
type CronSelectField = "cron_id" | "assistant_id" | "thread_id" | "end_time" | "schedule" | "created_at" | "updated_at" | "user_id" | "payload" | "next_run_date" | "metadata" | "now";
//#endregion
export { Assistant, AssistantBase, AssistantGraph, AssistantSelectField, AssistantSortBy, AssistantVersion, AssistantsSearchResponse, CancelAction, Checkpoint, Config, Cron, CronCreateForThreadResponse, CronCreateResponse, CronSelectField, CronSortBy, DefaultValues, GraphSchema, Interrupt, Item, ListNamespaceResponse, Metadata, Run, RunSelectField, RunStatus, SearchItem, SearchItemsResponse, SortOrder, Subgraphs, Thread, ThreadSelectField, ThreadSortBy, ThreadState, ThreadStatus, ThreadTask, ThreadValuesFilter };
//# sourceMappingURL=schema.d.cts.map