diff --git a/aws-android-sdk-textract/src/main/java/com/amazonaws/services/textract/AmazonTextract.java b/aws-android-sdk-textract/src/main/java/com/amazonaws/services/textract/AmazonTextract.java index e57b54fd6cb..2d2f190e79c 100644 --- a/aws-android-sdk-textract/src/main/java/com/amazonaws/services/textract/AmazonTextract.java +++ b/aws-android-sdk-textract/src/main/java/com/amazonaws/services/textract/AmazonTextract.java @@ -97,40 +97,41 @@ public interface AmazonTextract { *
- * Words and lines that are related to nearby lines and words. The related
- * information is returned in two Block objects each of type
- * KEY_VALUE_SET
: a KEY Block object and a VALUE Block object.
- * For example, Name: Ana Silva Carolina contains a key and value.
+ * Form data (key-value pairs). The related information is returned in two
+ * Block objects, each of type KEY_VALUE_SET
: a KEY
+ * Block
object and a VALUE Block
object. For
+ * example, Name: Ana Silva Carolina contains a key and value.
* Name: is the key. Ana Silva Carolina is the value.
*
- * Table and table cell data. A TABLE Block object contains information
- * about a detected table. A CELL Block object is returned for each cell in
- * a table.
+ * Table and table cell data. A TABLE Block
object contains
+ * information about a detected table. A CELL Block
object is
+ * returned for each cell in a table.
*
- * Selectable elements such as checkboxes and radio buttons. A
- * SELECTION_ELEMENT Block object contains information about a selectable
- * element.
+ * Lines and words of text. A LINE Block
object contains one or
+ * more WORD Block
objects. All lines and words that are
+ * detected in the document are returned (including text that doesn't have a
+ * relationship with the value of FeatureTypes
).
*
- * Lines and words of text. A LINE Block object contains one or more WORD
- * Block objects.
+ * Selection elements such as check boxes and option buttons (radio buttons)
+ * can be detected in form data and in tables. A SELECTION_ELEMENT
+ * Block
object contains information about a selection element,
+ * including the selection status.
*
* You can choose which type of analysis to perform by specifying the
* FeatureTypes
list.
*
- * The output is returned in a list of BLOCK
objects.
+ * The output is returned in a list of Block
objects.
*
* AnalyzeDocument
is a synchronous operation. To analyze
@@ -154,6 +155,7 @@ public interface AmazonTextract {
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws ThrottlingException
+ * @throws HumanLoopQuotaExceededException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
@@ -169,8 +171,8 @@ AnalyzeDocumentResult analyzeDocument(AnalyzeDocumentRequest analyzeDocumentRequ
*
* Detects text in the input document. Amazon Textract can detect lines of
* text and the words that make up a line of text. The input document must
- * be an image in JPG or PNG format. DetectDocumentText
returns
- * the detected text in an array of Block objects.
+ * be an image in JPEG or PNG format. DetectDocumentText
+ * returns the detected text in an array of Block objects.
*
* Each document page has as an associated Block
of type PAGE.
@@ -238,37 +240,39 @@ DetectDocumentTextResult detectDocumentText(DetectDocumentTextRequest detectDocu
*
- * Words and lines that are related to nearby lines and words. The related
- * information is returned in two Block objects each of type
- * KEY_VALUE_SET
: a KEY Block object and a VALUE Block object.
- * For example, Name: Ana Silva Carolina contains a key and value.
+ * Form data (key-value pairs). The related information is returned in two
+ * Block objects, each of type KEY_VALUE_SET
: a KEY
+ * Block
object and a VALUE Block
object. For
+ * example, Name: Ana Silva Carolina contains a key and value.
* Name: is the key. Ana Silva Carolina is the value.
*
- * Table and table cell data. A TABLE Block object contains information
- * about a detected table. A CELL Block object is returned for each cell in
- * a table.
+ * Table and table cell data. A TABLE Block
object contains
+ * information about a detected table. A CELL Block
object is
+ * returned for each cell in a table.
*
- * Selectable elements such as checkboxes and radio buttons. A
- * SELECTION_ELEMENT Block object contains information about a selectable
- * element.
+ * Lines and words of text. A LINE Block
object contains one or
+ * more WORD Block
objects. All lines and words that are
+ * detected in the document are returned (including text that doesn't have a
+ * relationship with the value of the StartDocumentAnalysis
+ * FeatureTypes
input parameter).
*
- * Lines and words of text. A LINE Block object contains one or more WORD
- * Block objects.
+ * Selection elements such as check boxes and option buttons (radio buttons)
+ * can be detected in form data and in tables. A SELECTION_ELEMENT
+ * Block
object contains information about a selection element,
+ * including the selection status.
*
* Use the MaxResults
parameter to limit the number of blocks
- * returned. If there are more results than specified in
+ * that are returned. If there are more results than specified in
* MaxResults
, the value of NextToken
in the
* operation response contains a pagination token for getting the next set
* of results. To get the next page of results, call
@@ -375,13 +379,13 @@ GetDocumentTextDetectionResult getDocumentTextDetection(
/**
*
- * Starts asynchronous analysis of an input document for relationships - * between detected items such as key and value pairs, tables, and selection + * Starts the asynchronous analysis of an input document for relationships + * between detected items such as key-value pairs, tables, and selection * elements. *
*
* StartDocumentAnalysis
can analyze text in documents that are
- * in JPG, PNG, and PDF format. The documents are stored in an Amazon S3
+ * in JPEG, PNG, and PDF format. The documents are stored in an Amazon S3
* bucket. Use DocumentLocation to specify the bucket name and file
* name of the document.
*
* StartDocumentTextDetection
can analyze text in documents
- * that are in JPG, PNG, and PDF format. The documents are stored in an
+ * that are in JPEG, PNG, and PDF format. The documents are stored in an
* Amazon S3 bucket. Use DocumentLocation to specify the bucket name
* and file name of the document.
*
- * Words and lines that are related to nearby lines and words. The related
- * information is returned in two Block objects each of type
- * KEY_VALUE_SET
: a KEY Block object and a VALUE Block object.
- * For example, Name: Ana Silva Carolina contains a key and value.
+ * Form data (key-value pairs). The related information is returned in two
+ * Block objects, each of type KEY_VALUE_SET
: a KEY
+ * Block
object and a VALUE Block
object. For
+ * example, Name: Ana Silva Carolina contains a key and value.
* Name: is the key. Ana Silva Carolina is the value.
*
- * Table and table cell data. A TABLE Block object contains information
- * about a detected table. A CELL Block object is returned for each cell in
- * a table.
+ * Table and table cell data. A TABLE Block
object contains
+ * information about a detected table. A CELL Block
object is
+ * returned for each cell in a table.
*
- * Selectable elements such as checkboxes and radio buttons. A
- * SELECTION_ELEMENT Block object contains information about a selectable
- * element.
+ * Lines and words of text. A LINE Block
object contains one or
+ * more WORD Block
objects. All lines and words that are
+ * detected in the document are returned (including text that doesn't have a
+ * relationship with the value of FeatureTypes
).
*
- * Lines and words of text. A LINE Block object contains one or more WORD
- * Block objects.
+ * Selection elements such as check boxes and option buttons (radio buttons)
+ * can be detected in form data and in tables. A SELECTION_ELEMENT
+ * Block
object contains information about a selection element,
+ * including the selection status.
*
* You can choose which type of analysis to perform by specifying the
* FeatureTypes
list.
*
- * The output is returned in a list of BLOCK
objects.
+ * The output is returned in a list of Block
objects.
*
*
- * Words and lines that are related to nearby lines and words. The related
- * information is returned in two Block objects each of type
- *
- * Table and table cell data. A TABLE Block object contains information
- * about a detected table. A CELL Block object is returned for each cell in
- * a table.
+ * Table and table cell data. A TABLE
- * Selectable elements such as checkboxes and radio buttons. A
- * SELECTION_ELEMENT Block object contains information about a selectable
- * element.
+ * Lines and words of text. A LINE
- * Lines and words of text. A LINE Block object contains one or more WORD
- * Block objects.
+ * Selection elements such as check boxes and option buttons (radio buttons)
+ * can be detected in form data and in tables. A SELECTION_ELEMENT
+ *
* You can choose which type of analysis to perform by specifying the
*
- * The output is returned in a list of
*
* Detects text in the input document. Amazon Textract can detect lines of
* text and the words that make up a line of text. The input document must
- * be an image in JPG or PNG format.
* Each document page has as an associated
* Detects text in the input document. Amazon Textract can detect lines of
* text and the words that make up a line of text. The input document must
- * be an image in JPG or PNG format.
* Each document page has as an associated
- * Words and lines that are related to nearby lines and words. The related
- * information is returned in two Block objects each of type
- *
- * Table and table cell data. A TABLE Block object contains information
- * about a detected table. A CELL Block object is returned for each cell in
- * a table.
+ * Table and table cell data. A TABLE
- * Selectable elements such as checkboxes and radio buttons. A
- * SELECTION_ELEMENT Block object contains information about a selectable
- * element.
+ * Lines and words of text. A LINE
- * Lines and words of text. A LINE Block object contains one or more WORD
- * Block objects.
+ * Selection elements such as check boxes and option buttons (radio buttons)
+ * can be detected in form data and in tables. A SELECTION_ELEMENT
+ *
* Use the
- * Words and lines that are related to nearby lines and words. The related
- * information is returned in two Block objects each of type
- *
- * Table and table cell data. A TABLE Block object contains information
- * about a detected table. A CELL Block object is returned for each cell in
- * a table.
+ * Table and table cell data. A TABLE
- * Selectable elements such as checkboxes and radio buttons. A
- * SELECTION_ELEMENT Block object contains information about a selectable
- * element.
+ * Lines and words of text. A LINE
- * Lines and words of text. A LINE Block object contains one or more WORD
- * Block objects.
+ * Selection elements such as check boxes and option buttons (radio buttons)
+ * can be detected in form data and in tables. A SELECTION_ELEMENT
+ *
* Use the
- * Starts asynchronous analysis of an input document for relationships
- * between detected items such as key and value pairs, tables, and selection
+ * Starts the asynchronous analysis of an input document for relationships
+ * between detected items such as key-value pairs, tables, and selection
* elements.
*
*
- * Starts asynchronous analysis of an input document for relationships
- * between detected items such as key and value pairs, tables, and selection
+ * Starts the asynchronous analysis of an input document for relationships
+ * between detected items such as key-value pairs, tables, and selection
* elements.
*
*
*
*
- * Words and lines that are related to nearby lines and words. The related
- * information is returned in two Block objects each of type
- *
- * Table and table cell data. A TABLE Block object contains information
- * about a detected table. A CELL Block object is returned for each cell in
- * a table.
+ * Table and table cell data. A TABLE
- * Selectable elements such as checkboxes and radio buttons. A
- * SELECTION_ELEMENT Block object contains information about a selectable
- * element.
+ * Lines and words of text. A LINE
- * Lines and words of text. A LINE Block object contains one or more WORD
- * Block objects.
+ * Selection elements such as check boxes and option buttons (radio buttons)
+ * can be detected in form data and in tables. A SELECTION_ELEMENT
+ *
* You can choose which type of analysis to perform by specifying the
*
- * The output is returned in a list of
*
- * Words and lines that are related to nearby lines and words. The related
- * information is returned in two Block objects each of type
- *
- * Table and table cell data. A TABLE Block object contains information
- * about a detected table. A CELL Block object is returned for each cell in
- * a table.
+ * Table and table cell data. A TABLE
- * Selectable elements such as checkboxes and radio buttons. A
- * SELECTION_ELEMENT Block object contains information about a selectable
- * element.
+ * Lines and words of text. A LINE
- * Lines and words of text. A LINE Block object contains one or more WORD
- * Block objects.
+ * Selection elements such as check boxes and option buttons (radio buttons)
+ * can be detected in form data and in tables. A SELECTION_ELEMENT
+ *
* You can choose which type of analysis to perform by specifying the
*
- * The output is returned in a list of
*
* Detects text in the input document. Amazon Textract can detect lines of
* text and the words that make up a line of text. The input document must
- * be an image in JPG or PNG format.
* Each document page has as an associated
* Detects text in the input document. Amazon Textract can detect lines of
* text and the words that make up a line of text. The input document must
- * be an image in JPG or PNG format.
* Each document page has as an associated
- * Words and lines that are related to nearby lines and words. The related
- * information is returned in two Block objects each of type
- *
- * Table and table cell data. A TABLE Block object contains information
- * about a detected table. A CELL Block object is returned for each cell in
- * a table.
+ * Table and table cell data. A TABLE
- * Selectable elements such as checkboxes and radio buttons. A
- * SELECTION_ELEMENT Block object contains information about a selectable
- * element.
+ * Lines and words of text. A LINE
- * Lines and words of text. A LINE Block object contains one or more WORD
- * Block objects.
+ * Selection elements such as check boxes and option buttons (radio buttons)
+ * can be detected in form data and in tables. A SELECTION_ELEMENT
+ *
* Use the
- * Words and lines that are related to nearby lines and words. The related
- * information is returned in two Block objects each of type
- *
- * Table and table cell data. A TABLE Block object contains information
- * about a detected table. A CELL Block object is returned for each cell in
- * a table.
+ * Table and table cell data. A TABLE
- * Selectable elements such as checkboxes and radio buttons. A
- * SELECTION_ELEMENT Block object contains information about a selectable
- * element.
+ * Lines and words of text. A LINE
- * Lines and words of text. A LINE Block object contains one or more WORD
- * Block objects.
+ * Selection elements such as check boxes and option buttons (radio buttons)
+ * can be detected in form data and in tables. A SELECTION_ELEMENT
+ *
* Use the
- * Starts asynchronous analysis of an input document for relationships
- * between detected items such as key and value pairs, tables, and selection
+ * Starts the asynchronous analysis of an input document for relationships
+ * between detected items such as key-value pairs, tables, and selection
* elements.
*
*
- * Starts asynchronous analysis of an input document for relationships
- * between detected items such as key and value pairs, tables, and selection
+ * Starts the asynchronous analysis of an input document for relationships
+ * between detected items such as key-value pairs, tables, and selection
* elements.
*
*
*
*
- * Words and lines that are related to nearby lines and words. The related
- * information is returned in two Block objects each of type
- *
- * Table and table cell data. A TABLE Block object contains information
- * about a detected table. A CELL Block object is returned for each cell in
- * a table.
+ * Table and table cell data. A TABLE
- * Selectable elements such as checkboxes and radio buttons. A
- * SELECTION_ELEMENT Block object contains information about a selectable
- * element.
+ * Lines and words of text. A LINE
- * Lines and words of text. A LINE Block object contains one or more WORD
- * Block objects.
+ * Selection elements such as check boxes and option buttons (radio buttons)
+ * can be detected in form data and in tables. A SELECTION_ELEMENT
+ *
* You can choose which type of analysis to perform by specifying the
*
- * The output is returned in a list of
*
* Detects text in the input document. Amazon Textract can detect lines of
* text and the words that make up a line of text. The input document must
- * be an image in JPG or PNG format.
* Each document page has as an associated
- * Words and lines that are related to nearby lines and words. The related
- * information is returned in two Block objects each of type
- *
- * Table and table cell data. A TABLE Block object contains information
- * about a detected table. A CELL Block object is returned for each cell in
- * a table.
+ * Table and table cell data. A TABLE
- * Selectable elements such as checkboxes and radio buttons. A
- * SELECTION_ELEMENT Block object contains information about a selectable
- * element.
+ * Lines and words of text. A LINE
- * Lines and words of text. A LINE Block object contains one or more WORD
- * Block objects.
+ * Selection elements such as check boxes and option buttons (radio buttons)
+ * can be detected in form data and in tables. A SELECTION_ELEMENT
+ *
* Use the
- * Starts asynchronous analysis of an input document for relationships
- * between detected items such as key and value pairs, tables, and selection
+ * Starts the asynchronous analysis of an input document for relationships
+ * between detected items such as key-value pairs, tables, and selection
* elements.
*
*
*
- * Words and lines that are related to nearby lines and words. The related
- * information is returned in two Block objects each of type
- *
- * Table and table cell data. A TABLE Block object contains information about a
- * detected table. A CELL Block object is returned for each cell in a table.
+ * Table and table cell data. A TABLE
- * Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT
- * Block object contains information about a selectable element.
+ * Lines and words of text. A LINE
- * Lines and words of text. A LINE Block object contains one or more WORD Block
- * objects.
+ * Selection elements such as check boxes and option buttons (radio buttons) can
+ * be detected in form data and in tables. A SELECTION_ELEMENT
+ *
* You can choose which type of analysis to perform by specifying the
*
- * The output is returned in a list of
*
* 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 JPG or PNG format.
+ * bytes. The document must be an image in JPEG or PNG format.
*
- * If you are using an AWS SDK to call Amazon Textract, you might not need
- * to base64-encode image bytes passed using the
* A list of the types of analysis to perform. Add TABLES to the list to
- * return information about the tables detected in the input document. Add
- * FORMS to return detected fields and the associated text. To perform both
- * types of analysis, add TABLES and FORMS to
+ * Sets the configuration for the human in the loop workflow for analyzing
+ * documents.
+ *
* 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 JPG or PNG format.
+ * bytes. The document must be an image in JPEG or PNG format.
*
- * If you are using an AWS SDK to call Amazon Textract, you might not need
- * to base64-encode image bytes passed using the
* 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 JPG or PNG format.
+ * image in JPEG or PNG format.
*
- * If you are using an AWS SDK to call Amazon Textract, you might
- * not need to base64-encode image bytes passed using the
+ * 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
*
* 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 JPG or PNG format.
+ * bytes. The document must be an image in JPEG or PNG format.
*
- * If you are using an AWS SDK to call Amazon Textract, you might not need
- * to base64-encode image bytes passed using the
* 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 JPG or PNG format.
+ * an image in JPEG or PNG format.
*
- * If you are using an AWS SDK to call Amazon Textract, you might
- * not need to base64-encode image bytes passed using the
- *
* 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 JPG or PNG format.
+ * bytes. The document must be an image in JPEG or PNG format.
*
- * If you are using an AWS SDK to call Amazon Textract, you might not need
- * to base64-encode image bytes passed using the
* Returns a reference to this object so that method calls can be chained
@@ -168,12 +186,12 @@ public void setDocument(Document document) {
* 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 JPG or PNG format.
+ * an image in JPEG or PNG format.
*
- * If you are using an AWS SDK to call Amazon Textract, you might
- * not need to base64-encode image bytes passed using the
- *
* A list of the types of analysis to perform. Add TABLES to the list to
- * return information about the tables detected in the input document. Add
- * FORMS to return detected fields and the associated text. To perform both
- * types of analysis, add TABLES and FORMS to
* A list of the types of analysis to perform. Add TABLES to the
- * list to return information about the tables detected in the input
- * document. Add FORMS to return detected fields and the associated
- * text. To perform both types of analysis, add TABLES and FORMS to
- *
* A list of the types of analysis to perform. Add TABLES to the list to
- * return information about the tables detected in the input document. Add
- * FORMS to return detected fields and the associated text. To perform both
- * types of analysis, add TABLES and FORMS to
* A list of the types of analysis to perform. Add TABLES to the
- * list to return information about the tables detected in the
- * input document. Add FORMS to return detected fields and the
- * associated text. To perform both types of analysis, add TABLES
- * and FORMS to
* A list of the types of analysis to perform. Add TABLES to the list to
- * return information about the tables detected in the input document. Add
- * FORMS to return detected fields and the associated text. To perform both
- * types of analysis, add TABLES and FORMS to
* Returns a reference to this object so that method calls can be chained
@@ -241,10 +272,12 @@ public void setFeatureTypes(java.util.Collection
* A list of the types of analysis to perform. Add TABLES to the
- * list to return information about the tables detected in the
- * input document. Add FORMS to return detected fields and the
- * associated text. To perform both types of analysis, add TABLES
- * and FORMS to
* A list of the types of analysis to perform. Add TABLES to the list to
- * return information about the tables detected in the input document. Add
- * FORMS to return detected fields and the associated text. To perform both
- * types of analysis, add TABLES and FORMS to
* Returns a reference to this object so that method calls can be chained
@@ -272,10 +308,12 @@ public AnalyzeDocumentRequest withFeatureTypes(String... featureTypes) {
*
* @param featureTypes
* A list of the types of analysis to perform. Add TABLES to the
- * list to return information about the tables detected in the
- * input document. Add FORMS to return detected fields and the
- * associated text. To perform both types of analysis, add TABLES
- * and FORMS to
+ * Sets the configuration for the human in the loop workflow for analyzing
+ * documents.
+ *
+ * Sets the configuration for the human in the loop workflow for
+ * analyzing documents.
+ *
+ * Sets the configuration for the human in the loop workflow for analyzing
+ * documents.
+ *
+ * Sets the configuration for the human in the loop workflow for
+ * analyzing documents.
+ *
+ * Sets the configuration for the human in the loop workflow for analyzing
+ * documents.
+ *
+ * Returns a reference to this object so that method calls can be chained
+ * together.
+ *
+ * @param humanLoopConfig
+ * Sets the configuration for the human in the loop workflow for
+ * analyzing documents.
+ *
- * The text that's detected and analyzed by
+ * Shows the results of the human in the loop evaluation.
+ *
+ * The version of the model used to analyze the document.
+ *
* Metadata about the analyzed document. An example is the number of pages.
@@ -82,11 +96,11 @@ public AnalyzeDocumentResult withDocumentMetadata(DocumentMetadata documentMetad
/**
*
- * The text that's detected and analyzed by
- * The text that's detected and analyzed by
+ * The items that are detected and analyzed by
*
- * The text that's detected and analyzed by
- * The text that's detected and analyzed by
+ * The items that are detected and analyzed by
*
- * The text that's detected and analyzed by
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param blocks
- * The text that's detected and analyzed by
+ * The items that are detected and analyzed by
*
- * The text that's detected and analyzed by
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param blocks
- * The text that's detected and analyzed by
+ * The items that are detected and analyzed by
*
+ * Shows the results of the human in the loop evaluation.
+ *
+ * Shows the results of the human in the loop evaluation.
+ *
+ * Shows the results of the human in the loop evaluation.
+ *
+ * Shows the results of the human in the loop evaluation.
+ *
+ * Shows the results of the human in the loop evaluation.
+ *
+ * Returns a reference to this object so that method calls can be chained
+ * together.
+ *
+ * @param humanLoopActivationOutput
+ * Shows the results of the human in the loop evaluation.
+ *
+ * The version of the model used to analyze the document.
+ *
+ * The version of the model used to analyze the document.
+ *
+ * The version of the model used to analyze the document.
+ *
+ * The version of the model used to analyze the document.
+ *
+ * The version of the model used to analyze the document.
+ *
+ * Returns a reference to this object so that method calls can be chained
+ * together.
+ *
+ * @param analyzeDocumentModelVersion
+ * The version of the model used to analyze the document.
+ *
* A
* An array of
- * The type of text that's recognized in a block. In text-detection
- * operations, the following types are returned:
+ * 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.
+ * PAGE - Contains a list of the LINE
- * LINE - A string of tab-delimited, contiguous words that's detected
- * on a document page.
+ * LINE - A string of tab-delimited, contiguous words that are
+ * detected on a document page.
*
- * PAGE - Contains a list of child Block objects that are detected on
- * a document page.
+ * PAGE - Contains a list of child
- * KEY_VALUE_SET - Stores the KEY and VALUE Block objects for a field
- * that's detected on a document page. Use the
- * 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 that's
- * detected on a document page.
+ * 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's detected
- * on a document page.
+ * 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 any
- * grid-based information with 2 or more rows or columns with a cell span of
- * 1 row and 1 column each.
+ * 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.
*
- * SELECTION_ELEMENT - A selectable element such as a radio button or
- * checkbox that's detected on a document page. Use the value of
- *
- * The confidence that Amazon Textract has in the accuracy of the recognized
- * text and the accuracy of the geometry points around the recognized text.
+ * 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.
*
* Constraints:
- * The number of rows that a table spans.
* Constraints:
- * The number of columns that a table cell spans.
* Constraints:
- * A list of child blocks of the current block. For example a LINE object
+ * A list of child blocks of the current block. For example, a LINE object
* has child blocks for each WORD block that's part of 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. The list
@@ -262,8 +264,8 @@ public class Block implements Serializable {
/**
*
- * The selection status of a selectable element such as a radio button or
- * checkbox.
+ * The selection status of a selection element, such as an option button or
+ * check box.
*
* Constraints:
- * The page in which a block was detected.
@@ -289,14 +291,14 @@ public class Block implements Serializable {
/**
*
- * The type of text that's recognized in a block. In text-detection
- * operations, the following types are returned:
+ * 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.
+ * PAGE - Contains a list of the LINE
- * LINE - A string of tab-delimited, contiguous words that's detected
- * on a document page.
+ * LINE - A string of tab-delimited, contiguous words that are
+ * detected on a document page.
*
- * PAGE - Contains a list of child Block objects that are detected on
- * a document page.
+ * PAGE - Contains a list of child
- * KEY_VALUE_SET - Stores the KEY and VALUE Block objects for a field
- * that's detected on a document page. Use the
- * 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 that's
- * detected on a document page.
+ * 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's detected
- * on a document page.
+ * 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 any
- * grid-based information with 2 or more rows or columns with a cell span of
- * 1 row and 1 column each.
+ * 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.
*
- * SELECTION_ELEMENT - A selectable element such as a radio button or
- * checkbox that's detected on a document page. Use the value of
- *
- * The type of text that's recognized in a block. In text-detection
- * operations, the following types are returned:
+ * 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.
+ * PAGE - Contains a list of the LINE
- * LINE - A string of tab-delimited, contiguous words that's
- * detected on a document page.
+ * LINE - A string of tab-delimited, contiguous words that
+ * are detected on a document page.
*
- * PAGE - Contains a list of child Block objects that are
- * detected on a document page.
+ * PAGE - Contains a list of child
- * KEY_VALUE_SET - Stores the KEY and VALUE Block objects for
- * a field that's detected on a document page. Use the
- *
- * 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 that's detected on a document page.
+ * 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's
- * detected on a document page.
+ * 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 any grid-based information with 2 or more rows or
- * columns with a cell span of 1 row and 1 column each.
+ * table is grid-based information with two or more rows or columns,
+ * with a cell span of one row and one column each.
*
- * SELECTION_ELEMENT - A selectable element such as a radio
- * button or checkbox that's detected on a document page. Use the
- * value of
- * The type of text that's recognized in a block. In text-detection
- * operations, the following types are returned:
+ * 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.
+ * PAGE - Contains a list of the LINE
- * LINE - A string of tab-delimited, contiguous words that's detected
- * on a document page.
+ * LINE - A string of tab-delimited, contiguous words that are
+ * detected on a document page.
*
- * PAGE - Contains a list of child Block objects that are detected on
- * a document page.
+ * PAGE - Contains a list of child
- * KEY_VALUE_SET - Stores the KEY and VALUE Block objects for a field
- * that's detected on a document page. Use the
- * 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 that's
- * detected on a document page.
+ * 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's detected
- * on a document page.
+ * 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 any
- * grid-based information with 2 or more rows or columns with a cell span of
- * 1 row and 1 column each.
+ * 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.
*
- * SELECTION_ELEMENT - A selectable element such as a radio button or
- * checkbox that's detected on a document page. Use the value of
- *
- * The type of text that's recognized in a block. In
- * text-detection operations, the following types are returned:
+ * 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.
+ * PAGE - Contains a list of the LINE
- * LINE - A string of tab-delimited, contiguous words
- * that's detected on a document page.
+ * LINE - A string of tab-delimited, contiguous words that
+ * are detected on a document page.
*
- * PAGE - Contains a list of child Block objects that are
- * detected on a document page.
+ * PAGE - Contains a list of child
- * KEY_VALUE_SET - Stores the KEY and VALUE Block objects
- * for a field that's detected on a document page. Use the
- *
- * 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 that's detected on a document page.
+ * 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's detected on a document page.
+ * 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 any grid-based information with 2 or more rows or
- * columns with a cell span of 1 row and 1 column each.
+ * table is grid-based information with two or more rows or
+ * columns, with a cell span of one row and one column each.
*
- * SELECTION_ELEMENT - A selectable element such as a
- * radio button or checkbox that's detected on a document page.
- * Use the value of
- * The type of text that's recognized in a block. In text-detection
- * operations, the following types are returned:
+ * 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.
+ * PAGE - Contains a list of the LINE
- * LINE - A string of tab-delimited, contiguous words that's detected
- * on a document page.
+ * LINE - A string of tab-delimited, contiguous words that are
+ * detected on a document page.
*
- * PAGE - Contains a list of child Block objects that are detected on
- * a document page.
+ * PAGE - Contains a list of child
- * KEY_VALUE_SET - Stores the KEY and VALUE Block objects for a field
- * that's detected on a document page. Use the
- * 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 that's
- * detected on a document page.
+ * 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's detected
- * on a document page.
+ * 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 any
- * grid-based information with 2 or more rows or columns with a cell span of
- * 1 row and 1 column each.
+ * 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.
*
- * SELECTION_ELEMENT - A selectable element such as a radio button or
- * checkbox that's detected on a document page. Use the value of
- *
- * The type of text that's recognized in a block. In
- * text-detection operations, the following types are returned:
+ * 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.
+ * PAGE - Contains a list of the LINE
- * LINE - A string of tab-delimited, contiguous words
- * that's detected on a document page.
+ * LINE - A string of tab-delimited, contiguous words that
+ * are detected on a document page.
*
- * PAGE - Contains a list of child Block objects that are
- * detected on a document page.
+ * PAGE - Contains a list of child
- * KEY_VALUE_SET - Stores the KEY and VALUE Block objects
- * for a field that's detected on a document page. Use the
- *
- * 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 that's detected on a document page.
+ * 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's detected on a document page.
+ * 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 any grid-based information with 2 or more rows or
- * columns with a cell span of 1 row and 1 column each.
+ * table is grid-based information with two or more rows or
+ * columns, with a cell span of one row and one column each.
*
- * SELECTION_ELEMENT - A selectable element such as a
- * radio button or checkbox that's detected on a document page.
- * Use the value of
- * The type of text that's recognized in a block. In text-detection
- * operations, the following types are returned:
+ * 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.
+ * PAGE - Contains a list of the LINE
- * LINE - A string of tab-delimited, contiguous words that's detected
- * on a document page.
+ * LINE - A string of tab-delimited, contiguous words that are
+ * detected on a document page.
*
- * PAGE - Contains a list of child Block objects that are detected on
- * a document page.
+ * PAGE - Contains a list of child
- * KEY_VALUE_SET - Stores the KEY and VALUE Block objects for a field
- * that's detected on a document page. Use the
- * 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 that's
- * detected on a document page.
+ * 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's detected
- * on a document page.
+ * 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 any
- * grid-based information with 2 or more rows or columns with a cell span of
- * 1 row and 1 column each.
+ * 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.
*
- * SELECTION_ELEMENT - A selectable element such as a radio button or
- * checkbox that's detected on a document page. Use the value of
- *
- * The type of text that's recognized in a block. In
- * text-detection operations, the following types are returned:
+ * 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.
+ * PAGE - Contains a list of the LINE
- * LINE - A string of tab-delimited, contiguous words
- * that's detected on a document page.
+ * LINE - A string of tab-delimited, contiguous words that
+ * are detected on a document page.
*
- * PAGE - Contains a list of child Block objects that are
- * detected on a document page.
+ * PAGE - Contains a list of child
- * KEY_VALUE_SET - Stores the KEY and VALUE Block objects
- * for a field that's detected on a document page. Use the
- *
- * 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 that's detected on a document page.
+ * 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's detected on a document page.
+ * 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 any grid-based information with 2 or more rows or
- * columns with a cell span of 1 row and 1 column each.
+ * table is grid-based information with two or more rows or
+ * columns, with a cell span of one row and one column each.
*
- * SELECTION_ELEMENT - A selectable element such as a
- * radio button or checkbox that's detected on a document page.
- * Use the value of
- * The type of text that's recognized in a block. In text-detection
- * operations, the following types are returned:
+ * 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.
+ * PAGE - Contains a list of the LINE
- * LINE - A string of tab-delimited, contiguous words that's detected
- * on a document page.
+ * LINE - A string of tab-delimited, contiguous words that are
+ * detected on a document page.
*
- * PAGE - Contains a list of child Block objects that are detected on
- * a document page.
+ * PAGE - Contains a list of child
- * KEY_VALUE_SET - Stores the KEY and VALUE Block objects for a field
- * that's detected on a document page. Use the
- * 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 that's
- * detected on a document page.
+ * 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's detected
- * on a document page.
+ * 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 any
- * grid-based information with 2 or more rows or columns with a cell span of
- * 1 row and 1 column each.
+ * 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.
*
- * SELECTION_ELEMENT - A selectable element such as a radio button or
- * checkbox that's detected on a document page. Use the value of
- *
- * The type of text that's recognized in a block. In
- * text-detection operations, the following types are returned:
+ * 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.
+ * PAGE - Contains a list of the LINE
- * LINE - A string of tab-delimited, contiguous words
- * that's detected on a document page.
+ * LINE - A string of tab-delimited, contiguous words that
+ * are detected on a document page.
*
- * PAGE - Contains a list of child Block objects that are
- * detected on a document page.
+ * PAGE - Contains a list of child
- * KEY_VALUE_SET - Stores the KEY and VALUE Block objects
- * for a field that's detected on a document page. Use the
- *
- * 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 that's detected on a document page.
+ * 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's detected on a document page.
+ * 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 any grid-based information with 2 or more rows or
- * columns with a cell span of 1 row and 1 column each.
+ * table is grid-based information with two or more rows or
+ * columns, with a cell span of one row and one column each.
*
- * SELECTION_ELEMENT - A selectable element such as a
- * radio button or checkbox that's detected on a document page.
- * Use the value of
- * The confidence that Amazon Textract has in the accuracy of the recognized
- * text and the accuracy of the geometry points around the recognized text.
+ * 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.
*
* Constraints:
- * The confidence that Amazon Textract has in the accuracy of the
- * recognized text and the accuracy of the geometry points around
- * the recognized text.
+ * 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.
*
- * The confidence that Amazon Textract has in the accuracy of the recognized
- * text and the accuracy of the geometry points around the recognized text.
+ * 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.
*
* Constraints:
- * The confidence that Amazon Textract has in the accuracy of the
- * recognized text and the accuracy of the geometry points around
- * the recognized text.
+ * 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.
*
- * The confidence that Amazon Textract has in the accuracy of the recognized
- * text and the accuracy of the geometry points around the recognized text.
+ * 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.
*
* Returns a reference to this object so that method calls can be chained
@@ -1185,9 +1194,9 @@ public void setConfidence(Float confidence) {
* Length: 0 - 100
- * The confidence that Amazon Textract has in the accuracy of the
- * recognized text and the accuracy of the geometry points around
- * the recognized text.
+ * 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.
*
- * The number of rows that a table spans.
* Constraints:
- * The number of rows that a table spans.
- * The number of rows that a table spans.
* Constraints:
- * The number of rows that a table spans.
- * The number of rows that a table spans.
* Returns a reference to this object so that method calls can be chained
@@ -1437,8 +1453,10 @@ public void setRowSpan(Integer rowSpan) {
* Range: 0 -
- * The number of rows that a table spans.
- * The number of columns that a table cell spans.
* Constraints:
- * The number of columns that a table cell spans.
- *
- * The number of columns that a table cell spans.
* Constraints:
- * The number of columns that a table cell spans.
- *
- * The number of columns that a table cell spans.
* Returns a reference to this object so that method calls can be chained
@@ -1505,8 +1528,9 @@ public void setColumnSpan(Integer columnSpan) {
* Range: 0 -
- * The number of columns that a table cell spans.
- *
- * A list of child blocks of the current block. For example a LINE object
+ * A list of child blocks of the current block. For example, a LINE object
* has child blocks for each WORD block that's part of 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. The list
@@ -1659,7 +1683,7 @@ public Block withId(String id) {
*
*
* @return
- * A list of child blocks of the current block. For example a LINE
+ * A list of child blocks of the current block. For example, a LINE
* object has child blocks for each WORD block that's part of the
* line of text. There aren't Relationship objects in the list for
* relationships that don't exist, such as when the current block
@@ -1684,7 +1708,7 @@ public java.util.List
- * A list of child blocks of the current block. For example a LINE object
+ * A list of child blocks of the current block. For example, a LINE object
* has child blocks for each WORD block that's part of 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. The list
@@ -1704,7 +1728,7 @@ public java.util.List
- * A list of child blocks of the current block. For example a
+ * A list of child blocks of the current block. For example, a
* LINE object has child blocks for each WORD block that's part
* of the line of text. There aren't Relationship objects in the
* list for relationships that don't exist, such as when the
@@ -1735,7 +1759,7 @@ public void setRelationships(java.util.Collection
- * A list of child blocks of the current block. For example a LINE object
+ * A list of child blocks of the current block. For example, a LINE object
* has child blocks for each WORD block that's part of 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. The list
@@ -1758,7 +1782,7 @@ public void setRelationships(java.util.Collection
- * A list of child blocks of the current block. For example a
+ * A list of child blocks of the current block. For example, a
* LINE object has child blocks for each WORD block that's part
* of the line of text. There aren't Relationship objects in the
* list for relationships that don't exist, such as when the
@@ -1792,7 +1816,7 @@ public Block withRelationships(Relationship... relationships) {
/**
*
- * A list of child blocks of the current block. For example a LINE object
+ * A list of child blocks of the current block. For example, a LINE object
* has child blocks for each WORD block that's part of 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. The list
@@ -1815,7 +1839,7 @@ public Block withRelationships(Relationship... relationships) {
* together.
*
* @param relationships
- * A list of child blocks of the current block. For example a
+ * A list of child blocks of the current block. For example, a
* LINE object has child blocks for each WORD block that's part
* of the line of text. There aren't Relationship objects in the
* list for relationships that don't exist, such as when the
@@ -2054,16 +2078,16 @@ public Block withEntityTypes(java.util.Collection
- * The selection status of a selectable element such as a radio button or
- * checkbox.
+ * The selection status of a selection element, such as an option button or
+ * check box.
*
* Constraints:
- * The selection status of a selectable element such as a radio
- * button or checkbox.
+ * The selection status of a selection element, such as an option
+ * button or check box.
*
- * The selection status of a selectable element such as a radio button or
- * checkbox.
+ * The selection status of a selection element, such as an option button or
+ * check box.
*
* Constraints:
- * The selection status of a selectable element such as a radio
- * button or checkbox.
+ * The selection status of a selection element, such as an option
+ * button or check box.
*
- * The selection status of a selectable element such as a radio button or
- * checkbox.
+ * The selection status of a selection element, such as an option button or
+ * check box.
*
* Returns a reference to this object so that method calls can be chained
@@ -2103,8 +2127,8 @@ public void setSelectionStatus(String selectionStatus) {
* Allowed Values: SELECTED, NOT_SELECTED
*
* @param selectionStatus
- * The selection status of a selectable element such as a radio
- * button or checkbox.
+ * The selection status of a selection element, such as an option
+ * button or check box.
*
- * The selection status of a selectable element such as a radio button or
- * checkbox.
+ * The selection status of a selection element, such as an option button or
+ * check box.
*
* Constraints:
- * The selection status of a selectable element such as a radio
- * button or checkbox.
+ * The selection status of a selection element, such as an option
+ * button or check box.
*
- * The selection status of a selectable element such as a radio button or
- * checkbox.
+ * The selection status of a selection element, such as an option button or
+ * check box.
*
* Returns a reference to this object so that method calls can be chained
@@ -2147,8 +2171,8 @@ public void setSelectionStatus(SelectionStatus selectionStatus) {
* Allowed Values: SELECTED, NOT_SELECTED
*
* @param selectionStatus
- * The selection status of a selectable element such as a radio
- * button or checkbox.
+ * The selection status of a selection element, such as an option
+ * button or check box.
*
- * The page in which a block was detected.
@@ -2174,14 +2198,14 @@ public Block withSelectionStatus(SelectionStatus selectionStatus) {
* Range: 0 -
- * The page in which a block was detected.
- * The page in which a block was detected.
@@ -2203,15 +2227,15 @@ public Integer getPage() {
* Range: 0 -
- * The page in which a block was detected.
- * The page in which a block was detected.
@@ -2236,15 +2260,15 @@ public void setPage(Integer page) {
* Range: 0 -
- * The page in which a block was detected.
- * The bounding box around the recognized text, key, value, table or table cell
- * on a document page. The
* The
* Detects text in the input document. Amazon Textract can detect lines of text
* and the words that make up a line of text. The input document must be an
- * image in JPG or PNG format.
@@ -48,11 +48,12 @@ public class DetectDocumentTextRequest extends AmazonWebServiceRequest implement
*
* 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 JPG or PNG format.
+ * bytes. The document must be an image in JPEG or PNG format.
*
- * If you are using an AWS SDK to call Amazon Textract, you might not need
- * to base64-encode image bytes passed using the
* 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 JPG or PNG format.
+ * bytes. The document must be an image in JPEG or PNG format.
*
- * If you are using an AWS SDK to call Amazon Textract, you might not need
- * to base64-encode image bytes passed using the
* 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 JPG or PNG format.
+ * image in JPEG or PNG format.
*
- * If you are using an AWS SDK to call Amazon Textract, you might
- * not need to base64-encode image bytes passed using the
+ * 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
*
* 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 JPG or PNG format.
+ * bytes. The document must be an image in JPEG or PNG format.
*
- * If you are using an AWS SDK to call Amazon Textract, you might not need
- * to base64-encode image bytes passed using the
* 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 JPG or PNG format.
+ * an image in JPEG or PNG format.
*
- * If you are using an AWS SDK to call Amazon Textract, you might
- * not need to base64-encode image bytes passed using the
- *
* 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 JPG or PNG format.
+ * bytes. The document must be an image in JPEG or PNG format.
*
- * If you are using an AWS SDK to call Amazon Textract, you might not need
- * to base64-encode image bytes passed using the
* Returns a reference to this object so that method calls can be chained
@@ -129,12 +133,12 @@ public void setDocument(Document document) {
* 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 JPG or PNG format.
+ * an image in JPEG or PNG format.
*
- * If you are using an AWS SDK to call Amazon Textract, you might
- * not need to base64-encode image bytes passed using the
- *
- * Metadata about the document. Contains the number of pages that are
+ * Metadata about the document. It contains the number of pages that are
* detected in the document.
*
- * An array of Block objects containing the text detected in the document.
+ * An array of
- * Metadata about the document. Contains the number of pages that are
+ * Metadata about the document. It contains the number of pages that are
* detected in the document.
*
- * Metadata about the document. Contains the number of pages that
+ * Metadata about the document. It contains the number of pages that
* are detected in the document.
*
- * Metadata about the document. Contains the number of pages that are
+ * Metadata about the document. It contains the number of pages that are
* detected in the document.
*
- * Metadata about the document. Contains the number of pages that
- * are detected in the document.
+ * Metadata about the document. It contains the number of pages
+ * that are detected in the document.
*
- * Metadata about the document. Contains the number of pages that are
+ * Metadata about the document. It contains the number of pages that are
* detected in the document.
*
@@ -73,8 +79,8 @@ public void setDocumentMetadata(DocumentMetadata documentMetadata) {
* together.
*
* @param documentMetadata
- * Metadata about the document. Contains the number of pages that
- * are detected in the document.
+ * Metadata about the document. It contains the number of pages
+ * that are detected in the document.
*
- * An array of Block objects containing the text detected in the document.
+ * An array of
- * An array of Block objects containing the text detected in the
- * document.
+ * An array of
- * An array of Block objects containing the text detected in the document.
+ * An array of
- * An array of Block objects containing the text detected in the
- * document.
+ * An array of
- * An array of Block objects containing the text detected in the document.
+ * An array of
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param blocks
- * An array of Block objects containing the text detected in the
- * document.
+ * An array of
- * An array of Block objects containing the text detected in the document.
+ * An array of
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param blocks
- * An array of Block objects containing the text detected in the
- * document.
+ * An array of
+ * Returns a reference to this object so that method calls can be chained
+ * together.
+ *
+ * @param detectDocumentTextModelVersion
- * A blob of base-64 encoded documents bytes. The maximum size of a document
+ * 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 JPG format.
+ * PNG or JPEG format.
*
- * If you are using an AWS SDK to call Amazon Textract, you might not need
- * to base64-encode image bytes passed using the
* Constraints:
* Identifies an S3 object as the document source. The maximum size of a
- * document stored in an S3 bucket is 5 MB.
+ * document that's stored in an S3 bucket is 5 MB.
*
- * A blob of base-64 encoded documents bytes. The maximum size of a document
+ * 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 JPG format.
+ * PNG or JPEG format.
*
- * If you are using an AWS SDK to call Amazon Textract, you might not need
- * to base64-encode image bytes passed using the
* Constraints:
- * A blob of base-64 encoded documents bytes. The maximum size of a
+ * 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 JPG format.
+ * bytes must be in PNG or JPEG format.
*
- * If you are using an AWS SDK to call Amazon Textract, you might
- * not need to base64-encode image bytes passed using the
+ * If you're using an AWS SDK to call Amazon Textract, you might not
+ * need to base64-encode image bytes passed using the
*
- * A blob of base-64 encoded documents bytes. The maximum size of a document
+ * 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 JPG format.
+ * PNG or JPEG format.
*
- * If you are using an AWS SDK to call Amazon Textract, you might not need
- * to base64-encode image bytes passed using the
* Constraints:
- * A blob of base-64 encoded documents 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 JPG format.
+ * 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 are using an AWS SDK to call Amazon Textract, you might
+ * If you're using an AWS SDK to call Amazon Textract, you might
* not need to base64-encode image bytes passed using the
*
- * A blob of base-64 encoded documents bytes. The maximum size of a document
+ * 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 JPG format.
+ * PNG or JPEG format.
*
- * If you are using an AWS SDK to call Amazon Textract, you might not need
- * to base64-encode image bytes passed using the
* Returns a reference to this object so that method calls can be chained
* together.
*
* Constraints:
- * A blob of base-64 encoded documents 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 JPG format.
+ * 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 are using an AWS SDK to call Amazon Textract, you might
+ * If you're using an AWS SDK to call Amazon Textract, you might
* not need to base64-encode image bytes passed using the
*
* Identifies an S3 object as the document source. The maximum size of a
- * document stored in an S3 bucket is 5 MB.
+ * document that's stored in an S3 bucket is 5 MB.
*
* Identifies an S3 object as the document source. The maximum size
- * of a document stored in an S3 bucket is 5 MB.
+ * of a document that's stored in an S3 bucket is 5 MB.
*
* Identifies an S3 object as the document source. The maximum size of a
- * document stored in an S3 bucket is 5 MB.
+ * document that's stored in an S3 bucket is 5 MB.
*
* Identifies an S3 object as the document source. The maximum
- * size of a document stored in an S3 bucket is 5 MB.
+ * size of a document that's stored in an S3 bucket is 5 MB.
*
* Identifies an S3 object as the document source. The maximum size of a
- * document stored in an S3 bucket is 5 MB.
+ * document that's stored in an S3 bucket is 5 MB.
*
* Returns a reference to this object so that method calls can be chained
@@ -208,7 +208,7 @@ public void setS3Object(S3Object s3Object) {
*
* @param s3Object
* Identifies an S3 object as the document source. The maximum
- * size of a document stored in an S3 bucket is 5 MB.
+ * size of a document that's stored in an S3 bucket is 5 MB.
*
- * The input document can be an image file in JPG or PNG format. It can also be
+ * The input document can be an image file in JPEG or PNG format. It can also be
* a file in PDF format.
*
- * The number of pages detected in the document.
+ * The number of pages that are detected in the document.
*
* Constraints:
- * The number of pages detected in the document.
+ * The number of pages that are detected in the document.
*
* Constraints:
- * The number of pages detected in the document.
+ * The number of pages that are detected in the document.
*
- * The number of pages detected in the document.
+ * The number of pages that are detected in the document.
*
* Constraints:
- * The number of pages detected in the document.
+ * The number of pages that are detected in the document.
*
- * The number of pages detected in the document.
+ * The number of pages that are detected in the document.
*
* Returns a reference to this object so that method calls can be chained
@@ -77,7 +77,7 @@ public void setPages(Integer pages) {
* Range: 0 -
- * The number of pages detected in the document.
+ * The number of pages that are detected in the document.
*
* The document can't be processed because it's too large. The maximum document
* size for synchronous operations 5 MB. The maximum document size for
- * asynchronous operations is 500 MB for PDF format files.
+ * asynchronous operations is 500 MB for PDF files.
*
- * Information about where a recognized text, key, value, table, or table cell
- * is located on a document page.
+ * Information about where the following items are located on a document page:
+ * detected page, text, key-value pairs, tables, table cells, and selection
+ * elements.
*
* An axis-aligned coarse representation of the location of the recognized
- * text on the document page.
+ * item on the document page.
*
* Within the bounding box, a fine-grained polygon around the recognized
- * text.
+ * item.
*
* An axis-aligned coarse representation of the location of the recognized
- * text on the document page.
+ * item on the document page.
*
* An axis-aligned coarse representation of the location of the
- * recognized text on the document page.
+ * recognized item on the document page.
*
* An axis-aligned coarse representation of the location of the recognized
- * text on the document page.
+ * item on the document page.
*
* An axis-aligned coarse representation of the location of the
- * recognized text on the document page.
+ * recognized item on the document page.
*
* An axis-aligned coarse representation of the location of the recognized
- * text on the document page.
+ * item on the document page.
*
* Returns a reference to this object so that method calls can be chained
@@ -81,7 +82,7 @@ public void setBoundingBox(BoundingBox boundingBox) {
*
* @param boundingBox
* An axis-aligned coarse representation of the location of the
- * recognized text on the document page.
+ * recognized item on the document page.
*
* Within the bounding box, a fine-grained polygon around the recognized
- * text.
+ * item.
*
* Within the bounding box, a fine-grained polygon around the
- * recognized text.
+ * recognized item.
*
* Within the bounding box, a fine-grained polygon around the recognized
- * text.
+ * item.
*
* Within the bounding box, a fine-grained polygon around the
- * recognized text.
+ * recognized item.
*
* Within the bounding box, a fine-grained polygon around the recognized
- * text.
+ * item.
*
* Returns a reference to this object so that method calls can be chained
@@ -137,7 +138,7 @@ public void setPolygon(java.util.Collection
* Within the bounding box, a fine-grained polygon around the
- * recognized text.
+ * recognized item.
*
* Within the bounding box, a fine-grained polygon around the recognized
- * text.
+ * item.
*
* Returns a reference to this object so that method calls can be chained
@@ -163,7 +164,7 @@ public Geometry withPolygon(Point... polygon) {
*
* @param polygon
* Within the bounding box, a fine-grained polygon around the
- * recognized text.
+ * recognized item.
*
- * Words and lines that are related to nearby lines and words. The related
- * information is returned in two Block objects each of type
- *
- * Table and table cell data. A TABLE Block object contains information about a
- * detected table. A CELL Block object is returned for each cell in a table.
+ * Table and table cell data. A TABLE
- * Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT
- * Block object contains information about a selectable element.
+ * Lines and words of text. A LINE
- * Lines and words of text. A LINE Block object contains one or more WORD Block
- * objects.
+ * Selection elements such as check boxes and option buttons (radio buttons) can
+ * be detected in form data and in tables. A SELECTION_ELEMENT
+ *
- * Use the
* For more information, see
* A unique identifier for the text-detection job. The
* Constraints:
* A unique identifier for the text-detection job. The
* Constraints:
* A unique identifier for the text-detection job. The
*
* A unique identifier for the text-detection job. The
* Constraints:
* A unique identifier for the text-detection job. The
*
* A unique identifier for the text-detection job. The
* Returns a reference to this object so that method calls can be chained
@@ -179,7 +189,8 @@ public void setJobId(String jobId) {
* @param jobId
* A unique identifier for the text-detection job. The
*
- * The results of the text analysis operation.
+ * The results of the text-analysis operation.
*
- * A list of warnings that occurred during the document analysis operation.
+ * A list of warnings that occurred during the document-analysis operation.
*
- * The current status of an asynchronous document analysis operation.
+ * The current status of an asynchronous document-analysis operation.
*
* Information about a document that Amazon Textract processed.
@@ -296,11 +301,11 @@ public GetDocumentAnalysisResult withNextToken(String nextToken) {
/**
*
- * The results of the text analysis operation.
+ * The results of the text-analysis operation.
*
- * The results of the text analysis operation.
+ * The results of the text-analysis operation.
*
- * The results of the text analysis operation.
+ * The results of the text-analysis operation.
*
- * The results of the text analysis operation.
+ * The results of the text-analysis operation.
*
- * The results of the text analysis operation.
+ * The results of the text-analysis operation.
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param blocks
- * The results of the text analysis operation.
+ * The results of the text-analysis operation.
*
- * The results of the text analysis operation.
+ * The results of the text-analysis operation.
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param blocks
- * The results of the text analysis operation.
+ * The results of the text-analysis operation.
*
- * A list of warnings that occurred during the document analysis operation.
+ * A list of warnings that occurred during the document-analysis operation.
*
- * A list of warnings that occurred during the document analysis
+ * A list of warnings that occurred during the document-analysis
* operation.
*
- * A list of warnings that occurred during the document analysis operation.
+ * A list of warnings that occurred during the document-analysis operation.
*
- * A list of warnings that occurred during the document analysis
+ * A list of warnings that occurred during the document-analysis
* operation.
*
- * A list of warnings that occurred during the document analysis operation.
+ * A list of warnings that occurred during the document-analysis operation.
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param warnings
- * A list of warnings that occurred during the document analysis
+ * A list of warnings that occurred during the document-analysis
* operation.
*
- * A list of warnings that occurred during the document analysis operation.
+ * A list of warnings that occurred during the document-analysis operation.
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param warnings
- * A list of warnings that occurred during the document analysis
+ * A list of warnings that occurred during the document-analysis
* operation.
*
- * The current status of an asynchronous document analysis operation.
+ * The current status of an asynchronous document-analysis operation.
*
- * The current status of an asynchronous document analysis
+ * The current status of an asynchronous document-analysis
* operation.
*
- * The current status of an asynchronous document analysis operation.
+ * The current status of an asynchronous document-analysis operation.
*
- * The current status of an asynchronous document analysis
+ * The current status of an asynchronous document-analysis
* operation.
*
- * The current status of an asynchronous document analysis operation.
+ * The current status of an asynchronous document-analysis operation.
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param statusMessage
- * The current status of an asynchronous document analysis
+ * The current status of an asynchronous document-analysis
* operation.
*
+ * Returns a reference to this object so that method calls can be chained
+ * together.
+ *
+ * @param analyzeDocumentModelVersion
* A unique identifier for the text detection job. The
* Constraints:
* A unique identifier for the text detection job. The
* Constraints:
* A unique identifier for the text detection job. The
*
* A unique identifier for the text detection job. The
* Constraints:
* A unique identifier for the text detection job. The
*
* A unique identifier for the text detection job. The
* Returns a reference to this object so that method calls can be chained
@@ -160,7 +166,8 @@ public void setJobId(String jobId) {
* @param jobId
* A unique identifier for the text detection job. The
*
- * A list of warnings that occurred during the document text-detection
- * operation.
+ * A list of warnings that occurred during the text-detection operation for
+ * the document.
*
- * The current status of an asynchronous document text-detection operation.
+ * The current status of an asynchronous text-detection operation for the
+ * document.
*
* Information about a document that Amazon Textract processed.
@@ -371,13 +377,13 @@ public GetDocumentTextDetectionResult withBlocks(java.util.Collection
- * A list of warnings that occurred during the document text-detection
- * operation.
+ * A list of warnings that occurred during the text-detection operation for
+ * the document.
*
- * A list of warnings that occurred during the document
- * text-detection operation.
+ * A list of warnings that occurred during the text-detection
+ * operation for the document.
*
- * A list of warnings that occurred during the document text-detection
- * operation.
+ * A list of warnings that occurred during the text-detection operation for
+ * the document.
*
- * A list of warnings that occurred during the document
- * text-detection operation.
+ * A list of warnings that occurred during the text-detection
+ * operation for the document.
*
- * A list of warnings that occurred during the document text-detection
- * operation.
+ * A list of warnings that occurred during the text-detection operation for
+ * the document.
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param warnings
- * A list of warnings that occurred during the document
- * text-detection operation.
+ * A list of warnings that occurred during the text-detection
+ * operation for the document.
*
- * A list of warnings that occurred during the document text-detection
- * operation.
+ * A list of warnings that occurred during the text-detection operation for
+ * the document.
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param warnings
- * A list of warnings that occurred during the document
- * text-detection operation.
+ * A list of warnings that occurred during the text-detection
+ * operation for the document.
*
- * The current status of an asynchronous document text-detection operation.
+ * The current status of an asynchronous text-detection operation for the
+ * document.
*
- * The current status of an asynchronous document text-detection
- * operation.
+ * The current status of an asynchronous text-detection operation
+ * for the document.
*
- * The current status of an asynchronous document text-detection operation.
+ * The current status of an asynchronous text-detection operation for the
+ * document.
*
- * The current status of an asynchronous document text-detection
- * operation.
+ * The current status of an asynchronous text-detection operation
+ * for the document.
*
- * The current status of an asynchronous document text-detection operation.
+ * The current status of an asynchronous text-detection operation for the
+ * document.
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param statusMessage
- * The current status of an asynchronous document text-detection
- * operation.
+ * The current status of an asynchronous text-detection operation
+ * for the document.
*
+ * Returns a reference to this object so that method calls can be chained
+ * together.
+ *
+ * @param detectDocumentTextModelVersion
+ * Shows the results of the human in the loop evaluation. If there is no
+ * HumanLoopArn, the input did not trigger human review.
+ *
+ * The Amazon Resource Name (ARN) of the HumanLoop created.
+ *
+ * Constraints:
+ * Shows if and why human review was needed.
+ *
+ * Shows the result of condition evaluations, including those conditions
+ * which activated a human review.
+ *
+ * Constraints:
+ * The Amazon Resource Name (ARN) of the HumanLoop created.
+ *
+ * Constraints:
+ * The Amazon Resource Name (ARN) of the HumanLoop created.
+ *
+ * The Amazon Resource Name (ARN) of the HumanLoop created.
+ *
+ * Constraints:
+ * The Amazon Resource Name (ARN) of the HumanLoop created.
+ *
+ * The Amazon Resource Name (ARN) of the HumanLoop created.
+ *
+ * Returns a reference to this object so that method calls can be chained
+ * together.
+ *
+ * Constraints:
+ * The Amazon Resource Name (ARN) of the HumanLoop created.
+ *
+ * Shows if and why human review was needed.
+ *
+ * Shows if and why human review was needed.
+ *
+ * Shows if and why human review was needed.
+ *
+ * Shows if and why human review was needed.
+ *
+ * Shows if and why human review was needed.
+ *
+ * Returns a reference to this object so that method calls can be chained
+ * together.
+ *
+ * @param humanLoopActivationReasons
+ * Shows if and why human review was needed.
+ *
+ * Shows if and why human review was needed.
+ *
+ * Returns a reference to this object so that method calls can be chained
+ * together.
+ *
+ * @param humanLoopActivationReasons
+ * Shows if and why human review was needed.
+ *
+ * Shows the result of condition evaluations, including those conditions
+ * which activated a human review.
+ *
+ * Constraints:
+ * Shows the result of condition evaluations, including those
+ * conditions which activated a human review.
+ *
+ * Shows the result of condition evaluations, including those conditions
+ * which activated a human review.
+ *
+ * Constraints:
+ * Shows the result of condition evaluations, including those
+ * conditions which activated a human review.
+ *
+ * Shows the result of condition evaluations, including those conditions
+ * which activated a human review.
+ *
+ * Returns a reference to this object so that method calls can be chained
+ * together.
+ *
+ * Constraints:
+ * Shows the result of condition evaluations, including those
+ * conditions which activated a human review.
+ *
+ * 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.
+ *
+ * The name of the human workflow used for this image. This should be kept
+ * unique within a region.
+ *
+ * Constraints:
+ * The Amazon Resource Name (ARN) of the flow definition.
+ *
+ * Constraints:
+ * Sets attributes of the input data.
+ *
+ * The name of the human workflow used for this image. This should be kept
+ * unique within a region.
+ *
+ * Constraints:
+ * The name of the human workflow used for this image. This should
+ * be kept unique within a region.
+ *
+ * The name of the human workflow used for this image. This should be kept
+ * unique within a region.
+ *
+ * Constraints:
+ * The name of the human workflow used for this image. This
+ * should be kept unique within a region.
+ *
+ * The name of the human workflow used for this image. This should be kept
+ * unique within a region.
+ *
+ * Returns a reference to this object so that method calls can be chained
+ * together.
+ *
+ * Constraints:
+ * The name of the human workflow used for this image. This
+ * should be kept unique within a region.
+ *
+ * The Amazon Resource Name (ARN) of the flow definition.
+ *
+ * Constraints:
+ * The Amazon Resource Name (ARN) of the flow definition.
+ *
+ * The Amazon Resource Name (ARN) of the flow definition.
+ *
+ * Constraints:
+ * The Amazon Resource Name (ARN) of the flow definition.
+ *
+ * The Amazon Resource Name (ARN) of the flow definition.
+ *
+ * Returns a reference to this object so that method calls can be chained
+ * together.
+ *
+ * Constraints:
+ * The Amazon Resource Name (ARN) of the flow definition.
+ *
+ * Sets attributes of the input data.
+ *
+ * Sets attributes of the input data.
+ *
+ * Sets attributes of the input data.
+ *
+ * Sets attributes of the input data.
+ *
+ * Sets attributes of the input data.
+ *
+ * Returns a reference to this object so that method calls can be chained
+ * together.
+ *
+ * @param dataAttributes
+ * Sets attributes of the input data.
+ *
+ * Allows you to set attributes of the image. Currently, you can declare an
+ * image as free of personally identifiable information and adult content.
+ *
+ * Sets whether the input image is free of personally identifiable
+ * information or adult content.
+ *
+ * Sets whether the input image is free of personally identifiable
+ * information or adult content.
+ *
+ * Sets whether the input image is free of personally identifiable
+ * information or adult content.
+ *
+ * Sets whether the input image is free of personally identifiable
+ * information or adult content.
+ *
+ * Sets whether the input image is free of personally
+ * identifiable information or adult content.
+ *
+ * Sets whether the input image is free of personally identifiable
+ * information or adult content.
+ *
+ * Returns a reference to this object so that method calls can be chained
+ * together.
+ *
+ * @param contentClassifiers
+ * Sets whether the input image is free of personally
+ * identifiable information or adult content.
+ *
+ * Sets whether the input image is free of personally identifiable
+ * information or adult content.
+ *
+ * Returns a reference to this object so that method calls can be chained
+ * together.
+ *
+ * @param contentClassifiers
+ * Sets whether the input image is free of personally
+ * identifiable information or adult content.
+ *
+ * Indicates you have exceeded the maximum number of active human in the loop
+ * workflows available
+ *
* 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.
+ * 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
* The type of relationship that the blocks in the IDs array have with the
* current block. The relationship can be
* Constraints:
* The type of relationship that the blocks in the IDs array have with the
* current block. The relationship can be
* Constraints:
* The type of relationship that the blocks in the IDs array have
* with the current block. The relationship can be
- *
* The type of relationship that the blocks in the IDs array have with the
* current block. The relationship can be
* Constraints:
* The type of relationship that the blocks in the IDs array have
* with the current block. The relationship can be
- *
* The type of relationship that the blocks in the IDs array have with the
* current block. The relationship can be
* Returns a reference to this object so that method calls can be chained
@@ -107,7 +126,11 @@ public void setType(String type) {
* @param type
* The type of relationship that the blocks in the IDs array have
* with the current block. The relationship can be
- *
* The type of relationship that the blocks in the IDs array have with the
* current block. The relationship can be
* Constraints:
* The type of relationship that the blocks in the IDs array have
* with the current block. The relationship can be
- *
* The type of relationship that the blocks in the IDs array have with the
* current block. The relationship can be
* Returns a reference to this object so that method calls can be chained
@@ -155,7 +188,11 @@ public void setType(RelationshipType type) {
* @param type
* The type of relationship that the blocks in the IDs array have
* with the current block. The relationship can be
- *
- * The file name of the input document. It must be an image file (.JPG or
- * .PNG format). Asynchronous operations also support PDF files.
+ * 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 format files.
*
* Constraints:
- * The file name of the input document. It must be an image file (.JPG or
- * .PNG format). Asynchronous operations also support PDF files.
+ * 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 format files.
*
* Constraints:
- * The file name of the input document. It must be an image file
- * (.JPG or .PNG format). Asynchronous operations also support PDF
- * files.
+ * 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 format files.
*
- * The file name of the input document. It must be an image file (.JPG or
- * .PNG format). Asynchronous operations also support PDF files.
+ * 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 format files.
*
* Constraints:
- * The file name of the input document. It must be an image file
- * (.JPG or .PNG format). Asynchronous operations also support
- * PDF files.
+ * 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 format files.
*
- * The file name of the input document. It must be an image file (.JPG or
- * .PNG format). Asynchronous operations also support PDF files.
+ * 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 format files.
*
* Returns a reference to this object so that method calls can be chained
@@ -176,9 +180,9 @@ public void setName(String name) {
* Pattern: .*\S.*
- * The file name of the input document. It must be an image file
- * (.JPG or .PNG format). Asynchronous operations also support
- * PDF files.
+ * 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 format files.
*
- * Starts asynchronous analysis of an input document for relationships between
- * detected items such as key and value pairs, tables, and selection elements.
+ * Starts the asynchronous analysis of an input document for relationships
+ * between detected items such as key-value pairs, tables, and selection
+ * elements.
*
*
* 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 fields and the associated text. To
- * perform both types of analysis, add TABLES and FORMS to
- *
* Constraints:
- * An identifier you specify that's included in the completion notification
- * that's published to the Amazon SNS topic. For example, you can use
- *
* Constraints:
* 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 fields and the associated text. To
- * perform both types of analysis, add TABLES and FORMS to
- *
* 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 fields and the
- * associated text. To perform both types of analysis, add TABLES
- * and FORMS to
* 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 fields and the associated text. To
- * perform both types of analysis, add TABLES and FORMS to
- *
* 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 fields and
- * the associated text. To perform both types of analysis, add
- * TABLES and FORMS to
* 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 fields and the associated text. To
- * perform both types of analysis, add TABLES and FORMS to
- *
* Returns a reference to this object so that method calls can be chained
@@ -222,11 +225,11 @@ public void setFeatureTypes(java.util.Collection
* 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 fields and
- * the associated text. To perform both types of analysis, add
- * TABLES and FORMS to
* 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 fields and the associated text. To
- * perform both types of analysis, add TABLES and FORMS to
- *
* Returns a reference to this object so that method calls can be chained
@@ -258,11 +261,11 @@ public StartDocumentAnalysisRequest withFeatureTypes(String... featureTypes) {
* @param featureTypes
* 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 fields and
- * the associated text. To perform both types of analysis, add
- * TABLES and FORMS to
* Constraints:
* Constraints:
* Returns a reference to this object so that method calls can be chained
@@ -346,7 +361,10 @@ public void setClientRequestToken(String clientRequestToken) {
*
- * An identifier you specify that's included in the completion notification
- * that's published to the Amazon SNS topic. For example, you can use
- *
* Constraints:
- * An identifier you specify that's included in the completion
- * notification that's published to the Amazon SNS topic. For
- * example, you can use
- * An identifier you specify that's included in the completion notification
- * that's published to the Amazon SNS topic. For example, you can use
- *
* Constraints:
- * An identifier you specify that's included in the completion
- * notification that's published to the Amazon SNS topic. For
+ * An identifier that you specify that's included in the
+ * completion notification published to the Amazon SNS topic. For
* example, you can use
- * An identifier you specify that's included in the completion notification
- * that's published to the Amazon SNS topic. For example, you can use
- *
* Returns a reference to this object so that method calls can be chained
@@ -420,11 +438,11 @@ public void setJobTag(String jobTag) {
* Pattern: [a-zA-Z0-9_.\-:]+
- * An identifier you specify that's included in the completion
- * notification that's published to the Amazon SNS topic. For
+ * An identifier that you specify that's included in the
+ * completion notification published to the Amazon SNS topic. For
* example, you can use
* The identifier for the document text detection job. Use
*
* Constraints:
* The identifier for the document text detection job. Use
*
* Constraints:
* The identifier for the document text detection job. Use
*
* The identifier for the document text detection job. Use
*
* Constraints:
* The identifier for the document text detection job. Use
*
* The identifier for the document text detection job. Use
*
* Returns a reference to this object so that method calls can be chained
@@ -90,7 +96,8 @@ public void setJobId(String jobId) {
* @param jobId
* The identifier for the document text detection job. Use
*
*
* Constraints:
- * An identifier you specify that's included in the completion notification
- * that's published to the Amazon SNS topic. For example, you can use
- *
* Constraints:
* Constraints:
* Constraints:
* Returns a reference to this object so that method calls can be chained
@@ -212,7 +226,10 @@ public void setClientRequestToken(String clientRequestToken) {
*
- * An identifier you specify that's included in the completion notification
- * that's published to the Amazon SNS topic. For example, you can use
- *
* Constraints:
- * An identifier you specify that's included in the completion
- * notification that's published to the Amazon SNS topic. For
- * example, you can use
- * An identifier you specify that's included in the completion notification
- * that's published to the Amazon SNS topic. For example, you can use
- *
* Constraints:
- * An identifier you specify that's included in the completion
- * notification that's published to the Amazon SNS topic. For
+ * An identifier that you specify that's included in the
+ * completion notification published to the Amazon SNS topic. For
* example, you can use
- * An identifier you specify that's included in the completion notification
- * that's published to the Amazon SNS topic. For example, you can use
- *
* Returns a reference to this object so that method calls can be chained
@@ -286,11 +303,11 @@ public void setJobTag(String jobTag) {
* Pattern: [a-zA-Z0-9_.\-:]+
- * An identifier you specify that's included in the completion
- * notification that's published to the Amazon SNS topic. For
+ * An identifier that you specify that's included in the
+ * completion notification published to the Amazon SNS topic. For
* example, you can use
- * The identifier for the document text-detection job. Use
+ * The identifier of the text detection job for the document. Use
*
* Constraints:
- * The identifier for the document text-detection job. Use
+ * The identifier of the text detection job for the document. Use
*
* Constraints:
- * The identifier for the document text-detection job. Use
+ * The identifier of the text detection job for the document. Use
*
- * The identifier for the document text-detection job. Use
+ * The identifier of the text detection job for the document. Use
*
* Constraints:
- * The identifier for the document text-detection job. Use
+ * The identifier of the text detection job for the document. Use
*
- * The identifier for the document text-detection job. Use
+ * The identifier of the text detection job for the document. Use
*
* Returns a reference to this object so that method calls can be chained
@@ -88,9 +94,10 @@ public void setJobId(String jobId) {
* Pattern: ^[a-zA-Z0-9-_]+$
- * The identifier for the document text-detection job. Use
+ * The identifier of the text detection job for the document. Use
*
- * The format of the input document isn't supported. Amazon Textract supports
- * documents that are .png or .jpg format.
+ * The format of the input document isn't supported. Documents for synchronous
+ * operations can be in PNG or JPEG format. Documents for asynchronous
+ * operations can also be in PDF format.
*
* A warning about an issue that occurred during asynchronous text analysis
- * (StartDocumentAnalysis) or asynchronous document-text detection
+ * (StartDocumentAnalysis) or asynchronous document text detection
* (StartDocumentTextDetection).
* AnalyzeDocument
is a synchronous operation. To analyze
@@ -98,6 +99,7 @@ public interface AmazonTextractAsync extends AmazonTextract {
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws ThrottlingException
+ * @throws HumanLoopQuotaExceededException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
@@ -119,40 +121,41 @@ Future
*
* KEY_VALUE_SET
: a KEY Block object and a VALUE Block object.
- * For example, Name: Ana Silva Carolina contains a key and value.
+ * Form data (key-value pairs). The related information is returned in two
+ * Block objects, each of type KEY_VALUE_SET
: a KEY
+ * Block
object and a VALUE Block
object. For
+ * example, Name: Ana Silva Carolina contains a key and value.
* Name: is the key. Ana Silva Carolina is the value.
* Block
object contains
+ * information about a detected table. A CELL Block
object is
+ * returned for each cell in a table.
* Block
object contains one or
+ * more WORD Block
objects. All lines and words that are
+ * detected in the document are returned (including text that doesn't have a
+ * relationship with the value of FeatureTypes
).
* Block
object contains information about a selection element,
+ * including the selection status.
* FeatureTypes
list.
* BLOCK
objects.
+ * The output is returned in a list of Block
objects.
* AnalyzeDocument
is a synchronous operation. To analyze
@@ -180,6 +183,7 @@ FutureDetectDocumentText
returns
- * the detected text in an array of Block objects.
+ * be an image in JPEG or PNG format. DetectDocumentText
+ * returns the detected text in an array of Block objects.
* Block
of type PAGE.
@@ -247,8 +251,8 @@ FutureDetectDocumentText
returns
- * the detected text in an array of Block objects.
+ * be an image in JPEG or PNG format. DetectDocumentText
+ * returns the detected text in an array of Block objects.
* Block
of type PAGE.
@@ -323,37 +327,39 @@ Future
*
* KEY_VALUE_SET
: a KEY Block object and a VALUE Block object.
- * For example, Name: Ana Silva Carolina contains a key and value.
+ * Form data (key-value pairs). The related information is returned in two
+ * Block objects, each of type KEY_VALUE_SET
: a KEY
+ * Block
object and a VALUE Block
object. For
+ * example, Name: Ana Silva Carolina contains a key and value.
* Name: is the key. Ana Silva Carolina is the value.
* Block
object contains
+ * information about a detected table. A CELL Block
object is
+ * returned for each cell in a table.
* Block
object contains one or
+ * more WORD Block
objects. All lines and words that are
+ * detected in the document are returned (including text that doesn't have a
+ * relationship with the value of the StartDocumentAnalysis
+ * FeatureTypes
input parameter).
* Block
object contains information about a selection element,
+ * including the selection status.
* MaxResults
parameter to limit the number of blocks
- * returned. If there are more results than specified in
+ * that are returned. If there are more results than specified in
* MaxResults
, the value of NextToken
in the
* operation response contains a pagination token for getting the next set
* of results. To get the next page of results, call
@@ -414,37 +420,39 @@ Future
*
* KEY_VALUE_SET
: a KEY Block object and a VALUE Block object.
- * For example, Name: Ana Silva Carolina contains a key and value.
+ * Form data (key-value pairs). The related information is returned in two
+ * Block objects, each of type KEY_VALUE_SET
: a KEY
+ * Block
object and a VALUE Block
object. For
+ * example, Name: Ana Silva Carolina contains a key and value.
* Name: is the key. Ana Silva Carolina is the value.
* Block
object contains
+ * information about a detected table. A CELL Block
object is
+ * returned for each cell in a table.
* Block
object contains one or
+ * more WORD Block
objects. All lines and words that are
+ * detected in the document are returned (including text that doesn't have a
+ * relationship with the value of the StartDocumentAnalysis
+ * FeatureTypes
input parameter).
* Block
object contains information about a selection element,
+ * including the selection status.
* MaxResults
parameter to limit the number of blocks
- * returned. If there are more results than specified in
+ * that are returned. If there are more results than specified in
* MaxResults
, the value of NextToken
in the
* operation response contains a pagination token for getting the next set
* of results. To get the next page of results, call
@@ -630,13 +638,13 @@ FutureStartDocumentAnalysis
can analyze text in documents that are
- * in JPG, PNG, and PDF format. The documents are stored in an Amazon S3
+ * in JPEG, PNG, and PDF format. The documents are stored in an Amazon S3
* bucket. Use DocumentLocation to specify the bucket name and file
* name of the document.
* StartDocumentAnalysis
can analyze text in documents that are
- * in JPG, PNG, and PDF format. The documents are stored in an Amazon S3
+ * in JPEG, PNG, and PDF format. The documents are stored in an Amazon S3
* bucket. Use DocumentLocation to specify the bucket name and file
* name of the document.
* StartDocumentTextDetection
can analyze text in documents
- * that are in JPG, PNG, and PDF format. The documents are stored in an
+ * that are in JPEG, PNG, and PDF format. The documents are stored in an
* Amazon S3 bucket. Use DocumentLocation to specify the bucket name
* and file name of the document.
* StartDocumentTextDetection
can analyze text in documents
- * that are in JPG, PNG, and PDF format. The documents are stored in an
+ * that are in JPEG, PNG, and PDF format. The documents are stored in an
* Amazon S3 bucket. Use DocumentLocation to specify the bucket name
* and file name of the document.
*
*
* KEY_VALUE_SET
: a KEY Block object and a VALUE Block object.
- * For example, Name: Ana Silva Carolina contains a key and value.
+ * Form data (key-value pairs). The related information is returned in two
+ * Block objects, each of type KEY_VALUE_SET
: a KEY
+ * Block
object and a VALUE Block
object. For
+ * example, Name: Ana Silva Carolina contains a key and value.
* Name: is the key. Ana Silva Carolina is the value.
* Block
object contains
+ * information about a detected table. A CELL Block
object is
+ * returned for each cell in a table.
* Block
object contains one or
+ * more WORD Block
objects. All lines and words that are
+ * detected in the document are returned (including text that doesn't have a
+ * relationship with the value of FeatureTypes
).
* Block
object contains information about a selection element,
+ * including the selection status.
* FeatureTypes
list.
* BLOCK
objects.
+ * The output is returned in a list of Block
objects.
* AnalyzeDocument
is a synchronous operation. To analyze
@@ -324,6 +325,7 @@ public void shutdown() {
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws ThrottlingException
+ * @throws HumanLoopQuotaExceededException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
@@ -352,40 +354,41 @@ public AnalyzeDocumentResult call() throws Exception {
*
*
* KEY_VALUE_SET
: a KEY Block object and a VALUE Block object.
- * For example, Name: Ana Silva Carolina contains a key and value.
+ * Form data (key-value pairs). The related information is returned in two
+ * Block objects, each of type KEY_VALUE_SET
: a KEY
+ * Block
object and a VALUE Block
object. For
+ * example, Name: Ana Silva Carolina contains a key and value.
* Name: is the key. Ana Silva Carolina is the value.
* Block
object contains
+ * information about a detected table. A CELL Block
object is
+ * returned for each cell in a table.
* Block
object contains one or
+ * more WORD Block
objects. All lines and words that are
+ * detected in the document are returned (including text that doesn't have a
+ * relationship with the value of FeatureTypes
).
* Block
object contains information about a selection element,
+ * including the selection status.
* FeatureTypes
list.
* BLOCK
objects.
+ * The output is returned in a list of Block
objects.
* AnalyzeDocument
is a synchronous operation. To analyze
@@ -409,6 +412,7 @@ public AnalyzeDocumentResult call() throws Exception {
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws ThrottlingException
+ * @throws HumanLoopQuotaExceededException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
@@ -440,8 +444,8 @@ public AnalyzeDocumentResult call() throws Exception {
* DetectDocumentText
returns
- * the detected text in an array of Block objects.
+ * be an image in JPEG or PNG format. DetectDocumentText
+ * returns the detected text in an array of Block objects.
* Block
of type PAGE.
@@ -496,8 +500,8 @@ public DetectDocumentTextResult call() throws Exception {
* DetectDocumentText
returns
- * the detected text in an array of Block objects.
+ * be an image in JPEG or PNG format. DetectDocumentText
+ * returns the detected text in an array of Block objects.
* Block
of type PAGE.
@@ -582,37 +586,39 @@ public DetectDocumentTextResult call() throws Exception {
*
*
* KEY_VALUE_SET
: a KEY Block object and a VALUE Block object.
- * For example, Name: Ana Silva Carolina contains a key and value.
+ * Form data (key-value pairs). The related information is returned in two
+ * Block objects, each of type KEY_VALUE_SET
: a KEY
+ * Block
object and a VALUE Block
object. For
+ * example, Name: Ana Silva Carolina contains a key and value.
* Name: is the key. Ana Silva Carolina is the value.
* Block
object contains
+ * information about a detected table. A CELL Block
object is
+ * returned for each cell in a table.
* Block
object contains one or
+ * more WORD Block
objects. All lines and words that are
+ * detected in the document are returned (including text that doesn't have a
+ * relationship with the value of the StartDocumentAnalysis
+ * FeatureTypes
input parameter).
* Block
object contains information about a selection element,
+ * including the selection status.
* MaxResults
parameter to limit the number of blocks
- * returned. If there are more results than specified in
+ * that are returned. If there are more results than specified in
* MaxResults
, the value of NextToken
in the
* operation response contains a pagination token for getting the next set
* of results. To get the next page of results, call
@@ -679,37 +685,39 @@ public GetDocumentAnalysisResult call() throws Exception {
*
*
* KEY_VALUE_SET
: a KEY Block object and a VALUE Block object.
- * For example, Name: Ana Silva Carolina contains a key and value.
+ * Form data (key-value pairs). The related information is returned in two
+ * Block objects, each of type KEY_VALUE_SET
: a KEY
+ * Block
object and a VALUE Block
object. For
+ * example, Name: Ana Silva Carolina contains a key and value.
* Name: is the key. Ana Silva Carolina is the value.
* Block
object contains
+ * information about a detected table. A CELL Block
object is
+ * returned for each cell in a table.
* Block
object contains one or
+ * more WORD Block
objects. All lines and words that are
+ * detected in the document are returned (including text that doesn't have a
+ * relationship with the value of the StartDocumentAnalysis
+ * FeatureTypes
input parameter).
* Block
object contains information about a selection element,
+ * including the selection status.
* MaxResults
parameter to limit the number of blocks
- * returned. If there are more results than specified in
+ * that are returned. If there are more results than specified in
* MaxResults
, the value of NextToken
in the
* operation response contains a pagination token for getting the next set
* of results. To get the next page of results, call
@@ -921,13 +929,13 @@ public GetDocumentTextDetectionResult call() throws Exception {
/**
* StartDocumentAnalysis
can analyze text in documents that are
- * in JPG, PNG, and PDF format. The documents are stored in an Amazon S3
+ * in JPEG, PNG, and PDF format. The documents are stored in an Amazon S3
* bucket. Use DocumentLocation to specify the bucket name and file
* name of the document.
* StartDocumentAnalysis
can analyze text in documents that are
- * in JPG, PNG, and PDF format. The documents are stored in an Amazon S3
+ * in JPEG, PNG, and PDF format. The documents are stored in an Amazon S3
* bucket. Use DocumentLocation to specify the bucket name and file
* name of the document.
* StartDocumentTextDetection
can analyze text in documents
- * that are in JPG, PNG, and PDF format. The documents are stored in an
+ * that are in JPEG, PNG, and PDF format. The documents are stored in an
* Amazon S3 bucket. Use DocumentLocation to specify the bucket name
* and file name of the document.
* StartDocumentTextDetection
can analyze text in documents
- * that are in JPG, PNG, and PDF format. The documents are stored in an
+ * that are in JPEG, PNG, and PDF format. The documents are stored in an
* Amazon S3 bucket. Use DocumentLocation to specify the bucket name
* and file name of the document.
*
*
* KEY_VALUE_SET
: a KEY Block object and a VALUE Block object.
- * For example, Name: Ana Silva Carolina contains a key and value.
+ * Form data (key-value pairs). The related information is returned in two
+ * Block objects, each of type KEY_VALUE_SET
: a KEY
+ * Block
object and a VALUE Block
object. For
+ * example, Name: Ana Silva Carolina contains a key and value.
* Name: is the key. Ana Silva Carolina is the value.
* Block
object contains
+ * information about a detected table. A CELL Block
object is
+ * returned for each cell in a table.
* Block
object contains one or
+ * more WORD Block
objects. All lines and words that are
+ * detected in the document are returned (including text that doesn't have a
+ * relationship with the value of FeatureTypes
).
* Block
object contains information about a selection element,
+ * including the selection status.
* FeatureTypes
list.
* BLOCK
objects.
+ * The output is returned in a list of Block
objects.
* AnalyzeDocument
is a synchronous operation. To analyze
@@ -423,6 +425,7 @@ private static ClientConfiguration adjustClientConfiguration(ClientConfiguration
* @throws ProvisionedThroughputExceededException
* @throws InternalServerErrorException
* @throws ThrottlingException
+ * @throws HumanLoopQuotaExceededException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
@@ -464,8 +467,8 @@ public AnalyzeDocumentResult analyzeDocument(AnalyzeDocumentRequest analyzeDocum
* DetectDocumentText
returns
- * the detected text in an array of Block objects.
+ * be an image in JPEG or PNG format. DetectDocumentText
+ * returns the detected text in an array of Block objects.
* Block
of type PAGE.
@@ -561,37 +564,39 @@ public DetectDocumentTextResult detectDocumentText(
*
*
* KEY_VALUE_SET
: a KEY Block object and a VALUE Block object.
- * For example, Name: Ana Silva Carolina contains a key and value.
+ * Form data (key-value pairs). The related information is returned in two
+ * Block objects, each of type KEY_VALUE_SET
: a KEY
+ * Block
object and a VALUE Block
object. For
+ * example, Name: Ana Silva Carolina contains a key and value.
* Name: is the key. Ana Silva Carolina is the value.
* Block
object contains
+ * information about a detected table. A CELL Block
object is
+ * returned for each cell in a table.
* Block
object contains one or
+ * more WORD Block
objects. All lines and words that are
+ * detected in the document are returned (including text that doesn't have a
+ * relationship with the value of the StartDocumentAnalysis
+ * FeatureTypes
input parameter).
* Block
object contains information about a selection element,
+ * including the selection status.
* MaxResults
parameter to limit the number of blocks
- * returned. If there are more results than specified in
+ * that are returned. If there are more results than specified in
* MaxResults
, the value of NextToken
in the
* operation response contains a pagination token for getting the next set
* of results. To get the next page of results, call
@@ -752,13 +757,13 @@ public GetDocumentTextDetectionResult getDocumentTextDetection(
/**
* StartDocumentAnalysis
can analyze text in documents that are
- * in JPG, PNG, and PDF format. The documents are stored in an Amazon S3
+ * in JPEG, PNG, and PDF format. The documents are stored in an Amazon S3
* bucket. Use DocumentLocation to specify the bucket name and file
* name of the document.
* StartDocumentTextDetection
can analyze text in documents
- * that are in JPG, PNG, and PDF format. The documents are stored in an
+ * that are in JPEG, PNG, and PDF format. The documents are stored in an
* Amazon S3 bucket. Use DocumentLocation to specify the bucket name
* and file name of the document.
*
*
* KEY_VALUE_SET
: a KEY Block object and a VALUE Block object. For
- * example, Name: Ana Silva Carolina contains a key and value.
- * Name: is the key. Ana Silva Carolina is the value.
+ * Form data (key-value pairs). The related information is returned in two
+ * Block objects, each of type KEY_VALUE_SET
: a KEY
+ * Block
object and a VALUE Block
object. For example,
+ * Name: Ana Silva Carolina contains a key and value. Name: is the
+ * key. Ana Silva Carolina is the value.
* Block
object contains
+ * information about a detected table. A CELL Block
object is
+ * returned for each cell in a table.
* Block
object contains one or
+ * more WORD Block
objects. All lines and words that are detected
+ * in the document are returned (including text that doesn't have a relationship
+ * with the value of FeatureTypes
).
* Block
object contains information about a selection element,
+ * including the selection status.
* FeatureTypes
list.
* BLOCK
objects.
+ * The output is returned in a list of Block
objects.
* AnalyzeDocument
is a synchronous operation. To analyze documents
@@ -77,11 +80,12 @@ public class AnalyzeDocumentRequest extends AmazonWebServiceRequest implements S
* Bytes
field.
+ * 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.
* FeatureTypes
.
+ * 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
).
* Bytes
field.
+ * 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.
* Bytes
field.
* Bytes
field.
+ * 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.
* Bytes
field.
+ * 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.
* Bytes
field.
+ * 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.
* Bytes
field.
+ * 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.
* FeatureTypes
.
+ * 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
).
* FeatureTypes
.
+ * 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
).
* FeatureTypes
.
+ * 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
).
* FeatureTypes
.
+ * 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
).
* FeatureTypes
.
+ * 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
).
* FeatureTypes
.
+ * 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
).
* FeatureTypes
.
+ * 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
).
* FeatureTypes
.
+ * 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
).
* AnalyzeDocument
.
+ * The items that are detected and analyzed by AnalyzeDocument
.
* AnalyzeDocument
.
+ * The items that are detected and analyzed by AnalyzeDocument
.
* AnalyzeDocument
.
* AnalyzeDocument
.
+ * The items that are detected and analyzed by AnalyzeDocument
.
* AnalyzeDocument
.
* AnalyzeDocument
.
+ * The items that are detected and analyzed by AnalyzeDocument
.
* AnalyzeDocument
.
* AnalyzeDocument
.
+ * The items that are detected and analyzed by AnalyzeDocument
.
* AnalyzeDocument
.
* 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
+ * 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.
+ * tables, and selection elements that are detected in the document.
* Block
objects is returned by both synchronous and
@@ -43,14 +43,14 @@
public class Block implements Serializable {
/**
*
*
@@ -72,36 +72,35 @@ public class Block implements Serializable {
* Block
objects that
+ * are detected on a document page.
*
*
@@ -128,8 +127,9 @@ public class Block implements Serializable {
/**
* Block
objects that
+ * are detected on a document page.
* EntityType
field
- * to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE
- * Block object.
+ * 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.
* SelectionStatus
to determine the status of the selection
- * element.
+ * 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.
*
@@ -171,9 +171,10 @@ public class Block implements Serializable {
/**
* RowSpan
isn't
- * returned by DetectDocumentText
and
- * GetDocumentTextDetection
.
+ * The number of rows that a table cell spans. Currently this value is
+ * always 1, even if the number of rows spanned is greater than 1.
+ * RowSpan
isn't returned by DetectDocumentText
+ * and GetDocumentTextDetection
.
*
@@ -183,9 +184,10 @@ public class Block implements Serializable {
/**
* ColumnSpan
- * isn't returned by DetectDocumentText
and
- * GetDocumentTextDetection
.
+ * The number of columns that a table cell spans. Currently this value is
+ * always 1, even if the number of columns spanned is greater than 1.
+ * ColumnSpan
isn't returned by DetectDocumentText
+ * and GetDocumentTextDetection
.
*
@@ -215,7 +217,7 @@ public class Block implements Serializable {
/**
*
@@ -273,12 +275,12 @@ public class Block implements Serializable {
/**
* Page
is returned by
+ * The page on which a block was detected. Page
is returned by
* asynchronous operations. Page values greater than 1 are only returned for
- * multi-page documents that are in PDF format. A scanned image (JPG/PNG),
- * even if it contains multiple document pages, is always considered to be a
- * single-page document and the value of Page
is always 1.
- * Synchronous operations don't return Page
as every input
+ * multipage documents that are in PDF format. A scanned image (JPEG/PNG),
+ * even if it contains multiple document pages, is considered to be a
+ * single-page document. The value of Page
is always 1.
+ * Synchronous operations don't return Page
because every input
* document is considered to be a single-page document.
*
*
@@ -318,36 +320,35 @@ public class Block implements Serializable {
* Block
objects that
+ * are detected on a document page.
*
*
@@ -371,14 +372,14 @@ public class Block implements Serializable {
* SELECTION_ELEMENT
*
* @return Block
objects that
+ * are detected on a document page.
* EntityType
field
- * to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE
- * Block object.
+ * 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.
* SelectionStatus
to determine the status of the selection
- * element.
+ * 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.
*
*
@@ -401,36 +402,37 @@ public class Block implements Serializable {
* Block
+ * objects that are detected on a document page.
*
*
@@ -456,14 +458,14 @@ public String getBlockType() {
/**
* Block
objects
+ * that are detected on a document page.
* EntityType
field to determine if a KEY_VALUE_SET
- * object is a KEY Block object or a VALUE Block object.
+ * 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.
* SelectionStatus
to determine the status of
- * the selection element.
+ * 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.
*
*
@@ -485,36 +487,35 @@ public String getBlockType() {
* Block
objects that
+ * are detected on a document page.
*
*
@@ -538,14 +539,14 @@ public String getBlockType() {
* SELECTION_ELEMENT
*
* @param blockType Block
objects that
+ * are detected on a document page.
* EntityType
field
- * to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE
- * Block object.
+ * 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.
* SelectionStatus
to determine the status of the selection
- * element.
+ * 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.
*
*
@@ -568,36 +569,38 @@ public String getBlockType() {
* Block
+ * objects that are detected on a document page.
*
*
@@ -623,14 +626,14 @@ public void setBlockType(String blockType) {
/**
* Block
+ * objects that are detected on a document page.
* EntityType
field to determine if a KEY_VALUE_SET
- * object is a KEY Block object or a VALUE Block object.
+ * 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.
* SelectionStatus
to determine the
- * status of the selection element.
+ * 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.
*
*
@@ -652,36 +655,35 @@ public void setBlockType(String blockType) {
* Block
objects that
+ * are detected on a document page.
*
*
@@ -708,14 +710,14 @@ public void setBlockType(String blockType) {
* SELECTION_ELEMENT
*
* @param blockType Block
objects that
+ * are detected on a document page.
* EntityType
field
- * to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE
- * Block object.
+ * 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.
* SelectionStatus
to determine the status of the selection
- * element.
+ * 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.
*
*
@@ -738,36 +740,38 @@ public void setBlockType(String blockType) {
* Block
+ * objects that are detected on a document page.
*
*
@@ -796,14 +800,14 @@ public Block withBlockType(String blockType) {
/**
* Block
+ * objects that are detected on a document page.
* EntityType
field to determine if a KEY_VALUE_SET
- * object is a KEY Block object or a VALUE Block object.
+ * 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.
* SelectionStatus
to determine the
- * status of the selection element.
+ * 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.
*
*
@@ -825,36 +829,35 @@ public Block withBlockType(String blockType) {
* Block
objects that
+ * are detected on a document page.
*
*
@@ -878,14 +881,14 @@ public Block withBlockType(String blockType) {
* SELECTION_ELEMENT
*
* @param blockType Block
objects that
+ * are detected on a document page.
* EntityType
field
- * to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE
- * Block object.
+ * 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.
* SelectionStatus
to determine the status of the selection
- * element.
+ * 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.
*
*
@@ -908,36 +911,38 @@ public Block withBlockType(String blockType) {
* Block
+ * objects that are detected on a document page.
*
*
@@ -963,14 +968,14 @@ public void setBlockType(BlockType blockType) {
/**
* Block
+ * objects that are detected on a document page.
* EntityType
field to determine if a KEY_VALUE_SET
- * object is a KEY Block object or a VALUE Block object.
+ * 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.
* SelectionStatus
to determine the
- * status of the selection element.
+ * 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.
*
*
@@ -992,36 +997,35 @@ public void setBlockType(BlockType blockType) {
* Block
objects that
+ * are detected on a document page.
*
*
@@ -1048,14 +1052,14 @@ public void setBlockType(BlockType blockType) {
* SELECTION_ELEMENT
*
* @param blockType Block
objects that
+ * are detected on a document page.
* EntityType
field
- * to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE
- * Block object.
+ * 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.
* SelectionStatus
to determine the status of the selection
- * element.
+ * 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.
*
*
@@ -1078,36 +1082,38 @@ public void setBlockType(BlockType blockType) {
* Block
+ * objects that are detected on a document page.
*
*
@@ -1136,17 +1142,18 @@ public Block withBlockType(BlockType blockType) {
/**
* Block
+ * objects that are detected on a document page.
* EntityType
field to determine if a KEY_VALUE_SET
- * object is a KEY Block object or a VALUE Block object.
+ * 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.
* SelectionStatus
to determine the
- * status of the selection element.
+ * 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.
*
* Length: 0 - 100
*
* @return
* Length: 0 - 100
*
* @param confidence
*
* @param confidence RowSpan
isn't
- * returned by DetectDocumentText
and
- * GetDocumentTextDetection
.
+ * The number of rows that a table cell spans. Currently this value is
+ * always 1, even if the number of rows spanned is greater than 1.
+ * RowSpan
isn't returned by DetectDocumentText
+ * and GetDocumentTextDetection
.
*
* Range: 0 -
*
* @return RowSpan
isn't
- * returned by DetectDocumentText
and
+ * The number of rows that a table cell spans. Currently this value
+ * is always 1, even if the number of rows spanned is greater than
+ * 1. RowSpan
isn't returned by
+ * DetectDocumentText
and
* GetDocumentTextDetection
.
* RowSpan
isn't
- * returned by DetectDocumentText
and
- * GetDocumentTextDetection
.
+ * The number of rows that a table cell spans. Currently this value is
+ * always 1, even if the number of rows spanned is greater than 1.
+ * RowSpan
isn't returned by DetectDocumentText
+ * and GetDocumentTextDetection
.
*
* Range: 0 -
*
* @param rowSpan RowSpan
- * isn't returned by DetectDocumentText
and
+ * The number of rows that a table cell spans. Currently this
+ * value is always 1, even if the number of rows spanned is
+ * greater than 1. RowSpan
isn't returned by
+ * DetectDocumentText
and
* GetDocumentTextDetection
.
* RowSpan
isn't
- * returned by DetectDocumentText
and
- * GetDocumentTextDetection
.
+ * The number of rows that a table cell spans. Currently this value is
+ * always 1, even if the number of rows spanned is greater than 1.
+ * RowSpan
isn't returned by DetectDocumentText
+ * and GetDocumentTextDetection
.
*
*
* @param rowSpan RowSpan
- * isn't returned by DetectDocumentText
and
+ * The number of rows that a table cell spans. Currently this
+ * value is always 1, even if the number of rows spanned is
+ * greater than 1. RowSpan
isn't returned by
+ * DetectDocumentText
and
* GetDocumentTextDetection
.
* ColumnSpan
- * isn't returned by DetectDocumentText
and
- * GetDocumentTextDetection
.
+ * The number of columns that a table cell spans. Currently this value is
+ * always 1, even if the number of columns spanned is greater than 1.
+ * ColumnSpan
isn't returned by DetectDocumentText
+ * and GetDocumentTextDetection
.
*
* Range: 0 -
*
* @return ColumnSpan
isn't returned by
+ * The number of columns that a table cell spans. Currently this
+ * value is always 1, even if the number of columns spanned is
+ * greater than 1. ColumnSpan
isn't returned by
* DetectDocumentText
and
* GetDocumentTextDetection
.
* ColumnSpan
- * isn't returned by DetectDocumentText
and
- * GetDocumentTextDetection
.
+ * The number of columns that a table cell spans. Currently this value is
+ * always 1, even if the number of columns spanned is greater than 1.
+ * ColumnSpan
isn't returned by DetectDocumentText
+ * and GetDocumentTextDetection
.
*
* Range: 0 -
*
* @param columnSpan ColumnSpan
isn't returned by
+ * The number of columns that a table cell spans. Currently this
+ * value is always 1, even if the number of columns spanned is
+ * greater than 1. ColumnSpan
isn't returned by
* DetectDocumentText
and
* GetDocumentTextDetection
.
* ColumnSpan
- * isn't returned by DetectDocumentText
and
- * GetDocumentTextDetection
.
+ * The number of columns that a table cell spans. Currently this value is
+ * always 1, even if the number of columns spanned is greater than 1.
+ * ColumnSpan
isn't returned by DetectDocumentText
+ * and GetDocumentTextDetection
.
*
*
* @param columnSpan ColumnSpan
isn't returned by
+ * The number of columns that a table cell spans. Currently this
+ * value is always 1, even if the number of columns spanned is
+ * greater than 1. ColumnSpan
isn't returned by
* DetectDocumentText
and
* GetDocumentTextDetection
.
*
* Allowed Values: SELECTED, NOT_SELECTED
*
* @return
* Allowed Values: SELECTED, NOT_SELECTED
*
* @param selectionStatus
* Allowed Values: SELECTED, NOT_SELECTED
*
* @param selectionStatus Page
is returned by
+ * The page on which a block was detected. Page
is returned by
* asynchronous operations. Page values greater than 1 are only returned for
- * multi-page documents that are in PDF format. A scanned image (JPG/PNG),
- * even if it contains multiple document pages, is always considered to be a
- * single-page document and the value of Page
is always 1.
- * Synchronous operations don't return Page
as every input
+ * multipage documents that are in PDF format. A scanned image (JPEG/PNG),
+ * even if it contains multiple document pages, is considered to be a
+ * single-page document. The value of Page
is always 1.
+ * Synchronous operations don't return Page
because every input
* document is considered to be a single-page document.
*
*
* @return Page
is
+ * The page on which a block was detected. Page
is
* returned by asynchronous operations. Page values greater than 1
- * are only returned for multi-page documents that are in PDF
- * format. A scanned image (JPG/PNG), even if it contains multiple
- * document pages, is always considered to be a single-page document
- * and the value of Page
is always 1. Synchronous
- * operations don't return Page
as every input document
- * is considered to be a single-page document.
+ * are only returned for multipage documents that are in PDF format.
+ * A scanned image (JPEG/PNG), even if it contains multiple document
+ * pages, is considered to be a single-page document. The value of
+ * Page
is always 1. Synchronous operations don't
+ * return Page
because every input document is
+ * considered to be a single-page document.
* Page
is returned by
+ * The page on which a block was detected. Page
is returned by
* asynchronous operations. Page values greater than 1 are only returned for
- * multi-page documents that are in PDF format. A scanned image (JPG/PNG),
- * even if it contains multiple document pages, is always considered to be a
- * single-page document and the value of Page
is always 1.
- * Synchronous operations don't return Page
as every input
+ * multipage documents that are in PDF format. A scanned image (JPEG/PNG),
+ * even if it contains multiple document pages, is considered to be a
+ * single-page document. The value of Page
is always 1.
+ * Synchronous operations don't return Page
because every input
* document is considered to be a single-page document.
*
*
* @param page Page
is
+ * The page on which a block was detected. Page
is
* returned by asynchronous operations. Page values greater than
- * 1 are only returned for multi-page documents that are in PDF
- * format. A scanned image (JPG/PNG), even if it contains
- * multiple document pages, is always considered to be a
- * single-page document and the value of Page
is
- * always 1. Synchronous operations don't return
- * Page
as every input document is considered to be
- * a single-page document.
+ * 1 are only returned for multipage documents that are in PDF
+ * format. A scanned image (JPEG/PNG), even if it contains
+ * multiple document pages, is considered to be a single-page
+ * document. The value of Page
is always 1.
+ * Synchronous operations don't return Page
because
+ * every input document is considered to be a single-page
+ * document.
* Page
is returned by
+ * The page on which a block was detected. Page
is returned by
* asynchronous operations. Page values greater than 1 are only returned for
- * multi-page documents that are in PDF format. A scanned image (JPG/PNG),
- * even if it contains multiple document pages, is always considered to be a
- * single-page document and the value of Page
is always 1.
- * Synchronous operations don't return Page
as every input
+ * multipage documents that are in PDF format. A scanned image (JPEG/PNG),
+ * even if it contains multiple document pages, is considered to be a
+ * single-page document. The value of Page
is always 1.
+ * Synchronous operations don't return Page
because every input
* document is considered to be a single-page document.
*
*
* @param page Page
is
+ * The page on which a block was detected. Page
is
* returned by asynchronous operations. Page values greater than
- * 1 are only returned for multi-page documents that are in PDF
- * format. A scanned image (JPG/PNG), even if it contains
- * multiple document pages, is always considered to be a
- * single-page document and the value of Page
is
- * always 1. Synchronous operations don't return
- * Page
as every input document is considered to be
- * a single-page document.
+ * 1 are only returned for multipage documents that are in PDF
+ * format. A scanned image (JPEG/PNG), even if it contains
+ * multiple document pages, is considered to be a single-page
+ * document. The value of Page
is always 1.
+ * Synchronous operations don't return Page
because
+ * every input document is considered to be a single-page
+ * document.
* 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 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).
* top
and left
values returned are ratios of the
diff --git a/aws-android-sdk-textract/src/main/java/com/amazonaws/services/textract/model/ContentClassifier.java b/aws-android-sdk-textract/src/main/java/com/amazonaws/services/textract/model/ContentClassifier.java
new file mode 100644
index 00000000000..512cc0f3a20
--- /dev/null
+++ b/aws-android-sdk-textract/src/main/java/com/amazonaws/services/textract/model/ContentClassifier.java
@@ -0,0 +1,63 @@
+/*
+ * Copyright 2010-2019 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.
+ */
+
+package com.amazonaws.services.textract.model;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Content Classifier
+ */
+public enum ContentClassifier {
+
+ FreeOfPersonallyIdentifiableInformation("FreeOfPersonallyIdentifiableInformation"),
+ FreeOfAdultContent("FreeOfAdultContent");
+
+ private String value;
+
+ private ContentClassifier(String value) {
+ this.value = value;
+ }
+
+ @Override
+ public String toString() {
+ return value;
+ }
+
+ private static final MapDetectDocumentText
returns the
+ * image in JPEG or PNG format. DetectDocumentText
returns the
* detected text in an array of Block objects.
* Bytes
field.
+ * 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.
* Bytes
field.
+ * 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.
* Bytes
field.
* Bytes
field.
+ * 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.
* Bytes
field.
+ * 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.
* Bytes
field.
+ * 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.
* Bytes
field.
+ * 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.
* Block
objects that contain the text that's
+ * detected in the document.
* Block
objects that contain the text that's
+ * detected in the document.
* Block
objects that contain the text
+ * that's detected in the document.
* Block
objects that contain the text that's
+ * detected in the document.
* Block
objects that contain the text
+ * that's detected in the document.
* Block
objects that contain the text that's
+ * detected in the document.
* Block
objects that contain the text
+ * that's detected in the document.
* Block
objects that contain the text that's
+ * detected in the document.
* Block
objects that contain the text
+ * that's detected in the document.
* Bytes
field.
+ * 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.
*
- * Length: 1 - 5242880
+ * Length: 1 - 10485760
*/
private java.nio.ByteBuffer bytes;
/**
* Bytes
field.
+ * 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.
*
- * Length: 1 - 5242880
+ * Length: 1 - 10485760
*
* @return Bytes
field.
* Bytes
field.
+ * 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.
*
- * Length: 1 - 5242880
+ * Length: 1 - 10485760
*
* @param bytes Bytes
field.
* Bytes
field.
+ * 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.
*
- * Length: 1 - 5242880
+ * Length: 1 - 10485760
*
* @param bytes Bytes
field.
*
@@ -35,14 +35,14 @@ public class DocumentMetadata implements Serializable {
/**
*
* Range: 0 -
*
* @return
* Range: 0 -
*
* @param pages
*
* @param pages
*
* KEY_VALUE_SET
: a KEY Block object and a VALUE Block object. For
- * example, Name: Ana Silva Carolina contains a key and value.
- * Name: is the key. Ana Silva Carolina is the value.
+ * Form data (key-value pairs). The related information is returned in two
+ * Block objects, each of type KEY_VALUE_SET
: a KEY
+ * Block
object and a VALUE Block
object. For example,
+ * Name: Ana Silva Carolina contains a key and value. Name: is the
+ * key. Ana Silva Carolina is the value.
* Block
object contains
+ * information about a detected table. A CELL Block
object is
+ * returned for each cell in a table.
* Block
object contains one or
+ * more WORD Block
objects. All lines and words that are detected
+ * in the document are returned (including text that doesn't have a relationship
+ * with the value of the StartDocumentAnalysis
+ * FeatureTypes
input parameter).
* Block
object contains information about a selection element,
+ * including the selection status.
* MaxResults
parameter to limit the number of blocks
- * returned. If there are more results than specified in MaxResults
- * , the value of NextToken
in the operation response contains a
- * pagination token for getting the next set of results. To get the next page of
- * results, call GetDocumentAnalysis
, and populate the
- * NextToken
request parameter with the token value that's returned
- * from the previous call to GetDocumentAnalysis
.
+ * Use the MaxResults
parameter to limit the number of blocks that
+ * are returned. If there are more results than specified in
+ * MaxResults
, the value of NextToken
in the operation
+ * response contains a pagination token for getting the next set of results. To
+ * get the next page of results, call GetDocumentAnalysis
, and
+ * populate the NextToken
request parameter with the token value
+ * that's returned from the previous call to GetDocumentAnalysis
.
* JobId
is
- * returned from StartDocumentAnalysis
.
+ * returned from StartDocumentAnalysis
. A JobId
+ * value is only valid for 7 days.
*
@@ -126,7 +131,8 @@ public class GetDocumentAnalysisRequest extends AmazonWebServiceRequest implemen
/**
* JobId
is
- * returned from StartDocumentAnalysis
.
+ * returned from StartDocumentAnalysis
. A JobId
+ * value is only valid for 7 days.
*
@@ -136,7 +142,8 @@ public class GetDocumentAnalysisRequest extends AmazonWebServiceRequest implemen
* @return JobId
is returned from
- * StartDocumentAnalysis
.
+ * StartDocumentAnalysis
. A JobId
value is
+ * only valid for 7 days.
* JobId
is
- * returned from StartDocumentAnalysis
.
+ * returned from StartDocumentAnalysis
. A JobId
+ * value is only valid for 7 days.
*
@@ -156,7 +164,8 @@ public String getJobId() {
* @param jobId JobId
is returned from
- * StartDocumentAnalysis
.
+ * StartDocumentAnalysis
. A JobId
value
+ * is only valid for 7 days.
* JobId
is
- * returned from StartDocumentAnalysis
.
+ * returned from StartDocumentAnalysis
. A JobId
+ * value is only valid for 7 days.
* JobId
is returned from
- * StartDocumentAnalysis
.
+ * StartDocumentAnalysis
. A JobId
value
+ * is only valid for 7 days.
* JobId
is
- * returned from StartDocumentTextDetection
.
+ * returned from StartDocumentTextDetection
. A
+ * JobId
value is only valid for 7 days.
*
@@ -107,7 +108,8 @@ public class GetDocumentTextDetectionRequest extends AmazonWebServiceRequest imp
/**
* JobId
is
- * returned from StartDocumentTextDetection
.
+ * returned from StartDocumentTextDetection
. A
+ * JobId
value is only valid for 7 days.
*
@@ -117,7 +119,8 @@ public class GetDocumentTextDetectionRequest extends AmazonWebServiceRequest imp
* @return JobId
is returned from
- * StartDocumentTextDetection
.
+ * StartDocumentTextDetection
. A JobId
+ * value is only valid for 7 days.
* JobId
is
- * returned from StartDocumentTextDetection
.
+ * returned from StartDocumentTextDetection
. A
+ * JobId
value is only valid for 7 days.
*
@@ -137,7 +141,8 @@ public String getJobId() {
* @param jobId JobId
is returned from
- * StartDocumentTextDetection
.
+ * StartDocumentTextDetection
. A JobId
+ * value is only valid for 7 days.
* JobId
is
- * returned from StartDocumentTextDetection
.
+ * returned from StartDocumentTextDetection
. A
+ * JobId
value is only valid for 7 days.
* JobId
is returned from
- * StartDocumentTextDetection
.
+ * StartDocumentTextDetection
. A JobId
+ * value is only valid for 7 days.
*
+ * Length: - 256
+ */
+ private String humanLoopArn;
+
+ /**
+ *
+ * Length: - 10240
+ */
+ private String humanLoopActivationConditionsEvaluationResults;
+
+ /**
+ *
+ * Length: - 256
+ *
+ * @return
+ * Length: - 256
+ *
+ * @param humanLoopArn
+ * Length: - 256
+ *
+ * @param humanLoopArn
+ * Length: - 10240
+ *
+ * @return
+ * Length: - 10240
+ *
+ * @param humanLoopActivationConditionsEvaluationResults
+ * Length: - 10240
+ *
+ * @param humanLoopActivationConditionsEvaluationResults
+ * Length: 1 - 63
+ * Pattern: ^[a-z0-9](-*[a-z0-9])*
+ */
+ private String humanLoopName;
+
+ /**
+ *
+ * Length: - 256
+ */
+ private String flowDefinitionArn;
+
+ /**
+ *
+ * Length: 1 - 63
+ * Pattern: ^[a-z0-9](-*[a-z0-9])*
+ *
+ * @return
+ * Length: 1 - 63
+ * Pattern: ^[a-z0-9](-*[a-z0-9])*
+ *
+ * @param humanLoopName
+ * Length: 1 - 63
+ * Pattern: ^[a-z0-9](-*[a-z0-9])*
+ *
+ * @param humanLoopName
+ * Length: - 256
+ *
+ * @return
+ * Length: - 256
+ *
+ * @param flowDefinitionArn
+ * Length: - 256
+ *
+ * @param flowDefinitionArn Point
objects, Polygon
, is returned by
diff --git a/aws-android-sdk-textract/src/main/java/com/amazonaws/services/textract/model/Relationship.java b/aws-android-sdk-textract/src/main/java/com/amazonaws/services/textract/model/Relationship.java
index 78c425b6f5a..a165ee4d9e8 100644
--- a/aws-android-sdk-textract/src/main/java/com/amazonaws/services/textract/model/Relationship.java
+++ b/aws-android-sdk-textract/src/main/java/com/amazonaws/services/textract/model/Relationship.java
@@ -33,7 +33,10 @@ public class Relationship implements Serializable {
* VALUE
or
- * CHILD
.
+ * CHILD
. A relationship of type VALUE is a list that contains
+ * the ID of the VALUE block that's associated with the KEY of a key-value
+ * pair. A relationship of type CHILD is a list of IDs that identify WORD
+ * blocks.
*
@@ -53,7 +56,10 @@ public class Relationship implements Serializable {
* VALUE
or
- * CHILD
.
+ * CHILD
. A relationship of type VALUE is a list that contains
+ * the ID of the VALUE block that's associated with the KEY of a key-value
+ * pair. A relationship of type CHILD is a list of IDs that identify WORD
+ * blocks.
*
@@ -62,7 +68,10 @@ public class Relationship implements Serializable {
* @return VALUE
or CHILD
.
+ * VALUE
or CHILD
. A relationship of type
+ * VALUE is a list that contains the ID of the VALUE block that's
+ * associated with the KEY of a key-value pair. A relationship of
+ * type CHILD is a list of IDs that identify WORD blocks.
* VALUE
or
- * CHILD
.
+ * CHILD
. A relationship of type VALUE is a list that contains
+ * the ID of the VALUE block that's associated with the KEY of a key-value
+ * pair. A relationship of type CHILD is a list of IDs that identify WORD
+ * blocks.
*
@@ -83,7 +95,11 @@ public String getType() {
* @param type VALUE
or CHILD
.
+ * VALUE
or CHILD
. A relationship of
+ * type VALUE is a list that contains the ID of the VALUE block
+ * that's associated with the KEY of a key-value pair. A
+ * relationship of type CHILD is a list of IDs that identify WORD
+ * blocks.
* VALUE
or
- * CHILD
.
+ * CHILD
. A relationship of type VALUE is a list that contains
+ * the ID of the VALUE block that's associated with the KEY of a key-value
+ * pair. A relationship of type CHILD is a list of IDs that identify WORD
+ * blocks.
* VALUE
or CHILD
.
+ * VALUE
or CHILD
. A relationship of
+ * type VALUE is a list that contains the ID of the VALUE block
+ * that's associated with the KEY of a key-value pair. A
+ * relationship of type CHILD is a list of IDs that identify WORD
+ * blocks.
* VALUE
or
- * CHILD
.
+ * CHILD
. A relationship of type VALUE is a list that contains
+ * the ID of the VALUE block that's associated with the KEY of a key-value
+ * pair. A relationship of type CHILD is a list of IDs that identify WORD
+ * blocks.
*
@@ -131,7 +157,11 @@ public Relationship withType(String type) {
* @param type VALUE
or CHILD
.
+ * VALUE
or CHILD
. A relationship of
+ * type VALUE is a list that contains the ID of the VALUE block
+ * that's associated with the KEY of a key-value pair. A
+ * relationship of type CHILD is a list of IDs that identify WORD
+ * blocks.
* VALUE
or
- * CHILD
.
+ * CHILD
. A relationship of type VALUE is a list that contains
+ * the ID of the VALUE block that's associated with the KEY of a key-value
+ * pair. A relationship of type CHILD is a list of IDs that identify WORD
+ * blocks.
* VALUE
or CHILD
.
+ * VALUE
or CHILD
. A relationship of
+ * type VALUE is a list that contains the ID of the VALUE block
+ * that's associated with the KEY of a key-value pair. A
+ * relationship of type CHILD is a list of IDs that identify WORD
+ * blocks.
*
@@ -124,8 +125,9 @@ public S3Object withBucket(String bucket) {
/**
*
@@ -133,9 +135,9 @@ public S3Object withBucket(String bucket) {
* Pattern: .*\S.*
*
* @return
@@ -153,9 +156,9 @@ public String getName() {
* Pattern: .*\S.*
*
* @param name
*
* @param name StartDocumentAnalysis
can analyze text in documents that are in
- * JPG, PNG, and PDF format. The documents are stored in an Amazon S3 bucket.
+ * JPEG, PNG, and PDF format. The documents are stored in an Amazon S3 bucket.
* Use DocumentLocation to specify the bucket name and file name of the
* document.
* FeatureTypes
. All selectable elements (
- * SELECTION_ELEMENT
) that are detected are returned, whatever
- * the value of FeatureTypes
.
+ * 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
).
* StartDocumentAnalysis
* requests, the same JobId
is returned. Use
* ClientRequestToken
to prevent the same job from being
- * accidentally started more than once.
+ * accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
*
@@ -85,10 +88,10 @@ public class StartDocumentAnalysisRequest extends AmazonWebServiceRequest implem
/**
* JobTag
to identify the type of document, such as a tax form
- * or a receipt, that the completion notification corresponds to.
+ * 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).
*
@@ -154,21 +157,21 @@ public StartDocumentAnalysisRequest withDocumentLocation(DocumentLocation docume
* FeatureTypes
. All selectable elements (
- * SELECTION_ELEMENT
) that are detected are returned, whatever
- * the value of FeatureTypes
.
+ * 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
).
* FeatureTypes
. All selectable elements (
- * SELECTION_ELEMENT
) that are detected are returned,
- * whatever the value of FeatureTypes
.
+ * 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
).
* FeatureTypes
. All selectable elements (
- * SELECTION_ELEMENT
) that are detected are returned, whatever
- * the value of FeatureTypes
.
+ * 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
).
* FeatureTypes
. All selectable
- * elements (SELECTION_ELEMENT
) that are detected
- * are returned, whatever the value of FeatureTypes
.
+ * 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
).
* FeatureTypes
. All selectable elements (
- * SELECTION_ELEMENT
) that are detected are returned, whatever
- * the value of FeatureTypes
.
+ * 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
).
* FeatureTypes
. All selectable
- * elements (SELECTION_ELEMENT
) that are detected
- * are returned, whatever the value of FeatureTypes
.
+ * 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
).
* FeatureTypes
. All selectable elements (
- * SELECTION_ELEMENT
) that are detected are returned, whatever
- * the value of FeatureTypes
.
+ * 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
).
* FeatureTypes
. All selectable
- * elements (SELECTION_ELEMENT
) that are detected
- * are returned, whatever the value of FeatureTypes
.
+ * 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
).
* JobId
is returned. Use
* ClientRequestToken
to prevent the same job from being
- * accidentally started more than once.
+ * accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
*
@@ -291,7 +296,10 @@ public StartDocumentAnalysisRequest withFeatureTypes(java.util.CollectionJobId
is returned. Use
* ClientRequestToken
to prevent the same job from
- * being accidentally started more than once.
+ * being accidentally started more than once. For more information,
+ * see Calling Amazon Textract Asynchronous Operations.
* StartDocumentAnalysis
* requests, the same JobId
is returned. Use
* ClientRequestToken
to prevent the same job from being
- * accidentally started more than once.
+ * accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
*
@@ -317,7 +327,10 @@ public String getClientRequestToken() {
* StartDocumentAnalysis
requests, the same
* JobId
is returned. Use
* ClientRequestToken
to prevent the same job from
- * being accidentally started more than once.
+ * being accidentally started more than once. For more
+ * information, see Calling Amazon Textract Asynchronous Operations.
* StartDocumentAnalysis
* requests, the same JobId
is returned. Use
* ClientRequestToken
to prevent the same job from being
- * accidentally started more than once.
+ * accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
* StartDocumentAnalysis
requests, the same
* JobId
is returned. Use
* ClientRequestToken
to prevent the same job from
- * being accidentally started more than once.
+ * being accidentally started more than once. For more
+ * information, see Calling Amazon Textract Asynchronous Operations.
* JobTag
to identify the type of document, such as a tax form
- * or a receipt, that the completion notification corresponds to.
+ * 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).
*
@@ -369,11 +387,11 @@ public StartDocumentAnalysisRequest withClientRequestToken(String clientRequestT
* Pattern: [a-zA-Z0-9_.\-:]+
*
* @return JobTag
to identify the type of
- * document, such as a tax form or a receipt, that the completion
- * notification corresponds to.
+ * 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).
* JobTag
to identify the type of document, such as a tax form
- * or a receipt, that the completion notification corresponds to.
+ * 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).
*
@@ -393,11 +411,11 @@ public String getJobTag() {
* Pattern: [a-zA-Z0-9_.\-:]+
*
* @param jobTag JobTag
to identify the type
- * of document, such as a tax form or a receipt, that the
- * completion notification corresponds to.
+ * of document that the completion notification corresponds to
+ * (such as a tax form or a receipt).
* JobTag
to identify the type of document, such as a tax form
- * or a receipt, that the completion notification corresponds to.
+ * 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).
*
*
* @param jobTag JobTag
to identify the type
- * of document, such as a tax form or a receipt, that the
- * completion notification corresponds to.
+ * of document that the completion notification corresponds to
+ * (such as a tax form or a receipt).
* JobId
to identify the job in a subsequent call to
- * GetDocumentAnalysis
.
+ * GetDocumentAnalysis
. A JobId
value is only
+ * valid for 7 days.
*
@@ -35,7 +36,8 @@ public class StartDocumentAnalysisResult implements Serializable {
* JobId
to identify the job in a subsequent call to
- * GetDocumentAnalysis
.
+ * GetDocumentAnalysis
. A JobId
value is only
+ * valid for 7 days.
*
@@ -45,7 +47,8 @@ public class StartDocumentAnalysisResult implements Serializable {
* @return JobId
to identify the job in a subsequent call to
- * GetDocumentAnalysis
.
+ * GetDocumentAnalysis
. A JobId
value is
+ * only valid for 7 days.
* JobId
to identify the job in a subsequent call to
- * GetDocumentAnalysis
.
+ * GetDocumentAnalysis
. A JobId
value is only
+ * valid for 7 days.
*
@@ -66,7 +70,8 @@ public String getJobId() {
* @param jobId JobId
to identify the job in a subsequent call to
- * GetDocumentAnalysis
.
+ * GetDocumentAnalysis
. A JobId
value
+ * is only valid for 7 days.
* JobId
to identify the job in a subsequent call to
- * GetDocumentAnalysis
.
+ * GetDocumentAnalysis
. A JobId
value is only
+ * valid for 7 days.
* JobId
to identify the job in a subsequent call to
- * GetDocumentAnalysis
.
+ * GetDocumentAnalysis
. A JobId
value
+ * is only valid for 7 days.
* StartDocumentTextDetection
can analyze text in documents that
- * are in JPG, PNG, and PDF format. The documents are stored in an Amazon S3
+ * are in JPEG, PNG, and PDF format. The documents are stored in an Amazon S3
* bucket. Use DocumentLocation to specify the bucket name and file name
* of the document.
* StartDocumentTextDetection
* requests, the same JobId
is returned. Use
* ClientRequestToken
to prevent the same job from being
- * accidentally started more than once.
+ * accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
*
@@ -73,10 +75,10 @@ public class StartDocumentTextDetectionRequest extends AmazonWebServiceRequest i
/**
* JobTag
to identify the type of document, such as a tax form
- * or a receipt, that the completion notification corresponds to.
+ * 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).
*
@@ -144,7 +146,9 @@ public StartDocumentTextDetectionRequest withDocumentLocation(DocumentLocation d
* 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.
+ * accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
*
@@ -157,7 +161,10 @@ public StartDocumentTextDetectionRequest withDocumentLocation(DocumentLocation d
* StartDocumentTextDetection
requests, the same
* JobId
is returned. Use
* ClientRequestToken
to prevent the same job from
- * being accidentally started more than once.
+ * being accidentally started more than once. For more information,
+ * see Calling Amazon Textract Asynchronous Operations.
* StartDocumentTextDetection
* requests, the same JobId
is returned. Use
* ClientRequestToken
to prevent the same job from being
- * accidentally started more than once.
+ * accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
*
@@ -183,7 +192,10 @@ public String getClientRequestToken() {
* StartDocumentTextDetection
requests, the same
* JobId
is returned. Use
* ClientRequestToken
to prevent the same job from
- * being accidentally started more than once.
+ * being accidentally started more than once. For more
+ * information, see Calling Amazon Textract Asynchronous Operations.
* StartDocumentTextDetection
* requests, the same JobId
is returned. Use
* ClientRequestToken
to prevent the same job from being
- * accidentally started more than once.
+ * accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
* StartDocumentTextDetection
requests, the same
* JobId
is returned. Use
* ClientRequestToken
to prevent the same job from
- * being accidentally started more than once.
+ * being accidentally started more than once. For more
+ * information, see Calling Amazon Textract Asynchronous Operations.
* JobTag
to identify the type of document, such as a tax form
- * or a receipt, that the completion notification corresponds to.
+ * 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).
*
@@ -235,11 +252,11 @@ public StartDocumentTextDetectionRequest withClientRequestToken(String clientReq
* Pattern: [a-zA-Z0-9_.\-:]+
*
* @return JobTag
to identify the type of
- * document, such as a tax form or a receipt, that the completion
- * notification corresponds to.
+ * 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).
* JobTag
to identify the type of document, such as a tax form
- * or a receipt, that the completion notification corresponds to.
+ * 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).
*
@@ -259,11 +276,11 @@ public String getJobTag() {
* Pattern: [a-zA-Z0-9_.\-:]+
*
* @param jobTag JobTag
to identify the type
- * of document, such as a tax form or a receipt, that the
- * completion notification corresponds to.
+ * of document that the completion notification corresponds to
+ * (such as a tax form or a receipt).
* JobTag
to identify the type of document, such as a tax form
- * or a receipt, that the completion notification corresponds to.
+ * 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).
*
*
* @param jobTag JobTag
to identify the type
- * of document, such as a tax form or a receipt, that the
- * completion notification corresponds to.
+ * of document that the completion notification corresponds to
+ * (such as a tax form or a receipt).
* JobId
to identify the job in a subsequent call to
- * GetDocumentTextDetection
.
+ * GetDocumentTextDetection
. A JobId
value is only
+ * valid for 7 days.
*
@@ -33,9 +34,10 @@ public class StartDocumentTextDetectionResult implements Serializable {
/**
* JobId
to identify the job in a subsequent call to
- * GetDocumentTextDetection
.
+ * GetDocumentTextDetection
. A JobId
value is only
+ * valid for 7 days.
*
@@ -43,9 +45,10 @@ public class StartDocumentTextDetectionResult implements Serializable {
* Pattern: ^[a-zA-Z0-9-_]+$
*
* @return JobId
to identify the job in a subsequent call to
- * GetDocumentTextDetection
.
+ * GetDocumentTextDetection
. A JobId
value
+ * is only valid for 7 days.
* JobId
to identify the job in a subsequent call to
- * GetDocumentTextDetection
.
+ * GetDocumentTextDetection
. A JobId
value is only
+ * valid for 7 days.
*
@@ -64,9 +68,10 @@ public String getJobId() {
* Pattern: ^[a-zA-Z0-9-_]+$
*
* @param jobId JobId
to identify the job in a subsequent call to
- * GetDocumentTextDetection
.
+ * GetDocumentTextDetection
. A JobId
+ * value is only valid for 7 days.
* JobId
to identify the job in a subsequent call to
- * GetDocumentTextDetection
.
+ * GetDocumentTextDetection
. A JobId
value is only
+ * valid for 7 days.
*
*
* @param jobId JobId
to identify the job in a subsequent call to
- * GetDocumentTextDetection
.
+ * GetDocumentTextDetection
. A JobId
+ * value is only valid for 7 days.
*