@datafire/amazonaws_comprehend

Client library for Amazon Comprehend

Installation and Usage

npm install --save @datafire/amazonaws_comprehend

let amazonaws_comprehend = require('@datafire/amazonaws_comprehend').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_comprehend.BatchDetectDominantLanguage({
  "TextList": []
}).then(data => {
  console.log(data);
});

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.

Actions

BatchDetectDominantLanguage

amazonaws_comprehend.BatchDetectDominantLanguage({
  "TextList": []
}, context)

Input

• input object
  • TextList required StringList

Output

• output BatchDetectDominantLanguageResponse

BatchDetectEntities

amazonaws_comprehend.BatchDetectEntities({
  "TextList": [],
  "LanguageCode": ""
}, context)

Input

• input object
  • LanguageCode required String
  • TextList required StringList

Output

• output BatchDetectEntitiesResponse

BatchDetectKeyPhrases

amazonaws_comprehend.BatchDetectKeyPhrases({
  "TextList": [],
  "LanguageCode": ""
}, context)

Input

• input object
  • LanguageCode required String
  • TextList required StringList

Output

• output BatchDetectKeyPhrasesResponse

BatchDetectSentiment

amazonaws_comprehend.BatchDetectSentiment({
  "TextList": [],
  "LanguageCode": ""
}, context)

Input

• input object
  • LanguageCode required String
  • TextList required StringList

Output

• output BatchDetectSentimentResponse

DescribeTopicsDetectionJob

amazonaws_comprehend.DescribeTopicsDetectionJob({
  "JobId": ""
}, context)

Input

• input object
  • JobId required JobId

Output

• output DescribeTopicsDetectionJobResponse

DetectDominantLanguage

amazonaws_comprehend.DetectDominantLanguage({
  "Text": ""
}, context)

Input

• input object
  • Text required String

Output

• output DetectDominantLanguageResponse

DetectEntities

amazonaws_comprehend.DetectEntities({
  "Text": "",
  "LanguageCode": ""
}, context)

Input

• input object
  • LanguageCode required LanguageCode
  • Text required String

Output

• output DetectEntitiesResponse

DetectKeyPhrases

amazonaws_comprehend.DetectKeyPhrases({
  "Text": "",
  "LanguageCode": ""
}, context)

Input

• input object
  • LanguageCode required LanguageCode
  • Text required String

Output

• output DetectKeyPhrasesResponse

DetectSentiment

amazonaws_comprehend.DetectSentiment({
  "Text": "",
  "LanguageCode": ""
}, context)

Input

• input object
  • LanguageCode required LanguageCode
  • Text required String

Output

• output DetectSentimentResponse

ListTopicsDetectionJobs

amazonaws_comprehend.ListTopicsDetectionJobs({}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • Filter TopicsDetectionJobFilter
  • MaxResults MaxResultsInteger
  • NextToken String

Output

• output ListTopicsDetectionJobsResponse

StartTopicsDetectionJob

amazonaws_comprehend.StartTopicsDetectionJob({
  "InputDataConfig": {
    "S3Uri": ""
  },
  "OutputDataConfig": {
    "S3Uri": ""
  },
  "DataAccessRoleArn": ""
}, context)

Input

• input object
  • ClientRequestToken ClientRequestTokenString
  • DataAccessRoleArn required IamRoleArn
  • InputDataConfig required InputDataConfig
  • JobName JobName
  • NumberOfTopics NumberOfTopicsInteger
  • OutputDataConfig required OutputDataConfig

Output

• output StartTopicsDetectionJobResponse

Definitions

AnyLengthString

• AnyLengthString string

BatchDetectDominantLanguageItemResult

• BatchDetectDominantLanguageItemResult object: The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
  • Index Integer
  • Languages ListOfDominantLanguages

BatchDetectDominantLanguageRequest

• BatchDetectDominantLanguageRequest object
  • TextList required StringList

BatchDetectDominantLanguageResponse

• BatchDetectDominantLanguageResponse object
  • ErrorList required BatchItemErrorList
  • ResultList required ListOfDetectDominantLanguageResult

BatchDetectEntitiesItemResult

• BatchDetectEntitiesItemResult object: The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
  • Entities ListOfEntities
  • Index Integer

BatchDetectEntitiesRequest

• BatchDetectEntitiesRequest object
  • LanguageCode required String
  • TextList required StringList

BatchDetectEntitiesResponse

• BatchDetectEntitiesResponse object
  • ErrorList required BatchItemErrorList
  • ResultList required ListOfDetectEntitiesResult

BatchDetectKeyPhrasesItemResult

• BatchDetectKeyPhrasesItemResult object: The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
  • Index Integer
  • KeyPhrases ListOfKeyPhrases

BatchDetectKeyPhrasesRequest

• BatchDetectKeyPhrasesRequest object
  • LanguageCode required String
  • TextList required StringList

BatchDetectKeyPhrasesResponse

• BatchDetectKeyPhrasesResponse object
  • ErrorList required BatchItemErrorList
  • ResultList required ListOfDetectKeyPhrasesResult

BatchDetectSentimentItemResult

• BatchDetectSentimentItemResult object: The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
  • Index Integer
  • Sentiment SentimentType
  • SentimentScore SentimentScore

BatchDetectSentimentRequest

• BatchDetectSentimentRequest object
  • LanguageCode required String
  • TextList required StringList

BatchDetectSentimentResponse

• BatchDetectSentimentResponse object
  • ErrorList required BatchItemErrorList
  • ResultList required ListOfDetectSentimentResult

BatchItemError

• BatchItemError object: Describes an error that occurred while processing a document in a batch. The operation returns on BatchItemError object for each document that contained an error.
  • ErrorCode String
  • ErrorMessage String
  • Index Integer

BatchItemErrorList

• BatchItemErrorList array
  • items BatchItemError

BatchSizeLimitExceededException

• BatchSizeLimitExceededException object: The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
  • Message String

ClientRequestTokenString

• ClientRequestTokenString string

DescribeTopicsDetectionJobRequest

• DescribeTopicsDetectionJobRequest object
  • JobId required JobId

DescribeTopicsDetectionJobResponse

• DescribeTopicsDetectionJobResponse object
  • TopicsDetectionJobProperties TopicsDetectionJobProperties

DetectDominantLanguageRequest

• DetectDominantLanguageRequest object
  • Text required String

DetectDominantLanguageResponse

• DetectDominantLanguageResponse object
  • Languages ListOfDominantLanguages

DetectEntitiesRequest

• DetectEntitiesRequest object
  • LanguageCode required LanguageCode
  • Text required String

DetectEntitiesResponse

• DetectEntitiesResponse object
  • Entities ListOfEntities

DetectKeyPhrasesRequest

• DetectKeyPhrasesRequest object
  • LanguageCode required LanguageCode
  • Text required String

DetectKeyPhrasesResponse

• DetectKeyPhrasesResponse object
  • KeyPhrases ListOfKeyPhrases

DetectSentimentRequest

• DetectSentimentRequest object
  • LanguageCode required LanguageCode
  • Text required String

DetectSentimentResponse

• DetectSentimentResponse object
  • Sentiment SentimentType
  • SentimentScore SentimentScore

DominantLanguage

• DominantLanguage object: Returns the code for the dominant language in the input text and the level of confidence that Amazon Comprehend has in the accuracy of the detection.
  • LanguageCode String
  • Score Float

Entity

• Entity object: Provides information about an entity.
  • BeginOffset Integer
  • EndOffset Integer
  • Score Float
  • Text String
  • Type EntityType

EntityType

• EntityType string (values: PERSON, LOCATION, ORGANIZATION, COMMERCIAL_ITEM, EVENT, DATE, QUANTITY, TITLE, OTHER)

Float

• Float number

IamRoleArn

• IamRoleArn string

InputDataConfig

• InputDataConfig object: The input properties for a topic detection job.
  • InputFormat InputFormat
  • S3Uri required S3Uri

InputFormat

• InputFormat string (values: ONE_DOC_PER_FILE, ONE_DOC_PER_LINE)

Integer

• Integer integer

InternalServerException

• InternalServerException object: An internal server error occurred. Retry your request.
  • Message String

InvalidFilterException

• InvalidFilterException object: The filter specified for the ListTopicDetectionJobs operation is invalid. Specify a different filter.
  • Message String

InvalidRequestException

• InvalidRequestException object: The request is invalid.
  • Message String

JobId

• JobId string

JobName

• JobName string

JobNotFoundException

• JobNotFoundException object: The specified job was not found. Check the job ID and try again.
  • Message String

JobStatus

• JobStatus string (values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED)

KeyPhrase

• KeyPhrase object: Describes a key noun phrase.
  • BeginOffset Integer
  • EndOffset Integer
  • Score Float
  • Text String

LanguageCode

• LanguageCode string (values: en, es)

ListOfDetectDominantLanguageResult

• ListOfDetectDominantLanguageResult array
  • items BatchDetectDominantLanguageItemResult

ListOfDetectEntitiesResult

• ListOfDetectEntitiesResult array
  • items BatchDetectEntitiesItemResult

ListOfDetectKeyPhrasesResult

• ListOfDetectKeyPhrasesResult array
  • items BatchDetectKeyPhrasesItemResult

ListOfDetectSentimentResult

• ListOfDetectSentimentResult array
  • items BatchDetectSentimentItemResult

ListOfDominantLanguages

• ListOfDominantLanguages array
  • items DominantLanguage

ListOfEntities

• ListOfEntities array
  • items Entity

ListOfKeyPhrases

• ListOfKeyPhrases array
  • items KeyPhrase

ListTopicsDetectionJobsRequest

• ListTopicsDetectionJobsRequest object
  • Filter TopicsDetectionJobFilter
  • MaxResults MaxResultsInteger
  • NextToken String

ListTopicsDetectionJobsResponse

• ListTopicsDetectionJobsResponse object
  • NextToken String
  • TopicsDetectionJobPropertiesList TopicsDetectionJobPropertiesList

MaxResultsInteger

• MaxResultsInteger integer

NumberOfTopicsInteger

• NumberOfTopicsInteger integer

OutputDataConfig

• OutputDataConfig object: Provides configuration parameters for the output of topic detection jobs.
  • S3Uri required S3Uri

S3Uri

• S3Uri string

SentimentScore

• SentimentScore object: Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.
  • Mixed Float
  • Negative Float
  • Neutral Float
  • Positive Float

SentimentType

• SentimentType string (values: POSITIVE, NEGATIVE, NEUTRAL, MIXED)

StartTopicsDetectionJobRequest

• StartTopicsDetectionJobRequest object
  • ClientRequestToken ClientRequestTokenString
  • DataAccessRoleArn required IamRoleArn
  • InputDataConfig required InputDataConfig
  • JobName JobName
  • NumberOfTopics NumberOfTopicsInteger
  • OutputDataConfig required OutputDataConfig

StartTopicsDetectionJobResponse

• StartTopicsDetectionJobResponse object
  • JobId JobId
  • JobStatus JobStatus

String

• String string

StringList

• StringList array
  • items String

TextSizeLimitExceededException

• TextSizeLimitExceededException object: The size of the input text exceeds the limit. Use a smaller document.
  • Message String

Timestamp

• Timestamp string

TooManyRequestsException

• TooManyRequestsException object: The number of requests exceeds the limit. Resubmit your request later.
  • Message String

TopicsDetectionJobFilter

• TopicsDetectionJobFilter object: Provides information for filtering topic detection jobs. For more information, see .
  • JobName JobName
  • JobStatus JobStatus
  • SubmitTimeAfter Timestamp
  • SubmitTimeBefore Timestamp

TopicsDetectionJobProperties

• TopicsDetectionJobProperties object: Provides information about a topic detection job.
  • EndTime Timestamp
  • InputDataConfig InputDataConfig
  • JobId JobId
  • JobName JobName
  • JobStatus JobStatus
  • Message AnyLengthString
  • NumberOfTopics Integer
  • OutputDataConfig OutputDataConfig
  • SubmitTime Timestamp

TopicsDetectionJobPropertiesList

• TopicsDetectionJobPropertiesList array
  • items TopicsDetectionJobProperties

UnsupportedLanguageException

• UnsupportedLanguageException object: 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
  • Message String