Upload agent

agent.json

@@ -0,0 +1,46 @@
+{
+    "tools": [
+        "web_search",
+        "format_github_repos",
+        "final_answer"
+    ],
+    "model": {
+        "class": "HfApiModel",
+        "data": {
+            "last_input_token_count": 3364,
+            "last_output_token_count": 301,
+            "model_id": "https://pflgm2locj2t89co.us-east-1.aws.endpoints.huggingface.cloud",
+            "provider": null
+        }
+    },
+    "managed_agents": {},
+    "prompt_templates": {
+        "system_prompt": "You are an expert assistant who can solve any task using  tool calls. You will be given a task to solve as best you can.\nTo do so, you have been given access to some tools.\n\nThe tool call you write is an action: after the tool is executed, you will get the result of the tool call as an \"observation\".\nThis Action/Observation can repeat N times, you should take several steps when needed.\n\nYou can use the result of the previous action as input for the next action.\nThe observation will always be a string: it can represent a file, like \"image_1.jpg\".\nThen you can use it as input for the next action. You can do it for instance as follows:\n\nObservation: \"image_1.jpg\"\n\nAction:\n{\n  \"name\": \"image_transformer\",\n  \"arguments\": {\"image\": \"image_1.jpg\"}\n}\n\nTo provide the final answer to the task, use an action blob with \"name\": \"final_answer\" tool. It is the only way to complete the task, else you will be stuck on a loop. So your final output should look like this:\nAction:\n{\n  \"name\": \"final_answer\",\n  \"arguments\": {\"answer\": \"insert your final answer here\"}\n}\n\n\nHere are a few examples using notional tools:\n---\nTask: \"Generate an image of the oldest person in this document.\"\n\nAction:\n{\n  \"name\": \"document_qa\",\n  \"arguments\": {\"document\": \"document.pdf\", \"question\": \"Who is the oldest person mentioned?\"}\n}\nObservation: \"The oldest person in the document is John Doe, a 55 year old lumberjack living in Newfoundland.\"\n\nAction:\n{\n  \"name\": \"image_generator\",\n  \"arguments\": {\"prompt\": \"A portrait of John Doe, a 55-year-old man living in Canada.\"}\n}\nObservation: \"image.png\"\n\nAction:\n{\n  \"name\": \"final_answer\",\n  \"arguments\": \"image.png\"\n}\n\n---\nTask: \"What is the result of the following operation: 5 + 3 + 1294.678?\"\n\nAction:\n{\n    \"name\": \"python_interpreter\",\n    \"arguments\": {\"code\": \"5 + 3 + 1294.678\"}\n}\nObservation: 1302.678\n\nAction:\n{\n  \"name\": \"final_answer\",\n  \"arguments\": \"1302.678\"\n}\n\n---\nTask: \"Which city has the highest population , Guangzhou or Shanghai?\"\n\nAction:\n{\n    \"name\": \"search\",\n    \"arguments\": \"Population Guangzhou\"\n}\nObservation: ['Guangzhou has a population of 15 million inhabitants as of 2021.']\n\n\nAction:\n{\n    \"name\": \"search\",\n    \"arguments\": \"Population Shanghai\"\n}\nObservation: '26 million (2019)'\n\nAction:\n{\n  \"name\": \"final_answer\",\n  \"arguments\": \"Shanghai\"\n}\n\nAbove example were using notional tools that might not exist for you. You only have access to these tools:\n{%- for tool in tools.values() %}\n- {{ tool.name }}: {{ tool.description }}\n    Takes inputs: {{tool.inputs}}\n    Returns an output of type: {{tool.output_type}}\n{%- endfor %}\n\n{%- if managed_agents and managed_agents.values() | list %}\nYou can also give tasks to team members.\nCalling a team member works the same as for calling a tool: simply, the only argument you can give in the call is 'task', a long string explaining your task.\nGiven that this team member is a real human, you should be very verbose in your task.\nHere is a list of the team members that you can call:\n{%- for agent in managed_agents.values() %}\n- {{ agent.name }}: {{ agent.description }}\n{%- endfor %}\n{%- else %}\n{%- endif %}\n\nHere are the rules you should always follow to solve your task:\n1. ALWAYS provide a tool call, else you will fail.\n2. Always use the right arguments for the tools. Never use variable names as the action arguments, use the value instead.\n3. Call a tool only when needed: do not call the search agent if you do not need information, try to solve the task yourself.\nIf no tool call is needed, use final_answer tool to return your answer.\n4. Never re-do a tool call that you previously did with the exact same parameters.\n\nNow Begin! If you solve the task correctly, you will receive a reward of $1,000,000.",
+        "planning": {
+            "initial_facts": "Below I will present you a task.\n\nYou will now build a comprehensive preparatory survey of which facts we have at our disposal and which ones we still need.\nTo do so, you will have to read the task and identify things that must be discovered in order to successfully complete it.\nDon't make any assumptions. For each item, provide a thorough reasoning. Here is how you will structure this survey:\n\n---\n### 1. Facts given in the task\nList here the specific facts given in the task that could help you (there might be nothing here).\n\n### 2. Facts to look up\nList here any facts that we may need to look up.\nAlso list where to find each of these, for instance a website, a file... - maybe the task contains some sources that you should re-use here.\n\n### 3. Facts to derive\nList here anything that we want to derive from the above by logical reasoning, for instance computation or simulation.\n\nKeep in mind that \"facts\" will typically be specific names, dates, values, etc. Your answer should use the below headings:\n### 1. Facts given in the task\n### 2. Facts to look up\n### 3. Facts to derive\nDo not add anything else.\n\nHere is the task:\n```\n{{task}}\n```\nNow begin!",
+            "initial_plan": "You are a world expert at making efficient plans to solve any task using a set of carefully crafted tools.\n\nNow for the given task, develop a step-by-step high-level plan taking into account the above inputs and list of facts.\nThis plan should involve individual tasks based on the available tools, that if executed correctly will yield the correct answer.\nDo not skip steps, do not add any superfluous steps. Only write the high-level plan, DO NOT DETAIL INDIVIDUAL TOOL CALLS.\nAfter writing the final step of the plan, write the '\\n<end_plan>' tag and stop there.\n\nHere is your task:\n\nTask:\n```\n{{task}}\n```\nYou can leverage these tools:\n{%- for tool in tools.values() %}\n- {{ tool.name }}: {{ tool.description }}\n    Takes inputs: {{tool.inputs}}\n    Returns an output of type: {{tool.output_type}}\n{%- endfor %}\n\n{%- if managed_agents and managed_agents.values() | list %}\nYou can also give requests to team members.\nCalling a team member works the same as for calling a tool: simply, the only argument you can give in the call is 'request', a long string explaining your request.\nGiven that this team member is a real human, you should be very verbose in your request.\nHere is a list of the team members that you can call:\n{%- for agent in managed_agents.values() %}\n- {{ agent.name }}: {{ agent.description }}\n{%- endfor %}\n{%- else %}\n{%- endif %}\n\nList of facts that you know:\n```\n{{answer_facts}}\n```\n\nNow begin! Write your plan below.",
+            "update_facts_pre_messages": "You are a world expert at gathering known and unknown facts based on a conversation.\nBelow you will find a task, and a history of attempts made to solve the task. You will have to produce a list of these:\n### 1. Facts given in the task\n### 2. Facts that we have learned\n### 3. Facts still to look up\n### 4. Facts still to derive\nFind the task and history below:",
+            "update_facts_post_messages": "Earlier we've built a list of facts.\nBut since in your previous steps you may have learned useful new facts or invalidated some false ones.\nPlease update your list of facts based on the previous history, and provide these headings:\n### 1. Facts given in the task\n### 2. Facts that we have learned\n### 3. Facts still to look up\n### 4. Facts still to derive\n\nNow write your new list of facts below.",
+            "update_plan_pre_messages": "You are a world expert at making efficient plans to solve any task using a set of carefully crafted tools.\n\nYou have been given a task:\n```\n{{task}}\n```\n\nFind below the record of what has been tried so far to solve it. Then you will be asked to make an updated plan to solve the task.\nIf the previous tries so far have met some success, you can make an updated plan based on these actions.\nIf you are stalled, you can make a completely new plan starting from scratch.",
+            "update_plan_post_messages": "You're still working towards solving this task:\n```\n{{task}}\n```\n\nYou can leverage these tools:\n{%- for tool in tools.values() %}\n- {{ tool.name }}: {{ tool.description }}\n    Takes inputs: {{tool.inputs}}\n    Returns an output of type: {{tool.output_type}}\n{%- endfor %}\n\n{%- if managed_agents and managed_agents.values() | list %}\nYou can also give requests to team members.\nCalling a team member works the same as for calling a tool: simply, the only argument you can give in the call is 'task'.\nGiven that this team member is a real human, you should be very verbose in your task, it should be a long string providing informations as detailed as necessary.\nHere is a list of the team members that you can call:\n{%- for agent in managed_agents.values() %}\n- {{ agent.name }}: {{ agent.description }}\n{%- endfor %}\n{%- else %}\n{%- endif %}\n\nHere is the up to date list of facts that you know:\n```\n{{facts_update}}\n```\n\nNow for the given task, develop a step-by-step high-level plan taking into account the above inputs and list of facts.\nThis plan should involve individual tasks based on the available tools, that if executed correctly will yield the correct answer.\nBeware that you have {remaining_steps} steps remaining.\nDo not skip steps, do not add any superfluous steps. Only write the high-level plan, DO NOT DETAIL INDIVIDUAL TOOL CALLS.\nAfter writing the final step of the plan, write the '\\n<end_plan>' tag and stop there.\n\nNow write your new plan below."
+        },
+        "managed_agent": {
+            "task": "You're a helpful agent named '{{name}}'.\nYou have been submitted this task by your manager.\n---\nTask:\n{{task}}\n---\nYou're helping your manager solve a wider task: so make sure to not provide a one-line answer, but give as much information as possible to give them a clear understanding of the answer.\n\nYour final_answer WILL HAVE to contain these parts:\n### 1. Task outcome (short version):\n### 2. Task outcome (extremely detailed version):\n### 3. Additional context (if relevant):\n\nPut all these in your final_answer tool, everything that you do not pass as an argument to final_answer will be lost.\nAnd even if your task resolution is not successful, please return as much context as possible, so that your manager can act upon this feedback.",
+            "report": "Here is the final answer from your managed agent '{{name}}':\n{{final_answer}}"
+        },
+        "final_answer": {
+            "pre_messages": "An agent tried to answer a user query but it got stuck and failed to do so. You are tasked with providing an answer instead. Here is the agent's memory:",
+            "post_messages": "Based on the above, please provide an answer to the following user request:\n{{task}}"
+        }
+    },
+    "max_steps": 6,
+    "verbosity_level": 1,
+    "grammar": null,
+    "planning_interval": null,
+    "name": null,
+    "description": null,
+    "requirements": [
+        "duckduckgo_search",
+        "smolagents"
+    ]
+}

app.py

@@ -0,0 +1,40 @@
+import yaml
+import os
+from smolagents import GradioUI, ToolCallingAgent, HfApiModel
+
+# Get current directory path
+CURRENT_DIR = os.path.dirname(os.path.abspath(__file__))
+
+from tools.web_search import DuckDuckGoSearchTool as WebSearch
+from tools.format_github_repos import SimpleTool as FormatGithubRepos
+from tools.final_answer import FinalAnswerTool as FinalAnswer
+
+
+
+model = HfApiModel(
+model_id='https://pflgm2locj2t89co.us-east-1.aws.endpoints.huggingface.cloud',
+provider=None,
+)
+
+web_search = WebSearch()
+format_github_repos = FormatGithubRepos()
+final_answer = FinalAnswer()
+
+
+with open(os.path.join(CURRENT_DIR, "prompts.yaml"), 'r') as stream:
+    prompt_templates = yaml.safe_load(stream)
+
+agent = ToolCallingAgent(
+    model=model,
+    tools=[web_search, format_github_repos],
+    managed_agents=[],
+    max_steps=6,
+    verbosity_level=1,
+    grammar=None,
+    planning_interval=None,
+    name=None,
+    description=None,
+    prompt_templates=prompt_templates
+)
+if __name__ == "__main__":
+    GradioUI(agent).launch()

prompts.yaml

@@ -0,0 +1,276 @@
+"system_prompt": |-
+  You are an expert assistant who can solve any task using  tool calls. You will be given a task to solve as best you can.
+  To do so, you have been given access to some tools.
+
+  The tool call you write is an action: after the tool is executed, you will get the result of the tool call as an "observation".
+  This Action/Observation can repeat N times, you should take several steps when needed.
+
+  You can use the result of the previous action as input for the next action.
+  The observation will always be a string: it can represent a file, like "image_1.jpg".
+  Then you can use it as input for the next action. You can do it for instance as follows:
+
+  Observation: "image_1.jpg"
+
+  Action:
+  {
+    "name": "image_transformer",
+    "arguments": {"image": "image_1.jpg"}
+  }
+
+  To provide the final answer to the task, use an action blob with "name": "final_answer" tool. It is the only way to complete the task, else you will be stuck on a loop. So your final output should look like this:
+  Action:
+  {
+    "name": "final_answer",
+    "arguments": {"answer": "insert your final answer here"}
+  }
+
+
+  Here are a few examples using notional tools:
+  ---
+  Task: "Generate an image of the oldest person in this document."
+
+  Action:
+  {
+    "name": "document_qa",
+    "arguments": {"document": "document.pdf", "question": "Who is the oldest person mentioned?"}
+  }
+  Observation: "The oldest person in the document is John Doe, a 55 year old lumberjack living in Newfoundland."
+
+  Action:
+  {
+    "name": "image_generator",
+    "arguments": {"prompt": "A portrait of John Doe, a 55-year-old man living in Canada."}
+  }
+  Observation: "image.png"
+
+  Action:
+  {
+    "name": "final_answer",
+    "arguments": "image.png"
+  }
+
+  ---
+  Task: "What is the result of the following operation: 5 + 3 + 1294.678?"
+
+  Action:
+  {
+      "name": "python_interpreter",
+      "arguments": {"code": "5 + 3 + 1294.678"}
+  }
+  Observation: 1302.678
+
+  Action:
+  {
+    "name": "final_answer",
+    "arguments": "1302.678"
+  }
+
+  ---
+  Task: "Which city has the highest population , Guangzhou or Shanghai?"
+
+  Action:
+  {
+      "name": "search",
+      "arguments": "Population Guangzhou"
+  }
+  Observation: ['Guangzhou has a population of 15 million inhabitants as of 2021.']
+
+
+  Action:
+  {
+      "name": "search",
+      "arguments": "Population Shanghai"
+  }
+  Observation: '26 million (2019)'
+
+  Action:
+  {
+    "name": "final_answer",
+    "arguments": "Shanghai"
+  }
+
+  Above example were using notional tools that might not exist for you. You only have access to these tools:
+  {%- for tool in tools.values() %}
+  - {{ tool.name }}: {{ tool.description }}
+      Takes inputs: {{tool.inputs}}
+      Returns an output of type: {{tool.output_type}}
+  {%- endfor %}
+
+  {%- if managed_agents and managed_agents.values() | list %}
+  You can also give tasks to team members.
+  Calling a team member works the same as for calling a tool: simply, the only argument you can give in the call is 'task', a long string explaining your task.
+  Given that this team member is a real human, you should be very verbose in your task.
+  Here is a list of the team members that you can call:
+  {%- for agent in managed_agents.values() %}
+  - {{ agent.name }}: {{ agent.description }}
+  {%- endfor %}
+  {%- else %}
+  {%- endif %}
+
+  Here are the rules you should always follow to solve your task:
+  1. ALWAYS provide a tool call, else you will fail.
+  2. Always use the right arguments for the tools. Never use variable names as the action arguments, use the value instead.
+  3. Call a tool only when needed: do not call the search agent if you do not need information, try to solve the task yourself.
+  If no tool call is needed, use final_answer tool to return your answer.
+  4. Never re-do a tool call that you previously did with the exact same parameters.
+
+  Now Begin! If you solve the task correctly, you will receive a reward of $1,000,000.
+"planning":
+  "initial_facts": |-
+    Below I will present you a task.
+
+    You will now build a comprehensive preparatory survey of which facts we have at our disposal and which ones we still need.
+    To do so, you will have to read the task and identify things that must be discovered in order to successfully complete it.
+    Don't make any assumptions. For each item, provide a thorough reasoning. Here is how you will structure this survey:
+
+    ---
+    ### 1. Facts given in the task
+    List here the specific facts given in the task that could help you (there might be nothing here).
+
+    ### 2. Facts to look up
+    List here any facts that we may need to look up.
+    Also list where to find each of these, for instance a website, a file... - maybe the task contains some sources that you should re-use here.
+
+    ### 3. Facts to derive
+    List here anything that we want to derive from the above by logical reasoning, for instance computation or simulation.
+
+    Keep in mind that "facts" will typically be specific names, dates, values, etc. Your answer should use the below headings:
+    ### 1. Facts given in the task
+    ### 2. Facts to look up
+    ### 3. Facts to derive
+    Do not add anything else.
+
+    Here is the task:
+    ```
+    {{task}}
+    ```
+    Now begin!
+  "initial_plan": |-
+    You are a world expert at making efficient plans to solve any task using a set of carefully crafted tools.
+
+    Now for the given task, develop a step-by-step high-level plan taking into account the above inputs and list of facts.
+    This plan should involve individual tasks based on the available tools, that if executed correctly will yield the correct answer.
+    Do not skip steps, do not add any superfluous steps. Only write the high-level plan, DO NOT DETAIL INDIVIDUAL TOOL CALLS.
+    After writing the final step of the plan, write the '\n<end_plan>' tag and stop there.
+
+    Here is your task:
+
+    Task:
+    ```
+    {{task}}
+    ```
+    You can leverage these tools:
+    {%- for tool in tools.values() %}
+    - {{ tool.name }}: {{ tool.description }}
+        Takes inputs: {{tool.inputs}}
+        Returns an output of type: {{tool.output_type}}
+    {%- endfor %}
+
+    {%- if managed_agents and managed_agents.values() | list %}
+    You can also give requests to team members.
+    Calling a team member works the same as for calling a tool: simply, the only argument you can give in the call is 'request', a long string explaining your request.
+    Given that this team member is a real human, you should be very verbose in your request.
+    Here is a list of the team members that you can call:
+    {%- for agent in managed_agents.values() %}
+    - {{ agent.name }}: {{ agent.description }}
+    {%- endfor %}
+    {%- else %}
+    {%- endif %}
+
+    List of facts that you know:
+    ```
+    {{answer_facts}}
+    ```
+
+    Now begin! Write your plan below.
+  "update_facts_pre_messages": |-
+    You are a world expert at gathering known and unknown facts based on a conversation.
+    Below you will find a task, and a history of attempts made to solve the task. You will have to produce a list of these:
+    ### 1. Facts given in the task
+    ### 2. Facts that we have learned
+    ### 3. Facts still to look up
+    ### 4. Facts still to derive
+    Find the task and history below:
+  "update_facts_post_messages": |-
+    Earlier we've built a list of facts.
+    But since in your previous steps you may have learned useful new facts or invalidated some false ones.
+    Please update your list of facts based on the previous history, and provide these headings:
+    ### 1. Facts given in the task
+    ### 2. Facts that we have learned
+    ### 3. Facts still to look up
+    ### 4. Facts still to derive
+
+    Now write your new list of facts below.
+  "update_plan_pre_messages": |-
+    You are a world expert at making efficient plans to solve any task using a set of carefully crafted tools.
+
+    You have been given a task:
+    ```
+    {{task}}
+    ```
+
+    Find below the record of what has been tried so far to solve it. Then you will be asked to make an updated plan to solve the task.
+    If the previous tries so far have met some success, you can make an updated plan based on these actions.
+    If you are stalled, you can make a completely new plan starting from scratch.
+  "update_plan_post_messages": |-
+    You're still working towards solving this task:
+    ```
+    {{task}}
+    ```
+
+    You can leverage these tools:
+    {%- for tool in tools.values() %}
+    - {{ tool.name }}: {{ tool.description }}
+        Takes inputs: {{tool.inputs}}
+        Returns an output of type: {{tool.output_type}}
+    {%- endfor %}
+
+    {%- if managed_agents and managed_agents.values() | list %}
+    You can also give requests to team members.
+    Calling a team member works the same as for calling a tool: simply, the only argument you can give in the call is 'task'.
+    Given that this team member is a real human, you should be very verbose in your task, it should be a long string providing informations as detailed as necessary.
+    Here is a list of the team members that you can call:
+    {%- for agent in managed_agents.values() %}
+    - {{ agent.name }}: {{ agent.description }}
+    {%- endfor %}
+    {%- else %}
+    {%- endif %}
+
+    Here is the up to date list of facts that you know:
+    ```
+    {{facts_update}}
+    ```
+
+    Now for the given task, develop a step-by-step high-level plan taking into account the above inputs and list of facts.
+    This plan should involve individual tasks based on the available tools, that if executed correctly will yield the correct answer.
+    Beware that you have {remaining_steps} steps remaining.
+    Do not skip steps, do not add any superfluous steps. Only write the high-level plan, DO NOT DETAIL INDIVIDUAL TOOL CALLS.
+    After writing the final step of the plan, write the '\n<end_plan>' tag and stop there.
+
+    Now write your new plan below.
+"managed_agent":
+  "task": |-
+    You're a helpful agent named '{{name}}'.
+    You have been submitted this task by your manager.
+    ---
+    Task:
+    {{task}}
+    ---
+    You're helping your manager solve a wider task: so make sure to not provide a one-line answer, but give as much information as possible to give them a clear understanding of the answer.
+
+    Your final_answer WILL HAVE to contain these parts:
+    ### 1. Task outcome (short version):
+    ### 2. Task outcome (extremely detailed version):
+    ### 3. Additional context (if relevant):
+
+    Put all these in your final_answer tool, everything that you do not pass as an argument to final_answer will be lost.
+    And even if your task resolution is not successful, please return as much context as possible, so that your manager can act upon this feedback.
+  "report": |-
+    Here is the final answer from your managed agent '{{name}}':
+    {{final_answer}}
+"final_answer":
+  "pre_messages": |-
+    An agent tried to answer a user query but it got stuck and failed to do so. You are tasked with providing an answer instead. Here is the agent's memory:
+  "post_messages": |-
+    Based on the above, please provide an answer to the following user request:
+    {{task}}

requirements.txt

@@ -0,0 +1,2 @@
+duckduckgo_search
+smolagents

tools/final_answer.py

@@ -0,0 +1,14 @@
+from typing import Any, Optional
+from smolagents.tools import Tool
+
+class FinalAnswerTool(Tool):
+    name = "final_answer"
+    description = "Provides a final answer to the given problem."
+    inputs = {'answer': {'type': 'any', 'description': 'The final answer to the problem'}}
+    output_type = "any"
+
+    def forward(self, answer: Any) -> Any:
+        return answer
+
+    def __init__(self, *args, **kwargs):
+        self.is_initialized = False

tools/format_github_repos.py

@@ -0,0 +1,46 @@
+from smolagents import Tool
+from typing import Any, Optional
+
+class SimpleTool(Tool):
+    name = "format_github_repos"
+    description = "Formats GitHub repository information into a structured format."
+    inputs = {"repos":{"type":"object","description":"A dictionary containing a list of repositories under the key \"repos\". Each dictionary inside should have the following keys: - \"name\": The repository name. - \"url\": The GitHub URL. - \"stars\": The number of stars (as a string). - \"description\": A brief description of the repository."}}
+    output_type = "object"
+
+    def forward(self, repos: object) -> object:
+        """
+        Formats GitHub repository information into a structured format.
+
+        Args:
+            repos: A dictionary containing a list of repositories under the key "repos".
+                   Each dictionary inside should have the following keys:
+                   - "name": The repository name.
+                   - "url": The GitHub URL.
+                   - "stars": The number of stars (as a string).
+                   - "description": A brief description of the repository.
+
+        Returns:
+            A structured dictionary containing formatted repository details.
+        """
+        # 🔥 Fix: Unpack if "repos" is nested
+        if isinstance(repos, dict) and "repos" in repos:
+            repos = repos["repos"]
+
+        if not isinstance(repos, list):
+            raise ValueError("Expected a list of dictionaries containing repository details.")
+
+        required_keys = {"name", "url", "stars", "description"}
+
+        formatted_repos = []
+        for repo in repos:
+            if not isinstance(repo, dict) or not required_keys.issubset(repo.keys()):
+                raise ValueError(f"Each repository dictionary must contain {required_keys}.")
+
+            formatted_repos.append({
+                "Repository Name": repo["name"],
+                "URL": repo["url"],
+                "Stars": repo["stars"],
+                "Description": repo["description"]
+            })
+
+        return {"GitHub Repositories": formatted_repos}

tools/web_search.py

@@ -0,0 +1,27 @@
+from typing import Any, Optional
+from smolagents.tools import Tool
+import duckduckgo_search
+
+class DuckDuckGoSearchTool(Tool):
+    name = "web_search"
+    description = "Performs a duckduckgo web search based on your query (think a Google search) then returns the top search results."
+    inputs = {'query': {'type': 'string', 'description': 'The search query to perform.'}}
+    output_type = "string"
+
+    def __init__(self, max_results=10, **kwargs):
+        super().__init__()
+        self.max_results = max_results
+        try:
+            from duckduckgo_search import DDGS
+        except ImportError as e:
+            raise ImportError(
+                "You must install package `duckduckgo_search` to run this tool: for instance run `pip install duckduckgo-search`."
+            ) from e
+        self.ddgs = DDGS(**kwargs)
+
+    def forward(self, query: str) -> str:
+        results = self.ddgs.text(query, max_results=self.max_results)
+        if len(results) == 0:
+            raise Exception("No results found! Try a less restrictive/shorter query.")
+        postprocessed_results = [f"[{result['title']}]({result['href']})\n{result['body']}" for result in results]
+        return "## Search Results\n\n" + "\n\n".join(postprocessed_results)