Update BaseLLM.chat and BaseLLM.continue_conversation_with_tool_call_results for better consistency (#84)

* update chat and continue_conversation_with_tool_results return types

* fix agent tests

* fix tests

* update ollama

* update ollama tests

* ensure agent nb works

* changelog

Author: nerdai

CHANGELOG.md

@@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ### Changed
 
+- Update `BaseLLM.chat` and `BaseLLM.continue_conversation_with_tool_call_results` for better consistency (#84)
 - Refactor: Change LLMAgent.run helper method _run name to_process_loop (#83)
 - Remove TaskHandler._lock since we actually don't need it (#79)
 - [Fix] Move check for previous_step_result at top of method (#76)

docs/notebooks/first_llm_agent.ipynb

@@ -185,7 +185,7 @@
     "from llm_agents_from_scratch.logger import enable_console_logging\n",
     "\n",
     "if LOGGING_ENABLED:\n",
-    "    enable_console_logging(logging.INFO)"
+    "    enable_console_logging(logging.DEBUG)"
    ]
   },
   {
@@ -213,6 +213,27 @@
   {
    "cell_type": "code",
    "execution_count": 13,
+   "id": "980b29c6-bf26-439c-9458-0cab040e854b",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "Task(id_='25aa12c3-ae1a-415c-a186-102b4412c268', instruction='Add one to fifty-five point three. Use an appropriate tool!')"
+      ]
+     },
+     "execution_count": 13,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "task"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 14,
    "id": "e99cca54-0d21-4c9d-9a17-bf595d110fe5",
    "metadata": {},
    "outputs": [
@@ -222,11 +243,62 @@
      "text": [
       "INFO (llm_agents_fs.LLMAgent) :      🚀 Starting task: Add one to fifty-five point three. Use an appropriate tool!\n",
       "INFO (llm_agents_fs.TaskHandler) :      ⚙️ Processing Step: Add one to fifty-five point three. Use an appropriate tool!\n",
+      "DEBUG (llm_agents_fs.TaskHandler) :      🧵 Rollout: \n",
+      "DEBUG (llm_agents_fs.TaskHandler) :      💬 SYSTEM: You are a helpful assistant.\n",
+      "DEBUG (llm_agents_fs.TaskHandler) :      💬 USER INPUT: Add one to fifty-five point three. Use an appropriate tool!\n",
+      "DEBUG (llm_agents_fs.TaskHandler) :      💬 ASSISTANT: \n",
       "INFO (llm_agents_fs.TaskHandler) :      🛠️ Executing Tool Call: add_one\n",
       "INFO (llm_agents_fs.TaskHandler) :      ✅ Successful Tool Call: 56.3\n",
-      "INFO (llm_agents_fs.TaskHandler) :      ✅ Step Result: Adding one to fifty-five point three gives us fifty-six point three.\n",
+      "INFO (llm_agents_fs.TaskHandler) :      ✅ Step Result: The result of adding one to 55.3 is 56.3.\n",
+      "DEBUG (llm_agents_fs.TaskHandler) :      🧵 Rollout: assistant: The current instruction is 'Add one to fifty-five point three. Use an appropriate tool!'\n",
+      "assistant: I need to make a tool call(s) to `add_one`.\n",
+      "tool: {\n",
+      "    \"tool_call\": {\n",
+      "        \"tool_name\": \"add_one\",\n",
+      "        \"arguments\": {\n",
+      "            \"x\": \"55.3\"\n",
+      "        }\n",
+      "    },\n",
+      "    \"content\": \"56.3\",\n",
+      "    \"error\": false\n",
+      "}\n",
+      "assistant: The result of adding one to 55.3 is 56.3.\n",
+      "DEBUG (llm_agents_fs.TaskHandler) :      ---NEXT STEP PROMPT: You are overseeing an assistant's\n",
+      "progress in accomplishing a user instruction. Provided below is the assistant's\n",
+      "current response to the original task instruction. Also provided, is an\n",
+      "internal 'thinking' process of the assistant that the user has not seen.\n",
+      "\n",
+      "Determine if the current the response is sufficient to answer the original task\n",
+      "instruction. In the case that it is not, provide a new instruction to the\n",
+      "assistant in order to help them improve upon their current response.\n",
+      "\n",
+      "<user-instruction>\n",
+      "Add one to fifty-five point three. Use an appropriate tool!\n",
+      "</user-instruction>\n",
+      "\n",
+      "<current-response>\n",
+      "The result of adding one to 55.3 is 56.3.\n",
+      "</current-response>\n",
+      "\n",
+      "<thinking-process>\n",
+      "assistant: The current instruction is 'Add one to fifty-five point three. Use an appropriate tool!'\n",
+      "assistant: I need to make a tool call(s) to `add_one`.\n",
+      "tool: {\n",
+      "    \"tool_call\": {\n",
+      "        \"tool_name\": \"add_one\",\n",
+      "        \"arguments\": {\n",
+      "            \"x\": \"55.3\"\n",
+      "        }\n",
+      "    },\n",
+      "    \"content\": \"56.3\",\n",
+      "    \"error\": false\n",
+      "}\n",
+      "assistant: The result of adding one to 55.3 is 56.3.\n",
+      "</thinking-process>\n",
+      "\n",
+      "DEBUG (llm_agents_fs.TaskHandler) :      ---NEXT STEP: {\"task_step\":{\"id_\":\"915cca85-0b6b-477d-921e-0dce7b8b3533\",\"task_id\":\"add-one-to-55-point-three\",\"instruction\":\"Add one to fifty-five point three using the tool add_one.\"},\"task_result\":{\"task_id\":\"add-one-to-55-point-three\",\"content\":\"The result of adding one to 55.3 is 56.3.\"}}\n",
       "INFO (llm_agents_fs.TaskHandler) :      No new step required.\n",
-      "INFO (llm_agents_fs.LLMAgent) :      🏁 Task completed: Adding one to fifty-five point three gives us fifty-six point three.\n"
+      "INFO (llm_agents_fs.LLMAgent) :      🏁 Task completed: The result of adding one to 55.3 is 56.3.\n"
      ]
     }
    ],
@@ -236,15 +308,36 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 14,
+   "execution_count": 15,
+   "id": "3615a1c9-8a1d-4783-a840-e186206d9446",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "TaskResult(task_id='25aa12c3-ae1a-415c-a186-102b4412c268', content='The result of adding one to 55.3 is 56.3.')"
+      ]
+     },
+     "execution_count": 15,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "result.task_result"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 16,
    "id": "0fde7c61-f0d9-4ef9-b0b6-90386667bbb8",
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "The result is fifty-six point three.\n"
+      "The result of adding one to 55.3 is 56.3.\n"
      ]
     }
    ],
@@ -254,16 +347,16 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 15,
+   "execution_count": 17,
    "id": "93b1cfa1-1ac0-420d-b36e-007de5cdfc7f",
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "assistant: Add one to fifty-five point three. Use an appropriate tool!\n",
-      "assistant: I need to make a tool call(s) to add_one\n",
+      "assistant: The current instruction is 'Add one to fifty-five point three. Use an appropriate tool!'\n",
+      "assistant: I need to make a tool call(s) to `add_one`.\n",
       "tool: {\n",
       "    \"tool_call\": {\n",
       "        \"tool_name\": \"add_one\",\n",
@@ -274,21 +367,13 @@
       "    \"content\": \"56.3\",\n",
       "    \"error\": false\n",
       "}\n",
-      "assistant: Adding one to fifty-five point three gives us fifty-six point three.\n"
+      "assistant: The result of adding one to 55.3 is 56.3.\n"
      ]
     }
    ],
    "source": [
     "print(result.rollout)"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "e1a01698-dcdc-4796-a41b-6029eafa9ab5",
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {