From 1220630514ea2d0c8497093819df4abf0d56615f Mon Sep 17 00:00:00 2001 From: Jeremy Meng Date: Tue, 26 May 2020 21:57:31 +0000 Subject: [PATCH 1/9] [FormRecognizer] Update CHANGELOG for preview.3 --- .../ai-form-recognizer/CHANGELOG.md | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md b/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md index 8e756082c36b..dd345fd4ffeb 100644 --- a/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md +++ b/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md @@ -3,6 +3,30 @@ ## 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 tppe `TrainStatus` to `TrainingStatus`. + - [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 `formFileUrl`. + - Rename the second parameter of `beginRecognizeFormsFromUrl()` from `documentUrl` to `formFileUrl`. + - Rename the first parameter of `beginRecognizeReceiptsFromUrl()` from `documentUrl` to `receiptFileUrl`. + - Rename the first parameter of `beginTraining` from `blobContainerUrl` to `trainingFilesUrl`. ## 1.0.0-preview.2 (2020-05-06) From 24024f5ff259747c068184bd1243a8da0c5d662e Mon Sep 17 00:00:00 2001 From: Jeremy Meng Date: Tue, 26 May 2020 22:18:44 +0000 Subject: [PATCH 2/9] parameter names for preview.3 should be `formUrl` and `receiptUrl` --- sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md b/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md index dd345fd4ffeb..9a3c8b687181 100644 --- a/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md +++ b/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md @@ -23,9 +23,9 @@ - `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 `formFileUrl`. - - Rename the second parameter of `beginRecognizeFormsFromUrl()` from `documentUrl` to `formFileUrl`. - - Rename the first parameter of `beginRecognizeReceiptsFromUrl()` from `documentUrl` to `receiptFileUrl`. + - 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) From 5af3c34f8a55ea87a5887f25e92c0b4894de266c Mon Sep 17 00:00:00 2001 From: Jeremy Meng Date: Thu, 28 May 2020 16:17:02 +0000 Subject: [PATCH 3/9] More renaming --- sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md b/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md index 9a3c8b687181..35b7834f70e7 100644 --- a/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md +++ b/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md @@ -15,7 +15,12 @@ - [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 tppe `TrainStatus` to `TrainingStatus`. + - [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. From c5609f9bede839d12dcecbf4fb3a3969aa22f6d2 Mon Sep 17 00:00:00 2001 From: Jeremy Meng Date: Thu, 28 May 2020 17:23:51 +0000 Subject: [PATCH 4/9] data => form/receipt --- sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md b/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md index 35b7834f70e7..fe4dd1d5af62 100644 --- a/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md +++ b/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md @@ -28,6 +28,9 @@ - `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 `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`. From 873bbb7f58a0785359bb3fbf9f48608b2f921b66 Mon Sep 17 00:00:00 2001 From: Jeremy Meng Date: Thu, 28 May 2020 17:28:50 +0000 Subject: [PATCH 5/9] Update sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md Co-authored-by: Krista Pratico --- sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md b/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md index fe4dd1d5af62..e45eb8895d72 100644 --- a/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md +++ b/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md @@ -15,7 +15,7 @@ - [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 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`. From 148b8386e88683450b3f1e1d786cb2fed4ef878d Mon Sep 17 00:00:00 2001 From: Jeremy Meng Date: Thu, 28 May 2020 21:00:44 +0000 Subject: [PATCH 6/9] logging whitelist --- sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md b/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md index e45eb8895d72..584ca95b18ec 100644 --- a/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md +++ b/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md @@ -5,6 +5,7 @@ - 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`. From c12b883277425494ffc9b0d986e42b6b0c239df9 Mon Sep 17 00:00:00 2001 From: Jeremy Meng Date: Thu, 28 May 2020 21:02:43 +0000 Subject: [PATCH 7/9] useTrainingLabels parameter now required --- sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md b/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md index 584ca95b18ec..ce51b29ec8e5 100644 --- a/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md +++ b/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md @@ -29,6 +29,7 @@ - `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. - 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`. From 10558cc62d2fb94e040212b8600082f22b6d68f7 Mon Sep 17 00:00:00 2001 From: Jeremy Meng Date: Sat, 30 May 2020 00:20:15 +0000 Subject: [PATCH 8/9] intervalInMs => updateIntervalInMs --- sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md b/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md index ce51b29ec8e5..51e61388d79b 100644 --- a/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md +++ b/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md @@ -30,6 +30,7 @@ - `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. - 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`. From e7a6a1c4cb54eb9d00d06115cd675558f5443795 Mon Sep 17 00:00:00 2001 From: Jeremy Meng Date: Wed, 3 Jun 2020 00:54:28 +0000 Subject: [PATCH 9/9] Remove USReceipt for preview.3 --- sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md b/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md index 51e61388d79b..7035d849c3d3 100644 --- a/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md +++ b/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md @@ -31,6 +31,7 @@ - [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`.