Classes

The following classes are available globally.

  • Declaration

    Objective-C

    @interface AWSTextractAnalyzeDocumentRequest

    Swift

    class AWSTextractAnalyzeDocumentRequest
  • Declaration

    Objective-C

    @interface AWSTextractAnalyzeDocumentResponse

    Swift

    class AWSTextractAnalyzeDocumentResponse
  • 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 depends on the type of operation. In document-text detection (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 recognized text, key, value, table or table cell 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
  • Declaration

    Objective-C

    @interface AWSTextractDetectDocumentTextRequest

    Swift

    class AWSTextractDetectDocumentTextRequest
  • Declaration

    Objective-C

    @interface AWSTextractDetectDocumentTextResponse

    Swift

    class AWSTextractDetectDocumentTextResponse
  • 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
  • The Amazon S3 bucket that contains the document to be processed. It’s used by asynchronous operations such as StartDocumentTextDetection.

    The input document can be an image file in JPG 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
  • Information about where a recognized text, key, value, table, or table cell is located on a document page.

    See more

    Declaration

    Objective-C

    @interface AWSTextractGeometry

    Swift

    class AWSTextractGeometry
  • Declaration

    Objective-C

    @interface AWSTextractGetDocumentAnalysisRequest

    Swift

    class AWSTextractGetDocumentAnalysisRequest
  • Declaration

    Objective-C

    @interface AWSTextractGetDocumentAnalysisResponse

    Swift

    class AWSTextractGetDocumentAnalysisResponse
  • Declaration

    Objective-C

    @interface AWSTextractGetDocumentTextDetectionRequest

    Swift

    class AWSTextractGetDocumentTextDetectionRequest
  • Declaration

    Objective-C

    @interface AWSTextractGetDocumentTextDetectionResponse

    Swift

    class AWSTextractGetDocumentTextDetectionResponse
  • The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation, such as StartDocumentTextDetection.

    Required parameters: [SNSTopicArn, RoleArn]

    See more

    Declaration

    Objective-C

    @interface AWSTextractNotificationChannel

    Swift

    class AWSTextractNotificationChannel
  • The X and Y coordinates of a point on a document page. The X and Y values 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
  • 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
  • Declaration

    Objective-C

    @interface AWSTextractStartDocumentAnalysisRequest

    Swift

    class AWSTextractStartDocumentAnalysisRequest
  • Declaration

    Objective-C

    @interface AWSTextractStartDocumentAnalysisResponse

    Swift

    class AWSTextractStartDocumentAnalysisResponse
  • Declaration

    Objective-C

    @interface AWSTextractStartDocumentTextDetectionRequest

    Swift

    class AWSTextractStartDocumentTextDetectionRequest
  • Declaration

    Objective-C

    @interface AWSTextractStartDocumentTextDetectionResponse

    Swift

    class AWSTextractStartDocumentTextDetectionResponse
  • 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