Method●Since v0.6

ainvoke

Asynchronously run the graph with a single input and config.

ainvoke(
  self,
  input: InputT | Command | None,
  config: RunnableConfig | None = None,
  *,
  context: ContextT | None = None,
  stream_mode: StreamMode = 'values',
  print_mode: StreamMode | Sequence[StreamMode] = (),
  output_keys: str | Sequence[str] | None = None,
  interrupt_before: All | Sequence[str] | None = None,
  interrupt_after: All | Sequence[str] | None = None,
  durability: Durability | None = None,
  version: Literal['v1', 'v2'] = 'v1',
  **kwargs: Any = {}
) -> dict[str, Any] | Any

Parameters

Name	Type	Description
`input`*	`InputT \| Command \| None`	The input data for the graph. It can be a dictionary or any other type.
`config`	`RunnableConfig \| None`	Default:`None` The configuration for the graph run.
`context`	`ContextT \| None`	Default:`None` The static context to use for the run.
`stream_mode`	`StreamMode`	Default:`'values'` The stream mode for the graph run.
`print_mode`	`StreamMode \| Sequence[StreamMode]`	Default:`()` Accepts the same values as `stream_mode`, but only prints the output to the console, for debugging purposes. Does not affect the output of the graph in any way.
`output_keys`	`str \| Sequence[str] \| None`	Default:`None` The output keys to retrieve from the graph run.
`interrupt_before`	`All \| Sequence[str] \| None`	Default:`None` The nodes to interrupt the graph run before.
`interrupt_after`	`All \| Sequence[str] \| None`	Default:`None` The nodes to interrupt the graph run after.
`durability`	`Durability \| None`	Default:`None` The durability mode for the graph execution, defaults to `"async"`. Options are: `"sync"`: Changes are persisted synchronously before the next step starts. `"async"`: Changes are persisted asynchronously while the next step executes. `"exit"`: Changes are persisted only when the graph exits.
`version`	`Literal['v1', 'v2']`	Default:`'v1'` The streaming format version. `"v1"` (default) returns the traditional format, `"v2"` returns `StreamPart` typed dicts when `stream_mode` is not `"values"`.
`**kwargs`	`Any`	Default:`{}` Additional keyword arguments to pass to the graph run.

View source on GitHub

ainvoke( self, input: InputT | Command | None, config: RunnableConfig | None = None, *, context: ContextT | None = None, stream_mode: StreamMode = 'values', print_mode: StreamMode | Sequence[StreamMode] = (), output_keys: str | Sequence[str] | None = None, interrupt_before: All | Sequence[str] | None = None, interrupt_after: All | Sequence[str] | None = None, durability: Durability | None = None, version: Literal['v1', 'v2'] = 'v1', **kwargs: Any = {} ) -> dict[str, Any] | Any

Parameters

Name	Type	Description
`input`*	`InputT \| Command \| None`	The input data for the graph. It can be a dictionary or any other type.
`config`	`RunnableConfig \| None`	Default:`None` The configuration for the graph run.
`context`	`ContextT \| None`	Default:`None` The static context to use for the run.
`stream_mode`	`StreamMode`	Default:`'values'` The stream mode for the graph run.
`print_mode`	`StreamMode \| Sequence[StreamMode]`	Default:`()` Accepts the same values as `stream_mode`, but only prints the output to the console, for debugging purposes. Does not affect the output of the graph in any way.
`output_keys`	`str \| Sequence[str] \| None`	Default:`None` The output keys to retrieve from the graph run.
`interrupt_before`	`All \| Sequence[str] \| None`	Default:`None` The nodes to interrupt the graph run before.
`interrupt_after`	`All \| Sequence[str] \| None`	Default:`None` The nodes to interrupt the graph run after.
`durability`	`Durability \| None`	Default:`None` The durability mode for the graph execution, defaults to `"async"`. Options are: `"sync"`: Changes are persisted synchronously before the next step starts. `"async"`: Changes are persisted asynchronously while the next step executes. `"exit"`: Changes are persisted only when the graph exits.
`version`	`Literal['v1', 'v2']`	Default:`'v1'` The streaming format version. `"v1"` (default) returns the traditional format, `"v2"` returns `StreamPart` typed dicts when `stream_mode` is not `"values"`.
`**kwargs`	`Any`	Default:`{}` Additional keyword arguments to pass to the graph run.

ainvoke

Parameters

LangChain Assistant

Menu

ainvoke

Parameters