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.

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

Improve samples for Healthcare #17810

Closed
maririos opened this issue Jan 6, 2021 · 2 comments
Closed

Improve samples for Healthcare #17810

maririos opened this issue Jan 6, 2021 · 2 comments
Assignees
Labels
blocking-release Blocks release Client This issue points to a problem in the data-plane of the library. Cognitive - Text Analytics
Milestone

Comments

@maririos
Copy link
Member

maririos commented Jan 6, 2021

Now that there is no single document method, there are extra samples that we don't need. We should organize them again and end up having:

  • batch convenience async with automatic polling
  • batch convenience sync with manual polling
  • batch with TextDocumentInput async with automatic polling and with statistics = true
  • batch with TextDocumentInput sync with manual polling
  • cancellation async
  • cancellation sync
@maririos maririos added blocking-release Blocks release Client This issue points to a problem in the data-plane of the library. Cognitive - Text Analytics labels Jan 6, 2021
@maririos maririos added this to the [2021] February milestone Jan 6, 2021
@maririos maririos modified the milestones: [2021] February, [2021] March Feb 8, 2021
@maririos
Copy link
Member Author

maririos commented Feb 10, 2021

Similar to the work done in #17811

Other things to change:

In sample.cs files:

  • Sample should also show operation information like CreatedOn, ExpiresOn, etc...
  • Sample should also print the relations information
  • Sample should check that there were document errors. Example, see here.

sample.md:

  • Name needs to change to Sample_AnalyzeHealthcareEntities or Sample8_?.
  • Remove section Recognizing healthcare entities in a single document
  • Remove the word asynchronously from the description. The idea is that the sample by default shows the sync behavior and at the end there are links for the async behavior
  • Description of the content needs to be updated to reflect the new names
  • There should be code for the convenience batch and for the TextInputDocument. like here.
  • Note how the user shouldn't scroll right in order to see all the content. The sample code needs to be modified so this is reflected. See an example here.

@maririos
Copy link
Member Author

maririos commented Mar 5, 2021

Fixed in #19248

@maririos maririos closed this as completed Mar 5, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Mar 28, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
blocking-release Blocks release Client This issue points to a problem in the data-plane of the library. Cognitive - Text Analytics
Projects
None yet
Development

No branches or pull requests

2 participants