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 text of a batch of documents for named entities and returns information about them. For more information about named entities, see Entities in the Comprehend Developer Guide.

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 BeginBatchDetectEntities and EndBatchDetectEntities.

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

Syntax

C#
public virtual Task<BatchDetectEntitiesResponse> BatchDetectEntitiesAsync(
         BatchDetectEntitiesRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Comprehend.Model.BatchDetectEntitiesRequest

Container for the necessary parameters to execute the BatchDetectEntities 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 BatchDetectEntities service method, as returned by Comprehend.

Exceptions

ExceptionCondition
BatchSizeLimitExceededException The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
InternalServerException An internal server error occurred. Retry your request.
InvalidRequestException The request is invalid.
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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also