Merge pull request Azure#80 from Azure/assistantscleanup

Assistantscleanup

Author: codebytes

gen-ai/Assistants/README.md

@@ -35,6 +35,7 @@ Check out the provided samples to get started with integrating the Assistants AP
 | [Financial Assistant](./api-in-a-box/personal_finance/assistant-personal_finance.ipynb) | Function Calling with Yfinance to get latest stock prices. Summarization of user provided article. Extract country info from article, extract country, capital and other aspects, and call an API to get more information about each country. |
 | [Failed Banks](./api-in-a-box/failed_banks/assistant-failed_banks.ipynb) | Failed Banks is an Assistant designed to analyze and extract data concerning failed banks. It can provide insights into questions like identifying failed banks within specific states during a given time frame and generate charts illustrating bank failures across the US. |
 | [Wind Farm](./api-in-a-box/wind_farm/assistant-wind_farm.ipynb) | Utilizing Assistant tools such as the Code Interpreter and Function calling, this bot is capable of retrieving a CSV file that illustrates turbine wind speed, voltage, and the last maintenance date. It assists you in reviewing the file contents and aids in determining whether a specific turbine is in need of maintenance. |
+| [Sales Assistant](./api-in-a-box/sales_assistant/assistant_sales.ipynb) | Showcases how you can create an Assistant adept at managing various tasks, such as handling relational data across different files and supporting multiple users simultaneously within the same Assistant across distinct threads. |
 | [Assistants Bot-in-a-Box](./bot-in-a-box/) | The Assistants API Bot in-a-box automates virtual assistant deployment on Azure, facilitating seamless communication between users and assistants across various messaging channels. It streamlines message processing and response delivery through Azure Bot Services and the Assistants API. |
 
 ## Prerequisites

gen-ai/Assistants/api-in-a-box/README.md

@@ -145,8 +145,9 @@ while True:
 |----------------------|--------------------------------------------------|
 | [Math Tutor](math_tutor/assistant-math_tutor.ipynb) | Showcases the foundational concepts of Assistants such as Threads, Messages, Runs, Tools, and lifecycle management. |
 | [Financial Assistant](personal_finance/assistant-personal_finance.ipynb) | Function Calling with Yfinance to get latest stock prices. Summarization of user provided article. Extract country info from article, extract country, capital and other aspects, and call an API to get more information about each country. |
-| [Failed Banks](failed_banks/assistant-failed_banks.ipynb) | Failed Banks is an Assistant designed to analyze and extract data concerning failed banks. It can provide insights into questions like identifying failed banks within specific states during a given time frame and generate charts illustrating bank failures across the US. |
+| [Failed Banks](failed_banks/assistant-failed_banks.ipynb) | Using Assistant tools Code Interpreter and Function calling, this Assistant can get a CSV file, gather a list of failed banks by state, and generate a chart to visually represent the data. |
 | [Wind Farm](wind_farm/assistant-wind_farm.ipynb) | Utilizing Assistant tools such as the Code Interpreter and Function calling, this bot is capable of retrieving a CSV file that illustrates turbine wind speed, voltage, and the last maintenance date. It assists you in reviewing the file contents and aids in determining whether a specific turbine is in need of maintenance. |
+| [Sales Assistant](sales_assistant/assistant_sales.ipynb) | Showcases how you can create an Assistant adept at managing various tasks, such as handling relational data across different files and supporting multiple users simultaneously within the same Assistant across distinct threads. |
 
 ## Prerequisites
 

gen-ai/Assistants/api-in-a-box/failed_banks/README.md

@@ -10,6 +10,7 @@ Using Assistant tools Code Interpreter and Function calling, this bot can get a
 The objective of the provided notebook file is to create an Azure OpenAI Assistant named "Failed Banks Assistant" using the Azure OpenAI API. The assistant is designed to assist users in obtaining information about failed banks based on a provided CSV file. The assistant is equipped with the capability to process user messages, interact with the provided file, and respond with relevant information.
 
 ### Programming Languages
- - Python
+
+- Python
 
 ### Estimated Runtime: 5 mins

gen-ai/Assistants/api-in-a-box/failed_banks/assistant-failed_banks.ipynb

@@ -4,9 +4,65 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Failed Banks Information Assistant\n",
+    "# Failed Banks Information Assistant"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Objective\n",
     "\n",
-    "### Load the required libraries"
+    "This notebook demonstrates the following:\n",
+    "\n",
+    "- Using Assistant tools Code Interpreter and Function calling, this bot can get a CSV file, gather a list of failed banks by state, and generate a chart to visually represent the data.\n",
+    "\n",
+    "This tutorial uses the following Azure AI services:\n",
+    "- Access to Azure OpenAI Service - you can apply for access [here](https://aka.ms/oai/access)\n",
+    "- Azure OpenAI service - you can create it from instructions [here](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource)\n",
+    "- Azure OpenAI Studio - go to [https://oai.azure.com/](https://oai.azure.com/) to work with the Assistants API Playground\n",
+    "- A connection to the Azure OpenAI Service with a [Key and Endpoint](https://learn.microsoft.com/en-us/azure/ai-services/openai/chatgpt-quickstart)\n",
+    "\n",
+    "Reference:\n",
+    "- Learn more about how to use Assistants with our [How-to guide on Assistants](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/assistant)\n",
+    "- [Assistants OpenAI Overview](https://platform.openai.com/docs/assistants/overview)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Time\n",
+    "\n",
+    "You should expect to spend 5-10 minutes running this sample. "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## About this example\n",
+    "\n",
+    "This sample demonstrates the creation of an Azure OpenAI Assistant named \"Failed Banks Assistant\" through the Azure OpenAI API. The assistant is tailored to aid users in retrieving information about failed banks from a CSV file, the assistant efficiently processes user messages, interacts with the designated file, and promptly delivers pertinent information in response.\n",
+    "\n",
+    "### Data\n",
+    "This sample uses files from the folder [`data/`](./data/) in this repo. You can clone this repo or copy this folder to make sure you have access to these files when running the sample."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Before you begin"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Installation\n",
+    "\n",
+    "Install the following packages required to execute this notebook."
    ]
   },
   {
@@ -15,27 +71,15 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import io\n",
-    "import os\n",
-    "import time\n",
-    "from datetime import datetime\n",
-    "from pathlib import Path\n",
-    "from typing import Iterable\n",
-    "\n",
-    "from dotenv import load_dotenv\n",
-    "from openai import AzureOpenAI\n",
-    "from openai.types import FileObject\n",
-    "from openai.types.beta.threads.message_content_image_file import MessageContentImageFile\n",
-    "from openai.types.beta.threads.message_content_text import MessageContentText\n",
-    "from openai.types.beta.threads.messages import MessageFile\n",
-    "from PIL import Image"
+    "# Install the packages\n",
+    "%pip install -r ../requirements.txt"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Load the environment variables"
+    "### Parameters"
    ]
   },
   {
@@ -44,19 +88,60 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "load_dotenv(\"../.env\")\n",
+    "import os\n",
+    "\n",
+    "from dotenv import load_dotenv\n",
+    "\n",
+    "load_dotenv(\"../.env\")  # make sure to have the .env file in the root directory of the project\n",
+    "\n",
     "api_endpoint = os.getenv(\"OPENAI_URI\")\n",
     "api_key = os.getenv(\"OPENAI_KEY\")\n",
     "api_version = os.getenv(\"OPENAI_VERSION\")\n",
     "api_deployment_name = os.getenv(\"OPENAI_GPT_DEPLOYMENT\")\n",
-    "email_URI = os.getenv(\"EMAIL_URI\")"
+    "email_URI = os.getenv(\"EMAIL_URI\")\n",
+    "\n",
+    "should_cleanup: bool = False"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Run this Example"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Load the required libraries"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import io\n",
+    "import time\n",
+    "from datetime import datetime\n",
+    "from pathlib import Path\n",
+    "from typing import Iterable\n",
+    "\n",
+    "from openai import AzureOpenAI\n",
+    "from openai.types import FileObject\n",
+    "from openai.types.beta.threads.message_content_image_file import MessageContentImageFile\n",
+    "from openai.types.beta.threads.message_content_text import MessageContentText\n",
+    "from openai.types.beta.threads.messages import MessageFile\n",
+    "from PIL import Image"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Create an AzureOpenAI client"
+    "### Create an Azure OpenAI client"
    ]
   },
   {
@@ -147,7 +232,7 @@
    "source": [
     "def read_assistant_file(file_id:str):\n",
     "    response_content = client.files.content(file_id)\n",
-    "    return response_content.read() \n",
+    "    return response_content.read()\n",
     "\n",
     "def print_messages(messages: Iterable[MessageFile]) -> None:\n",
     "    message_list = []\n",
@@ -285,7 +370,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Cleanup"
+    "### Cleaning up"
    ]
   },
   {
@@ -294,10 +379,11 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "client.beta.assistants.delete(assistant.id)\n",
-    "client.beta.threads.delete(thread.id)\n",
-    "for file in assistant_files:\n",
-    "    client.files.delete(file.id)"
+    "if should_cleanup:\n",
+    "    client.beta.assistants.delete(assistant.id)\n",
+    "    client.beta.threads.delete(thread.id)\n",
+    "    for file in assistant_files:\n",
+    "        client.files.delete(file.id)"
    ]
   }
  ],

gen-ai/Assistants/api-in-a-box/math_tutor/README.md

@@ -7,9 +7,10 @@ Showcases the foundational concepts of Assistants such as Threads, Messages, Run
 
 ### Objective
 
-The objective of the provided Python file is to create an Azure OpenAI Assistant named "Math Tutor" using the Azure OpenAI API. The assistant is designed to function as a personal math tutor, capable of answering math questions through code interpretation. The script initiates a conversation with the assistant, guiding it through various mathematical queries and scenarios to showcase its capabilities.
+The objective of the provided notebook file is to create an Azure OpenAI Assistant named "Math Tutor" using the Azure OpenAI API. The assistant is designed to function as a personal math tutor, capable of answering math questions through code interpretation. The script initiates a conversation with the assistant, guiding it through various mathematical queries and scenarios to showcase its capabilities.
 
 ### Programming Languages
- - Python
+
+- Python
 
 ### Estimated Runtime: 5 mins