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
|[**Search service under a user-assigned managed identity**](search-howto-managed-identities-data-sources.md)| Service | Configures a search service to use a previously created user-assigned managed identity. |[Services - Update](/rest/api/searchmanagement/services/update?view=rest-searchmanagement-2024-03-01-preview&preserve-view=true#identity), 2021-04-01-preview or a later. |
55
+
|[**Search service under a user-assigned managed identity**](search-howto-managed-identities-data-sources.md)| Service | Configures a search service to use a previously created user-assigned managed identity. |[Services - Update](/rest/api/searchmanagement/services/update?view=rest-searchmanagement-2024-06-01-preview&preserve-view=true#identity), 2021-04-01-preview or the latest preview version. We recommend using the latest preview version. |
Copy file name to clipboardExpand all lines: articles/search/search-howto-incremental-index.md
+12-12Lines changed: 12 additions & 12 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: how-to
11
-
ms.date: 03/04/2024
11
+
ms.date: 06/25/2024
12
12
---
13
13
14
14
# Enable caching for incremental enrichment in Azure AI Search
@@ -45,10 +45,10 @@ You can use the Azure portal, preview APIs, or beta Azure SDKs are required to e
45
45
46
46
### [**REST**](#tab/rest)
47
47
48
-
On new indexers, add the "cache" property in the indexer definition payload when calling [Create or Update Indexer (2021-04-30-Preview)](/rest/api/searchservice/preview-api/create-or-update-indexer). You can also use the previous preview API version, 2020-06-30-Preview.
48
+
On new indexers, add the "cache" property in the indexer definition payload when calling Create or Update Indexer. You can use preview API versions 2021-04-30-preview and later. We recommend the latest preview for [Create or Update Indexer (2024-05-01-preview)](/rest/api/searchservice/indexers/create-or-update?view=rest-searchservice-2024-05-01-preview&preserve-view=true).
49
49
50
50
```https
51
-
POST https://[service name].search.windows.net/indexers?api-version=2021-04-30-Preview
51
+
POST https://[service name].search.windows.net/indexers?api-version=2024-05-01-preview
52
52
{
53
53
"name": "<YOUR-INDEXER-NAME>",
54
54
"targetIndexName": "<YOUR-INDEX-NAME>",
@@ -72,10 +72,10 @@ For existing indexers that already have a skillset, use the following steps to a
72
72
73
73
### Step 1: Get the indexer definition
74
74
75
-
Start with a valid, work indexer that has these components: data source, skillset, index. Using an API client, send a [GET Indexer](/rest/api/searchservice/get-indexer) request to retrieve the indexer. When you use the preview API version to the GET the indexer, a "cache" property set to null is added to the definition automatically.
75
+
Start with a valid, work indexer that has these components: data source, skillset, index. Using an API client, send a [GET Indexer](/rest/api/searchservice/indexers/get?view=rest-searchservice-2024-05-01-preview&preserve-view=true) request to retrieve the indexer. When you use the preview API version to the GET the indexer, a "cache" property set to null is added to the definition automatically.
76
76
77
77
```http
78
-
GET https://[YOUR-SEARCH-SERVICE].search.windows.net/indexers/[YOUR-INDEXER-NAME]?api-version=2021-04-30-Preview
78
+
GET https://[YOUR-SEARCH-SERVICE].search.windows.net/indexers/[YOUR-INDEXER-NAME]?api-version=2024-05-01-preview
79
79
Content-Type: application/json
80
80
api-key: [YOUR-ADMIN-KEY]
81
81
```
@@ -88,7 +88,7 @@ In the index definition, modify "cache" to include the following required and op
88
88
+ (Optional) `enableReprocessing` boolean property (`true` by default), indicates that incremental enrichment is enabled. Set to `false` if you want to suspend incremental processing while other resource-intensive operations, such as indexing new documents, are underway and then switch back to `true` later.
89
89
90
90
```http
91
-
POST https://[service name].search.windows.net/indexers?api-version=2021-04-30-Preview
91
+
POST https://[service name].search.windows.net/indexers?api-version=2024-05-01-preview
92
92
{
93
93
"name": "<YOUR-INDEXER-NAME>",
94
94
"targetIndexName": "<YOUR-INDEX-NAME>",
@@ -106,20 +106,20 @@ POST https://[service name].search.windows.net/indexers?api-version=2021-04-30-P
106
106
107
107
### Step 3: Reset the indexer
108
108
109
-
[Reset Indexer](/rest/api/searchservice/reset-indexer) is required when setting up incremental enrichment for existing indexers to ensure all documents are in a consistent state. You can use the portal or an API client for this task.
109
+
[Reset Indexer](/rest/api/searchservice/indexers/reset) is required when setting up incremental enrichment for existing indexers to ensure all documents are in a consistent state. You can use the portal or an API client for this task.
110
110
111
111
```https
112
-
POST https://[YOUR-SEARCH-SERVICE].search.windows.net/indexers/[YOUR-INDEXER-NAME]/reset?api-version=2021-04-30-Preview
112
+
POST https://[YOUR-SEARCH-SERVICE].search.windows.net/indexers/[YOUR-INDEXER-NAME]/reset?api-version=2024-05-01-preview
113
113
Content-Type: application/json
114
114
api-key: [YOUR-ADMIN-KEY]
115
115
```
116
116
117
117
### Step 4: Save the indexer
118
118
119
-
[Update Indexer (2021-04-30-Preview)](/rest/api/searchservice/preview-api/create-or-update-indexer) with a PUT request, where the body of the request includes "cache".
119
+
[Update Indexer](/rest/api/searchservice/indexers/create-or-update?view=rest-searchservice-2024-05-01-preview&preserve-view=true) with a PUT request, where the body of the request includes "cache".
120
120
121
121
```http
122
-
PUT https://[YOUR-SEARCH-SERVICE].search.windows.net/indexers/[YOUR-INDEXER-NAME]?api-version=2021-04-30-Preview
122
+
PUT https://[YOUR-SEARCH-SERVICE].search.windows.net/indexers/[YOUR-INDEXER-NAME]?api-version=2024-05-01-preview
123
123
Content-Type: application/json
124
124
api-key: [YOUR-ADMIN-KEY]
125
125
{
@@ -146,10 +146,10 @@ If you now issue another GET request on the indexer, the response from the servi
146
146
147
147
To run indexer, you can use the portal or the API. In the portal, from the indexers list, select the indexer and select **Run**. One advantage to using the portal is that you can monitor indexer status, note the duration of the job, and how many documents are processed. Portal pages are refreshed every few minutes.
148
148
149
-
Alternatively, you can use REST to [run the indexer](/rest/api/searchservice/run-indexer):
149
+
Alternatively, you can use REST to [run the indexer](/rest/api/searchservice/indexers/run):
150
150
151
151
```http
152
-
POST https://[YOUR-SEARCH-SERVICE].search.windows.net/indexers/[YOUR-INDEXER-NAME]/run?api-version=2020-06-30-Preview
152
+
POST https://[YOUR-SEARCH-SERVICE].search.windows.net/indexers/[YOUR-INDEXER-NAME]/run?api-version=2024-05-01-preview
Copy file name to clipboardExpand all lines: articles/search/search-howto-index-cosmosdb-gremlin.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,12 +41,12 @@ Because terminology can be confusing, it's worth noting that [Azure Cosmos DB in
41
41
42
42
The data source definition specifies the data to index, credentials, and policies for identifying changes in the data. A data source is defined as an independent resource so that it can be used by multiple indexers.
43
43
44
-
For this call, specify a [preview REST API version](search-api-preview.md)(2020-06-30-Preview or 2021-04-30-Preview) to create a data source that connects via an Azure Cosmos DB for Apache Gremlin.
44
+
For this call, specify a [preview REST API version](search-api-preview.md) to create a data source that connects via an Azure Cosmos DB for Apache Gremlin. You can use 2021-04-01-preview or later. We recommend the latest preview API.
45
45
46
-
1.[Create or update a data source](/rest/api/searchservice/preview-api/create-or-update-data-source) to set its definition:
46
+
1.[Create or update a data source](/rest/api/searchservice/data-sources/create-or-update?view=rest-searchservice-2024-05-01-preview&preserve-view=true) to set its definition:
47
47
48
48
```http
49
-
POST https://[service name].search.windows.net/datasources?api-version=2021-04-30-Preview
49
+
POST https://[service name].search.windows.net/datasources?api-version=2024-05-01-preview
50
50
Content-Type: application/json
51
51
api-key: [Search service admin key]
52
52
{
@@ -102,10 +102,10 @@ Avoid port numbers in the endpoint URL. If you include the port number, the conn
102
102
103
103
In a [search index](search-what-is-an-index.md), add fields to accept the source JSON documents or the output of your custom query projection. Ensure that the search index schema is compatible with your graph. For content in Azure Cosmos DB, your search index schema should correspond to the [Azure Cosmos DB items](../cosmos-db/resource-model.md#azure-cosmos-db-items) in your data source.
104
104
105
-
1.[Create or update an index](/rest/api/searchservice/create-index) to define search fields that will store data:
105
+
1.[Create or update an index](/rest/api/searchservice/indexes/create-or-update) to define search fields that will store data:
106
106
107
107
```http
108
-
POST https://[service name].search.windows.net/indexes?api-version=2020-06-30-Preview
108
+
POST https://[service name].search.windows.net/indexes?api-version=2024-05-01-preview
109
109
Content-Type: application/json
110
110
api-key: [Search service admin key]
111
111
{
@@ -164,10 +164,10 @@ In a [search index](search-what-is-an-index.md), add fields to accept the source
164
164
165
165
Once the index and data source have been created, you're ready to create the indexer. Indexer configuration specifies the inputs, parameters, and properties controlling run time behaviors.
166
166
167
-
1.[Create or update an indexer](/rest/api/searchservice/create-indexer) by giving it a name and referencing the data source and target index:
167
+
1.[Create or update an indexer](/rest/api/searchservice/indexers/create-or-update?view=rest-searchservice-2024-05-01-preview&preserve-view=true) by giving it a name and referencing the data source and target index:
168
168
169
169
```http
170
-
POST https://[service name].search.windows.net/indexers?api-version=2020-06-30
170
+
POST https://[service name].search.windows.net/indexers?api-version=2024-05-01-preview
171
171
Content-Type: application/json
172
172
api-key: [search service admin key]
173
173
{
@@ -196,10 +196,10 @@ An indexer runs automatically when it's created. You can prevent this by setting
196
196
197
197
## Check indexer status
198
198
199
-
To monitor the indexer status and execution history, send a [Get Indexer Status](/rest/api/searchservice/get-indexer-status) request:
199
+
To monitor the indexer status and execution history, send a [Get Indexer Status](/rest/api/searchservice/indexers/get-status) request:
200
200
201
201
```http
202
-
GET https://myservice.search.windows.net/indexers/myindexer/status?api-version=2020-06-30
202
+
GET https://myservice.search.windows.net/indexers/myindexer/status?api-version=2024-05-01-preview
203
203
Content-Type: application/json
204
204
api-key: [admin key]
205
205
```
@@ -276,7 +276,7 @@ When graph data is deleted, you might want to delete its corresponding document
276
276
The following example creates a data source with a soft-deletion policy:
277
277
278
278
```http
279
-
POST https://[service name].search.windows.net/datasources?api-version=2020-06-30-Preview
279
+
POST https://[service name].search.windows.net/datasources?api-version=2024-05-01-preview
Copy file name to clipboardExpand all lines: articles/search/search-howto-index-cosmosdb-mongodb.md
+11-12Lines changed: 11 additions & 12 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: how-to
11
-
ms.date: 02/28/2024
11
+
ms.date: 06/25/2024
12
12
---
13
13
14
14
# Index data from Azure Cosmos DB for MongoDB for queries in Azure AI Search
@@ -44,19 +44,18 @@ These are the limitations of this feature:
44
44
45
45
+ The MongoDB attribute `$ref` is a reserved word. If you need this in your MongoDB collection, consider alternative solutions for populating an index.
46
46
47
-
48
47
As an alternative to this connector, if your scenario has any of those requirements, you could use the [Push API/SDK](search-what-is-data-import.md) or consider [Azure Data Factory](../data-factory/connector-azure-cosmos-db.md) with an [Azure AI Search index](../data-factory/connector-azure-search.md) as the sink.
49
48
50
49
## Define the data source
51
50
52
51
The data source definition specifies the data to index, credentials, and policies for identifying changes in the data. A data source is defined as an independent resource so that it can be used by multiple indexers.
53
52
54
-
For this call, specify a [preview REST API version](search-api-preview.md) (2020-06-30-Preview or 2021-04-30-Preview) to create a data source that connects via the MongoDB API.
53
+
For this call, specify a [preview REST API version](search-api-preview.md). You can use 2020-06-30-preview or later to create a data source that connects via the MongoDB API. We recommend using the latest preview REST API.
55
54
56
-
1.[Create or update a data source](/rest/api/searchservice/preview-api/create-or-update-data-source) to set its definition:
55
+
1.[Create or update a data source](/rest/api/searchservice/data-sources/create-or-update?view=rest-searchservice-2024-05-01-preview&preserve-view=true) to set its definition:
57
56
58
57
```http
59
-
POST https://[service name].search.windows.net/datasources?api-version=2021-04-30-Preview
58
+
POST https://[service name].search.windows.net/datasources?api-version=2024-05-01-preview
60
59
Content-Type: application/json
61
60
api-key: [Search service admin key]
62
61
{
@@ -111,10 +110,10 @@ Avoid port numbers in the endpoint URL. If you include the port number, the conn
111
110
112
111
In a [search index](search-what-is-an-index.md), add fields to accept the source JSON documents or the output of your custom query projection. Ensure that the search index schema is compatible with source data. For content in Azure Cosmos DB, your search index schema should correspond to the [Azure Cosmos DB items](../cosmos-db/resource-model.md#azure-cosmos-db-items) in your data source.
113
112
114
-
1. [Create or update an index](/rest/api/searchservice/create-index) to define search fields that will store data:
113
+
1. [Create or update an index](/rest/api/searchservice/indexes/create-or-update?view=rest-searchservice-2024-05-01-preview&preserve-view=true) to define search fields that will store data:
115
114
116
115
```http
117
-
POST https://[service name].search.windows.net/indexes?api-version=2020-06-30
116
+
POST https://[service name].search.windows.net/indexes?api-version=2024-05-01-preview
118
117
Content-Type: application/json
119
118
api-key: [Search service admin key]
120
119
@@ -165,10 +164,10 @@ In a [search index](search-what-is-an-index.md), add fields to accept the source
165
164
166
165
Once the index and data source have been created, you're ready to create the indexer. Indexer configuration specifies the inputs, parameters, and properties controlling run time behaviors.
167
166
168
-
1. [Create or update an indexer](/rest/api/searchservice/create-indexer) by giving it a name and referencing the data source and target index:
167
+
1. [Create or update an indexer](/rest/api/searchservice/indexers/create-or-update?view=rest-searchservice-2024-05-01-preview&preserve-view=true) by giving it a name and referencing the data source and target index:
169
168
170
169
```http
171
-
POST https://[service name].search.windows.net/indexers?api-version=2020-06-30
170
+
POST https://[service name].search.windows.net/indexers?api-version=2024-05-01-preview
172
171
Content-Type: application/json
173
172
api-key: [search service admin key]
174
173
{
@@ -197,10 +196,10 @@ An indexer runs automatically when it's created. You can prevent this by setting
197
196
198
197
## Check indexer status
199
198
200
-
To monitor the indexer status and execution history, send a [Get Indexer Status](/rest/api/searchservice/get-indexer-status) request:
199
+
To monitor the indexer status and execution history, send a [Get Indexer Status](/rest/api/searchservice/indexers/get-status?view=rest-searchservice-2024-05-01-preview&preserve-view=true) request:
201
200
202
201
```http
203
-
GET https://myservice.search.windows.net/indexers/myindexer/status?api-version=2020-06-30
202
+
GET https://myservice.search.windows.net/indexers/myindexer/status?api-version=2024-05-01-preview
204
203
Content-Type: application/json
205
204
api-key: [admin key]
206
205
```
@@ -279,7 +278,7 @@ If you're using a custom query, make sure that the property referenced by `softD
279
278
The following example creates a data source with a soft-deletion policy:
280
279
281
280
```http
282
-
POST https://[service name].search.windows.net/datasources?api-version=2020-06-30
281
+
POST https://[service name].search.windows.net/datasources?api-version=2024-05-01-preview
Copy file name to clipboardExpand all lines: articles/search/search-howto-managed-identities-data-sources.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -170,12 +170,12 @@ Associating a user-assigned managed identity is supported in the Azure portal, i
170
170
171
171
### [**REST API**](#tab/rest-user)
172
172
173
-
You can use a preview Management REST API instead of the portal to assign a user-assigned managed identity. Use API versions `2021-04-01-preview` or later. This example uses `2024-03-01-preview`.
173
+
You can use a preview Management REST API instead of the portal to assign a user-assigned managed identity. Use API versions `2021-04-01-preview` or later. This example uses `2024-06-01-preview`.
174
174
175
-
1. Formulate a request to [UPDATE](/rest/api/searchmanagement/services/update?view=rest-searchmanagement-2024-03-01-preview&preserve-view=true#identity) a search service.
175
+
1. Formulate a request to [UPDATE](/rest/api/searchmanagement/services/update?view=rest-searchmanagement-2024-06-01-preview&preserve-view=true#identity) a search service.
176
176
177
177
```http
178
-
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview
178
+
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-06-01-preview
0 commit comments