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.

Interface for accessing Comprehend Amazon Comprehend is an AWS service for gaining insight into the content of documents. Use these actions to determine the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the predominant language used, and more.

Inheritance Hierarchy

Amazon.Comprehend.IAmazonComprehend

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

Syntax

C#
public interface IAmazonComprehend
         IAmazonService, IDisposable

The IAmazonComprehend type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method BatchDetectDominantLanguage(BatchDetectDominantLanguageRequest)

Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.

Public Method BatchDetectDominantLanguageAsync(BatchDetectDominantLanguageRequest, CancellationToken)

Initiates the asynchronous execution of the BatchDetectDominantLanguage operation.

Public Method BatchDetectEntities(BatchDetectEntitiesRequest)

Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see how-entities

Public Method BatchDetectEntitiesAsync(BatchDetectEntitiesRequest, CancellationToken)

Initiates the asynchronous execution of the BatchDetectEntities operation.

Public Method BatchDetectKeyPhrases(BatchDetectKeyPhrasesRequest)

Detects the key noun phrases found in a batch of documents.

Public Method BatchDetectKeyPhrasesAsync(BatchDetectKeyPhrasesRequest, CancellationToken)

Initiates the asynchronous execution of the BatchDetectKeyPhrases operation.

Public Method BatchDetectSentiment(BatchDetectSentimentRequest)

Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.

Public Method BatchDetectSentimentAsync(BatchDetectSentimentRequest, CancellationToken)

Initiates the asynchronous execution of the BatchDetectSentiment operation.

Public Method BatchDetectSyntax(BatchDetectSyntaxRequest)

Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see how-syntax.

Public Method BatchDetectSyntaxAsync(BatchDetectSyntaxRequest, CancellationToken)

Initiates the asynchronous execution of the BatchDetectSyntax operation.

Public Method DescribeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest)

Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.

Public Method DescribeDominantLanguageDetectionJobAsync(DescribeDominantLanguageDetectionJobRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDominantLanguageDetectionJob operation.

Public Method DescribeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest)

Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.

Public Method DescribeEntitiesDetectionJobAsync(DescribeEntitiesDetectionJobRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEntitiesDetectionJob operation.

Public Method DescribeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest)

Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.

Public Method DescribeKeyPhrasesDetectionJobAsync(DescribeKeyPhrasesDetectionJobRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeKeyPhrasesDetectionJob operation.

Public Method DescribeSentimentDetectionJob(DescribeSentimentDetectionJobRequest)

Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.

Public Method DescribeSentimentDetectionJobAsync(DescribeSentimentDetectionJobRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeSentimentDetectionJob operation.

Public Method DescribeTopicsDetectionJob(DescribeTopicsDetectionJobRequest)

Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.

Public Method DescribeTopicsDetectionJobAsync(DescribeTopicsDetectionJobRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeTopicsDetectionJob operation.

Public Method DetectDominantLanguage(DetectDominantLanguageRequest)

Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.

Public Method DetectDominantLanguageAsync(DetectDominantLanguageRequest, CancellationToken)

Initiates the asynchronous execution of the DetectDominantLanguage operation.

Public Method DetectEntities(DetectEntitiesRequest)

Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.

Public Method DetectEntitiesAsync(DetectEntitiesRequest, CancellationToken)

Initiates the asynchronous execution of the DetectEntities operation.

Public Method DetectKeyPhrases(DetectKeyPhrasesRequest)

Detects the key noun phrases found in the text.

Public Method DetectKeyPhrasesAsync(DetectKeyPhrasesRequest, CancellationToken)

Initiates the asynchronous execution of the DetectKeyPhrases operation.

Public Method DetectSentiment(DetectSentimentRequest)

Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).

Public Method DetectSentimentAsync(DetectSentimentRequest, CancellationToken)

Initiates the asynchronous execution of the DetectSentiment operation.

Public Method DetectSyntax(DetectSyntaxRequest)

Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax.

Public Method DetectSyntaxAsync(DetectSyntaxRequest, CancellationToken)

Initiates the asynchronous execution of the DetectSyntax operation.

Public Method ListDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest)

Gets a list of the dominant language detection jobs that you have submitted.

Public Method ListDominantLanguageDetectionJobsAsync(ListDominantLanguageDetectionJobsRequest, CancellationToken)

Initiates the asynchronous execution of the ListDominantLanguageDetectionJobs operation.

Public Method ListEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest)

Gets a list of the entity detection jobs that you have submitted.

Public Method ListEntitiesDetectionJobsAsync(ListEntitiesDetectionJobsRequest, CancellationToken)

Initiates the asynchronous execution of the ListEntitiesDetectionJobs operation.

Public Method ListKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest)

Get a list of key phrase detection jobs that you have submitted.

Public Method ListKeyPhrasesDetectionJobsAsync(ListKeyPhrasesDetectionJobsRequest, CancellationToken)

Initiates the asynchronous execution of the ListKeyPhrasesDetectionJobs operation.

Public Method ListSentimentDetectionJobs(ListSentimentDetectionJobsRequest)

Gets a list of sentiment detection jobs that you have submitted.

Public Method ListSentimentDetectionJobsAsync(ListSentimentDetectionJobsRequest, CancellationToken)

Initiates the asynchronous execution of the ListSentimentDetectionJobs operation.

Public Method ListTopicsDetectionJobs(ListTopicsDetectionJobsRequest)

Gets a list of the topic detection jobs that you have submitted.

Public Method ListTopicsDetectionJobsAsync(ListTopicsDetectionJobsRequest, CancellationToken)

Initiates the asynchronous execution of the ListTopicsDetectionJobs operation.

Public Method StartDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest)

Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.

Public Method StartDominantLanguageDetectionJobAsync(StartDominantLanguageDetectionJobRequest, CancellationToken)

Initiates the asynchronous execution of the StartDominantLanguageDetectionJob operation.

Public Method StartEntitiesDetectionJob(StartEntitiesDetectionJobRequest)

Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.

Public Method StartEntitiesDetectionJobAsync(StartEntitiesDetectionJobRequest, CancellationToken)

Initiates the asynchronous execution of the StartEntitiesDetectionJob operation.

Public Method StartKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest)

Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.

Public Method StartKeyPhrasesDetectionJobAsync(StartKeyPhrasesDetectionJobRequest, CancellationToken)

Initiates the asynchronous execution of the StartKeyPhrasesDetectionJob operation.

Public Method StartSentimentDetectionJob(StartSentimentDetectionJobRequest)

Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job.

Public Method StartSentimentDetectionJobAsync(StartSentimentDetectionJobRequest, CancellationToken)

Initiates the asynchronous execution of the StartSentimentDetectionJob operation.

Public Method StartTopicsDetectionJob(StartTopicsDetectionJobRequest)

Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.

Public Method StartTopicsDetectionJobAsync(StartTopicsDetectionJobRequest, CancellationToken)

Initiates the asynchronous execution of the StartTopicsDetectionJob operation.

Public Method StopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest)

Stops a dominant language detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Public Method StopDominantLanguageDetectionJobAsync(StopDominantLanguageDetectionJobRequest, CancellationToken)

Initiates the asynchronous execution of the StopDominantLanguageDetectionJob operation.

Public Method StopEntitiesDetectionJob(StopEntitiesDetectionJobRequest)

Stops an entities detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Public Method StopEntitiesDetectionJobAsync(StopEntitiesDetectionJobRequest, CancellationToken)

Initiates the asynchronous execution of the StopEntitiesDetectionJob operation.

Public Method StopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest)

Stops a key phrases detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Public Method StopKeyPhrasesDetectionJobAsync(StopKeyPhrasesDetectionJobRequest, CancellationToken)

Initiates the asynchronous execution of the StopKeyPhrasesDetectionJob operation.

Public Method StopSentimentDetectionJob(StopSentimentDetectionJobRequest)

Stops a sentiment detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Public Method StopSentimentDetectionJobAsync(StopSentimentDetectionJobRequest, CancellationToken)

Initiates the asynchronous execution of the StopSentimentDetectionJob operation.

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms