Merge pull request #79 from HeidiSteen/main

Tested quickstart notebook

Author: HeidiSteen

Quickstart/v11/README.md

@@ -28,12 +28,15 @@ This sample is a Jupyter Python3 .ipynb file to perform the actions against the
 ## Set up the sample
 
 1. Clone or download this sample repository.
-2. Extract contents if the download is a zip file. Make sure the files are read-write.
+
+1. Extract contents if the download is a zip file. Make sure the files are read-write.
 
 ## Run the sample
 
 1. Open the azure-search-quickstart.ipynb file in Visual Studio Code.
 
+1. Open an integrated terminal and run `pip install azure-search-documents`.
+
 1. Set the service endpoint and API key for your search service:
 
    * service_name = "YOUR-SEARCH-SERVICE-NAME"

Quickstart/v11/azure-search-quickstart.ipynb

@@ -1,19 +1,19 @@
 {
  "cells": [
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Create a search index using the Azure Cognitive Search Python SDK"
+    "# Create a search index in Azure Cognitive Search using the Azure SDK for Python"
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "This sample uses Jupyter Notebook to demonstrate index creation, data ingestion, and queries of an Azure Cognitive Search index by calling the azure-search-documents library in the Azure SDK for Python. This notebook is a companion document to this [Python quickstart](https://docs.microsoft.com/azure/search/search-get-started-python). \n",
-    "\n",
-    "To get started, load the libraries from the SDK. If you don't already have the SDK, uncomment the first install command and run that first."
+    "This Jupyter Notebook steps through creating, loading, and querying an index in Azure Cognitive Search index by calling the azure-search-documents library in the Azure SDK for Python. "
    ]
   },
   {
@@ -22,10 +22,10 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# If you have not already installed the Python SDK, execute:\n",
+    "# Uncomment the next line if you need to install the azure-search-documents client library:\n",
     "# !pip install azure-search-documents --pre\n",
     "\n",
-    "# This sample uses version: 11.1.0b3\n",
+    "# This sample uses version: 11.1.0\n",
     "!pip show azure-search-documents\n",
     "\n",
     "import os\n",
@@ -44,10 +44,11 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "In the first cell, initialize the administrative and search query clients used to make each request. Replace the search service_name, admin_key and query_key with valid values. If you get ConnectionError \"Failed to establish a new connection\", verify that the api-key is a primary or secondary admin key, and not a query key."
+    "In this step, initialize the search client used to make each request. Provide the name and admin API key of your search service. If you get ConnectionError \"Failed to establish a new connection\", verify that the api-key is a primary or secondary admin key, and not a query key."
    ]
   },
   {
@@ -58,7 +59,7 @@
    "source": [
     "# Set the service endpoint and API key from the environment\n",
     "\n",
-    "service_name = \"YOUR-SEARCH-SERIVCE-NAME\"\n",
+    "service_name = \"YOUR-SEARCH-SERVICE-NAME\"\n",
     "admin_key = \"YOUR-SEARCH-SERVICE-ADMIN-API-KEY\"\n",
     "\n",
     "index_name = \"hotels-quickstart\"\n",
@@ -342,7 +343,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "In the next query, add search_fields (an array) to scope query matching to a single field. "
+    "In the next query, add search_fields to scope query matching to a single field. If you're using a newer version of the client library, search_fields is an array. Add brackets around 'HotelName' if you get an error."
    ]
   },
   {
@@ -351,7 +352,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "results =  search_client.search(search_text=\"sublime\", search_fields=['HotelName'], select='HotelId,HotelName')\n",
+    "results =  search_client.search(search_text=\"sublime\", search_fields='HotelName', select='HotelId,HotelName')\n",
     "\n",
     "for result in results:\n",
     "    print(\"{}: {}\".format(result[\"HotelId\"], result[\"HotelName\"]))"
@@ -479,7 +480,12 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.3"
+   "version": "3.9.5"
+  },
+  "vscode": {
+   "interpreter": {
+    "hash": "9ff083f0c83558f9261023d47a77b9b3eb892c62cdbe066d046abcad1a5edb5c"
+   }
   }
  },
  "nbformat": 4,