1.0.0-beta.3 (2020-06-10)
New Features
- Support to copy a custom model from one Form Recognizer resource to another
- Added support for AAD Authentication.
- Raise
FormRecognizerException
when a model withModelStatus.Invalid
is returned from thebeginTraining()
API's - Raise
FormRecognizerException
when an invalid analyze status is returned from the service for recognize API's - Add
pageNumber
property toFormPage
andFormTable
model - Add
getFormRecognizerClient()
andgetFormRecognizerAsyncClient()
in FormTrainingClient and FormTrainingAsyncClient - Add
FormTrainingClientBuilder
to buildFormTrainingAsyncClient
andFormTrainingClient
Breaking Changes
- Update FormRecognizer API calls to return a
List
instead ofIterableStream
. - Adopt the
training
namespace for Form Recognizer Training Clients - Rename enum type
DimensionUnit
toLengthUnit
onFormPage
USReceipt
,USReceiptItem
,USReceiptType
andFormField{T}
types removed. Information about aRecognizedReceipt
must now be extracted from itsRecognizedForm
.- Rename parameters data and sourceUrl parameters found on methods for FormRecognizerClient to form and formUrl, respectively.
- Rename parameters for receipt API methods to receipt and receiptUrl.
- Update FormField property
transactionTime
onUSReceipt
to returnLocalTime
instead ofString
- Rename model
PageRange
toFormPageRange
- Rename property
startPageNumber
tofirstPageNumber
andendPageNumber
tolastPageNumber
in modelPageRange
- Rename
getCustomModelInfos
tolistCustomModels
- Rename property
lastUpdatedOn
tocompletedOn
andcreatedOn
torequestedOn
inCustomFormModel
and
CustomFormModelInfo
model - Rename model
CustomFormSubModel
toCustomFormSubmodel
- Rename
subModels
property on CustomFormModel tosubmodels
- Remove
pageNumber
property fromFormField
model - Rename parameter
fileSourceUrl
totrainingFilesUrl
onbeginTraining
method in FormTrainingClients - Rename parameter
useLabelFile
touseTrainingLabels
onbeginTraining
method in FormTrainingClients - Replace parameters
filePrefix
andincludeSubFolders
withTrainingFileFilter
model - Rename AccountProperties
count
andlimit
tocustomModelCount
andcustomModelLimit
- Rename
apiKey()
tocredential()
on FormRecognizerClientBuilder.
Key Bug Fixes
- Fix bug in FormRecognizer API's to support multipage document recognition.
- Fix Receipt type to select the valueString field via fieldValue.
This package's
documentation
and
samples
demonstrate the new API.