@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonComprehend extends Object implements AmazonComprehend
AmazonComprehend. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| 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 for named entities 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. |
BatchDetectSyntaxResult |
batchDetectSyntax(BatchDetectSyntaxRequest request)
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.
|
CreateDocumentClassifierResult |
createDocumentClassifier(CreateDocumentClassifierRequest request)
Creates a new document classifier that you can use to categorize documents.
|
CreateEntityRecognizerResult |
createEntityRecognizer(CreateEntityRecognizerRequest request)
Creates an entity recognizer using submitted files.
|
DeleteDocumentClassifierResult |
deleteDocumentClassifier(DeleteDocumentClassifierRequest request)
Deletes a previously created document classifier
|
DeleteEntityRecognizerResult |
deleteEntityRecognizer(DeleteEntityRecognizerRequest request)
Deletes an entity recognizer.
|
DescribeDocumentClassificationJobResult |
describeDocumentClassificationJob(DescribeDocumentClassificationJobRequest request)
Gets the properties associated with a document classification job.
|
DescribeDocumentClassifierResult |
describeDocumentClassifier(DescribeDocumentClassifierRequest request)
Gets the properties associated with a document classifier.
|
DescribeDominantLanguageDetectionJobResult |
describeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest request)
Gets the properties associated with a dominant language detection job.
|
DescribeEntitiesDetectionJobResult |
describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest request)
Gets the properties associated with an entities detection job.
|
DescribeEntityRecognizerResult |
describeEntityRecognizer(DescribeEntityRecognizerRequest request)
Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer
metadata, metrics, and so on.
|
DescribeKeyPhrasesDetectionJobResult |
describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest request)
Gets the properties associated with a key phrases detection job.
|
DescribeSentimentDetectionJobResult |
describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest request)
Gets the properties associated with a sentiment detection job.
|
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 named 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). |
DetectSyntaxResult |
detectSyntax(DetectSyntaxRequest request)
Inspects text for syntax and the part of speech of words in the document.
|
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.
|
ListDocumentClassificationJobsResult |
listDocumentClassificationJobs(ListDocumentClassificationJobsRequest request)
Gets a list of the documentation classification jobs that you have submitted.
|
ListDocumentClassifiersResult |
listDocumentClassifiers(ListDocumentClassifiersRequest request)
Gets a list of the document classifiers that you have created.
|
ListDominantLanguageDetectionJobsResult |
listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest request)
Gets a list of the dominant language detection jobs that you have submitted.
|
ListEntitiesDetectionJobsResult |
listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest request)
Gets a list of the entity detection jobs that you have submitted.
|
ListEntityRecognizersResult |
listEntityRecognizers(ListEntityRecognizersRequest request)
Gets a list of the properties of all entity recognizers that you created, including recognizers currently in
training.
|
ListKeyPhrasesDetectionJobsResult |
listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest request)
Get a list of key phrase detection jobs that you have submitted.
|
ListSentimentDetectionJobsResult |
listSentimentDetectionJobs(ListSentimentDetectionJobsRequest request)
Gets a list of sentiment detection jobs that you have submitted.
|
ListTopicsDetectionJobsResult |
listTopicsDetectionJobs(ListTopicsDetectionJobsRequest request)
Gets a list of the topic detection jobs that you have submitted.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartDocumentClassificationJobResult |
startDocumentClassificationJob(StartDocumentClassificationJobRequest request)
Starts an asynchronous document classification job.
|
StartDominantLanguageDetectionJobResult |
startDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest request)
Starts an asynchronous dominant language detection job for a collection of documents.
|
StartEntitiesDetectionJobResult |
startEntitiesDetectionJob(StartEntitiesDetectionJobRequest request)
Starts an asynchronous entity detection job for a collection of documents.
|
StartKeyPhrasesDetectionJobResult |
startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest request)
Starts an asynchronous key phrase detection job for a collection of documents.
|
StartSentimentDetectionJobResult |
startSentimentDetectionJob(StartSentimentDetectionJobRequest request)
Starts an asynchronous sentiment detection job for a collection of documents.
|
StartTopicsDetectionJobResult |
startTopicsDetectionJob(StartTopicsDetectionJobRequest request)
Starts an asynchronous topic detection job.
|
StopDominantLanguageDetectionJobResult |
stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest request)
Stops a dominant language detection job in progress.
|
StopEntitiesDetectionJobResult |
stopEntitiesDetectionJob(StopEntitiesDetectionJobRequest request)
Stops an entities detection job in progress.
|
StopKeyPhrasesDetectionJobResult |
stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest request)
Stops a key phrases detection job in progress.
|
StopSentimentDetectionJobResult |
stopSentimentDetectionJob(StopSentimentDetectionJobRequest request)
Stops a sentiment detection job in progress.
|
StopTrainingDocumentClassifierResult |
stopTrainingDocumentClassifier(StopTrainingDocumentClassifierRequest request)
Stops a document classifier training job while in progress.
|
StopTrainingEntityRecognizerResult |
stopTrainingEntityRecognizer(StopTrainingEntityRecognizerRequest request)
Stops an entity recognizer training job while in progress.
|
public BatchDetectDominantLanguageResult batchDetectDominantLanguage(BatchDetectDominantLanguageRequest request)
AmazonComprehendDetermines 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.
batchDetectDominantLanguage in interface AmazonComprehendpublic BatchDetectEntitiesResult batchDetectEntities(BatchDetectEntitiesRequest request)
AmazonComprehendInspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see how-entities
batchDetectEntities in interface AmazonComprehendpublic BatchDetectKeyPhrasesResult batchDetectKeyPhrases(BatchDetectKeyPhrasesRequest request)
AmazonComprehendDetects the key noun phrases found in a batch of documents.
batchDetectKeyPhrases in interface AmazonComprehendpublic BatchDetectSentimentResult batchDetectSentiment(BatchDetectSentimentRequest request)
AmazonComprehend
Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE,
NEUTRAL, MIXED, or NEGATIVE, in each one.
batchDetectSentiment in interface AmazonComprehendpublic BatchDetectSyntaxResult batchDetectSyntax(BatchDetectSyntaxRequest request)
AmazonComprehendInspects 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.
batchDetectSyntax in interface AmazonComprehendpublic CreateDocumentClassifierResult createDocumentClassifier(CreateDocumentClassifierRequest request)
AmazonComprehendCreates a new document classifier that you can use to categorize documents. To create a classifier you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see how-document-classification.
createDocumentClassifier in interface AmazonComprehendpublic CreateEntityRecognizerResult createEntityRecognizer(CreateEntityRecognizerRequest request)
AmazonComprehend
Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is
submitted, you can check job status using the API.
createEntityRecognizer in interface AmazonComprehendpublic DeleteDocumentClassifierResult deleteDocumentClassifier(DeleteDocumentClassifierRequest request)
AmazonComprehendDeletes a previously created document classifier
Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference
job is using the model, a ResourceInUseException will be returned.
This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.
deleteDocumentClassifier in interface AmazonComprehendpublic DeleteEntityRecognizerResult deleteEntityRecognizer(DeleteEntityRecognizerRequest request)
AmazonComprehendDeletes an entity recognizer.
Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference
job is using the model, a ResourceInUseException will be returned.
This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.
deleteEntityRecognizer in interface AmazonComprehendpublic DescribeDocumentClassificationJobResult describeDocumentClassificationJob(DescribeDocumentClassificationJobRequest request)
AmazonComprehendGets the properties associated with a document classification job. Use this operation to get the status of a classification job.
describeDocumentClassificationJob in interface AmazonComprehendpublic DescribeDocumentClassifierResult describeDocumentClassifier(DescribeDocumentClassifierRequest request)
AmazonComprehendGets the properties associated with a document classifier.
describeDocumentClassifier in interface AmazonComprehendpublic DescribeDominantLanguageDetectionJobResult describeDominantLanguageDetectionJob(DescribeDominantLanguageDetectionJobRequest request)
AmazonComprehendGets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
describeDominantLanguageDetectionJob in interface AmazonComprehendpublic DescribeEntitiesDetectionJobResult describeEntitiesDetectionJob(DescribeEntitiesDetectionJobRequest request)
AmazonComprehendGets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
describeEntitiesDetectionJob in interface AmazonComprehendpublic DescribeEntityRecognizerResult describeEntityRecognizer(DescribeEntityRecognizerRequest request)
AmazonComprehendProvides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
describeEntityRecognizer in interface AmazonComprehendpublic DescribeKeyPhrasesDetectionJobResult describeKeyPhrasesDetectionJob(DescribeKeyPhrasesDetectionJobRequest request)
AmazonComprehendGets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
describeKeyPhrasesDetectionJob in interface AmazonComprehendpublic DescribeSentimentDetectionJobResult describeSentimentDetectionJob(DescribeSentimentDetectionJobRequest request)
AmazonComprehendGets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
describeSentimentDetectionJob in interface AmazonComprehendpublic DescribeTopicsDetectionJobResult describeTopicsDetectionJob(DescribeTopicsDetectionJobRequest request)
AmazonComprehendGets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
describeTopicsDetectionJob in interface AmazonComprehendpublic DetectDominantLanguageResult detectDominantLanguage(DetectDominantLanguageRequest request)
AmazonComprehendDetermines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
detectDominantLanguage in interface AmazonComprehendpublic DetectEntitiesResult detectEntities(DetectEntitiesRequest request)
AmazonComprehendInspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.
detectEntities in interface AmazonComprehendpublic DetectKeyPhrasesResult detectKeyPhrases(DetectKeyPhrasesRequest request)
AmazonComprehendDetects the key noun phrases found in the text.
detectKeyPhrases in interface AmazonComprehendpublic DetectSentimentResult detectSentiment(DetectSentimentRequest request)
AmazonComprehend
Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL,
MIXED, or NEGATIVE).
detectSentiment in interface AmazonComprehendpublic DetectSyntaxResult detectSyntax(DetectSyntaxRequest request)
AmazonComprehendInspects text for syntax and the part of speech of words in the document. For more information, how-syntax.
detectSyntax in interface AmazonComprehendpublic ListDocumentClassificationJobsResult listDocumentClassificationJobs(ListDocumentClassificationJobsRequest request)
AmazonComprehendGets a list of the documentation classification jobs that you have submitted.
listDocumentClassificationJobs in interface AmazonComprehendpublic ListDocumentClassifiersResult listDocumentClassifiers(ListDocumentClassifiersRequest request)
AmazonComprehendGets a list of the document classifiers that you have created.
listDocumentClassifiers in interface AmazonComprehendpublic ListDominantLanguageDetectionJobsResult listDominantLanguageDetectionJobs(ListDominantLanguageDetectionJobsRequest request)
AmazonComprehendGets a list of the dominant language detection jobs that you have submitted.
listDominantLanguageDetectionJobs in interface AmazonComprehendpublic ListEntitiesDetectionJobsResult listEntitiesDetectionJobs(ListEntitiesDetectionJobsRequest request)
AmazonComprehendGets a list of the entity detection jobs that you have submitted.
listEntitiesDetectionJobs in interface AmazonComprehendpublic ListEntityRecognizersResult listEntityRecognizers(ListEntityRecognizersRequest request)
AmazonComprehendGets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.
The results of this list are not in any particular order. Please get the list and sort locally if needed.
listEntityRecognizers in interface AmazonComprehendpublic ListKeyPhrasesDetectionJobsResult listKeyPhrasesDetectionJobs(ListKeyPhrasesDetectionJobsRequest request)
AmazonComprehendGet a list of key phrase detection jobs that you have submitted.
listKeyPhrasesDetectionJobs in interface AmazonComprehendpublic ListSentimentDetectionJobsResult listSentimentDetectionJobs(ListSentimentDetectionJobsRequest request)
AmazonComprehendGets a list of sentiment detection jobs that you have submitted.
listSentimentDetectionJobs in interface AmazonComprehendpublic ListTopicsDetectionJobsResult listTopicsDetectionJobs(ListTopicsDetectionJobsRequest request)
AmazonComprehendGets a list of the topic detection jobs that you have submitted.
listTopicsDetectionJobs in interface AmazonComprehendpublic StartDocumentClassificationJobResult startDocumentClassificationJob(StartDocumentClassificationJobRequest request)
AmazonComprehendStarts an asynchronous document classification job. Use the operation to track the progress of the job.
startDocumentClassificationJob in interface AmazonComprehendpublic StartDominantLanguageDetectionJobResult startDominantLanguageDetectionJob(StartDominantLanguageDetectionJobRequest request)
AmazonComprehendStarts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.
startDominantLanguageDetectionJob in interface AmazonComprehendpublic StartEntitiesDetectionJobResult startEntitiesDetectionJob(StartEntitiesDetectionJobRequest request)
AmazonComprehendStarts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.
This API can be used for either standard entity detection or custom entity recognition. In order to be used for
custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access
to the recognizer being used to detect the custom entity.
startEntitiesDetectionJob in interface AmazonComprehendpublic StartKeyPhrasesDetectionJobResult startKeyPhrasesDetectionJob(StartKeyPhrasesDetectionJobRequest request)
AmazonComprehendStarts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
startKeyPhrasesDetectionJob in interface AmazonComprehendpublic StartSentimentDetectionJobResult startSentimentDetectionJob(StartSentimentDetectionJobRequest request)
AmazonComprehendStarts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job.
startSentimentDetectionJob in interface AmazonComprehendpublic StartTopicsDetectionJobResult startTopicsDetectionJob(StartTopicsDetectionJobRequest request)
AmazonComprehend
Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the
status of a job.
startTopicsDetectionJob in interface AmazonComprehendpublic StopDominantLanguageDetectionJobResult stopDominantLanguageDetectionJob(StopDominantLanguageDetectionJobRequest request)
AmazonComprehendStops 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.
stopDominantLanguageDetectionJob in interface AmazonComprehendpublic StopEntitiesDetectionJobResult stopEntitiesDetectionJob(StopEntitiesDetectionJobRequest request)
AmazonComprehendStops 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.
stopEntitiesDetectionJob in interface AmazonComprehendpublic StopKeyPhrasesDetectionJobResult stopKeyPhrasesDetectionJob(StopKeyPhrasesDetectionJobRequest request)
AmazonComprehendStops 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.
stopKeyPhrasesDetectionJob in interface AmazonComprehendpublic StopSentimentDetectionJobResult stopSentimentDetectionJob(StopSentimentDetectionJobRequest request)
AmazonComprehendStops 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.
stopSentimentDetectionJob in interface AmazonComprehendpublic StopTrainingDocumentClassifierResult stopTrainingDocumentClassifier(StopTrainingDocumentClassifierRequest request)
AmazonComprehendStops a document classifier training job while in progress.
If the training job state is TRAINING, the job is marked for termination and put into the
STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the
TRAINED; otherwise the training job is stopped and put into the STOPPED state and the
service sends back an HTTP 200 response with an empty HTTP body.
stopTrainingDocumentClassifier in interface AmazonComprehendpublic StopTrainingEntityRecognizerResult stopTrainingEntityRecognizer(StopTrainingEntityRecognizerRequest request)
AmazonComprehendStops an entity recognizer training job while in progress.
If the training job state is TRAINING, the job is marked for termination and put into the
STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the
TRAINED; otherwise the training job is stopped and putted into the STOPPED state and
the service sends back an HTTP 200 response with an empty HTTP body.
stopTrainingEntityRecognizer in interface AmazonComprehendpublic void shutdown()
AmazonComprehendshutdown in interface AmazonComprehendpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonComprehendResponse 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 a request.
getCachedResponseMetadata in interface AmazonComprehendrequest - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.