mirror of
https://github.com/hwchase17/langchain
synced 2024-11-08 07:10:35 +00:00
improve documentation on base chain (#6468)
Co-authored-by: Nuno Campos <nuno@boringbits.io>
This commit is contained in:
parent
ad7089a6d0
commit
cac6e45a67
@ -31,12 +31,29 @@ class Chain(Serializable, ABC):
|
|||||||
"""Base interface that all chains should implement."""
|
"""Base interface that all chains should implement."""
|
||||||
|
|
||||||
memory: Optional[BaseMemory] = None
|
memory: Optional[BaseMemory] = None
|
||||||
|
"""Optional memory object. Defaults to None.
|
||||||
|
Memory is a class that gets called at the start
|
||||||
|
and at the end of every chain. At the start, memory loads variables and passes
|
||||||
|
them along in the chain. At the end, it saves any returned variables.
|
||||||
|
There are many different types of memory - please see memory docs
|
||||||
|
for the full catalog."""
|
||||||
callbacks: Callbacks = Field(default=None, exclude=True)
|
callbacks: Callbacks = Field(default=None, exclude=True)
|
||||||
|
"""Optional list of callback handlers (or callback manager). Defaults to None.
|
||||||
|
Callback handlers are called throughout the lifecycle of a call to a chain,
|
||||||
|
starting with on_chain_start, ending with on_chain_end or on_chain_error.
|
||||||
|
Each custom chain can optionally call additional callback methods, see Callback docs
|
||||||
|
for full details."""
|
||||||
callback_manager: Optional[BaseCallbackManager] = Field(default=None, exclude=True)
|
callback_manager: Optional[BaseCallbackManager] = Field(default=None, exclude=True)
|
||||||
verbose: bool = Field(
|
"""Deprecated, use `callbacks` instead."""
|
||||||
default_factory=_get_verbosity
|
verbose: bool = Field(default_factory=_get_verbosity)
|
||||||
) # Whether to print the response text
|
"""Whether or not run in verbose mode. In verbose mode, some intermediate logs
|
||||||
|
will be printed to the console. Defaults to `langchain.verbose` value."""
|
||||||
tags: Optional[List[str]] = None
|
tags: Optional[List[str]] = None
|
||||||
|
"""Optional list of tags associated with the chain. Defaults to None
|
||||||
|
These tags will be associated with each call to this chain,
|
||||||
|
and passed as arguments to the handlers defined in `callbacks`.
|
||||||
|
You can use these to eg identify a specific instance of a chain with its use case.
|
||||||
|
"""
|
||||||
|
|
||||||
class Config:
|
class Config:
|
||||||
"""Configuration for this pydantic object."""
|
"""Configuration for this pydantic object."""
|
||||||
|
Loading…
Reference in New Issue
Block a user