NAME

Paws::Comprehend - Perl Interface to AWS Amazon Comprehend

SYNOPSIS

  use Paws;

  my $obj = Paws->service('Comprehend');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

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.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27

METHODS

BatchDetectDominantLanguage

TextList => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Comprehend::BatchDetectDominantLanguage

Returns: a Paws::Comprehend::BatchDetectDominantLanguageResponse instance

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 (https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html).

BatchDetectEntities

LanguageCode => Str
TextList => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Comprehend::BatchDetectEntities

Returns: a Paws::Comprehend::BatchDetectEntitiesResponse instance

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

BatchDetectKeyPhrases

LanguageCode => Str
TextList => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Comprehend::BatchDetectKeyPhrases

Returns: a Paws::Comprehend::BatchDetectKeyPhrasesResponse instance

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

BatchDetectSentiment

LanguageCode => Str
TextList => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Comprehend::BatchDetectSentiment

Returns: a Paws::Comprehend::BatchDetectSentimentResponse instance

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

BatchDetectSyntax

LanguageCode => Str
TextList => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Comprehend::BatchDetectSyntax

Returns: a Paws::Comprehend::BatchDetectSyntaxResponse instance

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.

CreateDocumentClassifier

DataAccessRoleArn => Str
DocumentClassifierName => Str
InputDataConfig => Paws::Comprehend::DocumentClassifierInputDataConfig
LanguageCode => Str
[ClientRequestToken => Str]
[OutputDataConfig => Paws::Comprehend::DocumentClassifierOutputDataConfig]
[Tags => ArrayRef[Paws::Comprehend::Tag]]
[VolumeKmsKeyId => Str]
[VpcConfig => Paws::Comprehend::VpcConfig]

Each argument is described in detail in: Paws::Comprehend::CreateDocumentClassifier

Returns: a Paws::Comprehend::CreateDocumentClassifierResponse instance

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

CreateEntityRecognizer

DataAccessRoleArn => Str
InputDataConfig => Paws::Comprehend::EntityRecognizerInputDataConfig
LanguageCode => Str
RecognizerName => Str
[ClientRequestToken => Str]
[Tags => ArrayRef[Paws::Comprehend::Tag]]
[VolumeKmsKeyId => Str]
[VpcConfig => Paws::Comprehend::VpcConfig]

Each argument is described in detail in: Paws::Comprehend::CreateEntityRecognizer

Returns: a Paws::Comprehend::CreateEntityRecognizerResponse instance

Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API.

DeleteDocumentClassifier

DocumentClassifierArn => Str

Each argument is described in detail in: Paws::Comprehend::DeleteDocumentClassifier

Returns: a Paws::Comprehend::DeleteDocumentClassifierResponse instance

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

DeleteEntityRecognizer

EntityRecognizerArn => Str

Each argument is described in detail in: Paws::Comprehend::DeleteEntityRecognizer

Returns: a Paws::Comprehend::DeleteEntityRecognizerResponse instance

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

DescribeDocumentClassificationJob

JobId => Str

Each argument is described in detail in: Paws::Comprehend::DescribeDocumentClassificationJob

Returns: a Paws::Comprehend::DescribeDocumentClassificationJobResponse instance

Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.

DescribeDocumentClassifier

DocumentClassifierArn => Str

Each argument is described in detail in: Paws::Comprehend::DescribeDocumentClassifier

Returns: a Paws::Comprehend::DescribeDocumentClassifierResponse instance

Gets the properties associated with a document classifier.

DescribeDominantLanguageDetectionJob

JobId => Str

Each argument is described in detail in: Paws::Comprehend::DescribeDominantLanguageDetectionJob

Returns: a Paws::Comprehend::DescribeDominantLanguageDetectionJobResponse instance

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

DescribeEntitiesDetectionJob

JobId => Str

Each argument is described in detail in: Paws::Comprehend::DescribeEntitiesDetectionJob

Returns: a Paws::Comprehend::DescribeEntitiesDetectionJobResponse instance

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

DescribeEntityRecognizer

EntityRecognizerArn => Str

Each argument is described in detail in: Paws::Comprehend::DescribeEntityRecognizer

Returns: a Paws::Comprehend::DescribeEntityRecognizerResponse instance

Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.

DescribeKeyPhrasesDetectionJob

JobId => Str

Each argument is described in detail in: Paws::Comprehend::DescribeKeyPhrasesDetectionJob

Returns: a Paws::Comprehend::DescribeKeyPhrasesDetectionJobResponse instance

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

DescribeSentimentDetectionJob

JobId => Str

Each argument is described in detail in: Paws::Comprehend::DescribeSentimentDetectionJob

Returns: a Paws::Comprehend::DescribeSentimentDetectionJobResponse instance

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

DescribeTopicsDetectionJob

JobId => Str

Each argument is described in detail in: Paws::Comprehend::DescribeTopicsDetectionJob

Returns: a Paws::Comprehend::DescribeTopicsDetectionJobResponse instance

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

DetectDominantLanguage

Text => Str

Each argument is described in detail in: Paws::Comprehend::DetectDominantLanguage

Returns: a Paws::Comprehend::DetectDominantLanguageResponse instance

Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages (https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html).

DetectEntities

LanguageCode => Str
Text => Str

Each argument is described in detail in: Paws::Comprehend::DetectEntities

Returns: a Paws::Comprehend::DetectEntitiesResponse instance

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

DetectKeyPhrases

LanguageCode => Str
Text => Str

Each argument is described in detail in: Paws::Comprehend::DetectKeyPhrases

Returns: a Paws::Comprehend::DetectKeyPhrasesResponse instance

Detects the key noun phrases found in the text.

DetectSentiment

LanguageCode => Str
Text => Str

Each argument is described in detail in: Paws::Comprehend::DetectSentiment

Returns: a Paws::Comprehend::DetectSentimentResponse instance

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

DetectSyntax

LanguageCode => Str
Text => Str

Each argument is described in detail in: Paws::Comprehend::DetectSyntax

Returns: a Paws::Comprehend::DetectSyntaxResponse instance

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

ListDocumentClassificationJobs

[Filter => Paws::Comprehend::DocumentClassificationJobFilter]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Comprehend::ListDocumentClassificationJobs

Returns: a Paws::Comprehend::ListDocumentClassificationJobsResponse instance

Gets a list of the documentation classification jobs that you have submitted.

ListDocumentClassifiers

[Filter => Paws::Comprehend::DocumentClassifierFilter]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Comprehend::ListDocumentClassifiers

Returns: a Paws::Comprehend::ListDocumentClassifiersResponse instance

Gets a list of the document classifiers that you have created.

ListDominantLanguageDetectionJobs

[Filter => Paws::Comprehend::DominantLanguageDetectionJobFilter]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Comprehend::ListDominantLanguageDetectionJobs

Returns: a Paws::Comprehend::ListDominantLanguageDetectionJobsResponse instance

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

ListEntitiesDetectionJobs

[Filter => Paws::Comprehend::EntitiesDetectionJobFilter]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Comprehend::ListEntitiesDetectionJobs

Returns: a Paws::Comprehend::ListEntitiesDetectionJobsResponse instance

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

ListEntityRecognizers

[Filter => Paws::Comprehend::EntityRecognizerFilter]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Comprehend::ListEntityRecognizers

Returns: a Paws::Comprehend::ListEntityRecognizersResponse instance

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

ListKeyPhrasesDetectionJobs

[Filter => Paws::Comprehend::KeyPhrasesDetectionJobFilter]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Comprehend::ListKeyPhrasesDetectionJobs

Returns: a Paws::Comprehend::ListKeyPhrasesDetectionJobsResponse instance

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

ListSentimentDetectionJobs

[Filter => Paws::Comprehend::SentimentDetectionJobFilter]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Comprehend::ListSentimentDetectionJobs

Returns: a Paws::Comprehend::ListSentimentDetectionJobsResponse instance

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

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::Comprehend::ListTagsForResource

Returns: a Paws::Comprehend::ListTagsForResourceResponse instance

Lists all tags associated with a given Amazon Comprehend resource.

ListTopicsDetectionJobs

[Filter => Paws::Comprehend::TopicsDetectionJobFilter]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Comprehend::ListTopicsDetectionJobs

Returns: a Paws::Comprehend::ListTopicsDetectionJobsResponse instance

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

StartDocumentClassificationJob

DataAccessRoleArn => Str
DocumentClassifierArn => Str
InputDataConfig => Paws::Comprehend::InputDataConfig
OutputDataConfig => Paws::Comprehend::OutputDataConfig
[ClientRequestToken => Str]
[JobName => Str]
[VolumeKmsKeyId => Str]
[VpcConfig => Paws::Comprehend::VpcConfig]

Each argument is described in detail in: Paws::Comprehend::StartDocumentClassificationJob

Returns: a Paws::Comprehend::StartDocumentClassificationJobResponse instance

Starts an asynchronous document classification job. Use the operation to track the progress of the job.

StartDominantLanguageDetectionJob

DataAccessRoleArn => Str
InputDataConfig => Paws::Comprehend::InputDataConfig
OutputDataConfig => Paws::Comprehend::OutputDataConfig
[ClientRequestToken => Str]
[JobName => Str]
[VolumeKmsKeyId => Str]
[VpcConfig => Paws::Comprehend::VpcConfig]

Each argument is described in detail in: Paws::Comprehend::StartDominantLanguageDetectionJob

Returns: a Paws::Comprehend::StartDominantLanguageDetectionJobResponse instance

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

StartEntitiesDetectionJob

DataAccessRoleArn => Str
InputDataConfig => Paws::Comprehend::InputDataConfig
LanguageCode => Str
OutputDataConfig => Paws::Comprehend::OutputDataConfig
[ClientRequestToken => Str]
[EntityRecognizerArn => Str]
[JobName => Str]
[VolumeKmsKeyId => Str]
[VpcConfig => Paws::Comprehend::VpcConfig]

Each argument is described in detail in: Paws::Comprehend::StartEntitiesDetectionJob

Returns: a Paws::Comprehend::StartEntitiesDetectionJobResponse instance

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

StartKeyPhrasesDetectionJob

DataAccessRoleArn => Str
InputDataConfig => Paws::Comprehend::InputDataConfig
LanguageCode => Str
OutputDataConfig => Paws::Comprehend::OutputDataConfig
[ClientRequestToken => Str]
[JobName => Str]
[VolumeKmsKeyId => Str]
[VpcConfig => Paws::Comprehend::VpcConfig]

Each argument is described in detail in: Paws::Comprehend::StartKeyPhrasesDetectionJob

Returns: a Paws::Comprehend::StartKeyPhrasesDetectionJobResponse instance

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

StartSentimentDetectionJob

DataAccessRoleArn => Str
InputDataConfig => Paws::Comprehend::InputDataConfig
LanguageCode => Str
OutputDataConfig => Paws::Comprehend::OutputDataConfig
[ClientRequestToken => Str]
[JobName => Str]
[VolumeKmsKeyId => Str]
[VpcConfig => Paws::Comprehend::VpcConfig]

Each argument is described in detail in: Paws::Comprehend::StartSentimentDetectionJob

Returns: a Paws::Comprehend::StartSentimentDetectionJobResponse instance

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

StartTopicsDetectionJob

DataAccessRoleArn => Str
InputDataConfig => Paws::Comprehend::InputDataConfig
OutputDataConfig => Paws::Comprehend::OutputDataConfig
[ClientRequestToken => Str]
[JobName => Str]
[NumberOfTopics => Int]
[VolumeKmsKeyId => Str]
[VpcConfig => Paws::Comprehend::VpcConfig]

Each argument is described in detail in: Paws::Comprehend::StartTopicsDetectionJob

Returns: a Paws::Comprehend::StartTopicsDetectionJobResponse instance

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

StopDominantLanguageDetectionJob

JobId => Str

Each argument is described in detail in: Paws::Comprehend::StopDominantLanguageDetectionJob

Returns: a Paws::Comprehend::StopDominantLanguageDetectionJobResponse instance

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.

StopEntitiesDetectionJob

JobId => Str

Each argument is described in detail in: Paws::Comprehend::StopEntitiesDetectionJob

Returns: a Paws::Comprehend::StopEntitiesDetectionJobResponse instance

Stops an entities detection job in progress.

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

JobId => Str

Each argument is described in detail in: Paws::Comprehend::StopKeyPhrasesDetectionJob

Returns: a Paws::Comprehend::StopKeyPhrasesDetectionJobResponse instance

Stops a key phrases detection job in progress.

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

JobId => Str

Each argument is described in detail in: Paws::Comprehend::StopSentimentDetectionJob

Returns: a Paws::Comprehend::StopSentimentDetectionJobResponse instance

Stops a sentiment detection job in progress.

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.

StopTrainingDocumentClassifier

DocumentClassifierArn => Str

Each argument is described in detail in: Paws::Comprehend::StopTrainingDocumentClassifier

Returns: a Paws::Comprehend::StopTrainingDocumentClassifierResponse instance

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

StopTrainingEntityRecognizer

EntityRecognizerArn => Str

Each argument is described in detail in: Paws::Comprehend::StopTrainingEntityRecognizer

Returns: a Paws::Comprehend::StopTrainingEntityRecognizerResponse instance

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

TagResource

ResourceArn => Str
Tags => ArrayRef[Paws::Comprehend::Tag]

Each argument is described in detail in: Paws::Comprehend::TagResource

Returns: a Paws::Comprehend::TagResourceResponse instance

Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Comprehend::UntagResource

Returns: a Paws::Comprehend::UntagResourceResponse instance

Removes a specific tag associated with an Amazon Comprehend resource.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results