Comprehend module
Index > Comprehend
Auto-generated documentation for Comprehend type annotations stubs module types-aiobotocore-comprehend.
How to install
From PyPI with pip
Install types-aioboto3
for Comprehend
service.
# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[comprehend]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aioboto3-lite[comprehend]'
# standalone installation
python -m pip install types-aiobotocore-comprehend
How to uninstall
Usage
Code samples can be found in Examples.
ComprehendClient
Type annotations and code completion for session.client("comprehend")
as ComprehendClient
boto3 documentation
Usage example
from aioboto3.session import Session
from types_aiobotocore_comprehend.client import ComprehendClient
session = Session()
async with session.client("comprehend") as client:
client: ComprehendClient
Paginators
Type annotations and code completion for
paginators
from session.client("comprehend").get_paginator("...")
.
Usage example
from types_aiobotocore_comprehend.paginator import ListDocumentClassificationJobsPaginator
def get_list_document_classification_jobs_paginator() -> ListDocumentClassificationJobsPaginator:
return client.get_paginator("list_document_classification_jobs"))
- ListDocumentClassificationJobsPaginator
- ListDocumentClassifiersPaginator
- ListDominantLanguageDetectionJobsPaginator
- ListEntitiesDetectionJobsPaginator
- ListEntityRecognizersPaginator
- ListKeyPhrasesDetectionJobsPaginator
- ListSentimentDetectionJobsPaginator
- ListTopicsDetectionJobsPaginator
Literals
Type annotations for literals used in methods and schema.
Usage example
from types_aiobotocore_comprehend.literals import AugmentedManifestsDocumentTypeFormatType
def get_value() -> AugmentedManifestsDocumentTypeFormatType:
return "PLAIN_TEXT_DOCUMENT"
- AugmentedManifestsDocumentTypeFormatType
- DocumentClassifierDataFormatType
- DocumentClassifierModeType
- DocumentReadActionType
- DocumentReadFeatureTypesType
- DocumentReadModeType
- EndpointStatusType
- EntityRecognizerDataFormatType
- EntityTypeType
- InputFormatType
- JobStatusType
- LanguageCodeType
- ListDocumentClassificationJobsPaginatorName
- ListDocumentClassifiersPaginatorName
- ListDominantLanguageDetectionJobsPaginatorName
- ListEntitiesDetectionJobsPaginatorName
- ListEntityRecognizersPaginatorName
- ListKeyPhrasesDetectionJobsPaginatorName
- ListSentimentDetectionJobsPaginatorName
- ListTopicsDetectionJobsPaginatorName
- ModelStatusType
- PartOfSpeechTagTypeType
- PiiEntitiesDetectionMaskModeType
- PiiEntitiesDetectionModeType
- PiiEntityTypeType
- SentimentTypeType
- SplitType
- SyntaxLanguageCodeType
- ComprehendServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from types_aiobotocore_comprehend.type_defs import AugmentedManifestsListItemTypeDef
def get_value() -> AugmentedManifestsListItemTypeDef:
return {
"S3Uri": ...,
"AttributeNames": ...,
}
- AugmentedManifestsListItemTypeDef
- DominantLanguageTypeDef
- BatchDetectDominantLanguageRequestRequestTypeDef
- BatchItemErrorTypeDef
- ResponseMetadataTypeDef
- EntityTypeDef
- BatchDetectEntitiesRequestRequestTypeDef
- KeyPhraseTypeDef
- BatchDetectKeyPhrasesRequestRequestTypeDef
- SentimentScoreTypeDef
- BatchDetectSentimentRequestRequestTypeDef
- BatchDetectSyntaxRequestRequestTypeDef
- ClassifierEvaluationMetricsTypeDef
- ClassifyDocumentRequestRequestTypeDef
- DocumentClassTypeDef
- DocumentLabelTypeDef
- ContainsPiiEntitiesRequestRequestTypeDef
- EntityLabelTypeDef
- DocumentClassifierOutputDataConfigTypeDef
- TagTypeDef
- VpcConfigTypeDef
- DeleteDocumentClassifierRequestRequestTypeDef
- DeleteEndpointRequestRequestTypeDef
- DeleteEntityRecognizerRequestRequestTypeDef
- DeleteResourcePolicyRequestRequestTypeDef
- DescribeDocumentClassificationJobRequestRequestTypeDef
- DescribeDocumentClassifierRequestRequestTypeDef
- DescribeDominantLanguageDetectionJobRequestRequestTypeDef
- DescribeEndpointRequestRequestTypeDef
- EndpointPropertiesTypeDef
- DescribeEntitiesDetectionJobRequestRequestTypeDef
- DescribeEntityRecognizerRequestRequestTypeDef
- DescribeEventsDetectionJobRequestRequestTypeDef
- DescribeKeyPhrasesDetectionJobRequestRequestTypeDef
- DescribePiiEntitiesDetectionJobRequestRequestTypeDef
- DescribeResourcePolicyRequestRequestTypeDef
- DescribeSentimentDetectionJobRequestRequestTypeDef
- DescribeTargetedSentimentDetectionJobRequestRequestTypeDef
- DescribeTopicsDetectionJobRequestRequestTypeDef
- DetectDominantLanguageRequestRequestTypeDef
- DetectEntitiesRequestRequestTypeDef
- DetectKeyPhrasesRequestRequestTypeDef
- DetectPiiEntitiesRequestRequestTypeDef
- PiiEntityTypeDef
- DetectSentimentRequestRequestTypeDef
- DetectSyntaxRequestRequestTypeDef
- DocumentClassificationJobFilterTypeDef
- OutputDataConfigTypeDef
- DocumentClassifierFilterTypeDef
- DocumentClassifierSummaryTypeDef
- DocumentReaderConfigTypeDef
- DominantLanguageDetectionJobFilterTypeDef
- EndpointFilterTypeDef
- EntitiesDetectionJobFilterTypeDef
- EntityRecognizerAnnotationsTypeDef
- EntityRecognizerDocumentsTypeDef
- EntityRecognizerEntityListTypeDef
- EntityRecognizerEvaluationMetricsTypeDef
- EntityRecognizerFilterTypeDef
- EntityTypesListItemTypeDef
- EntityTypesEvaluationMetricsTypeDef
- EntityRecognizerSummaryTypeDef
- EventsDetectionJobFilterTypeDef
- KeyPhrasesDetectionJobFilterTypeDef
- PaginatorConfigTypeDef
- ListDocumentClassifierSummariesRequestRequestTypeDef
- ListEntityRecognizerSummariesRequestRequestTypeDef
- PiiEntitiesDetectionJobFilterTypeDef
- SentimentDetectionJobFilterTypeDef
- ListTagsForResourceRequestRequestTypeDef
- TargetedSentimentDetectionJobFilterTypeDef
- TopicsDetectionJobFilterTypeDef
- PartOfSpeechTagTypeDef
- PiiOutputDataConfigTypeDef
- RedactionConfigTypeDef
- PutResourcePolicyRequestRequestTypeDef
- StopDominantLanguageDetectionJobRequestRequestTypeDef
- StopEntitiesDetectionJobRequestRequestTypeDef
- StopEventsDetectionJobRequestRequestTypeDef
- StopKeyPhrasesDetectionJobRequestRequestTypeDef
- StopPiiEntitiesDetectionJobRequestRequestTypeDef
- StopSentimentDetectionJobRequestRequestTypeDef
- StopTargetedSentimentDetectionJobRequestRequestTypeDef
- StopTrainingDocumentClassifierRequestRequestTypeDef
- StopTrainingEntityRecognizerRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateEndpointRequestRequestTypeDef
- DocumentClassifierInputDataConfigTypeDef
- BatchDetectDominantLanguageItemResultTypeDef
- CreateDocumentClassifierResponseTypeDef
- CreateEndpointResponseTypeDef
- CreateEntityRecognizerResponseTypeDef
- DescribeResourcePolicyResponseTypeDef
- DetectDominantLanguageResponseTypeDef
- ImportModelResponseTypeDef
- PutResourcePolicyResponseTypeDef
- StartDocumentClassificationJobResponseTypeDef
- StartDominantLanguageDetectionJobResponseTypeDef
- StartEntitiesDetectionJobResponseTypeDef
- StartEventsDetectionJobResponseTypeDef
- StartKeyPhrasesDetectionJobResponseTypeDef
- StartPiiEntitiesDetectionJobResponseTypeDef
- StartSentimentDetectionJobResponseTypeDef
- StartTargetedSentimentDetectionJobResponseTypeDef
- StartTopicsDetectionJobResponseTypeDef
- StopDominantLanguageDetectionJobResponseTypeDef
- StopEntitiesDetectionJobResponseTypeDef
- StopEventsDetectionJobResponseTypeDef
- StopKeyPhrasesDetectionJobResponseTypeDef
- StopPiiEntitiesDetectionJobResponseTypeDef
- StopSentimentDetectionJobResponseTypeDef
- StopTargetedSentimentDetectionJobResponseTypeDef
- BatchDetectEntitiesItemResultTypeDef
- DetectEntitiesResponseTypeDef
- BatchDetectKeyPhrasesItemResultTypeDef
- DetectKeyPhrasesResponseTypeDef
- BatchDetectSentimentItemResultTypeDef
- DetectSentimentResponseTypeDef
- ClassifierMetadataTypeDef
- ClassifyDocumentResponseTypeDef
- ContainsPiiEntitiesResponseTypeDef
- CreateEndpointRequestRequestTypeDef
- ImportModelRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestRequestTypeDef
- DescribeEndpointResponseTypeDef
- ListEndpointsResponseTypeDef
- DetectPiiEntitiesResponseTypeDef
- ListDocumentClassificationJobsRequestRequestTypeDef
- ListDocumentClassifiersRequestRequestTypeDef
- ListDocumentClassifierSummariesResponseTypeDef
- InputDataConfigTypeDef
- ListDominantLanguageDetectionJobsRequestRequestTypeDef
- ListEndpointsRequestRequestTypeDef
- ListEntitiesDetectionJobsRequestRequestTypeDef
- ListEntityRecognizersRequestRequestTypeDef
- EntityRecognizerInputDataConfigTypeDef
- EntityRecognizerMetadataEntityTypesListItemTypeDef
- ListEntityRecognizerSummariesResponseTypeDef
- ListEventsDetectionJobsRequestRequestTypeDef
- ListKeyPhrasesDetectionJobsRequestRequestTypeDef
- ListDocumentClassificationJobsRequestListDocumentClassificationJobsPaginateTypeDef
- ListDocumentClassifiersRequestListDocumentClassifiersPaginateTypeDef
- ListDominantLanguageDetectionJobsRequestListDominantLanguageDetectionJobsPaginateTypeDef
- ListEntitiesDetectionJobsRequestListEntitiesDetectionJobsPaginateTypeDef
- ListEntityRecognizersRequestListEntityRecognizersPaginateTypeDef
- ListKeyPhrasesDetectionJobsRequestListKeyPhrasesDetectionJobsPaginateTypeDef
- ListPiiEntitiesDetectionJobsRequestRequestTypeDef
- ListSentimentDetectionJobsRequestListSentimentDetectionJobsPaginateTypeDef
- ListSentimentDetectionJobsRequestRequestTypeDef
- ListTargetedSentimentDetectionJobsRequestRequestTypeDef
- ListTopicsDetectionJobsRequestListTopicsDetectionJobsPaginateTypeDef
- ListTopicsDetectionJobsRequestRequestTypeDef
- SyntaxTokenTypeDef
- CreateDocumentClassifierRequestRequestTypeDef
- BatchDetectDominantLanguageResponseTypeDef
- BatchDetectEntitiesResponseTypeDef
- BatchDetectKeyPhrasesResponseTypeDef
- BatchDetectSentimentResponseTypeDef
- DocumentClassifierPropertiesTypeDef
- DocumentClassificationJobPropertiesTypeDef
- DominantLanguageDetectionJobPropertiesTypeDef
- EntitiesDetectionJobPropertiesTypeDef
- EventsDetectionJobPropertiesTypeDef
- KeyPhrasesDetectionJobPropertiesTypeDef
- PiiEntitiesDetectionJobPropertiesTypeDef
- SentimentDetectionJobPropertiesTypeDef
- StartDocumentClassificationJobRequestRequestTypeDef
- StartDominantLanguageDetectionJobRequestRequestTypeDef
- StartEntitiesDetectionJobRequestRequestTypeDef
- StartEventsDetectionJobRequestRequestTypeDef
- StartKeyPhrasesDetectionJobRequestRequestTypeDef
- StartPiiEntitiesDetectionJobRequestRequestTypeDef
- StartSentimentDetectionJobRequestRequestTypeDef
- StartTargetedSentimentDetectionJobRequestRequestTypeDef
- StartTopicsDetectionJobRequestRequestTypeDef
- TargetedSentimentDetectionJobPropertiesTypeDef
- TopicsDetectionJobPropertiesTypeDef
- CreateEntityRecognizerRequestRequestTypeDef
- EntityRecognizerMetadataTypeDef
- BatchDetectSyntaxItemResultTypeDef
- DetectSyntaxResponseTypeDef
- DescribeDocumentClassifierResponseTypeDef
- ListDocumentClassifiersResponseTypeDef
- DescribeDocumentClassificationJobResponseTypeDef
- ListDocumentClassificationJobsResponseTypeDef
- DescribeDominantLanguageDetectionJobResponseTypeDef
- ListDominantLanguageDetectionJobsResponseTypeDef
- DescribeEntitiesDetectionJobResponseTypeDef
- ListEntitiesDetectionJobsResponseTypeDef
- DescribeEventsDetectionJobResponseTypeDef
- ListEventsDetectionJobsResponseTypeDef
- DescribeKeyPhrasesDetectionJobResponseTypeDef
- ListKeyPhrasesDetectionJobsResponseTypeDef
- DescribePiiEntitiesDetectionJobResponseTypeDef
- ListPiiEntitiesDetectionJobsResponseTypeDef
- DescribeSentimentDetectionJobResponseTypeDef
- ListSentimentDetectionJobsResponseTypeDef
- DescribeTargetedSentimentDetectionJobResponseTypeDef
- ListTargetedSentimentDetectionJobsResponseTypeDef
- DescribeTopicsDetectionJobResponseTypeDef
- ListTopicsDetectionJobsResponseTypeDef
- EntityRecognizerPropertiesTypeDef
- BatchDetectSyntaxResponseTypeDef
- DescribeEntityRecognizerResponseTypeDef
- ListEntityRecognizersResponseTypeDef