Expand 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.
If you’re using the service, you’re probably looking for ComprehendClient and Comprehend.
Structs§
- Augmented
Manifests List Item An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
- Batch
Detect Dominant Language Item Result The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
- Batch
Detect Dominant Language Request - Batch
Detect Dominant Language Response - Batch
Detect Entities Item Result The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
- Batch
Detect Entities Request - Batch
Detect Entities Response - Batch
Detect KeyPhrases Item Result The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
- Batch
Detect KeyPhrases Request - Batch
Detect KeyPhrases Response - Batch
Detect Sentiment Item Result The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
- Batch
Detect Sentiment Request - Batch
Detect Sentiment Response - Batch
Detect Syntax Item Result The result of calling the operation. The operation returns one object that is successfully processed by the operation.
- Batch
Detect Syntax Request - Batch
Detect Syntax Response - Batch
Item Error Describes an error that occurred while processing a document in a batch. The operation returns on
BatchItemErrorobject for each document that contained an error.- Classifier
Evaluation Metrics Describes the result metrics for the test data associated with an documentation classifier.
- Classifier
Metadata Provides information about a document classifier.
- Classify
Document Request - Classify
Document Response - Comprehend
Client - A client for the Amazon Comprehend API.
- Contains
PiiEntities Request - Contains
PiiEntities Response - Create
Document Classifier Request - Create
Document Classifier Response - Create
Endpoint Request - Create
Endpoint Response - Create
Entity Recognizer Request - Create
Entity Recognizer Response - Delete
Document Classifier Request - Delete
Document Classifier Response - Delete
Endpoint Request - Delete
Endpoint Response - Delete
Entity Recognizer Request - Delete
Entity Recognizer Response - Describe
Document Classification JobRequest - Describe
Document Classification JobResponse - Describe
Document Classifier Request - Describe
Document Classifier Response - Describe
Dominant Language Detection JobRequest - Describe
Dominant Language Detection JobResponse - Describe
Endpoint Request - Describe
Endpoint Response - Describe
Entities Detection JobRequest - Describe
Entities Detection JobResponse - Describe
Entity Recognizer Request - Describe
Entity Recognizer Response - Describe
Events Detection JobRequest - Describe
Events Detection JobResponse - Describe
KeyPhrases Detection JobRequest - Describe
KeyPhrases Detection JobResponse - Describe
PiiEntities Detection JobRequest - Describe
PiiEntities Detection JobResponse - Describe
Sentiment Detection JobRequest - Describe
Sentiment Detection JobResponse - Describe
Topics Detection JobRequest - Describe
Topics Detection JobResponse - Detect
Dominant Language Request - Detect
Dominant Language Response - Detect
Entities Request - Detect
Entities Response - Detect
KeyPhrases Request - Detect
KeyPhrases Response - Detect
PiiEntities Request - Detect
PiiEntities Response - Detect
Sentiment Request - Detect
Sentiment Response - Detect
Syntax Request - Detect
Syntax Response - Document
Class Specifies the class that categorizes the document being analyzed
- Document
Classification JobFilter Provides information for filtering a list of document classification jobs. For more information, see the operation. You can provide only one filter parameter in each request.
- Document
Classification JobProperties Provides information about a document classification job.
- Document
Classifier Filter Provides information for filtering a list of document classifiers. You can only specify one filtering parameter in a request. For more information, see the operation.
- Document
Classifier Input Data Config The input properties for training a document classifier.
For more information on how the input file is formatted, see how-document-classification-training-data.
- Document
Classifier Output Data Config Provides output results configuration parameters for custom classifier jobs.
- Document
Classifier Properties Provides information about a document classifier.
- Document
Label Specifies one of the label or labels that categorize the document being analyzed.
- Dominant
Language 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.
- Dominant
Language Detection JobFilter Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
- Dominant
Language Detection JobProperties Provides information about a dominant language detection job.
- Endpoint
Filter The filter used to determine which endpoints are returned. You can filter jobs on their name, model, status, or the date and time that they were created. You can only set one filter at a time.
- Endpoint
Properties Specifies information about the specified endpoint.
- Entities
Detection JobFilter Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
- Entities
Detection JobProperties Provides information about an entities detection job.
- Entity
Provides information about an entity.
- Entity
Label Specifies one of the label or labels that categorize the personally identifiable information (PII) entity being analyzed.
- Entity
Recognizer Annotations Describes the annotations associated with a entity recognizer.
- Entity
Recognizer Documents Describes the training documents submitted with an entity recognizer.
- Entity
Recognizer Entity List Describes the entity recognizer submitted with an entity recognizer.
- Entity
Recognizer Evaluation Metrics Detailed information about the accuracy of an entity recognizer.
- Entity
Recognizer Filter Provides information for filtering a list of entity recognizers. You can only specify one filtering parameter in a request. For more information, see the operation./>
- Entity
Recognizer Input Data Config Specifies the format and location of the input data.
- Entity
Recognizer Metadata Detailed information about an entity recognizer.
- Entity
Recognizer Metadata Entity Types List Item Individual item from the list of entity types in the metadata of an entity recognizer.
- Entity
Recognizer Properties Describes information about an entity recognizer.
- Entity
Types Evaluation Metrics Detailed information about the accuracy of an entity recognizer for a specific entity type.
- Entity
Types List Item An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
- Events
Detection JobFilter Provides information for filtering a list of event detection jobs.
- Events
Detection JobProperties Provides information about an events detection job.
- Input
Data Config The input properties for a topic detection job.
- KeyPhrase
Describes a key noun phrase.
- KeyPhrases
Detection JobFilter Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
- KeyPhrases
Detection JobProperties Provides information about a key phrases detection job.
- List
Document Classification Jobs Request - List
Document Classification Jobs Response - List
Document Classifiers Request - List
Document Classifiers Response - List
Dominant Language Detection Jobs Request - List
Dominant Language Detection Jobs Response - List
Endpoints Request - List
Endpoints Response - List
Entities Detection Jobs Request - List
Entities Detection Jobs Response - List
Entity Recognizers Request - List
Entity Recognizers Response - List
Events Detection Jobs Request - List
Events Detection Jobs Response - List
KeyPhrases Detection Jobs Request - List
KeyPhrases Detection Jobs Response - List
PiiEntities Detection Jobs Request - List
PiiEntities Detection Jobs Response - List
Sentiment Detection Jobs Request - List
Sentiment Detection Jobs Response - List
Tags ForResource Request - List
Tags ForResource Response - List
Topics Detection Jobs Request - List
Topics Detection Jobs Response - Output
Data Config Provides configuration parameters for the output of topic detection jobs.
- Part
OfSpeech Tag Identifies the part of speech represented by the token and gives the confidence that Amazon Comprehend has that the part of speech was correctly identified. For more information about the parts of speech that Amazon Comprehend can identify, see how-syntax.
- PiiEntities
Detection JobFilter Provides information for filtering a list of PII entity detection jobs.
- PiiEntities
Detection JobProperties Provides information about a PII entities detection job.
- PiiEntity
Provides information about a PII entity.
- PiiOutput
Data Config Provides configuration parameters for the output of PII entity detection jobs.
- Redaction
Config Provides configuration parameters for PII entity redaction.
- Sentiment
Detection JobFilter Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
- Sentiment
Detection JobProperties Provides information about a sentiment detection job.
- Sentiment
Score Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.
- Start
Document Classification JobRequest - Start
Document Classification JobResponse - Start
Dominant Language Detection JobRequest - Start
Dominant Language Detection JobResponse - Start
Entities Detection JobRequest - Start
Entities Detection JobResponse - Start
Events Detection JobRequest - Start
Events Detection JobResponse - Start
KeyPhrases Detection JobRequest - Start
KeyPhrases Detection JobResponse - Start
PiiEntities Detection JobRequest - Start
PiiEntities Detection JobResponse - Start
Sentiment Detection JobRequest - Start
Sentiment Detection JobResponse - Start
Topics Detection JobRequest - Start
Topics Detection JobResponse - Stop
Dominant Language Detection JobRequest - Stop
Dominant Language Detection JobResponse - Stop
Entities Detection JobRequest - Stop
Entities Detection JobResponse - Stop
Events Detection JobRequest - Stop
Events Detection JobResponse - Stop
KeyPhrases Detection JobRequest - Stop
KeyPhrases Detection JobResponse - Stop
PiiEntities Detection JobRequest - Stop
PiiEntities Detection JobResponse - Stop
Sentiment Detection JobRequest - Stop
Sentiment Detection JobResponse - Stop
Training Document Classifier Request - Stop
Training Document Classifier Response - Stop
Training Entity Recognizer Request - Stop
Training Entity Recognizer Response - Syntax
Token Represents a work in the input text that was recognized and assigned a part of speech. There is one syntax token record for each word in the source text.
- Tag
A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.
- TagResource
Request - TagResource
Response - Topics
Detection JobFilter Provides information for filtering topic detection jobs. For more information, see .
- Topics
Detection JobProperties Provides information about a topic detection job.
- Untag
Resource Request - Untag
Resource Response - Update
Endpoint Request - Update
Endpoint Response - VpcConfig
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC.
Enums§
- Batch
Detect Dominant Language Error - Errors returned by BatchDetectDominantLanguage
- Batch
Detect Entities Error - Errors returned by BatchDetectEntities
- Batch
Detect KeyPhrases Error - Errors returned by BatchDetectKeyPhrases
- Batch
Detect Sentiment Error - Errors returned by BatchDetectSentiment
- Batch
Detect Syntax Error - Errors returned by BatchDetectSyntax
- Classify
Document Error - Errors returned by ClassifyDocument
- Contains
PiiEntities Error - Errors returned by ContainsPiiEntities
- Create
Document Classifier Error - Errors returned by CreateDocumentClassifier
- Create
Endpoint Error - Errors returned by CreateEndpoint
- Create
Entity Recognizer Error - Errors returned by CreateEntityRecognizer
- Delete
Document Classifier Error - Errors returned by DeleteDocumentClassifier
- Delete
Endpoint Error - Errors returned by DeleteEndpoint
- Delete
Entity Recognizer Error - Errors returned by DeleteEntityRecognizer
- Describe
Document Classification JobError - Errors returned by DescribeDocumentClassificationJob
- Describe
Document Classifier Error - Errors returned by DescribeDocumentClassifier
- Describe
Dominant Language Detection JobError - Errors returned by DescribeDominantLanguageDetectionJob
- Describe
Endpoint Error - Errors returned by DescribeEndpoint
- Describe
Entities Detection JobError - Errors returned by DescribeEntitiesDetectionJob
- Describe
Entity Recognizer Error - Errors returned by DescribeEntityRecognizer
- Describe
Events Detection JobError - Errors returned by DescribeEventsDetectionJob
- Describe
KeyPhrases Detection JobError - Errors returned by DescribeKeyPhrasesDetectionJob
- Describe
PiiEntities Detection JobError - Errors returned by DescribePiiEntitiesDetectionJob
- Describe
Sentiment Detection JobError - Errors returned by DescribeSentimentDetectionJob
- Describe
Topics Detection JobError - Errors returned by DescribeTopicsDetectionJob
- Detect
Dominant Language Error - Errors returned by DetectDominantLanguage
- Detect
Entities Error - Errors returned by DetectEntities
- Detect
KeyPhrases Error - Errors returned by DetectKeyPhrases
- Detect
PiiEntities Error - Errors returned by DetectPiiEntities
- Detect
Sentiment Error - Errors returned by DetectSentiment
- Detect
Syntax Error - Errors returned by DetectSyntax
- List
Document Classification Jobs Error - Errors returned by ListDocumentClassificationJobs
- List
Document Classifiers Error - Errors returned by ListDocumentClassifiers
- List
Dominant Language Detection Jobs Error - Errors returned by ListDominantLanguageDetectionJobs
- List
Endpoints Error - Errors returned by ListEndpoints
- List
Entities Detection Jobs Error - Errors returned by ListEntitiesDetectionJobs
- List
Entity Recognizers Error - Errors returned by ListEntityRecognizers
- List
Events Detection Jobs Error - Errors returned by ListEventsDetectionJobs
- List
KeyPhrases Detection Jobs Error - Errors returned by ListKeyPhrasesDetectionJobs
- List
PiiEntities Detection Jobs Error - Errors returned by ListPiiEntitiesDetectionJobs
- List
Sentiment Detection Jobs Error - Errors returned by ListSentimentDetectionJobs
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- List
Topics Detection Jobs Error - Errors returned by ListTopicsDetectionJobs
- Start
Document Classification JobError - Errors returned by StartDocumentClassificationJob
- Start
Dominant Language Detection JobError - Errors returned by StartDominantLanguageDetectionJob
- Start
Entities Detection JobError - Errors returned by StartEntitiesDetectionJob
- Start
Events Detection JobError - Errors returned by StartEventsDetectionJob
- Start
KeyPhrases Detection JobError - Errors returned by StartKeyPhrasesDetectionJob
- Start
PiiEntities Detection JobError - Errors returned by StartPiiEntitiesDetectionJob
- Start
Sentiment Detection JobError - Errors returned by StartSentimentDetectionJob
- Start
Topics Detection JobError - Errors returned by StartTopicsDetectionJob
- Stop
Dominant Language Detection JobError - Errors returned by StopDominantLanguageDetectionJob
- Stop
Entities Detection JobError - Errors returned by StopEntitiesDetectionJob
- Stop
Events Detection JobError - Errors returned by StopEventsDetectionJob
- Stop
KeyPhrases Detection JobError - Errors returned by StopKeyPhrasesDetectionJob
- Stop
PiiEntities Detection JobError - Errors returned by StopPiiEntitiesDetectionJob
- Stop
Sentiment Detection JobError - Errors returned by StopSentimentDetectionJob
- Stop
Training Document Classifier Error - Errors returned by StopTrainingDocumentClassifier
- Stop
Training Entity Recognizer Error - Errors returned by StopTrainingEntityRecognizer
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Endpoint Error - Errors returned by UpdateEndpoint
Traits§
- Comprehend
- Trait representing the capabilities of the Amazon Comprehend API. Amazon Comprehend clients implement this trait.