The agent engineering platform.
Python agentsaiai-agentsanthropicchatgptdeepagentsenterpriseframeworkgeminigenerative-ailangchainlanggraphllmmultiagentopen-sourceopenaipydanticpythonragtypescript
core[patch]: Add doc-strings to outputs, fix @root_validator (#23190)
Eugene Yurtsev3c917204dc2e
diff --git a/libs/core/langchain_core/outputs/__init__.py b/libs/core/langchain_core/outputs/__init__.pyindex e5bb7970fe..9221e4ec84 100644--- a/libs/core/langchain_core/outputs/__init__.py+++ b/libs/core/langchain_core/outputs/__init__.py@@ -1,6 +1,22 @@"""**Output** classes are used to represent the output of a language model calland the output of a chat.+The top container for information is the `LLMResult` object. `LLMResult` is used by+both chat models and LLMs. This object contains the output of the language+model and any additional information that the model provider wants to return.++When invoking models via the standard runnable methods (e.g. invoke, batch, etc.):+- Chat models will return `AIMessage` objects.+- LLMs will return regular text strings.++In addition, users can access the raw output of either LLMs or chat models via+callbacks. The on_chat_model_end and on_llm_end callbacks will return an+LLMResult object containing the generated outputs and any additional information+returned by the model provider.++In general, if information is already available+in the AIMessage object, it is recommended to access it from there rather than+from the `LLMResult` object."""from langchain_core.outputs.chat_generation import ChatGeneration, ChatGenerationChunkfrom langchain_core.outputs.chat_result import ChatResultdiff --git a/libs/core/langchain_core/outputs/chat_generation.py b/libs/core/langchain_core/outputs/chat_generation.pyindex e95c538926..f62d8cca4a 100644--- a/libs/core/langchain_core/outputs/chat_generation.py+++ b/libs/core/langchain_core/outputs/chat_generation.py@@ -9,7 +9,18 @@ from langchain_core.utils._merge import merge_dictsclass ChatGeneration(Generation):- """A single chat generation output."""+ """A single chat generation output.++ A subclass of Generation that represents the response from a chat model+ that generates chat messages.++ The `message` attribute is a structured representation of the chat message.+ Most of the time, the message will be of type `AIMessage`.++ Users working with chat models will usually access information via either+ `AIMessage` (returned from runnable interfaces) or `LLMResult` (available+ via callbacks).+ """text: str = """""*SHOULD NOT BE SET DIRECTLY* The text contents of the output message."""@@ -19,7 +30,7 @@ class ChatGeneration(Generation):type: Literal["ChatGeneration"] = "ChatGeneration" # type: ignore[assignment]"""Type is used exclusively for serialization purposes."""- @root_validator+ @root_validator(pre=False, skip_on_failure=True)def set_text(cls, values: Dict[str, Any]) -> Dict[str, Any]:"""Set the text attribute to be the contents of the message."""try:diff --git a/libs/core/langchain_core/outputs/chat_result.py b/libs/core/langchain_core/outputs/chat_result.pyindex f985ca8275..2895c2a5cf 100644--- a/libs/core/langchain_core/outputs/chat_result.py+++ b/libs/core/langchain_core/outputs/chat_result.py@@ -5,11 +5,31 @@ from langchain_core.pydantic_v1 import BaseModelclass ChatResult(BaseModel):- """Class that contains all results for a single chat model call."""+ """Use to represent the result of a chat model call with a single prompt.++ This container is used internally by some implementations of chat model,+ it will eventually be mapped to a more general `LLMResult` object, and+ then projected into an `AIMessage` object.++ LangChain users working with chat models will usually access information via+ `AIMessage` (returned from runnable interfaces) or `LLMResult` (available+ via callbacks). Please refer the `AIMessage` and `LLMResult` schema documentation+ for more information.+ """generations: List[ChatGeneration]- """List of the chat generations. This is a List because an input can have multiple- candidate generations.+ """List of the chat generations.++ Generations is a list to allow for multiple candidate generations for a single+ input prompt."""llm_output: Optional[dict] = None- """For arbitrary LLM provider specific output."""+ """For arbitrary LLM provider specific output.++ This dictionary is a free-form dictionary that can contain any information that the+ provider wants to return. It is not standardized and is provider-specific.++ Users should generally avoid relying on this field and instead rely on+ accessing relevant information from standardized fields present in+ AIMessage.+ """diff --git a/libs/core/langchain_core/outputs/generation.py b/libs/core/langchain_core/outputs/generation.pyindex 34e219771d..bddf892980 100644--- a/libs/core/langchain_core/outputs/generation.py+++ b/libs/core/langchain_core/outputs/generation.py@@ -7,18 +7,31 @@ from langchain_core.utils._merge import merge_dictsclass Generation(Serializable):- """A single text generation output."""+ """A single text generation output.++ Generation represents the response from an "old-fashioned" LLM that+ generates regular text (not chat messages).++ This model is used internally by chat model and will eventually+ be mapped to a more general `LLMResult` object, and then projected into+ an `AIMessage` object.++ LangChain users working with chat models will usually access information via+ `AIMessage` (returned from runnable interfaces) or `LLMResult` (available+ via callbacks). Please refer the `AIMessage` and `LLMResult` schema documentation+ for more information.+ """text: str"""Generated text output."""generation_info: Optional[Dict[str, Any]] = None- """Raw response from the provider. May include things like the- reason for finishing or token log probabilities.+ """Raw response from the provider.++ May include things like the reason for finishing or token log probabilities."""type: Literal["Generation"] = "Generation""""Type is used exclusively for serialization purposes."""- # TODO: add log probs as separate attribute@classmethoddef is_lc_serializable(cls) -> bool:diff --git a/libs/core/langchain_core/outputs/llm_result.py b/libs/core/langchain_core/outputs/llm_result.pyindex d1df4c8304..aae6fa501d 100644--- a/libs/core/langchain_core/outputs/llm_result.py+++ b/libs/core/langchain_core/outputs/llm_result.py@@ -9,13 +9,38 @@ from langchain_core.pydantic_v1 import BaseModelclass LLMResult(BaseModel):- """Class that contains all results for a batched LLM call."""+ """A container for results of an LLM call.++ Both chat models and LLMs generate an LLMResult object. This object contains+ the generated outputs and any additional information that the model provider+ wants to return.+ """generations: List[List[Generation]]- """List of generated outputs. This is a List[List[]] because- each input could have multiple candidate generations."""+ """Generated outputs.++ The first dimension of the list represents completions for different input+ prompts.++ The second dimension of the list represents different candidate generations+ for a given prompt.++ When returned from an LLM the type is List[List[Generation]].+ When returned from a chat model the type is List[List[ChatGeneration]].++ ChatGeneration is a subclass of Generation that has a field for a structured+ chat message.+ """llm_output: Optional[dict] = None- """Arbitrary LLM provider-specific output."""+ """For arbitrary LLM provider specific output.++ This dictionary is a free-form dictionary that can contain any information that the+ provider wants to return. It is not standardized and is provider-specific.++ Users should generally avoid relying on this field and instead rely on+ accessing relevant information from standardized fields present in+ AIMessage.+ """run: Optional[List[RunInfo]] = None"""List of metadata info for model call for each input."""diff --git a/libs/core/langchain_core/outputs/run_info.py b/libs/core/langchain_core/outputs/run_info.pyindex 0c6c69826b..f9f84032ef 100644--- a/libs/core/langchain_core/outputs/run_info.py+++ b/libs/core/langchain_core/outputs/run_info.py@@ -6,7 +6,15 @@ from langchain_core.pydantic_v1 import BaseModelclass RunInfo(BaseModel):- """Class that contains metadata for a single execution of a Chain or model."""+ """Class that contains metadata for a single execution of a Chain or model.++ Here for backwards compatibility with older versions of langchain_core.++ This model will likely be deprecated in the future.++ Users can acquire the run_id information from callbacks or via run_id+ information present in the astream_event API (depending on the use case).+ """run_id: UUID"""A unique identifier for the model or chain run."""