Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.4/services/comprehend.ts?docs=full";

§Classes

Comprehend

§Interfaces

AugmentedManifestsListItem

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.

BatchDetectDominantLanguageItemResult

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

BatchDetectDominantLanguageRequest
BatchDetectDominantLanguageResponse
BatchDetectEntitiesItemResult

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

BatchDetectEntitiesRequest
BatchDetectEntitiesResponse
BatchDetectKeyPhrasesItemResult

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

BatchDetectKeyPhrasesRequest
BatchDetectKeyPhrasesResponse
BatchDetectSentimentItemResult

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

BatchDetectSentimentRequest
BatchDetectSentimentResponse
BatchDetectSyntaxItemResult

The result of calling the operation. The operation returns one object that is successfully processed by the operation.

BatchDetectSyntaxRequest
BatchDetectSyntaxResponse
BatchDetectTargetedSentimentItemResult

Analysis results for one of the documents in the batch.

BatchDetectTargetedSentimentRequest
BatchDetectTargetedSentimentResponse
BatchItemError

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.

Block

Information about each word or line of text in the input document.

BlockReference

A reference to a block.

BoundingBox

The bounding box around the detected page or around an element on a document page. The left (x-coordinate) and top (y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).

ChildBlock

Nested block contained within a block.

ClassifierEvaluationMetrics

Describes the result metrics for the test data associated with an documentation classifier.

ClassifierMetadata

Provides information about a document classifier.

ClassifyDocumentRequest
ClassifyDocumentResponse
ContainsPiiEntitiesRequest
ContainsPiiEntitiesResponse
CreateDocumentClassifierRequest
CreateDocumentClassifierResponse
CreateEndpointRequest
CreateEndpointResponse
CreateEntityRecognizerRequest
CreateEntityRecognizerResponse
DeleteDocumentClassifierRequest
DeleteEndpointRequest
DeleteEntityRecognizerRequest
DeleteResourcePolicyRequest
DescribeDocumentClassificationJobRequest
DescribeDocumentClassificationJobResponse
DescribeDocumentClassifierRequest
DescribeDocumentClassifierResponse
DescribeDominantLanguageDetectionJobRequest
DescribeDominantLanguageDetectionJobResponse
DescribeEndpointRequest
DescribeEndpointResponse
DescribeEntitiesDetectionJobRequest
DescribeEntitiesDetectionJobResponse
DescribeEntityRecognizerRequest
DescribeEntityRecognizerResponse
DescribeEventsDetectionJobRequest
DescribeEventsDetectionJobResponse
DescribeKeyPhrasesDetectionJobRequest
DescribeKeyPhrasesDetectionJobResponse
DescribePiiEntitiesDetectionJobRequest
DescribePiiEntitiesDetectionJobResponse
DescribeResourcePolicyRequest
DescribeResourcePolicyResponse
DescribeSentimentDetectionJobRequest
DescribeSentimentDetectionJobResponse
DescribeTargetedSentimentDetectionJobRequest
DescribeTargetedSentimentDetectionJobResponse
DescribeTopicsDetectionJobRequest
DescribeTopicsDetectionJobResponse
DetectDominantLanguageRequest
DetectDominantLanguageResponse
DetectEntitiesRequest
DetectEntitiesResponse
DetectKeyPhrasesRequest
DetectKeyPhrasesResponse
DetectPiiEntitiesRequest
DetectPiiEntitiesResponse
DetectSentimentRequest
DetectSentimentResponse
DetectSyntaxRequest
DetectSyntaxResponse
DetectTargetedSentimentRequest
DetectTargetedSentimentResponse
DocumentClass

Specifies the class that categorizes the document being analyzed

DocumentClassificationJobFilter

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.

DocumentClassificationJobProperties

Provides information about a document classification job.

DocumentClassifierFilter

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.

DocumentClassifierInputDataConfig

The input properties for training a document classifier.

DocumentClassifierOutputDataConfig

Provides output results configuration parameters for custom classifier jobs.

DocumentClassifierProperties

Provides information about a document classifier.

DocumentClassifierSummary

Describes information about a document classifier and its versions.

DocumentLabel

Specifies one of the label or labels that categorize the document being analyzed.

DocumentMetadata

Information about the document, discovered during text extraction.

DocumentReaderConfig

Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

DocumentTypeListItem

Document type for each page in the document.

DominantLanguage

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.

DominantLanguageDetectionJobFilter

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

DominantLanguageDetectionJobProperties

Provides information about a dominant language detection job.

EndpointFilter

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.

EndpointProperties

Specifies information about the specified endpoint. For information about endpoints, see Managing endpoints.

EntitiesDetectionJobFilter

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

EntitiesDetectionJobProperties

Provides information about an entities detection job.

Entity

Provides information about an entity.

EntityLabel

Specifies one of the label or labels that categorize the personally identifiable information (PII) entity being analyzed.

EntityRecognizerAnnotations

Describes the annotations associated with a entity recognizer.

EntityRecognizerDocuments

Describes the training documents submitted with an entity recognizer.

EntityRecognizerEntityList

Describes the entity recognizer submitted with an entity recognizer.

EntityRecognizerEvaluationMetrics

Detailed information about the accuracy of an entity recognizer.

EntityRecognizerFilter

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

EntityRecognizerInputDataConfig

Specifies the format and location of the input data.

EntityRecognizerMetadata

Detailed information about an entity recognizer.

EntityRecognizerMetadataEntityTypesListItem

Individual item from the list of entity types in the metadata of an entity recognizer.

EntityRecognizerProperties

Describes information about an entity recognizer.

EntityRecognizerSummary

Describes the information about an entity recognizer and its versions.

EntityTypesEvaluationMetrics

Detailed information about the accuracy of an entity recognizer for a specific entity type.

EntityTypesListItem

An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.

ErrorsListItem

Text extraction encountered one or more page-level errors in the input document.

EventsDetectionJobFilter

Provides information for filtering a list of event detection jobs.

EventsDetectionJobProperties

Provides information about an events detection job.

ExtractedCharactersListItem

Array of the number of characters extracted from each page.

Geometry

Information about the location of items on a document page.

ImportModelRequest
ImportModelResponse
InputDataConfig

The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.

KeyPhrase

Describes a key noun phrase.

KeyPhrasesDetectionJobFilter

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

KeyPhrasesDetectionJobProperties

Provides information about a key phrases detection job.

ListDocumentClassificationJobsRequest
ListDocumentClassificationJobsResponse
ListDocumentClassifiersRequest
ListDocumentClassifiersResponse
ListDocumentClassifierSummariesRequest
ListDocumentClassifierSummariesResponse
ListDominantLanguageDetectionJobsRequest
ListDominantLanguageDetectionJobsResponse
ListEndpointsRequest
ListEndpointsResponse
ListEntitiesDetectionJobsRequest
ListEntitiesDetectionJobsResponse
ListEntityRecognizersRequest
ListEntityRecognizersResponse
ListEntityRecognizerSummariesRequest
ListEntityRecognizerSummariesResponse
ListEventsDetectionJobsRequest
ListEventsDetectionJobsResponse
ListKeyPhrasesDetectionJobsRequest
ListKeyPhrasesDetectionJobsResponse
ListPiiEntitiesDetectionJobsRequest
ListPiiEntitiesDetectionJobsResponse
ListSentimentDetectionJobsRequest
ListSentimentDetectionJobsResponse
ListTagsForResourceRequest
ListTagsForResourceResponse
ListTargetedSentimentDetectionJobsRequest
ListTargetedSentimentDetectionJobsResponse
ListTopicsDetectionJobsRequest
ListTopicsDetectionJobsResponse
MentionSentiment

Contains the sentiment and sentiment score for one mention of an entity.

OutputDataConfig

Provides configuration parameters for the output of inference jobs.

PartOfSpeechTag

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 Syntax in the Comprehend Developer Guide.

PiiEntitiesDetectionJobFilter

Provides information for filtering a list of PII entity detection jobs.

PiiEntitiesDetectionJobProperties

Provides information about a PII entities detection job.

PiiEntity

Provides information about a PII entity.

PiiOutputDataConfig

Provides configuration parameters for the output of PII entity detection jobs.

Point

The X and Y coordinates of a point on a document page.

PutResourcePolicyRequest
PutResourcePolicyResponse
RedactionConfig

Provides configuration parameters for PII entity redaction.

RelationshipsListItem

List of child blocks for the current block.

SentimentDetectionJobFilter

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

SentimentDetectionJobProperties

Provides information about a sentiment detection job.

SentimentScore

Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.

StartDocumentClassificationJobRequest
StartDocumentClassificationJobResponse
StartDominantLanguageDetectionJobRequest
StartDominantLanguageDetectionJobResponse
StartEntitiesDetectionJobRequest
StartEntitiesDetectionJobResponse
StartEventsDetectionJobRequest
StartEventsDetectionJobResponse
StartKeyPhrasesDetectionJobRequest
StartKeyPhrasesDetectionJobResponse
StartPiiEntitiesDetectionJobRequest
StartPiiEntitiesDetectionJobResponse
StartSentimentDetectionJobRequest
StartSentimentDetectionJobResponse
StartTargetedSentimentDetectionJobRequest
StartTargetedSentimentDetectionJobResponse
StartTopicsDetectionJobRequest
StartTopicsDetectionJobResponse
StopDominantLanguageDetectionJobRequest
StopDominantLanguageDetectionJobResponse
StopEntitiesDetectionJobRequest
StopEntitiesDetectionJobResponse
StopEventsDetectionJobRequest
StopEventsDetectionJobResponse
StopKeyPhrasesDetectionJobRequest
StopKeyPhrasesDetectionJobResponse
StopPiiEntitiesDetectionJobRequest
StopPiiEntitiesDetectionJobResponse
StopSentimentDetectionJobRequest
StopSentimentDetectionJobResponse
StopTargetedSentimentDetectionJobRequest
StopTargetedSentimentDetectionJobResponse
StopTrainingDocumentClassifierRequest
StopTrainingEntityRecognizerRequest
SyntaxToken

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.

TagResourceRequest
TargetedSentimentDetectionJobFilter

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

TargetedSentimentDetectionJobProperties

Provides information about a targeted sentiment detection job.

TargetedSentimentEntity

Information about one of the entities found by targeted sentiment analysis.

TargetedSentimentMention

Information about one mention of an entity. The mention information includes the location of the mention in the text and the sentiment of the mention.

TopicsDetectionJobFilter

Provides information for filtering topic detection jobs. For more information, see .

TopicsDetectionJobProperties

Provides information about a topic detection job.

UntagResourceRequest
UpdateEndpointRequest
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.

§Type Aliases

AugmentedManifestsDocumentTypeFormat
BlockType
DocumentClassifierDataFormat
DocumentClassifierMode
DocumentReadAction
DocumentReadFeatureTypes

Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT as the read action, you must specify one or both of the following values:

DocumentReadMode
DocumentType
EndpointStatus
EntityRecognizerDataFormat
EntityType
InputFormat
JobStatus
LanguageCode
ModelStatus
PageBasedErrorCode
PartOfSpeechTagType
PiiEntitiesDetectionMaskMode
PiiEntitiesDetectionMode
PiiEntityType
RelationshipType
SentimentType
Split
SyntaxLanguageCode
TargetedSentimentEntityType