Classes

The following classes are available globally.

  • An adapter selected for use when analyzing documents. Contains an adapter ID and a version number. Contains information on pages selected for analysis when analyzing documents asychronously.

    Required parameters: [AdapterId, Version]

    See more

    Declaration

    Objective-C

    @interface AWSTextractAdapter

    Swift

    class AWSTextractAdapter

  • Contains information on the adapter, including the adapter ID, Name, Creation time, and feature types.

    See more

    Declaration

    Objective-C

    @interface AWSTextractAdapterOverview

    Swift

    class AWSTextractAdapterOverview

  • The dataset configuration options for a given version of an adapter. Can include an Amazon S3 bucket if specified.

    See more

    Declaration

    Objective-C

    @interface AWSTextractAdapterVersionDatasetConfig

    Swift

    class AWSTextractAdapterVersionDatasetConfig

  • Contains information on the metrics used to evalute the peformance of a given adapter version. Includes data for baseline model performance and individual adapter version perfromance.

    See more

    Declaration

    Objective-C

    @interface AWSTextractAdapterVersionEvaluationMetric

    Swift

    class AWSTextractAdapterVersionEvaluationMetric

  • Summary info for an adapter version. Contains information on the AdapterId, AdapterVersion, CreationTime, FeatureTypes, and Status.

    See more

    Declaration

    Objective-C

    @interface AWSTextractAdapterVersionOverview

    Swift

    class AWSTextractAdapterVersionOverview

  • Contains information about adapters used when analyzing a document, with each adapter specified using an AdapterId and version

    Required parameters: [Adapters]

    See more

    Declaration

    Objective-C

    @interface AWSTextractAdaptersConfig

    Swift

    class AWSTextractAdaptersConfig
  • See more

    Declaration

    Objective-C

    @interface AWSTextractAnalyzeDocumentRequest

    Swift

    class AWSTextractAnalyzeDocumentRequest
  • See more

    Declaration

    Objective-C

    @interface AWSTextractAnalyzeDocumentResponse

    Swift

    class AWSTextractAnalyzeDocumentResponse
  • See more

    Declaration

    Objective-C

    @interface AWSTextractAnalyzeExpenseRequest

    Swift

    class AWSTextractAnalyzeExpenseRequest
  • See more

    Declaration

    Objective-C

    @interface AWSTextractAnalyzeExpenseResponse

    Swift

    class AWSTextractAnalyzeExpenseResponse

  • Used to contain the information detected by an AnalyzeID operation.

    Required parameters: [Text]

    See more

    Declaration

    Objective-C

    @interface AWSTextractAnalyzeIDDetections

    Swift

    class AWSTextractAnalyzeIDDetections
  • See more

    Declaration

    Objective-C

    @interface AWSTextractAnalyzeIDRequest

    Swift

    class AWSTextractAnalyzeIDRequest
  • See more

    Declaration

    Objective-C

    @interface AWSTextractAnalyzeIDResponse

    Swift

    class AWSTextractAnalyzeIDResponse

  • 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.

    See more

    Declaration

    Objective-C

    @interface AWSTextractBlock

    Swift

    class AWSTextractBlock

  • 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.

    See more

    Declaration

    Objective-C

    @interface AWSTextractBoundingBox

    Swift

    class AWSTextractBoundingBox
  • See more

    Declaration

    Objective-C

    @interface AWSTextractCreateAdapterRequest

    Swift

    class AWSTextractCreateAdapterRequest
  • See more

    Declaration

    Objective-C

    @interface AWSTextractCreateAdapterResponse

    Swift

    class AWSTextractCreateAdapterResponse
  • See more

    Declaration

    Objective-C

    @interface AWSTextractCreateAdapterVersionRequest

    Swift

    class AWSTextractCreateAdapterVersionRequest
  • See more

    Declaration

    Objective-C

    @interface AWSTextractCreateAdapterVersionResponse

    Swift

    class AWSTextractCreateAdapterVersionResponse
  • See more

    Declaration

    Objective-C

    @interface AWSTextractDeleteAdapterRequest

    Swift

    class AWSTextractDeleteAdapterRequest

  • Declaration

    Objective-C

    @interface AWSTextractDeleteAdapterResponse

    Swift

    class AWSTextractDeleteAdapterResponse
  • See more

    Declaration

    Objective-C

    @interface AWSTextractDeleteAdapterVersionRequest

    Swift

    class AWSTextractDeleteAdapterVersionRequest

  • Declaration

    Objective-C

    @interface AWSTextractDeleteAdapterVersionResponse

    Swift

    class AWSTextractDeleteAdapterVersionResponse
  • See more

    Declaration

    Objective-C

    @interface AWSTextractDetectDocumentTextRequest

    Swift

    class AWSTextractDetectDocumentTextRequest
  • See more

    Declaration

    Objective-C

    @interface AWSTextractDetectDocumentTextResponse

    Swift

    class AWSTextractDetectDocumentTextResponse

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

    See more

    Declaration

    Objective-C

    @interface AWSTextractDetectedSignature

    Swift

    class AWSTextractDetectedSignature

  • 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.

    See more

    Declaration

    Objective-C

    @interface AWSTextractDocument

    Swift

    class AWSTextractDocument

  • Summary information about documents grouped by the same document type.

    See more

    Declaration

    Objective-C

    @interface AWSTextractDocumentGroup

    Swift

    class AWSTextractDocumentGroup

  • 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.

    See more

    Declaration

    Objective-C

    @interface AWSTextractDocumentLocation

    Swift

    class AWSTextractDocumentLocation

  • Information about the input document.

    See more

    Declaration

    Objective-C

    @interface AWSTextractDocumentMetadata

    Swift

    class AWSTextractDocumentMetadata

  • The evaluation metrics (F1 score, Precision, and Recall) for an adapter version.

    See more

    Declaration

    Objective-C

    @interface AWSTextractEvaluationMetric

    Swift

    class AWSTextractEvaluationMetric

  • Returns the kind of currency detected.

    See more

    Declaration

    Objective-C

    @interface AWSTextractExpenseCurrency

    Swift

    class AWSTextractExpenseCurrency

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

    See more

    Declaration

    Objective-C

    @interface AWSTextractExpenseDetection

    Swift

    class AWSTextractExpenseDetection

  • The structure holding all the information returned by AnalyzeExpense

    See more

    Declaration

    Objective-C

    @interface AWSTextractExpenseDocument

    Swift

    class AWSTextractExpenseDocument

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

    See more

    Declaration

    Objective-C

    @interface AWSTextractExpenseField

    Swift

    class AWSTextractExpenseField

  • 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.

    See more

    Declaration

    Objective-C

    @interface AWSTextractExpenseGroupProperty

    Swift

    class AWSTextractExpenseGroupProperty

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

    See more

    Declaration

    Objective-C

    @interface AWSTextractExpenseType

    Swift

    class AWSTextractExpenseType

  • Contains information extracted by an analysis operation after using StartLendingAnalysis.

    See more

    Declaration

    Objective-C

    @interface AWSTextractExtraction

    Swift

    class AWSTextractExtraction

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

    See more

    Declaration

    Objective-C

    @interface AWSTextractGeometry

    Swift

    class AWSTextractGeometry
  • See more

    Declaration

    Objective-C

    @interface AWSTextractGetAdapterRequest

    Swift

    class AWSTextractGetAdapterRequest
  • See more

    Declaration

    Objective-C

    @interface AWSTextractGetAdapterResponse

    Swift

    class AWSTextractGetAdapterResponse
  • See more

    Declaration

    Objective-C

    @interface AWSTextractGetAdapterVersionRequest

    Swift

    class AWSTextractGetAdapterVersionRequest
  • See more

    Declaration

    Objective-C

    @interface AWSTextractGetAdapterVersionResponse

    Swift

    class AWSTextractGetAdapterVersionResponse
  • See more

    Declaration

    Objective-C

    @interface AWSTextractGetDocumentAnalysisRequest

    Swift

    class AWSTextractGetDocumentAnalysisRequest
  • See more

    Declaration

    Objective-C

    @interface AWSTextractGetDocumentAnalysisResponse

    Swift

    class AWSTextractGetDocumentAnalysisResponse
  • See more

    Declaration

    Objective-C

    @interface AWSTextractGetDocumentTextDetectionRequest

    Swift

    class AWSTextractGetDocumentTextDetectionRequest
  • See more

    Declaration

    Objective-C

    @interface AWSTextractGetDocumentTextDetectionResponse

    Swift

    class AWSTextractGetDocumentTextDetectionResponse
  • See more

    Declaration

    Objective-C

    @interface AWSTextractGetExpenseAnalysisRequest

    Swift

    class AWSTextractGetExpenseAnalysisRequest
  • See more

    Declaration

    Objective-C

    @interface AWSTextractGetExpenseAnalysisResponse

    Swift

    class AWSTextractGetExpenseAnalysisResponse
  • See more

    Declaration

    Objective-C

    @interface AWSTextractGetLendingAnalysisRequest

    Swift

    class AWSTextractGetLendingAnalysisRequest
  • See more

    Declaration

    Objective-C

    @interface AWSTextractGetLendingAnalysisResponse

    Swift

    class AWSTextractGetLendingAnalysisResponse
  • See more

    Declaration

    Objective-C

    @interface AWSTextractGetLendingAnalysisSummaryRequest

    Swift

    class AWSTextractGetLendingAnalysisSummaryRequest
  • See more

    Declaration

    Objective-C

    @interface AWSTextractGetLendingAnalysisSummaryResponse

    Swift

    class AWSTextractGetLendingAnalysisSummaryResponse

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

    See more

    Declaration

    Objective-C

    @interface AWSTextractHumanLoopActivationOutput

    Swift

    class AWSTextractHumanLoopActivationOutput

  • 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]

    See more

    Declaration

    Objective-C

    @interface AWSTextractHumanLoopConfig

    Swift

    class AWSTextractHumanLoopConfig

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

    See more

    Declaration

    Objective-C

    @interface AWSTextractHumanLoopDataAttributes

    Swift

    class AWSTextractHumanLoopDataAttributes

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

    See more

    Declaration

    Objective-C

    @interface AWSTextractIdentityDocument

    Swift

    class AWSTextractIdentityDocument

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

    See more

    Declaration

    Objective-C

    @interface AWSTextractIdentityDocumentField

    Swift

    class AWSTextractIdentityDocumentField

  • The results extracted for a lending document.

    See more

    Declaration

    Objective-C

    @interface AWSTextractLendingDetection

    Swift

    class AWSTextractLendingDetection

  • Holds the structured data returned by AnalyzeDocument for lending documents.

    See more

    Declaration

    Objective-C

    @interface AWSTextractLendingDocument

    Swift

    class AWSTextractLendingDocument

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

    See more

    Declaration

    Objective-C

    @interface AWSTextractLendingField

    Swift

    class AWSTextractLendingField

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

    See more

    Declaration

    Objective-C

    @interface AWSTextractLendingResult

    Swift

    class AWSTextractLendingResult

  • Contains information regarding DocumentGroups and UndetectedDocumentTypes.

    See more

    Declaration

    Objective-C

    @interface AWSTextractLendingSummary

    Swift

    class AWSTextractLendingSummary

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

    See more

    Declaration

    Objective-C

    @interface AWSTextractLineItemFields

    Swift

    class AWSTextractLineItemFields

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

    See more

    Declaration

    Objective-C

    @interface AWSTextractLineItemGroup

    Swift

    class AWSTextractLineItemGroup
  • See more

    Declaration

    Objective-C

    @interface AWSTextractListAdapterVersionsRequest

    Swift

    class AWSTextractListAdapterVersionsRequest
  • See more

    Declaration

    Objective-C

    @interface AWSTextractListAdapterVersionsResponse

    Swift

    class AWSTextractListAdapterVersionsResponse
  • See more

    Declaration

    Objective-C

    @interface AWSTextractListAdaptersRequest

    Swift

    class AWSTextractListAdaptersRequest
  • See more

    Declaration

    Objective-C

    @interface AWSTextractListAdaptersResponse

    Swift

    class AWSTextractListAdaptersResponse
  • See more

    Declaration

    Objective-C

    @interface AWSTextractListTagsForResourceRequest

    Swift

    class AWSTextractListTagsForResourceRequest
  • See more

    Declaration

    Objective-C

    @interface AWSTextractListTagsForResourceResponse

    Swift

    class AWSTextractListTagsForResourceResponse

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

    See more

    Declaration

    Objective-C

    @interface AWSTextractNormalizedValue

    Swift

    class AWSTextractNormalizedValue

  • 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]

    See more

    Declaration

    Objective-C

    @interface AWSTextractNotificationChannel

    Swift

    class AWSTextractNotificationChannel

  • 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]

    See more

    Declaration

    Objective-C

    @interface AWSTextractOutputConfig

    Swift

    class AWSTextractOutputConfig

  • 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]

    See more

    Declaration

    Objective-C

    @interface AWSTextractPageClassification

    Swift

    class AWSTextractPageClassification

  • 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.

    See more

    Declaration

    Objective-C

    @interface AWSTextractPoint

    Swift

    class AWSTextractPoint

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

    See more

    Declaration

    Objective-C

    @interface AWSTextractPrediction

    Swift

    class AWSTextractPrediction

  • Required parameters: [Queries]

    See more

    Declaration

    Objective-C

    @interface AWSTextractQueriesConfig

    Swift

    class AWSTextractQueriesConfig

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

    Required parameters: [Text]

    See more

    Declaration

    Objective-C

    @interface AWSTextractQuery

    Swift

    class AWSTextractQuery

  • 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.

    See more

    Declaration

    Objective-C

    @interface AWSTextractRelationship

    Swift

    class AWSTextractRelationship

  • 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.

    See more

    Declaration

    Objective-C

    @interface AWSTextractS3Object

    Swift

    class AWSTextractS3Object

  • Information regarding a detected signature on a page.

    See more

    Declaration

    Objective-C

    @interface AWSTextractSignatureDetection

    Swift

    class AWSTextractSignatureDetection

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

    See more

    Declaration

    Objective-C

    @interface AWSTextractSplitDocument

    Swift

    class AWSTextractSplitDocument
  • See more

    Declaration

    Objective-C

    @interface AWSTextractStartDocumentAnalysisRequest

    Swift

    class AWSTextractStartDocumentAnalysisRequest
  • See more

    Declaration

    Objective-C

    @interface AWSTextractStartDocumentAnalysisResponse

    Swift

    class AWSTextractStartDocumentAnalysisResponse
  • See more

    Declaration

    Objective-C

    @interface AWSTextractStartDocumentTextDetectionRequest

    Swift

    class AWSTextractStartDocumentTextDetectionRequest
  • See more

    Declaration

    Objective-C

    @interface AWSTextractStartDocumentTextDetectionResponse

    Swift

    class AWSTextractStartDocumentTextDetectionResponse
  • See more

    Declaration

    Objective-C

    @interface AWSTextractStartExpenseAnalysisRequest

    Swift

    class AWSTextractStartExpenseAnalysisRequest
  • See more

    Declaration

    Objective-C

    @interface AWSTextractStartExpenseAnalysisResponse

    Swift

    class AWSTextractStartExpenseAnalysisResponse
  • See more

    Declaration

    Objective-C

    @interface AWSTextractStartLendingAnalysisRequest

    Swift

    class AWSTextractStartLendingAnalysisRequest
  • See more

    Declaration

    Objective-C

    @interface AWSTextractStartLendingAnalysisResponse

    Swift

    class AWSTextractStartLendingAnalysisResponse
  • See more

    Declaration

    Objective-C

    @interface AWSTextractTagResourceRequest

    Swift

    class AWSTextractTagResourceRequest

  • Declaration

    Objective-C

    @interface AWSTextractTagResourceResponse

    Swift

    class AWSTextractTagResourceResponse

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

    See more

    Declaration

    Objective-C

    @interface AWSTextractUndetectedSignature

    Swift

    class AWSTextractUndetectedSignature
  • See more

    Declaration

    Objective-C

    @interface AWSTextractUntagResourceRequest

    Swift

    class AWSTextractUntagResourceRequest

  • Declaration

    Objective-C

    @interface AWSTextractUntagResourceResponse

    Swift

    class AWSTextractUntagResourceResponse
  • See more

    Declaration

    Objective-C

    @interface AWSTextractUpdateAdapterRequest

    Swift

    class AWSTextractUpdateAdapterRequest
  • See more

    Declaration

    Objective-C

    @interface AWSTextractUpdateAdapterResponse

    Swift

    class AWSTextractUpdateAdapterResponse

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

    See more

    Declaration

    Objective-C

    @interface AWSTextractWarning

    Swift

    class AWSTextractWarning

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface AWSTextractResources : NSObject

+ (instancetype)sharedInstance;

- (NSDictionary *)JSONObject;

@end

    Swift

    class AWSTextractResources : NSObject

  • Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.

    See more

    Declaration

    Objective-C

    @interface AWSTextract

    Swift

    class AWSTextract