// // Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. // // Licensed under the Apache License, Version 2.0 (the "License"). // You may not use this file except in compliance with the License. // A copy of the License is located at // // http://aws.amazon.com/apache2.0 // // or in the "license" file accompanying this file. This file is distributed // on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either // express or implied. See the License for the specific language governing // permissions and limitations under the License. // #import #import #import NS_ASSUME_NONNULL_BEGIN FOUNDATION_EXPORT NSString *const AWSTextractErrorDomain; typedef NS_ENUM(NSInteger, AWSTextractErrorType) { AWSTextractErrorUnknown, AWSTextractErrorAccessDenied, AWSTextractErrorBadDocument, AWSTextractErrorDocumentTooLarge, AWSTextractErrorHumanLoopQuotaExceeded, AWSTextractErrorIdempotentParameterMismatch, AWSTextractErrorInternalServer, AWSTextractErrorInvalidJobId, AWSTextractErrorInvalidKMSKey, AWSTextractErrorInvalidParameter, AWSTextractErrorInvalidS3Object, AWSTextractErrorLimitExceeded, AWSTextractErrorProvisionedThroughputExceeded, AWSTextractErrorThrottling, AWSTextractErrorUnsupportedDocument, }; typedef NS_ENUM(NSInteger, AWSTextractBlockType) { AWSTextractBlockTypeUnknown, AWSTextractBlockTypeKeyValueSet, AWSTextractBlockTypePage, AWSTextractBlockTypeLine, AWSTextractBlockTypeWord, AWSTextractBlockTypeTable, AWSTextractBlockTypeCell, AWSTextractBlockTypeSelectionElement, AWSTextractBlockTypeMergedCell, AWSTextractBlockTypeTitle, AWSTextractBlockTypeQuery, AWSTextractBlockTypeQueryResult, AWSTextractBlockTypeSignature, AWSTextractBlockTypeTableTitle, AWSTextractBlockTypeTableFooter, }; typedef NS_ENUM(NSInteger, AWSTextractContentClassifier) { AWSTextractContentClassifierUnknown, AWSTextractContentClassifierFreeOfPersonallyIdentifiableInformation, AWSTextractContentClassifierFreeOfAdultContent, }; typedef NS_ENUM(NSInteger, AWSTextractEntityType) { AWSTextractEntityTypeUnknown, AWSTextractEntityTypeKey, AWSTextractEntityTypeValue, AWSTextractEntityTypeColumnHeader, AWSTextractEntityTypeTableTitle, AWSTextractEntityTypeTableFooter, AWSTextractEntityTypeTableSectionTitle, AWSTextractEntityTypeTableSummary, AWSTextractEntityTypeStructuredTable, AWSTextractEntityTypeSemiStructuredTable, }; typedef NS_ENUM(NSInteger, AWSTextractFeatureType) { AWSTextractFeatureTypeUnknown, AWSTextractFeatureTypeTables, AWSTextractFeatureTypeForms, AWSTextractFeatureTypeQueries, AWSTextractFeatureTypeSignatures, }; typedef NS_ENUM(NSInteger, AWSTextractJobStatus) { AWSTextractJobStatusUnknown, AWSTextractJobStatusInProgress, AWSTextractJobStatusSucceeded, AWSTextractJobStatusFailed, AWSTextractJobStatusPartialSuccess, }; typedef NS_ENUM(NSInteger, AWSTextractRelationshipType) { AWSTextractRelationshipTypeUnknown, AWSTextractRelationshipTypeValue, AWSTextractRelationshipTypeChild, AWSTextractRelationshipTypeComplexFeatures, AWSTextractRelationshipTypeMergedCell, AWSTextractRelationshipTypeTitle, AWSTextractRelationshipTypeAnswer, AWSTextractRelationshipTypeTable, AWSTextractRelationshipTypeTableTitle, AWSTextractRelationshipTypeTableFooter, }; typedef NS_ENUM(NSInteger, AWSTextractSelectionStatus) { AWSTextractSelectionStatusUnknown, AWSTextractSelectionStatusSelected, AWSTextractSelectionStatusNotSelected, }; typedef NS_ENUM(NSInteger, AWSTextractTextType) { AWSTextractTextTypeUnknown, AWSTextractTextTypeHandwriting, AWSTextractTextTypePrinted, }; typedef NS_ENUM(NSInteger, AWSTextractValueType) { AWSTextractValueTypeUnknown, AWSTextractValueTypeDate, }; @class AWSTextractAnalyzeDocumentRequest; @class AWSTextractAnalyzeDocumentResponse; @class AWSTextractAnalyzeExpenseRequest; @class AWSTextractAnalyzeExpenseResponse; @class AWSTextractAnalyzeIDDetections; @class AWSTextractAnalyzeIDRequest; @class AWSTextractAnalyzeIDResponse; @class AWSTextractBlock; @class AWSTextractBoundingBox; @class AWSTextractDetectDocumentTextRequest; @class AWSTextractDetectDocumentTextResponse; @class AWSTextractDetectedSignature; @class AWSTextractDocument; @class AWSTextractDocumentGroup; @class AWSTextractDocumentLocation; @class AWSTextractDocumentMetadata; @class AWSTextractExpenseCurrency; @class AWSTextractExpenseDetection; @class AWSTextractExpenseDocument; @class AWSTextractExpenseField; @class AWSTextractExpenseGroupProperty; @class AWSTextractExpenseType; @class AWSTextractExtraction; @class AWSTextractGeometry; @class AWSTextractGetDocumentAnalysisRequest; @class AWSTextractGetDocumentAnalysisResponse; @class AWSTextractGetDocumentTextDetectionRequest; @class AWSTextractGetDocumentTextDetectionResponse; @class AWSTextractGetExpenseAnalysisRequest; @class AWSTextractGetExpenseAnalysisResponse; @class AWSTextractGetLendingAnalysisRequest; @class AWSTextractGetLendingAnalysisResponse; @class AWSTextractGetLendingAnalysisSummaryRequest; @class AWSTextractGetLendingAnalysisSummaryResponse; @class AWSTextractHumanLoopActivationOutput; @class AWSTextractHumanLoopConfig; @class AWSTextractHumanLoopDataAttributes; @class AWSTextractIdentityDocument; @class AWSTextractIdentityDocumentField; @class AWSTextractLendingDetection; @class AWSTextractLendingDocument; @class AWSTextractLendingField; @class AWSTextractLendingResult; @class AWSTextractLendingSummary; @class AWSTextractLineItemFields; @class AWSTextractLineItemGroup; @class AWSTextractNormalizedValue; @class AWSTextractNotificationChannel; @class AWSTextractOutputConfig; @class AWSTextractPageClassification; @class AWSTextractPoint; @class AWSTextractPrediction; @class AWSTextractQueriesConfig; @class AWSTextractQuery; @class AWSTextractRelationship; @class AWSTextractS3Object; @class AWSTextractSignatureDetection; @class AWSTextractSplitDocument; @class AWSTextractStartDocumentAnalysisRequest; @class AWSTextractStartDocumentAnalysisResponse; @class AWSTextractStartDocumentTextDetectionRequest; @class AWSTextractStartDocumentTextDetectionResponse; @class AWSTextractStartExpenseAnalysisRequest; @class AWSTextractStartExpenseAnalysisResponse; @class AWSTextractStartLendingAnalysisRequest; @class AWSTextractStartLendingAnalysisResponse; @class AWSTextractUndetectedSignature; @class AWSTextractWarning; /** */ @interface AWSTextractAnalyzeDocumentRequest : AWSRequest /**

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

*/ @property (nonatomic, strong) AWSTextractDocument * _Nullable document; /**

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. To perform both forms and table analysis, add TABLES and FORMS to FeatureTypes. To detect signatures within form data and table data, add SIGNATURES to either TABLES or FORMS. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

*/ @property (nonatomic, strong) NSArray * _Nullable featureTypes; /**

Sets the configuration for the human in the loop workflow for analyzing documents.

*/ @property (nonatomic, strong) AWSTextractHumanLoopConfig * _Nullable humanLoopConfig; /**

Contains Queries and the alias for those Queries, as determined by the input.

*/ @property (nonatomic, strong) AWSTextractQueriesConfig * _Nullable queriesConfig; @end /** */ @interface AWSTextractAnalyzeDocumentResponse : AWSModel /**

The version of the model used to analyze the document.

*/ @property (nonatomic, strong) NSString * _Nullable analyzeDocumentModelVersion; /**

The items that are detected and analyzed by AnalyzeDocument.

*/ @property (nonatomic, strong) NSArray * _Nullable blocks; /**

Metadata about the analyzed document. An example is the number of pages.

*/ @property (nonatomic, strong) AWSTextractDocumentMetadata * _Nullable documentMetadata; /**

Shows the results of the human in the loop evaluation.

*/ @property (nonatomic, strong) AWSTextractHumanLoopActivationOutput * _Nullable humanLoopActivationOutput; @end /** */ @interface AWSTextractAnalyzeExpenseRequest : AWSRequest /**

The input document, either as bytes or as an S3 object.

You pass image bytes to an Amazon Textract API operation by using the Bytes property. For example, you would use the Bytes property to pass a document loaded from a local file system. Image bytes passed by using the Bytes property must be base64 encoded. Your code might not need to encode document file bytes if you're using an AWS SDK to call Amazon Textract API operations.

You pass images stored in an S3 bucket to an Amazon Textract API operation by using the S3Object property. Documents stored in an S3 bucket don't need to be base64 encoded.

The AWS Region for the S3 bucket that contains the S3 object must match the AWS Region that you use for Amazon Textract operations.

If you use the AWS CLI to call Amazon Textract operations, passing image bytes using the Bytes property isn't supported. You must first upload the document to an Amazon S3 bucket, and then call the operation using the S3Object property.

For Amazon Textract to process an S3 object, the user must have permission to access the S3 object.

*/ @property (nonatomic, strong) AWSTextractDocument * _Nullable document; @end /** */ @interface AWSTextractAnalyzeExpenseResponse : AWSModel /**

Information about the input document.

*/ @property (nonatomic, strong) AWSTextractDocumentMetadata * _Nullable documentMetadata; /**

The expenses detected by Amazon Textract.

*/ @property (nonatomic, strong) NSArray * _Nullable expenseDocuments; @end /**

Used to contain the information detected by an AnalyzeID operation.

Required parameters: [Text] */ @interface AWSTextractAnalyzeIDDetections : AWSModel /**

The confidence score of the detected text.

*/ @property (nonatomic, strong) NSNumber * _Nullable confidence; /**

Only returned for dates, returns the type of value detected and the date written in a more machine readable way.

*/ @property (nonatomic, strong) AWSTextractNormalizedValue * _Nullable normalizedValue; /**

Text of either the normalized field or value associated with it.

*/ @property (nonatomic, strong) NSString * _Nullable text; @end /** */ @interface AWSTextractAnalyzeIDRequest : AWSRequest /**

The document being passed to AnalyzeID.

*/ @property (nonatomic, strong) NSArray * _Nullable documentPages; @end /** */ @interface AWSTextractAnalyzeIDResponse : AWSModel /**

The version of the AnalyzeIdentity API being used to process documents.

*/ @property (nonatomic, strong) NSString * _Nullable analyzeIDModelVersion; /**

Information about the input document.

*/ @property (nonatomic, strong) AWSTextractDocumentMetadata * _Nullable documentMetadata; /**

The list of documents processed by AnalyzeID. Includes a number denoting their place in the list and the response structure for the document.

*/ @property (nonatomic, strong) NSArray * _Nullable identityDocuments; @end /**

A Block represents items that are recognized in a document within a group of pixels close to each other. The information returned in a Block object depends on the type of operation. In text detection for documents (for example DetectDocumentText), you get information about the detected words and lines of text. In text analysis (for example AnalyzeDocument), you can also get information about the fields, tables, and selection elements that are detected in the document.

An array of Block objects is returned by both synchronous and asynchronous operations. In synchronous operations, such as DetectDocumentText, the array of Block objects is the entire set of results. In asynchronous operations, such as GetDocumentAnalysis, the array is returned over one or more responses.

For more information, see How Amazon Textract Works.

*/ @interface AWSTextractBlock : AWSModel /**

The type of text item that's recognized. In operations for text detection, the following types are returned:

  • PAGE - Contains a list of the LINE Block objects that are detected on a document page.

  • WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.

  • LINE - A string of tab-delimited, contiguous words that are detected on a document page.

In text analysis operations, the following types are returned:

  • PAGE - Contains a list of child Block objects that are detected on a document page.

  • KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.

  • WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.

  • LINE - A string of tab-delimited, contiguous words that are detected on a document page.

  • TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.

  • TABLE_TITLE - The title of a table. A title is typically a line of text above or below a table, or embedded as the first row of a table.

  • TABLE_FOOTER - The footer associated with a table. A footer is typically a line or lines of text below a table or embedded as the last row of a table.

  • CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.

  • MERGED_CELL - A cell in a table whose content spans more than one row or column. The Relationships array for this cell contain data from individual cells.

  • SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.

  • SIGNATURE - The location and confidene score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.

  • QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.

  • QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.

*/ @property (nonatomic, assign) AWSTextractBlockType blockType; /**

The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

*/ @property (nonatomic, strong) NSNumber * _Nullable columnIndex; /**

The number of columns that a table cell spans. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

*/ @property (nonatomic, strong) NSNumber * _Nullable columnSpan; /**

The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.

*/ @property (nonatomic, strong) NSNumber * _Nullable confidence; /**

The type of entity.

The following entity types can be returned by FORMS analysis:

  • KEY - An identifier for a field on the document.

  • VALUE - The field text.

The following entity types can be returned by TABLES analysis:

  • COLUMN_HEADER - Identifies a cell that is a header of a column.

  • TABLE_TITLE - Identifies a cell that is a title within the table.

  • TABLE_SECTION_TITLE - Identifies a cell that is a title of a section within a table. A section title is a cell that typically spans an entire row above a section.

  • TABLE_FOOTER - Identifies a cell that is a footer of a table.

  • TABLE_SUMMARY - Identifies a summary cell of a table. A summary cell can be a row of a table or an additional, smaller table that contains summary information for another table.

  • STRUCTURED_TABLE - Identifies a table with column headers where the content of each row corresponds to the headers.

  • SEMI_STRUCTURED_TABLE - Identifies a non-structured table.

EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.

*/ @property (nonatomic, strong) NSArray * _Nullable entityTypes; /**

The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.

*/ @property (nonatomic, strong) AWSTextractGeometry * _Nullable geometry; /**

The identifier for the recognized text. The identifier is only unique for a single operation.

*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**

The page on which a block was detected. Page is returned by synchronous and asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF or TIFF format. A scanned image (JPEG/PNG) provided to an asynchronous operation, even if it contains multiple document pages, is considered a single-page document. This means that for scanned images the value of Page is always 1. Synchronous operations will also return a Page value of 1 because every input document is considered to be a single-page document.

*/ @property (nonatomic, strong) NSNumber * _Nullable page; /**

*/ @property (nonatomic, strong) AWSTextractQuery * _Nullable query; /**

A list of relationship objects that describe how blocks are related to each other. For example, a LINE block object contains a CHILD relationship type with the WORD blocks that make up the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks.

*/ @property (nonatomic, strong) NSArray * _Nullable relationships; /**

The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

*/ @property (nonatomic, strong) NSNumber * _Nullable rowIndex; /**

The number of rows that a table cell spans. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

*/ @property (nonatomic, strong) NSNumber * _Nullable rowSpan; /**

The selection status of a selection element, such as an option button or check box.

*/ @property (nonatomic, assign) AWSTextractSelectionStatus selectionStatus; /**

The word or line of text that's recognized by Amazon Textract.

*/ @property (nonatomic, strong) NSString * _Nullable text; /**

The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.

*/ @property (nonatomic, assign) AWSTextractTextType textType; @end /**

The bounding box around the detected page, text, key-value pair, table, table cell, or selection element on a document page. The left (x-coordinate) and top (y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).

The top and left values returned are ratios of the overall document page size. For example, if the input image is 700 x 200 pixels, and the top-left coordinate of the bounding box is 350 x 50 pixels, the API returns a left value of 0.5 (350/700) and a top value of 0.25 (50/200).

The width and height values represent the dimensions of the bounding box as a ratio of the overall document page dimension. For example, if the document page size is 700 x 200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.

*/ @interface AWSTextractBoundingBox : AWSModel /**

The height of the bounding box as a ratio of the overall document page height.

*/ @property (nonatomic, strong) NSNumber * _Nullable height; /**

The left coordinate of the bounding box as a ratio of overall document page width.

*/ @property (nonatomic, strong) NSNumber * _Nullable left; /**

The top coordinate of the bounding box as a ratio of overall document page height.

*/ @property (nonatomic, strong) NSNumber * _Nullable top; /**

The width of the bounding box as a ratio of the overall document page width.

*/ @property (nonatomic, strong) NSNumber * _Nullable width; @end /** */ @interface AWSTextractDetectDocumentTextRequest : AWSRequest /**

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

*/ @property (nonatomic, strong) AWSTextractDocument * _Nullable document; @end /** */ @interface AWSTextractDetectDocumentTextResponse : AWSModel /**

An array of Block objects that contain the text that's detected in the document.

*/ @property (nonatomic, strong) NSArray * _Nullable blocks; /**

*/ @property (nonatomic, strong) NSString * _Nullable detectDocumentTextModelVersion; /**

Metadata about the document. It contains the number of pages that are detected in the document.

*/ @property (nonatomic, strong) AWSTextractDocumentMetadata * _Nullable documentMetadata; @end /**

A structure that holds information regarding a detected signature on a page.

*/ @interface AWSTextractDetectedSignature : AWSModel /**

The page a detected signature was found on.

*/ @property (nonatomic, strong) NSNumber * _Nullable page; @end /**

The input document, either as bytes or as an S3 object.

You pass image bytes to an Amazon Textract API operation by using the Bytes property. For example, you would use the Bytes property to pass a document loaded from a local file system. Image bytes passed by using the Bytes property must be base64 encoded. Your code might not need to encode document file bytes if you're using an AWS SDK to call Amazon Textract API operations.

You pass images stored in an S3 bucket to an Amazon Textract API operation by using the S3Object property. Documents stored in an S3 bucket don't need to be base64 encoded.

The AWS Region for the S3 bucket that contains the S3 object must match the AWS Region that you use for Amazon Textract operations.

If you use the AWS CLI to call Amazon Textract operations, passing image bytes using the Bytes property isn't supported. You must first upload the document to an Amazon S3 bucket, and then call the operation using the S3Object property.

For Amazon Textract to process an S3 object, the user must have permission to access the S3 object.

*/ @interface AWSTextractDocument : AWSModel /**

A blob of base64-encoded document bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.

*/ @property (nonatomic, strong) NSData * _Nullable bytes; /**

Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.

*/ @property (nonatomic, strong) AWSTextractS3Object * _Nullable s3Object; @end /**

Summary information about documents grouped by the same document type.

*/ @interface AWSTextractDocumentGroup : AWSModel /**

A list of the detected signatures found in a document group.

*/ @property (nonatomic, strong) NSArray * _Nullable detectedSignatures; /**

An array that contains information about the pages of a document, defined by logical boundary.

*/ @property (nonatomic, strong) NSArray * _Nullable splitDocuments; /**

The type of document that Amazon Textract has detected. See Analyze Lending Response Objects for a list of all types returned by Textract.

*/ @property (nonatomic, strong) NSString * _Nullable types; /**

A list of any expected signatures not found in a document group.

*/ @property (nonatomic, strong) NSArray * _Nullable undetectedSignatures; @end /**

The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations.

The input document can be an image file in JPEG or PNG format. It can also be a file in PDF format.

*/ @interface AWSTextractDocumentLocation : AWSModel /**

The Amazon S3 bucket that contains the input document.

*/ @property (nonatomic, strong) AWSTextractS3Object * _Nullable s3Object; @end /**

Information about the input document.

*/ @interface AWSTextractDocumentMetadata : AWSModel /**

The number of pages that are detected in the document.

*/ @property (nonatomic, strong) NSNumber * _Nullable pages; @end /**

Returns the kind of currency detected.

*/ @interface AWSTextractExpenseCurrency : AWSModel /**

Currency code for detected currency. the current supported codes are:

  • USD

  • EUR

  • GBP

  • CAD

  • INR

  • JPY

  • CHF

  • AUD

  • CNY

  • BZR

  • SEK

  • HKD

*/ @property (nonatomic, strong) NSString * _Nullable code; /**

Percentage confideence in the detected currency.

*/ @property (nonatomic, strong) NSNumber * _Nullable confidence; @end /**

An object used to store information about the Value or Label detected by Amazon Textract.

*/ @interface AWSTextractExpenseDetection : AWSModel /**

The confidence in detection, as a percentage

*/ @property (nonatomic, strong) NSNumber * _Nullable confidence; /**

Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

*/ @property (nonatomic, strong) AWSTextractGeometry * _Nullable geometry; /**

The word or line of text recognized by Amazon Textract

*/ @property (nonatomic, strong) NSString * _Nullable text; @end /**

The structure holding all the information returned by AnalyzeExpense

*/ @interface AWSTextractExpenseDocument : AWSModel /**

This is a block object, the same as reported when DetectDocumentText is run on a document. It provides word level recognition of text.

*/ @property (nonatomic, strong) NSArray * _Nullable blocks; /**

Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on.

*/ @property (nonatomic, strong) NSNumber * _Nullable expenseIndex; /**

Information detected on each table of a document, seperated into LineItems.

*/ @property (nonatomic, strong) NSArray * _Nullable lineItemGroups; /**

Any information found outside of a table by Amazon Textract.

*/ @property (nonatomic, strong) NSArray * _Nullable summaryFields; @end /**

Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection

*/ @interface AWSTextractExpenseField : AWSModel /**

Shows the kind of currency, both the code and confidence associated with any monatary value detected.

*/ @property (nonatomic, strong) AWSTextractExpenseCurrency * _Nullable currency; /**

Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.

*/ @property (nonatomic, strong) NSArray * _Nullable groupProperties; /**

The explicitly stated label of a detected element.

*/ @property (nonatomic, strong) AWSTextractExpenseDetection * _Nullable labelDetection; /**

The page number the value was detected on.

*/ @property (nonatomic, strong) NSNumber * _Nullable pageNumber; /**

The implied label of a detected element. Present alongside LabelDetection for explicit elements.

*/ @property (nonatomic, strong) AWSTextractExpenseType * _Nullable types; /**

The value of a detected element. Present in explicit and implicit elements.

*/ @property (nonatomic, strong) AWSTextractExpenseDetection * _Nullable valueDetection; @end /**

Shows the group that a certain key belongs to. This helps differentiate between names and addresses for different organizations, that can be hard to determine via JSON response.

*/ @interface AWSTextractExpenseGroupProperty : AWSModel /**

Provides a group Id number, which will be the same for each in the group.

*/ @property (nonatomic, strong) NSString * _Nullable identifier; /**

Informs you on whether the expense group is a name or an address.

*/ @property (nonatomic, strong) NSArray * _Nullable types; @end /**

An object used to store information about the Type detected by Amazon Textract.

*/ @interface AWSTextractExpenseType : AWSModel /**

The confidence of accuracy, as a percentage.

*/ @property (nonatomic, strong) NSNumber * _Nullable confidence; /**

The word or line of text detected by Amazon Textract.

*/ @property (nonatomic, strong) NSString * _Nullable text; @end /**

Contains information extracted by an analysis operation after using StartLendingAnalysis.

*/ @interface AWSTextractExtraction : AWSModel /**

The structure holding all the information returned by AnalyzeExpense

*/ @property (nonatomic, strong) AWSTextractExpenseDocument * _Nullable expenseDocument; /**

The structure that lists each document processed in an AnalyzeID operation.

*/ @property (nonatomic, strong) AWSTextractIdentityDocument * _Nullable identityDocument; /**

Holds the structured data returned by AnalyzeDocument for lending documents.

*/ @property (nonatomic, strong) AWSTextractLendingDocument * _Nullable lendingDocument; @end /**

Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

*/ @interface AWSTextractGeometry : AWSModel /**

An axis-aligned coarse representation of the location of the recognized item on the document page.

*/ @property (nonatomic, strong) AWSTextractBoundingBox * _Nullable boundingBox; /**

Within the bounding box, a fine-grained polygon around the recognized item.

*/ @property (nonatomic, strong) NSArray * _Nullable polygon; @end /** */ @interface AWSTextractGetDocumentAnalysisRequest : AWSRequest /**

A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

*/ @property (nonatomic, strong) NSString * _Nullable jobId; /**

The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSTextractGetDocumentAnalysisResponse : AWSModel /**

*/ @property (nonatomic, strong) NSString * _Nullable analyzeDocumentModelVersion; /**

The results of the text-analysis operation.

*/ @property (nonatomic, strong) NSArray * _Nullable blocks; /**

Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

*/ @property (nonatomic, strong) AWSTextractDocumentMetadata * _Nullable documentMetadata; /**

The current status of the text detection job.

*/ @property (nonatomic, assign) AWSTextractJobStatus jobStatus; /**

If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

Returns if the detection job could not be completed. Contains explanation for what error occured.

*/ @property (nonatomic, strong) NSString * _Nullable statusMessage; /**

A list of warnings that occurred during the document-analysis operation.

*/ @property (nonatomic, strong) NSArray * _Nullable warnings; @end /** */ @interface AWSTextractGetDocumentTextDetectionRequest : AWSRequest /**

A unique identifier for the text detection job. The JobId is returned from StartDocumentTextDetection. A JobId value is only valid for 7 days.

*/ @property (nonatomic, strong) NSString * _Nullable jobId; /**

The maximum number of results to return per paginated call. The largest value you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSTextractGetDocumentTextDetectionResponse : AWSModel /**

The results of the text-detection operation.

*/ @property (nonatomic, strong) NSArray * _Nullable blocks; /**

*/ @property (nonatomic, strong) NSString * _Nullable detectDocumentTextModelVersion; /**

Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

*/ @property (nonatomic, strong) AWSTextractDocumentMetadata * _Nullable documentMetadata; /**

The current status of the text detection job.

*/ @property (nonatomic, assign) AWSTextractJobStatus jobStatus; /**

If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text-detection results.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

Returns if the detection job could not be completed. Contains explanation for what error occured.

*/ @property (nonatomic, strong) NSString * _Nullable statusMessage; /**

A list of warnings that occurred during the text-detection operation for the document.

*/ @property (nonatomic, strong) NSArray * _Nullable warnings; @end /** */ @interface AWSTextractGetExpenseAnalysisRequest : AWSRequest /**

A unique identifier for the text detection job. The JobId is returned from StartExpenseAnalysis. A JobId value is only valid for 7 days.

*/ @property (nonatomic, strong) NSString * _Nullable jobId; /**

The maximum number of results to return per paginated call. The largest value you can specify is 20. If you specify a value greater than 20, a maximum of 20 results is returned. The default value is 20.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSTextractGetExpenseAnalysisResponse : AWSModel /**

The current model version of AnalyzeExpense.

*/ @property (nonatomic, strong) NSString * _Nullable analyzeExpenseModelVersion; /**

Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract operation.

*/ @property (nonatomic, strong) AWSTextractDocumentMetadata * _Nullable documentMetadata; /**

The expenses detected by Amazon Textract.

*/ @property (nonatomic, strong) NSArray * _Nullable expenseDocuments; /**

The current status of the text detection job.

*/ @property (nonatomic, assign) AWSTextractJobStatus jobStatus; /**

If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text-detection results.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

Returns if the detection job could not be completed. Contains explanation for what error occured.

*/ @property (nonatomic, strong) NSString * _Nullable statusMessage; /**

A list of warnings that occurred during the text-detection operation for the document.

*/ @property (nonatomic, strong) NSArray * _Nullable warnings; @end /** */ @interface AWSTextractGetLendingAnalysisRequest : AWSRequest /**

A unique identifier for the lending or text-detection job. The JobId is returned from StartLendingAnalysis. A JobId value is only valid for 7 days.

*/ @property (nonatomic, strong) NSString * _Nullable jobId; /**

The maximum number of results to return per paginated call. The largest value that you can specify is 30. If you specify a value greater than 30, a maximum of 30 results is returned. The default value is 30.

*/ @property (nonatomic, strong) NSNumber * _Nullable maxResults; /**

If the previous response was incomplete, Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of lending results.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; @end /** */ @interface AWSTextractGetLendingAnalysisResponse : AWSModel /**

The current model version of the Analyze Lending API.

*/ @property (nonatomic, strong) NSString * _Nullable analyzeLendingModelVersion; /**

Information about the input document.

*/ @property (nonatomic, strong) AWSTextractDocumentMetadata * _Nullable documentMetadata; /**

The current status of the lending analysis job.

*/ @property (nonatomic, assign) AWSTextractJobStatus jobStatus; /**

If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of lending results.

*/ @property (nonatomic, strong) NSString * _Nullable nextToken; /**

Holds the information returned by one of AmazonTextract's document analysis operations for the pinstripe.

*/ @property (nonatomic, strong) NSArray * _Nullable results; /**

Returns if the lending analysis job could not be completed. Contains explanation for what error occurred.

*/ @property (nonatomic, strong) NSString * _Nullable statusMessage; /**

A list of warnings that occurred during the lending analysis operation.

*/ @property (nonatomic, strong) NSArray * _Nullable warnings; @end /** */ @interface AWSTextractGetLendingAnalysisSummaryRequest : AWSRequest /**

A unique identifier for the lending or text-detection job. The JobId is returned from StartLendingAnalysis. A JobId value is only valid for 7 days.

*/ @property (nonatomic, strong) NSString * _Nullable jobId; @end /** */ @interface AWSTextractGetLendingAnalysisSummaryResponse : AWSModel /**

The current model version of the Analyze Lending API.

*/ @property (nonatomic, strong) NSString * _Nullable analyzeLendingModelVersion; /**

Information about the input document.

*/ @property (nonatomic, strong) AWSTextractDocumentMetadata * _Nullable documentMetadata; /**

The current status of the lending analysis job.

*/ @property (nonatomic, assign) AWSTextractJobStatus jobStatus; /**

Returns if the lending analysis could not be completed. Contains explanation for what error occurred.

*/ @property (nonatomic, strong) NSString * _Nullable statusMessage; /**

Contains summary information for documents grouped by type.

*/ @property (nonatomic, strong) AWSTextractLendingSummary * _Nullable summary; /**

A list of warnings that occurred during the lending analysis operation.

*/ @property (nonatomic, strong) NSArray * _Nullable warnings; @end /**

Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the input did not trigger human review.

*/ @interface AWSTextractHumanLoopActivationOutput : AWSModel /**

Shows the result of condition evaluations, including those conditions which activated a human review.

*/ @property (nonatomic, strong) NSString * _Nullable humanLoopActivationConditionsEvaluationResults; /**

Shows if and why human review was needed.

*/ @property (nonatomic, strong) NSArray * _Nullable humanLoopActivationReasons; /**

The Amazon Resource Name (ARN) of the HumanLoop created.

*/ @property (nonatomic, strong) NSString * _Nullable humanLoopArn; @end /**

Sets up the human review workflow the document will be sent to if one of the conditions is met. You can also set certain attributes of the image before review.

Required parameters: [HumanLoopName, FlowDefinitionArn] */ @interface AWSTextractHumanLoopConfig : AWSModel /**

Sets attributes of the input data.

*/ @property (nonatomic, strong) AWSTextractHumanLoopDataAttributes * _Nullable dataAttributes; /**

The Amazon Resource Name (ARN) of the flow definition.

*/ @property (nonatomic, strong) NSString * _Nullable flowDefinitionArn; /**

The name of the human workflow used for this image. This should be kept unique within a region.

*/ @property (nonatomic, strong) NSString * _Nullable humanLoopName; @end /**

Allows you to set attributes of the image. Currently, you can declare an image as free of personally identifiable information and adult content.

*/ @interface AWSTextractHumanLoopDataAttributes : AWSModel /**

Sets whether the input image is free of personally identifiable information or adult content.

*/ @property (nonatomic, strong) NSArray * _Nullable contentClassifiers; @end /**

The structure that lists each document processed in an AnalyzeID operation.

*/ @interface AWSTextractIdentityDocument : AWSModel /**

Individual word recognition, as returned by document detection.

*/ @property (nonatomic, strong) NSArray * _Nullable blocks; /**

Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.

*/ @property (nonatomic, strong) NSNumber * _Nullable documentIndex; /**

The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.

*/ @property (nonatomic, strong) NSArray * _Nullable identityDocumentFields; @end /**

Structure containing both the normalized type of the extracted information and the text associated with it. These are extracted as Type and Value respectively.

*/ @interface AWSTextractIdentityDocumentField : AWSModel /**

Used to contain the information detected by an AnalyzeID operation.

*/ @property (nonatomic, strong) AWSTextractAnalyzeIDDetections * _Nullable types; /**

Used to contain the information detected by an AnalyzeID operation.

*/ @property (nonatomic, strong) AWSTextractAnalyzeIDDetections * _Nullable valueDetection; @end /**

The results extracted for a lending document.

*/ @interface AWSTextractLendingDetection : AWSModel /**

The confidence level for the text of a detected value in a lending document.

*/ @property (nonatomic, strong) NSNumber * _Nullable confidence; /**

Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

*/ @property (nonatomic, strong) AWSTextractGeometry * _Nullable geometry; /**

The selection status of a selection element, such as an option button or check box.

*/ @property (nonatomic, assign) AWSTextractSelectionStatus selectionStatus; /**

The text extracted for a detected value in a lending document.

*/ @property (nonatomic, strong) NSString * _Nullable text; @end /**

Holds the structured data returned by AnalyzeDocument for lending documents.

*/ @interface AWSTextractLendingDocument : AWSModel /**

An array of LendingField objects.

*/ @property (nonatomic, strong) NSArray * _Nullable lendingFields; /**

A list of signatures detected in a lending document.

*/ @property (nonatomic, strong) NSArray * _Nullable signatureDetections; @end /**

Holds the normalized key-value pairs returned by AnalyzeDocument, including the document type, detected text, and geometry.

*/ @interface AWSTextractLendingField : AWSModel /**

The results extracted for a lending document.

*/ @property (nonatomic, strong) AWSTextractLendingDetection * _Nullable keyDetection; /**

The type of the lending document.

*/ @property (nonatomic, strong) NSString * _Nullable types; /**

An array of LendingDetection objects.

*/ @property (nonatomic, strong) NSArray * _Nullable valueDetections; @end /**

Contains the detections for each page analyzed through the Analyze Lending API.

*/ @interface AWSTextractLendingResult : AWSModel /**

An array of Extraction to hold structured data. e.g. normalized key value pairs instead of raw OCR detections .

*/ @property (nonatomic, strong) NSArray * _Nullable extractions; /**

The page number for a page, with regard to whole submission.

*/ @property (nonatomic, strong) NSNumber * _Nullable page; /**

The classifier result for a given page.

*/ @property (nonatomic, strong) AWSTextractPageClassification * _Nullable pageClassification; @end /**

Contains information regarding DocumentGroups and UndetectedDocumentTypes.

*/ @interface AWSTextractLendingSummary : AWSModel /**

Contains an array of all DocumentGroup objects.

*/ @property (nonatomic, strong) NSArray * _Nullable documentGroups; /**

UndetectedDocumentTypes.

*/ @property (nonatomic, strong) NSArray * _Nullable undetectedDocumentTypes; @end /**

A structure that holds information about the different lines found in a document's tables.

*/ @interface AWSTextractLineItemFields : AWSModel /**

ExpenseFields used to show information from detected lines on a table.

*/ @property (nonatomic, strong) NSArray * _Nullable lineItemExpenseFields; @end /**

A grouping of tables which contain LineItems, with each table identified by the table's LineItemGroupIndex.

*/ @interface AWSTextractLineItemGroup : AWSModel /**

The number used to identify a specific table in a document. The first table encountered will have a LineItemGroupIndex of 1, the second 2, etc.

*/ @property (nonatomic, strong) NSNumber * _Nullable lineItemGroupIndex; /**

The breakdown of information on a particular line of a table.

*/ @property (nonatomic, strong) NSArray * _Nullable lineItems; @end /**

Contains information relating to dates in a document, including the type of value, and the value.

*/ @interface AWSTextractNormalizedValue : AWSModel /**

The value of the date, written as Year-Month-DayTHour:Minute:Second.

*/ @property (nonatomic, strong) NSString * _Nullable value; /**

The normalized type of the value detected. In this case, DATE.

*/ @property (nonatomic, assign) AWSTextractValueType valueType; @end /**

The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation.

Required parameters: [SNSTopicArn, RoleArn] */ @interface AWSTextractNotificationChannel : AWSModel /**

The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.

*/ @property (nonatomic, strong) NSString * _Nullable roleArn; /**

The Amazon SNS topic that Amazon Textract posts the completion status to.

*/ @property (nonatomic, strong) NSString * _Nullable SNSTopicArn; @end /**

Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.

OutputConfig is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With OutputConfig enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the KMSKeyID parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.

Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see Managing AI services opt-out policy.

For more information on data privacy, see the Data Privacy FAQ.

Required parameters: [S3Bucket] */ @interface AWSTextractOutputConfig : AWSModel /**

The name of the bucket your output will go to.

*/ @property (nonatomic, strong) NSString * _Nullable s3Bucket; /**

The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".

*/ @property (nonatomic, strong) NSString * _Nullable s3Prefix; @end /**

The class assigned to a Page object detected in an input document. Contains information regarding the predicted type/class of a document's page and the page number that the Page object was detected on.

Required parameters: [PageType, PageNumber] */ @interface AWSTextractPageClassification : AWSModel /**

The page number the value was detected on, relative to Amazon Textract's starting position.

*/ @property (nonatomic, strong) NSArray * _Nullable pageNumber; /**

The class, or document type, assigned to a detected Page object. The class, or document type, assigned to a detected Page object.

*/ @property (nonatomic, strong) NSArray * _Nullable pageType; @end /**

The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.

An array of Point objects, Polygon, is returned by DetectDocumentText. Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.

*/ @interface AWSTextractPoint : AWSModel /**

The value of the X coordinate for a point on a Polygon.

*/ @property (nonatomic, strong) NSNumber * _Nullable X; /**

The value of the Y coordinate for a point on a Polygon.

*/ @property (nonatomic, strong) NSNumber * _Nullable Y; @end /**

Contains information regarding predicted values returned by Amazon Textract operations, including the predicted value and the confidence in the predicted value.

*/ @interface AWSTextractPrediction : AWSModel /**

Amazon Textract's confidence in its predicted value.

*/ @property (nonatomic, strong) NSNumber * _Nullable confidence; /**

The predicted value of a detected object.

*/ @property (nonatomic, strong) NSString * _Nullable value; @end /**

Required parameters: [Queries] */ @interface AWSTextractQueriesConfig : AWSModel /**

*/ @property (nonatomic, strong) NSArray * _Nullable queries; @end /**

Each query contains the question you want to ask in the Text and the alias you want to associate.

Required parameters: [Text] */ @interface AWSTextractQuery : AWSModel /**

Alias attached to the query, for ease of location.

*/ @property (nonatomic, strong) NSString * _Nullable alias; /**

Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.

  • If a page is not specified, it is set to ["1"] by default.

  • The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.

  • When using * to indicate all pages, it must be the only element in the list.

  • You can use page intervals, such as [“1-3”, “1-1”, “4-*”]. Where * indicates last page of document.

  • Specified pages must be greater than 0 and less than or equal to the number of pages in the document.

*/ @property (nonatomic, strong) NSArray * _Nullable pages; /**

Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"

*/ @property (nonatomic, strong) NSString * _Nullable text; @end /**

Information about how blocks are related to each other. A Block object contains 0 or more Relation objects in a list, Relationships. For more information, see Block.

The Type element provides the type of the relationship for all blocks in the IDs array.

*/ @interface AWSTextractRelationship : AWSModel /**

An array of IDs for related blocks. You can get the type of the relationship from the Type element.

*/ @property (nonatomic, strong) NSArray * _Nullable ids; /**

The type of relationship between the blocks in the IDs array and the current block. The following list describes the relationship types that can be returned.

  • VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair.

  • CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type.

  • MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table.

  • ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block.

  • TABLE - A list of IDs that identify associated TABLE block types.

  • TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.

  • TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.

*/ @property (nonatomic, assign) AWSTextractRelationshipType types; @end /**

The S3 bucket name and file name that identifies the document.

The AWS Region for the S3 bucket that contains the document must match the Region that you use for Amazon Textract operations.

For Amazon Textract to process a file in an S3 bucket, the user must have permission to access the S3 bucket and file.

*/ @interface AWSTextractS3Object : AWSModel /**

The name of the S3 bucket. Note that the # character is not valid in the file name.

*/ @property (nonatomic, strong) NSString * _Nullable bucket; /**

The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

If the bucket has versioning enabled, you can specify the object version.

*/ @property (nonatomic, strong) NSString * _Nullable version; @end /**

Information regarding a detected signature on a page.

*/ @interface AWSTextractSignatureDetection : AWSModel /**

The confidence, from 0 to 100, in the predicted values for a detected signature.

*/ @property (nonatomic, strong) NSNumber * _Nullable confidence; /**

Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

*/ @property (nonatomic, strong) AWSTextractGeometry * _Nullable geometry; @end /**

Contains information about the pages of a document, defined by logical boundary.

*/ @interface AWSTextractSplitDocument : AWSModel /**

The index for a given document in a DocumentGroup of a specific Type.

*/ @property (nonatomic, strong) NSNumber * _Nullable index; /**

An array of page numbers for a for a given document, ordered by logical boundary.

*/ @property (nonatomic, strong) NSArray * _Nullable pages; @end /** */ @interface AWSTextractStartDocumentAnalysisRequest : AWSRequest /**

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

*/ @property (nonatomic, strong) NSString * _Nullable clientRequestToken; /**

The location of the document to be processed.

*/ @property (nonatomic, strong) AWSTextractDocumentLocation * _Nullable documentLocation; /**

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

*/ @property (nonatomic, strong) NSArray * _Nullable featureTypes; /**

An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

*/ @property (nonatomic, strong) NSString * _Nullable jobTag; /**

The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.

*/ @property (nonatomic, strong) NSString * _Nullable KMSKeyId; /**

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

*/ @property (nonatomic, strong) AWSTextractNotificationChannel * _Nullable notificationChannel; /**

Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetDocumentAnalysis operation.

*/ @property (nonatomic, strong) AWSTextractOutputConfig * _Nullable outputConfig; /**

*/ @property (nonatomic, strong) AWSTextractQueriesConfig * _Nullable queriesConfig; @end /** */ @interface AWSTextractStartDocumentAnalysisResponse : AWSModel /**

The identifier for the document text detection job. Use JobId to identify the job in a subsequent call to GetDocumentAnalysis. A JobId value is only valid for 7 days.

*/ @property (nonatomic, strong) NSString * _Nullable jobId; @end /** */ @interface AWSTextractStartDocumentTextDetectionRequest : AWSRequest /**

The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

*/ @property (nonatomic, strong) NSString * _Nullable clientRequestToken; /**

The location of the document to be processed.

*/ @property (nonatomic, strong) AWSTextractDocumentLocation * _Nullable documentLocation; /**

An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

*/ @property (nonatomic, strong) NSString * _Nullable jobTag; /**

The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.

*/ @property (nonatomic, strong) NSString * _Nullable KMSKeyId; /**

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

*/ @property (nonatomic, strong) AWSTextractNotificationChannel * _Nullable notificationChannel; /**

Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation.

*/ @property (nonatomic, strong) AWSTextractOutputConfig * _Nullable outputConfig; @end /** */ @interface AWSTextractStartDocumentTextDetectionResponse : AWSModel /**

The identifier of the text detection job for the document. Use JobId to identify the job in a subsequent call to GetDocumentTextDetection. A JobId value is only valid for 7 days.

*/ @property (nonatomic, strong) NSString * _Nullable jobId; @end /** */ @interface AWSTextractStartExpenseAnalysisRequest : AWSRequest /**

The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations

*/ @property (nonatomic, strong) NSString * _Nullable clientRequestToken; /**

The location of the document to be processed.

*/ @property (nonatomic, strong) AWSTextractDocumentLocation * _Nullable documentLocation; /**

An identifier you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

*/ @property (nonatomic, strong) NSString * _Nullable jobTag; /**

The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.

*/ @property (nonatomic, strong) NSString * _Nullable KMSKeyId; /**

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

*/ @property (nonatomic, strong) AWSTextractNotificationChannel * _Nullable notificationChannel; /**

Sets if the output will go to a customer defined bucket. By default, Amazon Textract will save the results internally to be accessed by the GetExpenseAnalysis operation.

*/ @property (nonatomic, strong) AWSTextractOutputConfig * _Nullable outputConfig; @end /** */ @interface AWSTextractStartExpenseAnalysisResponse : AWSModel /**

A unique identifier for the text detection job. The JobId is returned from StartExpenseAnalysis. A JobId value is only valid for 7 days.

*/ @property (nonatomic, strong) NSString * _Nullable jobId; @end /** */ @interface AWSTextractStartLendingAnalysisRequest : AWSRequest /**

The idempotent token that you use to identify the start request. If you use the same token with multiple StartLendingAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

*/ @property (nonatomic, strong) NSString * _Nullable clientRequestToken; /**

The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations.

The input document can be an image file in JPEG or PNG format. It can also be a file in PDF format.

*/ @property (nonatomic, strong) AWSTextractDocumentLocation * _Nullable documentLocation; /**

An identifier that you specify to be included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

*/ @property (nonatomic, strong) NSString * _Nullable jobTag; /**

The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side, using SSE-S3.

*/ @property (nonatomic, strong) NSString * _Nullable KMSKeyId; /**

The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation.

*/ @property (nonatomic, strong) AWSTextractNotificationChannel * _Nullable notificationChannel; /**

Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.

OutputConfig is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With OutputConfig enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the KMSKeyID parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.

Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see Managing AI services opt-out policy.

For more information on data privacy, see the Data Privacy FAQ.

*/ @property (nonatomic, strong) AWSTextractOutputConfig * _Nullable outputConfig; @end /** */ @interface AWSTextractStartLendingAnalysisResponse : AWSModel /**

A unique identifier for the lending or text-detection job. The JobId is returned from StartLendingAnalysis. A JobId value is only valid for 7 days.

*/ @property (nonatomic, strong) NSString * _Nullable jobId; @end /**

A structure containing information about an undetected signature on a page where it was expected but not found.

*/ @interface AWSTextractUndetectedSignature : AWSModel /**

The page where a signature was expected but not found.

*/ @property (nonatomic, strong) NSNumber * _Nullable page; @end /**

A warning about an issue that occurred during asynchronous text analysis (StartDocumentAnalysis) or asynchronous document text detection (StartDocumentTextDetection).

*/ @interface AWSTextractWarning : AWSModel /**

The error code for the warning.

*/ @property (nonatomic, strong) NSString * _Nullable errorCode; /**

A list of the pages that the warning applies to.

*/ @property (nonatomic, strong) NSArray * _Nullable pages; @end NS_ASSUME_NONNULL_END