mirror of
https://github.com/hwchase17/langchain.git
synced 2025-08-05 03:02:35 +00:00
docs: Add in code documentation to core Runnable with_fallbacks method (docs only) (#19104)
- Description: [a description of the change] Add in code documentation to core Runnable with_fallbacks method (docs only) - Issue: the issue #18804 @eyurtsev PTAL
This commit is contained in:
parent
cced3eb9bc
commit
4468e5bdbe
@ -1380,6 +1380,29 @@ class Runnable(Generic[Input, Output], ABC):
|
|||||||
) -> RunnableWithFallbacksT[Input, Output]:
|
) -> RunnableWithFallbacksT[Input, Output]:
|
||||||
"""Add fallbacks to a runnable, returning a new Runnable.
|
"""Add fallbacks to a runnable, returning a new Runnable.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
from typing import Iterator
|
||||||
|
|
||||||
|
from langchain_core.runnables import RunnableGenerator
|
||||||
|
|
||||||
|
|
||||||
|
def _generate_immediate_error(input: Iterator) -> Iterator[str]:
|
||||||
|
raise ValueError()
|
||||||
|
yield ""
|
||||||
|
|
||||||
|
|
||||||
|
def _generate(input: Iterator) -> Iterator[str]:
|
||||||
|
yield from "foo bar"
|
||||||
|
|
||||||
|
|
||||||
|
runnable = RunnableGenerator(_generate_immediate_error).with_fallbacks(
|
||||||
|
[RunnableGenerator(_generate)]
|
||||||
|
)
|
||||||
|
print(''.join(runnable.stream({}))) #foo bar
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
fallbacks: A sequence of runnables to try if the original runnable fails.
|
fallbacks: A sequence of runnables to try if the original runnable fails.
|
||||||
exceptions_to_handle: A tuple of exception types to handle.
|
exceptions_to_handle: A tuple of exception types to handle.
|
||||||
@ -1391,6 +1414,7 @@ class Runnable(Generic[Input, Output], ABC):
|
|||||||
Returns:
|
Returns:
|
||||||
A new Runnable that will try the original runnable, and then each
|
A new Runnable that will try the original runnable, and then each
|
||||||
fallback in order, upon failures.
|
fallback in order, upon failures.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
from langchain_core.runnables.fallbacks import RunnableWithFallbacks
|
from langchain_core.runnables.fallbacks import RunnableWithFallbacks
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user