Method clone

langroid/agent/chat_agent.py:308–338

Create i'th clone of this agent, ensuring tool use/handling is cloned. Important: We assume all member variables are in the __init__ method here and in the Agent class. TODO: We are attempting to clone an agent after its state has been changed in possibly many ways. B

(self, i: int = 0)

        return cast(ChatAgent, Agent.from_id(id))

    def clone(self, i: int = 0) -> "ChatAgent":
        """Create i'th clone of this agent, ensuring tool use/handling is cloned.
        Important: We assume all member variables are in the __init__ method here
        and in the Agent class.
        TODO: We are attempting to clone an agent after its state has been
        changed in possibly many ways. Below is an imperfect solution. Caution advised.
        Revisit later.
        """
        agent_cls = type(self)
        # Use model_copy to preserve Pydantic subclass types (like MockLMConfig)
        # instead of deepcopy which loses subclass information
        config_copy = self.config.model_copy(deep=True)
        config_copy.name = f"{config_copy.name}-{i}"
        new_agent = agent_cls(config_copy)
        new_agent.system_tool_instructions = self.system_tool_instructions
        new_agent.system_tool_format_instructions = self.system_tool_format_instructions
        new_agent.llm_tools_map = self.llm_tools_map
        new_agent.llm_tools_known = self.llm_tools_known
        new_agent.llm_tools_handled = self.llm_tools_handled
        new_agent.llm_tools_usable = self.llm_tools_usable
        new_agent.llm_functions_map = self.llm_functions_map
        new_agent.llm_functions_handled = self.llm_functions_handled
        new_agent.llm_functions_usable = self.llm_functions_usable
        new_agent.llm_function_force = self.llm_function_force
        # Ensure each clone gets its own vecdb client when supported.
        new_agent.vecdb = None if self.vecdb is None else self.vecdb.clone()
        self._clone_extra_state(new_agent)
        new_agent.id = ObjectRegistry.new_id()
        if self.config.add_to_registry:
            ObjectRegistry.register_object(new_agent)
        return new_agent

    def _clone_extra_state(self, new_agent: "ChatAgent") -> None:
        """Hook for subclasses to copy additional state into clones."""