Azure/azure-sdk-for-js @azure/ai-form-recognizer_3.1.0

on GitHub

3.1.0 (2021-05-26)

• This General Availability (GA) release marks the stability of the changes introduced in package versions 3.1.0-beta.1 through 3.1.0-beta.3.
• Changed all names including IdDocument to use IdentityDocument instead, for example: BeginRecognizeIdentityDocumentOptions, beginRecognizeIdentityDocuments, and beginRecognizeIdentityDocumentsFromUrl for clarity.
• Flattened the TextStyle type into the TextAppearance type. Rather than having a style property with its own name and confidence, TextAppearance now has styleName and styleConfidence properties.
• Removed the FormGenderField type. Any recognized value that was previously produced as a FormGenderField is now returned as a FormStringField instead (the value will remain the same).
• Renamed the FormCountryField type to FormCountryRegionField, and changed the valueType discriminant property of that type to "countryRegion:.
• Renamed ReadingOrder and Language to FormReadingOrder and FormLanguage to reduce the chance that these types would collide with other types having the same name from other packages.
• Removed the KnownStyleName, KnownSelectionMarkState, and KnownKeyValueType enums, as they represent simple string enums. The styleName, state, and valueType properties (respectively) now have strong string-enum types.
• Added the KnownFormLocale enum to access the well-known possible values of form locales (the locale property of the options parameters for prebuilt model recognition).
• Migrated to the 2.1 Form Recognizer service endpoint for all REST API calls.