detect_entities ¶

detect_entities(
    text: BoundedLengthString,
    *,
    config_overrides: Optional[ComprehendMedicalClientConfig] = None,
) -> DetectEntitiesResponse

The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation instead.

Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information.

Parameters:

text (BoundedLengthString) –

A UTF-8 text string containing the clinical content being examined for entities.

Raises:

InternalServerException –

An internal server error occurred. Retry your request.
InvalidEncodingException –

The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
InvalidRequestException –

The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
ServiceUnavailableException –

The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
TextSizeLimitExceededException –

The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.
TooManyRequestsException –

You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_comprehendmedical/_services/comprehend_medical.py

def detect_entities(
    self,
    text: "capo_comprehendmedical.types.bounded_length_string.BoundedLengthString",
    *,
    config_overrides: Optional[ComprehendMedicalClientConfig] = None,
) -> "capo_comprehendmedical.types.detect_entities_response.DetectEntitiesResponse":
    """<p>The <code>DetectEntities</code> operation is deprecated. You should use the <a>DetectEntitiesV2</a> operation instead.</p> <p>Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information.</p>

    Args:
        text: <p> A UTF-8 text string containing the clinical content being examined for entities.</p>

    Raises:
        capo_comprehendmedical.errors.internal_server_exception.InternalServerException: <p> An internal server error occurred. Retry your request. </p>
        capo_comprehendmedical.errors.invalid_encoding_exception.InvalidEncodingException: <p> The input text was not in valid UTF-8 character encoding. Check your text then retry your request.</p>
        capo_comprehendmedical.errors.invalid_request_exception.InvalidRequestException: <p> The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.</p>
        capo_comprehendmedical.errors.service_unavailable_exception.ServiceUnavailableException: <p> The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request. </p>
        capo_comprehendmedical.errors.text_size_limit_exceeded_exception.TextSizeLimitExceededException: <p> The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request. </p>
        capo_comprehendmedical.errors.too_many_requests_exception.TooManyRequestsException: <p> You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase. </p>
        capo_comprehendmedical.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_comprehendmedical.types.detect_entities_request.DetectEntitiesRequest]",
    ) -> OperationResponse[
        "capo_comprehendmedical.types.detect_entities_response.DetectEntitiesResponse"
    ]:
        import capo_comprehendmedical._operations.comprehend_medical_20181030.detect_entities

        output, http_response = (
            capo_comprehendmedical._operations.comprehend_medical_20181030.detect_entities.detect_entities(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DetectEntities")
    )
    input_: capo_comprehendmedical.types.detect_entities_request.DetectEntitiesRequest = {
        "text": text
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output