Typed dictionaries
Auto-generated documentation for Textract type annotations stubs module types-aiobotocore-textract.
DocumentMetadataTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import DocumentMetadataTypeDef
def get_value() -> DocumentMetadataTypeDef:
return {
"Pages": ...,
}
HumanLoopActivationOutputTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import HumanLoopActivationOutputTypeDef
def get_value() -> HumanLoopActivationOutputTypeDef:
return {
"HumanLoopArn": ...,
}
Definition
class HumanLoopActivationOutputTypeDef(TypedDict):
HumanLoopArn: NotRequired[str],
HumanLoopActivationReasons: NotRequired[List[str]],
HumanLoopActivationConditionsEvaluationResults: NotRequired[str],
ResponseMetadataTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
NormalizedValueTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import NormalizedValueTypeDef
def get_value() -> NormalizedValueTypeDef:
return {
"Value": ...,
}
Definition
class NormalizedValueTypeDef(TypedDict):
Value: NotRequired[str],
ValueType: NotRequired[ValueTypeType], # (1)
- See ValueTypeType
QueryTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import QueryTypeDef
def get_value() -> QueryTypeDef:
return {
"Text": ...,
}
Definition
class QueryTypeDef(TypedDict):
Text: str,
Alias: NotRequired[str],
Pages: NotRequired[Sequence[str]],
RelationshipTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import RelationshipTypeDef
def get_value() -> RelationshipTypeDef:
return {
"Type": ...,
}
Definition
class RelationshipTypeDef(TypedDict):
Type: NotRequired[RelationshipTypeType], # (1)
Ids: NotRequired[List[str]],
BoundingBoxTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import BoundingBoxTypeDef
def get_value() -> BoundingBoxTypeDef:
return {
"Width": ...,
}
Definition
class BoundingBoxTypeDef(TypedDict):
Width: NotRequired[float],
Height: NotRequired[float],
Left: NotRequired[float],
Top: NotRequired[float],
S3ObjectTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import S3ObjectTypeDef
def get_value() -> S3ObjectTypeDef:
return {
"Bucket": ...,
}
Definition
class S3ObjectTypeDef(TypedDict):
Bucket: NotRequired[str],
Name: NotRequired[str],
Version: NotRequired[str],
ExpenseTypeTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import ExpenseTypeTypeDef
def get_value() -> ExpenseTypeTypeDef:
return {
"Text": ...,
}
Definition
class ExpenseTypeTypeDef(TypedDict):
Text: NotRequired[str],
Confidence: NotRequired[float],
PointTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import PointTypeDef
def get_value() -> PointTypeDef:
return {
"X": ...,
}
GetDocumentAnalysisRequestRequestTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import GetDocumentAnalysisRequestRequestTypeDef
def get_value() -> GetDocumentAnalysisRequestRequestTypeDef:
return {
"JobId": ...,
}
Definition
class GetDocumentAnalysisRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
WarningTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import WarningTypeDef
def get_value() -> WarningTypeDef:
return {
"ErrorCode": ...,
}
Definition
class WarningTypeDef(TypedDict):
ErrorCode: NotRequired[str],
Pages: NotRequired[List[int]],
GetDocumentTextDetectionRequestRequestTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import GetDocumentTextDetectionRequestRequestTypeDef
def get_value() -> GetDocumentTextDetectionRequestRequestTypeDef:
return {
"JobId": ...,
}
Definition
class GetDocumentTextDetectionRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
GetExpenseAnalysisRequestRequestTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import GetExpenseAnalysisRequestRequestTypeDef
def get_value() -> GetExpenseAnalysisRequestRequestTypeDef:
return {
"JobId": ...,
}
Definition
class GetExpenseAnalysisRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
HumanLoopDataAttributesTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import HumanLoopDataAttributesTypeDef
def get_value() -> HumanLoopDataAttributesTypeDef:
return {
"ContentClassifiers": ...,
}
Definition
class HumanLoopDataAttributesTypeDef(TypedDict):
ContentClassifiers: NotRequired[Sequence[ContentClassifierType]], # (1)
NotificationChannelTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import NotificationChannelTypeDef
def get_value() -> NotificationChannelTypeDef:
return {
"SNSTopicArn": ...,
"RoleArn": ...,
}
OutputConfigTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import OutputConfigTypeDef
def get_value() -> OutputConfigTypeDef:
return {
"S3Bucket": ...,
}
StartDocumentAnalysisResponseTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import StartDocumentAnalysisResponseTypeDef
def get_value() -> StartDocumentAnalysisResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
Definition
class StartDocumentAnalysisResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartDocumentTextDetectionResponseTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import StartDocumentTextDetectionResponseTypeDef
def get_value() -> StartDocumentTextDetectionResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
Definition
class StartDocumentTextDetectionResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartExpenseAnalysisResponseTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import StartExpenseAnalysisResponseTypeDef
def get_value() -> StartExpenseAnalysisResponseTypeDef:
return {
"JobId": ...,
"ResponseMetadata": ...,
}
Definition
class StartExpenseAnalysisResponseTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
AnalyzeIDDetectionsTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import AnalyzeIDDetectionsTypeDef
def get_value() -> AnalyzeIDDetectionsTypeDef:
return {
"Text": ...,
}
Definition
class AnalyzeIDDetectionsTypeDef(TypedDict):
Text: str,
NormalizedValue: NotRequired[NormalizedValueTypeDef], # (1)
Confidence: NotRequired[float],
QueriesConfigTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import QueriesConfigTypeDef
def get_value() -> QueriesConfigTypeDef:
return {
"Queries": ...,
}
- See QueryTypeDef
DocumentLocationTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import DocumentLocationTypeDef
def get_value() -> DocumentLocationTypeDef:
return {
"S3Object": ...,
}
- See S3ObjectTypeDef
DocumentTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import DocumentTypeDef
def get_value() -> DocumentTypeDef:
return {
"Bytes": ...,
}
Definition
class DocumentTypeDef(TypedDict):
Bytes: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
S3Object: NotRequired[S3ObjectTypeDef], # (1)
- See S3ObjectTypeDef
GeometryTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import GeometryTypeDef
def get_value() -> GeometryTypeDef:
return {
"BoundingBox": ...,
}
Definition
class GeometryTypeDef(TypedDict):
BoundingBox: NotRequired[BoundingBoxTypeDef], # (1)
Polygon: NotRequired[List[PointTypeDef]], # (2)
- See BoundingBoxTypeDef
- See PointTypeDef
HumanLoopConfigTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import HumanLoopConfigTypeDef
def get_value() -> HumanLoopConfigTypeDef:
return {
"HumanLoopName": ...,
"FlowDefinitionArn": ...,
}
Definition
class HumanLoopConfigTypeDef(TypedDict):
HumanLoopName: str,
FlowDefinitionArn: str,
DataAttributes: NotRequired[HumanLoopDataAttributesTypeDef], # (1)
IdentityDocumentFieldTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import IdentityDocumentFieldTypeDef
def get_value() -> IdentityDocumentFieldTypeDef:
return {
"Type": ...,
}
Definition
class IdentityDocumentFieldTypeDef(TypedDict):
Type: NotRequired[AnalyzeIDDetectionsTypeDef], # (1)
ValueDetection: NotRequired[AnalyzeIDDetectionsTypeDef], # (1)
StartDocumentAnalysisRequestRequestTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import StartDocumentAnalysisRequestRequestTypeDef
def get_value() -> StartDocumentAnalysisRequestRequestTypeDef:
return {
"DocumentLocation": ...,
"FeatureTypes": ...,
}
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
Usage Example
from types_aiobotocore_textract.type_defs import StartDocumentTextDetectionRequestRequestTypeDef
def get_value() -> StartDocumentTextDetectionRequestRequestTypeDef:
return {
"DocumentLocation": ...,
}
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
Usage Example
from types_aiobotocore_textract.type_defs import StartExpenseAnalysisRequestRequestTypeDef
def get_value() -> StartExpenseAnalysisRequestRequestTypeDef:
return {
"DocumentLocation": ...,
}
Definition
class StartExpenseAnalysisRequestRequestTypeDef(TypedDict):
DocumentLocation: DocumentLocationTypeDef, # (1)
ClientRequestToken: NotRequired[str],
JobTag: NotRequired[str],
NotificationChannel: NotRequired[NotificationChannelTypeDef], # (2)
OutputConfig: NotRequired[OutputConfigTypeDef], # (3)
KMSKeyId: NotRequired[str],
AnalyzeExpenseRequestRequestTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import AnalyzeExpenseRequestRequestTypeDef
def get_value() -> AnalyzeExpenseRequestRequestTypeDef:
return {
"Document": ...,
}
- See DocumentTypeDef
AnalyzeIDRequestRequestTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import AnalyzeIDRequestRequestTypeDef
def get_value() -> AnalyzeIDRequestRequestTypeDef:
return {
"DocumentPages": ...,
}
Definition
class AnalyzeIDRequestRequestTypeDef(TypedDict):
DocumentPages: Sequence[DocumentTypeDef], # (1)
- See DocumentTypeDef
DetectDocumentTextRequestRequestTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import DetectDocumentTextRequestRequestTypeDef
def get_value() -> DetectDocumentTextRequestRequestTypeDef:
return {
"Document": ...,
}
Definition
class DetectDocumentTextRequestRequestTypeDef(TypedDict):
Document: DocumentTypeDef, # (1)
- See DocumentTypeDef
BlockTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import BlockTypeDef
def get_value() -> BlockTypeDef:
return {
"BlockType": ...,
}
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
Usage Example
from types_aiobotocore_textract.type_defs import ExpenseDetectionTypeDef
def get_value() -> ExpenseDetectionTypeDef:
return {
"Text": ...,
}
Definition
class ExpenseDetectionTypeDef(TypedDict):
Text: NotRequired[str],
Geometry: NotRequired[GeometryTypeDef], # (1)
Confidence: NotRequired[float],
- See GeometryTypeDef
AnalyzeDocumentRequestRequestTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import AnalyzeDocumentRequestRequestTypeDef
def get_value() -> AnalyzeDocumentRequestRequestTypeDef:
return {
"Document": ...,
"FeatureTypes": ...,
}
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
IdentityDocumentTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import IdentityDocumentTypeDef
def get_value() -> IdentityDocumentTypeDef:
return {
"DocumentIndex": ...,
}
Definition
class IdentityDocumentTypeDef(TypedDict):
DocumentIndex: NotRequired[int],
IdentityDocumentFields: NotRequired[List[IdentityDocumentFieldTypeDef]], # (1)
AnalyzeDocumentResponseTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import AnalyzeDocumentResponseTypeDef
def get_value() -> AnalyzeDocumentResponseTypeDef:
return {
"DocumentMetadata": ...,
"Blocks": ...,
"HumanLoopActivationOutput": ...,
"AnalyzeDocumentModelVersion": ...,
"ResponseMetadata": ...,
}
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
Usage Example
from types_aiobotocore_textract.type_defs import DetectDocumentTextResponseTypeDef
def get_value() -> DetectDocumentTextResponseTypeDef:
return {
"DocumentMetadata": ...,
"Blocks": ...,
"DetectDocumentTextModelVersion": ...,
"ResponseMetadata": ...,
}
Definition
class DetectDocumentTextResponseTypeDef(TypedDict):
DocumentMetadata: DocumentMetadataTypeDef, # (1)
Blocks: List[BlockTypeDef], # (2)
DetectDocumentTextModelVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetDocumentAnalysisResponseTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import GetDocumentAnalysisResponseTypeDef
def get_value() -> GetDocumentAnalysisResponseTypeDef:
return {
"DocumentMetadata": ...,
"JobStatus": ...,
"NextToken": ...,
"Blocks": ...,
"Warnings": ...,
"StatusMessage": ...,
"AnalyzeDocumentModelVersion": ...,
"ResponseMetadata": ...,
}
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
Usage Example
from types_aiobotocore_textract.type_defs import GetDocumentTextDetectionResponseTypeDef
def get_value() -> GetDocumentTextDetectionResponseTypeDef:
return {
"DocumentMetadata": ...,
"JobStatus": ...,
"NextToken": ...,
"Blocks": ...,
"Warnings": ...,
"StatusMessage": ...,
"DetectDocumentTextModelVersion": ...,
"ResponseMetadata": ...,
}
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
ExpenseFieldTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import ExpenseFieldTypeDef
def get_value() -> ExpenseFieldTypeDef:
return {
"Type": ...,
}
Definition
class ExpenseFieldTypeDef(TypedDict):
Type: NotRequired[ExpenseTypeTypeDef], # (1)
LabelDetection: NotRequired[ExpenseDetectionTypeDef], # (2)
ValueDetection: NotRequired[ExpenseDetectionTypeDef], # (2)
PageNumber: NotRequired[int],
AnalyzeIDResponseTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import AnalyzeIDResponseTypeDef
def get_value() -> AnalyzeIDResponseTypeDef:
return {
"IdentityDocuments": ...,
"DocumentMetadata": ...,
"AnalyzeIDModelVersion": ...,
"ResponseMetadata": ...,
}
Definition
class AnalyzeIDResponseTypeDef(TypedDict):
IdentityDocuments: List[IdentityDocumentTypeDef], # (1)
DocumentMetadata: DocumentMetadataTypeDef, # (2)
AnalyzeIDModelVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
LineItemFieldsTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import LineItemFieldsTypeDef
def get_value() -> LineItemFieldsTypeDef:
return {
"LineItemExpenseFields": ...,
}
Definition
class LineItemFieldsTypeDef(TypedDict):
LineItemExpenseFields: NotRequired[List[ExpenseFieldTypeDef]], # (1)
LineItemGroupTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import LineItemGroupTypeDef
def get_value() -> LineItemGroupTypeDef:
return {
"LineItemGroupIndex": ...,
}
Definition
class LineItemGroupTypeDef(TypedDict):
LineItemGroupIndex: NotRequired[int],
LineItems: NotRequired[List[LineItemFieldsTypeDef]], # (1)
ExpenseDocumentTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import ExpenseDocumentTypeDef
def get_value() -> ExpenseDocumentTypeDef:
return {
"ExpenseIndex": ...,
}
Definition
class ExpenseDocumentTypeDef(TypedDict):
ExpenseIndex: NotRequired[int],
SummaryFields: NotRequired[List[ExpenseFieldTypeDef]], # (1)
LineItemGroups: NotRequired[List[LineItemGroupTypeDef]], # (2)
AnalyzeExpenseResponseTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import AnalyzeExpenseResponseTypeDef
def get_value() -> AnalyzeExpenseResponseTypeDef:
return {
"DocumentMetadata": ...,
"ExpenseDocuments": ...,
"ResponseMetadata": ...,
}
Definition
class AnalyzeExpenseResponseTypeDef(TypedDict):
DocumentMetadata: DocumentMetadataTypeDef, # (1)
ExpenseDocuments: List[ExpenseDocumentTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetExpenseAnalysisResponseTypeDef
Usage Example
from types_aiobotocore_textract.type_defs import GetExpenseAnalysisResponseTypeDef
def get_value() -> GetExpenseAnalysisResponseTypeDef:
return {
"DocumentMetadata": ...,
"JobStatus": ...,
"NextToken": ...,
"ExpenseDocuments": ...,
"Warnings": ...,
"StatusMessage": ...,
"AnalyzeExpenseModelVersion": ...,
"ResponseMetadata": ...,
}
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