langchain_core.runnables.base.RunnableGenerator

class langchain_core.runnables.base.RunnableGenerator(transform: Union[Callable[[Iterator[Input]], Iterator[Output]], Callable[[AsyncIterator[Input]], AsyncIterator[Output]]], atransform: Optional[Callable[[AsyncIterator[Input]], AsyncIterator[Output]]] = None)

A runnable that runs a generator function.

Attributes

InputType	The type of input this runnable accepts specified as a type annotation.
OutputType	The type of output this runnable produces specified as a type annotation.
config_specs	List configurable fields for this runnable.
input_schema	The type of input this runnable accepts specified as a pydantic model.
output_schema	The type of output this runnable produces specified as a pydantic model.

Methods

__init__(transform[, atransform])
abatch(inputs[, config, return_exceptions])	Default implementation runs ainvoke in parallel using asyncio.gather.
ainvoke(input[, config])	Default implementation of ainvoke, calls invoke from a thread.
astream(input[, config])	Default implementation of astream, which calls ainvoke.
astream_log(input[, config, diff, ...])	Stream all output from a runnable, as reported to the callback system.
atransform(input[, config])	Default implementation of atransform, which buffers input and calls astream.
batch(inputs[, config, return_exceptions])	Default implementation runs invoke in parallel using a thread pool executor.
bind(**kwargs)	Bind arguments to a Runnable, returning a new Runnable.
config_schema(*[, include])	The type of config this runnable accepts specified as a pydantic model.
get_input_schema([config])	Get a pydantic model that can be used to validate input to the runnable.
get_output_schema([config])	Get a pydantic model that can be used to validate output to the runnable.
invoke(input[, config])	Transform a single input into an output.
map()	Return a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.
stream(input[, config])	Default implementation of stream, which calls invoke.
transform(input[, config])	Default implementation of transform, which buffers input and then calls stream.
with_config([config])	Bind config to a Runnable, returning a new Runnable.
with_fallbacks(fallbacks, *[, ...])	Add fallbacks to a runnable, returning a new Runnable.
with_listeners(*[, on_start, on_end, on_error])	Bind lifecycle listeners to a Runnable, returning a new Runnable.
with_retry(*[, retry_if_exception_type, ...])	Create a new Runnable that retries the original runnable on exceptions.
with_types(*[, input_type, output_type])	Bind input and output types to a Runnable, returning a new Runnable.

__init__(transform: Union[Callable[[Iterator[Input]], Iterator[Output]], Callable[[AsyncIterator[Input]], AsyncIterator[Output]]], atransform: Optional[Callable[[AsyncIterator[Input]], AsyncIterator[Output]]] = None) → None

async abatch(inputs: List[Input], config: Optional[Union[RunnableConfig, List[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: Optional[Any]) → List[Output]

Default implementation runs ainvoke in parallel using asyncio.gather.

The default implementation of batch works well for IO bound runnables.

Subclasses should override this method if they can batch more efficiently; e.g., if the underlying runnable uses an API which supports a batch mode.

async ainvoke(input: Input, config: Optional[RunnableConfig] = None, **kwargs: Any) → Output

Default implementation of ainvoke, calls invoke from a thread.

The default implementation allows usage of async code even if the runnable did not implement a native async version of invoke.

Subclasses should override this method if they can run asynchronously.

astream(input: Input, config: Optional[RunnableConfig] = None, **kwargs: Any) → AsyncIterator[Output]

Default implementation of astream, which calls ainvoke. Subclasses should override this method if they support streaming output.

async astream_log(input: Any, config: Optional[RunnableConfig] = None, *, diff: bool = True, with_streamed_output_list: bool = True, include_names: Optional[Sequence[str]] = None, include_types: Optional[Sequence[str]] = None, include_tags: Optional[Sequence[str]] = None, exclude_names: Optional[Sequence[str]] = None, exclude_types: Optional[Sequence[str]] = None, exclude_tags: Optional[Sequence[str]] = None, **kwargs: Optional[Any]) → Union[AsyncIterator[RunLogPatch], AsyncIterator[RunLog]]

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

• input – The input to the runnable.

• config – The config to use for the runnable.

• diff – Whether to yield diffs between each step, or the current state.

• with_streamed_output_list – Whether to yield the streamed_output list.

• include_names – Only include logs with these names.

• include_types – Only include logs with these types.

• include_tags – Only include logs with these tags.

• exclude_names – Exclude logs with these names.

• exclude_types – Exclude logs with these types.

• exclude_tags – Exclude logs with these tags.

atransform(input: AsyncIterator[Input], config: Optional[RunnableConfig] = None, **kwargs: Any) → AsyncIterator[Output]

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

batch(inputs: List[Input], config: Optional[Union[RunnableConfig, List[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: Optional[Any]) → List[Output]

Default implementation runs invoke in parallel using a thread pool executor.

The default implementation of batch works well for IO bound runnables.

Subclasses should override this method if they can batch more efficiently; e.g., if the underlying runnable uses an API which supports a batch mode.

bind(**kwargs: Any) → Runnable[Input, Output]

Bind arguments to a Runnable, returning a new Runnable.

config_schema(*, include: Optional[Sequence[str]] = None) → Type[BaseModel]

The type of config this runnable accepts specified as a pydantic model.

To mark a field as configurable, see the configurable_fields and configurable_alternatives methods.

Parameters

include – A list of fields to include in the config schema.

Returns

A pydantic model that can be used to validate config.

get_input_schema(config: Optional[RunnableConfig] = None) → Type[BaseModel]

Get a pydantic model that can be used to validate input to the runnable.

Runnables that leverage the configurable_fields and configurable_alternatives methods will have a dynamic input schema that depends on which configuration the runnable is invoked with.

This method allows to get an input schema for a specific configuration.

Parameters

config – A config to use when generating the schema.

Returns

A pydantic model that can be used to validate input.

get_output_schema(config: Optional[RunnableConfig] = None) → Type[BaseModel]

Get a pydantic model that can be used to validate output to the runnable.

Runnables that leverage the configurable_fields and configurable_alternatives methods will have a dynamic output schema that depends on which configuration the runnable is invoked with.

This method allows to get an output schema for a specific configuration.

Parameters

config – A config to use when generating the schema.

Returns

A pydantic model that can be used to validate output.

invoke(input: Input, config: Optional[RunnableConfig] = None, **kwargs: Any) → Output

Transform a single input into an output. Override to implement.

Parameters

• input – The input to the runnable.

• config – A config to use when invoking the runnable. The config supports standard keys like ‘tags’, ‘metadata’ for tracing purposes, ‘max_concurrency’ for controlling how much work to do in parallel, and other keys. Please refer to the RunnableConfig for more details.

Returns

The output of the runnable.

map() → Runnable[List[Input], List[Output]]

Return a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.

stream(input: Input, config: Optional[RunnableConfig] = None, **kwargs: Any) → Iterator[Output]

Default implementation of stream, which calls invoke. Subclasses should override this method if they support streaming output.

transform(input: Iterator[Input], config: Optional[RunnableConfig] = None, **kwargs: Any) → Iterator[Output]

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.

with_config(config: Optional[RunnableConfig] = None, **kwargs: Any) → Runnable[Input, Output]

Bind config to a Runnable, returning a new Runnable.

with_fallbacks(fallbacks: Sequence[Runnable[Input, Output]], *, exceptions_to_handle: Tuple[Type[BaseException], ...] = (<class 'Exception'>,)) → RunnableWithFallbacksT[Input, Output]

Add fallbacks to a runnable, returning a new Runnable.

Parameters

• fallbacks – A sequence of runnables to try if the original runnable fails.

• exceptions_to_handle – A tuple of exception types to handle.

Returns

A new Runnable that will try the original runnable, and then each fallback in order, upon failures.

with_listeners(*, on_start: Optional[Listener] = None, on_end: Optional[Listener] = None, on_error: Optional[Listener] = None) → Runnable[Input, Output]

Bind lifecycle listeners to a Runnable, returning a new Runnable.

on_start: Called before the runnable starts running, with the Run object. on_end: Called after the runnable finishes running, with the Run object. on_error: Called if the runnable throws an error, with the Run object.

The Run object contains information about the run, including its id, type, input, output, error, start_time, end_time, and any tags or metadata added to the run.

with_retry(*, retry_if_exception_type: ~typing.Tuple[~typing.Type[BaseException], ...] = (<class 'Exception'>,), wait_exponential_jitter: bool = True, stop_after_attempt: int = 3) → Runnable[Input, Output]

Create a new Runnable that retries the original runnable on exceptions.

Parameters

• retry_if_exception_type – A tuple of exception types to retry on

• wait_exponential_jitter – Whether to add jitter to the wait time between retries

• stop_after_attempt – The maximum number of attempts to make before giving up

Returns

A new Runnable that retries the original runnable on exceptions.

with_types(*, input_type: Optional[Type[Input]] = None, output_type: Optional[Type[Output]] = None) → Runnable[Input, Output]

Bind input and output types to a Runnable, returning a new Runnable.