Type definitions#
Auto-generated documentation for Textract type annotations stubs module mypy-boto3-textract.
BlobTypeDef#
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
StreamingBody,
]
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
AdapterOverviewTypeDef#
# AdapterOverviewTypeDef definition
class AdapterOverviewTypeDef(TypedDict):
AdapterId: NotRequired[str],
AdapterName: NotRequired[str],
CreationTime: NotRequired[datetime],
FeatureTypes: NotRequired[List[FeatureTypeType]], # (1)
- See FeatureTypeType
AdapterTypeDef#
# AdapterTypeDef definition
class AdapterTypeDef(TypedDict):
AdapterId: str,
Version: str,
Pages: NotRequired[Sequence[str]],
S3ObjectTypeDef#
# S3ObjectTypeDef definition
class S3ObjectTypeDef(TypedDict):
Bucket: NotRequired[str],
Name: NotRequired[str],
Version: NotRequired[str],
EvaluationMetricTypeDef#
# EvaluationMetricTypeDef definition
class EvaluationMetricTypeDef(TypedDict):
F1Score: NotRequired[float],
Precision: NotRequired[float],
Recall: NotRequired[float],
AdapterVersionOverviewTypeDef#
# AdapterVersionOverviewTypeDef definition
class AdapterVersionOverviewTypeDef(TypedDict):
AdapterId: NotRequired[str],
AdapterVersion: NotRequired[str],
CreationTime: NotRequired[datetime],
FeatureTypes: NotRequired[List[FeatureTypeType]], # (1)
Status: NotRequired[AdapterVersionStatusType], # (2)
StatusMessage: NotRequired[str],
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],
CreateAdapterRequestRequestTypeDef#
# CreateAdapterRequestRequestTypeDef definition
class CreateAdapterRequestRequestTypeDef(TypedDict):
AdapterName: str,
FeatureTypes: Sequence[FeatureTypeType], # (1)
ClientRequestToken: NotRequired[str],
Description: NotRequired[str],
AutoUpdate: NotRequired[AutoUpdateType], # (2)
Tags: NotRequired[Mapping[str, str]],
- See FeatureTypeType
- See AutoUpdateType
OutputConfigTypeDef#
# OutputConfigTypeDef definition
class OutputConfigTypeDef(TypedDict):
S3Bucket: str,
S3Prefix: NotRequired[str],
DeleteAdapterRequestRequestTypeDef#
# DeleteAdapterRequestRequestTypeDef definition
class DeleteAdapterRequestRequestTypeDef(TypedDict):
AdapterId: str,
DeleteAdapterVersionRequestRequestTypeDef#
# DeleteAdapterVersionRequestRequestTypeDef definition
class DeleteAdapterVersionRequestRequestTypeDef(TypedDict):
AdapterId: str,
AdapterVersion: str,
DetectedSignatureTypeDef#
# DetectedSignatureTypeDef definition
class DetectedSignatureTypeDef(TypedDict):
Page: NotRequired[int],
SplitDocumentTypeDef#
# SplitDocumentTypeDef definition
class SplitDocumentTypeDef(TypedDict):
Index: NotRequired[int],
Pages: NotRequired[List[int]],
UndetectedSignatureTypeDef#
# UndetectedSignatureTypeDef definition
class UndetectedSignatureTypeDef(TypedDict):
Page: NotRequired[int],
ExpenseCurrencyTypeDef#
# ExpenseCurrencyTypeDef definition
class ExpenseCurrencyTypeDef(TypedDict):
Code: NotRequired[str],
Confidence: NotRequired[float],
ExpenseGroupPropertyTypeDef#
# ExpenseGroupPropertyTypeDef definition
class ExpenseGroupPropertyTypeDef(TypedDict):
Types: NotRequired[List[str]],
Id: NotRequired[str],
ExpenseTypeTypeDef#
# ExpenseTypeTypeDef definition
class ExpenseTypeTypeDef(TypedDict):
Text: NotRequired[str],
Confidence: NotRequired[float],
PointTypeDef#
# PointTypeDef definition
class PointTypeDef(TypedDict):
X: NotRequired[float],
Y: NotRequired[float],
GetAdapterRequestRequestTypeDef#
# GetAdapterRequestRequestTypeDef definition
class GetAdapterRequestRequestTypeDef(TypedDict):
AdapterId: str,
GetAdapterVersionRequestRequestTypeDef#
# GetAdapterVersionRequestRequestTypeDef definition
class GetAdapterVersionRequestRequestTypeDef(TypedDict):
AdapterId: str,
AdapterVersion: str,
GetDocumentAnalysisRequestRequestTypeDef#
# GetDocumentAnalysisRequestRequestTypeDef definition
class GetDocumentAnalysisRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
WarningTypeDef#
# WarningTypeDef definition
class WarningTypeDef(TypedDict):
ErrorCode: NotRequired[str],
Pages: NotRequired[List[int]],
GetDocumentTextDetectionRequestRequestTypeDef#
# GetDocumentTextDetectionRequestRequestTypeDef definition
class GetDocumentTextDetectionRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
GetExpenseAnalysisRequestRequestTypeDef#
# GetExpenseAnalysisRequestRequestTypeDef definition
class GetExpenseAnalysisRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
GetLendingAnalysisRequestRequestTypeDef#
# GetLendingAnalysisRequestRequestTypeDef definition
class GetLendingAnalysisRequestRequestTypeDef(TypedDict):
JobId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
GetLendingAnalysisSummaryRequestRequestTypeDef#
# GetLendingAnalysisSummaryRequestRequestTypeDef definition
class GetLendingAnalysisSummaryRequestRequestTypeDef(TypedDict):
JobId: str,
HumanLoopDataAttributesTypeDef#
# HumanLoopDataAttributesTypeDef definition
class HumanLoopDataAttributesTypeDef(TypedDict):
ContentClassifiers: NotRequired[Sequence[ContentClassifierType]], # (1)
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
NotificationChannelTypeDef#
# NotificationChannelTypeDef definition
class NotificationChannelTypeDef(TypedDict):
SNSTopicArn: str,
RoleArn: str,
PredictionTypeDef#
# PredictionTypeDef definition
class PredictionTypeDef(TypedDict):
Value: NotRequired[str],
Confidence: NotRequired[float],
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
UpdateAdapterRequestRequestTypeDef#
# UpdateAdapterRequestRequestTypeDef definition
class UpdateAdapterRequestRequestTypeDef(TypedDict):
AdapterId: str,
Description: NotRequired[str],
AdapterName: NotRequired[str],
AutoUpdate: NotRequired[AutoUpdateType], # (1)
- See AutoUpdateType
AdaptersConfigTypeDef#
# AdaptersConfigTypeDef definition
class AdaptersConfigTypeDef(TypedDict):
Adapters: Sequence[AdapterTypeDef], # (1)
- See AdapterTypeDef
AdapterVersionDatasetConfigTypeDef#
# AdapterVersionDatasetConfigTypeDef definition
class AdapterVersionDatasetConfigTypeDef(TypedDict):
ManifestS3Object: NotRequired[S3ObjectTypeDef], # (1)
- See S3ObjectTypeDef
DocumentLocationTypeDef#
# DocumentLocationTypeDef definition
class DocumentLocationTypeDef(TypedDict):
S3Object: NotRequired[S3ObjectTypeDef], # (1)
- See S3ObjectTypeDef
AdapterVersionEvaluationMetricTypeDef#
# AdapterVersionEvaluationMetricTypeDef definition
class AdapterVersionEvaluationMetricTypeDef(TypedDict):
Baseline: NotRequired[EvaluationMetricTypeDef], # (1)
AdapterVersion: NotRequired[EvaluationMetricTypeDef], # (1)
FeatureType: NotRequired[FeatureTypeType], # (3)
CreateAdapterResponseTypeDef#
# CreateAdapterResponseTypeDef definition
class CreateAdapterResponseTypeDef(TypedDict):
AdapterId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateAdapterVersionResponseTypeDef#
# CreateAdapterVersionResponseTypeDef definition
class CreateAdapterVersionResponseTypeDef(TypedDict):
AdapterId: str,
AdapterVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetAdapterResponseTypeDef#
# GetAdapterResponseTypeDef definition
class GetAdapterResponseTypeDef(TypedDict):
AdapterId: str,
AdapterName: str,
CreationTime: datetime,
Description: str,
FeatureTypes: List[FeatureTypeType], # (1)
AutoUpdate: AutoUpdateType, # (2)
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See FeatureTypeType
- See AutoUpdateType
- See ResponseMetadataTypeDef
ListAdapterVersionsResponseTypeDef#
# ListAdapterVersionsResponseTypeDef definition
class ListAdapterVersionsResponseTypeDef(TypedDict):
AdapterVersions: List[AdapterVersionOverviewTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAdaptersResponseTypeDef#
# ListAdaptersResponseTypeDef definition
class ListAdaptersResponseTypeDef(TypedDict):
Adapters: List[AdapterOverviewTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
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)
UpdateAdapterResponseTypeDef#
# UpdateAdapterResponseTypeDef definition
class UpdateAdapterResponseTypeDef(TypedDict):
AdapterId: str,
AdapterName: str,
CreationTime: datetime,
Description: str,
FeatureTypes: List[FeatureTypeType], # (1)
AutoUpdate: AutoUpdateType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See FeatureTypeType
- See AutoUpdateType
- See ResponseMetadataTypeDef
AnalyzeIDDetectionsTypeDef#
# AnalyzeIDDetectionsTypeDef definition
class AnalyzeIDDetectionsTypeDef(TypedDict):
Text: str,
NormalizedValue: NotRequired[NormalizedValueTypeDef], # (1)
Confidence: NotRequired[float],
DocumentTypeDef#
# DocumentTypeDef definition
class DocumentTypeDef(TypedDict):
Bytes: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
S3Object: NotRequired[S3ObjectTypeDef], # (1)
- See S3ObjectTypeDef
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)
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)
ListAdapterVersionsRequestListAdapterVersionsPaginateTypeDef#
# ListAdapterVersionsRequestListAdapterVersionsPaginateTypeDef definition
class ListAdapterVersionsRequestListAdapterVersionsPaginateTypeDef(TypedDict):
AdapterId: NotRequired[str],
AfterCreationTime: NotRequired[Union[datetime, str]],
BeforeCreationTime: NotRequired[Union[datetime, str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListAdapterVersionsRequestRequestTypeDef#
# ListAdapterVersionsRequestRequestTypeDef definition
class ListAdapterVersionsRequestRequestTypeDef(TypedDict):
AdapterId: NotRequired[str],
AfterCreationTime: NotRequired[Union[datetime, str]],
BeforeCreationTime: NotRequired[Union[datetime, str]],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListAdaptersRequestListAdaptersPaginateTypeDef#
# ListAdaptersRequestListAdaptersPaginateTypeDef definition
class ListAdaptersRequestListAdaptersPaginateTypeDef(TypedDict):
AfterCreationTime: NotRequired[Union[datetime, str]],
BeforeCreationTime: NotRequired[Union[datetime, str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListAdaptersRequestRequestTypeDef#
# ListAdaptersRequestRequestTypeDef definition
class ListAdaptersRequestRequestTypeDef(TypedDict):
AfterCreationTime: NotRequired[Union[datetime, str]],
BeforeCreationTime: NotRequired[Union[datetime, str]],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
PageClassificationTypeDef#
# PageClassificationTypeDef definition
class PageClassificationTypeDef(TypedDict):
PageType: List[PredictionTypeDef], # (1)
PageNumber: List[PredictionTypeDef], # (1)
- See PredictionTypeDef
- See PredictionTypeDef
CreateAdapterVersionRequestRequestTypeDef#
# CreateAdapterVersionRequestRequestTypeDef definition
class CreateAdapterVersionRequestRequestTypeDef(TypedDict):
AdapterId: str,
DatasetConfig: AdapterVersionDatasetConfigTypeDef, # (1)
OutputConfig: OutputConfigTypeDef, # (2)
ClientRequestToken: NotRequired[str],
KMSKeyId: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],
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],
GetAdapterVersionResponseTypeDef#
# GetAdapterVersionResponseTypeDef definition
class GetAdapterVersionResponseTypeDef(TypedDict):
AdapterId: str,
AdapterVersion: str,
CreationTime: datetime,
FeatureTypes: List[FeatureTypeType], # (1)
Status: AdapterVersionStatusType, # (2)
StatusMessage: str,
DatasetConfig: AdapterVersionDatasetConfigTypeDef, # (3)
KMSKeyId: str,
OutputConfig: OutputConfigTypeDef, # (4)
EvaluationMetrics: List[AdapterVersionEvaluationMetricTypeDef], # (5)
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See FeatureTypeType
- See AdapterVersionStatusType
- See