You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/search/search-api-migration.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,7 +72,7 @@ Effective March 29, 2024 and applicable to all [supported REST APIs](/rest/api/s
72
72
73
73
+ 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.
74
74
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`.
Copy file name to clipboardExpand all lines: articles/search/semantic-code-migration.md
+17-25Lines changed: 17 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,31 +14,23 @@ ms.date: 12/10/2024
14
14
15
15
# Migrate semantic ranking code from previous versions
16
16
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.
18
18
19
19
## API versions providing semantic ranking
20
20
21
21
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.
<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 |
| 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). |
42
34
43
35
## Change logs for Azure SDKs
44
36
@@ -90,17 +82,17 @@ Starting on July 14, 2023, semantic ranker is language agnostic. In preview vers
90
82
91
83
## 2021-04-30-preview
92
84
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.
94
86
+ 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`.
96
88
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.
98
90
99
91
## 2020-06-30-preview
100
92
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.
102
94
+ 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 fieldinputs to the semantic ranker.
104
96
+ Adds `captions`, `answers`, and `highlights` to the query response.
0 commit comments