ag2 0.9.1__py3-none-any.whl → 0.9.1.post0__py3-none-any.whl

autogen/agentchat/contrib/web_surfer.py

@@ -0,0 +1,303 @@
+# Copyright (c) 2023 - 2025, AG2ai, Inc., AG2ai open-source projects maintainers and core contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+# Portions derived from  https://github.com/microsoft/autogen are under the MIT License.
+# SPDX-License-Identifier: MIT
+import copy
+import logging
+import re
+from datetime import datetime
+from typing import Annotated, Any, Callable, Literal, Optional, Union
+
+from ... import Agent, AssistantAgent, ConversableAgent, OpenAIWrapper, UserProxyAgent
+from ...browser_utils import SimpleTextBrowser
+from ...llm_config import LLMConfig
+from ...oai.openai_utils import filter_config
+from ...token_count_utils import count_token, get_max_token_limit
+
+logger = logging.getLogger(__name__)
+
+
+class WebSurferAgent(ConversableAgent):
+    """(In preview) An agent that acts as a basic web surfer that can search the web and visit web pages."""
+
+    DEFAULT_PROMPT = (
+        "You are a helpful AI assistant with access to a web browser (via the provided functions). In fact, YOU ARE THE ONLY MEMBER OF YOUR PARTY WITH ACCESS TO A WEB BROWSER, so please help out where you can by performing web searches, navigating pages, and reporting what you find. Today's date is "
+        + datetime.now().date().isoformat()
+    )
+
+    DEFAULT_DESCRIPTION = "A helpful assistant with access to a web browser. Ask them to perform web searches, open pages, navigate to Wikipedia, answer questions from pages, and or generate summaries."
+
+    def __init__(
+        self,
+        name: str,
+        system_message: Optional[Union[str, list[str]]] = DEFAULT_PROMPT,
+        description: Optional[str] = DEFAULT_DESCRIPTION,
+        is_termination_msg: Optional[Callable[[dict[str, Any]], bool]] = None,
+        max_consecutive_auto_reply: Optional[int] = None,
+        human_input_mode: Literal["ALWAYS", "NEVER", "TERMINATE"] = "TERMINATE",
+        function_map: Optional[dict[str, Callable[..., Any]]] = None,
+        code_execution_config: Union[dict[str, Any], Literal[False]] = False,
+        llm_config: Optional[Union[LLMConfig, dict[str, Any], Literal[False]]] = None,
+        summarizer_llm_config: Optional[Union[LLMConfig, dict[str, Any], Literal[False]]] = None,
+        default_auto_reply: Optional[Union[str, dict[str, Any]]] = "",
+        browser_config: Optional[dict[str, Any]] = None,
+        **kwargs: Any,
+    ):
+        super().__init__(
+            name=name,
+            system_message=system_message,
+            description=description,
+            is_termination_msg=is_termination_msg,
+            max_consecutive_auto_reply=max_consecutive_auto_reply,
+            human_input_mode=human_input_mode,
+            function_map=function_map,
+            code_execution_config=code_execution_config,
+            llm_config=llm_config,
+            default_auto_reply=default_auto_reply,
+            **kwargs,
+        )
+
+        self._create_summarizer_client(summarizer_llm_config, llm_config)
+
+        # Create the browser
+        self.browser = SimpleTextBrowser(**(browser_config if browser_config else {}))
+
+        inner_llm_config = copy.deepcopy(llm_config)
+
+        # Set up the inner monologue
+        self._assistant = AssistantAgent(
+            self.name + "_inner_assistant",
+            system_message=system_message,  # type: ignore[arg-type]
+            llm_config=inner_llm_config,
+            is_termination_msg=lambda m: False,
+        )
+
+        self._user_proxy = UserProxyAgent(
+            self.name + "_inner_user_proxy",
+            human_input_mode="NEVER",
+            code_execution_config=False,
+            default_auto_reply="",
+            is_termination_msg=lambda m: False,
+        )
+
+        if inner_llm_config not in [None, False]:
+            self._register_functions()
+
+        self.register_reply([Agent, None], WebSurferAgent.generate_surfer_reply, remove_other_reply_funcs=True)
+        self.register_reply([Agent, None], ConversableAgent.generate_code_execution_reply)
+        self.register_reply([Agent, None], ConversableAgent.generate_function_call_reply)
+        self.register_reply([Agent, None], ConversableAgent.check_termination_and_human_reply)
+
+    def _create_summarizer_client(
+        self, summarizer_llm_config: Union[LLMConfig, dict[str, Any]], llm_config: Union[LLMConfig, dict[str, Any]]
+    ) -> None:
+        # If the summarizer_llm_config is None, we copy it from the llm_config
+        if summarizer_llm_config is None:
+            if llm_config is None:  # Nothing to copy
+                self.summarizer_llm_config = None
+            elif llm_config is False:  # LLMs disabled
+                self.summarizer_llm_config = False
+            else:  # Create a suitable config
+                self.summarizer_llm_config = copy.deepcopy(llm_config)  # type: ignore[assignment]
+                if "config_list" in self.summarizer_llm_config:  # type: ignore[operator]
+                    preferred_models = filter_config(  # type: ignore[no-untyped-call]
+                        self.summarizer_llm_config["config_list"],  # type: ignore[index]
+                        {"model": ["gpt-3.5-turbo-1106", "gpt-3.5-turbo-16k-0613", "gpt-3.5-turbo-16k"]},
+                    )
+                    if len(preferred_models) == 0:
+                        logger.warning(
+                            "The summarizer did not find the preferred model (gpt-3.5-turbo-16k) in the config list. "
+                            "Semantic operations on webpages (summarization or Q&A) might be costly or ineffective."
+                        )
+                    else:
+                        self.summarizer_llm_config["config_list"] = preferred_models  # type: ignore[index]
+        else:
+            self.summarizer_llm_config = summarizer_llm_config  # type: ignore[assignment]
+
+        # Create the summarizer client
+        self.summarization_client = (
+            None if self.summarizer_llm_config is False else OpenAIWrapper(**self.summarizer_llm_config)
+        )  # type: ignore[arg-type]
+
+    def _register_functions(self) -> None:
+        """Register the functions for the inner assistant and user proxy."""
+
+        # Helper functions
+        def _browser_state() -> tuple[str, str]:
+            header = f"Address: {self.browser.address}\n"
+            if self.browser.page_title is not None:
+                header += f"Title: {self.browser.page_title}\n"
+
+            current_page = self.browser.viewport_current_page
+            total_pages = len(self.browser.viewport_pages)
+
+            header += f"Viewport position: Showing page {current_page + 1} of {total_pages}.\n"
+            return (header, self.browser.viewport)
+
+        @self._user_proxy.register_for_execution()
+        @self._assistant.register_for_llm(
+            name="informational_web_search",
+            description="Perform an INFORMATIONAL web search query then return the search results.",
+        )
+        def _informational_search(query: Annotated[str, "The informational web search query to perform."]) -> str:
+            self.browser.visit_page(f"bing: {query}")
+            header, content = _browser_state()
+            return header.strip() + "\n=======================\n" + content
+
+        @self._user_proxy.register_for_execution()
+        @self._assistant.register_for_llm(
+            name="navigational_web_search",
+            description="Perform a NAVIGATIONAL web search query then immediately navigate to the top result. Useful, for example, to navigate to a particular Wikipedia article or other known destination. Equivalent to Google's \"I'm Feeling Lucky\" button.",
+        )
+        def _navigational_search(query: Annotated[str, "The navigational web search query to perform."]) -> str:
+            self.browser.visit_page(f"bing: {query}")
+
+            # Extract the first linl
+            m = re.search(r"\[.*?\]\((http.*?)\)", self.browser.page_content)
+            if m:
+                self.browser.visit_page(m.group(1))
+
+            # Return where we ended up
+            header, content = _browser_state()
+            return header.strip() + "\n=======================\n" + content
+
+        @self._user_proxy.register_for_execution()
+        @self._assistant.register_for_llm(
+            name="visit_page", description="Visit a webpage at a given URL and return its text."
+        )
+        def _visit_page(url: Annotated[str, "The relative or absolute url of the webpage to visit."]) -> str:
+            self.browser.visit_page(url)
+            header, content = _browser_state()
+            return header.strip() + "\n=======================\n" + content
+
+        @self._user_proxy.register_for_execution()
+        @self._assistant.register_for_llm(
+            name="page_up",
+            description="Scroll the viewport UP one page-length in the current webpage and return the new viewport content.",
+        )
+        def _page_up() -> str:
+            self.browser.page_up()
+            header, content = _browser_state()
+            return header.strip() + "\n=======================\n" + content
+
+        @self._user_proxy.register_for_execution()
+        @self._assistant.register_for_llm(
+            name="page_down",
+            description="Scroll the viewport DOWN one page-length in the current webpage and return the new viewport content.",
+        )
+        def _page_down() -> str:
+            self.browser.page_down()
+            header, content = _browser_state()
+            return header.strip() + "\n=======================\n" + content
+
+        if self.summarization_client is not None:
+
+            @self._user_proxy.register_for_execution()
+            @self._assistant.register_for_llm(
+                name="answer_from_page",
+                description="Uses AI to read the page and directly answer a given question based on the content.",
+            )
+            def _answer_from_page(
+                question: Annotated[Optional[str], "The question to directly answer."],
+                url: Annotated[Optional[str], "[Optional] The url of the page. (Defaults to the current page)"] = None,
+            ) -> str:
+                if url is not None and url != self.browser.address:
+                    self.browser.visit_page(url)
+
+                # We are likely going to need to fix this later, but summarize only as many tokens that fit in the buffer
+                limit = 4096
+                try:
+                    limit = get_max_token_limit(self.summarizer_llm_config["config_list"][0]["model"])  # type: ignore[index]
+                except ValueError:
+                    pass  # limit is unknown
+                except TypeError:
+                    pass  # limit is unknown
+
+                if limit < 16000:
+                    logger.warning(
+                        f"The token limit ({limit}) of the WebSurferAgent.summarizer_llm_config, is below the recommended 16k."
+                    )
+
+                buffer = ""
+                for line in re.split(r"([\r\n]+)", self.browser.page_content):
+                    tokens = count_token(buffer + line)
+                    if tokens + 1024 > limit:  # Leave room for our summary
+                        break
+                    buffer += line
+
+                buffer = buffer.strip()
+                if len(buffer) == 0:
+                    return "Nothing to summarize."
+
+                messages = [
+                    {
+                        "role": "system",
+                        "content": "You are a helpful assistant that can summarize long documents to answer question.",
+                    }
+                ]
+
+                prompt = f"Please summarize the following into one or two paragraph:\n\n{buffer}"
+                if question is not None:
+                    prompt = f"Please summarize the following into one or two paragraphs with respect to '{question}':\n\n{buffer}"
+
+                messages.append(
+                    {"role": "user", "content": prompt},
+                )
+
+                response = self.summarization_client.create(context=None, messages=messages)  # type: ignore[union-attr]
+                extracted_response = self.summarization_client.extract_text_or_completion_object(response)[0]  # type: ignore[union-attr]
+                return str(extracted_response)
+
+            @self._user_proxy.register_for_execution()
+            @self._assistant.register_for_llm(
+                name="summarize_page",
+                description="Uses AI to summarize the content found at a given url. If the url is not provided, the current page is summarized.",
+            )
+            def _summarize_page(
+                url: Annotated[
+                    Optional[str], "[Optional] The url of the page to summarize. (Defaults to current page)"
+                ] = None,
+            ) -> str:
+                return _answer_from_page(url=url, question=None)
+
+    def generate_surfer_reply(
+        self,
+        messages: Optional[list[dict[str, str]]] = None,
+        sender: Optional[Agent] = None,
+        config: Optional[OpenAIWrapper] = None,
+    ) -> tuple[bool, Optional[Union[str, dict[str, str]]]]:
+        """Generate a reply using autogen.oai."""
+        if messages is None:
+            messages = self._oai_messages[sender]
+
+        self._user_proxy.reset()  # type: ignore[no-untyped-call]
+        self._assistant.reset()  # type: ignore[no-untyped-call]
+
+        # Clone the messages to give context
+        self._assistant.chat_messages[self._user_proxy] = list()
+        history = messages[0 : len(messages) - 1]
+        for message in history:
+            self._assistant.chat_messages[self._user_proxy].append(message)
+
+        # Remind the agent where it is
+        self._user_proxy.send(
+            f"Your browser is currently open to the page '{self.browser.page_title}' at the address '{self.browser.address}'.",
+            self._assistant,
+            request_reply=False,
+            silent=True,
+        )
+
+        self._user_proxy.send(messages[-1]["content"], self._assistant, request_reply=True, silent=True)
+        agent_reply = self._user_proxy.chat_messages[self._assistant][-1]
+        # print("Agent Reply: " + str(agent_reply))
+        proxy_reply = self._user_proxy.generate_reply(
+            messages=self._user_proxy.chat_messages[self._assistant], sender=self._assistant
+        )
+        # print("Proxy Reply: " + str(proxy_reply))
+
+        if proxy_reply == "":  # Was the default reply
+            return True, None if agent_reply is None else agent_reply["content"]
+        else:
+            return True, None if proxy_reply is None else proxy_reply["content"]  # type: ignore[index]