style: refs pass (#33813)

Author: mdrxy

libs/core/langchain_core/agents.py

@@ -52,31 +52,33 @@ class AgentAction(Serializable):
     """The input to pass in to the Tool."""
     log: str
     """Additional information to log about the action.
-    This log can be used in a few ways. First, it can be used to audit
-    what exactly the LLM predicted to lead to this (tool, tool_input).
-    Second, it can be used in future iterations to show the LLMs prior
-    thoughts. This is useful when (tool, tool_input) does not contain
-    full information about the LLM prediction (for example, any `thought`
-    before the tool/tool_input)."""
+
+    This log can be used in a few ways. First, it can be used to audit what exactly the
+    LLM predicted to lead to this `(tool, tool_input)`.
+
+    Second, it can be used in future iterations to show the LLMs prior thoughts. This is
+    useful when `(tool, tool_input)` does not contain full information about the LLM
+    prediction (for example, any `thought` before the tool/tool_input).
+    """
     type: Literal["AgentAction"] = "AgentAction"
 
     # Override init to support instantiation by position for backward compat.
     def __init__(self, tool: str, tool_input: str | dict, log: str, **kwargs: Any):
-        """Create an AgentAction.
+        """Create an `AgentAction`.
 
         Args:
             tool: The name of the tool to execute.
-            tool_input: The input to pass in to the Tool.
+            tool_input: The input to pass in to the `Tool`.
             log: Additional information to log about the action.
         """
         super().__init__(tool=tool, tool_input=tool_input, log=log, **kwargs)
 
     @classmethod
     def is_lc_serializable(cls) -> bool:
-        """AgentAction is serializable.
+        """`AgentAction` is serializable.
 
         Returns:
-            True
+            `True`
         """
         return True
 
@@ -98,19 +100,23 @@ def messages(self) -> Sequence[BaseMessage]:
 class AgentActionMessageLog(AgentAction):
     """Representation of an action to be executed by an agent.
 
-    This is similar to AgentAction, but includes a message log consisting of
-    chat messages. This is useful when working with ChatModels, and is used
-    to reconstruct conversation history from the agent's perspective.
+    This is similar to `AgentAction`, but includes a message log consisting of
+    chat messages.
+
+    This is useful when working with `ChatModels`, and is used to reconstruct
+    conversation history from the agent's perspective.
     """
 
     message_log: Sequence[BaseMessage]
-    """Similar to log, this can be used to pass along extra
-    information about what exact messages were predicted by the LLM
-    before parsing out the (tool, tool_input). This is again useful
-    if (tool, tool_input) cannot be used to fully recreate the LLM
-    prediction, and you need that LLM prediction (for future agent iteration).
+    """Similar to log, this can be used to pass along extra information about what exact
+    messages were predicted by the LLM before parsing out the `(tool, tool_input)`.
+
+    This is again useful if `(tool, tool_input)` cannot be used to fully recreate the
+    LLM prediction, and you need that LLM prediction (for future agent iteration).
+
     Compared to `log`, this is useful when the underlying LLM is a
-    chat model (and therefore returns messages rather than a string)."""
+    chat model (and therefore returns messages rather than a string).
+    """
     # Ignoring type because we're overriding the type from AgentAction.
     # And this is the correct thing to do in this case.
     # The type literal is used for serialization purposes.
@@ -132,19 +138,22 @@ def messages(self) -> Sequence[BaseMessage]:
 
 
 class AgentFinish(Serializable):
-    """Final return value of an ActionAgent.
+    """Final return value of an `ActionAgent`.
 
-    Agents return an AgentFinish when they have reached a stopping condition.
+    Agents return an `AgentFinish` when they have reached a stopping condition.
     """
 
     return_values: dict
     """Dictionary of return values."""
     log: str
     """Additional information to log about the return value.
+
     This is used to pass along the full LLM prediction, not just the parsed out
-    return value. For example, if the full LLM prediction was
-    `Final Answer: 2` you may want to just return `2` as a return value, but pass
-    along the full string as a `log` (for debugging or observability purposes).
+    return value.
+
+    For example, if the full LLM prediction was `Final Answer: 2` you may want to just
+    return `2` as a return value, but pass along the full string as a `log` (for
+    debugging or observability purposes).
     """
     type: Literal["AgentFinish"] = "AgentFinish"
 
@@ -154,7 +163,7 @@ def __init__(self, return_values: dict, log: str, **kwargs: Any):
 
     @classmethod
     def is_lc_serializable(cls) -> bool:
-        """Return True as this class is serializable."""
+        """Return `True` as this class is serializable."""
         return True
 
     @classmethod
@@ -202,7 +211,7 @@ def _convert_agent_observation_to_messages(
         observation: Observation to convert to a message.
 
     Returns:
-        AIMessage that corresponds to the original tool invocation.
+        `AIMessage` that corresponds to the original tool invocation.
     """
     if isinstance(agent_action, AgentActionMessageLog):
         return [_create_function_message(agent_action, observation)]
@@ -225,7 +234,7 @@ def _create_function_message(
         observation: the result of the tool invocation.
 
     Returns:
-        FunctionMessage that corresponds to the original tool invocation.
+        `FunctionMessage` that corresponds to the original tool invocation.
     """
     if not isinstance(observation, str):
         try:

libs/core/langchain_core/documents/base.py

@@ -114,11 +114,11 @@ class Blob(BaseMedia):
     data: bytes | str | None = None
     """Raw data associated with the `Blob`."""
     mimetype: str | None = None
-    """MimeType not to be confused with a file extension."""
+    """MIME type, not to be confused with a file extension."""
     encoding: str = "utf-8"
     """Encoding to use if decoding the bytes into a string.
 
-    Use `utf-8` as default encoding, if decoding to string.
+    Uses `utf-8` as default encoding if decoding to string.
     """
     path: PathLike | None = None
     """Location where the original content was found."""
@@ -134,7 +134,7 @@ def source(self) -> str | None:
 
         If a path is associated with the `Blob`, it will default to the path location.
 
-        Unless explicitly set via a metadata field called `"source"`, in which
+        Unless explicitly set via a metadata field called `'source'`, in which
         case that value will be used instead.
         """
         if self.metadata and "source" in self.metadata:
@@ -309,7 +309,7 @@ def __init__(self, page_content: str, **kwargs: Any) -> None:
 
     @classmethod
     def is_lc_serializable(cls) -> bool:
-        """Return True as this class is serializable."""
+        """Return `True` as this class is serializable."""
         return True
 
     @classmethod
@@ -322,10 +322,10 @@ def get_lc_namespace(cls) -> list[str]:
         return ["langchain", "schema", "document"]
 
     def __str__(self) -> str:
-        """Override __str__ to restrict it to page_content and metadata.
+        """Override `__str__` to restrict it to page_content and metadata.
 
         Returns:
-            A string representation of the Document.
+            A string representation of the `Document`.
         """
         # The format matches pydantic format for __str__.
         #

libs/core/langchain_core/outputs/generation.py

@@ -20,8 +20,7 @@ class Generation(Serializable):
 
     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.
+    via callbacks). Please refer to `AIMessage` and `LLMResult` for more information.
     """
 
     text: str
@@ -34,11 +33,13 @@ class Generation(Serializable):
     """
     type: Literal["Generation"] = "Generation"
     """Type is used exclusively for serialization purposes.
-    Set to "Generation" for this class."""
+
+    Set to "Generation" for this class.
+    """
 
     @classmethod
     def is_lc_serializable(cls) -> bool:
-        """Return True as this class is serializable."""
+        """Return `True` as this class is serializable."""
         return True
 
     @classmethod
@@ -52,7 +53,7 @@ def get_lc_namespace(cls) -> list[str]:
 
 
 class GenerationChunk(Generation):
-    """Generation chunk, which can be concatenated with other Generation chunks."""
+    """`GenerationChunk`, which can be concatenated with other Generation chunks."""
 
     def __add__(self, other: GenerationChunk) -> GenerationChunk:
         """Concatenate two `GenerationChunk`s.

libs/core/langchain_core/prompt_values.py

@@ -30,7 +30,7 @@ class PromptValue(Serializable, ABC):
 
     @classmethod
     def is_lc_serializable(cls) -> bool:
-        """Return True as this class is serializable."""
+        """Return `True` as this class is serializable."""
         return True
 
     @classmethod
@@ -48,7 +48,7 @@ def to_string(self) -> str:
 
     @abstractmethod
     def to_messages(self) -> list[BaseMessage]:
-        """Return prompt as a list of Messages."""
+        """Return prompt as a list of messages."""
 
 
 class StringPromptValue(PromptValue):