Skip to content

Commit 8855145

Browse files
committed
Added GH learn-how links
1 parent 39ad1f3 commit 8855145

File tree

2 files changed

+19
-15
lines changed

2 files changed

+19
-15
lines changed

articles/search/search-get-started-rest.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,15 @@ ms.author: heidist
99
ms.service: cognitive-search
1010
ms.topic: quickstart
1111
ms.devlang: rest-api
12-
ms.date: 03/06/2024
12+
ms.date: 03/14/2024
1313
ms.custom:
1414
- mode-api
1515
- ignite-2023
1616
---
1717

1818
# Quickstart: Text search using REST
1919

20-
Learn how to use the [Search REST APIs](/rest/api/searchservice) to create, load, and query a search index in Azure AI Search.
21-
22-
[Download a REST sample](https://github.com/Azure-Samples/azure-search-rest-samples/tree/main/Quickstart) to send the requests in this quickstart, or create requests manually using the instructions in this article.
20+
The REST APIs in Azure AI Search provide programmatic access to all of its capabilities, including preview features, and they're an easy way to learn how features work. In this quickstart, call the [Search REST APIs](/rest/api/searchservice) to create, load, and query a search index in Azure AI Search.
2321

2422
If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
2523

@@ -29,18 +27,22 @@ If you don't have an Azure subscription, create a [free account](https://azure.m
2927

3028
+ [Azure AI Search](search-what-is-azure-search.md). [Create](search-create-service-portal.md) or [find an existing Azure AI Search resource](https://portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.Search%2FsearchServices) under your current subscription. You can use a free service for this quickstart.
3129

32-
## Copy a key and URL
30+
## Download files
31+
32+
[Download a REST sample](https://github.com/Azure-Samples/azure-search-rest-samples/tree/main/Quickstart) from GitHub to send the requests in this quickstart. [Learn how](https://docs.github.com/get-started/start-your-journey/downloading-files-from-github).
33+
34+
Or, start a new file on your local system and create requests manually using the instructions in this article.
35+
36+
## Copy a search service key and URL
3337

3438
REST calls require the search service endpoint and an API key on every request. You can get these values from the Azure portal.
3539

36-
1. Sign in to the [Azure portal](https://portal.azure.com), navigate to the **Overview** page, and copy the URL. An example endpoint might look like `https://mydemo.search.windows.net`.
40+
1. Sign in to the [Azure portal](https://portal.azure.com), navigate to the search service **Overview** page, and copy the URL. An example endpoint might look like `https://mydemo.search.windows.net`.
3741

3842
1. Under **Settings** > **Keys**, copy an admin key. Admin keys are used to add, modify, and delete objects. There are two interchangeable admin keys. Copy either one.
3943

4044
:::image type="content" source="media/search-get-started-rest/get-url-key.png" alt-text="Screenshot of the URL and API keys in the Azure portal.":::
4145

42-
A valid API key establishes trust, on a per request basis, between the application sending the request and the search service handling it.
43-
4446
## Set up Visual Studio Code
4547

4648
If you're not familiar with the REST client for Visual Studio Code, this section includes setup so that you can complete the tasks in this quickstart.
@@ -57,7 +59,7 @@ If you're not familiar with the REST client for Visual Studio Code, this section
5759

5860
```http
5961
@baseUrl = PUT-YOUR-SEARCH-SERVICE-ENDPOINT-HERE
60-
@apiKey = PUT-YOUR-API-KEY-HERE
62+
@apiKey = PUT-YOUR-SEARCH-SERVICE-API-KEY-HERE
6163
6264
### List existing indexes by name
6365
GET {{baseUrl}}/indexes?api-version=2023-11-01&$select=name HTTP/1.1

articles/search/search-get-started-vector.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.service: cognitive-search
88
ms.custom:
99
- ignite-2023
1010
ms.topic: quickstart
11-
ms.date: 03/06/2024
11+
ms.date: 03/14/2024
1212
---
1313

1414
# Quickstart: Vector search using REST
@@ -17,8 +17,6 @@ Learn how to use the [Search REST APIs](/rest/api/searchservice) to create, load
1717

1818
In Azure AI Search, a [*vector store*](vector-store.md) has an index schema that defines vector and nonvector fields, a vector configuration for algorithms that create the embedding space, and settings on vector field definitions that are used in query requests. The [Create Index](/rest/api/searchservice/indexes/create-or-update) API creates the vector store.
1919

20-
[Download a REST sample](https://github.com/Azure-Samples/azure-search-rest-samples/tree/main/Quickstart-vectors) to send the requests in this quickstart, or create requests manually to adapt the instructions for your own data.
21-
2220
If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
2321

2422
> [!NOTE]
@@ -36,7 +34,13 @@ If you don't have an Azure subscription, create a [free account](https://azure.m
3634

3735
+ Optionally, an [Azure OpenAI](https://aka.ms/oai/access) resource with a deployment of **text-embedding-ada-002**. The source `.rest` file includes an optional step for generating new text embeddings, but we provide pre-generated embeddings so that you can omit this dependency.
3836

39-
## Copy a key and URL
37+
## Download files
38+
39+
[Download a REST sample](https://github.com/Azure-Samples/azure-search-rest-samples/tree/main/Quickstart-vectors) from GitHub to send the requests in this quickstart. [Learn how](https://docs.github.com/get-started/start-your-journey/downloading-files-from-github).
40+
41+
Or, start a new file on your local system and create requests manually using the instructions in this article.
42+
43+
## Copy a search service key and URL
4044

4145
REST calls require the search service endpoint and an API key on every request. You can get these values from the Azure portal.
4246

@@ -46,8 +50,6 @@ REST calls require the search service endpoint and an API key on every request.
4650

4751
:::image type="content" source="media/search-get-started-rest/get-url-key.png" alt-text="Screenshot of the URL and API keys in the Azure portal.":::
4852

49-
A valid API key establishes trust, on a per request basis, between the application sending the request and the search service handling it.
50-
5153
## Create a vector index
5254

5355
[Create Index (REST)](/rest/api/searchservice/create-index) creates a vector index and sets up the physical data structures on your search service.

0 commit comments

Comments
 (0)