Typed dictionaries#
Auto-generated documentation for Textract type annotations stubs module mypy-boto3-textract.
DocumentMetadataTypeDef#
# DocumentMetadataTypeDef usage example
from mypy_boto3_textract.type_defs import DocumentMetadataTypeDef
def get_value() -> DocumentMetadataTypeDef:
return {
"Pages": ...,
}
# DocumentMetadataTypeDef definition
class DocumentMetadataTypeDef(TypedDict):
Pages: NotRequired[int],
HumanLoopActivationOutputTypeDef#
# HumanLoopActivationOutputTypeDef usage example
from mypy_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],
NormalizedValueTypeDef#
# NormalizedValueTypeDef usage example
from mypy_boto3_textract.type_defs import NormalizedValueTypeDef
def get_value() -> NormalizedValueTypeDef:
return {
"Value": ...,
}
# NormalizedValueTypeDef definition
class NormalizedValueTypeDef(TypedDict):
Value: NotRequired[str],
ValueType: NotRequired[ValueTypeType], # (1)
- See ValueTypeType
QueryTypeDef#
# QueryTypeDef usage example
from mypy_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]],
RelationshipTypeDef#
# RelationshipTypeDef usage example
from mypy_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]],
BoundingBoxTypeDef#
# BoundingBoxTypeDef usage example
from mypy_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],
DetectedSignatureTypeDef#
# DetectedSignatureTypeDef usage example
from mypy_boto3_textract.type_defs import DetectedSignatureTypeDef
def get_value() -> DetectedSignatureTypeDef:
return {
"Page": ...,
}
# DetectedSignatureTypeDef definition
class DetectedSignatureTypeDef(TypedDict):
Page: NotRequired[int],
SplitDocumentTypeDef#
# SplitDocumentTypeDef usage example
from mypy_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 usage example
from mypy_boto3_textract.type_defs import UndetectedSignatureTypeDef
def get_value() -> UndetectedSignatureTypeDef:
return {
"Page": ...,
}
# UndetectedSignatureTypeDef definition
class UndetectedSignatureTypeDef(TypedDict):
Page: NotRequired[int],
S3ObjectTypeDef#
# S3ObjectTypeDef usage example
from mypy_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],
ExpenseCurrencyTypeDef#
# ExpenseCurrencyTypeDef usage example
from mypy_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 usage example
from mypy_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 usage example
from mypy_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 usage example
from mypy_boto3_textract.type_defs import PointTypeDef
def get_value() -> PointTypeDef:
return {
"X": ...,
}
# PointTypeDef definition
class PointTypeDef(TypedDict):
X: NotRequired[float],
Y: NotRequired[float],
GetDocumentAnalysisRequestRequestTypeDef#
# GetDocumentAnalysisRequestRequestTypeDef usage example
from mypy_boto3_textract.type_defs import GetDocumentAnalysisRequestRequestTypeDef
def get_value() -> GetDocumentAnalysisRequestRequestTypeDef:
return {
"JobId": ...,
}
# GetDocumentAnalysisRequestRequestTypeDef definition
class GetDocumentAnalysisRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
WarningTypeDef#
# WarningTypeDef usage example
from mypy_boto3_textract.type_defs import WarningTypeDef
def get_value() -> WarningTypeDef:
return {
"ErrorCode": ...,
}
# WarningTypeDef definition
class WarningTypeDef(TypedDict):
ErrorCode: NotRequired[str],
Pages: NotRequired[List[int]],
GetDocumentTextDetectionRequestRequestTypeDef#
# GetDocumentTextDetectionRequestRequestTypeDef usage example
from mypy_boto3_textract.type_defs import GetDocumentTextDetectionRequestRequestTypeDef
def get_value() -> GetDocumentTextDetectionRequestRequestTypeDef:
return {
"JobId": ...,
}
# GetDocumentTextDetectionRequestRequestTypeDef definition
class GetDocumentTextDetectionRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
GetExpenseAnalysisRequestRequestTypeDef#
# GetExpenseAnalysisRequestRequestTypeDef usage example
from mypy_boto3_textract.type_defs import GetExpenseAnalysisRequestRequestTypeDef
def get_value() -> GetExpenseAnalysisRequestRequestTypeDef:
return {
"JobId": ...,
}
# GetExpenseAnalysisRequestRequestTypeDef definition
class GetExpenseAnalysisRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
GetLendingAnalysisRequestRequestTypeDef#
# GetLendingAnalysisRequestRequestTypeDef usage example
from mypy_boto3_textract.type_defs import GetLendingAnalysisRequestRequestTypeDef
def get_value() -> GetLendingAnalysisRequestRequestTypeDef:
return {
"JobId": ...,
}
# GetLendingAnalysisRequestRequestTypeDef definition
class GetLendingAnalysisRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
GetLendingAnalysisSummaryRequestRequestTypeDef#
# GetLendingAnalysisSummaryRequestRequestTypeDef usage example
from mypy_boto3_textract.type_defs import GetLendingAnalysisSummaryRequestRequestTypeDef
def get_value() -> GetLendingAnalysisSummaryRequestRequestTypeDef:
return {
"JobId": ...,
}
# GetLendingAnalysisSummaryRequestRequestTypeDef definition
class GetLendingAnalysisSummaryRequestRequestTypeDef(TypedDict):
JobId: str,
HumanLoopDataAttributesTypeDef#
# HumanLoopDataAttributesTypeDef usage example
from mypy_boto3_textract.type_defs import HumanLoopDataAttributesTypeDef
def get_value() -> HumanLoopDataAttributesTypeDef:
return {
"ContentClassifiers": ...,
}
# HumanLoopDataAttributesTypeDef definition
class HumanLoopDataAttributesTypeDef(TypedDict):
ContentClassifiers: NotRequired[Sequence[ContentClassifierType]], # (1)
NotificationChannelTypeDef#
# NotificationChannelTypeDef usage example
from mypy_boto3_textract.type_defs import NotificationChannelTypeDef
def get_value() -> NotificationChannelTypeDef:
return {
"SNSTopicArn": ...,
"RoleArn": ...,
}
# NotificationChannelTypeDef definition
class NotificationChannelTypeDef(TypedDict):
SNSTopicArn: str,
RoleArn: str,
OutputConfigTypeDef#
# OutputConfigTypeDef usage example
from mypy_boto3_textract.type_defs import OutputConfigTypeDef
def get_value() -> OutputConfigTypeDef:
return {
"S3Bucket": ...,
}
# OutputConfigTypeDef definition
class OutputConfigTypeDef(TypedDict):
S3Bucket: str,
S3Prefix: NotRequired[str],
PredictionTypeDef#
# PredictionTypeDef usage example
from mypy_boto3_textract.type_defs import PredictionTypeDef
def get_value() -> PredictionTypeDef:
return {
"Value": ...,
}
# PredictionTypeDef definition
class PredictionTypeDef(TypedDict):
Value: NotRequired[str],
Confidence: NotRequired[float],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_textract.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
StartDocumentAnalysisResponseTypeDef#
# StartDocumentAnalysisResponseTypeDef usage example
from mypy_boto3_textract.type_defs import StartDocumentAnalysisResponseTypeDef
def get_value() -> StartDocumentAnalysisResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
# StartDocumentAnalysisResponseTypeDef definition
class StartDocumentAnalysisResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartDocumentTextDetectionResponseTypeDef#
# StartDocumentTextDetectionResponseTypeDef usage example
from mypy_boto3_textract.type_defs import StartDocumentTextDetectionResponseTypeDef
def get_value() -> StartDocumentTextDetectionResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
# StartDocumentTextDetectionResponseTypeDef definition
class StartDocumentTextDetectionResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartExpenseAnalysisResponseTypeDef#
# StartExpenseAnalysisResponseTypeDef usage example
from mypy_boto3_textract.type_defs import StartExpenseAnalysisResponseTypeDef
def get_value() -> StartExpenseAnalysisResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
# StartExpenseAnalysisResponseTypeDef definition
class StartExpenseAnalysisResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartLendingAnalysisResponseTypeDef#
# StartLendingAnalysisResponseTypeDef usage example
from mypy_boto3_textract.type_defs import StartLendingAnalysisResponseTypeDef
def get_value() -> StartLendingAnalysisResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
# StartLendingAnalysisResponseTypeDef definition
class StartLendingAnalysisResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
AnalyzeIDDetectionsTypeDef#
# AnalyzeIDDetectionsTypeDef usage example
from mypy_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],
QueriesConfigTypeDef#
# QueriesConfigTypeDef usage example
from mypy_boto3_textract.type_defs import QueriesConfigTypeDef
def get_value() -> QueriesConfigTypeDef:
return {
"Queries": ...,
}
# QueriesConfigTypeDef definition
class QueriesConfigTypeDef(TypedDict):
Queries: Sequence[QueryTypeDef], # (1)
- See QueryTypeDef
DocumentGroupTypeDef#
# DocumentGroupTypeDef usage example
from mypy_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)
DocumentLocationTypeDef#
# DocumentLocationTypeDef usage example
from mypy_boto3_textract.type_defs import DocumentLocationTypeDef
def get_value() -> DocumentLocationTypeDef:
return {
"S3Object": ...,
}
# DocumentLocationTypeDef definition
class DocumentLocationTypeDef(TypedDict):
S3Object: NotRequired[S3ObjectTypeDef], # (1)
- See S3ObjectTypeDef
DocumentTypeDef#
# DocumentTypeDef usage example
from mypy_boto3_textract.type_defs import DocumentTypeDef
def get_value() -> DocumentTypeDef:
return {
"Bytes": ...,
}
# DocumentTypeDef definition
class DocumentTypeDef(TypedDict):
Bytes: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
S3Object: NotRequired[S3ObjectTypeDef], # (1)
- See S3ObjectTypeDef
GeometryTypeDef#
# GeometryTypeDef usage example
from mypy_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)
- See BoundingBoxTypeDef
- See PointTypeDef
HumanLoopConfigTypeDef#
# HumanLoopConfigTypeDef usage example
from mypy_boto3_textract.type_defs import HumanLoopConfigTypeDef
def get_value() -> HumanLoopConfigTypeDef:
return {
"HumanLoopName": ...,
"FlowDefinitionArn": ...,
}
# HumanLoopConfigTypeDef definition
class HumanLoopConfigTypeDef(TypedDict):
HumanLoopName: str,
FlowDefinitionArn: str,
DataAttributes: NotRequired[HumanLoopDataAttributesTypeDef], # (1)
PageClassificationTypeDef#
# PageClassificationTypeDef usage example
from mypy_boto3_textract.type_defs import PageClassificationTypeDef
def get_value() -> PageClassificationTypeDef:
return {
"PageType": ...,
"PageNumber": ...,
}
# PageClassificationTypeDef definition
class PageClassificationTypeDef(TypedDict):
PageType: List[PredictionTypeDef], # (1)
PageNumber: List[PredictionTypeDef], # (1)
- See PredictionTypeDef
- See PredictionTypeDef
IdentityDocumentFieldTypeDef#
# IdentityDocumentFieldTypeDef usage example
from mypy_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)
LendingSummaryTypeDef#
# LendingSummaryTypeDef usage example
from mypy_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]],
StartDocumentAnalysisRequestRequestTypeDef#
# StartDocumentAnalysisRequestRequestTypeDef usage example
from mypy_boto3_textract.type_defs import StartDocumentAnalysisRequestRequestTypeDef
def get_value() -> StartDocumentAnalysisRequestRequestTypeDef:
return {
"DocumentLocation": ...,
"FeatureTypes": ...,
}
# 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)
- See DocumentLocationTypeDef
- See FeatureTypeType
- See NotificationChannelTypeDef
- See OutputConfigTypeDef
- See QueriesConfigTypeDef
StartDocumentTextDetectionRequestRequestTypeDef#
# StartDocumentTextDetectionRequestRequestTypeDef usage example
from mypy_boto3_textract.type_defs import StartDocumentTextDetectionRequestRequestTypeDef
def get_value() -> StartDocumentTextDetectionRequestRequestTypeDef:
return {
"DocumentLocation": ...,
}
# 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],
StartExpenseAnalysisRequestRequestTypeDef#
# StartExpenseAnalysisRequestRequestTypeDef usage example
from mypy_boto3_textract.type_defs import StartExpenseAnalysisRequestRequestTypeDef
def get_value() -> StartExpenseAnalysisRequestRequestTypeDef:
return {
"DocumentLocation": ...,
}
# 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],
StartLendingAnalysisRequestRequestTypeDef#
# StartLendingAnalysisRequestRequestTypeDef usage example
from mypy_boto3_textract.type_defs import StartLendingAnalysisRequestRequestTypeDef
def get_value() -> StartLendingAnalysisRequestRequestTypeDef:
return {
"DocumentLocation": ...,
}
# 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],
AnalyzeExpenseRequestRequestTypeDef#
# AnalyzeExpenseRequestRequestTypeDef usage example
from mypy_boto3_textract.type_defs import AnalyzeExpenseRequestRequestTypeDef
def get_value() -> AnalyzeExpenseRequestRequestTypeDef:
return {
"Document": ...,
}
# AnalyzeExpenseRequestRequestTypeDef definition
class AnalyzeExpenseRequestRequestTypeDef(TypedDict):
Document: DocumentTypeDef, # (1)
- See DocumentTypeDef
AnalyzeIDRequestRequestTypeDef#
# AnalyzeIDRequestRequestTypeDef usage example
from mypy_boto3_textract.type_defs import AnalyzeIDRequestRequestTypeDef
def get_value() -> AnalyzeIDRequestRequestTypeDef:
return {
"DocumentPages": ...,
}
# AnalyzeIDRequestRequestTypeDef definition
class AnalyzeIDRequestRequestTypeDef(TypedDict):
DocumentPages: Sequence[DocumentTypeDef], # (1)
- See DocumentTypeDef
DetectDocumentTextRequestRequestTypeDef#
# DetectDocumentTextRequestRequestTypeDef usage example
from mypy_boto3_textract.type_defs import DetectDocumentTextRequestRequestTypeDef
def get_value() -> DetectDocumentTextRequestRequestTypeDef:
return {
"Document": ...,
}
# DetectDocumentTextRequestRequestTypeDef definition
class DetectDocumentTextRequestRequestTypeDef(TypedDict):
Document: DocumentTypeDef, # (1)
- See DocumentTypeDef
BlockTypeDef#
# BlockTypeDef usage example
from mypy_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[QueryTypeDef], # (7)
- See BlockTypeType
- See TextTypeType
- See GeometryTypeDef
- See RelationshipTypeDef
- See EntityTypeType
- See SelectionStatusType
- See QueryTypeDef
ExpenseDetectionTypeDef#
# ExpenseDetectionTypeDef usage example
from mypy_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],
- See GeometryTypeDef
LendingDetectionTypeDef#
# LendingDetectionTypeDef usage example
from mypy_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],
- See SelectionStatusType
- See GeometryTypeDef
SignatureDetectionTypeDef#
# SignatureDetectionTypeDef usage example
from mypy_boto3_textract.type_defs import SignatureDetectionTypeDef
def get_value() -> SignatureDetectionTypeDef:
return {
"Confidence": ...,
}
# SignatureDetectionTypeDef definition
class SignatureDetectionTypeDef(TypedDict):
Confidence: NotRequired[float],
Geometry: NotRequired[GeometryTypeDef], # (1)
- See GeometryTypeDef
AnalyzeDocumentRequestRequestTypeDef#
# AnalyzeDocumentRequestRequestTypeDef usage example
from mypy_boto3_textract.type_defs import AnalyzeDocumentRequestRequestTypeDef
def get_value() -> AnalyzeDocumentRequestRequestTypeDef:
return {
"Document": ...,
"FeatureTypes": ...,
}
# AnalyzeDocumentRequestRequestTypeDef definition
class AnalyzeDocumentRequestRequestTypeDef(TypedDict):
Document: DocumentTypeDef, # (1)
FeatureTypes: Sequence[FeatureTypeType], # (2)
HumanLoopConfig: NotRequired[HumanLoopConfigTypeDef], # (3)
QueriesConfig: NotRequired[QueriesConfigTypeDef], # (4)
- See DocumentTypeDef
- See FeatureTypeType
- See HumanLoopConfigTypeDef
- See QueriesConfigTypeDef
GetLendingAnalysisSummaryResponseTypeDef#
# GetLendingAnalysisSummaryResponseTypeDef usage example
from mypy_boto3_textract.type_defs import GetLendingAnalysisSummaryResponseTypeDef
def get_value() -> GetLendingAnalysisSummaryResponseTypeDef:
return {
"DocumentMetadata": ...,
"JobStatus": ...,
"Summary": ...,
"Warnings": ...,
"StatusMessage": ...,
"AnalyzeLendingModelVersion": ...,
"ResponseMetadata": ...,
}
# 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)
- See DocumentMetadataTypeDef
- See JobStatusType
- See LendingSummaryTypeDef
- See WarningTypeDef
- See ResponseMetadataTypeDef
AnalyzeDocumentResponseTypeDef#
# AnalyzeDocumentResponseTypeDef usage example
from mypy_boto3_textract.type_defs import AnalyzeDocumentResponseTypeDef
def get_value() -> AnalyzeDocumentResponseTypeDef:
return {
"DocumentMetadata": ...,
"Blocks": ...,
"HumanLoopActivationOutput": ...,
"AnalyzeDocumentModelVersion": ...,
"ResponseMetadata": ...,
}
# AnalyzeDocumentResponseTypeDef definition
class AnalyzeDocumentResponseTypeDef(TypedDict):
DocumentMetadata: DocumentMetadataTypeDef, # (1)
Blocks: List[BlockTypeDef], # (2)
HumanLoopActivationOutput: HumanLoopActivationOutputTypeDef, # (3)
AnalyzeDocumentModelVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See DocumentMetadataTypeDef
- See BlockTypeDef
- See HumanLoopActivationOutputTypeDef
- See ResponseMetadataTypeDef
DetectDocumentTextResponseTypeDef#
# DetectDocumentTextResponseTypeDef usage example
from mypy_boto3_textract.type_defs import DetectDocumentTextResponseTypeDef
def get_value() -> DetectDocumentTextResponseTypeDef:
return {
"DocumentMetadata": ...,
"Blocks": ...,
"DetectDocumentTextModelVersion": ...,
"ResponseMetadata": ...,
}
# DetectDocumentTextResponseTypeDef definition
class DetectDocumentTextResponseTypeDef(TypedDict):
DocumentMetadata: DocumentMetadataTypeDef, # (1)
Blocks: List[BlockTypeDef], # (2)
DetectDocumentTextModelVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetDocumentAnalysisResponseTypeDef#
# GetDocumentAnalysisResponseTypeDef usage example
from mypy_boto3_textract.type_defs import GetDocumentAnalysisResponseTypeDef
def get_value() -> GetDocumentAnalysisResponseTypeDef:
return {
"DocumentMetadata": ...,
"JobStatus": ...,
"NextToken": ...,
"Blocks": ...,
"Warnings": ...,
"StatusMessage": ...,
"AnalyzeDocumentModelVersion": ...,
"ResponseMetadata": ...,
}
# GetDocumentAnalysisResponseTypeDef definition
class GetDocumentAnalysisResponseTypeDef(TypedDict):
DocumentMetadata: DocumentMetadataTypeDef, # (1)
JobStatus: JobStatusType, # (2)
NextToken: str,
Blocks: List[BlockTypeDef], # (3)
Warnings: List[WarningTypeDef], # (4)
StatusMessage: str,
AnalyzeDocumentModelVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See DocumentMetadataTypeDef
- See JobStatusType
- See BlockTypeDef
- See WarningTypeDef
- See ResponseMetadataTypeDef
GetDocumentTextDetectionResponseTypeDef#
# GetDocumentTextDetectionResponseTypeDef usage example
from mypy_boto3_textract.type_defs import GetDocumentTextDetectionResponseTypeDef
def get_value() -> GetDocumentTextDetectionResponseTypeDef:
return {
"DocumentMetadata": ...,
"JobStatus": ...,
"NextToken": ...,
"Blocks": ...,
"Warnings": ...,
"StatusMessage": ...,
"DetectDocumentTextModelVersion": ...,
"ResponseMetadata": ...,
}
# GetDocumentTextDetectionResponseTypeDef definition
class GetDocumentTextDetectionResponseTypeDef(TypedDict):
DocumentMetadata: DocumentMetadataTypeDef, # (1)
JobStatus: JobStatusType, # (2)
NextToken: str,
Blocks: List[BlockTypeDef], # (3)
Warnings: List[WarningTypeDef], # (4)
StatusMessage: str,
DetectDocumentTextModelVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See DocumentMetadataTypeDef
- See JobStatusType
- See BlockTypeDef
- See WarningTypeDef
- See ResponseMetadataTypeDef
IdentityDocumentTypeDef#
# IdentityDocumentTypeDef usage example
from mypy_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)
ExpenseFieldTypeDef#
# ExpenseFieldTypeDef usage example
from mypy_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)
- See ExpenseTypeTypeDef
- See ExpenseDetectionTypeDef
- See ExpenseDetectionTypeDef
- See ExpenseCurrencyTypeDef
- See ExpenseGroupPropertyTypeDef
LendingFieldTypeDef#
# LendingFieldTypeDef usage example
from mypy_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)
AnalyzeIDResponseTypeDef#
# AnalyzeIDResponseTypeDef usage example
from mypy_boto3_textract.type_defs import AnalyzeIDResponseTypeDef
def get_value() -> AnalyzeIDResponseTypeDef:
return {
"IdentityDocuments": ...,
"DocumentMetadata": ...,
"AnalyzeIDModelVersion": ...,
"ResponseMetadata": ...,
}
# AnalyzeIDResponseTypeDef definition
class AnalyzeIDResponseTypeDef(TypedDict):
IdentityDocuments: List[IdentityDocumentTypeDef], # (1)
DocumentMetadata: DocumentMetadataTypeDef, # (2)
AnalyzeIDModelVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
LineItemFieldsTypeDef#
# LineItemFieldsTypeDef usage example
from mypy_boto3_textract.type_defs import LineItemFieldsTypeDef
def get_value() -> LineItemFieldsTypeDef:
return {
"LineItemExpenseFields": ...,
}
# LineItemFieldsTypeDef definition
class LineItemFieldsTypeDef(TypedDict):
LineItemExpenseFields: NotRequired[List[ExpenseFieldTypeDef]], # (1)
LendingDocumentTypeDef#
# LendingDocumentTypeDef usage example
from mypy_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)
LineItemGroupTypeDef#
# LineItemGroupTypeDef usage example
from mypy_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)
ExpenseDocumentTypeDef#
# ExpenseDocumentTypeDef usage example
from mypy_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)
- See ExpenseFieldTypeDef
- See LineItemGroupTypeDef
- See BlockTypeDef
AnalyzeExpenseResponseTypeDef#
# AnalyzeExpenseResponseTypeDef usage example
from mypy_boto3_textract.type_defs import AnalyzeExpenseResponseTypeDef
def get_value() -> AnalyzeExpenseResponseTypeDef:
return {
"DocumentMetadata": ...,
"ExpenseDocuments": ...,
"ResponseMetadata": ...,
}
# AnalyzeExpenseResponseTypeDef definition
class AnalyzeExpenseResponseTypeDef(TypedDict):
DocumentMetadata: DocumentMetadataTypeDef, # (1)
ExpenseDocuments: List[ExpenseDocumentTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ExtractionTypeDef#
# ExtractionTypeDef usage example
from mypy_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)
GetExpenseAnalysisResponseTypeDef#
# GetExpenseAnalysisResponseTypeDef usage example
from mypy_boto3_textract.type_defs import GetExpenseAnalysisResponseTypeDef
def get_value() -> GetExpenseAnalysisResponseTypeDef:
return {
"DocumentMetadata": ...,
"JobStatus": ...,
"NextToken": ...,
"ExpenseDocuments": ...,
"Warnings": ...,
"StatusMessage": ...,
"AnalyzeExpenseModelVersion": ...,
"ResponseMetadata": ...,
}
# GetExpenseAnalysisResponseTypeDef definition
class GetExpenseAnalysisResponseTypeDef(TypedDict):
DocumentMetadata: DocumentMetadataTypeDef, # (1)
JobStatus: JobStatusType, # (2)
NextToken: str,
ExpenseDocuments: List[ExpenseDocumentTypeDef], # (3)
Warnings: List[WarningTypeDef], # (4)
StatusMessage: str,
AnalyzeExpenseModelVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See DocumentMetadataTypeDef
- See JobStatusType
- See ExpenseDocumentTypeDef
- See WarningTypeDef
- See ResponseMetadataTypeDef
LendingResultTypeDef#
# LendingResultTypeDef usage example
from mypy_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)
GetLendingAnalysisResponseTypeDef#
# GetLendingAnalysisResponseTypeDef usage example
from mypy_boto3_textract.type_defs import GetLendingAnalysisResponseTypeDef
def get_value() -> GetLendingAnalysisResponseTypeDef:
return {
"DocumentMetadata": ...,
"JobStatus": ...,
"NextToken": ...,
"Results": ...,
"Warnings": ...,
"StatusMessage": ...,
"AnalyzeLendingModelVersion": ...,
"ResponseMetadata": ...,
}
# GetLendingAnalysisResponseTypeDef definition
class GetLendingAnalysisResponseTypeDef(TypedDict):
DocumentMetadata: DocumentMetadataTypeDef, # (1)
JobStatus: JobStatusType, # (2)
NextToken: str,
Results: List[LendingResultTypeDef], # (3)
Warnings: List[WarningTypeDef], # (4)
StatusMessage: str,
AnalyzeLendingModelVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See DocumentMetadataTypeDef
- See JobStatusType
- See LendingResultTypeDef
- See WarningTypeDef
- See ResponseMetadataTypeDef