Type definitions

Index > Textract > Type definitions

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

BlobTypeDef

# BlobTypeDef Union usage example

from types_boto3_textract.type_defs import BlobTypeDef


def get_value() -> BlobTypeDef:
    return ...


# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    botocore.response.StreamingBody,
]

TimestampTypeDef

# TimestampTypeDef Union usage example

from types_boto3_textract.type_defs import TimestampTypeDef


def get_value() -> TimestampTypeDef:
    return ...


# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime.datetime,
    str,
]

QueryUnionTypeDef

# QueryUnionTypeDef Union usage example

from types_boto3_textract.type_defs import QueryUnionTypeDef


def get_value() -> QueryUnionTypeDef:
    return ...


# QueryUnionTypeDef definition

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

1. See QueryTypeDef
2. See QueryOutputTypeDef

AdapterOverviewTypeDef

# AdapterOverviewTypeDef TypedDict usage example

from types_boto3_textract.type_defs import AdapterOverviewTypeDef


def get_value() -> AdapterOverviewTypeDef:
    return {
        "AdapterId": ...,
    }


# AdapterOverviewTypeDef definition

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

1. See List[FeatureTypeType]

AdapterTypeDef

# AdapterTypeDef TypedDict usage example

from types_boto3_textract.type_defs import AdapterTypeDef


def get_value() -> AdapterTypeDef:
    return {
        "AdapterId": ...,
    }


# AdapterTypeDef definition

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

S3ObjectTypeDef

# S3ObjectTypeDef TypedDict usage example

from types_boto3_textract.type_defs import S3ObjectTypeDef


def get_value() -> S3ObjectTypeDef:
    return {
        "Bucket": ...,
    }


# S3ObjectTypeDef definition

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

EvaluationMetricTypeDef

# EvaluationMetricTypeDef TypedDict usage example

from types_boto3_textract.type_defs import EvaluationMetricTypeDef


def get_value() -> EvaluationMetricTypeDef:
    return {
        "F1Score": ...,
    }


# EvaluationMetricTypeDef definition

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

AdapterVersionOverviewTypeDef

# AdapterVersionOverviewTypeDef TypedDict usage example

from types_boto3_textract.type_defs import AdapterVersionOverviewTypeDef


def get_value() -> AdapterVersionOverviewTypeDef:
    return {
        "AdapterId": ...,
    }


# AdapterVersionOverviewTypeDef definition

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

1. See List[FeatureTypeType]
2. See AdapterVersionStatusType

DocumentMetadataTypeDef

# DocumentMetadataTypeDef TypedDict usage example

from types_boto3_textract.type_defs import DocumentMetadataTypeDef


def get_value() -> DocumentMetadataTypeDef:
    return {
        "Pages": ...,
    }


# DocumentMetadataTypeDef definition

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

HumanLoopActivationOutputTypeDef

# HumanLoopActivationOutputTypeDef TypedDict usage example

from types_boto3_textract.type_defs import HumanLoopActivationOutputTypeDef


def get_value() -> HumanLoopActivationOutputTypeDef:
    return {
        "HumanLoopArn": ...,
    }


# HumanLoopActivationOutputTypeDef definition

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

ResponseMetadataTypeDef

# ResponseMetadataTypeDef TypedDict usage example

from types_boto3_textract.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

NormalizedValueTypeDef

# NormalizedValueTypeDef TypedDict usage example

from types_boto3_textract.type_defs import NormalizedValueTypeDef


def get_value() -> NormalizedValueTypeDef:
    return {
        "Value": ...,
    }


# NormalizedValueTypeDef definition

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

1. See ValueTypeType

QueryOutputTypeDef

# QueryOutputTypeDef TypedDict usage example

from types_boto3_textract.type_defs import QueryOutputTypeDef


def get_value() -> QueryOutputTypeDef:
    return {
        "Text": ...,
    }


# QueryOutputTypeDef definition

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

RelationshipTypeDef

# RelationshipTypeDef TypedDict usage example

from types_boto3_textract.type_defs import RelationshipTypeDef


def get_value() -> RelationshipTypeDef:
    return {
        "Type": ...,
    }


# RelationshipTypeDef definition

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

1. See RelationshipTypeType

BoundingBoxTypeDef

# BoundingBoxTypeDef TypedDict usage example

from types_boto3_textract.type_defs import BoundingBoxTypeDef


def get_value() -> BoundingBoxTypeDef:
    return {
        "Width": ...,
    }


# BoundingBoxTypeDef definition

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

CreateAdapterRequestTypeDef

# CreateAdapterRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import CreateAdapterRequestTypeDef


def get_value() -> CreateAdapterRequestTypeDef:
    return {
        "AdapterName": ...,
    }


# CreateAdapterRequestTypeDef definition

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

1. See Sequence[FeatureTypeType]
2. See AutoUpdateType

OutputConfigTypeDef

# OutputConfigTypeDef TypedDict usage example

from types_boto3_textract.type_defs import OutputConfigTypeDef


def get_value() -> OutputConfigTypeDef:
    return {
        "S3Bucket": ...,
    }


# OutputConfigTypeDef definition

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

DeleteAdapterRequestTypeDef

# DeleteAdapterRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import DeleteAdapterRequestTypeDef


def get_value() -> DeleteAdapterRequestTypeDef:
    return {
        "AdapterId": ...,
    }


# DeleteAdapterRequestTypeDef definition

class DeleteAdapterRequestTypeDef(TypedDict):
    AdapterId: str,

DeleteAdapterVersionRequestTypeDef

# DeleteAdapterVersionRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import DeleteAdapterVersionRequestTypeDef


def get_value() -> DeleteAdapterVersionRequestTypeDef:
    return {
        "AdapterId": ...,
    }


# DeleteAdapterVersionRequestTypeDef definition

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

DetectedSignatureTypeDef

# DetectedSignatureTypeDef TypedDict usage example

from types_boto3_textract.type_defs import DetectedSignatureTypeDef


def get_value() -> DetectedSignatureTypeDef:
    return {
        "Page": ...,
    }


# DetectedSignatureTypeDef definition

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

SplitDocumentTypeDef

# SplitDocumentTypeDef TypedDict usage example

from types_boto3_textract.type_defs import SplitDocumentTypeDef


def get_value() -> SplitDocumentTypeDef:
    return {
        "Index": ...,
    }


# SplitDocumentTypeDef definition

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

UndetectedSignatureTypeDef

# UndetectedSignatureTypeDef TypedDict usage example

from types_boto3_textract.type_defs import UndetectedSignatureTypeDef


def get_value() -> UndetectedSignatureTypeDef:
    return {
        "Page": ...,
    }


# UndetectedSignatureTypeDef definition

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

ExpenseCurrencyTypeDef

# ExpenseCurrencyTypeDef TypedDict usage example

from types_boto3_textract.type_defs import ExpenseCurrencyTypeDef


def get_value() -> ExpenseCurrencyTypeDef:
    return {
        "Code": ...,
    }


# ExpenseCurrencyTypeDef definition

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

ExpenseGroupPropertyTypeDef

# ExpenseGroupPropertyTypeDef TypedDict usage example

from types_boto3_textract.type_defs import ExpenseGroupPropertyTypeDef


def get_value() -> ExpenseGroupPropertyTypeDef:
    return {
        "Types": ...,
    }


# ExpenseGroupPropertyTypeDef definition

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

ExpenseTypeTypeDef

# ExpenseTypeTypeDef TypedDict usage example

from types_boto3_textract.type_defs import ExpenseTypeTypeDef


def get_value() -> ExpenseTypeTypeDef:
    return {
        "Text": ...,
    }


# ExpenseTypeTypeDef definition

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

PointTypeDef

# PointTypeDef TypedDict usage example

from types_boto3_textract.type_defs import PointTypeDef


def get_value() -> PointTypeDef:
    return {
        "X": ...,
    }


# PointTypeDef definition

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

GetAdapterRequestTypeDef

# GetAdapterRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import GetAdapterRequestTypeDef


def get_value() -> GetAdapterRequestTypeDef:
    return {
        "AdapterId": ...,
    }


# GetAdapterRequestTypeDef definition

class GetAdapterRequestTypeDef(TypedDict):
    AdapterId: str,

GetAdapterVersionRequestTypeDef

# GetAdapterVersionRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import GetAdapterVersionRequestTypeDef


def get_value() -> GetAdapterVersionRequestTypeDef:
    return {
        "AdapterId": ...,
    }


# GetAdapterVersionRequestTypeDef definition

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

GetDocumentAnalysisRequestTypeDef

# GetDocumentAnalysisRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import GetDocumentAnalysisRequestTypeDef


def get_value() -> GetDocumentAnalysisRequestTypeDef:
    return {
        "JobId": ...,
    }


# GetDocumentAnalysisRequestTypeDef definition

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

WarningTypeDef

# WarningTypeDef TypedDict usage example

from types_boto3_textract.type_defs import WarningTypeDef


def get_value() -> WarningTypeDef:
    return {
        "ErrorCode": ...,
    }


# WarningTypeDef definition

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

GetDocumentTextDetectionRequestTypeDef

# GetDocumentTextDetectionRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import GetDocumentTextDetectionRequestTypeDef


def get_value() -> GetDocumentTextDetectionRequestTypeDef:
    return {
        "JobId": ...,
    }


# GetDocumentTextDetectionRequestTypeDef definition

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

GetExpenseAnalysisRequestTypeDef

# GetExpenseAnalysisRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import GetExpenseAnalysisRequestTypeDef


def get_value() -> GetExpenseAnalysisRequestTypeDef:
    return {
        "JobId": ...,
    }


# GetExpenseAnalysisRequestTypeDef definition

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

GetLendingAnalysisRequestTypeDef

# GetLendingAnalysisRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import GetLendingAnalysisRequestTypeDef


def get_value() -> GetLendingAnalysisRequestTypeDef:
    return {
        "JobId": ...,
    }


# GetLendingAnalysisRequestTypeDef definition

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

GetLendingAnalysisSummaryRequestTypeDef

# GetLendingAnalysisSummaryRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import GetLendingAnalysisSummaryRequestTypeDef


def get_value() -> GetLendingAnalysisSummaryRequestTypeDef:
    return {
        "JobId": ...,
    }


# GetLendingAnalysisSummaryRequestTypeDef definition

class GetLendingAnalysisSummaryRequestTypeDef(TypedDict):
    JobId: str,

HumanLoopDataAttributesTypeDef

# HumanLoopDataAttributesTypeDef TypedDict usage example

from types_boto3_textract.type_defs import HumanLoopDataAttributesTypeDef


def get_value() -> HumanLoopDataAttributesTypeDef:
    return {
        "ContentClassifiers": ...,
    }


# HumanLoopDataAttributesTypeDef definition

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

1. See Sequence[ContentClassifierType]

PaginatorConfigTypeDef

# PaginatorConfigTypeDef TypedDict usage example

from types_boto3_textract.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

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

ListTagsForResourceRequestTypeDef

# ListTagsForResourceRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "ResourceARN": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    ResourceARN: str,

NotificationChannelTypeDef

# NotificationChannelTypeDef TypedDict usage example

from types_boto3_textract.type_defs import NotificationChannelTypeDef


def get_value() -> NotificationChannelTypeDef:
    return {
        "SNSTopicArn": ...,
    }


# NotificationChannelTypeDef definition

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

PredictionTypeDef

# PredictionTypeDef TypedDict usage example

from types_boto3_textract.type_defs import PredictionTypeDef


def get_value() -> PredictionTypeDef:
    return {
        "Value": ...,
    }


# PredictionTypeDef definition

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

QueryTypeDef

# QueryTypeDef TypedDict usage example

from types_boto3_textract.type_defs import QueryTypeDef


def get_value() -> QueryTypeDef:
    return {
        "Text": ...,
    }


# QueryTypeDef definition

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

TagResourceRequestTypeDef

# TagResourceRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "ResourceARN": ...,
    }


# TagResourceRequestTypeDef definition

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

UntagResourceRequestTypeDef

# UntagResourceRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "ResourceARN": ...,
    }


# UntagResourceRequestTypeDef definition

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

UpdateAdapterRequestTypeDef

# UpdateAdapterRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import UpdateAdapterRequestTypeDef


def get_value() -> UpdateAdapterRequestTypeDef:
    return {
        "AdapterId": ...,
    }


# UpdateAdapterRequestTypeDef definition

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

1. See AutoUpdateType

AdaptersConfigTypeDef

# AdaptersConfigTypeDef TypedDict usage example

from types_boto3_textract.type_defs import AdaptersConfigTypeDef


def get_value() -> AdaptersConfigTypeDef:
    return {
        "Adapters": ...,
    }


# AdaptersConfigTypeDef definition

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

1. See Sequence[AdapterTypeDef]

AdapterVersionDatasetConfigTypeDef

# AdapterVersionDatasetConfigTypeDef TypedDict usage example

from types_boto3_textract.type_defs import AdapterVersionDatasetConfigTypeDef


def get_value() -> AdapterVersionDatasetConfigTypeDef:
    return {
        "ManifestS3Object": ...,
    }


# AdapterVersionDatasetConfigTypeDef definition

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

1. See S3ObjectTypeDef

DocumentLocationTypeDef

# DocumentLocationTypeDef TypedDict usage example

from types_boto3_textract.type_defs import DocumentLocationTypeDef


def get_value() -> DocumentLocationTypeDef:
    return {
        "S3Object": ...,
    }


# DocumentLocationTypeDef definition

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

1. See S3ObjectTypeDef

AdapterVersionEvaluationMetricTypeDef

# AdapterVersionEvaluationMetricTypeDef TypedDict usage example

from types_boto3_textract.type_defs import AdapterVersionEvaluationMetricTypeDef


def get_value() -> AdapterVersionEvaluationMetricTypeDef:
    return {
        "Baseline": ...,
    }


# 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 TypedDict usage example

from types_boto3_textract.type_defs import CreateAdapterResponseTypeDef


def get_value() -> CreateAdapterResponseTypeDef:
    return {
        "AdapterId": ...,
    }


# CreateAdapterResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

CreateAdapterVersionResponseTypeDef

# CreateAdapterVersionResponseTypeDef TypedDict usage example

from types_boto3_textract.type_defs import CreateAdapterVersionResponseTypeDef


def get_value() -> CreateAdapterVersionResponseTypeDef:
    return {
        "AdapterId": ...,
    }


# CreateAdapterVersionResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

GetAdapterResponseTypeDef

# GetAdapterResponseTypeDef TypedDict usage example

from types_boto3_textract.type_defs import GetAdapterResponseTypeDef


def get_value() -> GetAdapterResponseTypeDef:
    return {
        "AdapterId": ...,
    }


# GetAdapterResponseTypeDef definition

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

1. See List[FeatureTypeType]
2. See AutoUpdateType
3. See ResponseMetadataTypeDef

ListAdapterVersionsResponseTypeDef

# ListAdapterVersionsResponseTypeDef TypedDict usage example

from types_boto3_textract.type_defs import ListAdapterVersionsResponseTypeDef


def get_value() -> ListAdapterVersionsResponseTypeDef:
    return {
        "AdapterVersions": ...,
    }


# ListAdapterVersionsResponseTypeDef definition

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

1. See List[AdapterVersionOverviewTypeDef]
2. See ResponseMetadataTypeDef

ListAdaptersResponseTypeDef

# ListAdaptersResponseTypeDef TypedDict usage example

from types_boto3_textract.type_defs import ListAdaptersResponseTypeDef


def get_value() -> ListAdaptersResponseTypeDef:
    return {
        "Adapters": ...,
    }


# ListAdaptersResponseTypeDef definition

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

1. See List[AdapterOverviewTypeDef]
2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef

# ListTagsForResourceResponseTypeDef TypedDict usage example

from types_boto3_textract.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Tags": ...,
    }


# ListTagsForResourceResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

StartDocumentAnalysisResponseTypeDef

# StartDocumentAnalysisResponseTypeDef TypedDict usage example

from types_boto3_textract.type_defs import StartDocumentAnalysisResponseTypeDef


def get_value() -> StartDocumentAnalysisResponseTypeDef:
    return {
        "JobId": ...,
    }


# StartDocumentAnalysisResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

StartDocumentTextDetectionResponseTypeDef

# StartDocumentTextDetectionResponseTypeDef TypedDict usage example

from types_boto3_textract.type_defs import StartDocumentTextDetectionResponseTypeDef


def get_value() -> StartDocumentTextDetectionResponseTypeDef:
    return {
        "JobId": ...,
    }


# StartDocumentTextDetectionResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

StartExpenseAnalysisResponseTypeDef

# StartExpenseAnalysisResponseTypeDef TypedDict usage example

from types_boto3_textract.type_defs import StartExpenseAnalysisResponseTypeDef


def get_value() -> StartExpenseAnalysisResponseTypeDef:
    return {
        "JobId": ...,
    }


# StartExpenseAnalysisResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

StartLendingAnalysisResponseTypeDef

# StartLendingAnalysisResponseTypeDef TypedDict usage example

from types_boto3_textract.type_defs import StartLendingAnalysisResponseTypeDef


def get_value() -> StartLendingAnalysisResponseTypeDef:
    return {
        "JobId": ...,
    }


# StartLendingAnalysisResponseTypeDef definition

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

1. See ResponseMetadataTypeDef

UpdateAdapterResponseTypeDef

# UpdateAdapterResponseTypeDef TypedDict usage example

from types_boto3_textract.type_defs import UpdateAdapterResponseTypeDef


def get_value() -> UpdateAdapterResponseTypeDef:
    return {
        "AdapterId": ...,
    }


# UpdateAdapterResponseTypeDef definition

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

1. See List[FeatureTypeType]
2. See AutoUpdateType
3. See ResponseMetadataTypeDef

AnalyzeIDDetectionsTypeDef

# AnalyzeIDDetectionsTypeDef TypedDict usage example

from types_boto3_textract.type_defs import AnalyzeIDDetectionsTypeDef


def get_value() -> AnalyzeIDDetectionsTypeDef:
    return {
        "Text": ...,
    }


# AnalyzeIDDetectionsTypeDef definition

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

1. See NormalizedValueTypeDef

DocumentTypeDef

# DocumentTypeDef TypedDict usage example

from types_boto3_textract.type_defs import DocumentTypeDef


def get_value() -> DocumentTypeDef:
    return {
        "Bytes": ...,
    }


# DocumentTypeDef definition

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

1. See S3ObjectTypeDef

DocumentGroupTypeDef

# DocumentGroupTypeDef TypedDict usage example

from types_boto3_textract.type_defs import DocumentGroupTypeDef


def get_value() -> DocumentGroupTypeDef:
    return {
        "Type": ...,
    }


# 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 List[SplitDocumentTypeDef]
2. See List[DetectedSignatureTypeDef]
3. See List[UndetectedSignatureTypeDef]

GeometryTypeDef

# GeometryTypeDef TypedDict usage example

from types_boto3_textract.type_defs import GeometryTypeDef


def get_value() -> GeometryTypeDef:
    return {
        "BoundingBox": ...,
    }


# GeometryTypeDef definition

class GeometryTypeDef(TypedDict):
    BoundingBox: NotRequired[BoundingBoxTypeDef],  # (1)
    Polygon: NotRequired[List[PointTypeDef]],  # (2)
    RotationAngle: NotRequired[float],

1. See BoundingBoxTypeDef
2. See List[PointTypeDef]

HumanLoopConfigTypeDef

# HumanLoopConfigTypeDef TypedDict usage example

from types_boto3_textract.type_defs import HumanLoopConfigTypeDef


def get_value() -> HumanLoopConfigTypeDef:
    return {
        "HumanLoopName": ...,
    }


# HumanLoopConfigTypeDef definition

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

1. See HumanLoopDataAttributesTypeDef

ListAdapterVersionsRequestPaginateTypeDef

# ListAdapterVersionsRequestPaginateTypeDef TypedDict usage example

from types_boto3_textract.type_defs import ListAdapterVersionsRequestPaginateTypeDef


def get_value() -> ListAdapterVersionsRequestPaginateTypeDef:
    return {
        "AdapterId": ...,
    }


# ListAdapterVersionsRequestPaginateTypeDef definition

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

1. See PaginatorConfigTypeDef

ListAdapterVersionsRequestTypeDef

# ListAdapterVersionsRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import ListAdapterVersionsRequestTypeDef


def get_value() -> ListAdapterVersionsRequestTypeDef:
    return {
        "AdapterId": ...,
    }


# ListAdapterVersionsRequestTypeDef definition

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

ListAdaptersRequestPaginateTypeDef

# ListAdaptersRequestPaginateTypeDef TypedDict usage example

from types_boto3_textract.type_defs import ListAdaptersRequestPaginateTypeDef


def get_value() -> ListAdaptersRequestPaginateTypeDef:
    return {
        "AfterCreationTime": ...,
    }


# ListAdaptersRequestPaginateTypeDef definition

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

1. See PaginatorConfigTypeDef

ListAdaptersRequestTypeDef

# ListAdaptersRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import ListAdaptersRequestTypeDef


def get_value() -> ListAdaptersRequestTypeDef:
    return {
        "AfterCreationTime": ...,
    }


# ListAdaptersRequestTypeDef definition

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

PageClassificationTypeDef

# PageClassificationTypeDef TypedDict usage example

from types_boto3_textract.type_defs import PageClassificationTypeDef


def get_value() -> PageClassificationTypeDef:
    return {
        "PageType": ...,
    }


# PageClassificationTypeDef definition

class PageClassificationTypeDef(TypedDict):
    PageType: List[PredictionTypeDef],  # (1)
    PageNumber: List[PredictionTypeDef],  # (1)

1. See List[PredictionTypeDef]
2. See List[PredictionTypeDef]

CreateAdapterVersionRequestTypeDef

# CreateAdapterVersionRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import CreateAdapterVersionRequestTypeDef


def get_value() -> CreateAdapterVersionRequestTypeDef:
    return {
        "AdapterId": ...,
    }


# CreateAdapterVersionRequestTypeDef definition

class CreateAdapterVersionRequestTypeDef(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

StartDocumentTextDetectionRequestTypeDef

# StartDocumentTextDetectionRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import StartDocumentTextDetectionRequestTypeDef


def get_value() -> StartDocumentTextDetectionRequestTypeDef:
    return {
        "DocumentLocation": ...,
    }


# StartDocumentTextDetectionRequestTypeDef definition

class StartDocumentTextDetectionRequestTypeDef(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

StartExpenseAnalysisRequestTypeDef

# StartExpenseAnalysisRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import StartExpenseAnalysisRequestTypeDef


def get_value() -> StartExpenseAnalysisRequestTypeDef:
    return {
        "DocumentLocation": ...,
    }


# StartExpenseAnalysisRequestTypeDef definition

class StartExpenseAnalysisRequestTypeDef(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

StartLendingAnalysisRequestTypeDef

# StartLendingAnalysisRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import StartLendingAnalysisRequestTypeDef


def get_value() -> StartLendingAnalysisRequestTypeDef:
    return {
        "DocumentLocation": ...,
    }


# StartLendingAnalysisRequestTypeDef definition

class StartLendingAnalysisRequestTypeDef(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 TypedDict usage example

from types_boto3_textract.type_defs import GetAdapterVersionResponseTypeDef


def get_value() -> GetAdapterVersionResponseTypeDef:
    return {
        "AdapterId": ...,
    }


# GetAdapterVersionResponseTypeDef definition

class GetAdapterVersionResponseTypeDef(TypedDict):
    AdapterId: str,
    AdapterVersion: str,
    CreationTime: datetime.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 List[FeatureTypeType]
2. See AdapterVersionStatusType
3. See AdapterVersionDatasetConfigTypeDef
4. See OutputConfigTypeDef
5. See List[AdapterVersionEvaluationMetricTypeDef]
6. See ResponseMetadataTypeDef

IdentityDocumentFieldTypeDef

# IdentityDocumentFieldTypeDef TypedDict usage example

from types_boto3_textract.type_defs import IdentityDocumentFieldTypeDef


def get_value() -> IdentityDocumentFieldTypeDef:
    return {
        "Type": ...,
    }


# IdentityDocumentFieldTypeDef definition

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

1. See AnalyzeIDDetectionsTypeDef
2. See AnalyzeIDDetectionsTypeDef

AnalyzeExpenseRequestTypeDef

# AnalyzeExpenseRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import AnalyzeExpenseRequestTypeDef


def get_value() -> AnalyzeExpenseRequestTypeDef:
    return {
        "Document": ...,
    }


# AnalyzeExpenseRequestTypeDef definition

class AnalyzeExpenseRequestTypeDef(TypedDict):
    Document: DocumentTypeDef,  # (1)

1. See DocumentTypeDef

AnalyzeIDRequestTypeDef

# AnalyzeIDRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import AnalyzeIDRequestTypeDef


def get_value() -> AnalyzeIDRequestTypeDef:
    return {
        "DocumentPages": ...,
    }


# AnalyzeIDRequestTypeDef definition

class AnalyzeIDRequestTypeDef(TypedDict):
    DocumentPages: Sequence[DocumentTypeDef],  # (1)

1. See Sequence[DocumentTypeDef]

DetectDocumentTextRequestTypeDef

# DetectDocumentTextRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import DetectDocumentTextRequestTypeDef


def get_value() -> DetectDocumentTextRequestTypeDef:
    return {
        "Document": ...,
    }


# DetectDocumentTextRequestTypeDef definition

class DetectDocumentTextRequestTypeDef(TypedDict):
    Document: DocumentTypeDef,  # (1)

1. See DocumentTypeDef

LendingSummaryTypeDef

# LendingSummaryTypeDef TypedDict usage example

from types_boto3_textract.type_defs import LendingSummaryTypeDef


def get_value() -> LendingSummaryTypeDef:
    return {
        "DocumentGroups": ...,
    }


# LendingSummaryTypeDef definition

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

1. See List[DocumentGroupTypeDef]

BlockTypeDef

# BlockTypeDef TypedDict usage example

from types_boto3_textract.type_defs import BlockTypeDef


def get_value() -> BlockTypeDef:
    return {
        "BlockType": ...,
    }


# 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 List[RelationshipTypeDef]
5. See List[EntityTypeType]
6. See SelectionStatusType
7. See QueryOutputTypeDef

ExpenseDetectionTypeDef

# ExpenseDetectionTypeDef TypedDict usage example

from types_boto3_textract.type_defs import ExpenseDetectionTypeDef


def get_value() -> ExpenseDetectionTypeDef:
    return {
        "Text": ...,
    }


# ExpenseDetectionTypeDef definition

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

1. See GeometryTypeDef

LendingDetectionTypeDef

# LendingDetectionTypeDef TypedDict usage example

from types_boto3_textract.type_defs import LendingDetectionTypeDef


def get_value() -> LendingDetectionTypeDef:
    return {
        "Text": ...,
    }


# 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 TypedDict usage example

from types_boto3_textract.type_defs import SignatureDetectionTypeDef


def get_value() -> SignatureDetectionTypeDef:
    return {
        "Confidence": ...,
    }


# SignatureDetectionTypeDef definition

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

1. See GeometryTypeDef

QueriesConfigTypeDef

# QueriesConfigTypeDef TypedDict usage example

from types_boto3_textract.type_defs import QueriesConfigTypeDef


def get_value() -> QueriesConfigTypeDef:
    return {
        "Queries": ...,
    }


# QueriesConfigTypeDef definition

class QueriesConfigTypeDef(TypedDict):
    Queries: Sequence[QueryUnionTypeDef],  # (1)

1. See Sequence[QueryUnionTypeDef]

GetLendingAnalysisSummaryResponseTypeDef

# GetLendingAnalysisSummaryResponseTypeDef TypedDict usage example

from types_boto3_textract.type_defs import GetLendingAnalysisSummaryResponseTypeDef


def get_value() -> GetLendingAnalysisSummaryResponseTypeDef:
    return {
        "DocumentMetadata": ...,
    }


# 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 List[WarningTypeDef]
5. See ResponseMetadataTypeDef

AnalyzeDocumentResponseTypeDef

# AnalyzeDocumentResponseTypeDef TypedDict usage example

from types_boto3_textract.type_defs import AnalyzeDocumentResponseTypeDef


def get_value() -> AnalyzeDocumentResponseTypeDef:
    return {
        "DocumentMetadata": ...,
    }


# 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 List[BlockTypeDef]
3. See HumanLoopActivationOutputTypeDef
4. See ResponseMetadataTypeDef

DetectDocumentTextResponseTypeDef

# DetectDocumentTextResponseTypeDef TypedDict usage example

from types_boto3_textract.type_defs import DetectDocumentTextResponseTypeDef


def get_value() -> DetectDocumentTextResponseTypeDef:
    return {
        "DocumentMetadata": ...,
    }


# DetectDocumentTextResponseTypeDef definition

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

1. See DocumentMetadataTypeDef
2. See List[BlockTypeDef]
3. See ResponseMetadataTypeDef

GetDocumentAnalysisResponseTypeDef

# GetDocumentAnalysisResponseTypeDef TypedDict usage example

from types_boto3_textract.type_defs import GetDocumentAnalysisResponseTypeDef


def get_value() -> GetDocumentAnalysisResponseTypeDef:
    return {
        "DocumentMetadata": ...,
    }


# 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 List[BlockTypeDef]
4. See List[WarningTypeDef]
5. See ResponseMetadataTypeDef

GetDocumentTextDetectionResponseTypeDef

# GetDocumentTextDetectionResponseTypeDef TypedDict usage example

from types_boto3_textract.type_defs import GetDocumentTextDetectionResponseTypeDef


def get_value() -> GetDocumentTextDetectionResponseTypeDef:
    return {
        "DocumentMetadata": ...,
    }


# 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 List[BlockTypeDef]
4. See List[WarningTypeDef]
5. See ResponseMetadataTypeDef

IdentityDocumentTypeDef

# IdentityDocumentTypeDef TypedDict usage example

from types_boto3_textract.type_defs import IdentityDocumentTypeDef


def get_value() -> IdentityDocumentTypeDef:
    return {
        "DocumentIndex": ...,
    }


# IdentityDocumentTypeDef definition

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

1. See List[IdentityDocumentFieldTypeDef]
2. See List[BlockTypeDef]

ExpenseFieldTypeDef

# ExpenseFieldTypeDef TypedDict usage example

from types_boto3_textract.type_defs import ExpenseFieldTypeDef


def get_value() -> ExpenseFieldTypeDef:
    return {
        "Type": ...,
    }


# 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 List[ExpenseGroupPropertyTypeDef]

LendingFieldTypeDef

# LendingFieldTypeDef TypedDict usage example

from types_boto3_textract.type_defs import LendingFieldTypeDef


def get_value() -> LendingFieldTypeDef:
    return {
        "Type": ...,
    }


# LendingFieldTypeDef definition

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

1. See LendingDetectionTypeDef
2. See List[LendingDetectionTypeDef]

AnalyzeDocumentRequestTypeDef

# AnalyzeDocumentRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import AnalyzeDocumentRequestTypeDef


def get_value() -> AnalyzeDocumentRequestTypeDef:
    return {
        "Document": ...,
    }


# AnalyzeDocumentRequestTypeDef definition

class AnalyzeDocumentRequestTypeDef(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 Sequence[FeatureTypeType]
3. See HumanLoopConfigTypeDef
4. See QueriesConfigTypeDef
5. See AdaptersConfigTypeDef

StartDocumentAnalysisRequestTypeDef

# StartDocumentAnalysisRequestTypeDef TypedDict usage example

from types_boto3_textract.type_defs import StartDocumentAnalysisRequestTypeDef


def get_value() -> StartDocumentAnalysisRequestTypeDef:
    return {
        "DocumentLocation": ...,
    }


# StartDocumentAnalysisRequestTypeDef definition

class StartDocumentAnalysisRequestTypeDef(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 Sequence[FeatureTypeType]
3. See NotificationChannelTypeDef
4. See OutputConfigTypeDef
5. See QueriesConfigTypeDef
6. See AdaptersConfigTypeDef

AnalyzeIDResponseTypeDef

# AnalyzeIDResponseTypeDef TypedDict usage example

from types_boto3_textract.type_defs import AnalyzeIDResponseTypeDef


def get_value() -> AnalyzeIDResponseTypeDef:
    return {
        "IdentityDocuments": ...,
    }


# AnalyzeIDResponseTypeDef definition

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

1. See List[IdentityDocumentTypeDef]
2. See DocumentMetadataTypeDef
3. See ResponseMetadataTypeDef

LineItemFieldsTypeDef

# LineItemFieldsTypeDef TypedDict usage example

from types_boto3_textract.type_defs import LineItemFieldsTypeDef


def get_value() -> LineItemFieldsTypeDef:
    return {
        "LineItemExpenseFields": ...,
    }


# LineItemFieldsTypeDef definition

class LineItemFieldsTypeDef(TypedDict):
    LineItemExpenseFields: NotRequired[List[ExpenseFieldTypeDef]],  # (1)

1. See List[ExpenseFieldTypeDef]

LendingDocumentTypeDef

# LendingDocumentTypeDef TypedDict usage example

from types_boto3_textract.type_defs import LendingDocumentTypeDef


def get_value() -> LendingDocumentTypeDef:
    return {
        "LendingFields": ...,
    }


# LendingDocumentTypeDef definition

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

1. See List[LendingFieldTypeDef]
2. See List[SignatureDetectionTypeDef]

LineItemGroupTypeDef

# LineItemGroupTypeDef TypedDict usage example

from types_boto3_textract.type_defs import LineItemGroupTypeDef


def get_value() -> LineItemGroupTypeDef:
    return {
        "LineItemGroupIndex": ...,
    }


# LineItemGroupTypeDef definition

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

1. See List[LineItemFieldsTypeDef]

ExpenseDocumentTypeDef

# ExpenseDocumentTypeDef TypedDict usage example

from types_boto3_textract.type_defs import ExpenseDocumentTypeDef


def get_value() -> ExpenseDocumentTypeDef:
    return {
        "ExpenseIndex": ...,
    }


# 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 List[ExpenseFieldTypeDef]
2. See List[LineItemGroupTypeDef]
3. See List[BlockTypeDef]

AnalyzeExpenseResponseTypeDef

# AnalyzeExpenseResponseTypeDef TypedDict usage example

from types_boto3_textract.type_defs import AnalyzeExpenseResponseTypeDef


def get_value() -> AnalyzeExpenseResponseTypeDef:
    return {
        "DocumentMetadata": ...,
    }


# AnalyzeExpenseResponseTypeDef definition

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

1. See DocumentMetadataTypeDef
2. See List[ExpenseDocumentTypeDef]
3. See ResponseMetadataTypeDef

ExtractionTypeDef

# ExtractionTypeDef TypedDict usage example

from types_boto3_textract.type_defs import ExtractionTypeDef


def get_value() -> ExtractionTypeDef:
    return {
        "LendingDocument": ...,
    }


# 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 TypedDict usage example

from types_boto3_textract.type_defs import GetExpenseAnalysisResponseTypeDef


def get_value() -> GetExpenseAnalysisResponseTypeDef:
    return {
        "DocumentMetadata": ...,
    }


# 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 List[ExpenseDocumentTypeDef]
4. See List[WarningTypeDef]
5. See ResponseMetadataTypeDef

LendingResultTypeDef

# LendingResultTypeDef TypedDict usage example

from types_boto3_textract.type_defs import LendingResultTypeDef


def get_value() -> LendingResultTypeDef:
    return {
        "Page": ...,
    }


# LendingResultTypeDef definition

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

1. See PageClassificationTypeDef
2. See List[ExtractionTypeDef]

GetLendingAnalysisResponseTypeDef

# GetLendingAnalysisResponseTypeDef TypedDict usage example

from types_boto3_textract.type_defs import GetLendingAnalysisResponseTypeDef


def get_value() -> GetLendingAnalysisResponseTypeDef:
    return {
        "DocumentMetadata": ...,
    }


# 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 List[LendingResultTypeDef]
4. See List[WarningTypeDef]
5. See ResponseMetadataTypeDef