Skip to content

Commit 36391e5

Browse files
authored
Merge pull request #268328 from HeidiSteen/heidist-fix
[SCOPED] [azure search] update debug session to use VS Code REST client + more postman link replacements
2 parents 423bd1b + c327732 commit 36391e5

10 files changed

+50
-67
lines changed

articles/search/cognitive-search-tutorial-blob.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ All HTTP requests to a search service require an API key. A valid key establishe
127127
128128
## 2 - Set up Postman
129129
130-
1. Start Postman, import the collection, and set up the environment variables. If you're unfamiliar with this tool, see [Explore Azure AI Search REST APIs](search-get-started-rest.md).
130+
1. Start Postman, import the collection, and set up the environment variables. If you're unfamiliar with this tool, see [Quickstart: Text search using REST](search-get-started-rest.md).
131131
132132
1. You'll need to provide a search service name, an admin API key, an index name, a connection string to your Azure Storage account, and the container name.
133133

articles/search/cognitive-search-tutorial-debug-sessions.md

Lines changed: 40 additions & 55 deletions
Large diffs are not rendered by default.

articles/search/samples-rest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ Learn about the REST API samples that demonstrate the functionality and workflow
1919

2020
REST is the definitive programming interface for Azure AI Search, and all operations that can be invoked programmatically are available first in REST, and then in SDKs. For this reason, most examples in the documentation use the REST APIs to demonstrate or explain important concepts.
2121

22-
REST samples are usually developed and tested on the [Postman app](https://www.postman.com/downloads/), but you can use any client that supports HTTP calls. [Here's a quickstart](search-get-started-rest.md) that explains how to formulate the HTTP request from end-to-end in Postman.
22+
You can use any client that supports HTTP calls. [Here's a quickstart](search-get-started-rest.md) that explains how to formulate the HTTP request using Visual Studio Code with a REST client.
2323

2424
## Doc samples
2525

2626
Code samples from the Azure AI Search team demonstrate features and workflows. Many of these samples are referenced in tutorials, quickstarts, and how-to articles. You can find these samples in [**Azure-Samples/azure-search-postman-samples**](https://github.com/Azure-Samples/azure-search-postman-samples) on GitHub.
2727

2828
| Samples | Description |
2929
|---------|---------|
30-
| [Quickstart](https://github.com/Azure-Samples/azure-search-postman-samples/tree/main/Quickstart) | Source code for [Quickstart: Create a search index using REST APIs](search-get-started-rest.md). This sample covers the basic workflow for creating, loading, and querying a search index using sample data. |
30+
| [Quickstart](https://github.com/Azure-Samples/azure-search-postman-samples/tree/main/Quickstart) | Source code for [Quickstart: Text search using REST](search-get-started-rest.md). This sample covers the basic workflow for creating, loading, and querying a search index using sample data. |
3131
| [Quickstart-vectors](https://github.com/Azure-Samples/azure-search-postman-samples/tree/main/Quickstart-vectors) | Source code for [Quickstart: Vector search using REST APIs](search-get-started-vector.md). This sample covers the basic workflow for indexing and querying vector data. |
3232
| [Tutorial](https://github.com/Azure-Samples/azure-search-postman-samples/tree/main/Tutorial) | Source code for [Tutorial: Use REST and AI to generate searchable content from Azure blobs](cognitive-search-tutorial-blob.md). This sample shows you how to create a skillset that iterates over Azure blobs to extract information and infer structure.|
3333
| [Debug-sessions](https://github.com/Azure-Samples/azure-search-postman-samples/tree/main/Debug-sessions) | Source code for [Tutorial: Diagnose, repair, and commit changes to your skillset](cognitive-search-tutorial-debug-sessions.md). This sample shows you how to use a skillset debug session in the Azure portal. REST is used to create the objects used during debug.|

articles/search/search-how-to-create-search-index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ The following screenshot highlights where **Add index** and **Import data** appe
9595
9696
### [**REST**](#tab/index-rest)
9797

98-
[**Create Index (REST API)**](/rest/api/searchservice/create-index) is used to create an index. The Postman app can function as a search index client to connect to your search service and send requests. See [Create a search index using REST and Postman](search-get-started-rest.md) to get started.
98+
[**Create Index (REST API)**](/rest/api/searchservice/create-index) is used to create an index. You need a REST client to connect to your search service and send requests. See [Quickstart: Text search using REST](search-get-started-rest.md) to get started.
9999

100100
The REST API provides defaults for field attribution. For example, all `Edm.String` fields are searchable by default. Attributes are shown in full below for illustrative purposes, but you can omit attribution in cases where the default values apply.
101101

articles/search/search-how-to-load-search-index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ If indexers are already defined, you can [reset and run an indexer](search-howto
4545

4646
[Documents - Index (REST)](/rest/api/searchservice/documents) is the means by which you can import data into a search index. The @search.action parameter determines whether documents are added in full, or partially in terms of new or replacement values for specific fields.
4747

48-
[**REST Quickstart: Create, load, and query an index**](search-get-started-rest.md) explains the steps. The following example is a modified version of the example. It's been trimmed for brevity and the first HotelId value has been altered to avoid overwriting an existing document.
48+
[**Quickstart: Text search using REST**](search-get-started-rest.md) explains the steps. The following example is a modified version of the example. It's been trimmed for brevity and the first HotelId value has been altered to avoid overwriting an existing document.
4949

5050
1. Formulate a POST call specifying the index name, the "docs/index" endpoint, and a request body that includes the @search.action parameter.
5151

articles/search/search-howto-create-indexers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ POST /indexers?api-version=[api-version]
188188
}
189189
```
190190

191-
There are numerous tutorials and examples that demonstrate REST clients for creating objects. [Create a search index using REST](search-get-started-rest.md) can get you started.
191+
There are numerous tutorials and examples that demonstrate REST clients for creating objects. [Quickstart: Text search using REST](search-get-started-rest.md) can get you started.
192192

193193
### [**.NET SDK**](#tab/indexer-csharp)
194194

articles/search/search-more-like-this.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,4 @@ GET /indexes/hotels-sample-index/docs?moreLikeThis=20&searchFields=Description&$
6767
You can use any REST client for this exercise.
6868

6969
> [!div class="nextstepaction"]
70-
> [Quickstart: Azure AI Search using REST](search-get-started-rest.md)
70+
> [Quickstart: Text search using REST](search-get-started-rest.md)

articles/search/search-query-create.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,7 @@ In the portal, when you open an index, you can work with Search Explorer alongsi
100100

101101
### [**REST API**](#tab/rest-text-query)
102102

103-
[Postman app](https://www.postman.com/downloads/) is useful for working with the REST APIs, such as [Search Documents (REST)](/rest/api/searchservice/documents/search-post).
104-
105-
[Quickstart: Create a search index using REST and Postman](search-get-started-rest.md) has step-by-step instructions for setting up requests.
103+
Use a REST client to set up a request. [Quickstart: Text search using REST](search-get-started-rest.md) has instructions if you need help with getting started.
106104

107105
The following example calls the REST API for full text search:
108106

articles/search/semantic-how-to-query-request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ In this article, learn how to invoke a semantic ranking over a result set, promo
3333
Choose a search client that supports semantic ranking. Here are some options:
3434

3535
+ [Azure portal](https://portal.azure.com), using the index designer to add a semantic configuration.
36-
+ [Postman app](https://www.postman.com/downloads/) using [REST APIs](/rest/api/searchservice/)
36+
+ [Visual Studio Code](https://code.visualstudio.com/download) with a [REST client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client)
3737
+ [Azure SDK for .NET](https://www.nuget.org/packages/Azure.Search.Documents)
3838
+ [Azure SDK for Python](https://pypi.org/project/azure-search-documents)
3939
+ [Azure SDK for Java](https://central.sonatype.com/artifact/com.azure/azure-search-documents)

articles/search/tutorial-create-custom-analyzer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ For each request, you need to:
5656

5757
:::image type="content" source="media/search-get-started-rest/postman-url.png" alt-text="Postman request URL and header" border="false":::
5858

59-
If you're unfamiliar with Postman, see [Explore Azure AI Search REST APIs](search-get-started-rest.md).
59+
If you're unfamiliar with Postman, see [Quickstart: Text search using REST](search-get-started-rest.md).
6060

6161
## 3 - Create an initial index
6262

0 commit comments

Comments
 (0)