NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
NuGet · #2613 most downloaded on NuGet
This is the Microsoft Azure Cognitive Services Form Recognizer client library
Last release 3 years ago
no release in 18 months
Release timing varies
gaps range from 2 weeks to 1.2 years
Nearly every release is documented
notes for 6 of 6 stable releases
Nothing withdrawn
no release was ever pulled
6 years old
6 releases · first in 2020
One column per quarter.
Functions Extensions - WebPubSub
Code | Docs
Support: Active
Functions Extensions - WebPubSub
Microsoft.Azure.Functions.Worker.Extensions.WebPubSub
DocumentAnalysisFeature, added properties Barcodes, KeyValuePairs, and Languages as add-on capabilities.DocumentContentSource as a base class to AzureBlobContentSource (renamed to BlobContentSource in this SDK version) and AzureBlobFileListSource (renamed to BlobFileListContentSource in this SDK version).DocumentModelAdministrationClient, added a new overload to BuildDocumentModel that takes a DocumentContentSource object. It can be used to build a document model from alternative content sources.ServiceVersion to classes AnalyzeResult, DocumentModelDetails, DocumentModelSummary, OperationDetails, and OperationSummary.DocumentAnalysisClient and DocumentModelAdministrationClient now target service API version 2023-07-31 by default. Version 2023-02-28-preview is not supported anymore.DocumentAnalysisFeature, properties OcrFormula and OcrFont were renamed to Formulas and FontStyling, respectively.AnalyzeDocumentOptions.QueryFields and DocumentAnalysisFeature.QueryFieldsPremium were removed.DocumentImage and the property DocumentPage.Images were removed.DocumentAnnotation, DocumentAnnotationKind, and the property DocumentPage.Annotations were removed.DocumentPageKind and property DocumentPage.Kind.DocumentKeyValuePair.CommonName.DocumentBarcodeKind, renamed members QRCode, PDF417, EAN8, EAN13, ITF, and MicroQRCode to QrCode, Pdf417, Ean8, Ean13, Itf, and MicroQrCode, respectively.AzureBlobContentSource to BlobContentSource.AzureBlobFileListSource to BlobFileListContentSource.ClassifierDocumentTypeDetails, properties AzureBlobFileListSource and AzureBlobSource have been replaced by a single polymorphic property TrainingDataSource.ClassifierDocumentTypeDetails, all constructors have been replaced by a single constructor that takes a polymorphic parameter trainingDataSource.ResourceDetails, renamed property CustomNeuralDocumentModelBuilds to NeuralDocumentModelQuota.DocumentClassifierDetails, renamed property ApiVersion to ServiceVersion.FontStyle to DocumentFontStyle.FontWeight to DocumentFontWeight.QuotaDetails to ResourceQuotaDetails.GetResourceDetails API while targeting service version 2022-08-31 would throw an ArgumentNullException.Added GetWords method to DocumentLine. It can be used to split the line into separate DocumentWord instances.
GetWords method to DocumentLine. It can be used to split the line into separate DocumentWord instances.DocumentModelOperationDetails for each kind of operation: DocumentModelBuildOperationDetails, DocumentModelCopyToOperationDetails, and DocumentModelComposeOperationDetails.DocumentField.ExpectedFieldType property.DocumentAnalysisClient and DocumentModelAdministrationClient now target the service version 2022-08-31, so they don't support 2020-06-30-preview anymore.DocumentModelAdministrationClient methods to use the term DocumentModel instead of Model only. For example, BuildModel and GetModels became BuildDocumentModel and GetDocumentModels.
Operation types have been renamed to reflect this change. For example, ComposeModelOperation became ComposeDocumentModelOperation.BuildModelOptions has been renamed to BuildDocumentModelOptions.BoundingPolygon type. All BoundingPolygon properties are now of type IReadOnlyList<PointF>.DocumentField conversion methods, such as AsDate and AsString, to the new DocumentFieldValue class. They can be accessed from the DocumentField.Value property.DocumentField.ValueType (now called FieldType) can now be Unknown when the field value couldn't be parsed by the service. In this case, DocumentField.Content can be used to get a textual representation of the field.DocumentField.AsDate to return a DateTimeOffset instead of a DateTime.DocumentModelOperationDetails and DocumentModelOperationSummary to OperationDetails and OperationSummary, respectively.Result in DocumentModelOperationDetails (now called OperationDetails) to each of its new derived classes. The property can't be accessed from the base class anymore.DocTypeInfo to DocumentTypeDetails.Offset to Index in the DocumentSpan class.DocType to DocumentType in the AnalyzedDocument class.DocTypes to DocumentTypes in the DocumentModelDetails class.DocumentModelCount and DocumentModelLimit to CustomDocumentModelCount and CustomDocumentModelLimit in the ResourceDetails class.BuildModelOptions.Prefix. The prefix must now be set with the prefix parameter in the method BuildModel.DocumentPageKind and related properties.BoundingRegion a struct instead of a class.BoundingRegion now implements the IEquatable<BoundingRegion> interface.BoundingRegion.ToString to include information about its page number and its bounding polygon in its string representation.DocumentSpan now implements the IEquatable<DocumentSpan> interface.DocumentSpan.ToString to include information about its index and its length in its string representation.LengthUnit to DocumentPageLengthUnit. This change only affects the type defined in the DocumentAnalysis namespace.SelectionMarkState to DocumentSelectionMarkState. This change only affects the type defined in the DocumentAnalysis namespace.CopyAuthorization to DocumentModelCopyAuthorization. This change only affects the type defined in the DocumentAnalysis namespace.Handles invoices and other recognition operations that return a FormField with Text and no BoundingBox or Page information.
FormField with Text and no BoundingBox or Page information.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.4.
3.1.0-beta.1 through 3.1.0-beta.4.FormRecognizerModelFactory class to support missing model types for mocking.2.0. This can be specified in the FormRecognizerClientOptions object under the ServiceVersion enum.
By default the SDK targets latest supported service version.2.1.Id for Identity in all the StartRecognizeIdDocuments functionalities. For example, the name of the method is now StartRecognizeIdentityDocuments.ReadingOrder to FormReadingOrder.TextAppearance now includes the properties StyleName and StyleConfidence that were part of the TextStyle object.TextStyle.AsCountryCode to AsCountryRegion.FieldValueGender.Gender from the model FieldValuetype.### Key Bug Fixes - Updated dependency versions.
First stable release of the Azure.AI.FormRecognizer package.
BoundingBox to FieldBoundingBox.FormRecognizerModelFactory static class to support mocking model types.Your coding agent can read these notes before it upgrades. Set up the MCP server →