Comprehend module
Index > Comprehend
Auto-generated documentation for Comprehend type annotations stubs module mypy-boto3-comprehend.
How to install
VSCode extension
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and Comprehend
.
From PyPI with pip
Install boto3-stubs
for Comprehend
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[comprehend]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[comprehend]'
# standalone installation
python -m pip install mypy-boto3-comprehend
How to uninstall
Usage
Code samples can be found in Examples.
ComprehendClient
Type annotations and code completion for boto3.client("comprehend")
as ComprehendClient
boto3 documentation
Usage example
from boto3.session import Session
from mypy_boto3_comprehend.client import ComprehendClient
def get_client() -> ComprehendClient:
return Session().client("comprehend")
Paginators
Type annotations and code completion for paginators
from boto3.client("comprehend").get_paginator("...")
.
Usage example
from boto3.session import Session
from mypy_boto3_comprehend.paginator import ListDocumentClassificationJobsPaginator
def get_list_document_classification_jobs_paginator() -> ListDocumentClassificationJobsPaginator:
return Session().client("comprehend").get_paginator("list_document_classification_jobs"))
- ListDocumentClassificationJobsPaginator
- ListDocumentClassifiersPaginator
- ListDominantLanguageDetectionJobsPaginator
- ListEndpointsPaginator
- ListEntitiesDetectionJobsPaginator
- ListEntityRecognizersPaginator
- ListKeyPhrasesDetectionJobsPaginator
- ListPiiEntitiesDetectionJobsPaginator
- ListSentimentDetectionJobsPaginator
- ListTopicsDetectionJobsPaginator
Literals
Type annotations for literals used in methods and schemas.
Usage example
from mypy_boto3_comprehend.literals import AugmentedManifestsDocumentTypeFormatType
def get_value() -> AugmentedManifestsDocumentTypeFormatType:
return "PLAIN_TEXT_DOCUMENT"
- AugmentedManifestsDocumentTypeFormatType
- BlockTypeType
- DatasetDataFormatType
- DatasetStatusType
- DatasetTypeType
- DocumentClassifierDataFormatType
- DocumentClassifierModeType
- DocumentReadActionType
- DocumentReadFeatureTypesType
- DocumentReadModeType
- DocumentTypeType
- EndpointStatusType
- EntityRecognizerDataFormatType
- EntityTypeType
- FlywheelIterationStatusType
- FlywheelStatusType
- InputFormatType
- JobStatusType
- LanguageCodeType
- ListDocumentClassificationJobsPaginatorName
- ListDocumentClassifiersPaginatorName
- ListDominantLanguageDetectionJobsPaginatorName
- ListEndpointsPaginatorName
- ListEntitiesDetectionJobsPaginatorName
- ListEntityRecognizersPaginatorName
- ListKeyPhrasesDetectionJobsPaginatorName
- ListPiiEntitiesDetectionJobsPaginatorName
- ListSentimentDetectionJobsPaginatorName
- ListTopicsDetectionJobsPaginatorName
- ModelStatusType
- ModelTypeType
- PageBasedErrorCodeType
- PartOfSpeechTagTypeType
- PiiEntitiesDetectionMaskModeType
- PiiEntitiesDetectionModeType
- PiiEntityTypeType
- RelationshipTypeType
- SentimentTypeType
- SplitType
- SyntaxLanguageCodeType
- TargetedSentimentEntityTypeType
- ComprehendServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from mypy_boto3_comprehend.type_defs import AugmentedManifestsListItemTypeDef
def get_value() -> AugmentedManifestsListItemTypeDef:
return {
"S3Uri": ...,
"AttributeNames": ...,
}
- AugmentedManifestsListItemTypeDef
- DominantLanguageTypeDef
- BatchDetectDominantLanguageRequestRequestTypeDef
- BatchItemErrorTypeDef
- ResponseMetadataTypeDef
- BatchDetectEntitiesRequestRequestTypeDef
- KeyPhraseTypeDef
- BatchDetectKeyPhrasesRequestRequestTypeDef
- SentimentScoreTypeDef
- BatchDetectSentimentRequestRequestTypeDef
- BatchDetectSyntaxRequestRequestTypeDef
- BatchDetectTargetedSentimentRequestRequestTypeDef
- ChildBlockTypeDef
- RelationshipsListItemTypeDef
- BoundingBoxTypeDef
- ClassifierEvaluationMetricsTypeDef
- DocumentReaderConfigTypeDef
- DocumentClassTypeDef
- DocumentLabelTypeDef
- DocumentTypeListItemTypeDef
- ErrorsListItemTypeDef
- ContainsPiiEntitiesRequestRequestTypeDef
- EntityLabelTypeDef
- TagTypeDef
- DocumentClassifierOutputDataConfigTypeDef
- VpcConfigTypeDef
- DatasetAugmentedManifestsListItemTypeDef
- DatasetDocumentClassifierInputDataConfigTypeDef
- DatasetEntityRecognizerAnnotationsTypeDef
- DatasetEntityRecognizerDocumentsTypeDef
- DatasetEntityRecognizerEntityListTypeDef
- DatasetFilterTypeDef
- DatasetPropertiesTypeDef
- DeleteDocumentClassifierRequestRequestTypeDef
- DeleteEndpointRequestRequestTypeDef
- DeleteEntityRecognizerRequestRequestTypeDef
- DeleteFlywheelRequestRequestTypeDef
- DeleteResourcePolicyRequestRequestTypeDef
- DescribeDatasetRequestRequestTypeDef
- DescribeDocumentClassificationJobRequestRequestTypeDef
- DescribeDocumentClassifierRequestRequestTypeDef
- DescribeDominantLanguageDetectionJobRequestRequestTypeDef
- DescribeEndpointRequestRequestTypeDef
- EndpointPropertiesTypeDef
- DescribeEntitiesDetectionJobRequestRequestTypeDef
- DescribeEntityRecognizerRequestRequestTypeDef
- DescribeEventsDetectionJobRequestRequestTypeDef
- DescribeFlywheelIterationRequestRequestTypeDef
- DescribeFlywheelRequestRequestTypeDef
- DescribeKeyPhrasesDetectionJobRequestRequestTypeDef
- DescribePiiEntitiesDetectionJobRequestRequestTypeDef
- DescribeResourcePolicyRequestRequestTypeDef
- DescribeSentimentDetectionJobRequestRequestTypeDef
- DescribeTargetedSentimentDetectionJobRequestRequestTypeDef
- DescribeTopicsDetectionJobRequestRequestTypeDef
- DetectDominantLanguageRequestRequestTypeDef
- DetectKeyPhrasesRequestRequestTypeDef
- DetectPiiEntitiesRequestRequestTypeDef
- PiiEntityTypeDef
- DetectSentimentRequestRequestTypeDef
- DetectSyntaxRequestRequestTypeDef
- DetectTargetedSentimentRequestRequestTypeDef
- DocumentClassificationConfigTypeDef
- DocumentClassificationJobFilterTypeDef
- OutputDataConfigTypeDef
- DocumentClassifierFilterTypeDef
- DocumentClassifierSummaryTypeDef
- ExtractedCharactersListItemTypeDef
- DominantLanguageDetectionJobFilterTypeDef
- EndpointFilterTypeDef
- EntitiesDetectionJobFilterTypeDef
- EntityTypesListItemTypeDef
- EntityRecognizerAnnotationsTypeDef
- EntityRecognizerDocumentsTypeDef
- EntityRecognizerEntityListTypeDef
- EntityRecognizerEvaluationMetricsTypeDef
- EntityRecognizerFilterTypeDef
- EntityTypesEvaluationMetricsTypeDef
- EntityRecognizerOutputDataConfigTypeDef
- EntityRecognizerSummaryTypeDef
- EventsDetectionJobFilterTypeDef
- FlywheelFilterTypeDef
- FlywheelIterationFilterTypeDef
- FlywheelModelEvaluationMetricsTypeDef
- FlywheelSummaryTypeDef
- PointTypeDef
- KeyPhrasesDetectionJobFilterTypeDef
- PaginatorConfigTypeDef
- ListDocumentClassifierSummariesRequestRequestTypeDef
- ListEntityRecognizerSummariesRequestRequestTypeDef
- PiiEntitiesDetectionJobFilterTypeDef
- SentimentDetectionJobFilterTypeDef
- ListTagsForResourceRequestRequestTypeDef
- TargetedSentimentDetectionJobFilterTypeDef
- TopicsDetectionJobFilterTypeDef
- PartOfSpeechTagTypeDef
- PiiOutputDataConfigTypeDef
- RedactionConfigTypeDef
- PutResourcePolicyRequestRequestTypeDef
- StartFlywheelIterationRequestRequestTypeDef
- StopDominantLanguageDetectionJobRequestRequestTypeDef
- StopEntitiesDetectionJobRequestRequestTypeDef
- StopEventsDetectionJobRequestRequestTypeDef
- StopKeyPhrasesDetectionJobRequestRequestTypeDef
- StopPiiEntitiesDetectionJobRequestRequestTypeDef
- StopSentimentDetectionJobRequestRequestTypeDef
- StopTargetedSentimentDetectionJobRequestRequestTypeDef
- StopTrainingDocumentClassifierRequestRequestTypeDef
- StopTrainingEntityRecognizerRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateEndpointRequestRequestTypeDef
- DocumentClassifierInputDataConfigTypeDef
- BatchDetectDominantLanguageItemResultTypeDef
- CreateDatasetResponseTypeDef
- CreateDocumentClassifierResponseTypeDef
- CreateEndpointResponseTypeDef
- CreateEntityRecognizerResponseTypeDef
- CreateFlywheelResponseTypeDef
- DescribeResourcePolicyResponseTypeDef
- DetectDominantLanguageResponseTypeDef
- ImportModelResponseTypeDef
- PutResourcePolicyResponseTypeDef
- StartDocumentClassificationJobResponseTypeDef
- StartDominantLanguageDetectionJobResponseTypeDef
- StartEntitiesDetectionJobResponseTypeDef
- StartEventsDetectionJobResponseTypeDef
- StartFlywheelIterationResponseTypeDef
- StartKeyPhrasesDetectionJobResponseTypeDef
- StartPiiEntitiesDetectionJobResponseTypeDef
- StartSentimentDetectionJobResponseTypeDef
- StartTargetedSentimentDetectionJobResponseTypeDef
- StartTopicsDetectionJobResponseTypeDef
- StopDominantLanguageDetectionJobResponseTypeDef
- StopEntitiesDetectionJobResponseTypeDef
- StopEventsDetectionJobResponseTypeDef
- StopKeyPhrasesDetectionJobResponseTypeDef
- StopPiiEntitiesDetectionJobResponseTypeDef
- StopSentimentDetectionJobResponseTypeDef
- StopTargetedSentimentDetectionJobResponseTypeDef
- UpdateEndpointResponseTypeDef
- BatchDetectKeyPhrasesItemResultTypeDef
- DetectKeyPhrasesResponseTypeDef
- BatchDetectSentimentItemResultTypeDef
- DetectSentimentResponseTypeDef
- MentionSentimentTypeDef
- BlockReferenceTypeDef
- ClassifierMetadataTypeDef
- ClassifyDocumentRequestRequestTypeDef
- DetectEntitiesRequestRequestTypeDef
- InputDataConfigTypeDef
- ContainsPiiEntitiesResponseTypeDef
- CreateEndpointRequestRequestTypeDef
- ImportModelRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestRequestTypeDef
- DataSecurityConfigTypeDef
- UpdateDataSecurityConfigTypeDef
- DatasetEntityRecognizerInputDataConfigTypeDef
- ListDatasetsRequestRequestTypeDef
- DescribeDatasetResponseTypeDef
- ListDatasetsResponseTypeDef
- DescribeEndpointResponseTypeDef
- ListEndpointsResponseTypeDef
- DetectPiiEntitiesResponseTypeDef
- ListDocumentClassificationJobsRequestRequestTypeDef
- ListDocumentClassifiersRequestRequestTypeDef
- ListDocumentClassifierSummariesResponseTypeDef
- DocumentMetadataTypeDef
- ListDominantLanguageDetectionJobsRequestRequestTypeDef
- ListEndpointsRequestRequestTypeDef
- ListEntitiesDetectionJobsRequestRequestTypeDef
- EntityRecognitionConfigTypeDef
- EntityRecognizerInputDataConfigTypeDef
- ListEntityRecognizersRequestRequestTypeDef
- EntityRecognizerMetadataEntityTypesListItemTypeDef
- ListEntityRecognizerSummariesResponseTypeDef
- ListEventsDetectionJobsRequestRequestTypeDef
- ListFlywheelsRequestRequestTypeDef
- ListFlywheelIterationHistoryRequestRequestTypeDef
- FlywheelIterationPropertiesTypeDef
- ListFlywheelsResponseTypeDef
- GeometryTypeDef
- ListKeyPhrasesDetectionJobsRequestRequestTypeDef
- ListDocumentClassificationJobsRequestListDocumentClassificationJobsPaginateTypeDef
- ListDocumentClassifiersRequestListDocumentClassifiersPaginateTypeDef
- ListDominantLanguageDetectionJobsRequestListDominantLanguageDetectionJobsPaginateTypeDef
- ListEndpointsRequestListEndpointsPaginateTypeDef
- ListEntitiesDetectionJobsRequestListEntitiesDetectionJobsPaginateTypeDef
- ListEntityRecognizersRequestListEntityRecognizersPaginateTypeDef
- ListKeyPhrasesDetectionJobsRequestListKeyPhrasesDetectionJobsPaginateTypeDef
- ListPiiEntitiesDetectionJobsRequestListPiiEntitiesDetectionJobsPaginateTypeDef
- ListPiiEntitiesDetectionJobsRequestRequestTypeDef
- ListSentimentDetectionJobsRequestListSentimentDetectionJobsPaginateTypeDef
- ListSentimentDetectionJobsRequestRequestTypeDef
- ListTargetedSentimentDetectionJobsRequestRequestTypeDef
- ListTopicsDetectionJobsRequestListTopicsDetectionJobsPaginateTypeDef
- ListTopicsDetectionJobsRequestRequestTypeDef
- SyntaxTokenTypeDef
- CreateDocumentClassifierRequestRequestTypeDef
- BatchDetectDominantLanguageResponseTypeDef
- BatchDetectKeyPhrasesResponseTypeDef
- BatchDetectSentimentResponseTypeDef
- TargetedSentimentMentionTypeDef
- EntityTypeDef
- DocumentClassifierPropertiesTypeDef
- DocumentClassificationJobPropertiesTypeDef
- DominantLanguageDetectionJobPropertiesTypeDef
- EntitiesDetectionJobPropertiesTypeDef
- EventsDetectionJobPropertiesTypeDef
- KeyPhrasesDetectionJobPropertiesTypeDef
- PiiEntitiesDetectionJobPropertiesTypeDef
- SentimentDetectionJobPropertiesTypeDef
- StartDocumentClassificationJobRequestRequestTypeDef
- StartDominantLanguageDetectionJobRequestRequestTypeDef
- StartEntitiesDetectionJobRequestRequestTypeDef
- StartEventsDetectionJobRequestRequestTypeDef
- StartKeyPhrasesDetectionJobRequestRequestTypeDef
- StartPiiEntitiesDetectionJobRequestRequestTypeDef
- StartSentimentDetectionJobRequestRequestTypeDef
- StartTargetedSentimentDetectionJobRequestRequestTypeDef
- StartTopicsDetectionJobRequestRequestTypeDef
- TargetedSentimentDetectionJobPropertiesTypeDef
- TopicsDetectionJobPropertiesTypeDef
- UpdateFlywheelRequestRequestTypeDef
- DatasetInputDataConfigTypeDef
- ClassifyDocumentResponseTypeDef
- TaskConfigTypeDef
- CreateEntityRecognizerRequestRequestTypeDef
- EntityRecognizerMetadataTypeDef
- DescribeFlywheelIterationResponseTypeDef
- ListFlywheelIterationHistoryResponseTypeDef
- BlockTypeDef
- BatchDetectSyntaxItemResultTypeDef
- DetectSyntaxResponseTypeDef
- TargetedSentimentEntityTypeDef
- BatchDetectEntitiesItemResultTypeDef
- DescribeDocumentClassifierResponseTypeDef
- ListDocumentClassifiersResponseTypeDef
- DescribeDocumentClassificationJobResponseTypeDef
- ListDocumentClassificationJobsResponseTypeDef
- DescribeDominantLanguageDetectionJobResponseTypeDef
- ListDominantLanguageDetectionJobsResponseTypeDef
- DescribeEntitiesDetectionJobResponseTypeDef
- ListEntitiesDetectionJobsResponseTypeDef
- DescribeEventsDetectionJobResponseTypeDef
- ListEventsDetectionJobsResponseTypeDef
- DescribeKeyPhrasesDetectionJobResponseTypeDef
- ListKeyPhrasesDetectionJobsResponseTypeDef
- DescribePiiEntitiesDetectionJobResponseTypeDef
- ListPiiEntitiesDetectionJobsResponseTypeDef
- DescribeSentimentDetectionJobResponseTypeDef
- ListSentimentDetectionJobsResponseTypeDef
- DescribeTargetedSentimentDetectionJobResponseTypeDef
- ListTargetedSentimentDetectionJobsResponseTypeDef
- DescribeTopicsDetectionJobResponseTypeDef
- ListTopicsDetectionJobsResponseTypeDef
- CreateDatasetRequestRequestTypeDef
- CreateFlywheelRequestRequestTypeDef
- FlywheelPropertiesTypeDef
- EntityRecognizerPropertiesTypeDef
- DetectEntitiesResponseTypeDef
- BatchDetectSyntaxResponseTypeDef
- BatchDetectTargetedSentimentItemResultTypeDef
- DetectTargetedSentimentResponseTypeDef
- BatchDetectEntitiesResponseTypeDef
- DescribeFlywheelResponseTypeDef
- UpdateFlywheelResponseTypeDef
- DescribeEntityRecognizerResponseTypeDef
- ListEntityRecognizersResponseTypeDef
- BatchDetectTargetedSentimentResponseTypeDef