Comprehend module#
Index > Comprehend
Auto-generated documentation for Comprehend type annotations stubs module types-boto3-comprehend.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
Comprehend
service. - Use provided commands to install generated packages.
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 types-boto3
for Comprehend
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[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-boto3-lite[comprehend]'
# standalone installation
python -m pip install types-boto3-comprehend
How to uninstall#
python -m pip uninstall -y types-boto3-comprehend
Usage#
Code samples can be found in Examples.
ComprehendClient#
Type annotations and code completion for boto3.client("comprehend")
as ComprehendClient
boto3 documentation
# ComprehendClient usage example
from boto3.session import Session
from types_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("...")
.
# ListDocumentClassificationJobsPaginator usage example
from boto3.session import Session
from types_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 schema.
# AugmentedManifestsDocumentTypeFormatType usage example
from types_boto3_comprehend.literals import AugmentedManifestsDocumentTypeFormatType
def get_value() -> AugmentedManifestsDocumentTypeFormatType:
return "PLAIN_TEXT_DOCUMENT"
- AugmentedManifestsDocumentTypeFormatType
- BlockTypeType
- DatasetDataFormatType
- DatasetStatusType
- DatasetTypeType
- DocumentClassifierDataFormatType
- DocumentClassifierDocumentTypeFormatType
- 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
- PageBasedWarningCodeType
- PartOfSpeechTagTypeType
- PiiEntitiesDetectionMaskModeType
- PiiEntitiesDetectionModeType
- PiiEntityTypeType
- RelationshipTypeType
- SentimentTypeType
- SplitType
- SyntaxLanguageCodeType
- TargetedSentimentEntityTypeType
- ToxicContentTypeType
- ComprehendServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AugmentedManifestsListItemOutputTypeDef
- AugmentedManifestsListItemTypeDef
- DominantLanguageTypeDef
- BatchDetectDominantLanguageRequestTypeDef
- BatchItemErrorTypeDef
- ResponseMetadataTypeDef
- BatchDetectEntitiesRequestTypeDef
- KeyPhraseTypeDef
- BatchDetectKeyPhrasesRequestTypeDef
- SentimentScoreTypeDef
- BatchDetectSentimentRequestTypeDef
- BatchDetectSyntaxRequestTypeDef
- BatchDetectTargetedSentimentRequestTypeDef
- BlobTypeDef
- ChildBlockTypeDef
- RelationshipsListItemTypeDef
- BoundingBoxTypeDef
- ClassifierEvaluationMetricsTypeDef
- DocumentClassTypeDef
- DocumentLabelTypeDef
- DocumentTypeListItemTypeDef
- ErrorsListItemTypeDef
- WarningsListItemTypeDef
- ContainsPiiEntitiesRequestTypeDef
- EntityLabelTypeDef
- TagTypeDef
- DocumentClassifierOutputDataConfigTypeDef
- VpcConfigOutputTypeDef
- VpcConfigTypeDef
- DatasetAugmentedManifestsListItemTypeDef
- DatasetDocumentClassifierInputDataConfigTypeDef
- DatasetEntityRecognizerAnnotationsTypeDef
- DatasetEntityRecognizerDocumentsTypeDef
- DatasetEntityRecognizerEntityListTypeDef
- TimestampTypeDef
- DatasetPropertiesTypeDef
- DeleteDocumentClassifierRequestTypeDef
- DeleteEndpointRequestTypeDef
- DeleteEntityRecognizerRequestTypeDef
- DeleteFlywheelRequestTypeDef
- DeleteResourcePolicyRequestTypeDef
- DescribeDatasetRequestTypeDef
- DescribeDocumentClassificationJobRequestTypeDef
- DescribeDocumentClassifierRequestTypeDef
- DescribeDominantLanguageDetectionJobRequestTypeDef
- DescribeEndpointRequestTypeDef
- EndpointPropertiesTypeDef
- DescribeEntitiesDetectionJobRequestTypeDef
- DescribeEntityRecognizerRequestTypeDef
- DescribeEventsDetectionJobRequestTypeDef
- DescribeFlywheelIterationRequestTypeDef
- DescribeFlywheelRequestTypeDef
- DescribeKeyPhrasesDetectionJobRequestTypeDef
- DescribePiiEntitiesDetectionJobRequestTypeDef
- DescribeResourcePolicyRequestTypeDef
- DescribeSentimentDetectionJobRequestTypeDef
- DescribeTargetedSentimentDetectionJobRequestTypeDef
- DescribeTopicsDetectionJobRequestTypeDef
- DetectDominantLanguageRequestTypeDef
- DetectKeyPhrasesRequestTypeDef
- DetectPiiEntitiesRequestTypeDef
- PiiEntityTypeDef
- DetectSentimentRequestTypeDef
- DetectSyntaxRequestTypeDef
- DetectTargetedSentimentRequestTypeDef
- TextSegmentTypeDef
- DocumentClassificationConfigOutputTypeDef
- DocumentClassificationConfigTypeDef
- OutputDataConfigTypeDef
- DocumentClassifierDocumentsTypeDef
- DocumentReaderConfigOutputTypeDef
- DocumentReaderConfigTypeDef
- DocumentClassifierSummaryTypeDef
- ExtractedCharactersListItemTypeDef
- EntityTypesListItemTypeDef
- EntityRecognizerAnnotationsTypeDef
- EntityRecognizerDocumentsTypeDef
- EntityRecognizerEntityListTypeDef
- EntityRecognizerEvaluationMetricsTypeDef
- EntityTypesEvaluationMetricsTypeDef
- EntityRecognizerOutputDataConfigTypeDef
- EntityRecognizerSummaryTypeDef
- FlywheelModelEvaluationMetricsTypeDef
- FlywheelSummaryTypeDef
- PointTypeDef
- PaginatorConfigTypeDef
- ListDocumentClassifierSummariesRequestTypeDef
- ListEntityRecognizerSummariesRequestTypeDef
- ListTagsForResourceRequestTypeDef
- PartOfSpeechTagTypeDef
- PiiOutputDataConfigTypeDef
- RedactionConfigOutputTypeDef
- PutResourcePolicyRequestTypeDef
- RedactionConfigTypeDef
- StartFlywheelIterationRequestTypeDef
- StopDominantLanguageDetectionJobRequestTypeDef
- StopEntitiesDetectionJobRequestTypeDef
- StopEventsDetectionJobRequestTypeDef
- StopKeyPhrasesDetectionJobRequestTypeDef
- StopPiiEntitiesDetectionJobRequestTypeDef
- StopSentimentDetectionJobRequestTypeDef
- StopTargetedSentimentDetectionJobRequestTypeDef
- StopTrainingDocumentClassifierRequestTypeDef
- StopTrainingEntityRecognizerRequestTypeDef
- ToxicContentTypeDef
- UntagResourceRequestTypeDef
- UpdateEndpointRequestTypeDef
- 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
- ContainsPiiEntitiesResponseTypeDef
- CreateEndpointRequestTypeDef
- ImportModelRequestTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestTypeDef
- DataSecurityConfigOutputTypeDef
- DataSecurityConfigTypeDef
- VpcConfigUnionTypeDef
- DatasetEntityRecognizerInputDataConfigTypeDef
- DatasetFilterTypeDef
- DocumentClassificationJobFilterTypeDef
- DocumentClassifierFilterTypeDef
- DominantLanguageDetectionJobFilterTypeDef
- EndpointFilterTypeDef
- EntitiesDetectionJobFilterTypeDef
- EntityRecognizerFilterTypeDef
- EventsDetectionJobFilterTypeDef
- FlywheelFilterTypeDef
- FlywheelIterationFilterTypeDef
- KeyPhrasesDetectionJobFilterTypeDef
- PiiEntitiesDetectionJobFilterTypeDef
- SentimentDetectionJobFilterTypeDef
- TargetedSentimentDetectionJobFilterTypeDef
- TopicsDetectionJobFilterTypeDef
- DescribeDatasetResponseTypeDef
- ListDatasetsResponseTypeDef
- DescribeEndpointResponseTypeDef
- ListEndpointsResponseTypeDef
- DetectPiiEntitiesResponseTypeDef
- DetectToxicContentRequestTypeDef
- DocumentClassifierInputDataConfigOutputTypeDef
- InputDataConfigOutputTypeDef
- DocumentClassifierInputDataConfigTypeDef
- DocumentReaderConfigUnionTypeDef
- InputDataConfigTypeDef
- ListDocumentClassifierSummariesResponseTypeDef
- DocumentMetadataTypeDef
- EntityRecognitionConfigOutputTypeDef
- EntityRecognitionConfigTypeDef
- EntityRecognizerInputDataConfigOutputTypeDef
- EntityRecognizerInputDataConfigTypeDef
- EntityRecognizerMetadataEntityTypesListItemTypeDef
- ListEntityRecognizerSummariesResponseTypeDef
- FlywheelIterationPropertiesTypeDef
- ListFlywheelsResponseTypeDef
- GeometryTypeDef
- SyntaxTokenTypeDef
- RedactionConfigUnionTypeDef
- ToxicLabelsTypeDef
- BatchDetectDominantLanguageResponseTypeDef
- BatchDetectKeyPhrasesResponseTypeDef
- BatchDetectSentimentResponseTypeDef
- TargetedSentimentMentionTypeDef
- EntityTypeDef
- DataSecurityConfigUnionTypeDef
- UpdateDataSecurityConfigTypeDef
- DatasetInputDataConfigTypeDef
- ListDatasetsRequestTypeDef
- ListDocumentClassificationJobsRequestPaginateTypeDef
- ListDocumentClassificationJobsRequestTypeDef
- ListDocumentClassifiersRequestPaginateTypeDef
- ListDocumentClassifiersRequestTypeDef
- ListDominantLanguageDetectionJobsRequestPaginateTypeDef
- ListDominantLanguageDetectionJobsRequestTypeDef
- ListEndpointsRequestPaginateTypeDef
- ListEndpointsRequestTypeDef
- ListEntitiesDetectionJobsRequestPaginateTypeDef
- ListEntitiesDetectionJobsRequestTypeDef
- ListEntityRecognizersRequestPaginateTypeDef
- ListEntityRecognizersRequestTypeDef
- ListEventsDetectionJobsRequestTypeDef
- ListFlywheelsRequestTypeDef
- ListFlywheelIterationHistoryRequestTypeDef
- ListKeyPhrasesDetectionJobsRequestPaginateTypeDef
- ListKeyPhrasesDetectionJobsRequestTypeDef
- ListPiiEntitiesDetectionJobsRequestPaginateTypeDef
- ListPiiEntitiesDetectionJobsRequestTypeDef
- ListSentimentDetectionJobsRequestPaginateTypeDef
- ListSentimentDetectionJobsRequestTypeDef
- ListTargetedSentimentDetectionJobsRequestTypeDef
- ListTopicsDetectionJobsRequestPaginateTypeDef
- ListTopicsDetectionJobsRequestTypeDef
- DocumentClassifierPropertiesTypeDef
- DocumentClassificationJobPropertiesTypeDef
- DominantLanguageDetectionJobPropertiesTypeDef
- EntitiesDetectionJobPropertiesTypeDef
- EventsDetectionJobPropertiesTypeDef
- KeyPhrasesDetectionJobPropertiesTypeDef
- PiiEntitiesDetectionJobPropertiesTypeDef
- SentimentDetectionJobPropertiesTypeDef
- TargetedSentimentDetectionJobPropertiesTypeDef
- TopicsDetectionJobPropertiesTypeDef
- DocumentClassifierInputDataConfigUnionTypeDef
- ClassifyDocumentRequestTypeDef
- DetectEntitiesRequestTypeDef
- InputDataConfigUnionTypeDef
- ClassifyDocumentResponseTypeDef
- TaskConfigOutputTypeDef
- TaskConfigTypeDef
- EntityRecognizerInputDataConfigUnionTypeDef
- EntityRecognizerMetadataTypeDef
- DescribeFlywheelIterationResponseTypeDef
- ListFlywheelIterationHistoryResponseTypeDef
- BlockTypeDef
- BatchDetectSyntaxItemResultTypeDef
- DetectSyntaxResponseTypeDef
- DetectToxicContentResponseTypeDef
- TargetedSentimentEntityTypeDef
- BatchDetectEntitiesItemResultTypeDef
- UpdateFlywheelRequestTypeDef
- CreateDatasetRequestTypeDef
- DescribeDocumentClassifierResponseTypeDef
- ListDocumentClassifiersResponseTypeDef
- DescribeDocumentClassificationJobResponseTypeDef
- ListDocumentClassificationJobsResponseTypeDef
- DescribeDominantLanguageDetectionJobResponseTypeDef
- ListDominantLanguageDetectionJobsResponseTypeDef
- DescribeEntitiesDetectionJobResponseTypeDef
- ListEntitiesDetectionJobsResponseTypeDef
- DescribeEventsDetectionJobResponseTypeDef
- ListEventsDetectionJobsResponseTypeDef
- DescribeKeyPhrasesDetectionJobResponseTypeDef
- ListKeyPhrasesDetectionJobsResponseTypeDef
- DescribePiiEntitiesDetectionJobResponseTypeDef
- ListPiiEntitiesDetectionJobsResponseTypeDef
- DescribeSentimentDetectionJobResponseTypeDef
- ListSentimentDetectionJobsResponseTypeDef
- DescribeTargetedSentimentDetectionJobResponseTypeDef
- ListTargetedSentimentDetectionJobsResponseTypeDef
- DescribeTopicsDetectionJobResponseTypeDef
- ListTopicsDetectionJobsResponseTypeDef
- CreateDocumentClassifierRequestTypeDef
- StartDocumentClassificationJobRequestTypeDef
- StartDominantLanguageDetectionJobRequestTypeDef
- StartEntitiesDetectionJobRequestTypeDef
- StartEventsDetectionJobRequestTypeDef
- StartKeyPhrasesDetectionJobRequestTypeDef
- StartPiiEntitiesDetectionJobRequestTypeDef
- StartSentimentDetectionJobRequestTypeDef
- StartTargetedSentimentDetectionJobRequestTypeDef
- StartTopicsDetectionJobRequestTypeDef
- FlywheelPropertiesTypeDef
- TaskConfigUnionTypeDef
- CreateEntityRecognizerRequestTypeDef
- EntityRecognizerPropertiesTypeDef
- DetectEntitiesResponseTypeDef
- BatchDetectSyntaxResponseTypeDef
- BatchDetectTargetedSentimentItemResultTypeDef
- DetectTargetedSentimentResponseTypeDef
- BatchDetectEntitiesResponseTypeDef
- DescribeFlywheelResponseTypeDef
- UpdateFlywheelResponseTypeDef
- CreateFlywheelRequestTypeDef
- DescribeEntityRecognizerResponseTypeDef
- ListEntityRecognizersResponseTypeDef
- BatchDetectTargetedSentimentResponseTypeDef