boto / boto3

AWS SDK for Python
https://aws.amazon.com/sdk-for-python/
Apache License 2.0
8.81k stars 1.84k forks source link

Mistake in the ComprehendMedical Documentation #4122

Closed elcho closed 1 month ago

elcho commented 1 month ago

Describe the issue

In the ComprehendMedical/Client/infer_rx_norm/Response Structure/Entities section, the definition for Category and Type are switched. The actual response returned sets the Type to MEDICATION and the Category to one of GENERIC_NAME or BRAND_NAME. The Response Syntax section is correct.

Links

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/comprehendmedical/client/infer_rx_norm.html

tim-finnigan commented 1 month ago

Thanks for reporting this issue, I will escalate this to the Comprehend Medical team to address this since they own the upstream InferRxNorm API / documentation. I also created an issue (https://github.com/aws/aws-sdk/issues/741) to track this in our cross-SDK repository since service APIs like this are used across SDKs.

Please refer to that issue for updates going forward, and I would expect this to get fixed very soon. Thanks again for bringing this to our attention.

github-actions[bot] commented 1 month ago

This issue is now closed. Comments on closed issues are hard for our team to see. If you need more assistance, please open a new issue that references this one.