Skip to content

Type definitions#

Index > Textract > Type definitions

Auto-generated documentation for Textract type annotations stubs module mypy-boto3-textract.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AdapterOverviewTypeDef#

# AdapterOverviewTypeDef definition

class AdapterOverviewTypeDef(TypedDict):
    AdapterId: NotRequired[str],
    AdapterName: NotRequired[str],
    CreationTime: NotRequired[datetime],
    FeatureTypes: NotRequired[List[FeatureTypeType]],  # (1)
  1. See FeatureTypeType

AdapterTypeDef#

# AdapterTypeDef definition

class AdapterTypeDef(TypedDict):
    AdapterId: str,
    Version: str,
    Pages: NotRequired[Sequence[str]],

S3ObjectTypeDef#

# S3ObjectTypeDef definition

class S3ObjectTypeDef(TypedDict):
    Bucket: NotRequired[str],
    Name: NotRequired[str],
    Version: NotRequired[str],

EvaluationMetricTypeDef#

# EvaluationMetricTypeDef definition

class EvaluationMetricTypeDef(TypedDict):
    F1Score: NotRequired[float],
    Precision: NotRequired[float],
    Recall: NotRequired[float],

AdapterVersionOverviewTypeDef#

# AdapterVersionOverviewTypeDef definition

class AdapterVersionOverviewTypeDef(TypedDict):
    AdapterId: NotRequired[str],
    AdapterVersion: NotRequired[str],
    CreationTime: NotRequired[datetime],
    FeatureTypes: NotRequired[List[FeatureTypeType]],  # (1)
    Status: NotRequired[AdapterVersionStatusType],  # (2)
    StatusMessage: NotRequired[str],
  1. See FeatureTypeType
  2. See AdapterVersionStatusType

DocumentMetadataTypeDef#

# DocumentMetadataTypeDef definition

class DocumentMetadataTypeDef(TypedDict):
    Pages: NotRequired[int],

HumanLoopActivationOutputTypeDef#

# HumanLoopActivationOutputTypeDef definition

class HumanLoopActivationOutputTypeDef(TypedDict):
    HumanLoopArn: NotRequired[str],
    HumanLoopActivationReasons: NotRequired[List[str]],
    HumanLoopActivationConditionsEvaluationResults: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

NormalizedValueTypeDef#

# NormalizedValueTypeDef definition

class NormalizedValueTypeDef(TypedDict):
    Value: NotRequired[str],
    ValueType: NotRequired[ValueTypeType],  # (1)
  1. See ValueTypeType

QueryOutputTypeDef#

# QueryOutputTypeDef definition

class QueryOutputTypeDef(TypedDict):
    Text: str,
    Alias: NotRequired[str],
    Pages: NotRequired[List[str]],

RelationshipTypeDef#

# RelationshipTypeDef definition

class RelationshipTypeDef(TypedDict):
    Type: NotRequired[RelationshipTypeType],  # (1)
    Ids: NotRequired[List[str]],
  1. See RelationshipTypeType

BoundingBoxTypeDef#

# BoundingBoxTypeDef definition

class BoundingBoxTypeDef(TypedDict):
    Width: NotRequired[float],
    Height: NotRequired[float],
    Left: NotRequired[float],
    Top: NotRequired[float],

CreateAdapterRequestRequestTypeDef#

# CreateAdapterRequestRequestTypeDef definition

class CreateAdapterRequestRequestTypeDef(TypedDict):
    AdapterName: str,
    FeatureTypes: Sequence[FeatureTypeType],  # (1)
    ClientRequestToken: NotRequired[str],
    Description: NotRequired[str],
    AutoUpdate: NotRequired[AutoUpdateType],  # (2)
    Tags: NotRequired[Mapping[str, str]],
  1. See FeatureTypeType
  2. See AutoUpdateType

OutputConfigTypeDef#

# OutputConfigTypeDef definition

class OutputConfigTypeDef(TypedDict):
    S3Bucket: str,
    S3Prefix: NotRequired[str],

DeleteAdapterRequestRequestTypeDef#

# DeleteAdapterRequestRequestTypeDef definition

class DeleteAdapterRequestRequestTypeDef(TypedDict):
    AdapterId: str,

DeleteAdapterVersionRequestRequestTypeDef#

# DeleteAdapterVersionRequestRequestTypeDef definition

class DeleteAdapterVersionRequestRequestTypeDef(TypedDict):
    AdapterId: str,
    AdapterVersion: str,

DetectedSignatureTypeDef#

# DetectedSignatureTypeDef definition

class DetectedSignatureTypeDef(TypedDict):
    Page: NotRequired[int],

SplitDocumentTypeDef#

# SplitDocumentTypeDef definition

class SplitDocumentTypeDef(TypedDict):
    Index: NotRequired[int],
    Pages: NotRequired[List[int]],

UndetectedSignatureTypeDef#

# UndetectedSignatureTypeDef definition

class UndetectedSignatureTypeDef(TypedDict):
    Page: NotRequired[int],

ExpenseCurrencyTypeDef#

# ExpenseCurrencyTypeDef definition

class ExpenseCurrencyTypeDef(TypedDict):
    Code: NotRequired[str],
    Confidence: NotRequired[float],

ExpenseGroupPropertyTypeDef#

# ExpenseGroupPropertyTypeDef definition

class ExpenseGroupPropertyTypeDef(TypedDict):
    Types: NotRequired[List[str]],
    Id: NotRequired[str],

ExpenseTypeTypeDef#

# ExpenseTypeTypeDef definition

class ExpenseTypeTypeDef(TypedDict):
    Text: NotRequired[str],
    Confidence: NotRequired[float],

PointTypeDef#

# PointTypeDef definition

class PointTypeDef(TypedDict):
    X: NotRequired[float],
    Y: NotRequired[float],

GetAdapterRequestRequestTypeDef#

# GetAdapterRequestRequestTypeDef definition

class GetAdapterRequestRequestTypeDef(TypedDict):
    AdapterId: str,

GetAdapterVersionRequestRequestTypeDef#

# GetAdapterVersionRequestRequestTypeDef definition

class GetAdapterVersionRequestRequestTypeDef(TypedDict):
    AdapterId: str,
    AdapterVersion: str,

GetDocumentAnalysisRequestRequestTypeDef#

# GetDocumentAnalysisRequestRequestTypeDef definition

class GetDocumentAnalysisRequestRequestTypeDef(TypedDict):
    JobId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

WarningTypeDef#

# WarningTypeDef definition

class WarningTypeDef(TypedDict):
    ErrorCode: NotRequired[str],
    Pages: NotRequired[List[int]],

GetDocumentTextDetectionRequestRequestTypeDef#

# GetDocumentTextDetectionRequestRequestTypeDef definition

class GetDocumentTextDetectionRequestRequestTypeDef(TypedDict):
    JobId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

GetExpenseAnalysisRequestRequestTypeDef#

# GetExpenseAnalysisRequestRequestTypeDef definition

class GetExpenseAnalysisRequestRequestTypeDef(TypedDict):
    JobId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

GetLendingAnalysisRequestRequestTypeDef#

# GetLendingAnalysisRequestRequestTypeDef definition

class GetLendingAnalysisRequestRequestTypeDef(TypedDict):
    JobId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

GetLendingAnalysisSummaryRequestRequestTypeDef#

# GetLendingAnalysisSummaryRequestRequestTypeDef definition

class GetLendingAnalysisSummaryRequestRequestTypeDef(TypedDict):
    JobId: str,

HumanLoopDataAttributesTypeDef#

# HumanLoopDataAttributesTypeDef definition

class HumanLoopDataAttributesTypeDef(TypedDict):
    ContentClassifiers: NotRequired[Sequence[ContentClassifierType]],  # (1)
  1. See ContentClassifierType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,

NotificationChannelTypeDef#

# NotificationChannelTypeDef definition

class NotificationChannelTypeDef(TypedDict):
    SNSTopicArn: str,
    RoleArn: str,

PredictionTypeDef#

# PredictionTypeDef definition

class PredictionTypeDef(TypedDict):
    Value: NotRequired[str],
    Confidence: NotRequired[float],

QueryTypeDef#

# QueryTypeDef definition

class QueryTypeDef(TypedDict):
    Text: str,
    Alias: NotRequired[str],
    Pages: NotRequired[Sequence[str]],

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

UpdateAdapterRequestRequestTypeDef#

# UpdateAdapterRequestRequestTypeDef definition

class UpdateAdapterRequestRequestTypeDef(TypedDict):
    AdapterId: str,
    Description: NotRequired[str],
    AdapterName: NotRequired[str],
    AutoUpdate: NotRequired[AutoUpdateType],  # (1)
  1. See AutoUpdateType

AdaptersConfigTypeDef#

# AdaptersConfigTypeDef definition

class AdaptersConfigTypeDef(TypedDict):
    Adapters: Sequence[AdapterTypeDef],  # (1)
  1. See AdapterTypeDef

AdapterVersionDatasetConfigTypeDef#

# AdapterVersionDatasetConfigTypeDef definition

class AdapterVersionDatasetConfigTypeDef(TypedDict):
    ManifestS3Object: NotRequired[S3ObjectTypeDef],  # (1)
  1. See S3ObjectTypeDef

DocumentLocationTypeDef#

# DocumentLocationTypeDef definition

class DocumentLocationTypeDef(TypedDict):
    S3Object: NotRequired[S3ObjectTypeDef],  # (1)
  1. See S3ObjectTypeDef

AdapterVersionEvaluationMetricTypeDef#

# AdapterVersionEvaluationMetricTypeDef definition

class AdapterVersionEvaluationMetricTypeDef(TypedDict):
    Baseline: NotRequired[EvaluationMetricTypeDef],  # (1)
    AdapterVersion: NotRequired[EvaluationMetricTypeDef],  # (1)
    FeatureType: NotRequired[FeatureTypeType],  # (3)
  1. See EvaluationMetricTypeDef
  2. See EvaluationMetricTypeDef
  3. See FeatureTypeType

CreateAdapterResponseTypeDef#

# CreateAdapterResponseTypeDef definition

class CreateAdapterResponseTypeDef(TypedDict):
    AdapterId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateAdapterVersionResponseTypeDef#

# CreateAdapterVersionResponseTypeDef definition

class CreateAdapterVersionResponseTypeDef(TypedDict):
    AdapterId: str,
    AdapterVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetAdapterResponseTypeDef#

# GetAdapterResponseTypeDef definition

class GetAdapterResponseTypeDef(TypedDict):
    AdapterId: str,
    AdapterName: str,
    CreationTime: datetime,
    Description: str,
    FeatureTypes: List[FeatureTypeType],  # (1)
    AutoUpdate: AutoUpdateType,  # (2)
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FeatureTypeType
  2. See AutoUpdateType
  3. See ResponseMetadataTypeDef

ListAdapterVersionsResponseTypeDef#

# ListAdapterVersionsResponseTypeDef definition

class ListAdapterVersionsResponseTypeDef(TypedDict):
    AdapterVersions: List[AdapterVersionOverviewTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See AdapterVersionOverviewTypeDef
  2. See ResponseMetadataTypeDef

ListAdaptersResponseTypeDef#

# ListAdaptersResponseTypeDef definition

class ListAdaptersResponseTypeDef(TypedDict):
    Adapters: List[AdapterOverviewTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See AdapterOverviewTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartDocumentAnalysisResponseTypeDef#

# StartDocumentAnalysisResponseTypeDef definition

class StartDocumentAnalysisResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartDocumentTextDetectionResponseTypeDef#

# StartDocumentTextDetectionResponseTypeDef definition

class StartDocumentTextDetectionResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartExpenseAnalysisResponseTypeDef#

# StartExpenseAnalysisResponseTypeDef definition

class StartExpenseAnalysisResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartLendingAnalysisResponseTypeDef#