AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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. Amazon Comprehend Medical only detects medical entities in English language texts.

The DetectEntitiesV2 operation replaces the DetectEntities operation. This new action uses a different model for determining the entities in your medical text and changes the way that some entities are returned in the output. You should use the DetectEntitiesV2 operation in all new applications.

The DetectEntitiesV2 operation returns the Acuity and Direction entities as attributes instead of types.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDetectEntitiesV2 and EndDetectEntitiesV2.

Namespace: Amazon.ComprehendMedical
Assembly: AWSSDK.ComprehendMedical.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<DetectEntitiesV2Response> DetectEntitiesV2Async(
         DetectEntitiesV2Request request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.ComprehendMedical.Model.DetectEntitiesV2Request

Container for the necessary parameters to execute the DetectEntitiesV2 service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DetectEntitiesV2 service method, as returned by ComprehendMedical.

Exceptions

ExceptionCondition
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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also