azure-sdk-for-python icon indicating copy to clipboard operation
azure-sdk-for-python copied to clipboard

[Text analytics] Missing enums in HealthcareEntityRelation and HealthcareEntityCategory

Open justinqquall opened this issue 3 years ago • 5 comments

  • Package Name: azure-ai-textanalytics
  • Package Version: 5.2.1
  • Operating System:
  • Python Version: 3.10 Describe the bug The following enums are received from the API but not included in the list of enums for HealthcareEntityRelation
    COURSE_OF_EXAMINATION = "CourseOfExamination"
    COURSE_OF_TREATMENT = "CourseOfTreatment"
    EXAMINATION_FINDS_CONDITION = "ExaminationFindsCondition"
    BODY_SITE_OF_CONDITION = "BodySiteOfCondition"
    BODY_SITE_OF_TREATMENT = "BodySiteOfTreatment"

The following enums are received from the API but not included in the list of enums for HealthcareEntityCategory

    COURSE = "Course"

To Reproduce Steps to reproduce the behavior: Submit a document to healthcare analytics API that would result in extraction of the relations and relation categories described above. Expected behavior The client enum classes should include all enums by the API. If a downstream system relies on the enums of the client naively, it will crash. Screenshots If applicable, add screenshots to help explain your problem. Additional context This happens when using model_version 2022-08-15-preview. Does not appear to happen with older model versions. Probably a pre-release issue but please keep this in mind for next sdk release

justinqquall avatar Nov 09 '22 20:11 justinqquall

Label prediction was below confidence level 0.6 for Model:ServiceLabels: 'Cognitive - Text Analytics:0.094449885,Storage:0.06462542,Tables:0.036182404'

azure-sdk avatar Nov 09 '22 20:11 azure-sdk

Thanks @justinqquall, I'll take a look and get back to you asap.

kristapratico avatar Nov 09 '22 20:11 kristapratico

@peytonfraser these enum values were not defined in the swagger spec for 2022-05-01 and so the SDKs missed exposing them in the GA release. Can you provide the known list of values for these two enums?

kristapratico avatar Nov 09 '22 20:11 kristapratico

Thank you, Krista! Much appreciated. Hope you’re having a nice week.

On Nov 9, 2022, at 12:43 PM, Krista Pratico @.***> wrote:

Thanks @justinqquall https://github.com/justinqquall, I'll take a look and get back to you asap.

— Reply to this email directly, view it on GitHub https://github.com/Azure/azure-sdk-for-python/issues/27406#issuecomment-1309352649, or unsubscribe https://github.com/notifications/unsubscribe-auth/ALH2PG77OID4WEQBKIRMCGDWHQEGRANCNFSM6AAAAAAR32YSXI. You are receiving this because you were mentioned.

justinqquall avatar Nov 09 '22 21:11 justinqquall

Adding @aurghob, can you share all the known values for these two enums?

https://github.com/Azure/azure-rest-api-specs/blob/bdb63328ebe9214f0e513c0073ae7c97c6d4844f/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzetext.json#L825

https://github.com/Azure/azure-rest-api-specs/blob/bdb63328ebe9214f0e513c0073ae7c97c6d4844f/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzetext.json#L919

We need to update the 2022-05-01 swagger to include these and also update 2022-10-01-preview so we can expose these enums in the next SDK release.

kristapratico avatar Nov 09 '22 22:11 kristapratico

Hi, Thanks for bringing this up. We will discuss these with the team that works on the model to make sure there are no other discrepancies before we move forward.

aurghob avatar Nov 14 '22 18:11 aurghob

The enums have been updated in this PR (#30194) and will be available in the 5.3.0 release of the library.

kristapratico avatar Jun 02 '23 18:06 kristapratico