Skip to content

Commit 3d5923e

Browse files
authored
Merge pull request #215468 from laujan/214995-vinod-migration
214995 vinod migration
2 parents 4e1f6cc + 6f9d54f commit 3d5923e

File tree

2 files changed

+30
-4
lines changed

2 files changed

+30
-4
lines changed

articles/applied-ai-services/form-recognizer/v3-migration-guide.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,20 @@ recommendations: false
1919
>
2020
> Form Recognizer REST API v3.0 introduces breaking changes in the REST API request and analyze response JSON.
2121
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+
2236
Form Recognizer v3.0 introduces several new features and capabilities:
2337

2438
* [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:
92106
}
93107
```
94108

95-
### Additional supported parameters
109+
### Additionally supported parameters
96110

97111
Parameters that continue to be supported:
98112

@@ -372,4 +386,5 @@ In this migration guide, you've learned how to upgrade your existing Form Recogn
372386

373387
* [Review the new REST API](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)
374388
* [What is Form Recognizer?](overview.md)
375-
* [Form Recognizer quickstart](/azure/applied-ai-services/form-recognizer/how-to-guides/v2-1-sdk-rest-api)
389+
* [Form Recognizer quickstart](./quickstarts/try-sdk-rest-api.md)
390+

articles/applied-ai-services/form-recognizer/whats-new.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ ms.date: 10/20/2022
1111
ms.author: lajanuar
1212
monikerRange: '>=form-recog-2.1.0'
1313
recommendations: false
14+
ms.custom: references_regions
1415
---
1516
<!-- markdownlint-disable MD024 -->
1617
<!-- markdownlint-disable MD036 -->
@@ -23,12 +24,22 @@ recommendations: false
2324

2425
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.
2526

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+
2630
## October 2022
2731

2832
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.
2933

3034
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.
3135

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+
3243
## September 2022
3344

3445
### Region expansion for training custom neural models
@@ -565,7 +576,7 @@ The updated Layout API table feature adds header recognition with column headers
565576

566577
* Client defaults to the latest supported service version, currently v2.1. You can specify version 2.0 in the **FormRecognizerClientOptions** object's **Version** property.
567578

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.
569580

570581
* **FormReadingOrder**. *ReadingOrder* renamed to **FormReadingOrder**.
571582

@@ -653,7 +664,7 @@ The updated Layout API table feature adds header recognition with column headers
653664

654665
#### **Breaking changes (May)**
655666

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.
657668

658669
* **FieldValueType**. Renamed value type *country* to **countryRegion**. Removed value type *gender*.
659670

0 commit comments

Comments
 (0)