Skip to content

Commit 2756d1b

Browse files
committed
BULK EDIT: Update REST API references to Create Indexer
1 parent cb750a9 commit 2756d1b

21 files changed

+29
-29
lines changed

articles/search/cognitive-search-common-errors-warnings.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This article provides information and solutions to common errors and warnings yo
1919

2020
Indexing stops when the error count exceeds ['maxFailedItems'](cognitive-search-concept-troubleshooting.md#tip-2-see-what-works-even-if-there-are-some-failures).
2121

22-
If you want indexers to ignore these errors (and skip over "failed documents"), consider updating the `maxFailedItems` and `maxFailedItemsPerBatch` as described [here](/rest/api/searchservice/create-indexer#general-parameters-for-all-indexers).
22+
If you want indexers to ignore these errors (and skip over "failed documents"), consider updating the `maxFailedItems` and `maxFailedItemsPerBatch` as described [here](/rest/api/searchservice/indexers/create#indexingparameters).
2323

2424
> [!NOTE]
2525
> Each failed document along with its document key (when available) will show up as an error in the indexer execution status. You can utilize the [index api](/rest/api/searchservice/addupdate-or-delete-documents) to manually upload the documents at a later point if you have set the indexer to tolerate failures.
@@ -189,7 +189,7 @@ The document was read and processed, but the indexer couldn't add it to the sear
189189
| Trouble connecting to the target index (that persists after retries) because the service is under other load, such as querying or indexing. | Failed to establish connection to update index. Search service is under heavy load. | [Scale up your search service](search-capacity-planning.md)
190190
| Search service is being patched for service update, or is in the middle of a topology reconfiguration. | Failed to establish connection to update index. Search service is currently down/Search service is undergoing a transition. | Configure service with at least three replicas for 99.9% availability per [SLA documentation](https://azure.microsoft.com/support/legal/sla/search/v1_0/)
191191
| Failure in the underlying compute/networking resource (rare) | Failed to establish connection to update index. An unknown failure occurred. | Configure indexers to [run on a schedule](search-howto-schedule-indexers.md) to pick up from a failed state.
192-
| An indexing request made to the target index wasn't acknowledged within a timeout period due to network issues. | Could not establish connection to the search index in a timely manner. | Configure indexers to [run on a schedule](search-howto-schedule-indexers.md) to pick up from a failed state. Additionally, try lowering the indexer [batch size](/rest/api/searchservice/create-indexer#parameters) if this error condition persists.
192+
| An indexing request made to the target index wasn't acknowledged within a timeout period due to network issues. | Could not establish connection to the search index in a timely manner. | Configure indexers to [run on a schedule](search-howto-schedule-indexers.md) to pick up from a failed state. Additionally, try lowering the indexer [batch size](/rest/api/searchservice/indexers/create#indexingparameters) if this error condition persists.
193193

194194
<a name="could-not-index-document-because-the-indexer-data-to-index-was-invalid"></a>
195195

@@ -390,7 +390,7 @@ Output field mappings that reference non-existent/null data will produce warning
390390
<a name="document-text-appears-to-be-utf-16-encoded-but-is-missing-a-byte-order-mark"></a>
391391

392392
## `Warning: Document text appears to be UTF-16 encoded, but is missing a byte order mark`
393-
The [indexer parsing modes](/rest/api/searchservice/create-indexer#blob-configuration-parameters) need to know how text is encoded before parsing it. The two most common ways of encoding text are UTF-16 and UTF-8. UTF-8 is a variable-length encoding where each character is between 1 byte and 4 bytes long. UTF-16 is a fixed-length encoding where each character is 2 bytes long. UTF-16 has two different variants, `big endian` and `little endian`. Text encoding is determined by a `byte order mark`, a series of bytes before the text.
393+
The [indexer parsing modes](/rest/api/searchservice/indexers/create#blobindexerparsingmode) need to know how text is encoded before parsing it. The two most common ways of encoding text are UTF-16 and UTF-8. UTF-8 is a variable-length encoding where each character is between 1 byte and 4 bytes long. UTF-16 is a fixed-length encoding where each character is 2 bytes long. UTF-16 has two different variants, `big endian` and `little endian`. Text encoding is determined by a `byte order mark`, a series of bytes before the text.
394394

395395
| Encoding | Byte Order Mark |
396396
| --- | --- |

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ After the source files are set up, enable image normalization by setting the `im
6262

6363
Metadata adjustments are captured in a complex type created for each image. You can't opt out of the image normalization requirement. Skills that iterate over images, such as OCR and image analysis, expect normalized images.
6464

65-
1. [Create or Update an indexer](/rest/api/searchservice/create-indexer) to set the configuration properties:
65+
1. [Create or Update an indexer](/rest/api/searchservice/indexers/create) to set the configuration properties:
6666

6767
```json
6868
{
@@ -636,7 +636,7 @@ def base64EncodeImage(image):
636636

637637
## See also
638638

639-
+ [Create indexer (REST)](/rest/api/searchservice/create-indexer)
639+
+ [Create indexer (REST)](/rest/api/searchservice/indexers/create)
640640
+ [Image Analysis skill](cognitive-search-skill-image-analysis.md)
641641
+ [OCR skill](cognitive-search-skill-ocr.md)
642642
+ [Text merge skill](cognitive-search-skill-textmerger.md)

articles/search/cognitive-search-custom-skill-scale.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The following properties on a [custom skill](cognitive-search-custom-skill-web-a
3030

3131
1. Set `timeout`to a value sufficient for the skill to respond with a valid response.
3232

33-
1. In the `indexer` definition, set [`batchSize`](/rest/api/searchservice/create-indexer#indexer-parameters) to the number of documents that should be read from the data source and enriched concurrently.
33+
1. In the `indexer` definition, set [`batchSize`](/rest/api/searchservice/indexers/create#indexer-parameters) to the number of documents that should be read from the data source and enriched concurrently.
3434

3535
### Considerations
3636

articles/search/cognitive-search-skill-image-analysis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -778,4 +778,4 @@ If you get the error similar to `"One or more skills are invalid. Details: Error
778778
+ [Built-in skills](cognitive-search-predefined-skills.md)
779779
+ [How to define a skillset](cognitive-search-defining-skillset.md)
780780
+ [Extract text and information from images](cognitive-search-concept-image-scenarios.md)
781-
+ [Create Indexer (REST)](/rest/api/searchservice/create-indexer)
781+
+ [Create Indexer (REST)](/rest/api/searchservice/indexers/create)

articles/search/cognitive-search-skill-ocr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,4 +218,4 @@ The above skillset example assumes that a normalized-images field exists. To gen
218218
+ [TextMerger skill](cognitive-search-skill-textmerger.md)
219219
+ [How to define a skillset](cognitive-search-defining-skillset.md)
220220
+ [Extract text and information from images](cognitive-search-concept-image-scenarios.md)
221-
+ [Create Indexer (REST)](/rest/api/searchservice/create-indexer)
221+
+ [Create Indexer (REST)](/rest/api/searchservice/indexers/create)

articles/search/cognitive-search-skill-textmerger.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,4 +157,4 @@ The example above assumes that a normalized-images field exists. To get normaliz
157157

158158
+ [Built-in skills](cognitive-search-predefined-skills.md)
159159
+ [How to define a skillset](cognitive-search-defining-skillset.md)
160-
+ [Create Indexer (REST)](/rest/api/searchservice/create-indexer)
160+
+ [Create Indexer (REST)](/rest/api/searchservice/indexers/create)

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

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

405405
### Step 4: Create and run an indexer
406406

407-
Call [Create Indexer](/rest/api/searchservice/create-indexer) to drive the pipeline. The three components you have created thus far (data source, skillset, index) are inputs to an indexer. Creating the indexer on Azure AI Search is the event that puts the entire pipeline into motion.
407+
Call [Create Indexer](/rest/api/searchservice/indexers/create) to drive the pipeline. The three components you have created thus far (data source, skillset, index) are inputs to an indexer. Creating the indexer on Azure AI Search is the event that puts the entire pipeline into motion.
408408

409409
Expect this step to take several minutes to complete. Even though the data set is small, analytical skills are computation-intensive.
410410

articles/search/knowledge-store-create-rest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ A valid API key establishes trust, on a per request basis, between the applicati
144144
145145
## Create a skillset
146146
147-
A skillset defines enrichments (skills) and your knowledge store. [Create Skillset](/rest/api/searchservice/create-indexer) creates the object on your search service.
147+
A skillset defines enrichments (skills) and your knowledge store. [Create Skillset](/rest/api/searchservice/indexers/create) creates the object on your search service.
148148
149149
1. Paste in the following example to create the skillset.
150150
@@ -311,7 +311,7 @@ A skillset defines enrichments (skills) and your knowledge store. [Create Skills
311311
312312
## Create an indexer
313313
314-
[Create Indexer](/rest/api/searchservice/create-indexer) creates and runs the indexer. Indexer execution starts by cracking the documents, extracting text and images, and initializing the skillset. The indexer checks for the other objects that you created: the datasource, the index, and the skillset.
314+
[Create Indexer](/rest/api/searchservice/indexers/create) creates and runs the indexer. Indexer execution starts by cracking the documents, extracting text and images, and initializing the skillset. The indexer checks for the other objects that you created: the datasource, the index, and the skillset.
315315
316316
1. Paste in the following example to create the indexer.
317317

articles/search/search-how-to-index-onelake-files.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -360,7 +360,7 @@ In a [search index](search-what-is-an-index.md), add fields to accept the conten
360360

361361
Once the index and data source are created, you're ready to create the indexer. Indexer configuration specifies the inputs, parameters, and properties controlling run time behaviors. You can also specify which parts of a blob to index.
362362

363-
1. [Create or update an indexer](/rest/api/searchservice/create-indexer) by giving it a name and referencing the data source and target index:
363+
1. [Create or update an indexer](/rest/api/searchservice/indexers/create) by giving it a name and referencing the data source and target index:
364364

365365
```json
366366
{
@@ -404,7 +404,7 @@ Once the index and data source are created, you're ready to create the indexer.
404404

405405
In file indexing, you can often omit field mappings because the indexer has built-in support for mapping the "content" and metadata properties to similarly named and typed fields in an index. For metadata properties, the indexer automatically replaces hyphens `-` with underscores in the search index.
406406

407-
For more information about other properties, [Create an indexer](search-howto-create-indexers.md). For the full list of parameter descriptions, see [Blob configuration parameters](/rest/api/searchservice/create-indexer#blob-configuration-parameters) in the REST API. The parameters are the same for OneLake.
407+
For more information about other properties, [Create an indexer](search-howto-create-indexers.md). For the full list of parameter descriptions, see [Create Indexer (REST)](/rest/api/searchservice/indexers/create#definitions) in the REST API. The parameters are the same for OneLake.
408408

409409
By default, an indexer runs automatically when you create it. You can change this behavior by setting "disabled" to true. To control indexer execution, [run an indexer on demand](search-howto-run-reset-indexers.md) or [put it on a schedule](search-howto-schedule-indexers.md).
410410

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ In a [search index](search-what-is-an-index.md), add fields that correspond to t
138138
139139
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.
140140
141-
1. [Create or update an indexer](/rest/api/searchservice/create-indexer) by giving it a name and referencing the data source and target index:
141+
1. [Create or update an indexer](/rest/api/searchservice/indexers/create) by giving it a name and referencing the data source and target index:
142142
143143
```http
144144
POST https://[service name].search.windows.net/indexers?api-version=2024-07-01

0 commit comments

Comments
 (0)