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/applied-ai-services/form-recognizer/v3-migration-guide.md
+17-2Lines changed: 17 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,20 @@ recommendations: false
19
19
>
20
20
> Form Recognizer REST API v3.0 introduces breaking changes in the REST API request and analyze response JSON.
21
21
22
+
## Migrating from a v3.0 preview API version
23
+
24
+
Preview APIs are periodically deprecated. If you're using a preview API version, plan on updating your application to target the GA API version once available. To migrate from the 2021-09-30-preview or the 2022-01-30-preview API versions to the 2022-08-31 (GA) API version using the SDK, update to the [current version of the language specific SDK](sdk-overview.md).
25
+
26
+
The 2022-08-31 API has a few updates from the preview API versions:
27
+
* Field rename: boundingBox to polygon to support non-quadrilateral polygon regions.
28
+
* Field deleted: entities removed from the result of the general document model.
29
+
* Field rename: documentLanguage.languageCode to locale
30
+
* Added support for HEIF format
31
+
* Added paragraph detection, with role classification for layout and general document models
32
+
* Added support for parsed address fields.
33
+
34
+
## Migrating from v2.1
35
+
22
36
Form Recognizer v3.0 introduces several new features and capabilities:
23
37
24
38
*[Form Recognizer REST API](quickstarts/get-started-sdks-rest-api.md?view=form-recog-3.0.0&preserve-view=true) has been redesigned for better usability.
@@ -92,7 +106,7 @@ Base64 encoding is also supported in Form Recognizer v3.0:
92
106
}
93
107
```
94
108
95
-
### Additional supported parameters
109
+
### Additionally supported parameters
96
110
97
111
Parameters that continue to be supported:
98
112
@@ -372,4 +386,5 @@ In this migration guide, you've learned how to upgrade your existing Form Recogn
372
386
373
387
*[Review the new REST API](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)
Copy file name to clipboardExpand all lines: articles/applied-ai-services/form-recognizer/whats-new.md
+13-2Lines changed: 13 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,7 @@ ms.date: 10/20/2022
11
11
ms.author: lajanuar
12
12
monikerRange: '>=form-recog-2.1.0'
13
13
recommendations: false
14
+
ms.custom: references_regions
14
15
---
15
16
<!-- markdownlint-disable MD024 -->
16
17
<!-- markdownlint-disable MD036 -->
@@ -23,12 +24,22 @@ recommendations: false
23
24
24
25
Form Recognizer service is updated on an ongoing basis. Bookmark this page to stay up to date with release notes, feature enhancements, and documentation updates.
25
26
27
+
>[!NOTE]
28
+
> With the release of the 2022-08-31 GA API, the associated preview APIs are being deprecated. If you are using the 2021-09-30-preview or the 2022-01-30-preview API versions, please update your applications to target the 2022-08-31 API version. There are a few minor changes involved, for more information, _see_ the [migration guide](v3-migration-guide.md).
29
+
26
30
## October 2022
27
31
28
32
With the latest preview release, Form Recognizer's Read (OCR), Layout, and Custom template models support 134 new languages. These language additions include Greek, Latvian, Serbian, Thai, Ukrainian, and Vietnamese, along with several Latin and Cyrillic languages. Form Recognizer now has a total of 299 supported languages across the most recent GA and new preview versions. Refer to the [supported languages](language-support.md) page to see all supported languages.
29
33
30
34
Use the REST API parameter `api-version=2022-06-30-preview` when using the API or the corresponding SDK to support the new languages in your applications.
31
35
36
+
### Region expansion for training custom neural models
37
+
38
+
Training custom neural models now supported in added regions.
39
+
* East US
40
+
* East US2
41
+
* US Gov Arizona
42
+
32
43
## September 2022
33
44
34
45
### Region expansion for training custom neural models
@@ -565,7 +576,7 @@ The updated Layout API table feature adds header recognition with column headers
565
576
566
577
* Client defaults to the latest supported service version, currently v2.1. You can specify version 2.0 in the **FormRecognizerClientOptions** object's **Version** property.
567
578
568
-
***StartRecognizeIdentityDocuments**. Renamed methods and method parameters using **Identity** to replace _Id_ keyword for all related identity documents recognition API functionalities.
579
+
***StartRecognizeIdentityDocuments**. Renamed methods and method parameters using **Identity** to replace _ID_ keyword for all related identity documents recognition API functionalities.
569
580
570
581
***FormReadingOrder**. *ReadingOrder* renamed to **FormReadingOrder**.
571
582
@@ -653,7 +664,7 @@ The updated Layout API table feature adds header recognition with column headers
653
664
654
665
#### **Breaking changes (May)**
655
666
656
-
***begin_recognize_identity_documents** and **begin_recognize_identity_documents_from_url**. Renamed methods and method parameters using **Identity** to replace _Id_ keyword.
667
+
***begin_recognize_identity_documents** and **begin_recognize_identity_documents_from_url**. Renamed methods and method parameters using **Identity** to replace _ID_ keyword.
657
668
658
669
***FieldValueType**. Renamed value type *country* to **countryRegion**. Removed value type *gender*.
0 commit comments