Skip to content

Type definitions#

Index > Textract > Type definitions

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

BlobTypeDef#

# BlobTypeDef definition

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

QueryUnionTypeDef#

# QueryUnionTypeDef definition

QueryUnionTypeDef = Union[
    QueryTypeDef,  # (1)
    QueryOutputTypeDef,  # (2)
]
  1. See QueryTypeDef
  2. See QueryOutputTypeDef

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#

# StartLendingAnalysisResponseTypeDef definition

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

UpdateAdapterResponseTypeDef#

# UpdateAdapterResponseTypeDef definition

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

AnalyzeIDDetectionsTypeDef#

# AnalyzeIDDetectionsTypeDef definition

class AnalyzeIDDetectionsTypeDef(TypedDict):
    Text: str,
    NormalizedValue: NotRequired[NormalizedValueTypeDef],  # (1)
    Confidence: NotRequired[float],
  1. See NormalizedValueTypeDef

DocumentTypeDef#

# DocumentTypeDef definition

class DocumentTypeDef(TypedDict):
    Bytes: NotRequired[BlobTypeDef],
    S3Object: NotRequired[S3ObjectTypeDef],  # (1)
  1. See S3ObjectTypeDef

DocumentGroupTypeDef#

# DocumentGroupTypeDef definition

class DocumentGroupTypeDef(TypedDict):
    Type: NotRequired[str],
    SplitDocuments: NotRequired[list[SplitDocumentTypeDef]],  # (1)
    DetectedSignatures: NotRequired[list[DetectedSignatureTypeDef]],  # (2)
    UndetectedSignatures: NotRequired[list[UndetectedSignatureTypeDef]],  # (3)
  1. See SplitDocumentTypeDef
  2. See DetectedSignatureTypeDef
  3. See UndetectedSignatureTypeDef

GeometryTypeDef#

# GeometryTypeDef definition

class GeometryTypeDef(TypedDict):
    BoundingBox: NotRequired[BoundingBoxTypeDef],  # (1)
    Polygon: NotRequired[list[PointTypeDef]],  # (2)
  1. See BoundingBoxTypeDef
  2. See PointTypeDef

HumanLoopConfigTypeDef#

# HumanLoopConfigTypeDef definition

class HumanLoopConfigTypeDef(TypedDict):
    HumanLoopName: str,
    FlowDefinitionArn: str,
    DataAttributes: NotRequired[HumanLoopDataAttributesTypeDef],  # (1)
  1. See HumanLoopDataAttributesTypeDef

ListAdapterVersionsRequestPaginateTypeDef#

# ListAdapterVersionsRequestPaginateTypeDef definition

class ListAdapterVersionsRequestPaginateTypeDef(TypedDict):
    AdapterId: NotRequired[str],
    AfterCreationTime: NotRequired[TimestampTypeDef],
    BeforeCreationTime: NotRequired[TimestampTypeDef],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListAdapterVersionsRequestRequestTypeDef#

# ListAdapterVersionsRequestRequestTypeDef definition

class ListAdapterVersionsRequestRequestTypeDef(TypedDict):
    AdapterId: NotRequired[str],
    AfterCreationTime: NotRequired[TimestampTypeDef],
    BeforeCreationTime: NotRequired[TimestampTypeDef],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListAdaptersRequestPaginateTypeDef#

# ListAdaptersRequestPaginateTypeDef definition

class ListAdaptersRequestPaginateTypeDef(TypedDict):
    AfterCreationTime: NotRequired[TimestampTypeDef],
    BeforeCreationTime: NotRequired[TimestampTypeDef],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListAdaptersRequestRequestTypeDef#

# ListAdaptersRequestRequestTypeDef definition

class ListAdaptersRequestRequestTypeDef(TypedDict):
    AfterCreationTime: NotRequired[TimestampTypeDef],
    BeforeCreationTime: NotRequired[TimestampTypeDef],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

PageClassificationTypeDef#

# PageClassificationTypeDef definition

class PageClassificationTypeDef(TypedDict):
    PageType: list[PredictionTypeDef],  # (1)
    PageNumber: list[PredictionTypeDef],  # (1)
  1. See PredictionTypeDef
  2. See PredictionTypeDef

CreateAdapterVersionRequestRequestTypeDef#

# CreateAdapterVersionRequestRequestTypeDef definition

class CreateAdapterVersionRequestRequestTypeDef(TypedDict):
    AdapterId: str,
    DatasetConfig: AdapterVersionDatasetConfigTypeDef,  # (1)
    OutputConfig: OutputConfigTypeDef,  # (2)
    ClientRequestToken: NotRequired[str],
    KMSKeyId: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
  1. See AdapterVersionDatasetConfigTypeDef
  2. See OutputConfigTypeDef

StartDocumentTextDetectionRequestRequestTypeDef#

# StartDocumentTextDetectionRequestRequestTypeDef definition

class StartDocumentTextDetectionRequestRequestTypeDef(TypedDict):
    DocumentLocation: DocumentLocationTypeDef,  # (1)
    ClientRequestToken: NotRequired[str],
    JobTag: NotRequired[str],
    NotificationChannel: NotRequired[NotificationChannelTypeDef],  # (2)
    OutputConfig: NotRequired[OutputConfigTypeDef],  # (3)
    KMSKeyId: NotRequired[str],
  1. See DocumentLocationTypeDef
  2. See NotificationChannelTypeDef
  3. See OutputConfigTypeDef

StartExpenseAnalysisRequestRequestTypeDef#

# StartExpenseAnalysisRequestRequestTypeDef definition

class StartExpenseAnalysisRequestRequestTypeDef(TypedDict):
    DocumentLocation: DocumentLocationTypeDef,  # (1)
    ClientRequestToken: NotRequired[str],
    JobTag: NotRequired[str],
    NotificationChannel: NotRequired[NotificationChannelTypeDef],  # (2)
    OutputConfig: NotRequired[OutputConfigTypeDef],  # (3)
    KMSKeyId: NotRequired[str],
  1. See DocumentLocationTypeDef
  2. See NotificationChannelTypeDef
  3. See OutputConfigTypeDef

StartLendingAnalysisRequestRequestTypeDef#

# StartLendingAnalysisRequestRequestTypeDef definition

class StartLendingAnalysisRequestRequestTypeDef(TypedDict):
    DocumentLocation: DocumentLocationTypeDef,  # (1)
    ClientRequestToken: NotRequired[str],
    JobTag: NotRequired[str],
    NotificationChannel: NotRequired[NotificationChannelTypeDef],  # (2)
    OutputConfig: NotRequired[OutputConfigTypeDef],  # (3)
    KMSKeyId: NotRequired[str],
  1. See DocumentLocationTypeDef
  2. See NotificationChannelTypeDef
  3. See OutputConfigTypeDef

GetAdapterVersionResponseTypeDef#

# GetAdapterVersionResponseTypeDef definition

class GetAdapterVersionResponseTypeDef(TypedDict):
    AdapterId: str,
    AdapterVersion: str,
    CreationTime: datetime,
    FeatureTypes: list[FeatureTypeType],  # (1)
    Status: AdapterVersionStatusType,  # (2)
    StatusMessage: str,
    DatasetConfig: AdapterVersionDatasetConfigTypeDef,  # (3)
    KMSKeyId: str,
    OutputConfig: OutputConfigTypeDef,  # (4)
    EvaluationMetrics: list[AdapterVersionEvaluationMetricTypeDef],  # (5)
    Tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See FeatureTypeType
  2. See AdapterVersionStatusType
  3. See AdapterVersionDatasetConfigTypeDef
  4. See OutputConfigTypeDef
  5. See AdapterVersionEvaluationMetricTypeDef
  6. See ResponseMetadataTypeDef

IdentityDocumentFieldTypeDef#

# IdentityDocumentFieldTypeDef definition

class IdentityDocumentFieldTypeDef(TypedDict):
    Type: NotRequired[AnalyzeIDDetectionsTypeDef],  # (1)
    ValueDetection: NotRequired[AnalyzeIDDetectionsTypeDef],  # (1)
  1. See AnalyzeIDDetectionsTypeDef
  2. See AnalyzeIDDetectionsTypeDef

AnalyzeExpenseRequestRequestTypeDef#

# AnalyzeExpenseRequestRequestTypeDef definition

class AnalyzeExpenseRequestRequestTypeDef(TypedDict):
    Document: DocumentTypeDef,  # (1)
  1. See DocumentTypeDef

AnalyzeIDRequestRequestTypeDef#

# AnalyzeIDRequestRequestTypeDef definition

class AnalyzeIDRequestRequestTypeDef(TypedDict):
    DocumentPages: Sequence[DocumentTypeDef],  # (1)
  1. See DocumentTypeDef

DetectDocumentTextRequestRequestTypeDef#

# DetectDocumentTextRequestRequestTypeDef definition

class DetectDocumentTextRequestRequestTypeDef(TypedDict):
    Document: DocumentTypeDef,  # (1)
  1. See DocumentTypeDef

LendingSummaryTypeDef#

# LendingSummaryTypeDef definition

class LendingSummaryTypeDef(TypedDict):
    DocumentGroups: NotRequired[list[DocumentGroupTypeDef]],  # (1)
    UndetectedDocumentTypes: NotRequired[list[str]],
  1. See DocumentGroupTypeDef

BlockTypeDef#

# BlockTypeDef definition

class BlockTypeDef(TypedDict):
    BlockType: NotRequired[BlockTypeType],  # (1)
    Confidence: NotRequired[float],
    Text: NotRequired[str],
    TextType: NotRequired[TextTypeType],  # (2)
    RowIndex: NotRequired[int],
    ColumnIndex: NotRequired[int],
    RowSpan: NotRequired[int],
    ColumnSpan: NotRequired[int],
    Geometry: NotRequired[GeometryTypeDef],  # (3)
    Id: NotRequired[str],
    Relationships: NotRequired[list[RelationshipTypeDef]],  # (4)
    EntityTypes: NotRequired[list[EntityTypeType]],  # (5)
    SelectionStatus: NotRequired[SelectionStatusType],  # (6)
    Page: NotRequired[int],
    Query: NotRequired[QueryOutputTypeDef],  # (7)
  1. See BlockTypeType
  2. See TextTypeType
  3. See GeometryTypeDef
  4. See RelationshipTypeDef
  5. See EntityTypeType
  6. See SelectionStatusType
  7. See QueryOutputTypeDef

ExpenseDetectionTypeDef#

# ExpenseDetectionTypeDef definition

class ExpenseDetectionTypeDef(TypedDict):
    Text: NotRequired[str],
    Geometry: NotRequired[GeometryTypeDef],  # (1)
    Confidence: NotRequired[float],
  1. See GeometryTypeDef

LendingDetectionTypeDef#

# LendingDetectionTypeDef definition

class LendingDetectionTypeDef(TypedDict):
    Text: NotRequired[str],
    SelectionStatus: NotRequired[SelectionStatusType],  # (1)
    Geometry: NotRequired[GeometryTypeDef],  # (2)
    Confidence: NotRequired[float],
  1. See SelectionStatusType
  2. See GeometryTypeDef

SignatureDetectionTypeDef#

# SignatureDetectionTypeDef definition

class SignatureDetectionTypeDef(TypedDict):
    Confidence: NotRequired[float],
    Geometry: NotRequired[GeometryTypeDef],  # (1)
  1. See GeometryTypeDef

QueriesConfigTypeDef#

# QueriesConfigTypeDef definition

class QueriesConfigTypeDef(TypedDict):
    Queries: Sequence[QueryUnionTypeDef],  # (1)
  1. See QueryTypeDef QueryOutputTypeDef

GetLendingAnalysisSummaryResponseTypeDef#

# GetLendingAnalysisSummaryResponseTypeDef definition

class GetLendingAnalysisSummaryResponseTypeDef(TypedDict):
    DocumentMetadata: DocumentMetadataTypeDef,  # (1)
    JobStatus: JobStatusType,  # (2)
    Summary: LendingSummaryTypeDef,  # (3)
    Warnings: list[WarningTypeDef],  # (4)
    StatusMessage: str,
    AnalyzeLendingModelVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See DocumentMetadataTypeDef
  2. See JobStatusType
  3. See LendingSummaryTypeDef
  4. See WarningTypeDef
  5. See ResponseMetadataTypeDef

AnalyzeDocumentResponseTypeDef#

# AnalyzeDocumentResponseTypeDef definition

class AnalyzeDocumentResponseTypeDef(TypedDict):
    DocumentMetadata: DocumentMetadataTypeDef,  # (1)
    Blocks: list[BlockTypeDef],  # (2)
    HumanLoopActivationOutput: HumanLoopActivationOutputTypeDef,  # (3)
    AnalyzeDocumentModelVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See DocumentMetadataTypeDef
  2. See BlockTypeDef
  3. See HumanLoopActivationOutputTypeDef
  4. See ResponseMetadataTypeDef

DetectDocumentTextResponseTypeDef#

# DetectDocumentTextResponseTypeDef definition

class DetectDocumentTextResponseTypeDef(TypedDict):
    DocumentMetadata: DocumentMetadataTypeDef,  # (1)
    Blocks: list[BlockTypeDef],  # (2)
    DetectDocumentTextModelVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See DocumentMetadataTypeDef
  2. See BlockTypeDef
  3. See ResponseMetadataTypeDef

GetDocumentAnalysisResponseTypeDef#

# GetDocumentAnalysisResponseTypeDef definition

class GetDocumentAnalysisResponseTypeDef(TypedDict):
    DocumentMetadata: DocumentMetadataTypeDef,  # (1)
    JobStatus: JobStatusType,  # (2)
    Blocks: list[BlockTypeDef],  # (3)
    Warnings: list[WarningTypeDef],  # (4)
    StatusMessage: str,
    AnalyzeDocumentModelVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
    NextToken: NotRequired[str],
  1. See DocumentMetadataTypeDef
  2. See JobStatusType
  3. See BlockTypeDef
  4. See WarningTypeDef
  5. See ResponseMetadataTypeDef

GetDocumentTextDetectionResponseTypeDef#

# GetDocumentTextDetectionResponseTypeDef definition

class GetDocumentTextDetectionResponseTypeDef(TypedDict):
    DocumentMetadata: DocumentMetadataTypeDef,  # (1)
    JobStatus: JobStatusType,  # (2)
    Blocks: list[BlockTypeDef],  # (3)
    Warnings: list[WarningTypeDef],  # (4)
    StatusMessage: str,
    DetectDocumentTextModelVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
    NextToken: NotRequired[str],
  1. See DocumentMetadataTypeDef
  2. See JobStatusType
  3. See BlockTypeDef
  4. See WarningTypeDef
  5. See ResponseMetadataTypeDef

IdentityDocumentTypeDef#

# IdentityDocumentTypeDef definition

class IdentityDocumentTypeDef(TypedDict):
    DocumentIndex: NotRequired[int],
    IdentityDocumentFields: NotRequired[list[IdentityDocumentFieldTypeDef]],  # (1)
    Blocks: NotRequired[list[BlockTypeDef]],  # (2)
  1. See IdentityDocumentFieldTypeDef
  2. See BlockTypeDef

ExpenseFieldTypeDef#

# ExpenseFieldTypeDef definition

class ExpenseFieldTypeDef(TypedDict):
    Type: NotRequired[ExpenseTypeTypeDef],  # (1)
    LabelDetection: NotRequired[ExpenseDetectionTypeDef],  # (2)
    ValueDetection: NotRequired[ExpenseDetectionTypeDef],  # (2)
    PageNumber: NotRequired[int],
    Currency: NotRequired[ExpenseCurrencyTypeDef],  # (4)
    GroupProperties: NotRequired[list[ExpenseGroupPropertyTypeDef]],  # (5)
  1. See ExpenseTypeTypeDef
  2. See ExpenseDetectionTypeDef
  3. See ExpenseDetectionTypeDef
  4. See ExpenseCurrencyTypeDef
  5. See ExpenseGroupPropertyTypeDef

LendingFieldTypeDef#

# LendingFieldTypeDef definition

class LendingFieldTypeDef(TypedDict):
    Type: NotRequired[str],
    KeyDetection: NotRequired[LendingDetectionTypeDef],  # (1)
    ValueDetections: NotRequired[list[LendingDetectionTypeDef]],  # (2)
  1. See LendingDetectionTypeDef
  2. See LendingDetectionTypeDef

AnalyzeDocumentRequestRequestTypeDef#

# AnalyzeDocumentRequestRequestTypeDef definition

class AnalyzeDocumentRequestRequestTypeDef(TypedDict):
    Document: DocumentTypeDef,  # (1)
    FeatureTypes: Sequence[FeatureTypeType],  # (2)
    HumanLoopConfig: NotRequired[HumanLoopConfigTypeDef],  # (3)
    QueriesConfig: NotRequired[QueriesConfigTypeDef],  # (4)
    AdaptersConfig: NotRequired[AdaptersConfigTypeDef],  # (5)
  1. See DocumentTypeDef
  2. See FeatureTypeType
  3. See HumanLoopConfigTypeDef
  4. See QueriesConfigTypeDef
  5. See AdaptersConfigTypeDef

StartDocumentAnalysisRequestRequestTypeDef#

# StartDocumentAnalysisRequestRequestTypeDef definition

class StartDocumentAnalysisRequestRequestTypeDef(TypedDict):
    DocumentLocation: DocumentLocationTypeDef,  # (1)
    FeatureTypes: Sequence[FeatureTypeType],  # (2)
    ClientRequestToken: NotRequired[str],
    JobTag: NotRequired[str],
    NotificationChannel: NotRequired[NotificationChannelTypeDef],  # (3)
    OutputConfig: NotRequired[OutputConfigTypeDef],  # (4)
    KMSKeyId: NotRequired[str],
    QueriesConfig: NotRequired[QueriesConfigTypeDef],  # (5)
    AdaptersConfig: NotRequired[AdaptersConfigTypeDef],  # (6)
  1. See DocumentLocationTypeDef
  2. See FeatureTypeType
  3. See NotificationChannelTypeDef
  4. See OutputConfigTypeDef
  5. See QueriesConfigTypeDef
  6. See AdaptersConfigTypeDef

AnalyzeIDResponseTypeDef#

# AnalyzeIDResponseTypeDef definition

class AnalyzeIDResponseTypeDef(TypedDict):
    IdentityDocuments: list[IdentityDocumentTypeDef],  # (1)
    DocumentMetadata: DocumentMetadataTypeDef,  # (2)
    AnalyzeIDModelVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See IdentityDocumentTypeDef
  2. See DocumentMetadataTypeDef
  3. See ResponseMetadataTypeDef

LineItemFieldsTypeDef#

# LineItemFieldsTypeDef definition

class LineItemFieldsTypeDef(TypedDict):
    LineItemExpenseFields: NotRequired[list[ExpenseFieldTypeDef]],  # (1)
  1. See ExpenseFieldTypeDef

LendingDocumentTypeDef#

# LendingDocumentTypeDef definition

class LendingDocumentTypeDef(TypedDict):
    LendingFields: NotRequired[list[LendingFieldTypeDef]],  # (1)
    SignatureDetections: NotRequired[list[SignatureDetectionTypeDef]],  # (2)
  1. See LendingFieldTypeDef
  2. See SignatureDetectionTypeDef

LineItemGroupTypeDef#

# LineItemGroupTypeDef definition

class LineItemGroupTypeDef(TypedDict):
    LineItemGroupIndex: NotRequired[int],
    LineItems: NotRequired[list[LineItemFieldsTypeDef]],  # (1)
  1. See LineItemFieldsTypeDef

ExpenseDocumentTypeDef#

# ExpenseDocumentTypeDef definition

class ExpenseDocumentTypeDef(TypedDict):
    ExpenseIndex: NotRequired[int],
    SummaryFields: NotRequired[list[ExpenseFieldTypeDef]],  # (1)
    LineItemGroups: NotRequired[list[LineItemGroupTypeDef]],  # (2)
    Blocks: NotRequired[list[BlockTypeDef]],  # (3)
  1. See ExpenseFieldTypeDef
  2. See LineItemGroupTypeDef
  3. See BlockTypeDef

AnalyzeExpenseResponseTypeDef#

# AnalyzeExpenseResponseTypeDef definition

class AnalyzeExpenseResponseTypeDef(TypedDict):
    DocumentMetadata: DocumentMetadataTypeDef,  # (1)
    ExpenseDocuments: list[ExpenseDocumentTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See DocumentMetadataTypeDef
  2. See ExpenseDocumentTypeDef
  3. See ResponseMetadataTypeDef

ExtractionTypeDef#

# ExtractionTypeDef definition

class ExtractionTypeDef(TypedDict):
    LendingDocument: NotRequired[LendingDocumentTypeDef],  # (1)
    ExpenseDocument: NotRequired[ExpenseDocumentTypeDef],  # (2)
    IdentityDocument: NotRequired[IdentityDocumentTypeDef],  # (3)
  1. See LendingDocumentTypeDef
  2. See ExpenseDocumentTypeDef
  3. See IdentityDocumentTypeDef

GetExpenseAnalysisResponseTypeDef#

# GetExpenseAnalysisResponseTypeDef definition

class GetExpenseAnalysisResponseTypeDef(TypedDict):
    DocumentMetadata: DocumentMetadataTypeDef,  # (1)
    JobStatus: JobStatusType,  # (2)
    ExpenseDocuments: list[ExpenseDocumentTypeDef],  # (3)
    Warnings: list[WarningTypeDef],  # (4)
    StatusMessage: str,
    AnalyzeExpenseModelVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
    NextToken: NotRequired[str],
  1. See DocumentMetadataTypeDef
  2. See JobStatusType
  3. See ExpenseDocumentTypeDef
  4. See WarningTypeDef
  5. See ResponseMetadataTypeDef

LendingResultTypeDef#

# LendingResultTypeDef definition

class LendingResultTypeDef(TypedDict):
    Page: NotRequired[int],
    PageClassification: NotRequired[PageClassificationTypeDef],  # (1)
    Extractions: NotRequired[list[ExtractionTypeDef]],  # (2)
  1. See PageClassificationTypeDef
  2. See ExtractionTypeDef

GetLendingAnalysisResponseTypeDef#

# GetLendingAnalysisResponseTypeDef definition

class GetLendingAnalysisResponseTypeDef(TypedDict):
    DocumentMetadata: DocumentMetadataTypeDef,  # (1)
    JobStatus: JobStatusType,  # (2)
    Results: list[LendingResultTypeDef],  # (3)
    Warnings: list[WarningTypeDef],  # (4)
    StatusMessage: str,
    AnalyzeLendingModelVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
    NextToken: NotRequired[str],
  1. See DocumentMetadataTypeDef
  2. See JobStatusType
  3. See LendingResultTypeDef
  4. See WarningTypeDef
  5. See ResponseMetadataTypeDef