com.amazonaws.services.comprehend

Class AmazonComprehendClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.comprehend.AmazonComprehendClient

All Implemented Interfaces:

AmazonComprehend

Direct Known Subclasses:

AmazonComprehendAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonComprehendClient
extends AmazonWebServiceClient
implements AmazonComprehend

Client for accessing Amazon Comprehend. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.comprehend.AmazonComprehend

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
BatchDetectDominantLanguageResult	batchDetectDominantLanguage(BatchDetectDominantLanguageRequest request) Determines the dominant language of the input text for a batch of documents.
BatchDetectEntitiesResult	batchDetectEntities(BatchDetectEntitiesRequest request) Inspects the text of a batch of documents and returns information about them.
BatchDetectKeyPhrasesResult	batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest request) Detects the key noun phrases found in a batch of documents.
BatchDetectSentimentResult	batchDetectSentiment(BatchDetectSentimentRequest request) Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.
static AmazonComprehendClientBuilder	builder()
DescribeTopicsDetectionJobResult	describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest request) Gets the properties associated with a topic detection job.
DetectDominantLanguageResult	detectDominantLanguage(DetectDominantLanguageRequest request) Determines the dominant language of the input text.
DetectEntitiesResult	detectEntities(DetectEntitiesRequest request) Inspects text for entities, and returns information about them.
DetectKeyPhrasesResult	detectKeyPhrases(DetectKeyPhrasesRequest request) Detects the key noun phrases found in the text.
DetectSentimentResult	detectSentiment(DetectSentimentRequest request) Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
ListTopicsDetectionJobsResult	listTopicsDetectionJobs(ListTopicsDetectionJobsRequest request) Gets a list of the topic detection jobs that you have submitted.
StartTopicsDetectionJobResult	startTopicsDetectionJob(StartTopicsDetectionJobRequest request) Starts an asynchronous topic detection job.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.comprehend.AmazonComprehend

shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AmazonComprehendClientBuilder builder()

batchDetectDominantLanguage

public BatchDetectDominantLanguageResult batchDetectDominantLanguage(BatchDetectDominantLanguageRequest request)

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.

Specified by:

batchDetectDominantLanguage in interface AmazonComprehend

Parameters:

batchDetectDominantLanguageRequest -

Returns:

Result of the BatchDetectDominantLanguage operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

TextSizeLimitExceededException - The size of the input text exceeds the limit. Use a smaller document.

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.

See Also:

AWS API Documentation

batchDetectEntities

public BatchDetectEntitiesResult batchDetectEntities(BatchDetectEntitiesRequest request)

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

Specified by:

batchDetectEntities in interface AmazonComprehend

Parameters:

batchDetectEntitiesRequest -

Returns:

Result of the BatchDetectEntities operation returned by the service.

Throws:

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 all APIs except DetectDominantLanguage, Amazon Comprehend accepts only English or Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects 100 languages. For a list of languages, see how-languages

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.

See Also:

AWS API Documentation

batchDetectKeyPhrases

public BatchDetectKeyPhrasesResult batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest request)

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

Specified by:

batchDetectKeyPhrases in interface AmazonComprehend

Parameters:

batchDetectKeyPhrasesRequest -

Returns:

Result of the BatchDetectKeyPhrases operation returned by the service.

Throws:

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 all APIs except DetectDominantLanguage, Amazon Comprehend accepts only English or Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects 100 languages. For a list of languages, see how-languages

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.

See Also:

AWS API Documentation

batchDetectSentiment

public BatchDetectSentimentResult batchDetectSentiment(BatchDetectSentimentRequest request)

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

Specified by:

batchDetectSentiment in interface AmazonComprehend

Parameters:

batchDetectSentimentRequest -

Returns:

Result of the BatchDetectSentiment operation returned by the service.

Throws:

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 all APIs except DetectDominantLanguage, Amazon Comprehend accepts only English or Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects 100 languages. For a list of languages, see how-languages

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.

See Also:

AWS API Documentation

describeTopicsDetectionJob

public DescribeTopicsDetectionJobResult describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest request)

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

Specified by:

describeTopicsDetectionJob in interface AmazonComprehend

Parameters:

describeTopicsDetectionJobRequest -

Returns:

Result of the DescribeTopicsDetectionJob operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

JobNotFoundException - The specified job was not found. Check the job ID and try again.

TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

detectDominantLanguage

public DetectDominantLanguageResult detectDominantLanguage(DetectDominantLanguageRequest request)

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

Specified by:

detectDominantLanguage in interface AmazonComprehend

Parameters:

detectDominantLanguageRequest -

Returns:

Result of the DetectDominantLanguage operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

TextSizeLimitExceededException - The size of the input text exceeds the limit. Use a smaller document.

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

detectEntities

public DetectEntitiesResult detectEntities(DetectEntitiesRequest request)

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

Specified by:

detectEntities in interface AmazonComprehend

Parameters:

detectEntitiesRequest -

Returns:

Result of the DetectEntities operation returned by the service.

Throws:

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 all APIs except DetectDominantLanguage, Amazon Comprehend accepts only English or Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects 100 languages. For a list of languages, see how-languages

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

detectKeyPhrases

public DetectKeyPhrasesResult detectKeyPhrases(DetectKeyPhrasesRequest request)

Detects the key noun phrases found in the text.

Specified by:

detectKeyPhrases in interface AmazonComprehend

Parameters:

detectKeyPhrasesRequest -

Returns:

Result of the DetectKeyPhrases operation returned by the service.

Throws:

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 all APIs except DetectDominantLanguage, Amazon Comprehend accepts only English or Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects 100 languages. For a list of languages, see how-languages

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

detectSentiment

public DetectSentimentResult detectSentiment(DetectSentimentRequest request)

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

Specified by:

detectSentiment in interface AmazonComprehend

Parameters:

detectSentimentRequest -

Returns:

Result of the DetectSentiment operation returned by the service.

Throws:

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 all APIs except DetectDominantLanguage, Amazon Comprehend accepts only English or Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects 100 languages. For a list of languages, see how-languages

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

listTopicsDetectionJobs

public ListTopicsDetectionJobsResult listTopicsDetectionJobs(ListTopicsDetectionJobsRequest request)

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

Specified by:

listTopicsDetectionJobs in interface AmazonComprehend

Parameters:

listTopicsDetectionJobsRequest -

Returns:

Result of the ListTopicsDetectionJobs operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.

InvalidFilterException - The filter specified for the ListTopicDetectionJobs operation is invalid. Specify a different filter.

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

startTopicsDetectionJob

public StartTopicsDetectionJobResult startTopicsDetectionJob(StartTopicsDetectionJobRequest request)

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

Specified by:

startTopicsDetectionJob in interface AmazonComprehend

Parameters:

startTopicsDetectionJobRequest -

Returns:

Result of the StartTopicsDetectionJob operation returned by the service.

Throws:

InvalidRequestException - The request is invalid.

TooManyRequestsException - The number of requests exceeds the limit. Resubmit your request later.

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonComprehend

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.