Skip to content

Commit e46722d

Browse files
authored
Merge pull request #338 from HeidiSteen/main
BULK EDIT: REST API links
2 parents 408a931 + 3ddbbe7 commit e46722d

22 files changed

+32
-32
lines changed

articles/search/cognitive-search-concept-image-scenarios.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ In a skillset, Image Analysis and OCR skill output is always text. Output text i
282282
],
283283
```
284284

285-
1. [Update the indexer](/rest/api/searchservice/update-indexer) to map skillset output (nodes in an enrichment tree) to index fields.
285+
1. [Update the indexer](/rest/api/searchservice/indexers/create-or-update) to map skillset output (nodes in an enrichment tree) to index fields.
286286

287287
Enriched documents are internal. To externalize the nodes in an enriched document tree, set up an output field mapping that specifies which index field receives node content. Enriched data is accessed by your app through an index field. The following example shows a "text" node (OCR output) in an enriched document that's mapped to a "text" field in a search index.
288288

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -497,7 +497,7 @@ POST {{baseUrl}}/indexers?api-version=2024-07-01 HTTP/1.1
497497

498498
Indexing and enrichment commence as soon as you submit the Create Indexer request. Depending on skillset complexity and operations, indexing can take a while.
499499

500-
To find out whether the indexer is still running, call [Get Indexer Status](/rest/api/searchservice/get-indexer-status) to check the indexer status.
500+
To find out whether the indexer is still running, call [Get Indexer Status](/rest/api/searchservice/indexers/get-status) to check the indexer status.
501501

502502
```http
503503
### Get Indexer Status (wait several minutes for the indexer to complete)

articles/search/index-add-suggesters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ private static void CreateIndex(string indexName, SearchIndexClient indexClient)
151151

152152
A suggester is used in a query. After a suggester is created, call one of the following APIs for a search-as-you-type experience:
153153

154-
+ [Suggestions REST API](/rest/api/searchservice/suggestions)
154+
+ [Suggestions REST API](/rest/api/searchservice/documents/suggest-post)
155155
+ [Autocomplete REST API](/rest/api/searchservice/documents/autocomplete-post)
156156
+ [SuggestAsync method](/dotnet/api/azure.search.documents.searchclient.suggestasync)
157157
+ [AutocompleteAsync method](/dotnet/api/azure.search.documents.searchclient.autocompleteasync)

articles/search/knowledge-store-projection-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ Recall that projections are exclusive to knowledge stores, and aren't used to st
164164

165165
1. From the skills array, determine which skill outputs should be referenced in the `source` of each projection. All projections have a source. The source can be the output of an upstream skill, but is often the output of a Shaper skill. The composition of your projection is determined through shapes.
166166

167-
1. If you're adding projections to an existing skillset, [update the skillset](/rest/api/searchservice/update-skillset) and [run the indexer](/rest/api/searchservice/run-indexer).
167+
1. If you're adding projections to an existing skillset, [update the skillset](/rest/api/searchservice/update-skillset) and [run the indexer](/rest/api/searchservice/indexers/run).
168168

169169
1. Check your results in Azure Storage. On subsequent runs, avoid naming collisions by deleting objects in Azure Storage or changing project names in the skillset.
170170

articles/search/knowledge-store-projections-examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ You can process projections by following these steps:
267267

268268
1. [Update the skillset](/rest/api/searchservice/update-skillset) by issuing a PUT request with your projection definition in the body of the skillset.
269269

270-
1. [Run the indexer](/rest/api/searchservice/run-indexer) to put the skillset into execution.
270+
1. [Run the indexer](/rest/api/searchservice/indexers/run) to put the skillset into execution.
271271

272272
1. [Monitor indexer execution](search-howto-monitor-indexers.md) to check progress and catch any errors.
273273

articles/search/monitor-azure-cognitive-search-data-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ The following operations can appear in a resource log.
200200
| Query.Lookup | A lookup query against an index. See [Query types and composition](search-query-overview.md). |
201201
| Query.Search | A full text search request against an index. See [Query types and composition](search-query-overview.md). |
202202
| Query.Suggest | Type ahead query against an index. See [Query types and composition](search-query-overview.md). |
203-
| ServiceStats | This operation is a routine call to [Get Service Statistics](/rest/api/searchservice/get-service-statistics), either called directly or implicitly to populate a portal overview page when it's loaded or refreshed. |
203+
| ServiceStats | This operation is a routine call to [Get Service Statistics](/rest/api/searchservice/get-service-statistics/get-service-statistics), either called directly or implicitly to populate a portal overview page when it's loaded or refreshed. |
204204
| Skillsets.* | Applies to a skillset. Can be Create, Delete, Get, List. |
205205

206206
## Related content

articles/search/query-odata-filter-orderby-syntax.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,10 @@ Field paths are used in many parameters of the [Azure AI Search REST APIs](/rest
9090
| [Search](/rest/api/searchservice/documents/search-post) | `facet` | Can only refer to **facetable** fields |
9191
| [Search](/rest/api/searchservice/documents/search-post) | `highlight` | Can only refer to **searchable** fields |
9292
| [Search](/rest/api/searchservice/documents/search-post) | `searchFields` | Can only refer to **searchable** fields |
93-
| [Suggest](/rest/api/searchservice/suggestions) and [Autocomplete](/rest/api/searchservice/documents/autocomplete-post) | `searchFields` | Can only refer to fields that are part of a [suggester](index-add-suggesters.md) |
94-
| [Search](/rest/api/searchservice/documents/search-post), [Suggest](/rest/api/searchservice/suggestions), and [Autocomplete](/rest/api/searchservice/documents/autocomplete-post) | `$filter` | Can only refer to **filterable** fields |
95-
| [Search](/rest/api/searchservice/documents/search-post) and [Suggest](/rest/api/searchservice/suggestions) | `$orderby` | Can only refer to **sortable** fields |
96-
| [Search](/rest/api/searchservice/documents/search-post), [Suggest](/rest/api/searchservice/suggestions), and [Lookup](/rest/api/searchservice/documents/get) | `$select` | Can only refer to **retrievable** fields |
93+
| [Suggest](/rest/api/searchservice/documents/suggest-post) and [Autocomplete](/rest/api/searchservice/documents/autocomplete-post) | `searchFields` | Can only refer to fields that are part of a [suggester](index-add-suggesters.md) |
94+
| [Search](/rest/api/searchservice/documents/search-post), [Suggest](/rest/api/searchservice/documents/suggest-post), and [Autocomplete](/rest/api/searchservice/documents/autocomplete-post) | `$filter` | Can only refer to **filterable** fields |
95+
| [Search](/rest/api/searchservice/documents/search-post) and [Suggest](/rest/api/searchservice/documents/suggest-post) | `$orderby` | Can only refer to **sortable** fields |
96+
| [Search](/rest/api/searchservice/documents/search-post), [Suggest](/rest/api/searchservice/documents/suggest-post), and [Lookup](/rest/api/searchservice/documents/get) | `$select` | Can only refer to **retrievable** fields |
9797

9898
## Constants
9999

articles/search/search-add-autocomplete-suggestions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Search-as-you-type is a common technique for improving query productivity. In Az
2020
To implement these experiences in Azure AI Search:
2121

2222
+ Add a `suggester` to an index schema.
23-
+ Build a query that calls the [Autocomplete](/rest/api/searchservice/documents/autocomplete-post) or [Suggestions](/rest/api/searchservice/suggestions) API on the request.
23+
+ Build a query that calls the [Autocomplete](/rest/api/searchservice/documents/autocomplete-post) or [Suggestions](/rest/api/searchservice/documents/suggest-post) API on the request.
2424
+ Add a UI control to handle search-as-you-type interactions in your client app. We recommend using an existing JavaScript library for this purpose.
2525

2626
In Azure AI Search, autocompleted queries and suggested results are retrieved from the search index, from selected fields that you register with a suggester. A suggester is part of the index, and it specifies which fields provide content that either completes a query, suggests a result, or does both. When the index is created and loaded, a suggester data structure is created internally to store prefixes used for matching on partial queries. For suggestions, choosing suitable fields that are unique, or at least not repetitive, is essential to the experience. For more information, see [Create a suggester](index-add-suggesters.md).
@@ -51,20 +51,20 @@ Matches are on the beginning of a term anywhere in the input string. Given "the
5151

5252
Follow these links for the REST and .NET SDK reference pages:
5353

54-
+ [Suggestions REST API](/rest/api/searchservice/suggestions)
54+
+ [Suggestions REST API](/rest/api/searchservice/documents/suggest-post)
5555
+ [Autocomplete REST API](/rest/api/searchservice/documents/autocomplete-post)
5656
+ [SuggestAsync method](/dotnet/api/azure.search.documents.searchclient.suggestasync)
5757
+ [AutocompleteAsync method](/dotnet/api/azure.search.documents.searchclient.autocompleteasync)
5858

5959
## Structure a response
6060

61-
Responses for autocomplete and suggestions are what you might expect for the pattern: [Autocomplete](/rest/api/searchservice/documents/autocomplete-post#responses) returns a list of terms, [Suggestions](/rest/api/searchservice/suggestions#response) returns terms plus a document ID so that you can fetch the document (use the [Lookup Document](/rest/api/searchservice/documents/get) API to fetch the specific document for a detail page).
61+
Responses for autocomplete and suggestions are what you might expect for the pattern: [Autocomplete](/rest/api/searchservice/documents/autocomplete-post#responses) returns a list of terms, [Suggestions](/rest/api/searchservice/documents/suggest-post#response) returns terms plus a document ID so that you can fetch the document (use the [Lookup Document](/rest/api/searchservice/documents/get) API to fetch the specific document for a detail page).
6262

6363
Responses are shaped by the parameters on the request:
6464

6565
+ For Autocomplete, set the [autocompleteMode](/rest/api/searchservice/documents/autocomplete-post#autocompletemode) to determine whether text completion occurs on one or two terms.
6666

67-
+ For Suggestions, set [$select](/rest/api/searchservice/suggestions#query-parameters) to return fields containing unique or differentiating values, such as names and description. Avoid fields that contain duplicate values (such as a category or city).
67+
+ For Suggestions, set [$select](/rest/api/searchservice/documents/suggest-post#request-body) to return fields containing unique or differentiating values, such as names and description. Avoid fields that contain duplicate values (such as a category or city).
6868

6969
The following parameters apply to both autocomplete and suggestions, but are more applicable to suggestions, especially when a suggester includes multiple fields.
7070

articles/search/search-howto-connecting-azure-sql-database-to-azure-search-using-indexers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ An indexer runs automatically when it's created. You can prevent this by setting
182182
183183
## Check indexer status
184184
185-
To monitor the indexer status and execution history, send a [Get Indexer Status](/rest/api/searchservice/get-indexer-status) request:
185+
To monitor the indexer status and execution history, send a [Get Indexer Status](/rest/api/searchservice/indexers/get-status) request:
186186
187187
```http
188188
GET https://myservice.search.windows.net/indexers/myindexer/status?api-version=2024-07-01
@@ -272,7 +272,7 @@ api-key: admin-key
272272
When using SQL integrated change tracking policy, don't specify a separate data deletion detection policy. The SQL integrated change tracking policy has built-in support for identifying deleted rows. However, for the deleted rows to be detected automatically, the document key in your search index must be the same as the primary key in the SQL table.
273273

274274
> [!NOTE]
275-
> When using [TRUNCATE TABLE](/sql/t-sql/statements/truncate-table-transact-sql) to remove a large number of rows from a SQL table, the indexer needs to be [reset](/rest/api/searchservice/reset-indexer) to reset the change tracking state to pick up row deletions.
275+
> When using [TRUNCATE TABLE](/sql/t-sql/statements/truncate-table-transact-sql) to remove a large number of rows from a SQL table, the indexer needs to be [reset](/rest/api/searchservice/indexers/reset) to reset the change tracking state to pick up row deletions.
276276
277277
<a name="HighWaterMarkPolicy"></a>
278278

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ When you're ready to create an indexer on a remote search service, you need a se
171171

172172
### [**REST**](#tab/indexer-rest)
173173

174-
Visual Studio Code with a REST client can send indexer requests. Using the app, you can connect to your search service and send [Create Indexer (REST)](/rest/api/searchservice/indexers/create) or [Update indexer](/rest/api/searchservice/update-indexer) requests.
174+
Visual Studio Code with a REST client can send indexer requests. Using the app, you can connect to your search service and send [Create Indexer (REST)](/rest/api/searchservice/indexers/create) or [Update indexer](/rest/api/searchservice/indexers/create-or-update) requests.
175175

176176
```http
177177
POST /indexers?api-version=[api-version]
@@ -243,7 +243,7 @@ Change detection logic is built into the data platforms. How an indexer supports
243243

244244
Indexers keep track of the last document it processed from the data source through an internal *high water mark*. The marker is never exposed in the API, but internally the indexer keeps track of where it stopped. When indexing resumes, either through a scheduled run or an on-demand invocation, the indexer references the high water mark so that it can pick up where it left off.
245245

246-
If you need to clear the high water mark to reindex in full, you can use [Reset Indexer](/rest/api/searchservice/reset-indexer). For more selective reindexing, use [Reset Skills](/rest/api/searchservice/skillsets/reset-skills?view=rest-searchservice-2024-05-01-preview&preserve-view=true) or [Reset Documents](/rest/api/searchservice/indexers/reset-docs?view=rest-searchservice-2024-05-01-preview&preserve-view=true). Through the reset APIs, you can clear internal state, and also flush the cache if you enabled [incremental enrichment](search-howto-incremental-index.md). For more background and comparison of each reset option, see [Run or reset indexers, skills, and documents](search-howto-run-reset-indexers.md).
246+
If you need to clear the high water mark to reindex in full, you can use [Reset Indexer](/rest/api/searchservice/indexers/reset). For more selective reindexing, use [Reset Skills](/rest/api/searchservice/skillsets/reset-skills?view=rest-searchservice-2024-05-01-preview&preserve-view=true) or [Reset Documents](/rest/api/searchservice/indexers/reset-docs?view=rest-searchservice-2024-05-01-preview&preserve-view=true). Through the reset APIs, you can clear internal state, and also flush the cache if you enabled [incremental enrichment](search-howto-incremental-index.md). For more background and comparison of each reset option, see [Run or reset indexers, skills, and documents](search-howto-run-reset-indexers.md).
247247

248248
## Next steps
249249

0 commit comments

Comments
 (0)