notebooks/simulating_user.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Simulating User\n",
    "\n",
    "In HybridAGI, the User is simulated by default because being able to run a graph program without human input is required to optimize or finetune any interactive program. Many other frameworks to avoid this constraint just removed the possibility to interact with the user during the execution of a plan. But for us, with a background in Human-Human & Human-Robot collaboration, speaking is a goal-directed action that happen in a plan (or program in our case).\n",
    "\n",
    "In HybridAGI, we made 2 different tools to interact with the User:\n",
    "\n",
    "- `Speak`: This tool send a message to the user, the message is being stored into the chat history and the last message is given as final answer to the system. \n",
    "- `AskUser`: This tool ask a question to the user, both question and answer are being stored into the chat history, when the tool is simulated (by default) the answer is simulated by LLM based on the user profile and chat history.\n",
    "\n",
    "In the following graph program, we are going to disambiguate the Objective of the program, to spice things up, we are going to make 2 programs and use sub-program calls."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "/home/yoan/.cache/pypoetry/virtualenvs/hybridagi-B1GoJrSC-py3.10/lib/python3.10/site-packages/tqdm/auto.py:21: TqdmWarning: IProgress not found. Please update jupyter and ipywidgets. See https://ipywidgets.readthedocs.io/en/stable/user_install.html\n",
      "  from .autonotebook import tqdm as notebook_tqdm\n"
     ]
    },
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "\u001b[35m--- Step 0 ---\n",
      "Call Program: main\n",
      "Program Purpose: What is the meaning of life?\u001b[0m\n",
      "\u001b[35m--- Step 1 ---\n",
      "Call Program: clarify_objective\n",
      "Program Purpose: Clarify the Objective if needed\u001b[0m\n",
      "\u001b[34m--- Step 2 ---\n",
      "Decision Purpose: Check if the question is unclear\n",
      "Decision Question: Is the Objective's question still unclear?\n",
      "Decision: CLARIFY\u001b[0m\n",
      "\u001b[36m--- Step 3 ---\n",
      "Action Purpose: Ask question to clarify the Objective\n",
      "Action: {\n",
      "  \"question\": \"What specific aspect or perspective of 'the meaning of life' are you interested in?\",\n",
      "  \"answer\": \"Curiosity about purpose or existence.\"\n",
      "}\u001b[0m\n",
      "\u001b[36m--- Step 4 ---\n",
      "Action Purpose: Refine the question\n",
      "Action: {\n",
      "  \"new_objective\": \"To explore and understand the concept of purpose or existence in relation to 'the meaning of life'.\"\n",
      "}\u001b[0m\n",
      "\u001b[35m--- Step 5 ---\n",
      "End Program: clarify_objective\u001b[0m\n",
      "\u001b[36m--- Step 6 ---\n",
      "Action Purpose: Answer the Objective's question in a helpfull way\n",
      "Action: {\n",
      "  \"message\": \"Hello! I have been designed to assist you with your questions. You asked about exploring and understanding the concept of purpose or existence in relation to 'the meaning of life'. While there isn't a definitive answer to this question, as it varies greatly among different cultures, philosophies, and individuals, I can provide some insights based on various philosophical perspectives.\\n\\nFor instance, some philosophers argue that the purpose of life is to seek happiness or personal fulfillment, while others suggest that our purpose lies in contributing to the greater good or serving others. Some even propose that life has no inherent meaning and it's up to each individual to create their own purpose.\\n\\nI encourage you to reflect on these ideas and consider which perspective resonates with you the most. If you have any specific philosophers, theories, or aspects of this topic you'd like to delve deeper into, feel free to ask! Let's continue this exploration together.\"\n",
      "}\u001b[0m\n",
      "\u001b[35m--- Step 7 ---\n",
      "End Program: main\u001b[0m\n",
      "Hello! I have been designed to assist you with your questions. You asked about exploring and understanding the concept of purpose or existence in relation to 'the meaning of life'. While there isn't a definitive answer to this question, as it varies greatly among different cultures, philosophies, and individuals, I can provide some insights based on various philosophical perspectives.\n",
      "\n",
      "For instance, some philosophers argue that the purpose of life is to seek happiness or personal fulfillment, while others suggest that our purpose lies in contributing to the greater good or serving others. Some even propose that life has no inherent meaning and it's up to each individual to create their own purpose.\n",
      "\n",
      "I encourage you to reflect on these ideas and consider which perspective resonates with you the most. If you have any specific philosophers, theories, or aspects of this topic you'd like to delve deeper into, feel free to ask! Let's continue this exploration together.\n"
     ]
    }
   ],
   "source": [
    "import dspy\n",
    "import hybridagi.core.graph_program as gp\n",
    "from hybridagi.core.datatypes import (\n",
    "    AgentState,\n",
    "    Query,\n",
    ")\n",
    "from hybridagi.memory.integration.local import LocalProgramMemory\n",
    "from hybridagi.modules.agents.tools import (\n",
    "    SpeakTool,\n",
    "    AskUserTool,\n",
    "    UpdateObjectiveTool,\n",
    ")\n",
    "from hybridagi.modules.agents import GraphInterpreterAgent\n",
    "\n",
    "clarify_objective = gp.GraphProgram(\n",
    "    name = \"clarify_objective\",\n",
    "    description = \"Clarify the objective by asking question to the user\",\n",
    ")\n",
    "\n",
    "clarify_objective.add(gp.Decision(\n",
    "    id = \"is_anything_unclear\",\n",
    "    purpose = \"Check if the question is unclear\",\n",
    "    question = \"Is the Objective's question still unclear?\",\n",
    "))\n",
    "\n",
    "clarify_objective.add(gp.Action(\n",
    "    id = \"ask_question\",\n",
    "    purpose = \"Ask question to clarify the Objective\",\n",
    "    tool = \"AskUser\",\n",
    "    prompt = \"Pick one question to clarify the Objective's question\",\n",
    "))\n",
    "\n",
    "clarify_objective.add(gp.Action(\n",
    "    id = \"refine_objective\",\n",
    "    purpose = \"Refine the question\",\n",
    "    tool = \"UpdateObjective\",\n",
    "    prompt = \"Refine the Objective's question by another question\",\n",
    "))\n",
    "\n",
    "clarify_objective.connect(\"start\", \"is_anything_unclear\")\n",
    "clarify_objective.connect(\"ask_question\", \"refine_objective\")\n",
    "clarify_objective.connect(\"is_anything_unclear\", \"ask_question\", label=\"Clarify\")\n",
    "clarify_objective.connect(\"is_anything_unclear\", \"end\", label=\"Answer\")\n",
    "clarify_objective.connect(\"refine_objective\", \"end\")\n",
    "\n",
    "clarify_objective.build()\n",
    "\n",
    "main = gp.GraphProgram(\n",
    "    name=\"main\",\n",
    "    description=\"The main program\",\n",
    ")\n",
    "\n",
    "main.add(gp.Program(\n",
    "    id = \"clarify_objective\",\n",
    "    purpose = \"Clarify the Objective if needed\",\n",
    "    program = \"clarify_objective\",\n",
    "))\n",
    "\n",
    "main.add(gp.Action(\n",
    "    id = \"answer\",\n",
    "    purpose = \"Answer the Objective's question in a helpfull way\",\n",
    "    tool = \"Speak\",\n",
    "    prompt = \"Please answer the Objective's question\",\n",
    "))\n",
    "\n",
    "main.connect(\"start\", \"clarify_objective\")\n",
    "main.connect(\"clarify_objective\", \"answer\")\n",
    "main.connect(\"answer\", \"end\")\n",
    "\n",
    "main.build()\n",
    "\n",
    "program_memory = LocalProgramMemory(index_name=\"test\")\n",
    "\n",
    "program_memory.update(clarify_objective)\n",
    "program_memory.update(main)\n",
    "\n",
    "agent_state = AgentState()\n",
    "\n",
    "tools = [\n",
    "    SpeakTool(\n",
    "        agent_state = agent_state,\n",
    "        speak_func = None, # the callable to call outside the simulation (default None)\n",
    "        simulated = True, # Weither or not to simulate the tool (default True)\n",
    "    ),\n",
    "    AskUserTool(\n",
    "        agent_state = agent_state,\n",
    "        ask_user_func = None, # the callable to call outside the simulation (default None)\n",
    "        simulated = True, # Weither or not to simulate the tool (default True)\n",
    "    ),\n",
    "    UpdateObjectiveTool(\n",
    "        agent_state = agent_state,\n",
    "    )\n",
    "]\n",
    "\n",
    "agent = GraphInterpreterAgent(\n",
    "    program_memory = program_memory,\n",
    "    agent_state = agent_state,\n",
    "    tools = tools,\n",
    ")\n",
    "\n",
    "# We can now setup the LLM using Ollama client from DSPy\n",
    "\n",
    "lm = dspy.OllamaLocal(model='mistral', max_tokens=1024, stop=[\"\\n\\n\\n\", \"\\n---\", \"\\n\\nContext:\"])\n",
    "dspy.configure(lm=lm)\n",
    "\n",
    "result = agent(Query(query=\"What is the meaning of life?\"))\n",
    "\n",
    "print(result.final_answer)"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "hybridagi-B1GoJrSC-py3.10",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.10.12"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}