Update quickstarts to use approved hotels dataset

Author: HeidiSteen

Quickstart-Semantic-Search/semantic-search-quickstart.ipynb

@@ -25,11 +25,11 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 2,
    "metadata": {},
    "outputs": [],
    "source": [
-    "! pip install azure-search-documents==11.6.0b1 --quiet\n",
+    "! pip install azure-search-documents==11.6.0b12 --quiet\n",
     "! pip install azure-identity --quiet\n",
     "! pip install python-dotenv --quiet"
    ]
@@ -56,9 +56,17 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 6,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      " hotels-quickstart-py created\n"
+     ]
+    }
+   ],
    "source": [
     "from azure.core.credentials import AzureKeyCredential\n",
     "\n",
@@ -85,7 +93,6 @@
     "        SimpleField(name=\"HotelId\", type=SearchFieldDataType.String, key=True),\n",
     "        SearchableField(name=\"HotelName\", type=SearchFieldDataType.String, sortable=True),\n",
     "        SearchableField(name=\"Description\", type=SearchFieldDataType.String, analyzer_name=\"en.lucene\"),\n",
-    "        SearchableField(name=\"Description_fr\", type=SearchFieldDataType.String, analyzer_name=\"fr.lucene\"),\n",
     "        SearchableField(name=\"Category\", type=SearchFieldDataType.String, facetable=True, filterable=True, sortable=True),\n",
     "\n",
     "        SearchableField(name=\"Tags\", collection=True, type=SearchFieldDataType.String, facetable=True, filterable=True),\n",
@@ -104,7 +111,7 @@
     "    ]\n",
     "\n",
     "semantic_config = SemanticConfiguration(\n",
-    "    name=\"my-semantic-config\",\n",
+    "    name=\"semantic-config\",\n",
     "    prioritized_fields=SemanticPrioritizedFields(\n",
     "        title_field=SemanticField(field_name=\"HotelName\"),\n",
     "        keywords_fields=[SemanticField(field_name=\"Category\")],\n",
@@ -135,7 +142,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 7,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -144,13 +151,12 @@
     "    {\n",
     "    \"@search.action\": \"upload\",\n",
     "    \"HotelId\": \"1\",\n",
-    "    \"HotelName\": \"Secret Point Motel\",\n",
-    "    \"Description\": \"The hotel is ideally located on the main commercial artery of the city in the heart of New York. A few minutes away is Time's Square and the historic centre of the city, as well as other places of interest that make New York one of America's most attractive and cosmopolitan cities.\",\n",
-    "    \"Description_fr\": \"L'hôtel est idéalement situé sur la principale artère commerciale de la ville en plein cœur de New York. A quelques minutes se trouve la place du temps et le centre historique de la ville, ainsi que d'autres lieux d'intérêt qui font de New York l'une des villes les plus attractives et cosmopolites de l'Amérique.\",\n",
+    "    \"HotelName\": \"Stay-Kay City Hotel\",\n",
+    "    \"Description\": \"This classic hotel is fully-refurbished and ideally located on the main commercial artery of the city in the heart of New York. A few minutes away is Times Square and the historic centre of the city, as well as other places of interest that make New York one of America's most attractive and cosmopolitan cities.\",\n",
     "    \"Category\": \"Boutique\",\n",
-    "    \"Tags\": [ \"pool\", \"air conditioning\", \"concierge\" ],\n",
+    "    \"Tags\": [ \"view\", \"air conditioning\", \"concierge\" ],\n",
     "    \"ParkingIncluded\": \"false\",\n",
-    "    \"LastRenovationDate\": \"1970-01-18T00:00:00Z\",\n",
+    "    \"LastRenovationDate\": \"2020-01-18T00:00:00Z\",\n",
     "    \"Rating\": 3.60,\n",
     "    \"Address\": {\n",
     "        \"StreetAddress\": \"677 5th Ave\",\n",
@@ -163,13 +169,12 @@
     "    {\n",
     "    \"@search.action\": \"upload\",\n",
     "    \"HotelId\": \"2\",\n",
-    "    \"HotelName\": \"Twin Dome Motel\",\n",
-    "    \"Description\": \"The hotel is situated in a  nineteenth century plaza, which has been expanded and renovated to the highest architectural standards to create a modern, functional and first-class hotel in which art and unique historical elements coexist with the most modern comforts.\",\n",
-    "    \"Description_fr\": \"L'hôtel est situé dans une place du XIXe siècle, qui a été agrandie et rénovée aux plus hautes normes architecturales pour créer un hôtel moderne, fonctionnel et de première classe dans lequel l'art et les éléments historiques uniques coexistent avec le confort le plus moderne.\",\n",
+    "    \"HotelName\": \"Old Century Hotel\",\n",
+    "    \"Description\": \"The hotel is situated in a nineteenth century plaza, which has been expanded and renovated to the highest architectural standards to create a modern, functional and first-class hotel in which art and unique historical elements coexist with the most modern comforts. The hotel also regularly hosts events like wine tastings, beer dinners, and live music.\",\n",
     "    \"Category\": \"Boutique\",\n",
     "    \"Tags\": [ \"pool\", \"free wifi\", \"concierge\" ],\n",
     "    \"ParkingIncluded\": \"false\",\n",
-    "    \"LastRenovationDate\": \"1979-02-18T00:00:00Z\",\n",
+    "    \"LastRenovationDate\": \"2019-02-18T00:00:00Z\",\n",
     "    \"Rating\": 3.60,\n",
     "    \"Address\": {\n",
     "        \"StreetAddress\": \"140 University Town Center Dr\",\n",
@@ -182,11 +187,10 @@
     "    {\n",
     "    \"@search.action\": \"upload\",\n",
     "    \"HotelId\": \"3\",\n",
-    "    \"HotelName\": \"Triple Landscape Hotel\",\n",
-    "    \"Description\": \"The Hotel stands out for its gastronomic excellence under the management of William Dough, who advises on and oversees all of the Hotel's restaurant services.\",\n",
-    "    \"Description_fr\": \"L'hôtel est situé dans une place du XIXe siècle, qui a été agrandie et rénovée aux plus hautes normes architecturales pour créer un hôtel moderne, fonctionnel et de première classe dans lequel l'art et les éléments historiques uniques coexistent avec le confort le plus moderne.\",\n",
-    "    \"Category\": \"Resort and Spa\",\n",
-    "    \"Tags\": [ \"air conditioning\", \"bar\", \"continental breakfast\" ],\n",
+    "    \"HotelName\": \"Gastronomic Landscape Hotel\",\n",
+    "    \"Description\": \"The Gastronomic Hotel stands out for its culinary excellence under the management of William Dough, who advises on and oversees all of the Hotel’s restaurant services.\",\n",
+    "    \"Category\": \"Suite\",\n",
+    "    \"Tags\": [ \"restaurant\", \"bar\", \"continental breakfast\" ],\n",
     "    \"ParkingIncluded\": \"true\",\n",
     "    \"LastRenovationDate\": \"2015-09-20T00:00:00Z\",\n",
     "    \"Rating\": 4.80,\n",
@@ -201,13 +205,12 @@
     "    {\n",
     "    \"@search.action\": \"upload\",\n",
     "    \"HotelId\": \"4\",\n",
-    "    \"HotelName\": \"Sublime Cliff Hotel\",\n",
-    "    \"Description\": \"Sublime Cliff Hotel is located in the heart of the historic center of Sublime in an extremely vibrant and lively area within short walking distance to the sites and landmarks of the city and is surrounded by the extraordinary beauty of churches, buildings, shops and monuments. Sublime Cliff is part of a lovingly restored 1800 palace.\",\n",
-    "    \"Description_fr\": \"Le sublime Cliff Hotel est situé au coeur du centre historique de sublime dans un quartier extrêmement animé et vivant, à courte distance de marche des sites et monuments de la ville et est entouré par l'extraordinaire beauté des églises, des bâtiments, des commerces et Monuments. Sublime Cliff fait partie d'un Palace 1800 restauré avec amour.\",\n",
+    "    \"HotelName\": \"Sublime Palace Hotel\",\n",
+    "    \"Description\": \"Sublime Palace Hotel is located in the heart of the historic center of Sublime in an extremely vibrant and lively area within short walking distance to the sites and landmarks of the city and is surrounded by the extraordinary beauty of churches, buildings, shops and monuments. Sublime Cliff is part of a lovingly restored 19th century resort, updated for every modern convenience.\",\n",
     "    \"Category\": \"Boutique\",\n",
-    "    \"Tags\": [ \"concierge\", \"view\", \"24-hour front desk service\" ],\n",
+    "    \"Tags\": [ \"concierge\", \"view\", \"air conditioning\" ],\n",
     "    \"ParkingIncluded\": \"true\",\n",
-    "    \"LastRenovationDate\": \"1960-02-06T00:00:00Z\",\n",
+    "    \"LastRenovationDate\": \"2020-02-06T00:00:00Z\",\n",
     "    \"Rating\": 4.60,\n",
     "    \"Address\": {\n",
     "        \"StreetAddress\": \"7400 San Pedro Ave\",\n",
@@ -230,9 +233,17 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 8,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Upload of new document succeeded: True\n"
+     ]
+    }
+   ],
    "source": [
     "# Upload documents to the index\n",
     "search_client = SearchClient(endpoint=search_endpoint,\n",
@@ -259,9 +270,29 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 9,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Total Documents Matching Query: 4\n",
+      "1.0\n",
+      "Gastronomic Landscape Hotel\n",
+      "Description: The Gastronomic Hotel stands out for its culinary excellence under the management of William Dough, who advises on and oversees all of the Hotel’s restaurant services.\n",
+      "1.0\n",
+      "Old Century Hotel\n",
+      "Description: The hotel is situated in a nineteenth century plaza, which has been expanded and renovated to the highest architectural standards to create a modern, functional and first-class hotel in which art and unique historical elements coexist with the most modern comforts. The hotel also regularly hosts events like wine tastings, beer dinners, and live music.\n",
+      "1.0\n",
+      "Sublime Palace Hotel\n",
+      "Description: Sublime Palace Hotel is located in the heart of the historic center of Sublime in an extremely vibrant and lively area within short walking distance to the sites and landmarks of the city and is surrounded by the extraordinary beauty of churches, buildings, shops and monuments. Sublime Cliff is part of a lovingly restored 19th century resort, updated for every modern convenience.\n",
+      "1.0\n",
+      "Stay-Kay City Hotel\n",
+      "Description: This classic hotel is fully-refurbished and ideally located on the main commercial artery of the city in the heart of New York. A few minutes away is Times Square and the historic centre of the city, as well as other places of interest that make New York one of America's most attractive and cosmopolitan cities.\n"
+     ]
+    }
+   ],
    "source": [
     "# Run an empty query (returns selected fields, all documents)\n",
     "results =  search_client.search(query_type='simple',\n",
@@ -281,18 +312,33 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Run a term query"
+    "## Run a term query\n",
+    "\n",
+    "Other hotels in this small data set have a stronger signal for restaurant, but because \"site\" is a less frequent term, BM25 scores it higher."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 14,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "0.6791836\n",
+      "Sublime Palace Hotel\n",
+      "Description: Sublime Palace Hotel is located in the heart of the historic center of Sublime in an extremely vibrant and lively area within short walking distance to the sites and landmarks of the city and is surrounded by the extraordinary beauty of churches, buildings, shops and monuments. Sublime Cliff is part of a lovingly restored 19th century resort, updated for every modern convenience.\n",
+      "0.5575875\n",
+      "Gastronomic Landscape Hotel\n",
+      "Description: The Gastronomic Hotel stands out for its culinary excellence under the management of William Dough, who advises on and oversees all of the Hotel’s restaurant services.\n"
+     ]
+    }
+   ],
    "source": [
     "# Run a text query (returns a BM25-scored result set)\n",
     "results =  search_client.search(query_type='simple',\n",
-    "    search_text=\"what hotel has a good restaurant on site\" ,\n",
+    "    search_text=\"restaurant on site\" ,\n",
     "    select='HotelName,HotelId,Description',\n",
     "    include_total_count=True)\n",
     "    \n",
@@ -307,18 +353,37 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Run a semantic query"
+    "## Run a semantic query\n",
+    "\n",
+    "In contrast, the L2 ranker revisits the query and uses machine reading comprehension to promote results that are more meaningful to the query."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 16,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "2.132748603820801\n",
+      "Gastronomic Landscape Hotel\n",
+      "Description: The Gastronomic Hotel stands out for its culinary excellence under the management of William Dough, who advises on and oversees all of the Hotel’s restaurant services.\n",
+      "Caption: The Gastronomic Hotel stands out for its culinary excellence under the management of William Dough, who advises on and oversees all of the Hotel’s<em> restaurant services.</em>\n",
+      "\n",
+      "1.6575827598571777\n",
+      "Sublime Palace Hotel\n",
+      "Description: Sublime Palace Hotel is located in the heart of the historic center of Sublime in an extremely vibrant and lively area within short walking distance to the sites and landmarks of the city and is surrounded by the extraordinary beauty of churches, buildings, shops and monuments. Sublime Cliff is part of a lovingly restored 19th century resort, updated for every modern convenience.\n",
+      "Caption: Sublime Palace<em> Hotel </em>is located in the heart of the historic center of<em> Sublime </em>in an extremely vibrant and lively area within short walking distance to the sites and landmarks of the city and is surrounded by the extraordinary beauty of churches, buildings, shops and monuments. <em>Sublime Cliff </em>is part of a lovingly restored 19th century<em> resort,.</em>\n",
+      "\n"
+     ]
+    }
+   ],
    "source": [
     "# Runs a semantic query (runs a BM25-ranked query and promotes the most relevant matches to the top)\n",
-    "results =  search_client.search(query_type='semantic', semantic_configuration_name='my-semantic-config',\n",
-    "    search_text=\"what hotel has a good restaurant on site\", \n",
+    "results =  search_client.search(query_type='semantic', semantic_configuration_name='semantic-config',\n",
+    "    search_text=\"restaurant on site\", \n",
     "    select='HotelName,Description,Category', query_caption='extractive')\n",
     "\n",
     "for result in results:\n",
@@ -344,12 +409,42 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 18,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Semantic Answer: The hotel is situated in<em> a nineteenth century plaza, </em>which has been expanded and renovated to the highest architectural standards to create a modern, functional and first-class hotel in which art and unique historical elements coexist with the most modern comforts. The hotel also regularly hosts events like wine tastings, beer dinners, and live ...\n",
+      "Semantic Answer Score: 0.968999981880188\n",
+      "\n",
+      "2.4739253520965576\n",
+      "Sublime Palace Hotel\n",
+      "Description: Sublime Palace Hotel is located in the heart of the historic center of Sublime in an extremely vibrant and lively area within short walking distance to the sites and landmarks of the city and is surrounded by the extraordinary beauty of churches, buildings, shops and monuments. Sublime Cliff is part of a lovingly restored 19th century resort, updated for every modern convenience.\n",
+      "Caption: <em>Sublime Palace Hotel </em>is located in the heart of the historic center of Sublime in an extremely vibrant and lively area within short walking distance to the sites and landmarks of the city and is surrounded by the extraordinary beauty of churches, buildings, shops and monuments. Sublime Cliff is part of a lovingly restored 19th century resort,.\n",
+      "\n",
+      "2.4739253520965576\n",
+      "Old Century Hotel\n",
+      "Description: The hotel is situated in a nineteenth century plaza, which has been expanded and renovated to the highest architectural standards to create a modern, functional and first-class hotel in which art and unique historical elements coexist with the most modern comforts. The hotel also regularly hosts events like wine tastings, beer dinners, and live music.\n",
+      "Caption: The hotel is situated in<em> a nineteenth century plaza, </em>which has been expanded and renovated to the highest architectural standards to create a modern, functional and first-class hotel in which art and unique historical elements coexist with the most modern comforts. The hotel also regularly hosts events like wine tastings, beer dinners, and live.\n",
+      "\n",
+      "2.3384294509887695\n",
+      "Stay-Kay City Hotel\n",
+      "Description: This classic hotel is fully-refurbished and ideally located on the main commercial artery of the city in the heart of New York. A few minutes away is Times Square and the historic centre of the city, as well as other places of interest that make New York one of America's most attractive and cosmopolitan cities.\n",
+      "Caption: This classic hotel is fully-refurbished and ideally located on the main commercial artery of the city in the heart of New York. A few minutes away is Times Square and the historic centre of the city, as well as other places of interest that make New York one of America's most attractive and cosmopolitan cities.\n",
+      "\n",
+      "1.7504537105560303\n",
+      "Gastronomic Landscape Hotel\n",
+      "Description: The Gastronomic Hotel stands out for its culinary excellence under the management of William Dough, who advises on and oversees all of the Hotel’s restaurant services.\n",
+      "Caption: The<em> Gastronomic </em>Hotel stands out for its culinary excellence under the management of William Dough, who advises on and oversees all of the Hotel’s restaurant services.\n",
+      "\n"
+     ]
+    }
+   ],
    "source": [
     "# Run a semantic query that returns semantic answers  \n",
-    "results =  search_client.search(query_type='semantic', semantic_configuration_name='my-semantic-config',\n",
+    "results =  search_client.search(query_type='semantic', semantic_configuration_name='semantic-config',\n",
     " search_text=\"what hotel is in a historic building\",\n",
     " select='HotelName,Description,Category', query_caption='extractive', query_answer=\"extractive\",)\n",
     "\n",
@@ -428,7 +523,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": ".venv",
    "language": "python",
    "name": "python3"
   },
@@ -442,12 +537,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.3"
-  },
-  "vscode": {
-   "interpreter": {
-    "hash": "9ff083f0c83558f9261023d47a77b9b3eb892c62cdbe066d046abcad1a5edb5c"
-   }
+   "version": "3.11.9"
   }
  },
  "nbformat": 4,

Quickstart/README.md

@@ -44,4 +44,4 @@ This sample is a Jupyter Python3 .ipynb file to perform the actions against the
 
 ## Next steps
 
-You can learn more about Azure AI Search on the [official documentation site](https://docs.microsoft.com/azure/search).
+You can learn more about Azure AI Search on the [official documentation site](https://learn.microsoft.com/azure/search).