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 aBlock
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 ofBlock
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 moreDeclaration
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) andtop
(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
andleft
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 aleft
value of 0.5 (350/700) and atop
value of 0.25 (50/200).The
See morewidth
andheight
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.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 theBytes
property to pass a document loaded from a local file system. Image bytes passed by using theBytes
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 moreDeclaration
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 JPEG or PNG format. It can also be a file in PDF format.
See moreDeclaration
Objective-C
@interface AWSTextractDocumentLocation
Swift
class AWSTextractDocumentLocation
-
Information about the input document.
See moreDeclaration
Objective-C
@interface AWSTextractDocumentMetadata
Swift
class AWSTextractDocumentMetadata
-
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 moreDeclaration
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
-
Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the input did not trigger human review.
See moreDeclaration
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 moreDeclaration
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 moreDeclaration
Objective-C
@interface AWSTextractHumanLoopDataAttributes
Swift
class AWSTextractHumanLoopDataAttributes
-
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 moreDeclaration
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.
Required parameters: [S3Bucket]
See moreDeclaration
Objective-C
@interface AWSTextractOutputConfig
Swift
class AWSTextractOutputConfig
-
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
See morePoint
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.Declaration
Objective-C
@interface AWSTextractPoint
Swift
class AWSTextractPoint
-
Information about how blocks are related to each other. A
Block
object contains 0 or moreRelation
objects in a list,Relationships
. For more information, see Block.The
See moreType
element provides the type of the relationship for all blocks in theIDs
array.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 moreDeclaration
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 moreDeclaration
Objective-C
@interface AWSTextractWarning
Swift
class AWSTextractWarning
-
Undocumented
See moreDeclaration
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 moreDeclaration
Objective-C
@interface AWSTextract
Swift
class AWSTextract