Azure/azure-sdk-for-net Azure.AI.FormRecognizer_4.0.0-beta.5

on GitHub

4.0.0-beta.5 (2022-08-09)

Features Added

• Added Length property to BoundingPolygon.
• Added a public constructor to CopyAuthorization.
• Added properties AccessToken and TargetResourceId to CopyAuthorization.

Breaking Changes

• Updated all long-running operation client methods to a new pattern. This affects StartAnalyzeDocument, StartAnalyzeDocumentFromUri, StartBuildModel, StartCopyModelTo, and StartCreateComposedModel methods. Changes are:
  • Removed the "Start" prefix. For example, StartAnalyzeDocument was renamed to AnalyzeDocument.
  • Added a new required parameter: waitUntil. It specifies whether the operation should run to completion before returning or not, removing the need to call WaitForCompletion in most scenarios.
• Updated DocumentModelInfo and DocumentModel:
  • Renamed them to DocumentModelSummary and DocumentModelDetails, respectively.
  • Removed the inheritance between them.
• Updated ModelOperationInfo and ModelOperation:
  • Renamed them to DocumentModelOperationSummary and DocumentModelOperationDetails, respectively.
  • Removed the inheritance between them.
  • Updated ResourceLocation to be a Uri in both.
• Renamed AccountProperties to ResourceDetails.
• Renamed method GetAccountProperties to GetResourceDetails.
• Renamed method StartCreateComposedModel to ComposeModel.
• Renamed BuildModelOptions.ModelDescription to Description.
• Renamed modelDescription parameters to description in methods GetCopyAuthorization and StartCreateComposedModel (now called ComposeModel).
• Renamed CopyAuthorization.ExpirationDateTime to ExpiresOn.
• Removed DocumentCaption and DocumentFootnote features.
• Updated the return type of StartCreateComposedModel (now called ComposeModel) to a ComposeModelOperation.
• Renamed class CopyModelOperation to CopyModelToOperation.
• Renamed parameter analyzeDocumentOptions to options in the StartAnalyzeDocument and StartAnalyzeDocumentFromUri methods (now called AnalyzeDocument and AnalyzeDocumentFromUri).
• Renamed parameter buildModelOptions to options in the StartBuildModel method (now called BuildModel).
• FormRecognizerClientOptions.Audience and DocumentAnalysisClientOptions.Audience now default to null.
• In the DocumentAnalysis namespace, CopyModelOperation.PercentCompleted and BuildModelOperation.PercentCompleted now throw an InvalidOperationException if called before a call to UpdateStatus.
• Updated CopyAuthorization.TargetModelLocation to be a Uri instead of string.
• Removed method DocumentAnalysisModelFactory.CopyAuthorization.