Skip to content

Commit 7576637

Browse files
committed
BULK EDIT: REST API link updates for Index APIs
1 parent e92fca2 commit 7576637

39 files changed

+66
-66
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Indexer read the document from the data source, but there was an issue convertin
9292

9393
| Reason | Details/Example | Resolution |
9494
| --- | --- | --- |
95-
| The document key is missing | `Document key cannot be missing or empty` | Ensure all documents have valid document keys. The document key is determined by setting the 'key' property as part of the [index definition](/rest/api/searchservice/create-index#request-body). Indexers emit this error when the property flagged as the 'key' can't be found on a particular document. |
95+
| The document key is missing | `Document key cannot be missing or empty` | Ensure all documents have valid document keys. The document key is determined by setting the 'key' property as part of the [index definition](/rest/api/searchservice/indexes/create#request-body). Indexers emit this error when the property flagged as the 'key' can't be found on a particular document. |
9696
| The document key is invalid | `Invalid document key. Keys can only contain letters, digits, underscore (_), dash (-), or equal sign (=). ` | Ensure all documents have valid document keys. Review [Indexing Blob Storage](search-howto-indexing-azure-blob-storage.md) for more details. If you're using the blob indexer, and your document key is the `metadata_storage_path` field, make sure that the indexer definition has a [base64Encode mapping function](search-indexer-field-mappings.md?tabs=rest#base64encode-function) with `parameters` equal to `null`, instead of the path in plain text. |
9797
| The document key is invalid | `Document key cannot be longer than 1024 characters` | Modify the document key to meet the validation requirements. |
9898
| Could not apply field mapping to a field | `Could not apply mapping function 'functionName' to field 'fieldName'. Array cannot be null. Parameter name: bytes` | Double check the [field mappings](search-indexer-field-mappings.md) defined on the indexer, and compare with the data of the specified field of the failed document. It might be necessary to modify the field mappings or the document data. |

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ In a skillset, Image Analysis and OCR skill output is always text. Output text i
224224
}
225225
```
226226

227-
1. [Create or update a search index](/rest/api/searchservice/create-index) to add fields to accept the skill outputs.
227+
1. [Create or update a search index](/rest/api/searchservice/indexes/create) to add fields to accept the skill outputs.
228228

229229
In the following fields collection example, "content" is blob content. "Metadata_storage_name" contains the name of the file (make sure it is "retrievable"). "Metadata_storage_path" is the unique path of the blob and is the default document key. "Merged_content" is output from Text Merge (useful when images are embedded).
230230

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -630,7 +630,7 @@ Add the following using statement to resolve the disambiguated reference.
630630
using Index = Azure.Search.Documents.Indexes.Models;
631631
```
632632

633-
To learn more about index concepts, see [Create Index (REST API)](/rest/api/searchservice/create-index).
633+
To learn more about index concepts, see [Create Index (REST API)](/rest/api/searchservice/indexes/create).
634634

635635
### Step 4: Create and run an indexer
636636

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ POST {{baseUrl}}/skillsets?api-version=2024-07-01 HTTP/1.1
311311
312312
### Step 3: Create an index
313313

314-
Call [Create Index](/rest/api/searchservice/create-index) to provide the schema used to create inverted indexes and other constructs in Azure AI Search.
314+
Call [Create Index](/rest/api/searchservice/indexes/create) to provide the schema used to create inverted indexes and other constructs in Azure AI Search.
315315

316316
The largest component of an index is the fields collection, where data type and attributes determine content and behavior in Azure AI Search. Make sure you have fields for your newly generated output.
317317

articles/search/includes/quickstarts/javascript.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ With that in place, we're ready to create an index.
127127

128128
#### Create index
129129

130-
Create a file **hotels_quickstart_index.json**. This file defines how Azure AI Search works with the documents you'll be loading in the next step. Each field will be identified by a `name` and have a specified `type`. Each field also has a series of index attributes that specify whether Azure AI Search can search, filter, sort, and facet upon the field. Most of the fields are simple data types, but some, like `AddressType` are complex types that allow you to create rich data structures in your index. You can read more about [supported data types](/rest/api/searchservice/supported-data-types) and index attributes described in [Create Index (REST)](/rest/api/searchservice/create-index).
130+
Create a file **hotels_quickstart_index.json**. This file defines how Azure AI Search works with the documents you'll be loading in the next step. Each field will be identified by a `name` and have a specified `type`. Each field also has a series of index attributes that specify whether Azure AI Search can search, filter, sort, and facet upon the field. Most of the fields are simple data types, but some, like `AddressType` are complex types that allow you to create rich data structures in your index. You can read more about [supported data types](/rest/api/searchservice/supported-data-types) and index attributes described in [Create Index (REST)](/rest/api/searchservice/indexes/create).
131131

132132
Add the following content to **hotels_quickstart_index.json** or [download the file](https://github.com/Azure-Samples/azure-search-javascript-samples/blob/main/quickstart/hotels_quickstart_index.json).
133133

articles/search/includes/quickstarts/typescript.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ With that in place, we're ready to create an index.
140140

141141
#### Create index
142142

143-
Create a file **hotels_quickstart_index.json**. This file defines how Azure AI Search works with the documents you'll be loading in the next step. Each field will be identified by a `name` and have a specified `type`. Each field also has a series of index attributes that specify whether Azure AI Search can search, filter, sort, and facet upon the field. Most of the fields are simple data types, but some, like `AddressType` are complex types that allow you to create rich data structures in your index. You can read more about [supported data types](/rest/api/searchservice/supported-data-types) and index attributes described in [Create Index (REST)](/rest/api/searchservice/create-index).
143+
Create a file **hotels_quickstart_index.json**. This file defines how Azure AI Search works with the documents you'll be loading in the next step. Each field will be identified by a `name` and have a specified `type`. Each field also has a series of index attributes that specify whether Azure AI Search can search, filter, sort, and facet upon the field. Most of the fields are simple data types, but some, like `AddressType` are complex types that allow you to create rich data structures in your index. You can read more about [supported data types](/rest/api/searchservice/supported-data-types) and index attributes described in [Create Index (REST)](/rest/api/searchservice/indexes/create).
144144

145145
Add the following content to **hotels_quickstart_index.json** or [download the file](https://github.com/Azure-Samples/azure-search-javascript-samples/blob/main/quickstart/hotels_quickstart_index.json).
146146

articles/search/index-add-custom-analyzers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ Within an index definition, you can place this section anywhere in the body of a
128128
}
129129
```
130130

131-
The analyzer definition is a part of the larger index. Definitions for char filters, tokenizers, and token filters are added to the index only if you're setting custom options. To use an existing filter or tokenizer as-is, specify it by name in the analyzer definition. For more information, see [Create Index (REST)](/rest/api/searchservice/create-index). For more examples, see [Add analyzers in Azure AI Search](search-analyzers.md#examples).
131+
The analyzer definition is a part of the larger index. Definitions for char filters, tokenizers, and token filters are added to the index only if you're setting custom options. To use an existing filter or tokenizer as-is, specify it by name in the analyzer definition. For more information, see [Create Index (REST)](/rest/api/searchservice/indexes/create). For more examples, see [Add analyzers in Azure AI Search](search-analyzers.md#examples).
132132

133133
## Test custom analyzers
134134

@@ -310,4 +310,4 @@ In the table below, the token filters that are implemented using Apache Lucene a
310310

311311
- [Azure AI Search REST APIs](/rest/api/searchservice/)
312312
- [Analyzers in Azure AI Search (Examples)](search-analyzers.md#examples)
313-
- [Create Index (REST)](/rest/api/searchservice/create-index)
313+
- [Create Index (REST)](/rest/api/searchservice/indexes/create)

articles/search/index-add-language-analyzers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ The following example illustrates a language analyzer specification in an index:
8787
},
8888
```
8989

90-
For more information about creating an index and setting field properties, see [Create Index (REST)](/rest/api/searchservice/create-index). For more information about text analysis, see [Analyzers in Azure AI Search](search-analyzers.md).
90+
For more information about creating an index and setting field properties, see [Create Index (REST)](/rest/api/searchservice/indexes/create). For more information about text analysis, see [Analyzers in Azure AI Search](search-analyzers.md).
9191

9292
<a name="language-analyzer-list"></a>
9393

@@ -160,5 +160,5 @@ For more information about creating an index and setting field properties, see [
160160

161161
+ [Create an index](search-what-is-an-index.md)
162162
+ [Create a multi-language index](search-language-support.md)
163-
+ [Create Index (REST API)](/rest/api/searchservice/create-index)
163+
+ [Create Index (REST API)](/rest/api/searchservice/indexes/create)
164164
+ [LexicalAnalyzerName Class (Azure SDK for .NET)](/dotnet/api/azure.search.documents.indexes.models.lexicalanalyzername)

articles/search/index-add-scoring-profiles.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Relevancy-based ordering in a search page is also implemented through scoring pr
9393

9494
To implement custom scoring behavior, add a scoring profile to the schema that defines the index. You can have up to 100 scoring profiles within an index (see [Service Limits](search-limits-quotas-capacity.md)), but you can only specify one profile at time in any given query.
9595

96-
1. Start with an index definition. You can add and update scoring profiles on an existing index without having to rebuild it. Use an [Update Index](/rest/api/searchservice/update-index) request to post your revision.
96+
1. Start with an index definition. You can add and update scoring profiles on an existing index without having to rebuild it. Use an [Update Index](/rest/api/searchservice/indexes/create-or-update) request to post your revision.
9797

9898
1. Paste in the [Template](#bkmk_template) provided in this article.
9999

@@ -103,7 +103,7 @@ To implement custom scoring behavior, add a scoring profile to the schema that d
103103

104104
You should work iteratively, using a data set that will help you prove or disprove the efficacy of a given profile.
105105

106-
Scoring profiles can be defined in Azure portal as shown in the following screenshot, or programmatically through [REST APIs](/rest/api/searchservice/update-index) or in Azure SDKs, such as the [ScoringProfile](/dotnet/api/azure.search.documents.indexes.models.scoringprofile) class in the Azure SDK for .NET.
106+
Scoring profiles can be defined in Azure portal as shown in the following screenshot, or programmatically through [REST APIs](/rest/api/searchservice/indexes/create-or-update) or in Azure SDKs, such as the [ScoringProfile](/dotnet/api/azure.search.documents.indexes.models.scoringprofile) class in the Azure SDK for .NET.
107107

108108
:::image type="content" source="media/scoring-profiles/portal-add-scoring-profile-small.png" alt-text="Add scoring profiles page" lightbox="media/scoring-profiles/portal-add-scoring-profile.png" border="true":::
109109

@@ -342,6 +342,6 @@ The `boostGenre` profile uses weighted text fields, boosting matches found in al
342342

343343
+ [Relevance and scoring in Azure AI Search](index-similarity-and-scoring.md)
344344
+ [REST API Reference](/rest/api/searchservice/)
345-
+ [Create Index API](/rest/api/searchservice/create-index)
345+
+ [Create Index API](/rest/api/searchservice/indexes/create)
346346
+ [Azure AI Search .NET SDK](/dotnet/api/overview/azure/search?)
347347
+ [What Are Scoring Profiles?](https://social.technet.microsoft.com/wiki/contents/articles/26706.azure-search-what-are-scoring-profiles.aspx)

articles/search/index-add-suggesters.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Search-as-you-type is enabled on a per-field basis for string fields. You can im
3939

4040
## How to create a suggester
4141

42-
To create a suggester, add one to an [index definition](/rest/api/searchservice/create-index). A suggester takes a name and a collection of fields over which the typeahead experience is enabled. The best time to create a suggester is when you're also defining the field that uses it.
42+
To create a suggester, add one to an [index definition](/rest/api/searchservice/indexes/create). A suggester takes a name and a collection of fields over which the typeahead experience is enabled. The best time to create a suggester is when you're also defining the field that uses it.
4343

4444
+ Use string fields only.
4545

@@ -82,7 +82,7 @@ As previously noted, analyzer choice impacts tokenization and prefixing. Conside
8282

8383
## Create using REST
8484

85-
In the REST API, add suggesters through [Create Index](/rest/api/searchservice/create-index) or [Update Index](/rest/api/searchservice/update-index).
85+
In the REST API, add suggesters through [Create Index](/rest/api/searchservice/indexes/create) or [Update Index](/rest/api/searchservice/indexes/create-or-update).
8686

8787
```json
8888
{

0 commit comments

Comments
 (0)