/ 
Paws-0.38
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Comprehend

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 (http://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 and returns information about them. For more information about 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.

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 (http://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 entities, and returns information about them. For more information, about 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).

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.

StartTopicsDetectionJob

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

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.

PAGINATORS

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

ListAllTopicsDetectionJobs(sub { },[Filter => Paws::Comprehend::TopicsDetectionJobFilter, MaxResults => Int, NextToken => Str])

ListAllTopicsDetectionJobs([Filter => Paws::Comprehend::TopicsDetectionJobFilter, MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- TopicsDetectionJobPropertiesList, passing the object as the first parameter, and the string 'TopicsDetectionJobPropertiesList' as the second parameter

If not, it will return a a Paws::Comprehend::ListTopicsDetectionJobsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues