Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FormRecognizer] Update CHANGELOG for preview.3 #9117

Merged
merged 10 commits into from
Jun 5, 2020
Merged

[FormRecognizer] Update CHANGELOG for preview.3 #9117

Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
1220630
[FormRecognizer] Update CHANGELOG for preview.3
jeremymeng May 26, 2020
24024f5
parameter names for preview.3 should be `formUrl` and `receiptUrl`
jeremymeng May 26, 2020
5af3c34
More renaming
jeremymeng May 28, 2020
c5609f9
data => form/receipt
jeremymeng May 28, 2020
873bbb7
Update sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md
jeremymeng May 28, 2020
148b838
logging whitelist
jeremymeng May 28, 2020
c12b883
useTrainingLabels parameter now required
jeremymeng May 28, 2020
10558cc
intervalInMs => updateIntervalInMs
jeremymeng May 30, 2020
8d3e1fb
Merge remote-tracking branch 'upstream/master' into fr-changelog-june…
jeremymeng Jun 1, 2020
e7a6a1c
Remove USReceipt for preview.3
jeremymeng Jun 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,35 @@
## 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.
- 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 `createOn` 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`
- Rename the first parameter of `beginRecognizeContentFromUrl()` from `documentUrl` to `formUrl`.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see you don't have this in master yet, but just in case I wanted to mention that we're also changing the parameter in beginRecognizeReceipts to receipt, and beginRecognizeContent,beginRecognizeCustomForms to form

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I think I'd like to keep the parameter name data for JS

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if we've talked about this before, but is there a reason why JS would diverge here

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not strong opinion, this is input and I don't like to pre-classify it to "form" or "receipt" since users could pass in any binary data. Probably also the reason why I had "documentUrl" instead of "formUrl" and "receiptUrl".

Has "formData"/"receiptData" been considered?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anyway, I submitted PR #9157 to use "form" and "receipt"

- 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