Skip to content

Commit aa5147b

Browse files
committed
API references and links
1 parent facfc86 commit aa5147b

10 files changed

+45
-45
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ The following example illustrates a resource log that includes common properties
159159
| Resource | String | Resource ID. For example: `/subscriptions/<your-subscription-id>/resourceGroups/<your-resource-group-name>/providers/Microsoft.Search/searchServices/<your-search-service-name>` |
160160
| Category | String | "OperationLogs". This value is a constant. OperationLogs is the only category used for resource logs. |
161161
| OperationName | String | The name of the operation (see the [full list of operations](#resource-log-search-ops)). An example is `Query.Search` |
162-
| OperationVersion | String | The api-version used on the request. For example: `2020-06-30` |
162+
| OperationVersion | String | The api-version used on the request. For example: `2023-11-01` |
163163
| ResultType | String |"Success". Other possible values: Success or Failure |
164164
| ResultSignature | Int | An HTTP result code. For example: `200` |
165165
| DurationMS | Int | Duration of the operation in milliseconds. |
@@ -176,7 +176,7 @@ The following properties are specific to Azure AI Search.
176176
| Description_s | String | The operation's endpoint. For example: `GET /indexes('content')/docs` |
177177
| Documents_d | Int | Number of documents processed. |
178178
| IndexName_s | String | Name of the index associated with the operation. |
179-
| Query_s | String | The query parameters used in the request. For example: `?search=beach access&$count=true&api-version=2020-06-30` |
179+
| Query_s | String | The query parameters used in the request. For example: `?search=beach access&$count=true&api-version=2023-11-01` |
180180

181181
<a name="resource-log-search-ops"></a>
182182

articles/search/query-simple-syntax.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Although the simple parser is based on the [Apache Lucene Simple Query Parser](h
2828
This example shows a simple query, distinguished by `"queryType": "simple"` and valid syntax. Although query type is set below, it's the default and can be omitted unless you're reverting from an alternative type. The following example is a search over independent terms, with a requirement that all matching documents include "pool".
2929

3030
```http
31-
POST https://{{service-name}}.search.windows.net/indexes/hotel-rooms-sample/docs/search?api-version=2020-06-30
31+
POST https://{{service-name}}.search.windows.net/indexes/hotel-rooms-sample/docs/search?api-version=2023-11-01
3232
{
3333
"queryType": "simple",
3434
"search": "budget hotel +pool",

articles/search/search-howto-index-json-blobs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.service: cognitive-search
1111
ms.custom:
1212
- ignite-2023
1313
ms.topic: how-to
14-
ms.date: 04/22/2024
14+
ms.date: 06/25/2024
1515
---
1616

1717
# Index JSON blobs and files in Azure AI Search
@@ -63,7 +63,7 @@ The blob indexer parses the JSON document into a single search document, loading
6363
Although the default behavior is one search document per JSON blob, setting the **`json`** parsing mode changes the internal field mappings for content, promoting fields inside `content` to actual fields in the search index. An example indexer definition for the **`json`** parsing mode might look like this:
6464

6565
```http
66-
POST https://[service name].search.windows.net/indexers?api-version=2020-06-30
66+
POST https://[service name].search.windows.net/indexers?api-version=2023-11-01
6767
Content-Type: application/json
6868
api-key: [admin key]
6969
@@ -102,7 +102,7 @@ Alternatively, you can use the JSON array option. This option is useful when blo
102102
The `parameters` property on the indexer contains parsing mode values. For a JSON array, the indexer definition should look similar to the following example.
103103

104104
```http
105-
POST https://[service name].search.windows.net/indexers?api-version=2020-06-30
105+
POST https://[service name].search.windows.net/indexers?api-version=2023-11-01
106106
Content-Type: application/json
107107
api-key: [admin key]
108108
@@ -161,7 +161,7 @@ If your blob contains multiple JSON entities separated by a newline, and you wan
161161
For JSON lines, the indexer definition should look similar to the following example.
162162

163163
```http
164-
POST https://[service name].search.windows.net/indexers?api-version=2020-06-30
164+
POST https://[service name].search.windows.net/indexers?api-version=2023-11-01
165165
Content-Type: application/json
166166
api-key: [admin key]
167167

articles/search/search-howto-index-mysql.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ ms.topic: how-to
1212
ms.custom:
1313
- kr2b-contr-experiment
1414
- ignite-2023
15-
ms.date: 03/08/2024
15+
ms.date: 06/25/2024
1616
---
1717

1818
# Index data from Azure Database for MySQL flexible server
1919

2020
> [!IMPORTANT]
21-
> MySQL support is currently in public preview under [Supplemental Terms of Use](https://azure.microsoft.com/support/legal/preview-supplemental-terms/). Use a [preview REST API](search-api-preview.md) (2020-06-30-preview or later) to index your content. There is currently no portal support.
21+
> MySQL support is currently in public preview under [Supplemental Terms of Use](https://azure.microsoft.com/support/legal/preview-supplemental-terms/). You can use 2020-06-30-preview or later to index your content. We recommend the latest preview API. There is currently no portal support.
2222
2323
In this article, learn how to configure an [**indexer**](search-indexer-overview.md) that imports content from Azure Database for MySQL and makes it searchable in Azure AI Search. Inputs to the indexer are your row, in a single table or view. Output is a search index with searchable content in individual fields.
2424

@@ -50,7 +50,7 @@ As noted, there’s no portal support for indexer creation, but a MySQL indexer
5050

5151
The data source definition specifies the data to index, credentials, and policies for identifying changes in the data. The data source is defined as an independent resource so that it can be used by multiple indexers.
5252

53-
[Create or Update Data Source](/rest/api/searchservice/create-data-source) specifies the definition. Be sure to use a preview REST API version (2020-06-30-Preview or later) when creating the data source.
53+
[Create or Update Data Source](/rest/api/searchservice/data-sources/create?view=rest-searchservice-2024-05-01-preview&preserve-view=true) specifies the definition. Be sure to use a preview REST API when creating the data source.
5454

5555
```http
5656
{
@@ -85,7 +85,7 @@ The data source definition specifies the data to index, credentials, and policie
8585

8686
## Create an index
8787

88-
[Create or Update Index](/rest/api/searchservice/create-index) specifies the index schema:
88+
[Create or Update Index](/rest/api/searchservice/indexes/create?view=rest-searchservice-2024-05-01-preview&preserve-view=true) specifies the index schema:
8989

9090
```http
9191
{
@@ -125,7 +125,7 @@ The following table maps the MySQL database to Azure AI Search equivalents. For
125125

126126
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.
127127

128-
[Create or update an indexer](/rest/api/searchservice/create-indexer) by giving it a name and referencing the data source and target index:
128+
[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:
129129

130130
```http
131131
{
@@ -154,10 +154,10 @@ Once the index and data source have been created, you're ready to create the ind
154154

155155
## Check indexer status
156156

157-
Send a [Get Indexer Status](/rest/api/searchservice/get-indexer-status) request to monitor indexer execution:
157+
Send a [Get Indexer Status](/rest/api/searchservice/indexers/get-status?view=rest-searchservice-2024-05-01-preview&preserve-view=true) request to monitor indexer execution:
158158

159159
```http
160-
GET https://myservice.search.windows.net/indexers/myindexer/status?api-version=2023-11-01
160+
GET https://myservice.search.windows.net/indexers/myindexer/status?api-version=2024-05-01-preview
161161
Content-Type: application/json
162162
api-key: [admin key]
163163
```

articles/search/search-howto-indexing-azure-blob-storage.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.service: cognitive-search
1010
ms.custom:
1111
- ignite-2023
1212
ms.topic: how-to
13-
ms.date: 06/17/2024
13+
ms.date: 06/25/2024
1414
---
1515

1616
# Index data from Azure Blob Storage
@@ -103,7 +103,7 @@ Currently, indexing [blob index tags](../storage/blobs/storage-blob-index-how-to
103103

104104
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.
105105

106-
1. [Create or update a data source](/rest/api/searchservice/create-data-source) to set its definition:
106+
1. [Create or update a data source](/rest/api/searchservice/data-sources/create-or-update) to set its definition:
107107

108108
```json
109109
{
@@ -155,10 +155,10 @@ Indexers can connect to a blob container using the following connections.
155155

156156
In a [search index](search-what-is-an-index.md), add fields to accept the content and metadata of your Azure blobs.
157157

158-
1. [Create or update an index](/rest/api/searchservice/create-index) to define search fields that will store blob content and metadata:
158+
1. [Create or update an index](/rest/api/searchservice/indexes/create-or-update) to define search fields that will store blob content and metadata:
159159

160160
```http
161-
POST https://[service name].search.windows.net/indexes?api-version=2020-06-30
161+
POST https://[service name].search.windows.net/indexes?api-version=2023-11-01
162162
{
163163
"name" : "my-search-index",
164164
"fields": [
@@ -191,10 +191,10 @@ In a [search index](search-what-is-an-index.md), add fields to accept the conten
191191

192192
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. You can also specify which parts of a blob to index.
193193

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

196196
```http
197-
POST https://[service name].search.windows.net/indexers?api-version=2020-06-30
197+
POST https://[service name].search.windows.net/indexers?api-version=2023-11-01
198198
{
199199
"name" : "my-blob-indexer",
200200
"dataSourceName" : "my-blob-datasource",
@@ -239,7 +239,7 @@ Once the index and data source have been created, you're ready to create the ind
239239

240240
In blob 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 will automatically replace hyphens `-` with underscores in the search index.
241241

242-
1. See [Create an indexer](search-howto-create-indexers.md) for more information about other properties. For the full list of parameter descriptions, see [Blob configuration parameters](/rest/api/searchservice/create-indexer#blob-configuration-parameters) in the REST API.
242+
1. See [Create an indexer](search-howto-create-indexers.md) for more information about other properties. For the full list of parameter descriptions, see [REST API](/rest/api/searchservice/indexers/create).
243243

244244
An indexer runs automatically when it's created. You can prevent this 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).
245245

@@ -300,10 +300,10 @@ POST https://[service name].search.windows.net/indexers?api-version=2023-11-01
300300

301301
## Check indexer status
302302

303-
To monitor the indexer status and execution history, send a [Get Indexer Status](/rest/api/searchservice/get-indexer-status) request:
303+
To monitor the indexer status and execution history, send a [Get Indexer Status](/rest/api/searchservice/indexers/get-status) request:
304304

305305
```http
306-
GET https://myservice.search.windows.net/indexers/myindexer/status?api-version=2020-06-30
306+
GET https://myservice.search.windows.net/indexers/myindexer/status?api-version=2023-11-01
307307
Content-Type: application/json
308308
api-key: [admin key]
309309
```
@@ -355,7 +355,7 @@ By default, the blob indexer stops as soon as it encounters a blob with an unsup
355355
There are five indexer properties that control the indexer's response when errors occur.
356356

357357
```http
358-
PUT /indexers/[indexer name]?api-version=2020-06-30
358+
PUT /indexers/[indexer name]?api-version=2023-11-01
359359
{
360360
"parameters" : {
361361
"maxFailedItems" : 10,

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.custom:
1111
- devx-track-dotnet
1212
- ignite-2023
1313
ms.topic: conceptual
14-
ms.date: 01/18/2024
14+
ms.date: 06/25/2024
1515
---
1616

1717
# Monitor indexer status and results in Azure AI Search
@@ -66,10 +66,10 @@ You can also configure the graph to see the number of skill invocations over the
6666

6767
## Monitor using Get Indexer Status (REST API)
6868

69-
You can retrieve the status and execution history of an indexer using the [Get Indexer Status command](/rest/api/searchservice/get-indexer-status):
69+
You can retrieve the status and execution history of an indexer using the [Get Indexer Status command](/rest/api/searchservice/indexers/get-status):
7070

7171
```http
72-
GET https://[service name].search.windows.net/indexers/[indexer name]/status?api-version=2020-06-30
72+
GET https://[service name].search.windows.net/indexers/[indexer name]/status?api-version=2023-11-01
7373
api-key: [Search service admin key]
7474
```
7575

@@ -111,7 +111,7 @@ Each run of the indexer also has its own status that indicates whether that spec
111111

112112
When an indexer is reset to refresh its change tracking state, a separate execution history entry is added with a **Reset** status.
113113

114-
For more information about status codes and indexer monitoring data, see [Get Indexer Status](/rest/api/searchservice/get-indexer-status).
114+
For more information about status codes and indexer monitoring data, see [Get Indexer Status](/rest/api/searchservice/indexers/get-status).
115115

116116
## Monitor using .NET
117117

@@ -171,7 +171,7 @@ When an indexer is reset to refresh its change tracking state, a separate histor
171171

172172
For more information about status codes and indexer monitoring information, see the following API reference:
173173

174-
* [GetIndexerStatus (REST API)](/rest/api/searchservice/get-indexer-status)
174+
* [Indexers - Get Status (REST API)](//rest/api/searchservice/indexers/get-status)
175175
* [IndexerStatus](/dotnet/api/azure.search.documents.indexes.models.indexerstatus)
176176
* [IndexerExecutionStatus](/dotnet/api/azure.search.documents.indexes.models.indexerexecutionstatus)
177177
* [IndexerExecutionResult](/dotnet/api/azure.search.documents.indexes.models.indexerexecutionresult)

articles/search/search-howto-run-reset-indexers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ catch (RequestFailedException ex) when (ex.Status == 429)
171171

172172
For indexers that have skillsets, you can reset individual skills to force processing of just that skill and any downstream skills that depend on its output. The [enrichment cache](search-howto-incremental-index.md), if you enabled it, is also refreshed.
173173

174-
[Reset Skills](/rest/api/searchservice/skillsets/reset-skills?view=rest-searchservice-2024-05-01-preview&preserve-view=true) is currently REST-only, available through `api-version=2020-06-30-Preview` or later. We recommend the latest preview API.
174+
[Reset Skills](/rest/api/searchservice/skillsets/reset-skills?view=rest-searchservice-2024-05-01-preview&preserve-view=true) is currently REST-only, available through 2020-06-30-preview or later. We recommend the latest preview API.
175175

176176
```http
177177
POST /skillsets/[skillset name]/resetskills?api-version=2024-05-01-preview

articles/search/search-indexer-field-mappings.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.service: cognitive-search
1111
ms.custom:
1212
- ignite-2023
1313
ms.topic: conceptual
14-
ms.date: 06/14/2024
14+
ms.date: 06/25/2024
1515
---
1616

1717
# Field mappings and transformations using Azure AI Search indexers
@@ -74,7 +74,7 @@ You can use the REST API or an Azure SDK to define field mappings.
7474

7575
### [**REST APIs**](#tab/rest)
7676

77-
Use [Create Indexer (REST)](/rest/api/searchservice/create-Indexer) or [Update Indexer (REST)](/rest/api/searchservice/update-indexer), any API version.
77+
Use [Create Indexer (REST)](/rest/api/searchservice/indexers/create) or [Update Indexer (REST)](/rest/api/searchservice/indexers/create-or-update), any API version.
7878

7979
This example handles a field name discrepancy.
8080

@@ -146,12 +146,12 @@ Performs *URL-safe* Base64 encoding of the input string. Assumes that the input
146146

147147
#### Example: Base-encoding a document key
148148

149-
Only URL-safe characters can appear in an Azure AI Search document key (so that you can address the document using the [Lookup API](/rest/api/searchservice/lookup-document)). If the source field for your key contains URL-unsafe characters, such as `-` and `\`, use the `base64Encode` function to convert it at indexing time.
149+
Only URL-safe characters can appear in an Azure AI Search document key (so that you can address the document using the [Lookup API](/rest/api/searchservice/documents/get)). If the source field for your key contains URL-unsafe characters, such as `-` and `\`, use the `base64Encode` function to convert it at indexing time.
150150

151151
The following example specifies the base64Encode function on `metadata_storage_name` to handle unsupported characters.
152152

153153
```http
154-
PUT /indexers?api-version=2020-06-30
154+
PUT /indexers?api-version=2023-11-01
155155
{
156156
"dataSourceName" : "my-blob-datasource ",
157157
"targetIndexName" : "my-search-index",
@@ -175,7 +175,7 @@ A document key (both before and after conversion) can't be longer than 1,024 cha
175175
There are times when you need to use an encoded version of a field like `metadata_storage_path` as the key, but also need an unencoded version for full text search. To support both scenarios, you can map `metadata_storage_path` to two fields: one for the key (encoded), and a second for a path field that we can assume is attributed as `searchable` in the index schema.
176176

177177
```http
178-
PUT /indexers/blob-indexer?api-version=2020-06-30
178+
PUT /indexers/blob-indexer?api-version=2023-11-01
179179
{
180180
"dataSourceName" : " blob-datasource ",
181181
"targetIndexName" : "my-target-index",

0 commit comments

Comments
 (0)