Make the edamam tool handle failures well

Informs the user when recipe search fails to find any and recommends
retrying with the last word chopped off. This can be picked up by the
agent to automatically retry. Queries with too many characters are
caught and handled too.
Also added |eval: false to several cells that should not be executing on
nbdev_test.

nbs/02_vegan_recipe_tools.ipynb

@@ -86,6 +86,7 @@
     }
    ],
    "source": [
+    "#| eval: false\n",
     "load_dotenv()"
    ]
   },
@@ -95,6 +96,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "#| eval: false\n",
     "llm = ChatOpenAI(temperature=0)"
    ]
   },
@@ -104,6 +106,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "#| eval: false\n",
     "tools = load_tools([\"llm-math\"], llm=llm)\n",
     "agent = initialize_agent(\n",
     "    tools,\n",
@@ -217,7 +220,7 @@
       "Action Input: 3% * (300 * 30)\u001b[0m\n",
       "Observation: \u001b[36;1m\u001b[1;3mAnswer: 270.0\u001b[0m\n",
       "Thought:\u001b[32;1m\u001b[1;3mI now know the final answer\n",
-      "Final Answer: The 3% of 300 * 30 is 270.0.\u001b[0m\n",
+      "Final Answer: 270.0\u001b[0m\n",
       "\n",
       "\u001b[1m> Finished chain.\u001b[0m\n"
      ]
@@ -225,8 +228,7 @@
     {
      "data": {
       "text/plain": [
-       "{'input': 'What is the 3% of of 300 * 30?',\n",
-       " 'output': 'The 3% of 300 * 30 is 270.0.'}"
+       "{'input': 'What is the 3% of of 300 * 30?', 'output': '270.0'}"
       ]
      },
      "execution_count": null,
@@ -302,6 +304,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "#| eval: false\n",
     "agent = OpenAIFunctionsAgent(llm=llm, tools=tools, prompt=prompt)"
    ]
   },
@@ -311,6 +314,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "#| eval: false\n",
     "agent_executor = AgentExecutor(agent=agent, tools=tools, memory=memory, verbose=True)"
    ]
   },
@@ -884,6 +888,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "#| eval: false\n",
     "params = {\n",
     "    \"location\": \"United States\",\n",
     "    \"hl\": \"en\",\n",
@@ -927,6 +932,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "#| eval: false\n",
     "agent = initialize_agent(\n",
     "    [time],\n",
     "    llm,\n",
@@ -1045,6 +1051,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "#| eval: false\n",
     "agent = OpenAIFunctionsAgent(\n",
     "    llm=llm, tools=[vegan_recipe_serpapi_search], prompt=prompt\n",
     ")"
@@ -1054,8 +1061,21 @@
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "ename": "NameError",
+     "evalue": "name 'vegan_recipe_serpapi_search' is not defined",
+     "output_type": "error",
+     "traceback": [
+      "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
+      "\u001b[0;31mNameError\u001b[0m                                 Traceback (most recent call last)",
+      "Cell \u001b[0;32mIn[45], line 3\u001b[0m\n\u001b[1;32m      1\u001b[0m \u001b[38;5;66;03m#| eval: false\u001b[39;00m\n\u001b[1;32m      2\u001b[0m agent_executor \u001b[38;5;241m=\u001b[39m AgentExecutor(\n\u001b[0;32m----> 3\u001b[0m     agent\u001b[38;5;241m=\u001b[39magent, tools\u001b[38;5;241m=\u001b[39m[\u001b[43mvegan_recipe_serpapi_search\u001b[49m], memory\u001b[38;5;241m=\u001b[39mmemory, verbose\u001b[38;5;241m=\u001b[39m\u001b[38;5;28;01mTrue\u001b[39;00m\n\u001b[1;32m      4\u001b[0m )\n",
+      "\u001b[0;31mNameError\u001b[0m: name 'vegan_recipe_serpapi_search' is not defined"
+     ]
+    }
+   ],
    "source": [
+    "#| eval: false\n",
     "agent_executor = AgentExecutor(\n",
     "    agent=agent, tools=[vegan_recipe_serpapi_search], memory=memory, verbose=True\n",
     ")"
@@ -2225,17 +2245,11 @@
     }
    ],
    "source": [
+    "#| eval: false\n",
     "response = get_vegan_recipes_edamam_api({\"q\": \"vegan chicken\"})\n",
     "display(response.ok, response.json()[\"hits\"][0][\"recipe\"])"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "TODO Maybe skip agent/ tool and integrate into gradio demo?"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -2243,13 +2257,18 @@
    "outputs": [],
    "source": [
     "#| export\n",
-    "@tool\n",
+    "@tool(return_direct=True)\n",
     "def vegan_recipe_edamam_search(query: str) -> str:\n",
     "    \"\"\"\n",
     "    Searches for vegan recipes based on a query.\n",
     "    If the query is not vegan friendly, adapt it to be.\n",
-    "    If the request fails an explanation message will be returned instead of the recipe JSON.\n",
+    "    If the request fails an explanation should be returned.\n",
+    "    If the cause of the failure was due to no recipes found, prompt the user to try again with a provided shorter query with one word removed.\n",
     "    \"\"\"\n",
+    "    max_chars = 45  # 5 chars per word * 9 max words\n",
+    "    if len(query) > max_chars:\n",
+    "        return f\"The query is too long, try again with a query that is under {max_chars} characters in length.\"\n",
+    "\n",
     "    # Veganize the query more\n",
     "    if \"vegan\" not in query.lower():\n",
     "        query = \"vegan \" + query\n",
@@ -2264,7 +2283,14 @@
     "\n",
     "    response = get_vegan_recipes_edamam_api(params)\n",
     "    if not response.ok:\n",
-    "        return f\"Received an error from Edamam API: {response.status_code} {response.text }\"\n",
+    "        return (\n",
+    "            f\"Received an error from Edamam API: {response.status_code} {response.text}\"\n",
+    "        )\n",
+    "\n",
+    "    if response.json()[\"count\"] <= 0:\n",
+    "        return f\"\"\"No recipes found for query {query}.\n",
+    "This usually occurs when there are too many keywords or ingredients that are not commonly found together in recipes.\n",
+    "I recommend trying again with `{' '.join(query.split(' ')[0:-1])}.`\"\"\"\n",
     "\n",
     "    return str([r[\"recipe\"] for r in response.json()[\"hits\"][0:3]])"
    ]
@@ -2329,30 +2355,7 @@
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mHi there! How can I assist you today?\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'Hi there! How can I assist you today?'"
-      ]
-     },
-     "execution_count": null,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
+   "outputs": [],
    "source": [
     "#| eval: false\n",
     "agent_executor.run(\"Hello\")"
@@ -2362,30 +2365,7 @@
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mOf course! I'm here to help. What do you need assistance with?\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "\"Of course! I'm here to help. What do you need assistance with?\""
-      ]
-     },
-     "execution_count": null,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
+   "outputs": [],
    "source": [
     "#| eval: false\n",
     "agent_executor.run(\"Help\")"
@@ -2395,30 +2375,7 @@
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mMy purpose is to assist and provide information on vegan recipes. I am here to help you find delicious and nutritious plant-based meal options. If you have any specific questions or need recipe recommendations, feel free to ask!\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'My purpose is to assist and provide information on vegan recipes. I am here to help you find delicious and nutritious plant-based meal options. If you have any specific questions or need recipe recommendations, feel free to ask!'"
-      ]
-     },
-     "execution_count": null,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
+   "outputs": [],
    "source": [
     "#| eval: false\n",
     "agent_executor.run(\"What is your purpose?\")"
@@ -2432,10 +2389,12 @@
     {
      "data": {
       "text/plain": [
-       "[HumanMessage(content='Look up grilled cheese recipes please', additional_kwargs={}, example=False),\n",
-       " AIMessage(content='I found a couple of vegan recipes that you might enjoy:\\n\\n1. [Grilled Avocado Sandwich](https://food52.com/recipes/31404-grilled-avocado-sandwich)\\n   - Ingredients: 2 slices of bread, 1/4 cup mashed avocado (or more), salt and pepper to taste, garlic powder (optional), Earth Balance vegan butter, room temp.\\n\\n2. [Shiny Happy Poppers](https://www.epicurious.com/recipes/food/views/shiny-happy-poppers-51100000)\\n   - Ingredients: 12 jalapeños, 1 cup cooked white or brown rice, 1 cup canned black beans, drained and rinsed, 2 tablespoons smooth or grainy vegan Dijon mustard, 1 teaspoon garlic powder (or 1 medium-size clove garlic, peeled and pressed), 1 tablespoon chopped fresh thyme leaves (or 2 teaspoons dried), 1/2 cup extra-virgin olive oil (for drizzling), hot sauce of choice (for drizzling).\\n\\nPlease note that these recipes are vegan and do not contain any animal products. Enjoy your meal!', additional_kwargs={}, example=False),\n",
-       " HumanMessage(content='I have a few ingrediens I would like to cook with.', additional_kwargs={}, example=False),\n",
-       " AIMessage(content=\"Sure! Please let me know the ingredients you have, and I'll try to find a vegan recipe that includes them.\", additional_kwargs={}, example=False)]"
+       "[HumanMessage(content='Hello', additional_kwargs={}, example=False),\n",
+       " AIMessage(content='Hi there! How can I assist you today?', additional_kwargs={}, example=False),\n",
+       " HumanMessage(content='Help', additional_kwargs={}, example=False),\n",
+       " AIMessage(content=\"Of course! I'm here to help. What do you need assistance with?\", additional_kwargs={}, example=False),\n",
+       " HumanMessage(content='What is your purpose?', additional_kwargs={}, example=False),\n",
+       " AIMessage(content='My purpose is to assist and provide information to users like you. I can help answer questions, provide recommendations, and assist with various tasks. Is there something specific you would like assistance with?', additional_kwargs={}, example=False)]"
       ]
      },
      "execution_count": null,
@@ -2460,7 +2419,7 @@
       "\n",
       "\n",
       "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mThat's great! I can help you find vegan recipes using the ingredients you have. Please let me know what ingredients you have, and I'll provide you with some recipe suggestions.\u001b[0m\n",
+      "\u001b[32;1m\u001b[1;3mThat's great! Please let me know the ingredients you have, and I'll help you find some vegan recipes to cook with them.\u001b[0m\n",
       "\n",
       "\u001b[1m> Finished chain.\u001b[0m\n"
      ]
@@ -2468,7 +2427,7 @@
     {
      "data": {
       "text/plain": [
-       "\"That's great! I can help you find vegan recipes using the ingredients you have. Please let me know what ingredients you have, and I'll provide you with some recipe suggestions.\""
+       "\"That's great! Please let me know the ingredients you have, and I'll help you find some vegan recipes to cook with them.\""
       ]
      },
      "execution_count": null,
@@ -2493,7 +2452,49 @@
       "\n",
       "\n",
       "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mGreat! You have a variety of ingredients to work with. Do you have any food allergies or dietary restrictions that I should consider when suggesting recipes?\u001b[0m\n",
+      "\u001b[32;1m\u001b[1;3m\n",
+      "Invoking: `vegan_recipe_edamam_search` with `{'query': 'tofu peppers carrots apples bananas kale spinach just egg soy milk'}`\n",
+      "\n",
+      "\n",
+      "\u001b[0m\u001b[36;1m\u001b[1;3mThe query is too long, try again with a query that is under 45 characters in length.\u001b[0m\u001b[32;1m\u001b[1;3m\n",
+      "Invoking: `vegan_recipe_edamam_search` with `{'query': 'tofu peppers carrots apples bananas kale spinach just egg'}`\n",
+      "\n",
+      "\n",
+      "\u001b[0m\u001b[36;1m\u001b[1;3mThe query is too long, try again with a query that is under 45 characters in length.\u001b[0m\u001b[32;1m\u001b[1;3m\n",
+      "Invoking: `vegan_recipe_edamam_search` with `{'query': 'tofu peppers carrots apples bananas kale spinach'}`\n",
+      "\n",
+      "\n",
+      "\u001b[0m\u001b[36;1m\u001b[1;3mThe query is too long, try again with a query that is under 45 characters in length.\u001b[0m\u001b[32;1m\u001b[1;3m\n",
+      "Invoking: `vegan_recipe_edamam_search` with `{'query': 'tofu peppers carrots apples bananas kale'}`\n",
+      "\n",
+      "\n",
+      "\u001b[0m\u001b[36;1m\u001b[1;3mNo recipes found for query vegan tofu peppers carrots apples bananas kale.\n",
+      "This usually occurs when there are too many keywords or ingredients that are not commonly found together in recipes.\n",
+      "I recommend trying again with `vegan tofu peppers carrots apples bananas.`\u001b[0m\u001b[32;1m\u001b[1;3m\n",
+      "Invoking: `vegan_recipe_edamam_search` with `{'query': 'vegan tofu peppers carrots apples bananas'}`\n",
+      "\n",
+      "\n",
+      "\u001b[0m\u001b[36;1m\u001b[1;3mNo recipes found for query vegan tofu peppers carrots apples bananas.\n",
+      "This usually occurs when there are too many keywords or ingredients that are not commonly found together in recipes.\n",
+      "I recommend trying again with `vegan tofu peppers carrots apples.`\u001b[0m\u001b[32;1m\u001b[1;3m\n",
+      "Invoking: `vegan_recipe_edamam_search` with `{'query': 'vegan tofu peppers carrots apples'}`\n",
+      "\n",
+      "\n",
+      "\u001b[0m\u001b[36;1m\u001b[1;3m[{'label': 'Peanut Tofu Stir Fry (Vegan + GF)', 'url': 'http://www.rhiansrecipes.com/2015/12/21/peanut-tofu-stir-fry-vegan-gf/', 'ingredientLines': ['* 2 tablespoon oil (coconut, vegetable or rapeseed), for frying', '* 400 g (14oz) hard, firm tofu', '* 1 red onion, finely sliced', '* 1 carrot, peeled and finely sliced', '* 200 g (7oz) french bean, trimmed and cut in 1/2', '* 1 sweet red pepper, finely sliced', 'for the marinade', '* 2 tablespoon peanut butter', '* 2 tablespoon sweet chilli sauce (you can substitute with chilli and', \"sugar if you don't have thi)\", '* 3 tablespoon soy sauce', '* 2 tablespoon vinegar (rice or apple cider)'], 'totalTime': 0.0}, {'label': 'Vegan Wasabi Slaw', 'url': 'http://kblog.lunchboxbunch.com/2011/07/vegan-wasabi-slaw.html', 'ingredientLines': ['2+ Tbsp wasabi powder', '2 Tbsp grape seed oil', '16 ounces silken tofu', '2-3 Tbsp apple cider vinegar', '1 1/2 Tbsp maple syrup', '2 Tbsp tamari', '1/4 tsp pepper', '2 tsp garlic powder', \"1 Tbsp dried parsley flaves (opt'l)\", \"sea salt (opt'l to taste)\", '1 bad (12 ounces) Brocco Slaw', '1-2 cups shredded carrots', \"1 green apple, shredded (opt'l)\", \"1/2 cup hemp or sunflower seeds (opt'l)\"], 'totalTime': 0.0}, {'label': 'Spicy Salad with Tahini Dressing', 'url': 'http://nimailarson.com/spicy-salad-with-tahini-dressing/', 'ingredientLines': ['2 handfuls of Arugula', '7 Oz Firm Tofu (half a block)', '1/2 Cucumber', '1/4 White Onion', '4 Radishes', '1/4 Cup Sunflower Seeds', '1/4 Cup Nutritional Yeast', '3 Tablespoons Soy Sauce', '1/4 Cup Water', '2 Tablespoons Tahini', '1 Tablespoon Olive Oil', '1 Tablespoon Apple Cider Vinegar', '1 Clove of Garlic', 'Salt, Black Pepper, Turmeric', 'Optional fun toppings: Daiya Vegan Cheese, Avocado, Sprouts, Shredded Carrot or Beetroot'], 'totalTime': 0.0}]\u001b[0m\u001b[32;1m\u001b[1;3mI found some vegan recipes for you based on the ingredients you have:\n",
+      "\n",
+      "1. [Peanut Tofu Stir Fry (Vegan + GF)](http://www.rhiansrecipes.com/2015/12/21/peanut-tofu-stir-fry-vegan-gf/)\n",
+      "   - Ingredients: oil, tofu, red onion, carrot, french bean, sweet red pepper, peanut butter, sweet chilli sauce, soy sauce, vinegar\n",
+      "   - Total Time: Not specified\n",
+      "\n",
+      "2. [Vegan Wasabi Slaw](http://kblog.lunchboxbunch.com/2011/07/vegan-wasabi-slaw.html)\n",
+      "   - Ingredients: wasabi powder, grape seed oil, silken tofu, apple cider vinegar, maple syrup, tamari, pepper, garlic powder, dried parsley flakes, sea salt, Brocco Slaw, shredded carrots, green apple, hemp or sunflower seeds\n",
+      "   - Total Time: Not specified\n",
+      "\n",
+      "3. [Spicy Salad with Tahini Dressing](http://nimailarson.com/spicy-salad-with-tahini-dressing/)\n",
+      "   - Ingredients: arugula, firm tofu, cucumber, white onion, radishes, sunflower seeds, nutritional yeast, soy sauce, water, tahini, olive oil, apple cider vinegar, garlic, salt, black pepper, turmeric\n",
+      "   - Total Time: Not specified\n",
+      "\n",
+      "Please let me know if you would like more information about any of these recipes or if you need help with anything else!\u001b[0m\n",
       "\n",
       "\u001b[1m> Finished chain.\u001b[0m\n"
      ]
@@ -2501,7 +2502,7 @@
     {
      "data": {
       "text/plain": [
-       "'Great! You have a variety of ingredients to work with. Do you have any food allergies or dietary restrictions that I should consider when suggesting recipes?'"
+       "'I found some vegan recipes for you based on the ingredients you have:\\n\\n1. [Peanut Tofu Stir Fry (Vegan + GF)](http://www.rhiansrecipes.com/2015/12/21/peanut-tofu-stir-fry-vegan-gf/)\\n   - Ingredients: oil, tofu, red onion, carrot, french bean, sweet red pepper, peanut butter, sweet chilli sauce, soy sauce, vinegar\\n   - Total Time: Not specified\\n\\n2. [Vegan Wasabi Slaw](http://kblog.lunchboxbunch.com/2011/07/vegan-wasabi-slaw.html)\\n   - Ingredients: wasabi powder, grape seed oil, silken tofu, apple cider vinegar, maple syrup, tamari, pepper, garlic powder, dried parsley flakes, sea salt, Brocco Slaw, shredded carrots, green apple, hemp or sunflower seeds\\n   - Total Time: Not specified\\n\\n3. [Spicy Salad with Tahini Dressing](http://nimailarson.com/spicy-salad-with-tahini-dressing/)\\n   - Ingredients: arugula, firm tofu, cucumber, white onion, radishes, sunflower seeds, nutritional yeast, soy sauce, water, tahini, olive oil, apple cider vinegar, garlic, salt, black pepper, turmeric\\n   - Total Time: Not specified\\n\\nPlease let me know if you would like more information about any of these recipes or if you need help with anything else!'"
       ]
      },
      "execution_count": null,
@@ -2584,6 +2585,7 @@
     }
    ],
    "source": [
+    "#| eval: false\n",
     "vegan_recipe_edamam_search(\"Tofu Stir-Fry\")"
    ]
   },