Skip to content

Comprehend module#

Index > Comprehend

Auto-generated documentation for Comprehend type annotations stubs module types-aiobotocore-comprehend.

How to install#

You can generate type annotations for aiobotocore package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'aiobotocore==2.25.0' mypy-boto3-builder
  2. Select aiobotocore AWS SDK.
  3. Add Comprehend service.
  4. Use provided commands to install generated packages.

From PyPI with pip#

Install types-aiobotocore for Comprehend service.

# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[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-aiobotocore-lite[comprehend]'

# standalone installation
python -m pip install types-aiobotocore-comprehend

How to uninstall#

python -m pip uninstall -y types-aiobotocore-comprehend

Usage#

Code samples can be found in Examples.

ComprehendClient#

Type annotations and code completion for session.create_client("comprehend") as ComprehendClient boto3 documentation

# ComprehendClient usage example

from aiobotocore.session import get_session

from types_aiobotocore_comprehend.client import ComprehendClient


session = get_session()
async with session.create_client("comprehend") as client:
    client: ComprehendClient

Paginators#

Type annotations and code completion for paginators from session.create_client("comprehend").get_paginator("...").

# ListDocumentClassificationJobsPaginator 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"))

Literals#

Type annotations for literals used in methods and schema.

# AugmentedManifestsDocumentTypeFormatType usage example

from types_aiobotocore_comprehend.literals import AugmentedManifestsDocumentTypeFormatType

def get_value() -> AugmentedManifestsDocumentTypeFormatType:
    return "PLAIN_TEXT_DOCUMENT"

Type definitions#

Type annotations for type definitions used in methods and schema.