Skip to content

[formrecognizer] rename input parameters#11518

Merged
kristapratico merged 1 commit intoAzure:masterfrom
kristapratico:fr-rename-input
May 19, 2020
Merged

[formrecognizer] rename input parameters#11518
kristapratico merged 1 commit intoAzure:masterfrom
kristapratico:fr-rename-input

Conversation

@kristapratico
Copy link
Contributor

@kristapratico kristapratico commented May 19, 2020

Issue is item on #11283

During arch board, we got feedback that the naming of our input parameters was too specific since the input need not be a file stream (params presented at arch board were form_file_stream and form_file_url). This PR does the following renames:

  • url -> form_url or receipt_url
  • stream -> form or receipt

Also fixes some paths in the async samples.

@kristapratico kristapratico added Cognitive Services Client This issue points to a problem in the data-plane of the library. FormRecognizer labels May 19, 2020
@kristapratico kristapratico self-assigned this May 19, 2020
@kristapratico kristapratico marked this pull request as ready for review May 19, 2020 18:55
@kristapratico kristapratico requested a review from iscai-msft as a code owner May 19, 2020 18:55
@kristapratico kristapratico requested a review from rakshith91 May 19, 2020 18:55
Copy link
Contributor

@iscai-msft iscai-msft left a comment

Choose a reason for hiding this comment

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

:shipit:

@@ -52,7 +50,7 @@ async def get_bounding_boxes(self):
# Make sure your form's type is included in the list of form types the custom model can recognize
with open(path_to_sample_forms, "rb") as f:
forms = await form_recognizer_client.recognize_custom_forms(
Copy link
Contributor

Choose a reason for hiding this comment

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

can fix this later but just a heads up - looks like we might get an unclosed client session warning here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

the async with is there, just hidden in the collapsed lines

@kristapratico
Copy link
Contributor Author

/check-enforcer evaluate

@kristapratico kristapratico merged commit af6b719 into Azure:master May 19, 2020
@kristapratico kristapratico deleted the fr-rename-input branch May 19, 2020 21:16
iscai-msft added a commit to iscai-msft/azure-sdk-for-python that referenced this pull request May 21, 2020
…into make_canary_test

* 'master' of https://github.com/Azure/azure-sdk-for-python: (28 commits)
  Kaihuis maps (Azure#11574)
  [formrecognizer] support Copy API (Azure#11372)
  Artifact Powered Docs.MS Release (Azure#11395)
  Sync eng/common directory with azure-sdk-tools repository (Azure#11562)
  Updated changelog (Azure#11554)
  update pinned versions in autorest_req.txt (Azure#11557)
  Add user authentication API to UsernamePasswordCredential (Azure#11528)
  Reduce Build Matrix (Azure#11539)
  Prevent Key Vault test failure due to operation timing (Azure#11552)
  update tests (Azure#11534)
  Datashare 2019 11 01 (Azure#11540)
  Search Renames / Regen (Azure#11342)
  update unit test according to the latest uamqp update (Azure#11533)
  Sync eng/common directory with azure-sdk-tools repository (Azure#11472)
  rename input parameters (Azure#11518)
  [cosmos] readme review feedback (Azure#11527)
  Update CODEOWNERS (Azure#11516)
  [Core] Support multipart changesets (Azure#10972)
  fix AttributeException (Azure#11463)
  release-for-hanaonazure-mgmt (Azure#11441)
  ...
iscai-msft added a commit that referenced this pull request May 21, 2020
…into feature/text_analytics_v3.0

* 'master' of https://github.com/Azure/azure-sdk-for-python: (28 commits)
  Kaihuis maps (#11574)
  [formrecognizer] support Copy API (#11372)
  Artifact Powered Docs.MS Release (#11395)
  Sync eng/common directory with azure-sdk-tools repository (#11562)
  Updated changelog (#11554)
  update pinned versions in autorest_req.txt (#11557)
  Add user authentication API to UsernamePasswordCredential (#11528)
  Reduce Build Matrix (#11539)
  Prevent Key Vault test failure due to operation timing (#11552)
  update tests (#11534)
  Datashare 2019 11 01 (#11540)
  Search Renames / Regen (#11342)
  update unit test according to the latest uamqp update (#11533)
  Sync eng/common directory with azure-sdk-tools repository (#11472)
  rename input parameters (#11518)
  [cosmos] readme review feedback (#11527)
  Update CODEOWNERS (#11516)
  [Core] Support multipart changesets (#10972)
  fix AttributeException (#11463)
  release-for-hanaonazure-mgmt (#11441)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Client This issue points to a problem in the data-plane of the library. Cognitive - Form Recognizer Cognitive Services

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants