Merge pull request #117 from HeidiSteen/main

Revised set up steps

Author: HeidiSteen

Quickstart-RAG/Quickstart-rag.ipynb

@@ -6,17 +6,17 @@
    "source": [
     "# RAG Quickstart for Azure AI Search\n",
     "\n",
-    "This quickstart provides a query for RAG scenarios. It demonstrates an approach for grounding chat queries with data in a search index on Azure AI Search.\n",
+    "This quickstart provides a query for RAG scenarios. It demonstrates an approach for a chat experience using grounding data from a search index on Azure AI Search.\n",
     "\n",
     "We took a few shortcuts to keep the exercise basic and focused on query definitions:\n",
     "\n",
     "- We use the hotels-sample-index, which can be created in minutes and runs on any search service tier. This index is created by a wizard using built-in sample data.\n",
     "\n",
-    "- We omit vectors so that we can skip chunking and embedding.\n",
+    "- We omit vectors so that we can skip chunking and embedding. The index contains plain text.\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",
     "\n",
-    "This quickstart is 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"
+    "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"
    ]
   },
   {
@@ -27,7 +27,6 @@
     "\n",
     "- [Azure OpenAI](https://learn.microsoft.com/azure/ai-services/openai/how-to/create-resource)\n",
     "\n",
-    "  - Configure Azure OpenAI to use a system managed identity.\n",
     "  - Deploy a chat model (GPT-3.5-Turbo, GPT-4, or equivalent LLM).\n",
     "\n",
     "- [Azure AI Search](https://learn.microsoft.com/azure/search/search-create-service-portal)\n",
@@ -36,14 +35,20 @@
     "  - Choose the same region as Azure OpenAI.\n",
     "  - Enable semantic ranking.\n",
     "  - Enable role-based access control.\n",
+    "  - Enable a system identity for Azure AI Search.\n",
+    "  \n",
+    "Make sure you know the name of the deployed model, and have the endpoints for both Azure resources at hand. You will provide this information in the steps that follow.\n",
     "\n",
     "## Configure access\n",
     "\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 and load the sample index on Azure AI Search, you must have role assignments for: **Search Index Data Reader**, **Search Index Data Contributor**, **Search Service Contributor**.\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",
+    "\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",
-    "1. To send the query and results from the search engine to Azure OpenAI, the search system identity must have **Cognitive Services OpenAI User** permissions on Azure OpenAI.\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",
     "\n",
     "## Create the sample index\n",
     "\n",
@@ -85,7 +90,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 20,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -95,19 +100,19 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 22,
    "metadata": {},
    "outputs": [],
    "source": [
     "# Set endpoints and deployment model (provide the name of the deployment)\n",
-    " AZURE_SEARCH_SERVICE: str = \"PUT YOUR SEARCH SERVICE ENDPOINT HERE\"\n",
-    " AZURE_OPENAI_ACCOUNT: str = \"PUT YOUR AZURE OPENAI ENDPOINT HERE\"\n",
-    " AZURE_DEPLOYMENT_MODEL: str = \"gpt-35-turbo\""
+    "AZURE_SEARCH_SERVICE: str = \"PUT YOUR SEARCH SERVICE ENDPOINT HERE\"\n",
+    "AZURE_OPENAI_ACCOUNT: str = \"PUT YOUR AZURE OPENAI ENDPOINT HERE\"\n",
+    "AZURE_DEPLOYMENT_MODEL: str = \"gpt-35-turbo\""
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 23,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -119,7 +124,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 16,
+   "execution_count": 24,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -212,18 +217,18 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 19,
+   "execution_count": 28,
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Based on your preferences, I recommend the following hotels: \n",
+      "Based on your preferences, I recommend the following hotels:\n",
       "\n",
-      "- Ocean Air Motel: This hotel is oceanfront with beach access, two pools, and a private balcony with ocean views. \n",
-      "- Marquis Plaza & Suites: This hotel has a view of the ocean and amenities like free Wi-Fi, a full kitchen, and a free breakfast buffet. \n",
-      "- Trails End Motel: Though not directly on the ocean, this hotel does have a view and is only 8 miles from downtown. Amenities include an on-site bar/restaurant, free hot breakfast buffet, and free Wi-Fi.\n"
+      "- Ocean Air Motel: This oceanfront hotel overlooks the beach and features rooms with private balconies, 2 indoor and outdoor pools, and it's located steps away from various shops and entertainment on the boardwalk.\n",
+      "- Marquis Plaza & Suites: Offering views of the ocean and amenities like free Wi-Fi, a full kitchen, and a free breakfast buffet, this hotel is a great option for those who want to spend a day at the aquarium and then come home to relax.\n",
+      "- Trails End Motel: Although not directly on the ocean, this non-smoking hotel offers great views, an on-site bar/restaurant, a hot breakfast buffet, and free wireless internet. Only 8 miles from downtown and 15 miles from the airport, it's a convenient choice.\n"
      ]
     }
    ],