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.
Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model.
When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see Entities in the Comprehend Developer Guide.
When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
If the system detects errors while processing a page in the input document, the API
response includes an entry in Errors for each error.
If the system detects a document-level error in your input document, the API returns
an InvalidRequestException error response. For details about this exception,
see
Errors in semi-structured documents in the Comprehend Developer Guide.
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 BeginDetectEntities and EndDetectEntities.
Namespace: Amazon.Comprehend
Assembly: AWSSDK.Comprehend.dll
Version: 3.x.y.z
public virtual Task<DetectEntitiesResponse> DetectEntitiesAsync( DetectEntitiesRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the DetectEntities service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| InternalServerException | An internal server error occurred. Retry your request. |
| InvalidRequestException | The request is invalid. |
| ResourceUnavailableException | The specified resource is not available. Check the resource and try your request again. |
| TextSizeLimitExceededException | The size of the input text exceeds the limit. Use a smaller document. |
| UnsupportedLanguageException | Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5