Skip to content

Commit

Permalink
[FormRecognizer] Update CHANGELOG for preview.3 (#9117)
Browse files Browse the repository at this point in the history
* [FormRecognizer] Update CHANGELOG for preview.3

* parameter names for preview.3 should be `formUrl` and `receiptUrl`

* More renaming

* data => form/receipt

* Update sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md

Co-authored-by: Krista Pratico <[email protected]>

* logging whitelist

* useTrainingLabels parameter now required

* intervalInMs => updateIntervalInMs

* Remove USReceipt for preview.3

Co-authored-by: Krista Pratico <[email protected]>
  • Loading branch information
jeremymeng and kristapratico authored Jun 5, 2020
1 parent 527f241 commit 7800a02
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,42 @@
## 1.0.0-preview.3 (Unreleased)

- Blank pages in receipt recognition are now handled properly.
- Support Azure Active Directory credential.
- Support to copy a custom model from one Form Recognizer resource to another.
- Headers and query parameters which don't contain sensitive information are no longer redacted in logging output.
- Refactoring for cross-language consistency:
- [Breaking] Rename `beginRecognizeForms()` to `beginRecognizeCustomForms()` in `FormRecognizerClient`.
- [Breaking] Rename `listModels()` to `listCustomModels()` in `FormTrainingClient`.
- [Breaking] Rename `count` to `customModelCount` and `limit` to `customModelLimit` in `AccountProperties`.
- [Breaking] Rename type `ErrorInformation` to `FormRecognizerError`.
- [Breaking] Rename type `ModelStatus` to `CustomFormModelStatus`.
- [Breaking] Rename type `CustomFormSubModelField` to `CustomFormField`.
- [Breaking] Rename type `FormElement` to `FormContent` and `FormElementCommon` to `FormContentCommon`.
- [Breaking] Rename property `fieldLabel` to `labelText` in `FormField` type.
- [Breaking] Rename type `ModelInfo` to `CustomFormModelInfo`.
- [Breaking] Rename properties `createdOn` to `requestedOn` and `lastModified` to `completedOn` in `CustomModelInfo` type.
- [Breaking] Rename type `TrainModelOptions` to `TrainingFileFilter`.
- [Breaking] Rename type `TrainStatus` to `TrainingStatus`.
- [Breaking] Rename type `ContentType` to `FormContentType`.
- [Breaking] Rename type `FormText` to `FieldText`.
- [Breaking] Rename type `CustomFormSubModel` to `CustomFormSubmodel`.
- [Breaking] Rename `models` to `submodels` in `CustomFormModel`.
- [Breaking] Recognition methods and training methods now return the result directly, instead of wrapping them in a response object. Specifically,
- `beginTraining` now returns `CustomFormModel` instead of `FormModelResponse` from the poller.
- `beginRecognizeContent` and `beginRecognizeContentFromUrl` now return `FormPageArray` instead of `RecognizeContentResultResponse` from the poller.
- `beginRecognizeForms` and `beginRecognizeFormsFromUrl` now return `RecognizedFormArray` instead of `RecognizeFormResultResponse` from the poller.
- `beginRecognizeReceipts` and `beginRecognizeReceiptsFromUrl` now return `RecognizedReceiptArray` instead of `RecognizeReceiptResultResponse` from the poller.
- [Breaking] Remove `getFormTrainingClient()` from `FormRecognizerClient`. A new method `getFormRecognizerClient()` is added to `FormTrainingClient`
- [Breaking] `useTrainingLabels` parameter is now required for `beginTraining()` method.
- [Breaking] Rename `intervalInMs` to `updateIntervalInMs` for all LRO poller options.
- [Breaking] Remove `USReceipt` and assoicated types.
- Rename the first parameter of `beginRecognizeContent()` from `data` to `form`.
- Rename the second parameter of `beginRecognizeForms()` from `data` to `form`.
- Rename the first parameter of `beginRecognizeReceipts()` from `data` to `receipt`.
- Rename the first parameter of `beginRecognizeContentFromUrl()` from `documentUrl` to `formUrl`.
- Rename the second parameter of `beginRecognizeFormsFromUrl()` from `documentUrl` to `formUrl`.
- Rename the first parameter of `beginRecognizeReceiptsFromUrl()` from `documentUrl` to `receiptUrl`.
- Rename the first parameter of `beginTraining` from `blobContainerUrl` to `trainingFilesUrl`.

## 1.0.0-preview.2 (2020-05-06)

Expand Down

0 comments on commit 7800a02

Please sign in to comment.