Type definitions#
Auto-generated documentation for Textract type annotations stubs module types-aiobotocore-textract.
BlobTypeDef#
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
StreamingBody,
]
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,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
NormalizedValueTypeDef#
# NormalizedValueTypeDef definition
class NormalizedValueTypeDef(TypedDict):
Value: NotRequired[str],
ValueType: NotRequired[ValueTypeType], # (1)
- See ValueTypeType
QueryTypeDef#
# QueryTypeDef definition
class QueryTypeDef(TypedDict):
Text: str,
Alias: NotRequired[str],
Pages: NotRequired[Sequence[str]],
RelationshipTypeDef#
# RelationshipTypeDef definition
class RelationshipTypeDef(TypedDict):
Type: NotRequired[RelationshipTypeType], # (1)
Ids: NotRequired[List[str]],
BoundingBoxTypeDef#
# BoundingBoxTypeDef definition
class BoundingBoxTypeDef(TypedDict):
Width: NotRequired[float],
Height: NotRequired[float],
Left: NotRequired[float],
Top: NotRequired[float],
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],
S3ObjectTypeDef#
# S3ObjectTypeDef definition
class S3ObjectTypeDef(TypedDict):
Bucket: NotRequired[str],
Name: NotRequired[str],
Version: NotRequired[str],
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],
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)
NotificationChannelTypeDef#
# NotificationChannelTypeDef definition
class NotificationChannelTypeDef(TypedDict):
SNSTopicArn: str,
RoleArn: str,
OutputConfigTypeDef#
# OutputConfigTypeDef definition
class OutputConfigTypeDef(TypedDict):
S3Bucket: str,
S3Prefix: NotRequired[str],
PredictionTypeDef#
# PredictionTypeDef definition
class PredictionTypeDef(TypedDict):
Value: NotRequired[str],
Confidence: NotRequired[float],
StartDocumentAnalysisResponseTypeDef#
# StartDocumentAnalysisResponseTypeDef definition
class StartDocumentAnalysisResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartDocumentTextDetectionResponseTypeDef#
# StartDocumentTextDetectionResponseTypeDef definition
class StartDocumentTextDetectionResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartExpenseAnalysisResponseTypeDef#
# StartExpenseAnalysisResponseTypeDef definition
class StartExpenseAnalysisResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartLendingAnalysisResponseTypeDef#
# StartLendingAnalysisResponseTypeDef definition
class StartLendingAnalysisResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
AnalyzeIDDetectionsTypeDef#
# AnalyzeIDDetectionsTypeDef definition
class AnalyzeIDDetectionsTypeDef(TypedDict):
Text: str,
NormalizedValue: NotRequired[NormalizedValueTypeDef], # (1)
Confidence: NotRequired[float],
QueriesConfigTypeDef#
# QueriesConfigTypeDef definition
class QueriesConfigTypeDef(TypedDict):
Queries: Sequence[QueryTypeDef], # (1)
- See QueryTypeDef
DocumentGroupTypeDef#
# 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 definition
class DocumentLocationTypeDef(TypedDict):
S3Object: NotRequired[S3ObjectTypeDef], # (1)
- See S3ObjectTypeDef
DocumentTypeDef#
# DocumentTypeDef definition
class DocumentTypeDef(TypedDict):
Bytes: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
S3Object: NotRequired[S3ObjectTypeDef], # (1)
- See S3ObjectTypeDef
GeometryTypeDef#
# GeometryTypeDef definition
class GeometryTypeDef(TypedDict):
BoundingBox: NotRequired[BoundingBoxTypeDef], # (1)
Polygon: NotRequired[List[PointTypeDef]], # (2)
- See BoundingBoxTypeDef
- See PointTypeDef
HumanLoopConfigTypeDef#
# HumanLoopConfigTypeDef definition
class HumanLoopConfigTypeDef(TypedDict):
HumanLoopName: str,
FlowDefinitionArn: str,
DataAttributes: NotRequired[HumanLoopDataAttributesTypeDef], # (1)
PageClassificationTypeDef#
# PageClassificationTypeDef definition
class PageClassificationTypeDef(TypedDict):
PageType: List[PredictionTypeDef], # (1)
PageNumber: List[PredictionTypeDef], # (1)
- See PredictionTypeDef
- See PredictionTypeDef
IdentityDocumentFieldTypeDef#
# IdentityDocumentFieldTypeDef definition
class IdentityDocumentFieldTypeDef(TypedDict):
Type: NotRequired[AnalyzeIDDetectionsTypeDef], # (1)
ValueDetection: NotRequired[AnalyzeIDDetectionsTypeDef], # (1)
LendingSummaryTypeDef#
# LendingSummaryTypeDef definition
class LendingSummaryTypeDef(TypedDict):
DocumentGroups: NotRequired[List[DocumentGroupTypeDef]], # (1)
UndetectedDocumentTypes: NotRequired[List[str]],
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)
- See DocumentLocationTypeDef
- See FeatureTypeType
- See NotificationChannelTypeDef
- See OutputConfigTypeDef
- See QueriesConfigTypeDef
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],
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],
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],
AnalyzeExpenseRequestRequestTypeDef#
# AnalyzeExpenseRequestRequestTypeDef definition
class AnalyzeExpenseRequestRequestTypeDef(TypedDict):
Document: DocumentTypeDef, # (1)
- See DocumentTypeDef
AnalyzeIDRequestRequestTypeDef#
# AnalyzeIDRequestRequestTypeDef definition
class AnalyzeIDRequestRequestTypeDef(TypedDict):
DocumentPages: Sequence[DocumentTypeDef], # (1)
- See DocumentTypeDef
DetectDocumentTextRequestRequestTypeDef#
# DetectDocumentTextRequestRequestTypeDef definition
class DetectDocumentTextRequestRequestTypeDef(TypedDict):
Document: DocumentTypeDef, # (1)
- See DocumentTypeDef
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[QueryTypeDef], # (7)
- See BlockTypeType
- See TextTypeType
- See GeometryTypeDef
- See RelationshipTypeDef
- See EntityTypeType
- See SelectionStatusType
- See QueryTypeDef
ExpenseDetectionTypeDef#
# ExpenseDetectionTypeDef definition
class ExpenseDetectionTypeDef(TypedDict):
Text: NotRequired[str],
Geometry: NotRequired[GeometryTypeDef], # (1)
Confidence: NotRequired[float],
- See GeometryTypeDef
LendingDetectionTypeDef#
# 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 definition
class SignatureDetectionTypeDef(TypedDict):
Confidence: NotRequired[float],
Geometry: NotRequired[GeometryTypeDef], # (1)
- See GeometryTypeDef
AnalyzeDocumentRequestRequestTypeDef#
# 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 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 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 definition
class DetectDocumentTextResponseTypeDef(TypedDict):
DocumentMetadata: DocumentMetadataTypeDef, # (1)
Blocks: List[BlockTypeDef], # (2)
DetectDocumentTextModelVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetDocumentAnalysisResponseTypeDef#
# 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 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 definition
class IdentityDocumentTypeDef(TypedDict):
DocumentIndex: NotRequired[int],
IdentityDocumentFields: NotRequired[List[IdentityDocumentFieldTypeDef]], # (1)
Blocks: NotRequired[List[BlockTypeDef]], # (2)
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)
- See ExpenseTypeTypeDef
- See ExpenseDetectionTypeDef
- See ExpenseDetectionTypeDef
- See ExpenseCurrencyTypeDef
- See ExpenseGroupPropertyTypeDef
LendingFieldTypeDef#
# LendingFieldTypeDef definition
class LendingFieldTypeDef(TypedDict):
Type: NotRequired[str],
KeyDetection: NotRequired[LendingDetectionTypeDef], # (1)
ValueDetections: NotRequired[List[LendingDetectionTypeDef]], # (2)
AnalyzeIDResponseTypeDef#
# AnalyzeIDResponseTypeDef definition
class AnalyzeIDResponseTypeDef(TypedDict):
IdentityDocuments: List[IdentityDocumentTypeDef], # (1)
DocumentMetadata: DocumentMetadataTypeDef, # (2)
AnalyzeIDModelVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
LineItemFieldsTypeDef#
# LineItemFieldsTypeDef definition
class LineItemFieldsTypeDef(TypedDict):
LineItemExpenseFields: NotRequired[List[ExpenseFieldTypeDef]], # (1)
LendingDocumentTypeDef#
# LendingDocumentTypeDef definition
class LendingDocumentTypeDef(TypedDict):
LendingFields: NotRequired[List[LendingFieldTypeDef]], # (1)
SignatureDetections: NotRequired[List[SignatureDetectionTypeDef]], # (2)
LineItemGroupTypeDef#
# LineItemGroupTypeDef definition
class LineItemGroupTypeDef(TypedDict):
LineItemGroupIndex: NotRequired[int],
LineItems: NotRequired[List[LineItemFieldsTypeDef]], # (1)
ExpenseDocumentTypeDef#
# 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 definition
class AnalyzeExpenseResponseTypeDef(TypedDict):
DocumentMetadata: DocumentMetadataTypeDef, # (1)
ExpenseDocuments: List[ExpenseDocumentTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ExtractionTypeDef#
# ExtractionTypeDef definition
class ExtractionTypeDef(TypedDict):
LendingDocument: NotRequired[LendingDocumentTypeDef], # (1)
ExpenseDocument: NotRequired[ExpenseDocumentTypeDef], # (2)
IdentityDocument: NotRequired[IdentityDocumentTypeDef], # (3)
GetExpenseAnalysisResponseTypeDef#
# 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 definition
class LendingResultTypeDef(TypedDict):
Page: NotRequired[int],
PageClassification: NotRequired[PageClassificationTypeDef], # (1)
Extractions: NotRequired[List[ExtractionTypeDef]], # (2)
GetLendingAnalysisResponseTypeDef#
# 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