Merge pull request #216905 from diberry/diberry/1102-search-py

Cog Search - search website - PY

Author: v-regandowner

articles/search/tutorial-python-create-load-index.md

@@ -7,16 +7,17 @@ author: diberry
 ms.author: diberry
 ms.service: cognitive-search
 ms.topic: tutorial
-ms.date: 11/17/2021
+ms.date: 11/02/2022
 ms.custom: devx-track-python
 ms.devlang: python
 ---
 
 # 2 - Create and load Search Index with Python
 
 Continue to build your Search-enabled website by:
-* Creating a Search resource with the VS Code extension
-* Creating a new index and importing data with Python using the sample script and Azure SDK [azure-search-documents](https://pypi.org/project/azure-search-documents/).
+* Create a Search resource with the VS Code extension
+* Create a new index
+* Import data with Python using the [sample script](https://github.com/Azure-Samples/azure-search-python-samples/blob/main/search-website-functions-v4/bulk-upload/bulk-upload.py) and Azure SDK [azure-search-documents](https://pypi.org/project/azure-search-documents/).
 
 ## Create an Azure Cognitive Search resource 
 
@@ -26,7 +27,7 @@ Create a new Search resource with the [Azure Cognitive Search](https://marketpla
 
 1. In the Side bar, **right-click on your Azure subscription** under the `Azure: Cognitive Search` area and select **Create new search service**.
 
-    :::image type="content" source="./media/tutorial-javascript-create-load-index/visual-studio-code-create-search-resource.png" alt-text="In the Side bar, right-click on your Azure subscription under the **Azure: Cognitive Search** area and select **Create new search service**.":::
+    :::image type="content" source="./media/tutorial-javascript-create-load-index/visual-studio-code-create-search-resource.png" alt-text="Screenshot of Visual Studio Code showing the Azure explorer, right-click on your Azure subscription under the Azure: Cognitive Search area and select Create new search service.":::
 
 1. Follow the prompts to provide the following information:
 
@@ -45,9 +46,9 @@ Get your Search resource admin key with the Visual Studio Code extension.
 
 1. In Visual Studio Code, in the Side bar, right-click on your Search resource and select **Copy Admin Key**.
 
-    :::image type="content" source="./media/tutorial-javascript-create-load-index/visual-studio-code-copy-admin-key.png" alt-text="In the Side bar, right-click on your Search resource and select **Copy Admin Key**.":::
+    :::image type="content" source="./media/tutorial-javascript-create-load-index/visual-studio-code-copy-admin-key.png" alt-text="Screenshot of Visual Studio Code showing the Azure explorer, right-click on your Search resource and select Copy Admin Key.":::
 
-1. Keep this admin key, you will need to use it to create objects in [a later section](#prepare-the-bulk-import-script-for-search). 
+1. Keep this admin key, you'll need to use it to create objects in [a later section](#prepare-the-bulk-import-script-for-search). 
 
 ## Prepare the bulk import script for Search
 
@@ -56,14 +57,14 @@ The script uses the Azure SDK for Cognitive Search:
 * [PYPI package azure-search-documents](https://pypi.org/project/azure-search-documents/)
 * [Reference Documentation](/python/api/azure-search-documents)
 
-1. In Visual Studio Code, open the `bulk_upload.py` file in the subdirectory,  `search-website/bulk-upload`, replace the following variables with your own values to authenticate with the Azure Search SDK:
+1. In Visual Studio Code, open the `bulk_upload.py` file in the subdirectory,  `search-website-functions-v4/bulk-upload`, replace the following variables with your own values to authenticate with the Azure Search SDK:
 
     * YOUR-SEARCH-SERVICE-NAME
     * YOUR-SEARCH-SERVICE-ADMIN-API-KEY
 
-    :::code language="python" source="~/azure-search-python-samples/search-website/bulk-upload/bulk-upload.py" highlight="20,21,69,83,135" :::
+    :::code language="python" source="~/azure-search-python-samples/search-website-functions-v4/bulk-upload/bulk-upload.py" highlight="20-22,46-48,53-54,75-80,83,69,83,135,142" :::
 
-1. Open an integrated terminal in Visual Studio for the project directory's subdirectory, `search-website/bulk-upload`, and run the following command to install the dependencies. 
+1. Open an integrated terminal in Visual Studio for the project directory's subdirectory, `search-website-functions-v4/bulk-upload`, and run the following command to install the dependencies. 
 
     # [macOS/Linux](#tab/linux-install)
 
@@ -79,7 +80,7 @@ The script uses the Azure SDK for Cognitive Search:
 
 ## Run the bulk import script for Search
 
-1. Continue using the integrated terminal in Visual Studio for the project directory's subdirectory, `search-website/bulk-upload`, to run the following bash command to run the `bulk_upload.py` script:
+1. Continue using the integrated terminal in Visual Studio for the project directory's subdirectory, `search-website-functions-v4/bulk-upload`, to run the following bash command to run the `bulk_upload.py` script:
 
     # [macOS/Linux](#tab/linux-run)
     
@@ -95,26 +96,19 @@ The script uses the Azure SDK for Cognitive Search:
 
 
 1. As the code runs, the console displays progress. 
-1. When the upload is complete, the last statement printed to the console is "Done. Press any key to close the terminal.".
+1. When the upload is complete, the last statement printed to the console is "Done! Upload complete".
 
 ## Review the new Search Index
 
-Once the upload completes, the search index is ready to use. Review your new index.
+[!INCLUDE [tutorial-load-index-review-index](includes/tutorial-add-search-website-load-index-review.md)]
 
-1. In Visual Studio Code, open the Azure Cognitive Search extension and select your Search resource.  
+## Rollback bulk import file changes
 
-    :::image type="content" source="media/tutorial-javascript-create-load-index/visual-studio-code-search-extension-view-resource.png" alt-text="In Visual Studio Code, open the Azure Cognitive Search extension and open your Search resource.":::
-
-1. Expand Indexes, then Documents, then `good-books`, then select a doc to see all the document-specific data.
- 
-    :::image type="content" source="media/tutorial-javascript-create-load-index/visual-studio-code-search-extension-view-docs.png" lightbox="media/tutorial-javascript-create-load-index/visual-studio-code-search-extension-view-docs.png" alt-text="Expand Indexes, then `good-books`, then select a doc.":::
+[!INCLUDE [tutorial-load-index-rollback](includes/tutorial-add-search-website-load-index-rollback-changes.md)]
 
 ## Copy your Search resource name
 
-Note your **Search resource name**. You will need this to connect the Azure Function app to your Search resource. 
-
-> [!CAUTION]
-> While you may be tempted to use your Search admin key in the Azure Function, that isn't following the principle of least privilege. The Azure Function will use the query key to conform to least privilege. 
+[!INCLUDE [tutorial-load-index-copy](includes/tutorial-add-search-website-load-index-copy-resource-name.md)]
 
 ## Next steps
 

articles/search/tutorial-python-deploy-static-web-app.md

@@ -7,110 +7,14 @@ author: diberry
 ms.author: diberry
 ms.service: cognitive-search
 ms.topic: tutorial
-ms.date: 08/30/2022
+ms.date: 11/02/2022
 ms.custom: devx-track-python
 ms.devlang: python
 ---
 
 # 3 - Deploy the search-enabled Python website
 
-Deploy the search-enabled website as an Azure Static web app. This deployment includes both the React app and the Function app.  
-
-The Static Web app pulls the information and files for deployment from GitHub using your fork of the samples repository.  
-
-## Create a Static Web App in Visual Studio Code
-
-1. Select **Azure** from the Activity Bar, then open **Resources** from the Side bar. 
-
-1. Right-click **Static Web Apps** and then select **Create Static Web App (Advanced)**.
-
-    :::image type="content" source="media/tutorial-javascript-create-load-index/visual-studio-code-create-static-web-app-resource-advanced.png" alt-text="Right-click **Static Web Apps** and then select **Create Static Web App (Advanced)**":::
-
-1. Follow the 8 prompts to provide the following information:
-
-    |Prompt|Enter|
-    |--|--|
-    |Enter the name for the new Static Web App.|Create a unique name for your resource. For example, you can prepend your name to the repository name such as, `joansmith-azure-search-javascript-samples`. |
-    |Select a resource group for new resources.|Use the resource group you created for this tutorial.|
-    |Select a SKU| Select the free SKU for this tutorial.|
-    |Choose build preset to configure default project structure.|Select **Custom**|
-    |Select the location of your application code|`search-website`<br><br>This is the path, from the root of the repository, to your Azure Static web app. |
-    |Select the location of your Azure Function code|`search-website/api`<br><br>This is the path, from the root of the repository, to your Azure Function app. |
-    |Enter the path of your build output...|`build`<br><br>This is the path, from your Azure Static web app, to your generated files.|
-    |Select a location for new resources.|Select a region close to you.|
-
-1. The resource is created, select **Open Actions in GitHub** from the Notifications. This opens a browser window pointed to your forked repo. 
-
-    The list of actions indicates your web app, both client and functions, were successfully pushed to your Azure Static Web App. 
-
-    Wait until the build and deployment complete before continuing. This may take a minute or two to finish.
-
-## Get Cognitive Search query key in VS Code
-
-1. In VS Code, open the [Activity bar](https://code.visualstudio.com/docs/getstarted/userinterface), and select the Azure icon. 
-
-1. In the Side bar, select your Azure subscription under the **Azure: Cognitive Search** area, then right-click on your Search resource and select **Copy Query Key**. 
-
-    :::image type="content" source="./media/tutorial-javascript-create-load-index/visual-studio-code-copy-query-key.png" alt-text="In the Side bar, select your Azure subscription under the **Azure: Cognitive Search** area, then right-click on your Search resource and select **Copy Query Key**.":::
-
-1. Keep this query key, you will need to use it in the next section. The query key is able to query your index. 
-
-## Add configuration settings in Azure portal
-
-The Azure Function app won't return search data until the search secrets are in settings. 
-
-1. Select **Azure** from the Activity Bar. 
-1. Right-click on your Static web app resource then select **Open in Portal**.
-
-    :::image type="content" source="media/tutorial-javascript-static-web-app/open-static-web-app-in-azure-portal.png" alt-text="Right-click on your Python Static web app resource then select Open in Portal.":::
-
-1. Select **Configuration** then select **+ Add**.
-
-    :::image type="content" source="media/tutorial-javascript-static-web-app/add-new-application-setting-to-static-web-app-in-portal.png" alt-text="Select Configuration then select Add for your Python app.":::
-
-1. Add each of the following settings:
-
-    |Setting|Your Search resource value|
-    |--|--|
-    |SearchApiKey|Your search query key|
-    |SearchServiceName|Your search resource name|
-    |SearchIndexName|`good-books`|
-    |SearchFacets|`authors*,language_code`|
-
-    Azure Cognitive Search requires different syntax for filtering collections than it does for strings. For the authors* facet, adding a * after a field name denotes that the field is of type Collection(Edm.String). This allows the Azure Function to add filters correctly to queries.
-
-1. Select **Save** to save the settings. 
-
-    :::image type="content" source="media/tutorial-javascript-static-web-app/save-new-application-setting-to-static-web-app-in-portal.png" alt-text="Select Save to save the settings.":::
-
-1. Return to VS Code. 
-1. Refresh your static web app to see the static web app's application settings. 
-
-    :::image type="content" source="media/tutorial-javascript-static-web-app/visual-studio-code-extension-fresh-resource.png" alt-text="Refresh your Static web app to see the Static web app's application settings.":::
-
-## Use search in your Static web app
-
-1. In VS Code, open the [Activity bar](https://code.visualstudio.com/docs/getstarted/userinterface), and select the Azure icon.
-1. In the Side Bar, **right-click on your Azure subscription** under the `Static web apps` area and find the static web app you created for this tutorial.
-1. Right-click your static web app name and select **Browse site**.
-    
-    :::image type="content" source="media/tutorial-javascript-create-load-index/visual-studio-code-browse-static-web-app.png" alt-text="Right-click the Static Web App name and select **Browse site**.":::    
-
-1. Select **Open** in the pop-up dialog.
-1. In the website search bar, enter a search query such as `code`, _slowly_ so the suggest feature suggests book titles. Select a suggestion or continue entering your own query. Press enter when you've completed your search query. 
-1. Review the results then select one of the books to see more details. 
-
-## Clean up resources
-
-To clean up the resources created in this tutorial, delete the resource group.
-
-1. In VS Code, open the [Activity bar](https://code.visualstudio.com/docs/getstarted/userinterface), and select the Azure icon. 
-
-1. In the Side bar, **right-click on your Azure subscription** under the `Resource Groups` area and find the resource group you created for this tutorial.
-1. Right-click the resource group name then select **Delete**.
-    This deletes both the Search and Static web app resources.
-1. If you no longer want the GitHub fork of the sample, remember to delete that on GitHub. Go to your fork's **Settings** then delete the fork. 
-
+[!INCLUDE [tutorial-deploy](includes/tutorial-add-search-website-create-app.md)]
 
 ## Next steps
 

articles/search/tutorial-python-overview.md

@@ -7,7 +7,7 @@ author: diberry
 ms.author: diberry
 ms.service: cognitive-search
 ms.topic: tutorial
-ms.date: 08/30/2022
+ms.date: 11/02/2022
 ms.custom: devx-track-python
 ms.devlang: python
 ---
@@ -17,30 +17,22 @@ ms.devlang: python
 This tutorial builds a website to search through a catalog of books then deploys the website to an Azure Static Web App. 
 
 The application is available: 
-* [Sample](https://github.com/Azure-Samples/azure-search-python-samples/tree/master/search-website)
+* [Sample](https://github.com/Azure-Samples/azure-search-python-samples/tree/master/search-website-functions-v4)
 * [Demo website - aka.ms/azs-good-books](https://aka.ms/azs-good-books)
 
 ## What does the sample do? 
 
-This sample website provides access to a catalog of 10,000 books. A user can search the catalog by entering text in the search bar. While the user enters text, the website uses your search index's suggest feature to complete the text. Once the query finishes, the list of books is displayed with a portion of the details. A user can select a book to see all the details, stored in the search index, of the book. 
-
-:::image type="content" source="./media/tutorial-javascript-overview/cognitive-search-enabled-book-website.png" alt-text="This sample website provides access to a catalog of 10,000 books. A user can search the catalog by entering text in the search bar. While the user enters text, the website uses the Search Index's suggest feature to complete the text. Once the search finishes, the list of books is displayed with a portion of the details. A user can select a book to see all the details, stored in the Search Index, of the book.":::
-
-The search experience includes: 
-
-* Search – provides search functionality for the application.
-* Suggest – provides suggestions as the user is typing in the search bar.
-* Document Lookup – looks up a document by ID to retrieve all of its contents for the details page.
+[!INCLUDE [tutorial-overview](includes/tutorial-add-search-website-what-sample-does.md)]
 
 ## How is the sample organized?
 
-The [sample](https://github.com/Azure-Samples/azure-search-python-samples/tree/master/search-website) includes the following:
+The [sample](https://github.com/Azure-Samples/azure-search-python-samples/tree/master/search-website-functions-v4) includes the following:
 
 |App|Purpose|GitHub<br>Repository<br>Location|
 |--|--|--|
-|Client|React app (presentation layer) to display books, with search. It calls the Azure Function app. |[/search-website/src](https://github.com/Azure-Samples/azure-search-python-samples/tree/master/search-website/src)|
-|Server|Azure Function app (business layer) - calls the Azure Cognitive Search API using Python SDK |[/search-website/api](https://github.com/Azure-Samples/azure-search-python-samples/tree/master/search-website/src)|
-|Bulk insert|Python file to create the index and add documents to it.|[/search-website/bulk-upload](https://github.com/Azure-Samples/azure-search-python-samples/tree/master/search-website/bulk-upload)|
+|Client|React app (presentation layer) to display books, with search. It calls the Azure Function app. |[/search-website-functions-v4/client](https://github.com/Azure-Samples/azure-search-python-samples/tree/master/search-website-functions-v4/client)|
+|Server|Azure Function app (business layer) - calls the Azure Cognitive Search API using Python SDK |[/search-website-functions-v4/api](https://github.com/Azure-Samples/azure-search-python-samples/tree/master/search-website-functions-v4/api)|
+|Bulk insert|Python file to create the index and add documents to it.|[/search-website-functions-v4/bulk-upload](https://github.com/Azure-Samples/azure-search-python-samples/tree/master/search-website-functions-v4/bulk-upload)|
 
 ## Set up your development environment
 
@@ -49,8 +41,7 @@ Install the following for your local development environment.
 - [Python 3.9](https://www.python.org/downloads/)
 - [Git](https://git-scm.com/downloads)
 - [Visual Studio Code](https://code.visualstudio.com/) and the following extensions
-    - [Azure Resources](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureresourcegroups)
-    - [Azure Cognitive Search 0.2.0+](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azurecognitivesearch)
+    - [Azure Cognitive Search](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azurecognitivesearch)
     - [Azure Static Web App](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azurestaticwebapps) 
 - Optional:
     - This tutorial doesn't run the Azure Function API locally but if you intend to run it locally, you need to install [azure-functions-core-tools](../azure-functions/functions-run-local.md?tabs=linux%2ccsharp%2cbash).
@@ -75,15 +66,7 @@ Forking the sample repository is critical to be able to deploy the static web ap
 
 ## Create a resource group for your Azure resources
 
-1. In Visual Studio Code, open the [Activity bar](https://code.visualstudio.com/docs/getstarted/userinterface), and select the Azure icon. 
-1. In Resources, select Add (**+**), and then select **Create Resource Group**.
-
-    :::image type="content" source="./media/tutorial-javascript-overview/visual-studio-code-create-resource-group.png" alt-text="In Resources, select Add (**+**), and then select **Create Resource Group**.":::
-1. Enter a resource group name, such as `cognitive-search-website-tutorial`. 
-1. Select a location close to you.
-1. When you create the Cognitive Search and Static Web App resources, later in the tutorial, use this resource group. 
-
-    Creating a resource group gives you a logical unit to manage the resources, including deleting them when you are finished using them.
+[!INCLUDE [tutorial-create-resource-group](includes/tutorial-add-search-website-create-resource-group.md)]
 
 ## Next steps