ComprehendClient Class

(QtAws::Comprehend::ComprehendClient)

The ComprehendClient class provides access to the Amazon Comprehend service. More...

Header: #include <ComprehendClient>
Inherits: QtAws::Core::AwsAbstractClient

Public Functions

ComprehendClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)
ComprehendClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Public Slots

BatchDetectDominantLanguageResponse *batchDetectDominantLanguage(const BatchDetectDominantLanguageRequest &request)
BatchDetectEntitiesResponse *batchDetectEntities(const BatchDetectEntitiesRequest &request)
BatchDetectKeyPhrasesResponse *batchDetectKeyPhrases(const BatchDetectKeyPhrasesRequest &request)
BatchDetectSentimentResponse *batchDetectSentiment(const BatchDetectSentimentRequest &request)
DescribeTopicsDetectionJobResponse *describeTopicsDetectionJob(const DescribeTopicsDetectionJobRequest &request)
DetectDominantLanguageResponse *detectDominantLanguage(const DetectDominantLanguageRequest &request)
DetectEntitiesResponse *detectEntities(const DetectEntitiesRequest &request)
DetectKeyPhrasesResponse *detectKeyPhrases(const DetectKeyPhrasesRequest &request)
DetectSentimentResponse *detectSentiment(const DetectSentimentRequest &request)
ListTopicsDetectionJobsResponse *listTopicsDetectionJobs(const ListTopicsDetectionJobsRequest &request)
StartTopicsDetectionJobResponse *startTopicsDetectionJob(const StartTopicsDetectionJobRequest &request)

Additional Inherited Members

Detailed Description

The ComprehendClient class provides access to the Amazon Comprehend service.

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

Member Function Documentation

ComprehendClient::ComprehendClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a ComprehendClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

ComprehendClient::ComprehendClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads ComprehendClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] BatchDetectDominantLanguageResponse *ComprehendClient::batchDetectDominantLanguage(const BatchDetectDominantLanguageRequest &request)

Sends request to the ComprehendClient service, and returns a pointer to an BatchDetectDominantLanguageResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see <a href="http://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html">Amazon Comprehend Supported Languages</a>.

[slot] BatchDetectEntitiesResponse *ComprehendClient::batchDetectEntities(const BatchDetectEntitiesRequest &request)

Sends request to the ComprehendClient service, and returns a pointer to an BatchDetectEntitiesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] BatchDetectKeyPhrasesResponse *ComprehendClient::batchDetectKeyPhrases(const BatchDetectKeyPhrasesRequest &request)

Sends request to the ComprehendClient service, and returns a pointer to an BatchDetectKeyPhrasesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Detects the key noun phrases found in a batch of

[slot] BatchDetectSentimentResponse *ComprehendClient::batchDetectSentiment(const BatchDetectSentimentRequest &request)

Sends request to the ComprehendClient service, and returns a pointer to an BatchDetectSentimentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Inspects a batch of documents and returns an inference of the prevailing sentiment, <code>POSITIVE</code>, <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NEGATIVE</code>, in each

[slot] DescribeTopicsDetectionJobResponse *ComprehendClient::describeTopicsDetectionJob(const DescribeTopicsDetectionJobRequest &request)

Sends request to the ComprehendClient service, and returns a pointer to an DescribeTopicsDetectionJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DetectDominantLanguageResponse *ComprehendClient::detectDominantLanguage(const DetectDominantLanguageRequest &request)

Sends request to the ComprehendClient service, and returns a pointer to an DetectDominantLanguageResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see <a href="http://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html">Amazon Comprehend Supported Languages</a>.

[slot] DetectEntitiesResponse *ComprehendClient::detectEntities(const DetectEntitiesRequest &request)

Sends request to the ComprehendClient service, and returns a pointer to an DetectEntitiesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Inspects text for entities, and returns information about them. For more information, about entities, see <a>how-entities</a>.

[slot] DetectKeyPhrasesResponse *ComprehendClient::detectKeyPhrases(const DetectKeyPhrasesRequest &request)

Sends request to the ComprehendClient service, and returns a pointer to an DetectKeyPhrasesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Detects the key noun phrases found in the text.

[slot] DetectSentimentResponse *ComprehendClient::detectSentiment(const DetectSentimentRequest &request)

Sends request to the ComprehendClient service, and returns a pointer to an DetectSentimentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListTopicsDetectionJobsResponse *ComprehendClient::listTopicsDetectionJobs(const ListTopicsDetectionJobsRequest &request)

Sends request to the ComprehendClient service, and returns a pointer to an ListTopicsDetectionJobsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets a list of the topic detection jobs that you have

[slot] StartTopicsDetectionJobResponse *ComprehendClient::startTopicsDetectionJob(const StartTopicsDetectionJobRequest &request)

Sends request to the ComprehendClient service, and returns a pointer to an StartTopicsDetectionJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.