Skip to content

Commit a6a208a

Browse files
Merge pull request #7335 from HeidiSteen/heidist-0901
Bulk API version update
2 parents 9edbddb + 622a470 commit a6a208a

37 files changed

+124
-124
lines changed

articles/search/includes/quickstarts/full-text-powershell.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ To connect to your search service:
9292
1. Create a `$url` object that targets the indexes collection on your search service. Replace `<YOUR-SEARCH-SERVICE>` with the value you obtained in [Get endpoint](#get-endpoint).
9393
9494
```powershell
95-
$url = "<YOUR-SEARCH-SERVICE>/indexes?api-version=2024-07-01&`$select=name"
95+
$url = "<YOUR-SEARCH-SERVICE>/indexes?api-version=@search.rerankerBoostedScore&`$select=name"
9696
```
9797
9898
1. Run `Invoke-RestMethod` to send a GET request to your search service. Include `ConvertTo-Json` to view responses from the service.
@@ -152,7 +152,7 @@ To create an index:
152152
2. Update the `$url` object to target the new index. Replace `<YOUR-SEARCH-SERVICE>` with the value you obtained in [Get endpoint](#get-endpoint).
153153
154154
```powershell
155-
$url = "<YOUR-SEARCH-SERVICE>/indexes/hotels-quickstart?api-version=2024-07-01"
155+
$url = "<YOUR-SEARCH-SERVICE>/indexes/hotels-quickstart?api-version=@search.rerankerBoostedScore"
156156
```
157157
158158
3. Run `Invoke-RestMethod` to create the index on your search service.
@@ -275,7 +275,7 @@ To upload documents to your index:
275275
2. Update the `$url` object to target the indexing endpoint. Replace `<YOUR-SEARCH-SERVICE>` with the value you obtained in [Get endpoint](#get-endpoint).
276276
277277
```powershell
278-
$url = "<YOUR-SEARCH-SERVICE>/indexes/hotels-quickstart/docs/index?api-version=2024-07-01"
278+
$url = "<YOUR-SEARCH-SERVICE>/indexes/hotels-quickstart/docs/index?api-version=@search.rerankerBoostedScore"
279279
```
280280
281281
3. Run `Invoke-RestMethod` to send the upload request to your search service.
@@ -301,7 +301,7 @@ To run a full-text query against your index:
301301
1. Update the `$url` object to specify search parameters. Replace `<YOUR-SEARCH-SERVICE>` with the value you obtained in [Get endpoint](#get-endpoint).
302302
303303
```powershell
304-
$url = '<YOUR-SEARCH-SERVICE>/indexes/hotels-quickstart/docs?api-version=2024-07-01&search=attached restaurant&searchFields=Description,Tags&$select=HotelId,HotelName,Tags,Description&$count=true'
304+
$url = '<YOUR-SEARCH-SERVICE>/indexes/hotels-quickstart/docs?api-version=@search.rerankerBoostedScore&search=attached restaurant&searchFields=Description,Tags&$select=HotelId,HotelName,Tags,Description&$count=true'
305305
```
306306
307307
2. Run `Invoke-RestMethod` to send the query request to your search service.
@@ -344,20 +344,20 @@ Run the following commands to explore the query syntax. You can perform string s
344344
# Query example 1
345345
# Search the index for the terms 'restaurant' and 'wifi'
346346
# Return only the HotelName, Description, and Tags fields
347-
$url = '<YOUR-SEARCH-SERVICE>/indexes/hotels-quickstart/docs?api-version=2024-07-01&search=restaurant wifi&$count=true&$select=HotelName,Description,Tags'
347+
$url = '<YOUR-SEARCH-SERVICE>/indexes/hotels-quickstart/docs?api-version=@search.rerankerBoostedScore&search=restaurant wifi&$count=true&$select=HotelName,Description,Tags'
348348
349349
# Query example 2
350350
# Use a filter to find hotels rated 4 or higher
351351
# Return only the HotelName and Rating fields
352-
$url = '<YOUR-SEARCH-SERVICE>/indexes/hotels-quickstart/docs?api-version=2024-07-01&search=*&$filter=Rating gt 4&$select=HotelName,Rating'
352+
$url = '<YOUR-SEARCH-SERVICE>/indexes/hotels-quickstart/docs?api-version=@search.rerankerBoostedScore&search=*&$filter=Rating gt 4&$select=HotelName,Rating'
353353
354354
# Query example 3
355355
# Take the top two results
356356
# Return only the HotelName and Category fields
357-
$url = '<YOUR-SEARCH-SERVICE>/indexes/hotels-quickstart/docs?api-version=2024-07-01&search=boutique&$top=2&$select=HotelName,Category'
357+
$url = '<YOUR-SEARCH-SERVICE>/indexes/hotels-quickstart/docs?api-version=@search.rerankerBoostedScore&search=boutique&$top=2&$select=HotelName,Category'
358358
359359
# Query example 4
360360
# Sort by a specific field (Address/City) in ascending order
361361
# Return only the HotelName, Address/City, Tags, and Rating fields
362-
$url = '<YOUR-SEARCH-SERVICE>/indexes/hotels-quickstart/docs?api-version=2024-07-01&search=pool&$orderby=Address/City asc&$select=HotelName, Address/City, Tags, Rating'
362+
$url = '<YOUR-SEARCH-SERVICE>/indexes/hotels-quickstart/docs?api-version=@search.rerankerBoostedScore&search=pool&$orderby=Address/City asc&$select=HotelName, Address/City, Tags, Rating'
363363
```

articles/search/includes/quickstarts/full-text-rest.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ To set up your request file:
8989
@token = PUT-YOUR-PERSONAL-IDENTITY-TOKEN-HERE
9090
9191
### List existing indexes by name
92-
GET {{baseUrl}}/indexes?api-version=2024-07-01 HTTP/1.1
92+
GET {{baseUrl}}/indexes?api-version=@search.rerankerBoostedScore HTTP/1.1
9393
Authorization: Bearer {{token}}
9494
```
9595
@@ -111,7 +111,7 @@ To create an index:
111111
112112
```http
113113
### Create a new index
114-
POST {{baseUrl}}/indexes?api-version=2024-07-01 HTTP/1.1
114+
POST {{baseUrl}}/indexes?api-version=@search.rerankerBoostedScore HTTP/1.1
115115
Content-Type: application/json
116116
Authorization: Bearer {{token}}
117117
@@ -169,7 +169,7 @@ To upload documents to your index:
169169
170170
```http
171171
### Upload documents
172-
POST {{baseUrl}}/indexes/hotels-quickstart/docs/index?api-version=2024-07-01 HTTP/1.1
172+
POST {{baseUrl}}/indexes/hotels-quickstart/docs/index?api-version=@search.rerankerBoostedScore HTTP/1.1
173173
Content-Type: application/json
174174
Authorization: Bearer {{token}}
175175
@@ -275,7 +275,7 @@ To run a full-text query against your index:
275275
276276
```http
277277
### Run a query
278-
POST {{baseUrl}}/indexes/hotels-quickstart/docs/search?api-version=2024-07-01 HTTP/1.1
278+
POST {{baseUrl}}/indexes/hotels-quickstart/docs/search?api-version=@search.rerankerBoostedScore HTTP/1.1
279279
Content-Type: application/json
280280
Authorization: Bearer {{token}}
281281

articles/search/includes/quickstarts/search-get-started-rbac-rest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ To connect using REST:
7575
@token = PUT-YOUR-PERSONAL-IDENTITY-TOKEN-HERE
7676
7777
### List existing indexes
78-
GET {{baseUrl}}/indexes?api-version=2024-07-01 HTTP/1.1
78+
GET {{baseUrl}}/indexes?api-version=@search.rerankerBoostedScore HTTP/1.1
7979
Content-Type: application/json
8080
Authorization: Bearer {{token}}
8181
```

articles/search/includes/quickstarts/search-get-started-vector-rest.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ The index schema in this example is organized around hotel content. Sample data
109109

110110
```http
111111
### Create a new index
112-
POST {{baseUrl}}/indexes?api-version=2024-07-01 HTTP/1.1
112+
POST {{baseUrl}}/indexes?api-version=@search.rerankerBoostedScore HTTP/1.1
113113
Content-Type: application/json
114114
Authorization: Bearer {{token}}
115115
@@ -402,7 +402,7 @@ In Azure AI Search, the index contains all searchable data and queries run on th
402402
403403
```http
404404
### Upload documents
405-
POST {{baseUrl}}/indexes/hotels-quickstart-vectors/docs/index?api-version=2024-07-01 HTTP/1.1
405+
POST {{baseUrl}}/indexes/hotels-quickstart-vectors/docs/index?api-version=@search.rerankerBoostedScore HTTP/1.1
406406
Content-Type: application/json
407407
Authorization: Bearer {{token}}
408408
@@ -673,7 +673,7 @@ The vector query string is semantically similar to the search string, but it inc
673673
674674
```http
675675
### Run a single vector query
676-
POST {{baseUrl}}/indexes/hotels-vector-quickstart/docs/search?api-version=2024-07-01 HTTP/1.1
676+
POST {{baseUrl}}/indexes/hotels-vector-quickstart/docs/search?api-version=@search.rerankerBoostedScore HTTP/1.1
677677
Content-Type: application/json
678678
Authorization: Bearer {{token}}
679679
@@ -784,7 +784,7 @@ You can add filters, but the filters are applied to the nonvector content in you
784784
785785
```http
786786
### Run a vector query with a filter
787-
POST {{baseUrl}}/indexes/hotels-vector-quickstart/docs/search?api-version=2024-07-01 HTTP/1.1
787+
POST {{baseUrl}}/indexes/hotels-vector-quickstart/docs/search?api-version=@search.rerankerBoostedScore HTTP/1.1
788788
Content-Type: application/json
789789
Authorization: Bearer {{token}}
790790
@@ -847,7 +847,7 @@ You can add filters, but the filters are applied to the nonvector content in you
847847
848848
```http
849849
### Run a vector query with a geo filter
850-
POST {{baseUrl}}/indexes/hotels-vector-quickstart/docs/search?api-version=2024-07-01 HTTP/1.1
850+
POST {{baseUrl}}/indexes/hotels-vector-quickstart/docs/search?api-version=@search.rerankerBoostedScore HTTP/1.1
851851
Content-Type: application/json
852852
Authorization: Bearer {{token}}
853853
@@ -917,7 +917,7 @@ Hybrid search consists of keyword queries and vector queries in a single search
917917
918918
```http
919919
### Run a hybrid query
920-
POST {{baseUrl}}/indexes/hotels-vector-quickstart/docs/search?api-version=2024-07-01 HTTP/1.1
920+
POST {{baseUrl}}/indexes/hotels-vector-quickstart/docs/search?api-version=@search.rerankerBoostedScore HTTP/1.1
921921
Content-Type: application/json
922922
Authorization: Bearer {{token}}
923923
@@ -1033,7 +1033,7 @@ Here's the last query in the collection. This hybrid query adds L2 semantic rank
10331033
10341034
```http
10351035
### Run a hybrid query with semantic reranking
1036-
POST {{baseUrl}}/indexes/hotels-vector-quickstart/docs/search?api-version=2024-07-01 HTTP/1.1
1036+
POST {{baseUrl}}/indexes/hotels-vector-quickstart/docs/search?api-version=@search.rerankerBoostedScore HTTP/1.1
10371037
Content-Type: application/json
10381038
Authorization: Bearer {{token}}
10391039
@@ -1127,7 +1127,7 @@ If you want to keep the search service, but delete the index and documents, you
11271127
11281128
```http
11291129
### Delete an index
1130-
DELETE {{baseUrl}}/indexes/hotels-vector-quickstart?api-version=2024-07-01 HTTP/1.1
1130+
DELETE {{baseUrl}}/indexes/hotels-vector-quickstart?api-version=@search.rerankerBoostedScore HTTP/1.1
11311131
Content-Type: application/json
11321132
Authorization: Bearer {{token}}
11331133
```

articles/search/includes/tutorials/skillset-rest.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Call [Create Data Source](/rest/api/searchservice/data-sources/create) to set th
9797
9898
```http
9999
### Create a data source
100-
POST {{baseUrl}}/datasources?api-version=2024-07-01 HTTP/1.1
100+
POST {{baseUrl}}/datasources?api-version=@search.rerankerBoostedScore HTTP/1.1
101101
Content-Type: application/json
102102
api-key: {{apiKey}}
103103
@@ -124,7 +124,7 @@ Call [Create Skillset](/rest/api/searchservice/skillsets/create) to specify whic
124124

125125
```http
126126
### Create a skillset
127-
POST {{baseUrl}}/skillsets?api-version=2024-07-01 HTTP/1.1
127+
POST {{baseUrl}}/skillsets?api-version=@search.rerankerBoostedScore HTTP/1.1
128128
Content-Type: application/json
129129
api-key: {{apiKey}}
130130
@@ -313,7 +313,7 @@ The largest component of an index is the fields collection, where data type and
313313

314314
```http
315315
### Create an index
316-
POST {{baseUrl}}/indexes?api-version=2024-07-01 HTTP/1.1
316+
POST {{baseUrl}}/indexes?api-version=@search.rerankerBoostedScore HTTP/1.1
317317
Content-Type: application/json
318318
api-key: {{apiKey}}
319319
@@ -406,7 +406,7 @@ Expect this step to take several minutes to complete. Even though the data set i
406406

407407
```http
408408
### Create and run an indexer
409-
POST {{baseUrl}}/indexers?api-version=2024-07-01 HTTP/1.1
409+
POST {{baseUrl}}/indexers?api-version=@search.rerankerBoostedScore HTTP/1.1
410410
Content-Type: application/json
411411
api-key: {{apiKey}}
412412
@@ -497,7 +497,7 @@ To find out whether the indexer is still running, call [Get Indexer Status](/res
497497

498498
```http
499499
### Get Indexer Status (wait several minutes for the indexer to complete)
500-
GET {{baseUrl}}/indexers/cog-search-demo-idxr/status?api-version=2024-07-01 HTTP/1.1
500+
GET {{baseUrl}}/indexers/cog-search-demo-idxr/status?api-version=@search.rerankerBoostedScore HTTP/1.1
501501
Content-Type: application/json
502502
api-key: {{apiKey}}
503503
```
@@ -514,7 +514,7 @@ Now that you've created an index that contains AI-generated content, call [Searc
514514

515515
```http
516516
### Query the index\
517-
POST {{baseUrl}}/indexes/cog-search-demo-idx/docs/search?api-version=2024-07-01 HTTP/1.1
517+
POST {{baseUrl}}/indexes/cog-search-demo-idx/docs/search?api-version=@search.rerankerBoostedScore HTTP/1.1
518518
Content-Type: application/json
519519
api-key: {{apiKey}}
520520
@@ -529,7 +529,7 @@ Filters can help you narrow results to items of interest:
529529

530530
```http
531531
### Filter by organization
532-
POST {{baseUrl}}/indexes/cog-search-demo-idx/docs/search?api-version=2024-07-01 HTTP/1.1
532+
POST {{baseUrl}}/indexes/cog-search-demo-idx/docs/search?api-version=@search.rerankerBoostedScore HTTP/1.1
533533
Content-Type: application/json
534534
api-key: {{apiKey}}
535535

articles/search/search-howto-managed-identities-storage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ For connections made using a system-assigned managed identity, the only change t
7474
Provide a connection string that contains a `ResourceId`, with no account key or password. The `ResourceId` must include the subscription ID of the storage account, the resource group of the storage account, and the storage account name.
7575

7676
```http
77-
POST https://[service name].search.windows.net/datasources?api-version=2024-07-01
77+
POST https://[service name].search.windows.net/datasources?api-version=@search.rerankerBoostedScore
7878
7979
{
8080
"name" : "blob-datasource",

articles/search/search-howto-powerapps.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ A connector in Power Apps is a data source connection. In this step, create a cu
7474
* For the URL, enter a sample query for your search index (`search=*` returns all documents, `$select=` lets you choose fields). The API version is required. Fully specified, a URL might look like the following example. Notice that the `https://` prefix is omitted.
7575

7676
```http
77-
mydemo.search.windows.net/indexes/hotels-sample-index/docs?search=*&$select=HotelName,Description,Address/City&api-version=2024-07-01
77+
mydemo.search.windows.net/indexes/hotels-sample-index/docs?search=*&$select=HotelName,Description,Address/City&api-version=@search.rerankerBoostedScore
7878
```
7979
8080
* For Headers, type `Content-Type application/json`.
@@ -95,7 +95,7 @@ A connector in Power Apps is a data source connection. In this step, create a cu
9595
9696
:::image type="content" source="./media/search-howto-powerapps/1-10-4-parameter-metadata-select.png" alt-text="Select parameter metadata" border="true":::
9797
98-
1. For *api-version*: Set `2024-07-01` as the **default value**, set **required** to *True*, and set **visibility** as *internal*.
98+
1. For *api-version*: Set `@search.rerankerBoostedScore` as the **default value**, set **required** to *True*, and set **visibility** as *internal*.
9999
100100
:::image type="content" source="./media/search-howto-powerapps/1-10-2-parameter-metadata-version.png" alt-text="Version parameter metadata" border="true":::
101101
@@ -107,7 +107,7 @@ A connector in Power Apps is a data source connection. In this step, create a cu
107107
parameters:
108108
- {name: search, in: query, required: false, type: string, default: '*'}
109109
- {name: $select, in: query, required: false, type: string, default: 'HotelName,Description,Address/City'}
110-
- {name: api-version, in: query, required: true, type: string, default: '2024-07-01',
110+
- {name: api-version, in: query, required: true, type: string, default: '@search.rerankerBoostedScore',
111111
x-ms-visibility: internal}
112112
- {name: Content-Type, in: header, required: false, type: string}
113113
```

articles/search/search-howto-reindex.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -161,12 +161,12 @@ Here's a [REST API example](search-get-started-text.md) demonstrating these tips
161161

162162
```rest
163163
### Get Stay-Kay City Hotel by ID
164-
GET {{baseUrl}}/indexes/hotels-vector-quickstart/docs('1')?api-version=2024-07-01 HTTP/1.1
164+
GET {{baseUrl}}/indexes/hotels-vector-quickstart/docs('1')?api-version=@search.rerankerBoostedScore HTTP/1.1
165165
Content-Type: application/json
166166
api-key: {{apiKey}}
167167
168168
### Change the description, city, and tags for Stay-Kay City Hotel
169-
POST {{baseUrl}}/indexes/hotels-vector-quickstart/docs/search.index?api-version=2024-07-01 HTTP/1.1
169+
POST {{baseUrl}}/indexes/hotels-vector-quickstart/docs/search.index?api-version=@search.rerankerBoostedScore HTTP/1.1
170170
Content-Type: application/json
171171
api-key: {{apiKey}}
172172
@@ -185,7 +185,7 @@ POST {{baseUrl}}/indexes/hotels-vector-quickstart/docs/search.index?api-version=
185185
}
186186
187187
### Retrieve the same document, confirm the overwrites and retention of all other values
188-
GET {{baseUrl}}/indexes/hotels-vector-quickstart/docs('1')?api-version=2024-07-01 HTTP/1.1
188+
GET {{baseUrl}}/indexes/hotels-vector-quickstart/docs('1')?api-version=@search.rerankerBoostedScore HTTP/1.1
189189
Content-Type: application/json
190190
api-key: {{apiKey}}
191191
```
@@ -329,17 +329,17 @@ Deleting a document doesn't immediately free up space in the index. Every few mi
329329
1. [Look up the document](/rest/api/searchservice/documents/get) to verify the value of the document ID and to review its content before deleting it. Specify the key or document ID in the request. The following examples illustrate a simple string for the [Hotels sample index](search-get-started-portal.md) and a base-64 encoded string for the metadata_storage_path key of the [cog-search-demo index](tutorial-skillset.md).
330330

331331
```http
332-
GET https://[service name].search.windows.net/indexes/hotel-sample-index/docs/1111?api-version=2024-07-01
332+
GET https://[service name].search.windows.net/indexes/hotel-sample-index/docs/1111?api-version=@search.rerankerBoostedScore
333333
```
334334
335335
```http
336-
GET https://[service name].search.windows.net/indexes/cog-search-demo/docs/aHR0cHM6Ly9oZWlkaWJsb2JzdG9yYWdlMi5ibG9iLmNvcmUud2luZG93cy5uZXQvY29nLXNlYXJjaC1kZW1vL2d1dGhyaWUuanBn0?api-version=2024-07-01
336+
GET https://[service name].search.windows.net/indexes/cog-search-demo/docs/aHR0cHM6Ly9oZWlkaWJsb2JzdG9yYWdlMi5ibG9iLmNvcmUud2luZG93cy5uZXQvY29nLXNlYXJjaC1kZW1vL2d1dGhyaWUuanBn0?api-version=@search.rerankerBoostedScore
337337
```
338338
339339
1. [Delete the document](/rest/api/searchservice/documents) using a delete `@search.action` to remove it from the search index.
340340
341341
```http
342-
POST https://[service name].search.windows.net/indexes/hotels-sample-index/docs/index?api-version=2024-07-01
342+
POST https://[service name].search.windows.net/indexes/hotels-sample-index/docs/index?api-version=@search.rerankerBoostedScore
343343
Content-Type: application/json
344344
api-key: [admin key]
345345
{

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Switch to the **Indexer Definition (JSON)** tab at the top of the index to view
7171
1. Set the schedule property in the body of the request:
7272

7373
```http
74-
PUT /indexers/<indexer-name>?api-version=2024-07-01
74+
PUT /indexers/<indexer-name>?api-version=@search.rerankerBoostedScore
7575
{
7676
"dataSourceName" : "myazuresqldatasource",
7777
"targetIndexName" : "my-target-index-name",

articles/search/search-index-azure-sql-managed-instance-with-managed-identity.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ When you're connecting with a system-assigned managed identity, the only change
101101
Here's an example of how to create a data source to index data from a storage account using the [Create Data Source](/rest/api/searchservice/data-sources/create) REST API and a managed identity connection string. The managed identity connection string format is the same for the REST API, .NET SDK, and the Azure portal.
102102

103103
```http
104-
POST https://[service name].search.windows.net/datasources?api-version=2024-07-01
104+
POST https://[service name].search.windows.net/datasources?api-version=@search.rerankerBoostedScore
105105
Content-Type: application/json
106106
api-key: [admin key]
107107
@@ -124,7 +124,7 @@ The index specifies the fields in a document, attributes, and other constructs t
124124
Here's a [Create Index](/rest/api/searchservice/indexes/create) REST API call with a searchable `booktitle` field:
125125
126126
```http
127-
POST https://[service name].search.windows.net/indexes?api-version=2024-07-01
127+
POST https://[service name].search.windows.net/indexes?api-version=@search.rerankerBoostedScore
128128
Content-Type: application/json
129129
api-key: [admin key]
130130
@@ -144,7 +144,7 @@ An indexer connects a data source with a target search index, and provides a sch
144144
Here's a [Create Indexer](/rest/api/searchservice/indexers/create) REST API call with an Azure SQL indexer definition. The indexer runs when you submit the request.
145145
146146
```http
147-
POST https://[service name].search.windows.net/indexers?api-version=2024-07-01
147+
POST https://[service name].search.windows.net/indexers?api-version=@search.rerankerBoostedScore
148148
Content-Type: application/json
149149
api-key: [admin key]
150150

0 commit comments

Comments
 (0)