Skip to content

Commit 6f7dae3

Browse files
committed
fix formatting and readability bugs
1 parent 4b58d2f commit 6f7dae3

File tree

3 files changed

+22
-32
lines changed

3 files changed

+22
-32
lines changed

articles/search/search-api-migration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Effective March 29, 2024 and applicable to all [supported REST APIs](/rest/api/s
7272

7373
+ For all API versions, updates on July 14, 2023 to the Microsoft-hosted semantic models made semantic ranker language-agnostic, effectively decommissioning the `queryLanguage` property. There's no "breaking change" in code, but the property is ignored.
7474

75-
See [Migrate from preview version](semantic-code-migration) to transition your code to use `semanticConfiguration`.
75+
See [Migrate from preview version](semantic-code-migration.md) to transition your code to use `semanticConfiguration`.
7676

7777
## Upgrade to 2024-11-01-preview
7878

articles/search/semantic-code-migration.md

Lines changed: 17 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -14,31 +14,23 @@ ms.date: 12/10/2024
1414

1515
# Migrate semantic ranking code from previous versions
1616

17-
If your semantic ranking code was written against preview APIs, this article explains how to migrate to newer APIs. Breaking changes for semantic ranker are limited to query logic in recent APIs, but if your code was written against the initial preview, you might need to change your semantic configuration as well.
17+
If your semantic ranking code was written against preview APIs, this article explains how to migrate to newer APIs. Breaking changes for semantic ranker are limited to query logic in recent APIs, but if your code was written against the initial preview version, you might need to change your semantic configuration as well.
1818

1919
## API versions providing semantic ranking
2020

2121
Check your code for the REST API version or SDK package version to confirm which one provides semantic ranking. The following API versions have some level of support for semantic ranking.
2222

23-
| Release | REST API version |
24-
|--|--|
25-
| initial | 2020-06-30-preview (query only) |
26-
| preview | 2021-04-30-preview (adds semantic configuration) |
27-
| preview | 2023-07-01-preview (changes semantic configuration <sup>1</sup>) |
28-
| preview | 2023-10-01-preview (changes semantic configuration <sup>2</sup>) |
29-
| stable | [2023-11-01](/rest/api/searchservice/operation-groups?view=rest-searchservice-2023-11-01&preserve-view=true) (generally available <sup>3</sup>)|
30-
| preview | 2024-05-01-preview (no change) |
31-
| stable | [2024-07-01 (REST)](/rest/api/searchservice/indexes/create-or-update?view=rest-searchservice-2024-07-01&preserve-view=true) (no change) |
32-
| preview | 2024-09-01-preview (no change) |
33-
| preview | 2024-11-01-preview (adds query rewrite <sup>4</sup>) |
34-
35-
<sup>1</sup> Starting on July 14, 2023 updates to the Microsoft-hosted semantic models made semantic ranker language-agnostic, effectively decommissioning the `queryLanguage` property for semantic ranking. There's no breaking change in code, but the property is ignored. Customers were advised to remove this property from code.
36-
37-
<sup>2</sup> API version 2023-07-01-preview introduced changes to semantic configuration that are now abandoned. Don't use this version.
38-
39-
<sup>3</sup> API version 2023-10-01-preview introduced changes to semantic configuration that progressed to the stable version. If your code targets this version or later, it's compatible with newer API versions unless you adopt new preview features.
40-
41-
<sup>4</sup> The `queryLanguage` property is now required if you use [query rewrite (preview)](semantic-how-to-query-rewrite.md).
23+
| Release | REST API version | Update |
24+
|--|--|--|
25+
| initial | [2020-06-30-preview](/rest/api/searchservice/preview-api/search-documents) | Adds queryType=semantic to Search Documents |
26+
| preview | [2021-04-30-preview](/rest/api/searchservice/preview-api/search-documents) | Adds semantic configuration |
27+
| preview | [2023-07-01-preview](/rest/api/searchservice/preview-api/search-documents) | Changes to semantic configuration. Starting on July 14, 2023 updates to the Microsoft-hosted semantic models made semantic ranker language-agnostic, effectively decommissioning the `queryLanguage` property for semantic ranking. There's no breaking change in code, but the property is ignored. Customers were advised to remove this property from code.|
28+
| preview | [2023-10-01-preview](/rest/api/searchservice/operation-groups?view=rest-searchservice-2023-10-01-preview&preserve-view=true) | Changes to semantic configuration. Introduced changes to semantic configuration that are now abandoned. Don't use this version.|
29+
| stable | [2023-11-01](/rest/api/searchservice/operation-groups?view=rest-searchservice-2023-11-01&preserve-view=true) | Generally available. Introduced changes to semantic configuration that progressed to the stable version. If your code targets this version or later, it's compatible with newer API versions unless you adopt new preview features.|
30+
| preview | [2024-05-01-preview](/rest/api/searchservice/operation-groups?view=rest-searchservice-2024-05-01-preview) | No change |
31+
| stable | [2024-07-01](/rest/api/searchservice/indexes/create-or-update?view=rest-searchservice-2024-07-01&preserve-view=true) | No change |
32+
| preview | [2024-09-01-preview](/rest/api/searchservice/operation-groups?view=rest-searchservice-2024-09-01-preview) | No change |
33+
| preview | [2024-11-01-preview](/rest/api/searchservice/operation-groups?view=rest-searchservice-2024-11-01-preview) | Adds query rewrite. The `queryLanguage` property is now required if you use [query rewrite (preview)](semantic-how-to-query-rewrite.md). |
4234

4335
## Change logs for Azure SDKs
4436

@@ -90,17 +82,17 @@ Starting on July 14, 2023, semantic ranker is language agnostic. In preview vers
9082

9183
## 2021-04-30-preview
9284

93-
+ Semantic support is now scoped to both [Search Documents](/rest/api/searchservice/preview-api/search-documents) and [Create or Update Index](/rest/api/searchservice/preview-api/create-or-update-index) preview API calls.
85+
+ Semantic support is through [Search Documents](/rest/api/searchservice/preview-api/search-documents) and [Create or Update Index](/rest/api/searchservice/preview-api/create-or-update-index) preview API calls.
9486
+ Adds `semanticConfiguration` to a search index. A semantic configuration has a name and a prioritized field list.
95-
+ Adds `semanticFields`. The `searchFields` property is no longer used to prioritize fields.
87+
+ Adds `semanticFields`.
9688

97-
In all versions after `2020-06-30-preview`, `semanticConfiguration` replaces `searchFields` as the mechanism for specifying which fields to use for L2 ranking.
89+
The `searchFields` property is no longer used to prioritize fields. In all versions moving forward, `semanticConfiguration.semanticFields` replaces `searchFields` as the mechanism for specifying which fields to use for L2 ranking.
9890

9991
## 2020-06-30-preview
10092

101-
+ Semantic support is scoped to a [Search Documents](/rest/api/searchservice/preview-api/search-documents) preview API call.
93+
+ Semantic support is through a [Search Documents](/rest/api/searchservice/preview-api/search-documents) preview API call.
10294
+ Adds `queryType=semantic` to the query request.
103-
+ Adapts `searchFields` so that if the query type is semantic, the `searchFields` property determines the priority order of field.inputs to the semantic ranker.
95+
+ Adapts `searchFields` so that if the query type is semantic, the `searchFields` property determines the priority order of field inputs to the semantic ranker.
10496
+ Adds `captions`, `answers`, and `highlights` to the query response.
10597

10698
## Next steps

articles/search/toc.yml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -430,20 +430,18 @@ items:
430430
href: hybrid-search-how-to-query.md
431431
- name: Ranking and relevance
432432
items:
433+
- name: Add a scoring profile
434+
href: index-add-scoring-profiles.md
435+
- name: Configure BM25 ranking
436+
href: index-ranking-similarity.md
433437
- name: Enable or disable semantic ranker
434438
href: semantic-how-to-enable-disable.md
435439
- name: Configure semantic ranker
436440
href: semantic-how-to-configure.md
437441
- name: Add semantic ranking to queries
438-
displayName: query
439442
href: semantic-how-to-query-request.md
440443
- name: Rewrite queries with semantic ranker
441-
displayName: query
442444
href: semantic-how-to-query-rewrite.md
443-
- name: Add a scoring profile
444-
href: index-add-scoring-profiles.md
445-
- name: Configure BM25 ranking
446-
href: index-ranking-similarity.md
447445
- name: Migrate semantic ranking code
448446
href: semantic-code-migration.md
449447
- name: Security

0 commit comments

Comments
 (0)