Package comprehendiface provides an interface to enable mocking the Amazon Comprehend service client for testing your code.

AugmentedManifestsDocumentTypeFormat_Values returns all elements of the AugmentedManifestsDocumentTypeFormat enum.

BlockType_Values returns all elements of the BlockType enum.

DatasetDataFormat_Values returns all elements of the DatasetDataFormat enum.

DatasetStatus_Values returns all elements of the DatasetStatus enum.

DatasetType_Values returns all elements of the DatasetType enum.

DocumentClassifierDataFormat_Values returns all elements of the DocumentClassifierDataFormat enum.

DocumentClassifierDocumentTypeFormat_Values returns all elements of the DocumentClassifierDocumentTypeFormat enum.

DocumentClassifierMode_Values returns all elements of the DocumentClassifierMode enum.

DocumentReadAction_Values returns all elements of the DocumentReadAction enum.

DocumentReadFeatureTypes_Values returns all elements of the DocumentReadFeatureTypes enum.

DocumentReadMode_Values returns all elements of the DocumentReadMode enum.

DocumentType_Values returns all elements of the DocumentType enum.

EndpointStatus_Values returns all elements of the EndpointStatus enum.

EntityRecognizerDataFormat_Values returns all elements of the EntityRecognizerDataFormat enum.

EntityType_Values returns all elements of the EntityType enum.

FlywheelIterationStatus_Values returns all elements of the FlywheelIterationStatus enum.

FlywheelStatus_Values returns all elements of the FlywheelStatus enum.

InputFormat_Values returns all elements of the InputFormat enum.

InvalidRequestDetailReason_Values returns all elements of the InvalidRequestDetailReason enum.

InvalidRequestReason_Values returns all elements of the InvalidRequestReason enum.

JobStatus_Values returns all elements of the JobStatus enum.

LanguageCode_Values returns all elements of the LanguageCode enum.

ModelStatus_Values returns all elements of the ModelStatus enum.

ModelType_Values returns all elements of the ModelType enum.

New creates a new instance of the Comprehend client with a session.

PageBasedErrorCode_Values returns all elements of the PageBasedErrorCode enum.

PageBasedWarningCode_Values returns all elements of the PageBasedWarningCode enum.

PartOfSpeechTagType_Values returns all elements of the PartOfSpeechTagType enum.

PiiEntitiesDetectionMaskMode_Values returns all elements of the PiiEntitiesDetectionMaskMode enum.

PiiEntitiesDetectionMode_Values returns all elements of the PiiEntitiesDetectionMode enum.

PiiEntityType_Values returns all elements of the PiiEntityType enum.

RelationshipType_Values returns all elements of the RelationshipType enum.

SentimentType_Values returns all elements of the SentimentType enum.

Split_Values returns all elements of the Split enum.

SyntaxLanguageCode_Values returns all elements of the SyntaxLanguageCode enum.

TargetedSentimentEntityType_Values returns all elements of the TargetedSentimentEntityType enum.

ToxicContentType_Values returns all elements of the ToxicContentType enum.

AugmentedManifestsDocumentTypeFormatPlainTextDocument is a AugmentedManifestsDocumentTypeFormat enum value.

AugmentedManifestsDocumentTypeFormatSemiStructuredDocument is a AugmentedManifestsDocumentTypeFormat enum value.

BlockTypeLine is a BlockType enum value.

BlockTypeWord is a BlockType enum value.

DatasetDataFormatAugmentedManifest is a DatasetDataFormat enum value.

DatasetDataFormatComprehendCsv is a DatasetDataFormat enum value.

DatasetStatusCompleted is a DatasetStatus enum value.

DatasetStatusCreating is a DatasetStatus enum value.

DatasetStatusFailed is a DatasetStatus enum value.

DatasetTypeTest is a DatasetType enum value.

DatasetTypeTrain is a DatasetType enum value.

DocumentClassifierDataFormatAugmentedManifest is a DocumentClassifierDataFormat enum value.

DocumentClassifierDataFormatComprehendCsv is a DocumentClassifierDataFormat enum value.

DocumentClassifierDocumentTypeFormatPlainTextDocument is a DocumentClassifierDocumentTypeFormat enum value.

DocumentClassifierDocumentTypeFormatSemiStructuredDocument is a DocumentClassifierDocumentTypeFormat enum value.

DocumentClassifierModeMultiClass is a DocumentClassifierMode enum value.

DocumentClassifierModeMultiLabel is a DocumentClassifierMode enum value.

DocumentReadActionTextractAnalyzeDocument is a DocumentReadAction enum value.

DocumentReadActionTextractDetectDocumentText is a DocumentReadAction enum value.

DocumentReadFeatureTypesForms is a DocumentReadFeatureTypes enum value.

DocumentReadFeatureTypesTables is a DocumentReadFeatureTypes enum value.

DocumentReadModeForceDocumentReadAction is a DocumentReadMode enum value.

DocumentReadModeServiceDefault is a DocumentReadMode enum value.

DocumentTypeImage is a DocumentType enum value.

DocumentTypeMsWord is a DocumentType enum value.

DocumentTypeNativePdf is a DocumentType enum value.

DocumentTypePlainText is a DocumentType enum value.

DocumentTypeScannedPdf is a DocumentType enum value.

DocumentTypeTextractAnalyzeDocumentJson is a DocumentType enum value.

DocumentTypeTextractDetectDocumentTextJson is a DocumentType enum value.

ID to lookup a service endpoint with.

EndpointStatusCreating is a EndpointStatus enum value.

EndpointStatusDeleting is a EndpointStatus enum value.

EndpointStatusFailed is a EndpointStatus enum value.

EndpointStatusInService is a EndpointStatus enum value.

EndpointStatusUpdating is a EndpointStatus enum value.

EntityRecognizerDataFormatAugmentedManifest is a EntityRecognizerDataFormat enum value.

EntityRecognizerDataFormatComprehendCsv is a EntityRecognizerDataFormat enum value.

EntityTypeCommercialItem is a EntityType enum value.

EntityTypeDate is a EntityType enum value.

EntityTypeEvent is a EntityType enum value.

EntityTypeLocation is a EntityType enum value.

EntityTypeOrganization is a EntityType enum value.

EntityTypeOther is a EntityType enum value.

EntityTypePerson is a EntityType enum value.

EntityTypeQuantity is a EntityType enum value.

EntityTypeTitle is a EntityType enum value.

ErrCodeBatchSizeLimitExceededException for service response error code "BatchSizeLimitExceededException".

ErrCodeConcurrentModificationException for service response error code "ConcurrentModificationException".

ErrCodeInternalServerException for service response error code "InternalServerException".

ErrCodeInvalidFilterException for service response error code "InvalidFilterException".

ErrCodeInvalidRequestException for service response error code "InvalidRequestException".

ErrCodeJobNotFoundException for service response error code "JobNotFoundException".

ErrCodeKmsKeyValidationException for service response error code "KmsKeyValidationException".

ErrCodeResourceInUseException for service response error code "ResourceInUseException".

ErrCodeResourceLimitExceededException for service response error code "ResourceLimitExceededException".

ErrCodeResourceNotFoundException for service response error code "ResourceNotFoundException".

ErrCodeResourceUnavailableException for service response error code "ResourceUnavailableException".

ErrCodeTextSizeLimitExceededException for service response error code "TextSizeLimitExceededException".

ErrCodeTooManyRequestsException for service response error code "TooManyRequestsException".

ErrCodeTooManyTagKeysException for service response error code "TooManyTagKeysException".

ErrCodeTooManyTagsException for service response error code "TooManyTagsException".

ErrCodeUnsupportedLanguageException for service response error code "UnsupportedLanguageException".

FlywheelIterationStatusCompleted is a FlywheelIterationStatus enum value.

FlywheelIterationStatusEvaluating is a FlywheelIterationStatus enum value.

FlywheelIterationStatusFailed is a FlywheelIterationStatus enum value.

FlywheelIterationStatusStopped is a FlywheelIterationStatus enum value.

FlywheelIterationStatusStopRequested is a FlywheelIterationStatus enum value.

FlywheelIterationStatusTraining is a FlywheelIterationStatus enum value.

FlywheelStatusActive is a FlywheelStatus enum value.

FlywheelStatusCreating is a FlywheelStatus enum value.

FlywheelStatusDeleting is a FlywheelStatus enum value.

FlywheelStatusFailed is a FlywheelStatus enum value.

FlywheelStatusUpdating is a FlywheelStatus enum value.

InputFormatOneDocPerFile is a InputFormat enum value.

InputFormatOneDocPerLine is a InputFormat enum value.

InvalidRequestDetailReasonDocumentSizeExceeded is a InvalidRequestDetailReason enum value.

InvalidRequestDetailReasonPageLimitExceeded is a InvalidRequestDetailReason enum value.

InvalidRequestDetailReasonTextractAccessDenied is a InvalidRequestDetailReason enum value.

InvalidRequestDetailReasonUnsupportedDocType is a InvalidRequestDetailReason enum value.

InvalidRequestReasonInvalidDocument is a InvalidRequestReason enum value.

JobStatusCompleted is a JobStatus enum value.

JobStatusFailed is a JobStatus enum value.

JobStatusInProgress is a JobStatus enum value.

JobStatusStopped is a JobStatus enum value.

JobStatusStopRequested is a JobStatus enum value.

JobStatusSubmitted is a JobStatus enum value.

LanguageCodeAr is a LanguageCode enum value.

LanguageCodeDe is a LanguageCode enum value.

LanguageCodeEn is a LanguageCode enum value.

LanguageCodeEs is a LanguageCode enum value.

LanguageCodeFr is a LanguageCode enum value.

LanguageCodeHi is a LanguageCode enum value.

LanguageCodeIt is a LanguageCode enum value.

LanguageCodeJa is a LanguageCode enum value.

LanguageCodeKo is a LanguageCode enum value.

LanguageCodePt is a LanguageCode enum value.

LanguageCodeZh is a LanguageCode enum value.

LanguageCodeZhTw is a LanguageCode enum value.

ModelStatusDeleting is a ModelStatus enum value.

ModelStatusInError is a ModelStatus enum value.

ModelStatusStopped is a ModelStatus enum value.

ModelStatusStopRequested is a ModelStatus enum value.

ModelStatusSubmitted is a ModelStatus enum value.

ModelStatusTrained is a ModelStatus enum value.

ModelStatusTrainedWithWarning is a ModelStatus enum value.

ModelStatusTraining is a ModelStatus enum value.

ModelTypeDocumentClassifier is a ModelType enum value.

ModelTypeEntityRecognizer is a ModelType enum value.

PageBasedErrorCodeInternalServerError is a PageBasedErrorCode enum value.

PageBasedErrorCodePageCharactersExceeded is a PageBasedErrorCode enum value.

PageBasedErrorCodePageSizeExceeded is a PageBasedErrorCode enum value.

PageBasedErrorCodeTextractBadPage is a PageBasedErrorCode enum value.

PageBasedErrorCodeTextractProvisionedThroughputExceeded is a PageBasedErrorCode enum value.

PageBasedWarningCodeInferencingNativeDocumentWithPlaintextTrainedModel is a PageBasedWarningCode enum value.

PageBasedWarningCodeInferencingPlaintextWithNativeTrainedModel is a PageBasedWarningCode enum value.

PartOfSpeechTagTypeAdj is a PartOfSpeechTagType enum value.

PartOfSpeechTagTypeAdp is a PartOfSpeechTagType enum value.

PartOfSpeechTagTypeAdv is a PartOfSpeechTagType enum value.

PartOfSpeechTagTypeAux is a PartOfSpeechTagType enum value.

PartOfSpeechTagTypeCconj is a PartOfSpeechTagType enum value.

PartOfSpeechTagTypeConj is a PartOfSpeechTagType enum value.

PartOfSpeechTagTypeDet is a PartOfSpeechTagType enum value.

PartOfSpeechTagTypeIntj is a PartOfSpeechTagType enum value.

PartOfSpeechTagTypeNoun is a PartOfSpeechTagType enum value.

PartOfSpeechTagTypeNum is a PartOfSpeechTagType enum value.

PartOfSpeechTagTypeO is a PartOfSpeechTagType enum value.

PartOfSpeechTagTypePart is a PartOfSpeechTagType enum value.

PartOfSpeechTagTypePron is a PartOfSpeechTagType enum value.

PartOfSpeechTagTypePropn is a PartOfSpeechTagType enum value.

PartOfSpeechTagTypePunct is a PartOfSpeechTagType enum value.

PartOfSpeechTagTypeSconj is a PartOfSpeechTagType enum value.

PartOfSpeechTagTypeSym is a PartOfSpeechTagType enum value.

PartOfSpeechTagTypeVerb is a PartOfSpeechTagType enum value.

PiiEntitiesDetectionMaskModeMask is a PiiEntitiesDetectionMaskMode enum value.

PiiEntitiesDetectionMaskModeReplaceWithPiiEntityType is a PiiEntitiesDetectionMaskMode enum value.

PiiEntitiesDetectionModeOnlyOffsets is a PiiEntitiesDetectionMode enum value.

PiiEntitiesDetectionModeOnlyRedaction is a PiiEntitiesDetectionMode enum value.

PiiEntityTypeAddress is a PiiEntityType enum value.

PiiEntityTypeAge is a PiiEntityType enum value.

PiiEntityTypeAll is a PiiEntityType enum value.

PiiEntityTypeAwsAccessKey is a PiiEntityType enum value.

PiiEntityTypeAwsSecretKey is a PiiEntityType enum value.

PiiEntityTypeBankAccountNumber is a PiiEntityType enum value.

PiiEntityTypeBankRouting is a PiiEntityType enum value.

PiiEntityTypeCaHealthNumber is a PiiEntityType enum value.

PiiEntityTypeCaSocialInsuranceNumber is a PiiEntityType enum value.

PiiEntityTypeCreditDebitCvv is a PiiEntityType enum value.

PiiEntityTypeCreditDebitExpiry is a PiiEntityType enum value.

PiiEntityTypeCreditDebitNumber is a PiiEntityType enum value.

PiiEntityTypeDateTime is a PiiEntityType enum value.

PiiEntityTypeDriverId is a PiiEntityType enum value.

PiiEntityTypeEmail is a PiiEntityType enum value.

PiiEntityTypeInAadhaar is a PiiEntityType enum value.

PiiEntityTypeInNrega is a PiiEntityType enum value.

PiiEntityTypeInPermanentAccountNumber is a PiiEntityType enum value.

PiiEntityTypeInternationalBankAccountNumber is a PiiEntityType enum value.

PiiEntityTypeInVoterNumber is a PiiEntityType enum value.

PiiEntityTypeIpAddress is a PiiEntityType enum value.

PiiEntityTypeLicensePlate is a PiiEntityType enum value.

PiiEntityTypeMacAddress is a PiiEntityType enum value.

PiiEntityTypeName is a PiiEntityType enum value.

PiiEntityTypePassportNumber is a PiiEntityType enum value.

PiiEntityTypePassword is a PiiEntityType enum value.

PiiEntityTypePhone is a PiiEntityType enum value.

PiiEntityTypePin is a PiiEntityType enum value.

PiiEntityTypeSsn is a PiiEntityType enum value.

PiiEntityTypeSwiftCode is a PiiEntityType enum value.

PiiEntityTypeUkNationalHealthServiceNumber is a PiiEntityType enum value.

PiiEntityTypeUkNationalInsuranceNumber is a PiiEntityType enum value.

PiiEntityTypeUkUniqueTaxpayerReferenceNumber is a PiiEntityType enum value.

PiiEntityTypeUrl is a PiiEntityType enum value.

PiiEntityTypeUsername is a PiiEntityType enum value.

PiiEntityTypeUsIndividualTaxIdentificationNumber is a PiiEntityType enum value.

PiiEntityTypeVehicleIdentificationNumber is a PiiEntityType enum value.

RelationshipTypeChild is a RelationshipType enum value.

SentimentTypeMixed is a SentimentType enum value.

SentimentTypeNegative is a SentimentType enum value.

SentimentTypeNeutral is a SentimentType enum value.

SentimentTypePositive is a SentimentType enum value.

ServiceID is a unique identifier of a specific service.

Name of service.

SplitTest is a Split enum value.

SplitTrain is a Split enum value.

SyntaxLanguageCodeDe is a SyntaxLanguageCode enum value.

SyntaxLanguageCodeEn is a SyntaxLanguageCode enum value.

SyntaxLanguageCodeEs is a SyntaxLanguageCode enum value.

SyntaxLanguageCodeFr is a SyntaxLanguageCode enum value.

SyntaxLanguageCodeIt is a SyntaxLanguageCode enum value.

SyntaxLanguageCodePt is a SyntaxLanguageCode enum value.

TargetedSentimentEntityTypeAttribute is a TargetedSentimentEntityType enum value.

TargetedSentimentEntityTypeBook is a TargetedSentimentEntityType enum value.

TargetedSentimentEntityTypeBrand is a TargetedSentimentEntityType enum value.

TargetedSentimentEntityTypeCommercialItem is a TargetedSentimentEntityType enum value.

TargetedSentimentEntityTypeDate is a TargetedSentimentEntityType enum value.

TargetedSentimentEntityTypeEvent is a TargetedSentimentEntityType enum value.

TargetedSentimentEntityTypeFacility is a TargetedSentimentEntityType enum value.

TargetedSentimentEntityTypeGame is a TargetedSentimentEntityType enum value.

TargetedSentimentEntityTypeLocation is a TargetedSentimentEntityType enum value.

TargetedSentimentEntityTypeMovie is a TargetedSentimentEntityType enum value.

TargetedSentimentEntityTypeMusic is a TargetedSentimentEntityType enum value.

TargetedSentimentEntityTypeOrganization is a TargetedSentimentEntityType enum value.

TargetedSentimentEntityTypeOther is a TargetedSentimentEntityType enum value.

TargetedSentimentEntityTypePerson is a TargetedSentimentEntityType enum value.

TargetedSentimentEntityTypePersonalTitle is a TargetedSentimentEntityType enum value.

TargetedSentimentEntityTypeQuantity is a TargetedSentimentEntityType enum value.

TargetedSentimentEntityTypeSoftware is a TargetedSentimentEntityType enum value.

ToxicContentTypeGraphic is a ToxicContentType enum value.

ToxicContentTypeHarassmentOrAbuse is a ToxicContentType enum value.

ToxicContentTypeHateSpeech is a ToxicContentType enum value.

ToxicContentTypeInsult is a ToxicContentType enum value.

ToxicContentTypeProfanity is a ToxicContentType enum value.

ToxicContentTypeSexual is a ToxicContentType enum value.

ToxicContentTypeViolenceOrThreat is a ToxicContentType enum value.

An augmented manifest file that provides training data for your custom model.

The result of calling the operation.

The result of calling the operation.

The result of calling the operation.

The result of calling the operation.

The result of calling the operation.

Analysis results for one of the documents in the batch.

Describes an error that occurred while processing a document in a batch.

The number of documents in the request exceeds the limit of 25.

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

A reference to a block.

The bounding box around the detected page or around an element on a document page.

Nested block contained within a block.

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

Provides information about a document classifier.

Comprehend provides the API operation methods for making requests to Amazon Comprehend.

Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.

Data security configuration.

An augmented manifest file that provides training data for your custom model.

Describes the dataset input data configuration for a document classifier model.

Describes the annotations associated with a entity recognizer.

Describes the documents submitted with a dataset for an entity recognizer model.

Describes the dataset entity list for an entity recognizer model.

Specifies the format and location of the input data.

Filter the datasets based on creation time or dataset status.

Specifies the format and location of the input data for the dataset.

Properties associated with the dataset.

Specifies the class that categorizes the document being analyzed.

Configuration required for a document classification model.

Provides information for filtering a list of document classification jobs.

Provides information about a document classification job.

The location of the training documents.

Provides information for filtering a list of document classifiers.

The input properties for training a document classifier.

Provide the location for output data from a custom classifier job.

Provides information about a document classifier.

Describes information about a document classifier and its versions.

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

Information about the document, discovered during text extraction.

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

Document type for each page in the document.

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.

Provides information for filtering a list of dominant language detection jobs.

Provides information about a dominant language detection job.

The filter used to determine which endpoints are returned.

Specifies information about the specified endpoint.

Provides information for filtering a list of dominant language detection jobs.

Provides information about an entities detection job.

Provides information about an entity.

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

Configuration required for an entity recognition model.

Describes the annotations associated with a entity recognizer.

Describes the training documents submitted with an entity recognizer.

Describes the entity list submitted with an entity recognizer.

Detailed information about the accuracy of an entity recognizer.

Provides information for filtering a list of entity recognizers.

Specifies the format and location of the input data.

Detailed information about an entity recognizer.

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

Output data configuration.

Describes information about an entity recognizer.

Describes the information about an entity recognizer and its versions.

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

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

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

Provides information for filtering a list of event detection jobs.

Provides information about an events detection job.

Array of the number of characters extracted from each page.

Filter the flywheels based on creation time or flywheel status.

Filter the flywheel iterations based on creation time.

The configuration properties of a flywheel iteration.

The evaluation metrics associated with the evaluated model.

The flywheel properties.

Flywheel summary information.

Information about the location of items on a document page.

The input properties for an inference job.

An internal server error occurred.

The filter specified for the operation is invalid.

Provides additional detail about why the request failed.

The request is invalid.

The specified job was not found.

Describes a key noun phrase.

Provides information for filtering a list of dominant language detection jobs.

Provides information about a key phrases detection job.

The KMS customer managed key (CMK) entered cannot be validated.

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

Provides configuration parameters for the output of inference jobs.

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.

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

Provides information about a PII entities detection job.

Provides information about a PII entity.

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

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

Provides configuration parameters for PII entity redaction.

List of child blocks for the current block.

The specified resource name is already in use.

The maximum number of resources per account has been exceeded.

The specified resource ARN was not found.

The specified resource is not available.

Provides information for filtering a list of dominant language detection jobs.

Provides information about a sentiment detection job.

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

Represents a work in the input text that was recognized and assigned a part of speech.

A key-value pair that adds as a metadata to a resource used by Amazon Comprehend.

Provides information for filtering a list of dominant language detection jobs.

Provides information about a targeted sentiment detection job.

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

Information about one mention of an entity.

Configuration about the model associated with a flywheel.

One of the of text strings.

The size of the input text exceeds the limit.

The number of requests exceeds the limit.

The request contains more tag keys than can be associated with a resource (50 tag keys per resource).

The request contains more tags than can be associated with a resource (50 tags per resource).

Provides information for filtering topic detection jobs.

Provides information about a topic detection job.

Toxic content analysis result for one string.

Toxicity analysis result for one string.

Amazon Comprehend can't process the language of the input text.

Data security configuration.

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.

The system identified one of the following warnings while processing the input document: - The document to classify is plain text, but the classifier is a native document model.