You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/search/search-get-started-rest.md
+11-9Lines changed: 11 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,17 +9,15 @@ ms.author: heidist
9
9
ms.service: cognitive-search
10
10
ms.topic: quickstart
11
11
ms.devlang: rest-api
12
-
ms.date: 03/06/2024
12
+
ms.date: 03/14/2024
13
13
ms.custom:
14
14
- mode-api
15
15
- ignite-2023
16
16
---
17
17
18
18
# Quickstart: Text search using REST
19
19
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.
23
21
24
22
If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
25
23
@@ -29,18 +27,22 @@ If you don't have an Azure subscription, create a [free account](https://azure.m
29
27
30
28
+[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.
31
29
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
33
37
34
38
REST calls require the search service endpoint and an API key on every request. You can get these values from the Azure portal.
35
39
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`.
37
41
38
42
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.
39
43
40
44
:::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.":::
41
45
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
-
44
46
## Set up Visual Studio Code
45
47
46
48
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
57
59
58
60
```http
59
61
@baseUrl = PUT-YOUR-SEARCH-SERVICE-ENDPOINT-HERE
60
-
@apiKey = PUT-YOUR-API-KEY-HERE
62
+
@apiKey = PUT-YOUR-SEARCH-SERVICE-API-KEY-HERE
61
63
62
64
### List existing indexes by name
63
65
GET {{baseUrl}}/indexes?api-version=2023-11-01&$select=name HTTP/1.1
Copy file name to clipboardExpand all lines: articles/search/search-get-started-vector.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ ms.service: cognitive-search
8
8
ms.custom:
9
9
- ignite-2023
10
10
ms.topic: quickstart
11
-
ms.date: 03/06/2024
11
+
ms.date: 03/14/2024
12
12
---
13
13
14
14
# Quickstart: Vector search using REST
@@ -17,8 +17,6 @@ Learn how to use the [Search REST APIs](/rest/api/searchservice) to create, load
17
17
18
18
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.
19
19
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
-
22
20
If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
23
21
24
22
> [!NOTE]
@@ -36,7 +34,13 @@ If you don't have an Azure subscription, create a [free account](https://azure.m
36
34
37
35
+ 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.
38
36
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
40
44
41
45
REST calls require the search service endpoint and an API key on every request. You can get these values from the Azure portal.
42
46
@@ -46,8 +50,6 @@ REST calls require the search service endpoint and an API key on every request.
46
50
47
51
:::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.":::
48
52
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
-
51
53
## Create a vector index
52
54
53
55
[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