Merge pull request #137 from HeidiSteen/main

Update Quickstart-RAG notebook

Author: HeidiSteen

Quickstart-RAG/Quickstart-rag.ipynb

@@ -16,7 +16,7 @@
     "\n",
     "A non-vector index isn't ideal for RAG patterns, but it makes for a simpler example.\n",
     "\n",
-    "Once you understand the fundamentals of integrating queries from Azure AI Search to an LLM, you can build on that experience by adding vector fields and vector and hybrid queries. We recommend the [phi-chat Python code example](https://github.com/Azure/azure-search-vector-samples/blob/main/demo-python/code/phi-chat/phi-chat.ipynb) for that step.\n",
+    "Once you understand the fundamentals of integrating queries from Azure AI Search to a chat completion model on Azure OpenAI, you can build on that experience by adding vector fields and vector and hybrid queries. We recommend the [phi-chat Python code example](https://github.com/Azure/azure-search-vector-samples/blob/main/demo-python/code/phi-chat/phi-chat.ipynb) for that step.\n",
     "\n",
     "This example is fully documented in [Quickstart: Generative search (RAG) with grounding data from Azure AI Search](https://learn.microsoft.com/azure/search/search-get-started-rag). If you need more guidance than the readme provides, please refer to the article.\n"
    ]
@@ -29,7 +29,7 @@
     "\n",
     "- [Azure OpenAI](https://learn.microsoft.com/azure/ai-services/openai/how-to/create-resource)\n",
     "\n",
-    "  - Deploy a chat model (gpt-4o, gpt-4o-mini, or equivalent LLM).\n",
+    "  - Deploy a chat completion model (gpt-4o, gpt-4o-mini, or equivalent model).\n",
     "\n",
     "- [Azure AI Search](https://learn.microsoft.com/azure/search/search-create-service-portal)\n",
     "\n",
@@ -45,12 +45,9 @@
     "\n",
     "This quickstart assumes authentication and authorization using Microsoft Entra ID and role assignments. It also assumes that you run this code from your local device.\n",
     "\n",
-    "1. To create, load, and query the sample index on Azure AI Search, you must personally have role assignments for: **Search Index Data Reader**, **Search Index Data Contributor**, **Search Service Contributor**.\n",
+    "1. To create, load, and query the sample hotels index on Azure AI Search, you must personally have role assignments for **Search Index Data Contributor** and **Search Service Contributor**. If the hotels index already exists, you only need **Search Index Data Reader**.\n",
     "\n",
-    "1. To send the query and search results to Azure OpenAI, both you and the search system identity must have **Cognitive Services OpenAI User** permissions on Azure OpenAI.\n",
-    "\n",
-    "   - Queries in the system prompt are sent from your local system, which is why you need permissions on Azure OpenAI.\n",
-    "   - Results used for grounding data are sent from the search engine, which is why the search service needs permissions on Azure OpenAI.\n",
+    "1. To send the query and search results to Azure OpenAI, you must have **Cognitive Services OpenAI User** permissions on Azure OpenAI.\n",
     "\n",
     "## Create the sample index\n",
     "\n",
@@ -105,6 +102,22 @@
     "\n",
     "It takes several minutes to create the environment. When the environment is ready, continue to the next step.\n",
     "\n",
+    "## Log in to Azure\n",
+    "\n",
+    "You're using Microsoft Entra ID and role assignments for the connection. Make sure you're logged in to the same tenant and subscription as Azure AI Search and Azure OpenAI. You can use the Azure CLI on the command line to show current properties, change properties, and to log in. For more information, see [Connect without keys](https://learn.microsoft.com/azure/search/search-get-started-rbac). \n",
+    "\n",
+    "Run each of the following commands in sequence.\n",
+    "\n",
+    "```azurecli\n",
+    "az account show\n",
+    "\n",
+    "az account set --subscription <PUT YOUR SUBSCRIPTION ID HERE>\n",
+    "\n",
+    "az login --tenant <PUT YOUR TENANT ID HERE>\n",
+    "```\n",
+    "\n",
+    "You should now be logged in to Azure.\n",
+    "\n",
     "## Run the code"
    ]
   },
@@ -136,43 +149,14 @@
    "source": [
     "## Basic RAG Query\n",
     "\n",
-    "The following code demonstrates how to query fields such as strings or string collections and use them to answer a question using RAG"
+    "The following code demonstrates how to query fields such as strings or string collections in a search index, and send the results to a chat completion model. The response returned to the user is from the chat completion model."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Sure! Here are a few hotels that offer complimentary breakfast:\n",
-      "\n",
-      "- **Whitefish Lodge & Suites**:\n",
-      "  - Continental breakfast\n",
-      "  - Free parking\n",
-      "  - Free wifi\n",
-      "\n",
-      "- **Trails End Motel**:\n",
-      "  - Free hot breakfast buffet\n",
-      "  - Free wireless internet\n",
-      "\n",
-      "- **Peaceful Market Hotel & Spa**:\n",
-      "  - Continental breakfast\n",
-      "  - Restaurant\n",
-      "  - View\n",
-      "\n",
-      "- **Marquis Plaza & Suites**:\n",
-      "  - Free breakfast buffet\n",
-      "  - Free wifi\n",
-      "  - Pool\n",
-      "\n",
-      "Enjoy your stay!\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "# Set up the query for generating responses\n",
     "from azure.identity import DefaultAzureCredential\n",
@@ -218,6 +202,7 @@
     ")\n",
     "sources_formatted = \"\\n\".join([f'{document[\"HotelName\"]}:{document[\"Description\"]}:{document[\"Tags\"]}' for document in search_results])\n",
     "\n",
+    "# Send the search results to the LLM to generate a response based on the prompt.\n",
     "response = openai_client.chat.completions.create(\n",
     "    messages=[\n",
     "        {\n",
@@ -228,6 +213,7 @@
     "    model=AZURE_DEPLOYMENT_MODEL\n",
     ")\n",
     "\n",
+    "# Here is the response from the chat model.\n",
     "print(response.choices[0].message.content)"
    ]
   },
@@ -241,9 +227,9 @@
     "\n",
     "+ Make sure you [enabled RBAC](https://learn.microsoft.com/azure/search/search-security-enable-roles?tabs=config-svc-portal%2Cdisable-keys-portal) on Azure AI Search. An HttpStatusMessage of **Forbidden** is an indicator that RBAC isn't enabled.\n",
     "\n",
-    "+ Recheck role assignments for yourself and for the search service system identity.\n",
+    "+ Recheck role assignments if you get a 401 error. You should also review the steps in [Connect without keys](https://learn.microsoft.com/azure/search/search-get-started-rbac).\n",
     "\n",
-    "+ Check firewall settings. This quickstart assumes public network access. If you have a firewall, you need to add rules to allow inbound requests from your device and for service-to-service connections.\n",
+    "+ Check firewall settings. This quickstart assumes public network access. If you have a firewall, you need to add rules to allow inbound requests from your device and for service-to-service connections. For more information, see [Configure network access](https://learn.microsoft.com/azure/search/service-configure-firewall).\n",
     "\n",
     "+ For more debugging guidance, see the [troubleshooting section](https://learn.microsoft.com/azure/search/search-get-started-rag#troubleshooting-errors) in the Quickstart documentation."
    ]
@@ -259,64 +245,9 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Sure! Here are a few hotels that offer complimentary breakfast:\n",
-      "\n",
-      "1. **Trails End Motel**\n",
-      "   - **Description**: Only 8 miles from Downtown. On-site bar/restaurant, Free hot breakfast buffet, Free wireless internet, All non-smoking hotel. Only 15 miles from the airport.\n",
-      "   - **Address**: 7014 E Camelback Rd, Scottsdale, AZ 85251, USA\n",
-      "   - **Tags**: Continental breakfast, view\n",
-      "   - **Room Recommendation**: \n",
-      "     - **Type**: Suite, 2 Queen Beds (City View)\n",
-      "     - **Rate**: $266.99 per night\n",
-      "     - **Sleeps**: 4\n",
-      "\n",
-      "2. **Whitefish Lodge & Suites**\n",
-      "   - **Description**: Located in the heart of the forest. Enjoy Warm Weather, Beach Club Services, Natural Hot Springs, Airport Shuttle.\n",
-      "   - **Address**: 3000 E 1st Ave, Denver, CO 80206, USA\n",
-      "   - **Tags**: Continental breakfast, free parking, free wifi\n",
-      "   - **Room Recommendation**: \n",
-      "     - **Type**: Suite, 2 Queen Beds (Mountain View)\n",
-      "     - **Rate**: $256.99 per night\n",
-      "     - **Sleeps**: 4\n",
-      "\n",
-      "3. **Peaceful Market Hotel & Spa**\n",
-      "   - **Description**: Book now and Save up to 30%. Central location. Steps from Empire State Building & Times Square, in Chelsea neighborhood. Brand new rooms. Impeccable service.\n",
-      "   - **Address**: 11 Times Sq, New York, NY 10036, USA\n",
-      "   - **Tags**: Continental breakfast, restaurant, view\n",
-      "   - **Room Recommendation**: \n",
-      "     - **Type**: Suite, 2 Queen Beds (Waterfront View)\n",
-      "     - **Rate**: $260.99 per night\n",
-      "     - **Sleeps**: 4\n",
-      "\n",
-      "4. **Nova Hotel & Spa**\n",
-      "   - **Description**: 1 Mile from the airport. Free WiFi, Outdoor Pool, Complimentary Airport Shuttle, 6 miles from the beach & 10 miles from downtown.\n",
-      "   - **Address**: 4400 Ashford Dunwoody Rd NE, Atlanta, GA 30346, USA\n",
-      "   - **Tags**: Pool, continental breakfast, free parking\n",
-      "   - **Room Recommendation**: \n",
-      "     - **Type**: Deluxe Room, 2 Queen Beds (City View)\n",
-      "     - **Rate**: $161.99 per night\n",
-      "     - **Sleeps**: 4\n",
-      "\n",
-      "5. **Scottish Inn**\n",
-      "   - **Description**: Newly Redesigned Rooms & airport shuttle. Minutes from the airport, enjoy lakeside amenities, a resort-style pool & stylish new guestrooms with Internet TVs.\n",
-      "   - **Address**: 3301 Veterans Memorial Blvd, Metairie, LA 70002, USA\n",
-      "   - **Tags**: 24-hour front desk service, continental breakfast, free wifi\n",
-      "   - **Room Recommendation**: \n",
-      "     - **Type**: Deluxe Room, 2 Queen Beds (City View)\n",
-      "     - **Rate**: $140.99 per night\n",
-      "     - **Sleeps**: 4\n",
-      "\n",
-      "I hope you find these recommendations helpful! Enjoy your stay!\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "import json\n",
     "\n",
@@ -351,7 +282,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": ".venv",
+   "display_name": "Python 3",
    "language": "python",
    "name": "python3"
   },
@@ -365,7 +296,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.9"
+   "version": "3.10.11"
   }
  },
  "nbformat": 4,