Skip to content

Commit 0a8ec94

Browse files
Merge pull request #7332 from HeidiSteen/heidist-0901
bulk API version change
2 parents 64a9226 + f31e005 commit 0a8ec94

10 files changed

+21
-21
lines changed

articles/search/cognitive-search-attach-cognitive-services.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ Enrichments are billable operations. If you no longer need to call Azure AI serv
235235
1. Remove the key in the body of the definition, and then send the request:
236236

237237
```http
238-
PUT https://[servicename].search.windows.net/skillsets/[skillset name]?api-version=2024-07-01
238+
PUT https://[servicename].search.windows.net/skillsets/[skillset name]?api-version=@search.rerankerBoostedScore
239239
api-key: [admin key]
240240
Content-Type: application/json
241241
{

articles/search/hybrid-search-how-to-query.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ The following example shows a hybrid query request using the REST API.
105105
This example is from the [vector quickstart](https://raw.githubusercontent.com/Azure-Samples/azure-search-rest-samples/refs/heads/main/Quickstart-vectors/az-search-quickstart-vectors.rest) that has vector and nonvector content, and several query examples. For brevity, the vector is truncated in this article.
106106

107107
```http
108-
POST https://{{search-service-name}}.search.windows.net/indexes/{{index-name}}/docs/search?api-version=2024-07-01
108+
POST https://{{search-service-name}}.search.windows.net/indexes/{{index-name}}/docs/search?api-version=@search.rerankerBoostedScore
109109
Content-Type: application/json
110110
api-key: {{admin-api-key}}
111111
{
@@ -240,7 +240,7 @@ This section has multiple query examples that illustrate hybrid query patterns.
240240
This example adds a filter, which is applied to the `filterable` nonvector fields of the search index.
241241

242242
```http
243-
POST https://{{search-service-name}}.search.windows.net/indexes/{{index-name}}/docs/search?api-version=2024-07-01
243+
POST https://{{search-service-name}}.search.windows.net/indexes/{{index-name}}/docs/search?api-version=@search.rerankerBoostedScore
244244
Content-Type: application/json
245245
api-key: {{admin-api-key}}
246246
{
@@ -324,7 +324,7 @@ Assuming that you [have semantic ranker](semantic-how-to-enable-disable.md) and
324324
Whenever you use semantic ranking with vectors, make sure `k` is set to 50. Semantic ranker uses up to 50 matches as input. Specifying less than 50 deprives the semantic ranking models of necessary inputs.
325325

326326
```http
327-
POST https://{{search-service-name}}.search.windows.net/indexes/{{index-name}}/docs/search?api-version=2024-07-01
327+
POST https://{{search-service-name}}.search.windows.net/indexes/{{index-name}}/docs/search?api-version=@search.rerankerBoostedScore
328328
Content-Type: application/json
329329
api-key: {{admin-api-key}}
330330
{
@@ -365,7 +365,7 @@ api-key: {{admin-api-key}}
365365
Here's the last query in the collection. It's the same semantic hybrid query as the previous example, but with a filter.
366366

367367
```http
368-
POST https://{{search-service-name}}.search.windows.net/indexes/{{index-name}}/docs/search?api-version=2024-07-01
368+
POST https://{{search-service-name}}.search.windows.net/indexes/{{index-name}}/docs/search?api-version=@search.rerankerBoostedScore
369369
Content-Type: application/json
370370
api-key: {{admin-api-key}}
371371
{

articles/search/hybrid-search-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Hybrid search is predicated on having a search index that contains fields of var
3434
A representative hybrid query might be as follows (notice that the vector queries have placeholder values for brevity):
3535

3636
```http
37-
POST https://{{searchServiceName}}.search.windows.net/indexes/hotels-vector-quickstart/docs/search?api-version=2024-07-01
37+
POST https://{{searchServiceName}}.search.windows.net/indexes/hotels-vector-quickstart/docs/search?api-version=@search.rerankerBoostedScore
3838
content-type: application/JSON
3939
{
4040
"count": true,

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ The following definition shows a simple profile named "geo". This example boosts
7777
To use this scoring profile, your query is formulated to specify `scoringProfile` parameter in the request. If you're using the REST API, queries are specified through GET and POST requests. In the following example, "currentLocation" has a delimiter of a single dash (`-`). It's followed by longitude and latitude coordinates, where longitude is a negative value.
7878

7979
```http
80-
POST /indexes/hotels/docs&api-version=2024-07-01
80+
POST /indexes/hotels/docs&api-version=@search.rerankerBoostedScore
8181
{
8282
"search": "inn",
8383
"scoringProfile": "geo",

articles/search/index-add-suggesters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ In a search application, client code should use a library like [jQuery UI Autoco
161161
API usage is illustrated in the following call to the Autocomplete REST API. There are two takeaways from this example. First, as with all queries, the operation is against the documents collection of an index and the query includes a `search` parameter, which in this case provides the partial query. Second, you must add `suggesterName` to the request. If a suggester isn't defined in the index, calls to autocomplete or suggestions fail.
162162

163163
```http
164-
POST /indexes/myxboxgames/docs/autocomplete?search&api-version=2024-07-01
164+
POST /indexes/myxboxgames/docs/autocomplete?search&api-version=@search.rerankerBoostedScore
165165
{
166166
"search": "minecraf",
167167
"suggesterName": "sg"

articles/search/index-ranking-similarity.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ BM25 ranking provides two parameters for tuning the relevance score calculation.
4343
1. Use a [Create or Update Index](/rest/api/searchservice/indexes/create) request to set BM25 parameters:
4444

4545
```http
46-
PUT [service-name].search.windows.net/indexes/[index-name]?api-version=2024-07-01&allowIndexDowntime=true
46+
PUT [service-name].search.windows.net/indexes/[index-name]?api-version=@search.rerankerBoostedScore&allowIndexDowntime=true
4747
{
4848
"similarity": {
4949
"@odata.type": "#Microsoft.Azure.Search.BM25Similarity",
@@ -84,7 +84,7 @@ The following links describe the Similarity property in the Azure SDKs.
8484
You can also use the [REST API](/rest/api/searchservice/indexes/create). The following example creates a new index with the "similarity" property set to BM25:
8585
8686
```http
87-
PUT [service-name].search.windows.net/indexes/[index name]?api-version=2024-07-01
87+
PUT [service-name].search.windows.net/indexes/[index name]?api-version=@search.rerankerBoostedScore
8888
{
8989
"name": "indexName",
9090
"fields": [

articles/search/index-similarity-and-scoring.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ By default, the score of a document is calculated based on statistical propertie
9797
If you prefer to compute the score based on the statistical properties across all shards, you can do so by adding `scoringStatistics=global` as a [query parameter](/rest/api/searchservice/documents/search-post) (or add `"scoringStatistics": "global"` as a body parameter of the [query request](/rest/api/searchservice/documents/search-post)).
9898

9999
```http
100-
POST https://[service name].search.windows.net/indexes/hotels/docs/search?api-version=2024-07-01
100+
POST https://[service name].search.windows.net/indexes/hotels/docs/search?api-version=@search.rerankerBoostedScore
101101
{
102102
"search": "<query string>",
103103
"scoringStatistics": "global"
@@ -107,7 +107,7 @@ POST https://[service name].search.windows.net/indexes/hotels/docs/search?api-ve
107107
Using `scoringStatistics` will ensure that all shards in the same replica provide the same results. That said, different replicas can be slightly different from one another as they're always getting updated with the latest changes to your index. In some scenarios, you might want your users to get more consistent results during a "query session". In such scenarios, you can provide a `sessionId` as part of your queries. The `sessionId` is a unique string that you create to refer to a unique user session.
108108

109109
```http
110-
POST https://[service name].search.windows.net/indexes/hotels/docs/search?api-version=2024-07-01
110+
POST https://[service name].search.windows.net/indexes/hotels/docs/search?api-version=@search.rerankerBoostedScore
111111
{
112112
"search": "<query string>",
113113
"sessionId": "<string>"

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ A valid API key establishes trust, on a per request basis, between the applicati
9292

9393
```http
9494
### Create a new index
95-
POST {{baseUrl}}/indexes?api-version=2024-07-01 HTTP/1.1
95+
POST {{baseUrl}}/indexes?api-version=@search.rerankerBoostedScore HTTP/1.1
9696
Content-Type: application/json
9797
api-key: {{apiKey}}
9898
@@ -124,7 +124,7 @@ A valid API key establishes trust, on a per request basis, between the applicati
124124
125125
```http
126126
### Create a data source
127-
POST {{baseUrl}}/datasources?api-version=2024-07-01 HTTP/1.1
127+
POST {{baseUrl}}/datasources?api-version=@search.rerankerBoostedScore HTTP/1.1
128128
Content-Type: application/json
129129
api-key: {{apiKey}}
130130
@@ -155,7 +155,7 @@ A skillset defines enrichments (skills) and your knowledge store. [Create Skills
155155
156156
```http
157157
### Create a skillset
158-
POST {{baseUrl}}/skillsets?api-version=2024-07-01 HTTP/1.1
158+
POST {{baseUrl}}/skillsets?api-version=@search.rerankerBoostedScore HTTP/1.1
159159
Content-Type: application/json
160160
api-key: {{apiKey}}
161161
@@ -322,7 +322,7 @@ A skillset defines enrichments (skills) and your knowledge store. [Create Skills
322322
323323
```http
324324
### Create indexer
325-
POST {{baseUrl}}/indexers?api-version=2024-07-01 HTTP/1.1
325+
POST {{baseUrl}}/indexers?api-version=@search.rerankerBoostedScore HTTP/1.1
326326
Content-Type: application/json
327327
api-key: {{apiKey}}
328328
@@ -370,7 +370,7 @@ After you send each request, the search service should respond with a 201 succes
370370
371371
```http
372372
### Get Indexer Status (wait several minutes for the indexer to complete)
373-
GET {{baseUrl}}/indexers/hotel-reviews-kstore-idxr/status?api-version=2024-07-01 HTTP/1.1
373+
GET {{baseUrl}}/indexers/hotel-reviews-kstore-idxr/status?api-version=@search.rerankerBoostedScore HTTP/1.1
374374
Content-Type: application/json
375375
api-key: {{apiKey}}
376376
```
@@ -379,7 +379,7 @@ After several minutes, you can query the index to inspect the content. Even if y
379379

380380
```http
381381
### Query the index (indexer status must be "success" before querying the index)
382-
POST {{baseUrl}}/indexes/hotel-reviews-kstore-idxr/docs/search?api-version=2024-07-01 HTTP/1.1
382+
POST {{baseUrl}}/indexes/hotel-reviews-kstore-idxr/docs/search?api-version=@search.rerankerBoostedScore HTTP/1.1
383383
Content-Type: application/json
384384
api-key: {{apiKey}}
385385

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

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

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

articles/search/query-lucene-syntax.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To use full Lucene syntax, set the queryType to `full` and pass in a query expre
2424
The following example is a search request constructed using the full syntax. This particular example shows in-field search and term boosting. It looks for hotels where the category field contains the term `budget`. Any documents containing the phrase `"recently renovated"` are ranked higher as a result of the term boost value (3).
2525

2626
```http
27-
POST /indexes/hotels-sample-index/docs/search?api-version=2024-07-01
27+
POST /indexes/hotels-sample-index/docs/search?api-version=@search.rerankerBoostedScore
2828
{
2929
"queryType": "full",
3030
"search": "category:budget AND \"recently renovated\"^3",

0 commit comments

Comments
 (0)