Skip to content

RemoteGraph

RemoteGraph

Bases: PregelProtocol

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 Graph and can be used directly as a node in another Graph.

Source code in libs/langgraph/langgraph/pregel/remote.py
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
class RemoteGraph(PregelProtocol):
    """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 `Graph` and can be used directly as
    a node in another `Graph`.
    """

    name: str

    def __init__(
        self,
        name: str,  # graph_id
        /,
        *,
        url: Optional[str] = None,
        api_key: Optional[str] = None,
        headers: Optional[dict[str, str]] = None,
        client: Optional[LangGraphClient] = None,
        sync_client: Optional[SyncLangGraphClient] = None,
        config: Optional[RunnableConfig] = None,
    ):
        """Specify `url`, `api_key`, and/or `headers` to create default sync and async clients.

        If `client` or `sync_client` are provided, they will be used instead of the default clients.
        See `LangGraphClient` and `SyncLangGraphClient` for details on the default clients. At least
        one of `url`, `client`, or `sync_client` must be provided.

        Args:
            name: The name of the graph.
            url: The URL of the remote API.
            api_key: The API key to use for authentication. If not provided, it will be read from the environment (`LANGGRAPH_API_KEY`, `LANGSMITH_API_KEY`, or `LANGCHAIN_API_KEY`).
            headers: Additional headers to include in the requests.
            client: A `LangGraphClient` instance to use instead of creating a default client.
            sync_client: A `SyncLangGraphClient` instance to use instead of creating a default client.
            config: An optional `RunnableConfig` instance with additional configuration.
        """
        self.name = name
        self.config = config

        if client is None and url is not None:
            client = get_client(url=url, api_key=api_key, headers=headers)
        self.client = client

        if sync_client is None and url is not None:
            sync_client = get_sync_client(url=url, api_key=api_key, headers=headers)
        self.sync_client = sync_client

    def _validate_client(self) -> LangGraphClient:
        if self.client is None:
            raise ValueError(
                "Async client is not initialized: please provide `url` or `client` when initializing `RemoteGraph`."
            )
        return self.client

    def _validate_sync_client(self) -> SyncLangGraphClient:
        if self.sync_client is None:
            raise ValueError(
                "Sync client is not initialized: please provide `url` or `sync_client` when initializing `RemoteGraph`."
            )
        return self.sync_client

    def copy(self, update: dict[str, Any]) -> Self:
        attrs = {**self.__dict__, **update}
        return self.__class__(attrs.pop("name"), **attrs)

    def with_config(
        self, config: Optional[RunnableConfig] = None, **kwargs: Any
    ) -> Self:
        return self.copy(
            {"config": merge_configs(self.config, config, cast(RunnableConfig, kwargs))}
        )

    def _get_drawable_nodes(
        self, graph: dict[str, list[dict[str, Any]]]
    ) -> dict[str, DrawableNode]:
        nodes = {}
        for node in graph["nodes"]:
            node_id = str(node["id"])
            node_data = node.get("data", {})

            # Get node name from node_data if available. If not, use node_id.
            node_name = node.get("name")
            if node_name is None:
                if isinstance(node_data, dict):
                    node_name = node_data.get("name", node_id)
                else:
                    node_name = node_id

            nodes[node_id] = DrawableNode(
                id=node_id,
                name=node_name,
                data=node_data,
                metadata=node.get("metadata"),
            )
        return nodes

    def get_graph(
        self,
        config: Optional[RunnableConfig] = None,
        *,
        xray: Union[int, bool] = False,
    ) -> DrawableGraph:
        """Get graph by graph name.

        This method calls `GET /assistants/{assistant_id}/graph`.

        Args:
            config: This parameter is not used.
            xray: Include graph representation of subgraphs. If an integer
                value is provided, only subgraphs with a depth less than or
                equal to the value will be included.

        Returns:
            The graph information for the assistant in JSON format.
        """
        sync_client = self._validate_sync_client()
        graph = sync_client.assistants.get_graph(
            assistant_id=self.name,
            xray=xray,
        )
        return DrawableGraph(
            nodes=self._get_drawable_nodes(graph),
            edges=[DrawableEdge(**edge) for edge in graph["edges"]],
        )

    async def aget_graph(
        self,
        config: Optional[RunnableConfig] = None,
        *,
        xray: Union[int, bool] = False,
    ) -> DrawableGraph:
        """Get graph by graph name.

        This method calls `GET /assistants/{assistant_id}/graph`.

        Args:
            config: This parameter is not used.
            xray: Include graph representation of subgraphs. If an integer
                value is provided, only subgraphs with a depth less than or
                equal to the value will be included.

        Returns:
            The graph information for the assistant in JSON format.
        """
        client = self._validate_client()
        graph = await client.assistants.get_graph(
            assistant_id=self.name,
            xray=xray,
        )
        return DrawableGraph(
            nodes=self._get_drawable_nodes(graph),
            edges=[DrawableEdge(**edge) for edge in graph["edges"]],
        )

    def _create_state_snapshot(self, state: ThreadState) -> StateSnapshot:
        tasks = []
        for task in state["tasks"]:
            interrupts = []
            for interrupt in task["interrupts"]:
                interrupts.append(Interrupt(**interrupt))

            tasks.append(
                PregelTask(
                    id=task["id"],
                    name=task["name"],
                    path=tuple(),
                    error=Exception(task["error"]) if task["error"] else None,
                    interrupts=tuple(interrupts),
                    state=self._create_state_snapshot(task["state"])
                    if task["state"]
                    else cast(RunnableConfig, {"configurable": task["checkpoint"]})
                    if task["checkpoint"]
                    else None,
                    result=task.get("result"),
                )
            )

        return StateSnapshot(
            values=state["values"],
            next=tuple(state["next"]) if state["next"] else tuple(),
            config={
                "configurable": {
                    "thread_id": state["checkpoint"]["thread_id"],
                    "checkpoint_ns": state["checkpoint"]["checkpoint_ns"],
                    "checkpoint_id": state["checkpoint"]["checkpoint_id"],
                    "checkpoint_map": state["checkpoint"].get("checkpoint_map", {}),
                }
            },
            metadata=CheckpointMetadata(**state["metadata"]),
            created_at=state["created_at"],
            parent_config={
                "configurable": {
                    "thread_id": state["parent_checkpoint"]["thread_id"],
                    "checkpoint_ns": state["parent_checkpoint"]["checkpoint_ns"],
                    "checkpoint_id": state["parent_checkpoint"]["checkpoint_id"],
                    "checkpoint_map": state["parent_checkpoint"].get(
                        "checkpoint_map", {}
                    ),
                }
            }
            if state["parent_checkpoint"]
            else None,
            tasks=tuple(tasks),
        )

    def _get_checkpoint(self, config: Optional[RunnableConfig]) -> Optional[Checkpoint]:
        if config is None:
            return None

        checkpoint = {}

        if "thread_id" in config["configurable"]:
            checkpoint["thread_id"] = config["configurable"]["thread_id"]
        if "checkpoint_ns" in config["configurable"]:
            checkpoint["checkpoint_ns"] = config["configurable"]["checkpoint_ns"]
        if "checkpoint_id" in config["configurable"]:
            checkpoint["checkpoint_id"] = config["configurable"]["checkpoint_id"]
        if "checkpoint_map" in config["configurable"]:
            checkpoint["checkpoint_map"] = config["configurable"]["checkpoint_map"]

        return checkpoint if checkpoint else None

    def _get_config(self, checkpoint: Checkpoint) -> RunnableConfig:
        return {
            "configurable": {
                "thread_id": checkpoint["thread_id"],
                "checkpoint_ns": checkpoint["checkpoint_ns"],
                "checkpoint_id": checkpoint["checkpoint_id"],
                "checkpoint_map": checkpoint.get("checkpoint_map", {}),
            }
        }

    def _sanitize_config(self, config: RunnableConfig) -> RunnableConfig:
        reserved_configurable_keys = frozenset(
            [
                "callbacks",
                "checkpoint_map",
                "checkpoint_id",
                "checkpoint_ns",
            ]
        )

        def _sanitize_obj(obj: Any) -> Any:
            """Remove non-JSON serializable fields from the given object."""
            if isinstance(obj, dict):
                return {k: _sanitize_obj(v) for k, v in obj.items()}
            elif isinstance(obj, list):
                return [_sanitize_obj(v) for v in obj]
            else:
                try:
                    orjson.dumps(obj)
                    return obj
                except orjson.JSONEncodeError:
                    return None

        # Remove non-JSON serializable fields from the config.
        config = _sanitize_obj(config)

        # Only include configurable keys that are not reserved and
        # not starting with "__pregel_" prefix.
        new_configurable = {
            k: v
            for k, v in config["configurable"].items()
            if k not in reserved_configurable_keys and not k.startswith("__pregel_")
        }

        return {
            "tags": config.get("tags") or [],
            "metadata": config.get("metadata") or {},
            "configurable": new_configurable,
        }

    def get_state(
        self, config: RunnableConfig, *, subgraphs: bool = False
    ) -> StateSnapshot:
        """Get the state of a thread.

        This method calls `POST /threads/{thread_id}/state/checkpoint` if a
        checkpoint is specified in the config or `GET /threads/{thread_id}/state`
        if no checkpoint is specified.

        Args:
            config: A `RunnableConfig` that includes `thread_id` in the
                `configurable` field.
            subgraphs: Include subgraphs in the state.

        Returns:
            The latest state of the thread.
        """
        sync_client = self._validate_sync_client()
        merged_config = merge_configs(self.config, config)

        state = sync_client.threads.get_state(
            thread_id=merged_config["configurable"]["thread_id"],
            checkpoint=self._get_checkpoint(merged_config),
            subgraphs=subgraphs,
        )
        return self._create_state_snapshot(state)

    async def aget_state(
        self, config: RunnableConfig, *, subgraphs: bool = False
    ) -> StateSnapshot:
        """Get the state of a thread.

        This method calls `POST /threads/{thread_id}/state/checkpoint` if a
        checkpoint is specified in the config or `GET /threads/{thread_id}/state`
        if no checkpoint is specified.

        Args:
            config: A `RunnableConfig` that includes `thread_id` in the
                `configurable` field.
            subgraphs: Include subgraphs in the state.

        Returns:
            The latest state of the thread.
        """
        client = self._validate_client()
        merged_config = merge_configs(self.config, config)

        state = await client.threads.get_state(
            thread_id=merged_config["configurable"]["thread_id"],
            checkpoint=self._get_checkpoint(merged_config),
            subgraphs=subgraphs,
        )
        return self._create_state_snapshot(state)

    def get_state_history(
        self,
        config: RunnableConfig,
        *,
        filter: Optional[dict[str, Any]] = None,
        before: Optional[RunnableConfig] = None,
        limit: Optional[int] = None,
    ) -> Iterator[StateSnapshot]:
        """Get the state history of a thread.

        This method calls `POST /threads/{thread_id}/history`.

        Args:
            config: A `RunnableConfig` that includes `thread_id` in the
                `configurable` field.
            filter: Metadata to filter on.
            before: A `RunnableConfig` that includes checkpoint metadata.
            limit: Max number of states to return.

        Returns:
            States of the thread.
        """
        sync_client = self._validate_sync_client()
        merged_config = merge_configs(self.config, config)

        states = sync_client.threads.get_history(
            thread_id=merged_config["configurable"]["thread_id"],
            limit=limit if limit else 10,
            before=self._get_checkpoint(before),
            metadata=filter,
            checkpoint=self._get_checkpoint(merged_config),
        )
        for state in states:
            yield self._create_state_snapshot(state)

    async def aget_state_history(
        self,
        config: RunnableConfig,
        *,
        filter: Optional[dict[str, Any]] = None,
        before: Optional[RunnableConfig] = None,
        limit: Optional[int] = None,
    ) -> AsyncIterator[StateSnapshot]:
        """Get the state history of a thread.

        This method calls `POST /threads/{thread_id}/history`.

        Args:
            config: A `RunnableConfig` that includes `thread_id` in the
                `configurable` field.
            filter: Metadata to filter on.
            before: A `RunnableConfig` that includes checkpoint metadata.
            limit: Max number of states to return.

        Returns:
            States of the thread.
        """
        client = self._validate_client()
        merged_config = merge_configs(self.config, config)

        states = await client.threads.get_history(
            thread_id=merged_config["configurable"]["thread_id"],
            limit=limit if limit else 10,
            before=self._get_checkpoint(before),
            metadata=filter,
            checkpoint=self._get_checkpoint(merged_config),
        )
        for state in states:
            yield self._create_state_snapshot(state)

    def update_state(
        self,
        config: RunnableConfig,
        values: Optional[Union[dict[str, Any], Any]],
        as_node: Optional[str] = None,
    ) -> RunnableConfig:
        """Update the state of a thread.

        This method calls `POST /threads/{thread_id}/state`.

        Args:
            config: A `RunnableConfig` that includes `thread_id` in the
                `configurable` field.
            values: Values to update to the state.
            as_node: Update the state as if this node had just executed.

        Returns:
            `RunnableConfig` for the updated thread.
        """
        sync_client = self._validate_sync_client()
        merged_config = merge_configs(self.config, config)

        response: dict = sync_client.threads.update_state(  # type: ignore
            thread_id=merged_config["configurable"]["thread_id"],
            values=values,
            as_node=as_node,
            checkpoint=self._get_checkpoint(merged_config),
        )
        return self._get_config(response["checkpoint"])

    async def aupdate_state(
        self,
        config: RunnableConfig,
        values: Optional[Union[dict[str, Any], Any]],
        as_node: Optional[str] = None,
    ) -> RunnableConfig:
        """Update the state of a thread.

        This method calls `POST /threads/{thread_id}/state`.

        Args:
            config: A `RunnableConfig` that includes `thread_id` in the
                `configurable` field.
            values: Values to update to the state.
            as_node: Update the state as if this node had just executed.

        Returns:
            `RunnableConfig` for the updated thread.
        """
        client = self._validate_client()
        merged_config = merge_configs(self.config, config)

        response: dict = await client.threads.update_state(  # type: ignore
            thread_id=merged_config["configurable"]["thread_id"],
            values=values,
            as_node=as_node,
            checkpoint=self._get_checkpoint(merged_config),
        )
        return self._get_config(response["checkpoint"])

    def _get_stream_modes(
        self,
        stream_mode: Optional[Union[StreamMode, list[StreamMode]]],
        config: Optional[RunnableConfig],
        default: StreamMode = "updates",
    ) -> tuple[
        list[StreamModeSDK], list[StreamModeSDK], bool, Optional[StreamProtocol]
    ]:
        """Return a tuple of the final list of stream modes sent to the
        remote graph and a boolean flag indicating if stream mode 'updates'
        was present in the original list of stream modes.

        'updates' mode is added to the list of stream modes so that interrupts
        can be detected in the remote graph.
        """
        updated_stream_modes: list[StreamModeSDK] = []
        req_single = True
        # coerce to list, or add default stream mode
        if stream_mode:
            if isinstance(stream_mode, str):
                updated_stream_modes.append(stream_mode)
            else:
                req_single = False
                updated_stream_modes.extend(stream_mode)
        else:
            updated_stream_modes.append(default)
        requested_stream_modes = updated_stream_modes.copy()
        # add any from parent graph
        stream: Optional[StreamProtocol] = (
            (config or {}).get(CONF, {}).get(CONFIG_KEY_STREAM)
        )
        if stream:
            updated_stream_modes.extend(stream.modes)
        # map "messages" to "messages-tuple"
        if "messages" in updated_stream_modes:
            updated_stream_modes.remove("messages")
            updated_stream_modes.append("messages-tuple")

        # if requested "messages-tuple",
        # map to "messages" in requested_stream_modes
        if "messages-tuple" in requested_stream_modes:
            requested_stream_modes.remove("messages-tuple")
            requested_stream_modes.append("messages")

        # add 'updates' mode if not present
        if "updates" not in updated_stream_modes:
            updated_stream_modes.append("updates")

        # remove 'events', as it's not supported in Pregel
        if "events" in updated_stream_modes:
            updated_stream_modes.remove("events")
        return (updated_stream_modes, requested_stream_modes, req_single, stream)

    def stream(
        self,
        input: Union[dict[str, Any], Any],
        config: Optional[RunnableConfig] = None,
        *,
        stream_mode: Optional[Union[StreamMode, list[StreamMode]]] = None,
        interrupt_before: Optional[Union[All, Sequence[str]]] = None,
        interrupt_after: Optional[Union[All, Sequence[str]]] = None,
        subgraphs: bool = False,
        **kwargs: Any,
    ) -> Iterator[Union[dict[str, Any], Any]]:
        """Create a run and stream the results.

        This method calls `POST /threads/{thread_id}/runs/stream` if a `thread_id`
        is speciffed in the `configurable` field of the config or
        `POST /runs/stream` otherwise.

        Args:
            input: Input to the graph.
            config: A `RunnableConfig` for graph invocation.
            stream_mode: Stream mode(s) to use.
            interrupt_before: Interrupt the graph before these nodes.
            interrupt_after: Interrupt the graph after these nodes.
            subgraphs: Stream from subgraphs.
            **kwargs: Additional params to pass to client.runs.stream.

        Yields:
            The output of the graph.
        """
        sync_client = self._validate_sync_client()
        merged_config = merge_configs(self.config, config)
        sanitized_config = self._sanitize_config(merged_config)
        stream_modes, requested, req_single, stream = self._get_stream_modes(
            stream_mode, config
        )
        if isinstance(input, Command):
            command: Optional[CommandSDK] = cast(CommandSDK, asdict(input))
            input = None
        else:
            command = None

        for chunk in sync_client.runs.stream(
            thread_id=sanitized_config["configurable"].get("thread_id"),
            assistant_id=self.name,
            input=input,
            command=command,
            config=sanitized_config,
            stream_mode=stream_modes,
            interrupt_before=interrupt_before,
            interrupt_after=interrupt_after,
            stream_subgraphs=subgraphs or stream is not None,
            if_not_exists="create",
            **kwargs,
        ):
            # split mode and ns
            if NS_SEP in chunk.event:
                mode, ns_ = chunk.event.split(NS_SEP, 1)
                ns = tuple(ns_.split(NS_SEP))
            else:
                mode, ns = chunk.event, ()
            # prepend caller ns (as it is not passed to remote graph)
            if caller_ns := (config or {}).get(CONF, {}).get(CONFIG_KEY_CHECKPOINT_NS):
                caller_ns = tuple(caller_ns.split(NS_SEP))
                ns = caller_ns + ns
            # stream to parent stream
            if stream is not None and mode in stream.modes:
                stream((ns, mode, chunk.data))
            # raise interrupt or errors
            if chunk.event.startswith("updates"):
                if isinstance(chunk.data, dict) and INTERRUPT in chunk.data:
                    raise GraphInterrupt(chunk.data[INTERRUPT])
            elif chunk.event.startswith("error"):
                raise RemoteException(chunk.data)
            # filter for what was actually requested
            if mode not in requested:
                continue
            # emit chunk
            if subgraphs:
                if NS_SEP in chunk.event:
                    mode, ns_ = chunk.event.split(NS_SEP, 1)
                    ns = tuple(ns_.split(NS_SEP))
                else:
                    mode, ns = chunk.event, ()
                if req_single:
                    yield ns, chunk.data
                else:
                    yield ns, mode, chunk.data
            elif req_single:
                yield chunk.data
            else:
                yield chunk

    async def astream(
        self,
        input: Union[dict[str, Any], Any],
        config: Optional[RunnableConfig] = None,
        *,
        stream_mode: Optional[Union[StreamMode, list[StreamMode]]] = None,
        interrupt_before: Optional[Union[All, Sequence[str]]] = None,
        interrupt_after: Optional[Union[All, Sequence[str]]] = None,
        subgraphs: bool = False,
        **kwargs: Any,
    ) -> AsyncIterator[Union[dict[str, Any], Any]]:
        """Create a run and stream the results.

        This method calls `POST /threads/{thread_id}/runs/stream` if a `thread_id`
        is speciffed in the `configurable` field of the config or
        `POST /runs/stream` otherwise.

        Args:
            input: Input to the graph.
            config: A `RunnableConfig` for graph invocation.
            stream_mode: Stream mode(s) to use.
            interrupt_before: Interrupt the graph before these nodes.
            interrupt_after: Interrupt the graph after these nodes.
            subgraphs: Stream from subgraphs.
            **kwargs: Additional params to pass to client.runs.stream.

        Yields:
            The output of the graph.
        """
        client = self._validate_client()
        merged_config = merge_configs(self.config, config)
        sanitized_config = self._sanitize_config(merged_config)
        stream_modes, requested, req_single, stream = self._get_stream_modes(
            stream_mode, config
        )
        if isinstance(input, Command):
            command: Optional[CommandSDK] = cast(CommandSDK, asdict(input))
            input = None
        else:
            command = None

        async for chunk in client.runs.stream(
            thread_id=sanitized_config["configurable"].get("thread_id"),
            assistant_id=self.name,
            input=input,
            command=command,
            config=sanitized_config,
            stream_mode=stream_modes,
            interrupt_before=interrupt_before,
            interrupt_after=interrupt_after,
            stream_subgraphs=subgraphs or stream is not None,
            if_not_exists="create",
            **kwargs,
        ):
            # split mode and ns
            if NS_SEP in chunk.event:
                mode, ns_ = chunk.event.split(NS_SEP, 1)
                ns = tuple(ns_.split(NS_SEP))
            else:
                mode, ns = chunk.event, ()
            # prepend caller ns (as it is not passed to remote graph)
            if caller_ns := (config or {}).get(CONF, {}).get(CONFIG_KEY_CHECKPOINT_NS):
                caller_ns = tuple(caller_ns.split(NS_SEP))
                ns = caller_ns + ns
            # stream to parent stream
            if stream is not None and mode in stream.modes:
                stream((ns, mode, chunk.data))
            # raise interrupt or errors
            if chunk.event.startswith("updates"):
                if isinstance(chunk.data, dict) and INTERRUPT in chunk.data:
                    raise GraphInterrupt(chunk.data[INTERRUPT])
            elif chunk.event.startswith("error"):
                raise RemoteException(chunk.data)
            # filter for what was actually requested
            if mode not in requested:
                continue
            # emit chunk
            if subgraphs:
                if NS_SEP in chunk.event:
                    mode, ns_ = chunk.event.split(NS_SEP, 1)
                    ns = tuple(ns_.split(NS_SEP))
                else:
                    mode, ns = chunk.event, ()
                if req_single:
                    yield ns, chunk.data
                else:
                    yield ns, mode, chunk.data
            elif req_single:
                yield chunk.data
            else:
                yield chunk

    async def astream_events(
        self,
        input: Any,
        config: Optional[RunnableConfig] = None,
        *,
        version: Literal["v1", "v2"],
        include_names: Optional[Sequence[All]] = None,
        include_types: Optional[Sequence[All]] = None,
        include_tags: Optional[Sequence[All]] = None,
        exclude_names: Optional[Sequence[All]] = None,
        exclude_types: Optional[Sequence[All]] = None,
        exclude_tags: Optional[Sequence[All]] = None,
        **kwargs: Any,
    ) -> AsyncIterator[dict[str, Any]]:
        raise NotImplementedError

    def invoke(
        self,
        input: Union[dict[str, Any], Any],
        config: Optional[RunnableConfig] = None,
        *,
        interrupt_before: Optional[Union[All, Sequence[str]]] = None,
        interrupt_after: Optional[Union[All, Sequence[str]]] = None,
        **kwargs: Any,
    ) -> Union[dict[str, Any], Any]:
        """Create a run, wait until it finishes and return the final state.

        Args:
            input: Input to the graph.
            config: A `RunnableConfig` for graph invocation.
            interrupt_before: Interrupt the graph before these nodes.
            interrupt_after: Interrupt the graph after these nodes.
            **kwargs: Additional params to pass to RemoteGraph.stream.

        Returns:
            The output of the graph.
        """
        for chunk in self.stream(
            input,
            config=config,
            interrupt_before=interrupt_before,
            interrupt_after=interrupt_after,
            stream_mode="values",
            **kwargs,
        ):
            pass
        try:
            return chunk
        except UnboundLocalError:
            return None

    async def ainvoke(
        self,
        input: Union[dict[str, Any], Any],
        config: Optional[RunnableConfig] = None,
        *,
        interrupt_before: Optional[Union[All, Sequence[str]]] = None,
        interrupt_after: Optional[Union[All, Sequence[str]]] = None,
        **kwargs: Any,
    ) -> Union[dict[str, Any], Any]:
        """Create a run, wait until it finishes and return the final state.

        Args:
            input: Input to the graph.
            config: A `RunnableConfig` for graph invocation.
            interrupt_before: Interrupt the graph before these nodes.
            interrupt_after: Interrupt the graph after these nodes.
            **kwargs: Additional params to pass to RemoteGraph.astream.

        Returns:
            The output of the graph.
        """
        async for chunk in self.astream(
            input,
            config=config,
            interrupt_before=interrupt_before,
            interrupt_after=interrupt_after,
            stream_mode="values",
            **kwargs,
        ):
            pass
        try:
            return chunk
        except UnboundLocalError:
            return None

__init__(name: str, /, *, url: Optional[str] = None, api_key: Optional[str] = None, headers: Optional[dict[str, str]] = None, client: Optional[LangGraphClient] = None, sync_client: Optional[SyncLangGraphClient] = None, config: Optional[RunnableConfig] = None)

Specify url, api_key, and/or headers to create default sync and async clients.

If client or sync_client are provided, they will be used instead of the default clients. See LangGraphClient and SyncLangGraphClient for details on the default clients. At least one of url, client, or sync_client must be provided.

Parameters:

  • name (str) –

    The name of the graph.

  • url (Optional[str], default: None ) –

    The URL of the remote API.

  • api_key (Optional[str], default: None ) –

    The API key to use for authentication. If not provided, it will be read from the environment (LANGGRAPH_API_KEY, LANGSMITH_API_KEY, or LANGCHAIN_API_KEY).

  • headers (Optional[dict[str, str]], default: None ) –

    Additional headers to include in the requests.

  • client (Optional[LangGraphClient], default: None ) –

    A LangGraphClient instance to use instead of creating a default client.

  • sync_client (Optional[SyncLangGraphClient], default: None ) –

    A SyncLangGraphClient instance to use instead of creating a default client.

  • config (Optional[RunnableConfig], default: None ) –

    An optional RunnableConfig instance with additional configuration.

Source code in libs/langgraph/langgraph/pregel/remote.py
def __init__(
    self,
    name: str,  # graph_id
    /,
    *,
    url: Optional[str] = None,
    api_key: Optional[str] = None,
    headers: Optional[dict[str, str]] = None,
    client: Optional[LangGraphClient] = None,
    sync_client: Optional[SyncLangGraphClient] = None,
    config: Optional[RunnableConfig] = None,
):
    """Specify `url`, `api_key`, and/or `headers` to create default sync and async clients.

    If `client` or `sync_client` are provided, they will be used instead of the default clients.
    See `LangGraphClient` and `SyncLangGraphClient` for details on the default clients. At least
    one of `url`, `client`, or `sync_client` must be provided.

    Args:
        name: The name of the graph.
        url: The URL of the remote API.
        api_key: The API key to use for authentication. If not provided, it will be read from the environment (`LANGGRAPH_API_KEY`, `LANGSMITH_API_KEY`, or `LANGCHAIN_API_KEY`).
        headers: Additional headers to include in the requests.
        client: A `LangGraphClient` instance to use instead of creating a default client.
        sync_client: A `SyncLangGraphClient` instance to use instead of creating a default client.
        config: An optional `RunnableConfig` instance with additional configuration.
    """
    self.name = name
    self.config = config

    if client is None and url is not None:
        client = get_client(url=url, api_key=api_key, headers=headers)
    self.client = client

    if sync_client is None and url is not None:
        sync_client = get_sync_client(url=url, api_key=api_key, headers=headers)
    self.sync_client = sync_client

get_graph(config: Optional[RunnableConfig] = None, *, xray: Union[int, bool] = False) -> DrawableGraph

Get graph by graph name.

This method calls GET /assistants/{assistant_id}/graph.

Parameters:

  • config (Optional[RunnableConfig], default: None ) –

    This parameter is not used.

  • xray (Union[int, bool], default: False ) –

    Include graph representation of subgraphs. If an integer value is provided, only subgraphs with a depth less than or equal to the value will be included.

Returns:

  • Graph

    The graph information for the assistant in JSON format.

Source code in libs/langgraph/langgraph/pregel/remote.py
def get_graph(
    self,
    config: Optional[RunnableConfig] = None,
    *,
    xray: Union[int, bool] = False,
) -> DrawableGraph:
    """Get graph by graph name.

    This method calls `GET /assistants/{assistant_id}/graph`.

    Args:
        config: This parameter is not used.
        xray: Include graph representation of subgraphs. If an integer
            value is provided, only subgraphs with a depth less than or
            equal to the value will be included.

    Returns:
        The graph information for the assistant in JSON format.
    """
    sync_client = self._validate_sync_client()
    graph = sync_client.assistants.get_graph(
        assistant_id=self.name,
        xray=xray,
    )
    return DrawableGraph(
        nodes=self._get_drawable_nodes(graph),
        edges=[DrawableEdge(**edge) for edge in graph["edges"]],
    )

aget_graph(config: Optional[RunnableConfig] = None, *, xray: Union[int, bool] = False) -> DrawableGraph async

Get graph by graph name.

This method calls GET /assistants/{assistant_id}/graph.

Parameters:

  • config (Optional[RunnableConfig], default: None ) –

    This parameter is not used.

  • xray (Union[int, bool], default: False ) –

    Include graph representation of subgraphs. If an integer value is provided, only subgraphs with a depth less than or equal to the value will be included.

Returns:

  • Graph

    The graph information for the assistant in JSON format.

Source code in libs/langgraph/langgraph/pregel/remote.py
async def aget_graph(
    self,
    config: Optional[RunnableConfig] = None,
    *,
    xray: Union[int, bool] = False,
) -> DrawableGraph:
    """Get graph by graph name.

    This method calls `GET /assistants/{assistant_id}/graph`.

    Args:
        config: This parameter is not used.
        xray: Include graph representation of subgraphs. If an integer
            value is provided, only subgraphs with a depth less than or
            equal to the value will be included.

    Returns:
        The graph information for the assistant in JSON format.
    """
    client = self._validate_client()
    graph = await client.assistants.get_graph(
        assistant_id=self.name,
        xray=xray,
    )
    return DrawableGraph(
        nodes=self._get_drawable_nodes(graph),
        edges=[DrawableEdge(**edge) for edge in graph["edges"]],
    )

get_state(config: RunnableConfig, *, subgraphs: bool = False) -> StateSnapshot

Get the state of a thread.

This method calls POST /threads/{thread_id}/state/checkpoint if a checkpoint is specified in the config or GET /threads/{thread_id}/state if no checkpoint is specified.

Parameters:

  • config (RunnableConfig) –

    A RunnableConfig that includes thread_id in the configurable field.

  • subgraphs (bool, default: False ) –

    Include subgraphs in the state.

Returns:

  • StateSnapshot

    The latest state of the thread.

Source code in libs/langgraph/langgraph/pregel/remote.py
def get_state(
    self, config: RunnableConfig, *, subgraphs: bool = False
) -> StateSnapshot:
    """Get the state of a thread.

    This method calls `POST /threads/{thread_id}/state/checkpoint` if a
    checkpoint is specified in the config or `GET /threads/{thread_id}/state`
    if no checkpoint is specified.

    Args:
        config: A `RunnableConfig` that includes `thread_id` in the
            `configurable` field.
        subgraphs: Include subgraphs in the state.

    Returns:
        The latest state of the thread.
    """
    sync_client = self._validate_sync_client()
    merged_config = merge_configs(self.config, config)

    state = sync_client.threads.get_state(
        thread_id=merged_config["configurable"]["thread_id"],
        checkpoint=self._get_checkpoint(merged_config),
        subgraphs=subgraphs,
    )
    return self._create_state_snapshot(state)

aget_state(config: RunnableConfig, *, subgraphs: bool = False) -> StateSnapshot async

Get the state of a thread.

This method calls POST /threads/{thread_id}/state/checkpoint if a checkpoint is specified in the config or GET /threads/{thread_id}/state if no checkpoint is specified.

Parameters:

  • config (RunnableConfig) –

    A RunnableConfig that includes thread_id in the configurable field.

  • subgraphs (bool, default: False ) –

    Include subgraphs in the state.

Returns:

  • StateSnapshot

    The latest state of the thread.

Source code in libs/langgraph/langgraph/pregel/remote.py
async def aget_state(
    self, config: RunnableConfig, *, subgraphs: bool = False
) -> StateSnapshot:
    """Get the state of a thread.

    This method calls `POST /threads/{thread_id}/state/checkpoint` if a
    checkpoint is specified in the config or `GET /threads/{thread_id}/state`
    if no checkpoint is specified.

    Args:
        config: A `RunnableConfig` that includes `thread_id` in the
            `configurable` field.
        subgraphs: Include subgraphs in the state.

    Returns:
        The latest state of the thread.
    """
    client = self._validate_client()
    merged_config = merge_configs(self.config, config)

    state = await client.threads.get_state(
        thread_id=merged_config["configurable"]["thread_id"],
        checkpoint=self._get_checkpoint(merged_config),
        subgraphs=subgraphs,
    )
    return self._create_state_snapshot(state)

get_state_history(config: RunnableConfig, *, filter: Optional[dict[str, Any]] = None, before: Optional[RunnableConfig] = None, limit: Optional[int] = None) -> Iterator[StateSnapshot]

Get the state history of a thread.

This method calls POST /threads/{thread_id}/history.

Parameters:

  • config (RunnableConfig) –

    A RunnableConfig that includes thread_id in the configurable field.

  • filter (Optional[dict[str, Any]], default: None ) –

    Metadata to filter on.

  • before (Optional[RunnableConfig], default: None ) –

    A RunnableConfig that includes checkpoint metadata.

  • limit (Optional[int], default: None ) –

    Max number of states to return.

Returns:

  • Iterator[StateSnapshot]

    States of the thread.

Source code in libs/langgraph/langgraph/pregel/remote.py
def get_state_history(
    self,
    config: RunnableConfig,
    *,
    filter: Optional[dict[str, Any]] = None,
    before: Optional[RunnableConfig] = None,
    limit: Optional[int] = None,
) -> Iterator[StateSnapshot]:
    """Get the state history of a thread.

    This method calls `POST /threads/{thread_id}/history`.

    Args:
        config: A `RunnableConfig` that includes `thread_id` in the
            `configurable` field.
        filter: Metadata to filter on.
        before: A `RunnableConfig` that includes checkpoint metadata.
        limit: Max number of states to return.

    Returns:
        States of the thread.
    """
    sync_client = self._validate_sync_client()
    merged_config = merge_configs(self.config, config)

    states = sync_client.threads.get_history(
        thread_id=merged_config["configurable"]["thread_id"],
        limit=limit if limit else 10,
        before=self._get_checkpoint(before),
        metadata=filter,
        checkpoint=self._get_checkpoint(merged_config),
    )
    for state in states:
        yield self._create_state_snapshot(state)

aget_state_history(config: RunnableConfig, *, filter: Optional[dict[str, Any]] = None, before: Optional[RunnableConfig] = None, limit: Optional[int] = None) -> AsyncIterator[StateSnapshot] async

Get the state history of a thread.

This method calls POST /threads/{thread_id}/history.

Parameters:

  • config (RunnableConfig) –

    A RunnableConfig that includes thread_id in the configurable field.

  • filter (Optional[dict[str, Any]], default: None ) –

    Metadata to filter on.

  • before (Optional[RunnableConfig], default: None ) –

    A RunnableConfig that includes checkpoint metadata.

  • limit (Optional[int], default: None ) –

    Max number of states to return.

Returns:

  • AsyncIterator[StateSnapshot]

    States of the thread.

Source code in libs/langgraph/langgraph/pregel/remote.py
async def aget_state_history(
    self,
    config: RunnableConfig,
    *,
    filter: Optional[dict[str, Any]] = None,
    before: Optional[RunnableConfig] = None,
    limit: Optional[int] = None,
) -> AsyncIterator[StateSnapshot]:
    """Get the state history of a thread.

    This method calls `POST /threads/{thread_id}/history`.

    Args:
        config: A `RunnableConfig` that includes `thread_id` in the
            `configurable` field.
        filter: Metadata to filter on.
        before: A `RunnableConfig` that includes checkpoint metadata.
        limit: Max number of states to return.

    Returns:
        States of the thread.
    """
    client = self._validate_client()
    merged_config = merge_configs(self.config, config)

    states = await client.threads.get_history(
        thread_id=merged_config["configurable"]["thread_id"],
        limit=limit if limit else 10,
        before=self._get_checkpoint(before),
        metadata=filter,
        checkpoint=self._get_checkpoint(merged_config),
    )
    for state in states:
        yield self._create_state_snapshot(state)

update_state(config: RunnableConfig, values: Optional[Union[dict[str, Any], Any]], as_node: Optional[str] = None) -> RunnableConfig

Update the state of a thread.

This method calls POST /threads/{thread_id}/state.

Parameters:

  • config (RunnableConfig) –

    A RunnableConfig that includes thread_id in the configurable field.

  • values (Optional[Union[dict[str, Any], Any]]) –

    Values to update to the state.

  • as_node (Optional[str], default: None ) –

    Update the state as if this node had just executed.

Returns:

  • RunnableConfig

    RunnableConfig for the updated thread.

Source code in libs/langgraph/langgraph/pregel/remote.py
def update_state(
    self,
    config: RunnableConfig,
    values: Optional[Union[dict[str, Any], Any]],
    as_node: Optional[str] = None,
) -> RunnableConfig:
    """Update the state of a thread.

    This method calls `POST /threads/{thread_id}/state`.

    Args:
        config: A `RunnableConfig` that includes `thread_id` in the
            `configurable` field.
        values: Values to update to the state.
        as_node: Update the state as if this node had just executed.

    Returns:
        `RunnableConfig` for the updated thread.
    """
    sync_client = self._validate_sync_client()
    merged_config = merge_configs(self.config, config)

    response: dict = sync_client.threads.update_state(  # type: ignore
        thread_id=merged_config["configurable"]["thread_id"],
        values=values,
        as_node=as_node,
        checkpoint=self._get_checkpoint(merged_config),
    )
    return self._get_config(response["checkpoint"])

aupdate_state(config: RunnableConfig, values: Optional[Union[dict[str, Any], Any]], as_node: Optional[str] = None) -> RunnableConfig async

Update the state of a thread.

This method calls POST /threads/{thread_id}/state.

Parameters:

  • config (RunnableConfig) –

    A RunnableConfig that includes thread_id in the configurable field.

  • values (Optional[Union[dict[str, Any], Any]]) –

    Values to update to the state.

  • as_node (Optional[str], default: None ) –

    Update the state as if this node had just executed.

Returns:

  • RunnableConfig

    RunnableConfig for the updated thread.

Source code in libs/langgraph/langgraph/pregel/remote.py
async def aupdate_state(
    self,
    config: RunnableConfig,
    values: Optional[Union[dict[str, Any], Any]],
    as_node: Optional[str] = None,
) -> RunnableConfig:
    """Update the state of a thread.

    This method calls `POST /threads/{thread_id}/state`.

    Args:
        config: A `RunnableConfig` that includes `thread_id` in the
            `configurable` field.
        values: Values to update to the state.
        as_node: Update the state as if this node had just executed.

    Returns:
        `RunnableConfig` for the updated thread.
    """
    client = self._validate_client()
    merged_config = merge_configs(self.config, config)

    response: dict = await client.threads.update_state(  # type: ignore
        thread_id=merged_config["configurable"]["thread_id"],
        values=values,
        as_node=as_node,
        checkpoint=self._get_checkpoint(merged_config),
    )
    return self._get_config(response["checkpoint"])

stream(input: Union[dict[str, Any], Any], config: Optional[RunnableConfig] = None, *, stream_mode: Optional[Union[StreamMode, list[StreamMode]]] = None, interrupt_before: Optional[Union[All, Sequence[str]]] = None, interrupt_after: Optional[Union[All, Sequence[str]]] = None, subgraphs: bool = False, **kwargs: Any) -> Iterator[Union[dict[str, Any], Any]]

Create a run and stream the results.

This method calls POST /threads/{thread_id}/runs/stream if a thread_id is speciffed in the configurable field of the config or POST /runs/stream otherwise.

Parameters:

  • input (Union[dict[str, Any], Any]) –

    Input to the graph.

  • config (Optional[RunnableConfig], default: None ) –

    A RunnableConfig for graph invocation.

  • stream_mode (Optional[Union[StreamMode, list[StreamMode]]], default: None ) –

    Stream mode(s) to use.

  • interrupt_before (Optional[Union[All, Sequence[str]]], default: None ) –

    Interrupt the graph before these nodes.

  • interrupt_after (Optional[Union[All, Sequence[str]]], default: None ) –

    Interrupt the graph after these nodes.

  • subgraphs (bool, default: False ) –

    Stream from subgraphs.

  • **kwargs (Any, default: {} ) –

    Additional params to pass to client.runs.stream.

Yields:

  • Union[dict[str, Any], Any]

    The output of the graph.

Source code in libs/langgraph/langgraph/pregel/remote.py
def stream(
    self,
    input: Union[dict[str, Any], Any],
    config: Optional[RunnableConfig] = None,
    *,
    stream_mode: Optional[Union[StreamMode, list[StreamMode]]] = None,
    interrupt_before: Optional[Union[All, Sequence[str]]] = None,
    interrupt_after: Optional[Union[All, Sequence[str]]] = None,
    subgraphs: bool = False,
    **kwargs: Any,
) -> Iterator[Union[dict[str, Any], Any]]:
    """Create a run and stream the results.

    This method calls `POST /threads/{thread_id}/runs/stream` if a `thread_id`
    is speciffed in the `configurable` field of the config or
    `POST /runs/stream` otherwise.

    Args:
        input: Input to the graph.
        config: A `RunnableConfig` for graph invocation.
        stream_mode: Stream mode(s) to use.
        interrupt_before: Interrupt the graph before these nodes.
        interrupt_after: Interrupt the graph after these nodes.
        subgraphs: Stream from subgraphs.
        **kwargs: Additional params to pass to client.runs.stream.

    Yields:
        The output of the graph.
    """
    sync_client = self._validate_sync_client()
    merged_config = merge_configs(self.config, config)
    sanitized_config = self._sanitize_config(merged_config)
    stream_modes, requested, req_single, stream = self._get_stream_modes(
        stream_mode, config
    )
    if isinstance(input, Command):
        command: Optional[CommandSDK] = cast(CommandSDK, asdict(input))
        input = None
    else:
        command = None

    for chunk in sync_client.runs.stream(
        thread_id=sanitized_config["configurable"].get("thread_id"),
        assistant_id=self.name,
        input=input,
        command=command,
        config=sanitized_config,
        stream_mode=stream_modes,
        interrupt_before=interrupt_before,
        interrupt_after=interrupt_after,
        stream_subgraphs=subgraphs or stream is not None,
        if_not_exists="create",
        **kwargs,
    ):
        # split mode and ns
        if NS_SEP in chunk.event:
            mode, ns_ = chunk.event.split(NS_SEP, 1)
            ns = tuple(ns_.split(NS_SEP))
        else:
            mode, ns = chunk.event, ()
        # prepend caller ns (as it is not passed to remote graph)
        if caller_ns := (config or {}).get(CONF, {}).get(CONFIG_KEY_CHECKPOINT_NS):
            caller_ns = tuple(caller_ns.split(NS_SEP))
            ns = caller_ns + ns
        # stream to parent stream
        if stream is not None and mode in stream.modes:
            stream((ns, mode, chunk.data))
        # raise interrupt or errors
        if chunk.event.startswith("updates"):
            if isinstance(chunk.data, dict) and INTERRUPT in chunk.data:
                raise GraphInterrupt(chunk.data[INTERRUPT])
        elif chunk.event.startswith("error"):
            raise RemoteException(chunk.data)
        # filter for what was actually requested
        if mode not in requested:
            continue
        # emit chunk
        if subgraphs:
            if NS_SEP in chunk.event:
                mode, ns_ = chunk.event.split(NS_SEP, 1)
                ns = tuple(ns_.split(NS_SEP))
            else:
                mode, ns = chunk.event, ()
            if req_single:
                yield ns, chunk.data
            else:
                yield ns, mode, chunk.data
        elif req_single:
            yield chunk.data
        else:
            yield chunk

astream(input: Union[dict[str, Any], Any], config: Optional[RunnableConfig] = None, *, stream_mode: Optional[Union[StreamMode, list[StreamMode]]] = None, interrupt_before: Optional[Union[All, Sequence[str]]] = None, interrupt_after: Optional[Union[All, Sequence[str]]] = None, subgraphs: bool = False, **kwargs: Any) -> AsyncIterator[Union[dict[str, Any], Any]] async

Create a run and stream the results.

This method calls POST /threads/{thread_id}/runs/stream if a thread_id is speciffed in the configurable field of the config or POST /runs/stream otherwise.

Parameters:

  • input (Union[dict[str, Any], Any]) –

    Input to the graph.

  • config (Optional[RunnableConfig], default: None ) –

    A RunnableConfig for graph invocation.

  • stream_mode (Optional[Union[StreamMode, list[StreamMode]]], default: None ) –

    Stream mode(s) to use.

  • interrupt_before (Optional[Union[All, Sequence[str]]], default: None ) –

    Interrupt the graph before these nodes.

  • interrupt_after (Optional[Union[All, Sequence[str]]], default: None ) –

    Interrupt the graph after these nodes.

  • subgraphs (bool, default: False ) –

    Stream from subgraphs.

  • **kwargs (Any, default: {} ) –

    Additional params to pass to client.runs.stream.

Yields:

  • AsyncIterator[Union[dict[str, Any], Any]]

    The output of the graph.

Source code in libs/langgraph/langgraph/pregel/remote.py
async def astream(
    self,
    input: Union[dict[str, Any], Any],
    config: Optional[RunnableConfig] = None,
    *,
    stream_mode: Optional[Union[StreamMode, list[StreamMode]]] = None,
    interrupt_before: Optional[Union[All, Sequence[str]]] = None,
    interrupt_after: Optional[Union[All, Sequence[str]]] = None,
    subgraphs: bool = False,
    **kwargs: Any,
) -> AsyncIterator[Union[dict[str, Any], Any]]:
    """Create a run and stream the results.

    This method calls `POST /threads/{thread_id}/runs/stream` if a `thread_id`
    is speciffed in the `configurable` field of the config or
    `POST /runs/stream` otherwise.

    Args:
        input: Input to the graph.
        config: A `RunnableConfig` for graph invocation.
        stream_mode: Stream mode(s) to use.
        interrupt_before: Interrupt the graph before these nodes.
        interrupt_after: Interrupt the graph after these nodes.
        subgraphs: Stream from subgraphs.
        **kwargs: Additional params to pass to client.runs.stream.

    Yields:
        The output of the graph.
    """
    client = self._validate_client()
    merged_config = merge_configs(self.config, config)
    sanitized_config = self._sanitize_config(merged_config)
    stream_modes, requested, req_single, stream = self._get_stream_modes(
        stream_mode, config
    )
    if isinstance(input, Command):
        command: Optional[CommandSDK] = cast(CommandSDK, asdict(input))
        input = None
    else:
        command = None

    async for chunk in client.runs.stream(
        thread_id=sanitized_config["configurable"].get("thread_id"),
        assistant_id=self.name,
        input=input,
        command=command,
        config=sanitized_config,
        stream_mode=stream_modes,
        interrupt_before=interrupt_before,
        interrupt_after=interrupt_after,
        stream_subgraphs=subgraphs or stream is not None,
        if_not_exists="create",
        **kwargs,
    ):
        # split mode and ns
        if NS_SEP in chunk.event:
            mode, ns_ = chunk.event.split(NS_SEP, 1)
            ns = tuple(ns_.split(NS_SEP))
        else:
            mode, ns = chunk.event, ()
        # prepend caller ns (as it is not passed to remote graph)
        if caller_ns := (config or {}).get(CONF, {}).get(CONFIG_KEY_CHECKPOINT_NS):
            caller_ns = tuple(caller_ns.split(NS_SEP))
            ns = caller_ns + ns
        # stream to parent stream
        if stream is not None and mode in stream.modes:
            stream((ns, mode, chunk.data))
        # raise interrupt or errors
        if chunk.event.startswith("updates"):
            if isinstance(chunk.data, dict) and INTERRUPT in chunk.data:
                raise GraphInterrupt(chunk.data[INTERRUPT])
        elif chunk.event.startswith("error"):
            raise RemoteException(chunk.data)
        # filter for what was actually requested
        if mode not in requested:
            continue
        # emit chunk
        if subgraphs:
            if NS_SEP in chunk.event:
                mode, ns_ = chunk.event.split(NS_SEP, 1)
                ns = tuple(ns_.split(NS_SEP))
            else:
                mode, ns = chunk.event, ()
            if req_single:
                yield ns, chunk.data
            else:
                yield ns, mode, chunk.data
        elif req_single:
            yield chunk.data
        else:
            yield chunk

invoke(input: Union[dict[str, Any], Any], config: Optional[RunnableConfig] = None, *, interrupt_before: Optional[Union[All, Sequence[str]]] = None, interrupt_after: Optional[Union[All, Sequence[str]]] = None, **kwargs: Any) -> Union[dict[str, Any], Any]

Create a run, wait until it finishes and return the final state.

Parameters:

  • input (Union[dict[str, Any], Any]) –

    Input to the graph.

  • config (Optional[RunnableConfig], default: None ) –

    A RunnableConfig for graph invocation.

  • interrupt_before (Optional[Union[All, Sequence[str]]], default: None ) –

    Interrupt the graph before these nodes.

  • interrupt_after (Optional[Union[All, Sequence[str]]], default: None ) –

    Interrupt the graph after these nodes.

  • **kwargs (Any, default: {} ) –

    Additional params to pass to RemoteGraph.stream.

Returns:

  • Union[dict[str, Any], Any]

    The output of the graph.

Source code in libs/langgraph/langgraph/pregel/remote.py
def invoke(
    self,
    input: Union[dict[str, Any], Any],
    config: Optional[RunnableConfig] = None,
    *,
    interrupt_before: Optional[Union[All, Sequence[str]]] = None,
    interrupt_after: Optional[Union[All, Sequence[str]]] = None,
    **kwargs: Any,
) -> Union[dict[str, Any], Any]:
    """Create a run, wait until it finishes and return the final state.

    Args:
        input: Input to the graph.
        config: A `RunnableConfig` for graph invocation.
        interrupt_before: Interrupt the graph before these nodes.
        interrupt_after: Interrupt the graph after these nodes.
        **kwargs: Additional params to pass to RemoteGraph.stream.

    Returns:
        The output of the graph.
    """
    for chunk in self.stream(
        input,
        config=config,
        interrupt_before=interrupt_before,
        interrupt_after=interrupt_after,
        stream_mode="values",
        **kwargs,
    ):
        pass
    try:
        return chunk
    except UnboundLocalError:
        return None

ainvoke(input: Union[dict[str, Any], Any], config: Optional[RunnableConfig] = None, *, interrupt_before: Optional[Union[All, Sequence[str]]] = None, interrupt_after: Optional[Union[All, Sequence[str]]] = None, **kwargs: Any) -> Union[dict[str, Any], Any] async

Create a run, wait until it finishes and return the final state.

Parameters:

  • input (Union[dict[str, Any], Any]) –

    Input to the graph.

  • config (Optional[RunnableConfig], default: None ) –

    A RunnableConfig for graph invocation.

  • interrupt_before (Optional[Union[All, Sequence[str]]], default: None ) –

    Interrupt the graph before these nodes.

  • interrupt_after (Optional[Union[All, Sequence[str]]], default: None ) –

    Interrupt the graph after these nodes.

  • **kwargs (Any, default: {} ) –

    Additional params to pass to RemoteGraph.astream.

Returns:

  • Union[dict[str, Any], Any]

    The output of the graph.

Source code in libs/langgraph/langgraph/pregel/remote.py
async def ainvoke(
    self,
    input: Union[dict[str, Any], Any],
    config: Optional[RunnableConfig] = None,
    *,
    interrupt_before: Optional[Union[All, Sequence[str]]] = None,
    interrupt_after: Optional[Union[All, Sequence[str]]] = None,
    **kwargs: Any,
) -> Union[dict[str, Any], Any]:
    """Create a run, wait until it finishes and return the final state.

    Args:
        input: Input to the graph.
        config: A `RunnableConfig` for graph invocation.
        interrupt_before: Interrupt the graph before these nodes.
        interrupt_after: Interrupt the graph after these nodes.
        **kwargs: Additional params to pass to RemoteGraph.astream.

    Returns:
        The output of the graph.
    """
    async for chunk in self.astream(
        input,
        config=config,
        interrupt_before=interrupt_before,
        interrupt_after=interrupt_after,
        stream_mode="values",
        **kwargs,
    ):
        pass
    try:
        return chunk
    except UnboundLocalError:
        return None

Comments