Skip to content

Commit d4663b6

Browse files
authored
Merge pull request #3302 from haileytap/hailey-quickstarts
[Azure Search] Standardize quickstarts as per content pattern
2 parents 4828f54 + cff517a commit d4663b6

22 files changed

+201
-210
lines changed

articles/search/includes/quickstarts/full-text-csharp.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
manager: nitinme
3-
author: eric-urban
4-
ms.author: eur
3+
author: haileytap
4+
ms.author: haileytapia
55
ms.service: azure-ai-search
66
ms.topic: include
7-
ms.date: 2/12/2025
7+
ms.date: 03/04/2025
88
---
99

1010
[!INCLUDE [Full text introduction](full-text-intro.md)]
@@ -14,12 +14,13 @@ ms.date: 2/12/2025
1414
1515
## Prerequisites
1616

17-
- An active Azure subscription - <a href="https://azure.microsoft.com/free/cognitive-services" target="_blank">Create one for free</a>
18-
- An Azure AI Search service. [Create a service](../../search-create-service-portal.md) if you don't have one. You can use a free tier for this quickstart.
17+
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
18+
- An Azure AI Search service. [Create a service](../../search-create-service-portal.md) if you don't have one. For this quickstart, you can use a free service.
1919

2020
## Microsoft Entra ID prerequisites
2121

2222
For the recommended keyless authentication with Microsoft Entra ID, you need to:
23+
2324
- Install the [Azure CLI](/cli/azure/install-azure-cli) used for keyless authentication with Microsoft Entra ID.
2425
- Assign both of the `Search Service Contributor` and `Search Index Data Contributor` roles to your user account. You can assign roles in the Azure portal under **Access control (IAM)** > **Add role assignment**. For more information, see [Connect to Azure AI Search using roles](../../search-security-rbac.md).
2526

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
---
22
manager: nitinme
3-
author: eric-urban
4-
ms.author: eur
3+
author: haileytap
4+
ms.author: haileytapia
55
ms.service: azure-ai-search
66
ms.topic: include
7-
ms.date: 2/19/2025
7+
ms.date: 03/04/2025
88
---
99

10-
Learn how to use the *Azure.Search.Documents* client library to create, load, and query a search index using sample data for [full text search](../../search-lucene-query-architecture.md). Full text search uses Apache Lucene for indexing and queries, and a BM25 ranking algorithm for scoring results.
10+
In this quickstart, you use the Azure.Search.Documents client library to create, load, and query a search index using sample data for [full text search](../../search-lucene-query-architecture.md). Full text search uses Apache Lucene for indexing and queries, and a BM25 ranking algorithm for scoring results.
1111

1212
This quickstart creates and queries a small hotels-quickstart index containing data about four hotels.
13-

articles/search/includes/quickstarts/full-text-java.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
manager: nitinme
3-
author: eric-urban
4-
ms.author: eur
3+
author: haileytap
4+
ms.author: haileytapia
55
ms.service: azure-ai-search
66
ms.topic: include
7-
ms.date: 2/12/2025
7+
ms.date: 03/04/2025
88
---
99

1010
[!INCLUDE [Full text introduction](full-text-intro.md)]
@@ -14,8 +14,8 @@ ms.date: 2/12/2025
1414
1515
## Prerequisites
1616

17-
- An active Azure subscription - <a href="https://azure.microsoft.com/free/cognitive-services" target="_blank">Create one for free</a>
18-
- An Azure AI Search service. [Create a service](../../search-create-service-portal.md) if you don't have one. You can use a free tier for this quickstart.
17+
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
18+
- An Azure AI Search service. [Create a service](../../search-create-service-portal.md) if you don't have one. For this quickstart, you can use a free service.
1919

2020
## Microsoft Entra ID prerequisites
2121

articles/search/includes/quickstarts/full-text-javascript.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
manager: nitinme
3-
author: eric-urban
4-
ms.author: eur
3+
author: haileytap
4+
ms.author: haileytapia
55
ms.service: azure-ai-search
66
ms.topic: include
7-
ms.date: 2/19/2025
7+
ms.date: 03/04/2025
88
---
99

1010
[!INCLUDE [Full text introduction](full-text-intro.md)]
@@ -14,8 +14,8 @@ ms.date: 2/19/2025
1414
1515
## Prerequisites
1616

17-
- An active Azure subscription - <a href="https://azure.microsoft.com/free/cognitive-services" target="_blank">Create one for free</a>
18-
- An Azure AI Search service. [Create a service](../../search-create-service-portal.md) if you don't have one. You can use a free tier for this quickstart.
17+
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
18+
- An Azure AI Search service. [Create a service](../../search-create-service-portal.md) if you don't have one. For this quickstart, you can use a free service.
1919

2020
## Microsoft Entra ID prerequisites
2121

articles/search/includes/quickstarts/full-text-python.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
manager: nitinme
3-
author: eric-urban
4-
ms.author: eur
3+
author: haileytap
4+
ms.author: haileytapia
55
ms.service: azure-ai-search
66
ms.topic: include
7-
ms.date: 2/22/2025
7+
ms.date: 03/04/2025
88
---
99

1010
[!INCLUDE [Full text introduction](full-text-intro.md)]
@@ -14,9 +14,9 @@ ms.date: 2/22/2025
1414
1515
## Prerequisites
1616

17-
- An active Azure subscription - <a href="https://azure.microsoft.com/free/cognitive-services" target="_blank">Create one for free</a>
18-
- An Azure AI Search service. [Create a service](../../search-create-service-portal.md) if you don't have one. You can use a free tier for this quickstart.
19-
- [Visual Studio Code with the Python extension](https://code.visualstudio.com/docs/languages/python), or an equivalent IDE, with Python 3.10 or later. If you don't have a suitable version of Python installed, you can follow the instructions in the [VS Code Python Tutorial](https://code.visualstudio.com/docs/python/python-tutorial#_install-a-python-interpreter).
17+
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
18+
- An Azure AI Search service. [Create a service](../../search-create-service-portal.md) if you don't have one. For this quickstart, you can use a free service.
19+
- [Visual Studio Code](https://code.visualstudio.com/download) with the [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python), or an equivalent IDE with Python 3.10 or later. If you haven't installed a suitable version of Python, follow the instructions in the [VS Code Python Tutorial](https://code.visualstudio.com/docs/python/python-tutorial#_install-a-python-interpreter).
2020

2121
## Microsoft Entra ID prerequisites
2222

articles/search/includes/quickstarts/full-text-typescript.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
manager: nitinme
3-
author: eric-urban
4-
ms.author: eur
3+
author: haileytap
4+
ms.author: haileytapia
55
ms.service: azure-ai-search
66
ms.topic: include
7-
ms.date: 2/19/2025
7+
ms.date: 03/04/2025
88
---
99

1010
[!INCLUDE [Full text introduction](full-text-intro.md)]
@@ -14,8 +14,8 @@ ms.date: 2/19/2025
1414
1515
## Prerequisites
1616

17-
- An active Azure subscription - <a href="https://azure.microsoft.com/free/cognitive-services" target="_blank">Create one for free</a>
18-
- An Azure AI Search service. [Create a service](../../search-create-service-portal.md) if you don't have one. You can use a free tier for this quickstart.
17+
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
18+
- An Azure AI Search service. [Create a service](../../search-create-service-portal.md) if you don't have one. For this quickstart, you can use a free service.
1919

2020
## Microsoft Entra ID prerequisites
2121

articles/search/knowledge-store-create-portal.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,40 @@
11
---
2-
title: "Quickstart: Create a knowledge store in the Azure portal"
2+
title: "Quickstart: Create a Knowledge Store in the Azure Portal"
33
titleSuffix: Azure AI Search
4-
description: Use the Import data wizard to create a knowledge store used for persisting enriched content. Connect to a knowledge store for analysis from other apps, or send enriched content to downstream processes.
5-
author: HeidiSteen
6-
ms.author: heidist
4+
description: Learn how to use the Import Data wizard to create a knowledge store for persisting enriched content. Connect to a knowledge store for analysis from other apps or send enriched content to downstream processes.
5+
author: haileytap
6+
ms.author: haileytapia
77
manager: nitinme
88
ms.service: azure-ai-search
99
ms.topic: quickstart
10-
ms.date: 12/10/2024
10+
ms.date: 03/04/2025
1111
ms.custom:
1212
- mode-ui
1313
- ignite-2023
1414
---
1515

1616
# Quickstart: Create a knowledge store in the Azure portal
1717

18-
In this quickstart, you create a [knowledge store](knowledge-store-concept-intro.md) that serves as a repository for output generated from an [AI enrichment pipeline](cognitive-search-concept-intro.md) in Azure AI Search. A knowledge store makes generated content available in Azure Storage for workloads other than search.
18+
In this quickstart, you create a [knowledge store](knowledge-store-concept-intro.md) that serves as a repository for output generated from an [AI enrichment pipeline](cognitive-search-concept-intro.md) in Azure AI Search. A knowledge store makes generated content available in Azure Storage for workloads other than search.
1919

20-
First, you set up some sample data in Azure Storage. Next, you run the **Import data** wizard to create an enrichment pipeline that also generates a knowledge store. The knowledge store contains original source content pulled from the data source (customer reviews of a hotel), plus AI-generated content that includes a sentiment label, key phrase extraction, and text translation of non-English customer comments.
20+
First, you set up sample data in Azure Storage. Next, you run the **Import data** wizard to create an enrichment pipeline that also generates a knowledge store. The knowledge store contains original source content pulled from the data source (customer reviews of a hotel), plus AI-generated content that includes a sentiment label, key phrase extraction, and text translation of non-English customer comments.
2121

2222
## Prerequisites
2323

24-
Before you begin, have the following prerequisites in place:
25-
2624
+ An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/).
2725

28-
+ Azure AI Search. [Create a service](search-create-service-portal.md) or [find an existing service](https://portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.Search%2FsearchServices) in your account. You can use a free service for this quickstart.
26+
+ An Azure AI Search service. [Create a service](search-create-service-portal.md) or [find an existing service](https://portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.Search%2FsearchServices) in your current subscription. For this quickstart, you can use a free service.
2927

30-
+ Azure Storage. [Create an account](/azure/storage/common/storage-account-create) or [find an existing account](https://portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.Storage%2storageAccounts/). The account type must be **StorageV2 (general purpose V2)**.
28+
+ An Azure Storage account. [Create an account](/azure/storage/common/storage-account-create) or [find an existing account](https://portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.Storage%2storageAccounts/). The account type must be **StorageV2 (general purpose V2)**.
3129

3230
+ Sample data hosted in Azure Storage:
3331

34-
[Download HotelReviews_Free.csv](https://github.com/Azure-Samples/azure-search-sample-data/blob/main/hotelreviews/HotelReviews_data.csv). This CSV contains 19 pieces of customer feedback about a single hotel (originates from Kaggle.com). The file is in a repo with other sample data. If you don't want the whole repo, copy the raw content and paste it into a spreadsheet app on your device.
32+
+ [Download HotelReviews_Free.csv](https://github.com/Azure-Samples/azure-search-sample-data/blob/main/hotelreviews/HotelReviews_data.csv), which contains 19 pieces of customer feedback about a single hotel (originates from Kaggle.com). This CSV is in a repo with other sample data. If you don't want the whole repo, copy the raw content and paste it into a spreadsheet app on your device.
3533

36-
[Upload the file to a blob container](/azure/storage/blobs/storage-quickstart-blobs-portal) in Azure Storage.
34+
+ [Upload the file to a blob container](/azure/storage/blobs/storage-quickstart-blobs-portal) in Azure Storage.
3735

38-
This quickstart also uses [Azure AI services](https://azure.microsoft.com/services/cognitive-services/) for AI enrichment. Because the workload is so small, Azure AI services is tapped behind the scenes for free processing for up to 20 transactions. This means that you can complete this exercise without having to create an extra Azure AI multi-service resource.
36+
> [!NOTE]
37+
> This quickstart uses [Azure AI services](https://azure.microsoft.com/services/cognitive-services/) for AI enrichment. Because the workload is so small, Azure AI services is tapped behind the scenes for free processing for up to 20 transactions. This means that you can complete this exercise without having to create an extra Azure AI multi-service resource.
3938
4039
## Start the wizard
4140

@@ -173,9 +172,9 @@ If you're using a free service, remember that you're limited to three indexes, i
173172
> [!TIP]
174173
> If you want to repeat this exercise or try a different AI enrichment walkthrough, delete the **hotel-reviews-idxr** indexer and the related objects to recreate them. Deleting the indexer resets the free daily transaction counter to zero.
175174
176-
## Next steps
175+
## Next step
177176

178-
Now that you've been introduced to a knowledge store, take a closer look at each step by switching over to the REST API walkthrough. Tasks that the wizard handled internally are explained in the REST walkthrough.
177+
Now that you've been introduced to a knowledge store, take a closer look at each step by completing the REST API walkthrough. The walkthrough explains tasks that the wizard handled internally.
179178

180179
> [!div class="nextstepaction"]
181180
> [Create a knowledge store using REST](knowledge-store-create-rest.md)

articles/search/search-create-app-portal.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,35 @@
11
---
2-
title: "Quickstart: Create a demo search app in Azure portal"
2+
title: "Quickstart: Create a Demo App in the Azure Portal"
33
titleSuffix: Azure AI Search
44
description: Run the Create demo app wizard to generate HTML pages and script for an operational web app. The page includes a search bar, results area, sidebar, and typeahead support.
55
manager: nitinme
6-
author: HeidiSteen
7-
ms.author: heidist
6+
author: haileytap
7+
ms.author: haileytapia
88
ms.service: azure-ai-search
99
ms.topic: quickstart
10-
ms.date: 12/04/2024
10+
ms.date: 03/04/2025
1111
ms.custom:
1212
- mode-ui
1313
- ignite-2023
1414
---
1515

1616
# Quickstart: Create a demo search app in the Azure portal
1717

18-
In this quickstart for Azure AI Search, learn how to use the Azure portal's **Create demo app** wizard to generate a downloadable, "localhost"-style web app that runs in a browser. Depending on how you configure it, the generated app is operational on first use, with a live read-only connection to an index on your search service. A default app can include a search bar, results area, sidebar filters, and typeahead support.
18+
In this quickstart, you use the **Create demo app** wizard in the Azure portal to generate a downloadable, "localhost"-style web app that runs in a browser. Depending on how you configure it, the generated app is operational on first use, with a live read-only connection to an index on your search service. A default app can include a search bar, results area, sidebar filters, and typeahead support.
1919

20-
A demo app can help you visualize how an index will function in a client app, but it isn't intended for production scenarios. Production apps should include security, error handling, and hosting logic that the demo app doesn't provide.
20+
A demo app can help you visualize how an index will function in a client app, but it isn't intended for production scenarios. Production apps should include security, error handling, and hosting logic that the demo app doesn't provide.
2121

2222
## Prerequisites
2323

24-
Before you begin, have the following prerequisites in place:
25-
2624
+ An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/).
2725

28-
+ An Azure AI Search service. [Create a service](search-create-service-portal.md) or [find an existing service](https://portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.Search%2FsearchServices) under your current subscription. You can use a free service for this quickstart.
26+
+ An Azure AI Search service. [Create a service](search-create-service-portal.md) or [find an existing service](https://portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.Search%2FsearchServices) in your current subscription. For this quickstart, you can use a free service.
2927

3028
+ [Microsoft Edge (latest version)](https://www.microsoft.com/edge) or Google Chrome.
3129

32-
+ A [search index](search-what-is-an-index.md) to use as the basis of your generated application.
30+
+ A [search index](search-what-is-an-index.md) to use as the basis of your generated application.
3331

34-
This quickstart uses the built-in hotels sample dataset. To create the index used in this exercise, run the **Import data** wizard, choosing the *hotels-sample* source and accepting all defaults.
32+
This quickstart uses the hotels-sample index. To create the index, run the [**Import data wizard**](search-import-data-portal.md), select the built-in sample data, and step through the wizard using all the default values.
3533

3634
:::image type="content" source="media/search-create-app-portal/import-data-hotels.png" alt-text="Screenshot of the data source page for sample data.":::
3735

@@ -104,11 +102,11 @@ When you're working in your own subscription, it's a good idea at the end of a p
104102

105103
You can find and manage resources in the Azure portal, using the **All resources** or **Resource groups** link in the left-navigation pane.
106104

107-
Remember that a free service is limited to three indexes, indexers, and data sources. You can delete individual items in the Azure portal to stay under the limit.
105+
Remember that a free service is limited to three indexes, indexers, and data sources. You can delete individual items in the Azure portal to stay under the limit.
108106

109-
## Next steps
107+
## Next step
110108

111-
The demo app is useful for prototyping because you can simulate an end-user experience without having to write JavaScript or front-end code, but as you get closer to proof-of-concept in your own project, review one of the end-to-end code samples that is closer facsimile of a real-word app:
109+
The demo app is useful for prototyping because you can simulate an end-user experience without writing any JavaScript or front-end code. As you get closer to proof-of-concept in your own project, review the end-to-end code samples that more closely mimic a real-word app:
112110

113111
> [!div class="nextstepaction"]
114112
> [Add search to web apps](tutorial-csharp-overview.md)

0 commit comments

Comments
 (0)