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.

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to DetectEntitiesAsync.

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

Syntax

C#
public abstract DetectEntitiesResponse DetectEntities(
         DetectEntitiesRequest request
)

Parameters

request
Type: Amazon.Comprehend.Model.DetectEntitiesRequest

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

Return Value


The response from the DetectEntities service method, as returned by Comprehend.

Exceptions

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

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

See Also