Comprehend class

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.

Constructors

Comprehend({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

batchDetectDominantLanguage({required List<String> textList}) → Future<BatchDetectDominantLanguageResponse>
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.
batchDetectEntities({required LanguageCode languageCode, required List<String> textList}) → Future<BatchDetectEntitiesResponse>
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({required LanguageCode languageCode, required List<String> textList}) → Future<BatchDetectKeyPhrasesResponse>
Detects the key noun phrases found in a batch of documents.
batchDetectSentiment({required LanguageCode languageCode, required List<String> textList}) → Future<BatchDetectSentimentResponse>
Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.
batchDetectSyntax({required SyntaxLanguageCode languageCode, required List<String> textList}) → Future<BatchDetectSyntaxResponse>
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.
classifyDocument({required String endpointArn, required String text}) → Future<ClassifyDocumentResponse>
Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createDocumentClassifier({required String dataAccessRoleArn, required String documentClassifierName, required DocumentClassifierInputDataConfig inputDataConfig, required LanguageCode languageCode, String? clientRequestToken, DocumentClassifierMode? mode, DocumentClassifierOutputDataConfig? outputDataConfig, List<Tag>? tags, String? volumeKmsKeyId, VpcConfig? vpcConfig}) → Future<CreateDocumentClassifierResponse>
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.
createEndpoint({required int desiredInferenceUnits, required String endpointName, required String modelArn, String? clientRequestToken, List<Tag>? tags}) → Future<CreateEndpointResponse>
Creates a model-specific endpoint for synchronous inference for a previously trained custom model
createEntityRecognizer({required String dataAccessRoleArn, required EntityRecognizerInputDataConfig inputDataConfig, required LanguageCode languageCode, required String recognizerName, String? clientRequestToken, List<Tag>? tags, String? volumeKmsKeyId, VpcConfig? vpcConfig}) → Future<CreateEntityRecognizerResponse>
Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API.
deleteDocumentClassifier({required String documentClassifierArn}) → Future<void>
Deletes a previously created document classifier
deleteEndpoint({required String endpointArn}) → Future<void>
Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted.
deleteEntityRecognizer({required String entityRecognizerArn}) → Future<void>
Deletes an entity recognizer.
describeDocumentClassificationJob({required String jobId}) → Future<DescribeDocumentClassificationJobResponse>
Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
describeDocumentClassifier({required String documentClassifierArn}) → Future<DescribeDocumentClassifierResponse>
Gets the properties associated with a document classifier.
describeDominantLanguageDetectionJob({required String jobId}) → Future<DescribeDominantLanguageDetectionJobResponse>
Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
describeEndpoint({required String endpointArn}) → Future<DescribeEndpointResponse>
Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint.
describeEntitiesDetectionJob({required String jobId}) → Future<DescribeEntitiesDetectionJobResponse>
Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
describeEntityRecognizer({required String entityRecognizerArn}) → Future<DescribeEntityRecognizerResponse>
Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
describeEventsDetectionJob({required String jobId}) → Future<DescribeEventsDetectionJobResponse>
Gets the status and details of an events detection job.
describeKeyPhrasesDetectionJob({required String jobId}) → Future<DescribeKeyPhrasesDetectionJobResponse>
Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
describePiiEntitiesDetectionJob({required String jobId}) → Future<DescribePiiEntitiesDetectionJobResponse>
Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.
describeSentimentDetectionJob({required String jobId}) → Future<DescribeSentimentDetectionJobResponse>
Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
describeTopicsDetectionJob({required String jobId}) → Future<DescribeTopicsDetectionJobResponse>
Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
detectDominantLanguage({required String text}) → Future<DetectDominantLanguageResponse>
Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
detectEntities({required String text, String? endpointArn, LanguageCode? languageCode}) → Future<DetectEntitiesResponse>
Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.
detectKeyPhrases({required LanguageCode languageCode, required String text}) → Future<DetectKeyPhrasesResponse>
Detects the key noun phrases found in the text.
detectPiiEntities({required LanguageCode languageCode, required String text}) → Future<DetectPiiEntitiesResponse>
Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.
detectSentiment({required LanguageCode languageCode, required String text}) → Future<DetectSentimentResponse>
Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).
detectSyntax({required SyntaxLanguageCode languageCode, required String text}) → Future<DetectSyntaxResponse>
Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax.
listDocumentClassificationJobs({DocumentClassificationJobFilter? filter, int? maxResults, String? nextToken}) → Future<ListDocumentClassificationJobsResponse>
Gets a list of the documentation classification jobs that you have submitted.
listDocumentClassifiers({DocumentClassifierFilter? filter, int? maxResults, String? nextToken}) → Future<ListDocumentClassifiersResponse>
Gets a list of the document classifiers that you have created.
listDominantLanguageDetectionJobs({DominantLanguageDetectionJobFilter? filter, int? maxResults, String? nextToken}) → Future<ListDominantLanguageDetectionJobsResponse>
Gets a list of the dominant language detection jobs that you have submitted.
listEndpoints({EndpointFilter? filter, int? maxResults, String? nextToken}) → Future<ListEndpointsResponse>
Gets a list of all existing endpoints that you've created.
listEntitiesDetectionJobs({EntitiesDetectionJobFilter? filter, int? maxResults, String? nextToken}) → Future<ListEntitiesDetectionJobsResponse>
Gets a list of the entity detection jobs that you have submitted.
listEntityRecognizers({EntityRecognizerFilter? filter, int? maxResults, String? nextToken}) → Future<ListEntityRecognizersResponse>
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.
listEventsDetectionJobs({EventsDetectionJobFilter? filter, int? maxResults, String? nextToken}) → Future<ListEventsDetectionJobsResponse>
Gets a list of the events detection jobs that you have submitted.
listKeyPhrasesDetectionJobs({KeyPhrasesDetectionJobFilter? filter, int? maxResults, String? nextToken}) → Future<ListKeyPhrasesDetectionJobsResponse>
Get a list of key phrase detection jobs that you have submitted.
listPiiEntitiesDetectionJobs({PiiEntitiesDetectionJobFilter? filter, int? maxResults, String? nextToken}) → Future<ListPiiEntitiesDetectionJobsResponse>
Gets a list of the PII entity detection jobs that you have submitted.
listSentimentDetectionJobs({SentimentDetectionJobFilter? filter, int? maxResults, String? nextToken}) → Future<ListSentimentDetectionJobsResponse>
Gets a list of sentiment detection jobs that you have submitted.
listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>
Lists all tags associated with a given Amazon Comprehend resource.
listTopicsDetectionJobs({TopicsDetectionJobFilter? filter, int? maxResults, String? nextToken}) → Future<ListTopicsDetectionJobsResponse>
Gets a list of the topic detection jobs that you have submitted.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
startDocumentClassificationJob({required String dataAccessRoleArn, required String documentClassifierArn, required InputDataConfig inputDataConfig, required OutputDataConfig outputDataConfig, String? clientRequestToken, String? jobName, String? volumeKmsKeyId, VpcConfig? vpcConfig}) → Future<StartDocumentClassificationJobResponse>
Starts an asynchronous document classification job. Use the operation to track the progress of the job.
startDominantLanguageDetectionJob({required String dataAccessRoleArn, required InputDataConfig inputDataConfig, required OutputDataConfig outputDataConfig, String? clientRequestToken, String? jobName, String? volumeKmsKeyId, VpcConfig? vpcConfig}) → Future<StartDominantLanguageDetectionJobResponse>
Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.
startEntitiesDetectionJob({required String dataAccessRoleArn, required InputDataConfig inputDataConfig, required LanguageCode languageCode, required OutputDataConfig outputDataConfig, String? clientRequestToken, String? entityRecognizerArn, String? jobName, String? volumeKmsKeyId, VpcConfig? vpcConfig}) → Future<StartEntitiesDetectionJobResponse>
Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.
startEventsDetectionJob({required String dataAccessRoleArn, required InputDataConfig inputDataConfig, required LanguageCode languageCode, required OutputDataConfig outputDataConfig, required List<String> targetEventTypes, String? clientRequestToken, String? jobName}) → Future<StartEventsDetectionJobResponse>
Starts an asynchronous event detection job for a collection of documents.
startKeyPhrasesDetectionJob({required String dataAccessRoleArn, required InputDataConfig inputDataConfig, required LanguageCode languageCode, required OutputDataConfig outputDataConfig, String? clientRequestToken, String? jobName, String? volumeKmsKeyId, VpcConfig? vpcConfig}) → Future<StartKeyPhrasesDetectionJobResponse>
Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
startPiiEntitiesDetectionJob({required String dataAccessRoleArn, required InputDataConfig inputDataConfig, required LanguageCode languageCode, required PiiEntitiesDetectionMode mode, required OutputDataConfig outputDataConfig, String? clientRequestToken, String? jobName, RedactionConfig? redactionConfig}) → Future<StartPiiEntitiesDetectionJobResponse>
Starts an asynchronous PII entity detection job for a collection of documents.
startSentimentDetectionJob({required String dataAccessRoleArn, required InputDataConfig inputDataConfig, required LanguageCode languageCode, required OutputDataConfig outputDataConfig, String? clientRequestToken, String? jobName, String? volumeKmsKeyId, VpcConfig? vpcConfig}) → Future<StartSentimentDetectionJobResponse>
Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job.
startTopicsDetectionJob({required String dataAccessRoleArn, required InputDataConfig inputDataConfig, required OutputDataConfig outputDataConfig, String? clientRequestToken, String? jobName, int? numberOfTopics, String? volumeKmsKeyId, VpcConfig? vpcConfig}) → Future<StartTopicsDetectionJobResponse>
Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.
stopDominantLanguageDetectionJob({required String jobId}) → Future<StopDominantLanguageDetectionJobResponse>
Stops a dominant language detection job in progress.
stopEntitiesDetectionJob({required String jobId}) → Future<StopEntitiesDetectionJobResponse>
Stops an entities detection job in progress.
stopEventsDetectionJob({required String jobId}) → Future<StopEventsDetectionJobResponse>
Stops an events detection job in progress.
stopKeyPhrasesDetectionJob({required String jobId}) → Future<StopKeyPhrasesDetectionJobResponse>
Stops a key phrases detection job in progress.
stopPiiEntitiesDetectionJob({required String jobId}) → Future<StopPiiEntitiesDetectionJobResponse>
Stops a PII entities detection job in progress.
stopSentimentDetectionJob({required String jobId}) → Future<StopSentimentDetectionJobResponse>
Stops a sentiment detection job in progress.
stopTrainingDocumentClassifier({required String documentClassifierArn}) → Future<void>
Stops a document classifier training job while in progress.
stopTrainingEntityRecognizer({required String entityRecognizerArn}) → Future<void>
Stops an entity recognizer training job while in progress.
tagResource({required String resourceArn, required List<Tag> tags}) → Future<void>
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.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>
Removes a specific tag associated with an Amazon Comprehend resource.
updateEndpoint({required int desiredInferenceUnits, required String endpointArn}) → Future<void>
Updates information about the specified endpoint.

Operators

operator ==(Object other) → bool
The equality operator.
inherited