langchain 0.2.6__py3-none-any.whl → 0.2.7__py3-none-any.whl

langchain/agents/agent_iterator.py

@@ -62,6 +62,22 @@ class AgentExecutorIterator:
         """
         Initialize the AgentExecutorIterator with the given AgentExecutor,
         inputs, and optional callbacks.
+
+        Args:
+            agent_executor (AgentExecutor): The AgentExecutor to iterate over.
+            inputs (Any): The inputs to the AgentExecutor.
+            callbacks (Callbacks, optional): The callbacks to use during iteration.
+                Defaults to None.
+            tags (Optional[list[str]], optional): The tags to use during iteration.
+                Defaults to None.
+            metadata (Optional[Dict[str, Any]], optional): The metadata to use
+                during iteration. Defaults to None.
+            run_name (Optional[str], optional): The name of the run. Defaults to None.
+            run_id (Optional[UUID], optional): The ID of the run. Defaults to None.
+            include_run_info (bool, optional): Whether to include run info
+                in the output. Defaults to False.
+            yield_actions (bool, optional): Whether to yield actions as they
+                are generated. Defaults to False.
         """
         self._agent_executor = agent_executor
         self.inputs = inputs
@@ -85,6 +101,7 @@ class AgentExecutorIterator:
 
     @property
     def inputs(self) -> Dict[str, str]:
+        """The inputs to the AgentExecutor."""
         return self._inputs
 
     @inputs.setter
@@ -93,6 +110,7 @@ class AgentExecutorIterator:
 
     @property
     def agent_executor(self) -> AgentExecutor:
+        """The AgentExecutor to iterate over."""
         return self._agent_executor
 
     @agent_executor.setter
@@ -103,10 +121,12 @@ class AgentExecutorIterator:
 
     @property
     def name_to_tool_map(self) -> Dict[str, BaseTool]:
+        """A mapping of tool names to tools."""
         return {tool.name: tool for tool in self.agent_executor.tools}
 
     @property
     def color_mapping(self) -> Dict[str, str]:
+        """A mapping of tool names to colors."""
         return get_color_mapping(
             [tool.name for tool in self.agent_executor.tools],
             excluded_colors=["green", "red"],

langchain/agents/agent_toolkits/__init__.py

@@ -13,6 +13,7 @@ whether permissions of the given toolkit are appropriate for the application.
 
 See [Security](https://python.langchain.com/docs/security) for more information.
 """
+
 from pathlib import Path
 from typing import TYPE_CHECKING, Any
 

langchain/agents/agent_toolkits/file_management/__init__.py

@@ -1,4 +1,5 @@
 """Local file management toolkit."""
+
 from typing import TYPE_CHECKING, Any
 
 from langchain._api import create_importer

langchain/agents/agent_toolkits/playwright/__init__.py

@@ -1,4 +1,5 @@
 """Playwright browser toolkit."""
+
 from typing import TYPE_CHECKING, Any
 
 from langchain._api import create_importer

langchain/agents/agent_toolkits/vectorstore/base.py

@@ -1,4 +1,5 @@
 """VectorStore agent."""
+
 from typing import Any, Dict, Optional
 
 from langchain_core.callbacks.base import BaseCallbackManager

langchain/agents/agent_toolkits/vectorstore/toolkit.py

@@ -1,4 +1,5 @@
 """Toolkit for interacting with a vector store."""
+
 from typing import List
 
 from langchain_core.language_models import BaseLanguageModel

langchain/agents/agent_types.py

@@ -1,4 +1,5 @@
 """Module definitions of agent types together with corresponding agents."""
+
 from enum import Enum
 
 from langchain_core._api import deprecated

langchain/agents/chat/base.py

@@ -80,6 +80,23 @@ class ChatAgent(Agent):
         format_instructions: str = FORMAT_INSTRUCTIONS,
         input_variables: Optional[List[str]] = None,
     ) -> BasePromptTemplate:
+        """Create a prompt from a list of tools.
+
+        Args:
+            tools: A list of tools.
+            system_message_prefix: The system message prefix.
+                Default is SYSTEM_MESSAGE_PREFIX.
+            system_message_suffix: The system message suffix.
+                Default is SYSTEM_MESSAGE_SUFFIX.
+            human_message: The human message. Default is HUMAN_MESSAGE.
+            format_instructions: The format instructions.
+                Default is FORMAT_INSTRUCTIONS.
+            input_variables: The input variables. Default is None.
+
+        Returns:
+            A prompt template.
+        """
+
         tool_strings = "\n".join([f"{tool.name}: {tool.description}" for tool in tools])
         tool_names = ", ".join([tool.name for tool in tools])
         format_instructions = format_instructions.format(tool_names=tool_names)
@@ -113,7 +130,26 @@ class ChatAgent(Agent):
         input_variables: Optional[List[str]] = None,
         **kwargs: Any,
     ) -> Agent:
-        """Construct an agent from an LLM and tools."""
+        """Construct an agent from an LLM and tools.
+
+        Args:
+            llm: The language model.
+            tools: A list of tools.
+            callback_manager: The callback manager. Default is None.
+            output_parser: The output parser. Default is None.
+            system_message_prefix: The system message prefix.
+                Default is SYSTEM_MESSAGE_PREFIX.
+            system_message_suffix: The system message suffix.
+                Default is SYSTEM_MESSAGE_SUFFIX.
+            human_message: The human message. Default is HUMAN_MESSAGE.
+            format_instructions: The format instructions.
+                Default is FORMAT_INSTRUCTIONS.
+            input_variables: The input variables. Default is None.
+            kwargs: Additional keyword arguments.
+
+        Returns:
+            An agent.
+        """
         cls._validate_tools(tools)
         prompt = cls.create_prompt(
             tools,

langchain/agents/chat/output_parser.py

@@ -25,6 +25,20 @@ class ChatOutputParser(AgentOutputParser):
         return self.format_instructions
 
     def parse(self, text: str) -> Union[AgentAction, AgentFinish]:
+        """Parse the output from the agent into
+        an AgentAction or AgentFinish object.
+
+        Args:
+            text: The text to parse.
+
+        Returns:
+            An AgentAction or AgentFinish object.
+
+        Raises:
+            OutputParserException: If the output could not be parsed.
+            ValueError: If the action could not be found.
+        """
+
         includes_answer = FINAL_ANSWER_ACTION in text
         try:
             found = self.pattern.search(text)

langchain/agents/conversational/base.py

@@ -1,4 +1,5 @@
 """An agent designed to hold a conversation in addition to using tools."""
+
 from __future__ import annotations
 
 from typing import Any, List, Optional, Sequence
@@ -40,12 +41,20 @@ class ConversationalAgent(Agent):
 
     @property
     def observation_prefix(self) -> str:
-        """Prefix to append the observation with."""
+        """Prefix to append the observation with.
+
+        Returns:
+            "Observation: "
+        """
         return "Observation: "
 
     @property
     def llm_prefix(self) -> str:
-        """Prefix to append the llm call with."""
+        """Prefix to append the llm call with.
+
+        Returns:
+            "Thought: "
+        """
         return "Thought:"
 
     @classmethod
@@ -64,11 +73,15 @@ class ConversationalAgent(Agent):
         Args:
             tools: List of tools the agent will have access to, used to format the
                 prompt.
-            prefix: String to put before the list of tools.
-            suffix: String to put after the list of tools.
-            ai_prefix: String to use before AI output.
+            prefix: String to put before the list of tools. Defaults to PREFIX.
+            suffix: String to put after the list of tools. Defaults to SUFFIX.
+            format_instructions: Instructions on how to use the tools. Defaults to
+                FORMAT_INSTRUCTIONS
+            ai_prefix: String to use before AI output. Defaults to "AI".
             human_prefix: String to use before human output.
+                Defaults to "Human".
             input_variables: List of input variables the final prompt will expect.
+                Defaults to ["input", "chat_history", "agent_scratchpad"].
 
         Returns:
             A PromptTemplate with the template assembled from the pieces here.
@@ -105,7 +118,26 @@ class ConversationalAgent(Agent):
         input_variables: Optional[List[str]] = None,
         **kwargs: Any,
     ) -> Agent:
-        """Construct an agent from an LLM and tools."""
+        """Construct an agent from an LLM and tools.
+
+        Args:
+            llm: The language model to use.
+            tools: A list of tools to use.
+            callback_manager: The callback manager to use. Default is None.
+            output_parser: The output parser to use. Default is None.
+            prefix: The prefix to use in the prompt. Default is PREFIX.
+            suffix: The suffix to use in the prompt. Default is SUFFIX.
+            format_instructions: The format instructions to use.
+                Default is FORMAT_INSTRUCTIONS.
+            ai_prefix: The prefix to use before AI output. Default is "AI".
+            human_prefix: The prefix to use before human output.
+                Default is "Human".
+            input_variables: The input variables to use. Default is None.
+            **kwargs: Any additional keyword arguments to pass to the agent.
+
+        Returns:
+            An agent.
+        """
         cls._validate_tools(tools)
         prompt = cls.create_prompt(
             tools,

langchain/agents/conversational/output_parser.py

@@ -22,6 +22,16 @@ class ConvoOutputParser(AgentOutputParser):
         return self.format_instructions
 
     def parse(self, text: str) -> Union[AgentAction, AgentFinish]:
+        """Parse the output from the agent into
+        an AgentAction or AgentFinish object.
+
+        Args:
+            text: The text to parse.
+
+        Returns:
+            An AgentAction or AgentFinish object.
+        """
+
         if f"{self.ai_prefix}:" in text:
             return AgentFinish(
                 {"output": text.split(f"{self.ai_prefix}:")[-1].strip()}, text

langchain/agents/conversational_chat/base.py

@@ -1,4 +1,5 @@
 """An agent designed to hold a conversation in addition to using tools."""
+
 from __future__ import annotations
 
 from typing import Any, List, Optional, Sequence, Tuple
@@ -35,7 +36,9 @@ class ConversationalChatAgent(Agent):
     """An agent designed to hold a conversation in addition to using tools."""
 
     output_parser: AgentOutputParser = Field(default_factory=ConvoOutputParser)
+    """Output parser for the agent."""
     template_tool_response: str = TEMPLATE_TOOL_RESPONSE
+    """Template for the tool response."""
 
     @classmethod
     def _get_default_output_parser(cls, **kwargs: Any) -> AgentOutputParser:
@@ -47,12 +50,20 @@ class ConversationalChatAgent(Agent):
 
     @property
     def observation_prefix(self) -> str:
-        """Prefix to append the observation with."""
+        """Prefix to append the observation with.
+
+        Returns:
+            "Observation: "
+        """
         return "Observation: "
 
     @property
     def llm_prefix(self) -> str:
-        """Prefix to append the llm call with."""
+        """Prefix to append the llm call with.
+
+        Returns:
+            "Thought: "
+        """
         return "Thought:"
 
     @classmethod
@@ -69,6 +80,20 @@ class ConversationalChatAgent(Agent):
         input_variables: Optional[List[str]] = None,
         output_parser: Optional[BaseOutputParser] = None,
     ) -> BasePromptTemplate:
+        """Create a prompt for the agent.
+
+        Args:
+            tools: The tools to use.
+            system_message: The system message to use.
+                Defaults to the PREFIX.
+            human_message: The human message to use.
+                Defaults to the SUFFIX.
+            input_variables: The input variables to use. Defaults to None.
+            output_parser: The output parser to use. Defaults to None.
+
+        Returns:
+            A PromptTemplate.
+        """
         tool_strings = "\n".join(
             [f"> {tool.name}: {tool.description}" for tool in tools]
         )
@@ -115,7 +140,21 @@ class ConversationalChatAgent(Agent):
         input_variables: Optional[List[str]] = None,
         **kwargs: Any,
     ) -> Agent:
-        """Construct an agent from an LLM and tools."""
+        """Construct an agent from an LLM and tools.
+
+        Args:
+            llm: The language model to use.
+            tools: A list of tools to use.
+            callback_manager: The callback manager to use. Default is None.
+            output_parser: The output parser to use. Default is None.
+            system_message: The system message to use. Default is PREFIX.
+            human_message: The human message to use. Default is SUFFIX.
+            input_variables: The input variables to use. Default is None.
+            **kwargs: Any additional arguments.
+
+        Returns:
+            An agent.
+        """
         cls._validate_tools(tools)
         _output_parser = output_parser or cls._get_default_output_parser()
         prompt = cls.create_prompt(

langchain/agents/format_scratchpad/__init__.py

@@ -5,6 +5,7 @@ that result from previous iterations of the agent.
 Depending on the prompting strategy you are using, you may want to format these
 differently before passing them into the LLM.
 """
+
 from langchain.agents.format_scratchpad.log import format_log_to_str
 from langchain.agents.format_scratchpad.log_to_messages import format_log_to_messages
 from langchain.agents.format_scratchpad.openai_functions import (

langchain/agents/format_scratchpad/log.py

@@ -8,7 +8,18 @@ def format_log_to_str(
     observation_prefix: str = "Observation: ",
     llm_prefix: str = "Thought: ",
 ) -> str:
-    """Construct the scratchpad that lets the agent continue its thought process."""
+    """Construct the scratchpad that lets the agent continue its thought process.
+
+    Args:
+        intermediate_steps: List of tuples of AgentAction and observation strings.
+        observation_prefix: Prefix to append the observation with.
+             Defaults to "Observation: ".
+        llm_prefix: Prefix to append the llm call with.
+                Defaults to "Thought: ".
+
+    Returns:
+        str: The scratchpad.
+    """
     thoughts = ""
     for action, observation in intermediate_steps:
         thoughts += action.log

langchain/agents/format_scratchpad/log_to_messages.py

@@ -8,7 +8,16 @@ def format_log_to_messages(
     intermediate_steps: List[Tuple[AgentAction, str]],
     template_tool_response: str = "{observation}",
 ) -> List[BaseMessage]:
-    """Construct the scratchpad that lets the agent continue its thought process."""
+    """Construct the scratchpad that lets the agent continue its thought process.
+
+    Args:
+        intermediate_steps: List of tuples of AgentAction and observation strings.
+        template_tool_response: Template to format the observation with.
+             Defaults to "{observation}".
+
+    Returns:
+        List[BaseMessage]: The scratchpad.
+    """
     thoughts: List[BaseMessage] = []
     for action, observation in intermediate_steps:
         thoughts.append(AIMessage(content=action.log))

langchain/agents/format_scratchpad/openai_functions.py

@@ -16,7 +16,8 @@ def _convert_agent_action_to_messages(
         agent_action: Agent action to convert.
 
     Returns:
-        AIMessage that corresponds to the original tool invocation.
+        AIMessage or the previous messages plus a FunctionMessage that corresponds to
+            the original tool invocation
     """
     if isinstance(agent_action, AgentActionMessageLog):
         return list(agent_action.message_log) + [
@@ -31,10 +32,13 @@ def _create_function_message(
 ) -> FunctionMessage:
     """Convert agent action and observation into a function message.
     Args:
-        agent_action: the tool invocation request from the agent
-        observation: the result of the tool invocation
+        agent_action: the tool invocation request from the agent.
+        observation: the result of the tool invocation.
     Returns:
-        FunctionMessage that corresponds to the original tool invocation
+        FunctionMessage that corresponds to the original tool invocation.
+
+    Raises:
+        ValueError: if the observation cannot be converted to a string.
     """
     if not isinstance(observation, str):
         try:
@@ -59,7 +63,8 @@ def format_to_openai_function_messages(
 
     Returns:
         list of messages to send to the LLM for the next prediction
-
+    Raises:
+        ValueError: if the observation cannot be converted to a string.
     """
     messages = []
 

langchain/agents/format_scratchpad/tools.py

@@ -14,12 +14,16 @@ from langchain.agents.output_parsers.tools import ToolAgentAction
 def _create_tool_message(
     agent_action: ToolAgentAction, observation: str
 ) -> ToolMessage:
-    """Convert agent action and observation into a function message.
+    """Convert agent action and observation into a tool message.
+
     Args:
-        agent_action: the tool invocation request from the agent
-        observation: the result of the tool invocation
+        agent_action: the tool invocation request from the agent.
+        observation: the result of the tool invocation.
     Returns:
-        FunctionMessage that corresponds to the original tool invocation
+        ToolMessage that corresponds to the original tool invocation.
+
+    Raises:
+        ValueError: if the observation cannot be converted to a string.
     """
     if not isinstance(observation, str):
         try:
@@ -38,13 +42,13 @@ def _create_tool_message(
 def format_to_tool_messages(
     intermediate_steps: Sequence[Tuple[AgentAction, str]],
 ) -> List[BaseMessage]:
-    """Convert (AgentAction, tool output) tuples into FunctionMessages.
+    """Convert (AgentAction, tool output) tuples into ToolMessages.
 
     Args:
-        intermediate_steps: Steps the LLM has taken to date, along with observations
+        intermediate_steps: Steps the LLM has taken to date, along with observations.
 
     Returns:
-        list of messages to send to the LLM for the next prediction
+        list of messages to send to the LLM for the next prediction.
 
     """
     messages = []

langchain/agents/initialize.py

@@ -1,4 +1,5 @@
 """Load agent."""
+
 from typing import Any, Optional, Sequence
 
 from langchain_core._api import deprecated
@@ -35,17 +36,24 @@ def initialize_agent(
     Args:
         tools: List of tools this agent has access to.
         llm: Language model to use as the agent.
-        agent: Agent type to use. If None and agent_path is also None, will default to
-            AgentType.ZERO_SHOT_REACT_DESCRIPTION.
+        agent: Agent type to use. If None and agent_path is also None, will default
+            to AgentType.ZERO_SHOT_REACT_DESCRIPTION. Defaults to None.
         callback_manager: CallbackManager to use. Global callback manager is used if
             not provided. Defaults to None.
-        agent_path: Path to serialized agent to use.
-        agent_kwargs: Additional keyword arguments to pass to the underlying agent
-        tags: Tags to apply to the traced runs.
-        **kwargs: Additional keyword arguments passed to the agent executor
+        agent_path: Path to serialized agent to use. If None and agent is also None,
+            will default to AgentType.ZERO_SHOT_REACT_DESCRIPTION. Defaults to None.
+        agent_kwargs: Additional keyword arguments to pass to the underlying agent.
+            Defaults to None.
+        tags: Tags to apply to the traced runs. Defaults to None.
+        **kwargs: Additional keyword arguments passed to the agent executor.
 
     Returns:
-        An agent executor
+        An agent executor.
+
+    Raises:
+        ValueError: If both `agent` and `agent_path` are specified.
+        ValueError: If `agent` is not a valid agent type.
+        ValueError: If both `agent` and `agent_path` are None.
     """
     tags_ = list(tags) if tags else []
     if agent is None and agent_path is None:

langchain/agents/json_chat/base.py

@@ -36,11 +36,17 @@ def create_json_chat_agent(
             then passed into the LLM. Default is `render_text_description`.
         template_tool_response: Template prompt that uses the tool response (observation)
             to make the LLM generate the next action to take.
+            Default is TEMPLATE_TOOL_RESPONSE.
 
     Returns:
         A Runnable sequence representing an agent. It takes as input all the same input
         variables as the prompt passed in does. It returns as output either an
         AgentAction or AgentFinish.
+        
+    Raises:
+        ValueError: If the prompt is missing required variables.
+        ValueError: If the template_tool_response is missing
+            the required variable 'observation'.
 
     Example:
 

langchain/agents/loading.py

@@ -48,6 +48,9 @@ def load_agent_from_config(
 
     Returns:
         An agent executor.
+
+    Raises:
+        ValueError: If agent type is not specified in the config.
     """
     if "_type" not in config:
         raise ValueError("Must specify an agent Type in config")
@@ -99,6 +102,10 @@ def load_agent(
 
     Returns:
         An agent executor.
+
+    Raises:
+        RuntimeError: If loading from the deprecated github-based
+            Hub is attempted.
     """
     if isinstance(path, str) and path.startswith("lc://"):
         raise RuntimeError(

langchain/agents/mrkl/base.py

@@ -1,4 +1,5 @@
 """Attempt to implement MRKL systems as described in arxiv.org/pdf/2205.00445.pdf."""
+
 from __future__ import annotations
 
 from typing import Any, Callable, List, NamedTuple, Optional, Sequence
@@ -20,9 +21,9 @@ from langchain.tools.render import render_text_description
 
 
 class ChainConfig(NamedTuple):
-    """Configuration for chain to use in MRKL system.
+    """Configuration for a chain to use in MRKL system.
 
-    Args:
+    Parameters:
         action_name: Name of the action.
         action: Action function to call.
         action_description: Description of the action.
@@ -35,7 +36,11 @@ class ChainConfig(NamedTuple):
 
 @deprecated("0.1.0", alternative="create_react_agent", removal="0.3.0")
 class ZeroShotAgent(Agent):
-    """Agent for the MRKL chain."""
+    """Agent for the MRKL chain.
+
+    Parameters:
+        output_parser: Output parser for the agent.
+    """
 
     output_parser: AgentOutputParser = Field(default_factory=MRKLOutputParser)
 
@@ -50,12 +55,20 @@ class ZeroShotAgent(Agent):
 
     @property
     def observation_prefix(self) -> str:
-        """Prefix to append the observation with."""
+        """Prefix to append the observation with.
+
+        Returns:
+            "Observation: "
+        """
         return "Observation: "
 
     @property
     def llm_prefix(self) -> str:
-        """Prefix to append the llm call with."""
+        """Prefix to append the llm call with.
+
+        Returns:
+            "Thought: "
+        """
         return "Thought:"
 
     @classmethod
@@ -72,9 +85,12 @@ class ZeroShotAgent(Agent):
         Args:
             tools: List of tools the agent will have access to, used to format the
                 prompt.
-            prefix: String to put before the list of tools.
-            suffix: String to put after the list of tools.
+            prefix: String to put before the list of tools. Defaults to PREFIX.
+            suffix: String to put after the list of tools. Defaults to SUFFIX.
+            format_instructions: Instructions on how to use the tools.
+                Defaults to FORMAT_INSTRUCTIONS
             input_variables: List of input variables the final prompt will expect.
+                Defaults to None.
 
         Returns:
             A PromptTemplate with the template assembled from the pieces here.
@@ -100,7 +116,20 @@ class ZeroShotAgent(Agent):
         input_variables: Optional[List[str]] = None,
         **kwargs: Any,
     ) -> Agent:
-        """Construct an agent from an LLM and tools."""
+        """Construct an agent from an LLM and tools.
+
+        Args:
+            llm: The LLM to use as the agent LLM.
+            tools: The tools to use.
+            callback_manager: The callback manager to use. Defaults to None.
+            output_parser: The output parser to use. Defaults to None.
+            prefix: The prefix to use. Defaults to PREFIX.
+            suffix: The suffix to use. Defaults to SUFFIX.
+            format_instructions: The format instructions to use.
+                Defaults to FORMAT_INSTRUCTIONS.
+            input_variables: The input variables to use. Defaults to None.
+            **kwargs: Additional parameters to pass to the agent.
+        """
         cls._validate_tools(tools)
         prompt = cls.create_prompt(
             tools,
@@ -141,13 +170,13 @@ class ZeroShotAgent(Agent):
 
 @deprecated("0.1.0", removal="0.3.0")
 class MRKLChain(AgentExecutor):
-    """[Deprecated] Chain that implements the MRKL system."""
+    """Chain that implements the MRKL system."""
 
     @classmethod
     def from_chains(
         cls, llm: BaseLanguageModel, chains: List[ChainConfig], **kwargs: Any
     ) -> AgentExecutor:
-        """User friendly way to initialize the MRKL chain.
+        """User-friendly way to initialize the MRKL chain.
 
         This is intended to be an easy way to get up and running with the
         MRKL chain.