Class RemoteGraph<Nn, Cc, ConfigurableFieldType>

The RemoteGraph class is a client implementation for calling remote APIs that implement the LangGraph Server API specification.

For example, the RemoteGraph class can be used to call APIs from deployments on LangGraph Cloud.

RemoteGraph behaves the same way as a StateGraph and can be used directly as a node in another StateGraph.

Example

import { RemoteGraph } from "@langchain/langgraph/remote";

// Can also pass a LangGraph SDK client instance directly
const remoteGraph = new RemoteGraph({
graphId: process.env.LANGGRAPH_REMOTE_GRAPH_ID!,
apiKey: process.env.LANGGRAPH_REMOTE_GRAPH_API_KEY,
url: process.env.LANGGRAPH_REMOTE_GRAPH_API_URL,
});

const input = {
messages: [
{
role: "human",
content: "Hello world!",
},
],
};

const config = {
configurable: { thread_id: "threadId1" },
};

await remoteGraph.invoke(input, config);

Type Parameters

Hierarchy

Implements

Constructors

Properties

client: Client
config?: RunnableConfig<Record<string, any>>
graphId: string
interruptAfter?: "*" | (keyof Nn)[]
interruptBefore?: "*" | (keyof Nn)[]
lc_kwargs: SerializedFields
lc_namespace: string[]
lc_runnable: boolean
lc_serializable: boolean
lg_is_pregel: boolean
name?: string

Accessors

  • get lc_aliases(): undefined | {
        [key: string]: string;
    }
  • A map of aliases for constructor args. Keys are the attribute names, e.g. "foo". Values are the alias that will replace the key in serialization. This is used to eg. make argument names match Python.

    Returns undefined | {
        [key: string]: string;
    }

  • get lc_attributes(): undefined | SerializedFields
  • A map of additional attributes to merge with constructor args. Keys are the attribute names, e.g. "foo". Values are the attribute values, which will be serialized. These attributes need to be accepted by the constructor as arguments.

    Returns undefined | SerializedFields

  • get lc_id(): string[]
  • The final serialized identifier for the module.

    Returns string[]

  • get lc_secrets(): undefined | {
        [key: string]: string;
    }
  • A map of secrets, which will be omitted from serialization. Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". Values are the secret ids, which will be used when deserializing.

    Returns undefined | {
        [key: string]: string;
    }

Methods

  • Internal method that handles batching and configuration for a runnable It takes a function, input values, and optional configuration, and returns a promise that resolves to the output values.

    Type Parameters

    • T extends any

    Parameters

    • func: ((inputs, options?, runManagers?, batchOptions?) => Promise<any[]>)

      The function to be executed for each input value.

        • (inputs, options?, runManagers?, batchOptions?): Promise<any[]>
        • Parameters

          Returns Promise<any[]>

    • inputs: T[]
    • Optional options: Partial<PregelOptions<Nn, Cc, ConfigurableFieldType> & {
          runType?: string;
      }> | Partial<PregelOptions<Nn, Cc, ConfigurableFieldType> & {
          runType?: string;
      }>[]
    • Optional batchOptions: RunnableBatchOptions

    Returns Promise<any[]>

    A promise that resolves to the output values.

  • Type Parameters

    • T extends any

    Parameters

    Returns Promise<any>

  • Parameters

    • state: ThreadState<DefaultValues>

    Returns StateSnapshot

  • Parameters

    • Optional config: RunnableConfig<Record<string, any>>

    Returns undefined | Checkpoint

  • Parameters

    • checkpoint: Record<string, unknown>

    Returns RunnableConfig<Record<string, any>>

  • Parameters

    • nodes: {
          data?: string | Record<string, any>;
          id: string | number;
          metadata?: unknown;
          name?: string;
      }[]

    Returns Record<string, Node>

  • Type Parameters

    Parameters

    • options: Partial<O> | Partial<O>[]
    • Optional length: number

    Returns Partial<O>[]

  • Parameters

    • config: RunnableConfig<Record<string, any>>

    Returns {
        configurable: {
            [k: string]: unknown;
        };
        metadata: any;
        tags: any;
    }

    • configurable: {
          [k: string]: unknown;
      }
      • [k: string]: unknown
    • metadata: any
    • tags: any
  • Parameters

    Returns AsyncGenerator<any, any, unknown>

  • Parameters

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • Helper method to transform an Iterator of Input values into an Iterator of Output values, with callbacks. Use this to implement stream() or transform() in Runnable subclasses.

    Type Parameters

    • I extends any
    • O extends any

    Parameters

    • inputGenerator: AsyncGenerator<I, any, unknown>
    • transformer: ((generator, runManager?, options?) => AsyncGenerator<O, any, unknown>)
        • (generator, runManager?, options?): AsyncGenerator<O, any, unknown>
        • Parameters

          Returns AsyncGenerator<O, any, unknown>

    • Optional options: Partial<PregelOptions<Nn, Cc, ConfigurableFieldType>> & {
          runType?: string;
      }

    Returns AsyncGenerator<O, any, unknown>

  • Convert a runnable to a tool. Return a new instance of RunnableToolLike which contains the runnable, name, description and schema.

    Type Parameters

    • T extends any = any

    Parameters

    • fields: {
          description?: string;
          name?: string;
          schema: ZodType<T, ZodTypeDef, T>;
      }
      • Optional description?: string

        The description of the tool. Falls back to the description on the Zod schema if not provided, or undefined if neither are provided.

      • Optional name?: string

        The name of the tool. If not provided, it will default to the name of the runnable.

      • schema: ZodType<T, ZodTypeDef, T>

        The Zod schema for the input of the tool. Infers the Zod type from the input type of the runnable.

    Returns RunnableToolLike<ZodType<ToolCall | T, ZodTypeDef, ToolCall | T>, any>

    An instance of RunnableToolLike which is a runnable that can be used as a tool.

  • Assigns new fields to the dict output of this runnable. Returns a new runnable.

    Parameters

    • mapping: RunnableMapLike<Record<string, unknown>, Record<string, unknown>>

    Returns Runnable<any, any, RunnableConfig<Record<string, any>>>

  • Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.

    Parameters

    Returns Promise<any[]>

    An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set

  • Parameters

    Returns Promise<any[]>

  • Parameters

    Returns Promise<any[]>

  • Parameters

    • Optional _: RunnableConfig<Record<string, any>> & {
          xray?: number | boolean;
      }

    Returns Graph

    Deprecated

    Use getGraphAsync instead. The async method will become the default in the next minor release.

  • Returns a drawable representation of the computation graph.

    Parameters

    • Optional config: RunnableConfig<Record<string, any>> & {
          xray?: number | boolean;
      }

    Returns Promise<Graph>

  • Parameters

    • Optional suffix: string

    Returns string

  • Parameters

    • config: RunnableConfig<Record<string, any>>
    • Optional options: {
          subgraphs?: boolean;
      }
      • Optional subgraphs?: boolean

    Returns Promise<StateSnapshot>

  • Parameters

    Returns AsyncIterableIterator<StateSnapshot>

  • Returns Generator<[string, PregelInterface<Nn, Cc, ConfigurableFieldType>], any, unknown>

    Deprecated

    Use getSubgraphsAsync instead. The async method will become the default in the next minor release.

  • Parameters

    • Optional namespace: string
    • Optional recurse: boolean

    Returns AsyncGenerator<[string, PregelInterface<Nn, Cc, ConfigurableFieldType>], any, unknown>

  • Parameters

    Returns Promise<any>

  • Pick keys from the dict output of this runnable. Returns a new runnable.

    Parameters

    • keys: string | string[]

    Returns Runnable<any, any, RunnableConfig<Record<string, any>>>

  • Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.

    Type Parameters

    • NewRunOutput

    Parameters

    • coerceable: RunnableLike<any, NewRunOutput, RunnableConfig<Record<string, any>>>

      A runnable, function, or object whose values are functions or runnables.

    Returns Runnable<any, Exclude<NewRunOutput, Error>, RunnableConfig<Record<string, any>>>

    A new runnable sequence.

  • Stream output in chunks.

    Parameters

    Returns Promise<IterableReadableStream<any>>

    A readable stream that is also an iterable.

  • Parameters

    Returns IterableReadableStream<StreamEvent>

  • Parameters

    Returns IterableReadableStream<never>

  • Stream all output from a runnable, as reported to the callback system. This includes all inner runs of LLMs, Retrievers, Tools, etc. Output is streamed as Log objects, which include a list of jsonpatch ops that describe how the state of the run has changed in each step, and the final state of the run. The jsonpatch ops can be applied in order to construct state.

    Parameters

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • Returns Serialized

  • Returns SerializedNotImplemented

  • Default implementation of transform, which buffers input and then calls stream. Subclasses should override this method if they can start producing output while input is still being generated.

    Parameters

    Returns AsyncGenerator<any, any, unknown>

  • Parameters

    Returns Promise<RunnableConfig<Record<string, any>>>

  • Create a new runnable from the current one that will try invoking other passed fallback runnables if the initial invocation fails.

    Parameters

    • fields: Runnable<any, any, RunnableConfig<Record<string, any>>>[] | {
          fallbacks: Runnable<any, any, RunnableConfig<Record<string, any>>>[];
      }

    Returns RunnableWithFallbacks<any, any>

    A new RunnableWithFallbacks.

  • Bind lifecycle listeners to a Runnable, returning a new Runnable. The Run object contains information about the run, including its id, type, input, output, error, startTime, endTime, and any tags or metadata added to the run.

    Parameters

    • params: {
          onEnd?: ((run, config?) => void | Promise<void>);
          onError?: ((run, config?) => void | Promise<void>);
          onStart?: ((run, config?) => void | Promise<void>);
      }

      The object containing the callback functions.

      • Optional onEnd?: ((run, config?) => void | Promise<void>)

        Called after the runnable finishes running, with the Run object.

          • (run, config?): void | Promise<void>
          • Parameters

            • run: Run
            • Optional config: RunnableConfig<Record<string, any>>

            Returns void | Promise<void>

      • Optional onError?: ((run, config?) => void | Promise<void>)

        Called if the runnable throws an error, with the Run object.

          • (run, config?): void | Promise<void>
          • Parameters

            • run: Run
            • Optional config: RunnableConfig<Record<string, any>>

            Returns void | Promise<void>

      • Optional onStart?: ((run, config?) => void | Promise<void>)

        Called before the runnable starts running, with the Run object.

          • (run, config?): void | Promise<void>
          • Parameters

            • run: Run
            • Optional config: RunnableConfig<Record<string, any>>

            Returns void | Promise<void>

    Returns Runnable<any, any, PregelOptions<Nn, Cc, ConfigurableFieldType>>

  • Add retry logic to an existing runnable.

    Parameters

    • Optional fields: {
          onFailedAttempt?: RunnableRetryFailedAttemptHandler;
          stopAfterAttempt?: number;
      }
      • Optional onFailedAttempt?: RunnableRetryFailedAttemptHandler
      • Optional stopAfterAttempt?: number

    Returns RunnableRetry<any, any, PregelOptions<Nn, Cc, ConfigurableFieldType>>

    A new RunnableRetry that, when invoked, will retry according to the parameters.

  • Parameters

    • thing: any

    Returns thing is Runnable<any, any, RunnableConfig<Record<string, any>>>

  • Returns string