@aws-sdk/client-textract 3.296.0 → 3.298.0

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJsonString } from "@aws-sdk/smithy-client";
 import { TextractServiceException as __BaseException } from "./TextractServiceException";
 /**
+ * @public
  * <p>You aren't authorized to perform the action. Use the Amazon Resource Name (ARN)
  *             of an authorized user or IAM role to perform the operation.</p>
  */
@@ -15,10 +16,10 @@ export declare class AccessDeniedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
 /**
+ * @public
  * <p>The S3 bucket name and file name that identifies the document.</p>
  *          <p>The AWS Region for the S3 bucket that contains the document must match the Region that
  *          you use for Amazon Textract operations.</p>
- *
  *          <p>For Amazon Textract to process a file in an S3 bucket, the user must have
  *          permission to access the S3 bucket and file.
  *
@@ -41,6 +42,7 @@ export interface S3Object {
     Version?: string;
 }
 /**
+ * @public
  * <p>The input document, either as bytes or as an S3 object.</p>
  *          <p>You pass image bytes to an Amazon Textract API operation by using the <code>Bytes</code>
  *          property. For example, you would use the <code>Bytes</code> property to pass a document
@@ -55,7 +57,6 @@ export interface S3Object {
  *          <p>If you use the AWS CLI to call Amazon Textract operations, passing image bytes using
  *          the Bytes property isn't supported. You must first upload the document to an Amazon S3
  *          bucket, and then call the operation using the S3Object property.</p>
- *
  *          <p>For Amazon Textract to process an S3 object, the user must have permission
  *          to access the S3 object. </p>
  */
@@ -73,17 +74,24 @@ export interface Document {
      */
     S3Object?: S3Object;
 }
+/**
+ * @public
+ */
 export declare enum FeatureType {
     FORMS = "FORMS",
     QUERIES = "QUERIES",
     SIGNATURES = "SIGNATURES",
     TABLES = "TABLES"
 }
+/**
+ * @public
+ */
 export declare enum ContentClassifier {
     FREE_OF_ADULT_CONTENT = "FreeOfAdultContent",
     FREE_OF_PERSONALLY_IDENTIFIABLE_INFORMATION = "FreeOfPersonallyIdentifiableInformation"
 }
 /**
+ * @public
  * <p>Allows you to set attributes of the image. Currently, you can declare an image as free
  *          of personally identifiable information and adult content. </p>
  */
@@ -95,6 +103,7 @@ export interface HumanLoopDataAttributes {
     ContentClassifiers?: (ContentClassifier | string)[];
 }
 /**
+ * @public
  * <p>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. </p>
  */
@@ -114,6 +123,7 @@ export interface HumanLoopConfig {
     DataAttributes?: HumanLoopDataAttributes;
 }
 /**
+ * @public
  * <p>Each query contains the question you want to ask in the Text and the alias you want to associate.</p>
  */
 export interface Query {
@@ -151,6 +161,7 @@ export interface Query {
     Pages?: string[];
 }
 /**
+ * @public
  * <p></p>
  */
 export interface QueriesConfig {
@@ -159,6 +170,9 @@ export interface QueriesConfig {
      */
     Queries: Query[] | undefined;
 }
+/**
+ * @public
+ */
 export interface AnalyzeDocumentRequest {
     /**
      * <p>The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS
@@ -188,6 +202,9 @@ export interface AnalyzeDocumentRequest {
      */
     QueriesConfig?: QueriesConfig;
 }
+/**
+ * @public
+ */
 export declare enum BlockType {
     CELL = "CELL",
     KEY_VALUE_SET = "KEY_VALUE_SET",
@@ -199,15 +216,27 @@ export declare enum BlockType {
     SELECTION_ELEMENT = "SELECTION_ELEMENT",
     SIGNATURE = "SIGNATURE",
     TABLE = "TABLE",
+    TABLE_FOOTER = "TABLE_FOOTER",
+    TABLE_TITLE = "TABLE_TITLE",
     TITLE = "TITLE",
     WORD = "WORD"
 }
+/**
+ * @public
+ */
 export declare enum EntityType {
     COLUMN_HEADER = "COLUMN_HEADER",
     KEY = "KEY",
+    SEMI_STRUCTURED_TABLE = "SEMI_STRUCTURED_TABLE",
+    STRUCTURED_TABLE = "STRUCTURED_TABLE",
+    TABLE_FOOTER = "TABLE_FOOTER",
+    TABLE_SECTION_TITLE = "TABLE_SECTION_TITLE",
+    TABLE_SUMMARY = "TABLE_SUMMARY",
+    TABLE_TITLE = "TABLE_TITLE",
     VALUE = "VALUE"
 }
 /**
+ * @public
  * <p>The bounding box around the detected page, text, key-value pair, table, table cell, or
  *          selection element on a document page. The <code>left</code> (x-coordinate) and
  *             <code>top</code> (y-coordinate) are coordinates that represent the top and left sides of
@@ -244,11 +273,11 @@ export interface BoundingBox {
     Top?: number;
 }
 /**
+ * @public
  * <p>The X and Y coordinates of a point on a document page. The X and Y
  *          values that are returned are ratios of the overall document page size. For example, if the
  *          input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is
  *          at the (350,50) pixel coordinate on the document page.</p>
- *
  *          <p>An array of <code>Point</code> objects, <code>Polygon</code>, is returned
  *          by <a>DetectDocumentText</a>. <code>Polygon</code> represents a fine-grained
  *          polygon around detected text. For more information, see Geometry in the Amazon Textract
@@ -265,6 +294,7 @@ export interface Point {
     Y?: number;
 }
 /**
+ * @public
  * <p>Information about where the following items are located on a document page: detected
  *          page, text, key-value pairs, tables, table cells, and selection elements.</p>
  */
@@ -279,15 +309,22 @@ export interface Geometry {
      */
     Polygon?: Point[];
 }
+/**
+ * @public
+ */
 export declare enum RelationshipType {
     ANSWER = "ANSWER",
     CHILD = "CHILD",
     COMPLEX_FEATURES = "COMPLEX_FEATURES",
     MERGED_CELL = "MERGED_CELL",
+    TABLE = "TABLE",
+    TABLE_FOOTER = "TABLE_FOOTER",
+    TABLE_TITLE = "TABLE_TITLE",
     TITLE = "TITLE",
     VALUE = "VALUE"
 }
 /**
+ * @public
  * <p>Information about how blocks are related to each other. A <code>Block</code> object
  *          contains 0 or more <code>Relation</code> objects in a list, <code>Relationships</code>. For
  *          more information, see <a>Block</a>.</p>
@@ -296,12 +333,46 @@ export declare enum RelationshipType {
  */
 export interface Relationship {
     /**
-     * <p>The type of relationship that the blocks in the IDs array have with the current block.
-     *          The relationship can be <code>VALUE</code> or <code>CHILD</code>. 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 in
-     *          the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of
-     *          Selection Elements.</p>
+     * <p>The type of relationship between the blocks in the IDs array and the current block. The
+     *          following list describes the relationship types that can be returned. </p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <i>VALUE</i> - A list that contains the ID of the VALUE block that's associated with the
+     *                KEY of a key-value pair.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <i>CHILD</i> - A list of IDs that identify blocks found within the
+     *                current block object. For example, WORD blocks have a CHILD relationship to the LINE
+     *                block type.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <i>MERGED_CELL</i> - A list of IDs that identify each of the
+     *                MERGED_CELL block types in a table.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <i>ANSWER</i> - A list that contains the ID of the QUERY_RESULT
+     *                block that’s associated with the corresponding QUERY block. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <i>TABLE</i> - A list of IDs that identify associated TABLE block
+     *                types. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <i>TABLE_TITLE</i> - A list that contains the ID for the TABLE_TITLE
+     *                block type in a table. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <i>TABLE_FOOTER</i> - A list of IDs that identify the TABLE_FOOTER
+     *                block types in a table. </p>
+     *             </li>
+     *          </ul>
      */
     Type?: RelationshipType | string;
     /**
@@ -311,15 +382,22 @@ export interface Relationship {
      */
     Ids?: string[];
 }
+/**
+ * @public
+ */
 export declare enum SelectionStatus {
     NOT_SELECTED = "NOT_SELECTED",
     SELECTED = "SELECTED"
 }
+/**
+ * @public
+ */
 export declare enum TextType {
     HANDWRITING = "HANDWRITING",
     PRINTED = "PRINTED"
 }
 /**
+ * @public
  * <p>A <code>Block</code> represents items that are recognized in a document within a group
  *          of pixels close to each other. The information returned in a <code>Block</code> object
  *          depends on the type of operation. In text detection for documents (for example <a>DetectDocumentText</a>), you get information about the detected words and lines
@@ -386,11 +464,28 @@ export interface Block {
      *             </li>
      *             <li>
      *                <p>
+     *                   <i>TABLE_TITLE</i> - The title of a table. A title is typically a
+     *                line of text above or below a table, or embedded as the first row of a table. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <i>TABLE_FOOTER</i> - The footer associated with a table. A footer
+     *                is typically a line or lines of text below a table or embedded as the last row of a
+     *                table. </p>
+     *             </li>
+     *             <li>
+     *                <p>
      *                   <i>CELL</i> - A cell within a detected table. The cell is the parent
      *                of the block that contains the text in the cell.</p>
      *             </li>
      *             <li>
      *                <p>
+     *                   <i>MERGED_CELL</i>  - A cell in a table whose content spans more than
+     *                one row or column. The <code>Relationships</code> array for this cell contain data
+     *                from individual cells.</p>
+     *             </li>
+     *             <li>
+     *                <p>
      *                   <i>SELECTION_ELEMENT</i> - 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 <code>SelectionStatus</code> to determine the status of the selection
@@ -442,14 +537,12 @@ export interface Block {
      */
     ColumnIndex?: number;
     /**
-     * <p>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. <code>RowSpan</code> isn't returned by
+     * <p>The number of rows that a table cell spans. <code>RowSpan</code> isn't returned by
      *             <code>DetectDocumentText</code> and <code>GetDocumentTextDetection</code>.</p>
      */
     RowSpan?: number;
     /**
-     * <p>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. <code>ColumnSpan</code> isn't returned by
+     * <p>The number of columns that a table cell spans. <code>ColumnSpan</code> isn't returned by
      *             <code>DetectDocumentText</code> and <code>GetDocumentTextDetection</code>. </p>
      */
     ColumnSpan?: number;
@@ -465,30 +558,60 @@ export interface Block {
      */
     Id?: string;
     /**
-     * <p>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 size can be the following:</p>
+     * <p>A list of relationship objects that describe how blocks are related to each other. For
+     *          example, a LINE block object contains a CHILD relationship type with the WORD blocks that
+     *          make up the line of text. There aren't Relationship objects in the list for relationships
+     *          that don't exist, such as when the current block has no child blocks.</p>
+     */
+    Relationships?: Relationship[];
+    /**
+     * <p>The type of entity. </p>
+     *          <p>The following entity types can be returned by FORMS analysis:</p>
      *          <ul>
      *             <li>
-     *                <p>0 - The block has no child blocks.</p>
+     *                <p>
+     *                   <i>KEY</i> - An identifier for a field on the document.</p>
      *             </li>
      *             <li>
-     *                <p>1 - The block has child blocks.</p>
+     *                <p>
+     *                   <i>VALUE</i> - The field text.</p>
      *             </li>
      *          </ul>
-     */
-    Relationships?: Relationship[];
-    /**
-     * <p>The type of entity. The following can be returned:</p>
+     *          <p>The following entity types can be returned by TABLES analysis:</p>
      *          <ul>
      *             <li>
      *                <p>
-     *                   <i>KEY</i> - An identifier for a field on the document.</p>
+     *                   <i>COLUMN_HEADER</i> - Identifies a cell that is a header of a column. </p>
      *             </li>
      *             <li>
      *                <p>
-     *                   <i>VALUE</i> - The field text.</p>
+     *                   <i>TABLE_TITLE</i> - Identifies a cell that is a title within the
+     *                table. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <i>TABLE_SECTION_TITLE</i> - Identifies a cell that is a title of a
+     *                section within a table. A section title is a cell that typically spans an entire row
+     *                above a section. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <i>TABLE_FOOTER</i> - Identifies a cell that is a footer of a table. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <i>TABLE_SUMMARY</i> - Identifies a summary cell of a table. A
+     *                summary cell can be a row of a table or an additional, smaller table that contains
+     *                summary information for another table. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <i>STRUCTURED_TABLE </i> - Identifies a table with column headers
+     *                where the content of each row corresponds to the headers. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <i>SEMI_STRUCTURED_TABLE</i> - Identifies a non-structured table. </p>
      *             </li>
      *          </ul>
      *          <p>
@@ -507,7 +630,7 @@ export interface Block {
      *          documents that are in PDF or TIFF format. A scanned image (JPEG/PNG) provided to an
      *          asynchronous operation, even if it contains multiple document pages, is considered a
      *          single-page document. This means that for scanned images the value of <code>Page</code> is
-     *          always 1. Synchronous operations operations will also return a <code>Page</code> value of 1
+     *          always 1. Synchronous operations will also return a <code>Page</code> value of 1
      *          because every input document is considered to be a single-page document.</p>
      */
     Page?: number;
@@ -517,6 +640,7 @@ export interface Block {
     Query?: Query;
 }
 /**
+ * @public
  * <p>Information about the input document.</p>
  */
 export interface DocumentMetadata {
@@ -526,6 +650,7 @@ export interface DocumentMetadata {
     Pages?: number;
 }
 /**
+ * @public
  * <p>Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the
  *          input did not trigger human review.</p>
  */
@@ -544,6 +669,9 @@ export interface HumanLoopActivationOutput {
      */
     HumanLoopActivationConditionsEvaluationResults?: __LazyJsonString | string;
 }
+/**
+ * @public
+ */
 export interface AnalyzeDocumentResponse {
     /**
      * <p>Metadata about the analyzed document. An example is the number of pages.</p>
@@ -563,6 +691,7 @@ export interface AnalyzeDocumentResponse {
     AnalyzeDocumentModelVersion?: string;
 }
 /**
+ * @public
  * <p>Amazon Textract isn't able to read the document. For more information on the document
  *          limits in Amazon Textract, see <a>limits</a>.</p>
  */
@@ -577,6 +706,7 @@ export declare class BadDocumentException extends __BaseException {
     constructor(opts: __ExceptionOptionType<BadDocumentException, __BaseException>);
 }
 /**
+ * @public
  * <p>The document can't be processed because it's too large. The maximum document size for
  *          synchronous operations 10 MB. The maximum document size for asynchronous operations is 500
  *          MB for PDF files.</p>
@@ -592,6 +722,7 @@ export declare class DocumentTooLargeException extends __BaseException {
     constructor(opts: __ExceptionOptionType<DocumentTooLargeException, __BaseException>);
 }
 /**
+ * @public
  * <p>Indicates you have exceeded the maximum number of active human in the loop workflows available</p>
  */
 export declare class HumanLoopQuotaExceededException extends __BaseException {
@@ -617,6 +748,7 @@ export declare class HumanLoopQuotaExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<HumanLoopQuotaExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>Amazon Textract experienced a service issue. Try your call again.</p>
  */
 export declare class InternalServerError extends __BaseException {
@@ -630,6 +762,7 @@ export declare class InternalServerError extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerError, __BaseException>);
 }
 /**
+ * @public
  * <p>An input parameter violated a constraint. For example, in synchronous operations,
  *        an <code>InvalidParameterException</code> exception occurs
  *       when neither of the <code>S3Object</code> or <code>Bytes</code> values are supplied in the <code>Document</code>
@@ -647,6 +780,7 @@ export declare class InvalidParameterException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
 }
 /**
+ * @public
  * <p>Amazon Textract is unable to access the S3 object that's specified in the request.
  *          for more information, <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html">Configure Access to Amazon S3</a>
  *          For troubleshooting information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html">Troubleshooting Amazon S3</a>
@@ -663,6 +797,7 @@ export declare class InvalidS3ObjectException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidS3ObjectException, __BaseException>);
 }
 /**
+ * @public
  * <p>The number of requests exceeded your throughput limit. If you want to increase this limit,
  *          contact Amazon Textract.</p>
  */
@@ -677,6 +812,7 @@ export declare class ProvisionedThroughputExceededException extends __BaseExcept
     constructor(opts: __ExceptionOptionType<ProvisionedThroughputExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>Amazon Textract is temporarily unable to process the request. Try your call again.</p>
  */
 export declare class ThrottlingException extends __BaseException {
@@ -690,6 +826,7 @@ export declare class ThrottlingException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
 /**
+ * @public
  * <p>The format of the input document isn't supported. Documents for operations can be in
  *          PNG, JPEG, PDF, or TIFF format.</p>
  */
@@ -703,6 +840,9 @@ export declare class UnsupportedDocumentException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<UnsupportedDocumentException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface AnalyzeExpenseRequest {
     /**
      * <p>The input document, either as bytes or as an S3 object.</p>
@@ -719,13 +859,13 @@ export interface AnalyzeExpenseRequest {
      *          <p>If you use the AWS CLI to call Amazon Textract operations, passing image bytes using
      *          the Bytes property isn't supported. You must first upload the document to an Amazon S3
      *          bucket, and then call the operation using the S3Object property.</p>
-     *
      *          <p>For Amazon Textract to process an S3 object, the user must have permission
      *          to access the S3 object. </p>
      */
     Document: Document | undefined;
 }
 /**
+ * @public
  * <p>Returns the kind of currency detected.</p>
  */
 export interface ExpenseCurrency {
@@ -777,6 +917,7 @@ export interface ExpenseCurrency {
     Confidence?: number;
 }
 /**
+ * @public
  * <p>Shows the group that a certain key belongs to. This helps differentiate between
  *          names and addresses for different organizations, that can be hard to determine
  *          via JSON response.</p>
@@ -792,6 +933,7 @@ export interface ExpenseGroupProperty {
     Id?: string;
 }
 /**
+ * @public
  * <p>An object used to store information about the Value or Label detected by Amazon Textract.</p>
  */
 export interface ExpenseDetection {
@@ -810,6 +952,7 @@ export interface ExpenseDetection {
     Confidence?: number;
 }
 /**
+ * @public
  * <p>An object used to store information about the Type detected by Amazon Textract.</p>
  */
 export interface ExpenseType {
@@ -823,6 +966,7 @@ export interface ExpenseType {
     Confidence?: number;
 }
 /**
+ * @public
  * <p>Breakdown of detected information, seperated into
  *          the catagories Type, LabelDetection, and ValueDetection</p>
  */
@@ -855,6 +999,7 @@ export interface ExpenseField {
     GroupProperties?: ExpenseGroupProperty[];
 }
 /**
+ * @public
  * <p>A structure that holds information about the different lines found in a document's tables.</p>
  */
 export interface LineItemFields {
@@ -864,6 +1009,7 @@ export interface LineItemFields {
     LineItemExpenseFields?: ExpenseField[];
 }
 /**
+ * @public
  * <p>A grouping of tables which contain LineItems, with each table identified by the table's <code>LineItemGroupIndex</code>.</p>
  */
 export interface LineItemGroup {
@@ -877,6 +1023,7 @@ export interface LineItemGroup {
     LineItems?: LineItemFields[];
 }
 /**
+ * @public
  * <p>The structure holding all the information returned by AnalyzeExpense</p>
  */
 export interface ExpenseDocument {
@@ -899,6 +1046,9 @@ export interface ExpenseDocument {
      */
     Blocks?: Block[];
 }
+/**
+ * @public
+ */
 export interface AnalyzeExpenseResponse {
     /**
      * <p>Information about the input document.</p>
@@ -909,16 +1059,23 @@ export interface AnalyzeExpenseResponse {
      */
     ExpenseDocuments?: ExpenseDocument[];
 }
+/**
+ * @public
+ */
 export interface AnalyzeIDRequest {
     /**
      * <p>The document being passed to AnalyzeID.</p>
      */
     DocumentPages: Document[] | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ValueType {
     DATE = "DATE"
 }
 /**
+ * @public
  * <p>Contains information relating to dates in a document, including the type
  *          of value, and the value.</p>
  */
@@ -933,6 +1090,7 @@ export interface NormalizedValue {
     ValueType?: ValueType | string;
 }
 /**
+ * @public
  * <p>Used to contain the information detected by an AnalyzeID operation.</p>
  */
 export interface AnalyzeIDDetections {
@@ -951,6 +1109,7 @@ export interface AnalyzeIDDetections {
     Confidence?: number;
 }
 /**
+ * @public
  * <p>Structure containing both the normalized type of the extracted information
  *          and the text associated with it. These are extracted as Type and Value respectively.</p>
  */
@@ -965,6 +1124,7 @@ export interface IdentityDocumentField {
     ValueDetection?: AnalyzeIDDetections;
 }
 /**
+ * @public
  * <p>The structure that lists each document processed in an AnalyzeID operation.</p>
  */
 export interface IdentityDocument {
@@ -983,6 +1143,9 @@ export interface IdentityDocument {
      */
     Blocks?: Block[];
 }
+/**
+ * @public
+ */
 export interface AnalyzeIDResponse {
     /**
      * <p>The list of documents processed by AnalyzeID. Includes a number denoting their place in
@@ -998,6 +1161,9 @@ export interface AnalyzeIDResponse {
      */
     AnalyzeIDModelVersion?: string;
 }
+/**
+ * @public
+ */
 export interface DetectDocumentTextRequest {
     /**
      * <p>The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI
@@ -1008,6 +1174,9 @@ export interface DetectDocumentTextRequest {
      */
     Document: Document | undefined;
 }
+/**
+ * @public
+ */
 export interface DetectDocumentTextResponse {
     /**
      * <p>Metadata about the document. It contains the number of pages that are detected in the
@@ -1025,6 +1194,7 @@ export interface DetectDocumentTextResponse {
     DetectDocumentTextModelVersion?: string;
 }
 /**
+ * @public
  * <p>A structure that holds information regarding a detected signature on a page.</p>
  */
 export interface DetectedSignature {
@@ -1034,6 +1204,7 @@ export interface DetectedSignature {
     Page?: number;
 }
 /**
+ * @public
  * <p>Contains information about the pages of a document, defined by logical boundary.</p>
  */
 export interface SplitDocument {
@@ -1047,6 +1218,7 @@ export interface SplitDocument {
     Pages?: number[];
 }
 /**
+ * @public
  * <p>A structure containing information about an undetected signature on a page where it was expected but not found.</p>
  */
 export interface UndetectedSignature {
@@ -1056,11 +1228,12 @@ export interface UndetectedSignature {
     Page?: number;
 }
 /**
+ * @public
  * <p>Summary information about documents grouped by the same document type.</p>
  */
 export interface DocumentGroup {
     /**
-     * <p>The type of document that Amazon Textract has detected. See LINK for a list of all types returned by Textract.</p>
+     * <p>The type of document that Amazon Textract has detected. See <a href="https://docs.aws.amazon.com/textract/latest/dg/lending-response-objects.html">Analyze Lending Response Objects</a> for a list of all types returned by Textract.</p>
      */
     Type?: string;
     /**
@@ -1077,6 +1250,7 @@ export interface DocumentGroup {
     UndetectedSignatures?: UndetectedSignature[];
 }
 /**
+ * @public
  * <p>The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous
  *          operations.</p>
  *          <p>The input document can be an image file in JPEG or PNG format. It can also be a file in
@@ -1089,6 +1263,7 @@ export interface DocumentLocation {
     S3Object?: S3Object;
 }
 /**
+ * @public
  * <p>The results extracted for a lending document.</p>
  */
 export interface LendingDetection {
@@ -1111,6 +1286,7 @@ export interface LendingDetection {
     Confidence?: number;
 }
 /**
+ * @public
  * <p>Holds the normalized key-value pairs returned by AnalyzeDocument, including the document type, detected text, and geometry.</p>
  */
 export interface LendingField {
@@ -1128,6 +1304,7 @@ export interface LendingField {
     ValueDetections?: LendingDetection[];
 }
 /**
+ * @public
  * <p>Information regarding a detected signature on a page.</p>
  */
 export interface SignatureDetection {
@@ -1142,6 +1319,7 @@ export interface SignatureDetection {
     Geometry?: Geometry;
 }
 /**
+ * @public
  * <p>Holds the structured data returned by AnalyzeDocument for lending documents.</p>
  */
 export interface LendingDocument {
@@ -1155,6 +1333,7 @@ export interface LendingDocument {
     SignatureDetections?: SignatureDetection[];
 }
 /**
+ * @public
  * <p>Contains information extracted by an analysis operation after using StartLendingAnalysis.</p>
  */
 export interface Extraction {
@@ -1171,6 +1350,9 @@ export interface Extraction {
      */
     IdentityDocument?: IdentityDocument;
 }
+/**
+ * @public
+ */
 export interface GetDocumentAnalysisRequest {
     /**
      * <p>A unique identifier for the text-detection job. The <code>JobId</code> is returned from
@@ -1191,6 +1373,9 @@ export interface GetDocumentAnalysisRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export declare enum JobStatus {
     FAILED = "FAILED",
     IN_PROGRESS = "IN_PROGRESS",
@@ -1198,6 +1383,7 @@ export declare enum JobStatus {
     SUCCEEDED = "SUCCEEDED"
 }
 /**
+ * @public
  * <p>A warning about an issue that occurred during asynchronous text analysis (<a>StartDocumentAnalysis</a>) or asynchronous document text detection (<a>StartDocumentTextDetection</a>). </p>
  */
 export interface Warning {
@@ -1210,6 +1396,9 @@ export interface Warning {
      */
     Pages?: number[];
 }
+/**
+ * @public
+ */
 export interface GetDocumentAnalysisResponse {
     /**
      * <p>Information about a document that Amazon Textract processed.
@@ -1245,6 +1434,7 @@ export interface GetDocumentAnalysisResponse {
     AnalyzeDocumentModelVersion?: string;
 }
 /**
+ * @public
  * <p>An invalid job identifier was passed to an asynchronous analysis operation.</p>
  */
 export declare class InvalidJobIdException extends __BaseException {
@@ -1258,6 +1448,7 @@ export declare class InvalidJobIdException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidJobIdException, __BaseException>);
 }
 /**
+ * @public
  * <p> Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key
  *         was entered incorrectly. </p>
  */
@@ -1271,6 +1462,9 @@ export declare class InvalidKMSKeyException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InvalidKMSKeyException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface GetDocumentTextDetectionRequest {
     /**
      * <p>A unique identifier for the text detection job. The <code>JobId</code> is returned from
@@ -1289,6 +1483,9 @@ export interface GetDocumentTextDetectionRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface GetDocumentTextDetectionResponse {
     /**
      * <p>Information about a document that Amazon Textract processed. <code>DocumentMetadata</code> is
@@ -1322,6 +1519,9 @@ export interface GetDocumentTextDetectionResponse {
      */
     DetectDocumentTextModelVersion?: string;
 }
+/**
+ * @public
+ */
 export interface GetExpenseAnalysisRequest {
     /**
      * <p>A unique identifier for the text detection job. The <code>JobId</code> is returned from
@@ -1340,6 +1540,9 @@ export interface GetExpenseAnalysisRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface GetExpenseAnalysisResponse {
     /**
      * <p>Information about a document that Amazon Textract processed. <code>DocumentMetadata</code> is
@@ -1373,6 +1576,9 @@ export interface GetExpenseAnalysisResponse {
      */
     AnalyzeExpenseModelVersion?: string;
 }
+/**
+ * @public
+ */
 export interface GetLendingAnalysisRequest {
     /**
      * <p>A unique identifier for the lending or text-detection job. The <code>JobId</code> is
@@ -1394,6 +1600,7 @@ export interface GetLendingAnalysisRequest {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>Contains information regarding predicted values returned by Amazon Textract operations, including the
  *          predicted value and the confidence in the predicted value.</p>
  */
@@ -1408,6 +1615,7 @@ export interface Prediction {
     Confidence?: number;
 }
 /**
+ * @public
  * <p>The class assigned to a Page object detected in an input document.
  *          Contains information regarding the predicted type/class of a document's page and the
  *          page number that the Page object was detected on.</p>
@@ -1424,6 +1632,7 @@ export interface PageClassification {
     PageNumber: Prediction[] | undefined;
 }
 /**
+ * @public
  * <p>Contains the detections for each page analyzed through the Analyze Lending API.</p>
  */
 export interface LendingResult {
@@ -1440,6 +1649,9 @@ export interface LendingResult {
      */
     Extractions?: Extraction[];
 }
+/**
+ * @public
+ */
 export interface GetLendingAnalysisResponse {
     /**
      * <p>Information about the input document.</p>
@@ -1473,6 +1685,9 @@ export interface GetLendingAnalysisResponse {
      */
     AnalyzeLendingModelVersion?: string;
 }
+/**
+ * @public
+ */
 export interface GetLendingAnalysisSummaryRequest {
     /**
      * <p> A unique identifier for the lending or text-detection job. The <code>JobId</code> is
@@ -1481,6 +1696,7 @@ export interface GetLendingAnalysisSummaryRequest {
     JobId: string | undefined;
 }
 /**
+ * @public
  * <p>Contains information regarding DocumentGroups and UndetectedDocumentTypes.</p>
  */
 export interface LendingSummary {
@@ -1493,6 +1709,9 @@ export interface LendingSummary {
      */
     UndetectedDocumentTypes?: string[];
 }
+/**
+ * @public
+ */
 export interface GetLendingAnalysisSummaryResponse {
     /**
      * <p>Information about the input document.</p>
@@ -1521,6 +1740,7 @@ export interface GetLendingAnalysisSummaryResponse {
     AnalyzeLendingModelVersion?: string;
 }
 /**
+ * @public
  * <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at
  *          least one of the other input parameters is different from the previous call to the
  *          operation. </p>
@@ -1536,6 +1756,7 @@ export declare class IdempotentParameterMismatchException extends __BaseExceptio
     constructor(opts: __ExceptionOptionType<IdempotentParameterMismatchException, __BaseException>);
 }
 /**
+ * @public
  * <p>An Amazon Textract service limit was exceeded. For example, if you start too many
  *          asynchronous jobs concurrently, calls to start operations
  *             (<code>StartDocumentTextDetection</code>, for example) raise a LimitExceededException
@@ -1553,6 +1774,7 @@ export declare class LimitExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of
  *          an asynchronous document operation. </p>
  */
@@ -1567,6 +1789,7 @@ export interface NotificationChannel {
     RoleArn: string | undefined;
 }
 /**
+ * @public
  * <p>Sets whether or not your output will go to a user created bucket. Used to set the name
  *          of the bucket, and the prefix on the output file.</p>
  *          <p>
@@ -1596,6 +1819,9 @@ export interface OutputConfig {
      */
     S3Prefix?: string;
 }
+/**
+ * @public
+ */
 export interface StartDocumentAnalysisRequest {
     /**
      * <p>The location of the document to be processed.</p>
@@ -1648,6 +1874,9 @@ export interface StartDocumentAnalysisRequest {
      */
     QueriesConfig?: QueriesConfig;
 }
+/**
+ * @public
+ */
 export interface StartDocumentAnalysisResponse {
     /**
      * <p>The identifier for the document text detection job. Use <code>JobId</code> to identify
@@ -1656,6 +1885,9 @@ export interface StartDocumentAnalysisResponse {
      */
     JobId?: string;
 }
+/**
+ * @public
+ */
 export interface StartDocumentTextDetectionRequest {
     /**
      * <p>The location of the document to be processed.</p>
@@ -1695,6 +1927,9 @@ export interface StartDocumentTextDetectionRequest {
      */
     KMSKeyId?: string;
 }
+/**
+ * @public
+ */
 export interface StartDocumentTextDetectionResponse {
     /**
      * <p>The identifier of the text detection job for the document. Use <code>JobId</code> to
@@ -1703,6 +1938,9 @@ export interface StartDocumentTextDetectionResponse {
      */
     JobId?: string;
 }
+/**
+ * @public
+ */
 export interface StartExpenseAnalysisRequest {
     /**
      * <p>The location of the document to be processed.</p>
@@ -1742,6 +1980,9 @@ export interface StartExpenseAnalysisRequest {
      */
     KMSKeyId?: string;
 }
+/**
+ * @public
+ */
 export interface StartExpenseAnalysisResponse {
     /**
      * <p>A unique identifier for the text detection job. The <code>JobId</code> is returned from
@@ -1749,6 +1990,9 @@ export interface StartExpenseAnalysisResponse {
      */
     JobId?: string;
 }
+/**
+ * @public
+ */
 export interface StartLendingAnalysisRequest {
     /**
      * <p>The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous
@@ -1804,6 +2048,9 @@ export interface StartLendingAnalysisRequest {
      */
     KMSKeyId?: string;
 }
+/**
+ * @public
+ */
 export interface StartLendingAnalysisResponse {
     /**
      * <p>A unique identifier for the lending or text-detection job. The <code>JobId</code> is
@@ -1812,275 +2059,3 @@ export interface StartLendingAnalysisResponse {
      */
     JobId?: string;
 }
-/**
- * @internal
- */
-export declare const S3ObjectFilterSensitiveLog: (obj: S3Object) => any;
-/**
- * @internal
- */
-export declare const DocumentFilterSensitiveLog: (obj: Document) => any;
-/**
- * @internal
- */
-export declare const HumanLoopDataAttributesFilterSensitiveLog: (obj: HumanLoopDataAttributes) => any;
-/**
- * @internal
- */
-export declare const HumanLoopConfigFilterSensitiveLog: (obj: HumanLoopConfig) => any;
-/**
- * @internal
- */
-export declare const QueryFilterSensitiveLog: (obj: Query) => any;
-/**
- * @internal
- */
-export declare const QueriesConfigFilterSensitiveLog: (obj: QueriesConfig) => any;
-/**
- * @internal
- */
-export declare const AnalyzeDocumentRequestFilterSensitiveLog: (obj: AnalyzeDocumentRequest) => any;
-/**
- * @internal
- */
-export declare const BoundingBoxFilterSensitiveLog: (obj: BoundingBox) => any;
-/**
- * @internal
- */
-export declare const PointFilterSensitiveLog: (obj: Point) => any;
-/**
- * @internal
- */
-export declare const GeometryFilterSensitiveLog: (obj: Geometry) => any;
-/**
- * @internal
- */
-export declare const RelationshipFilterSensitiveLog: (obj: Relationship) => any;
-/**
- * @internal
- */
-export declare const BlockFilterSensitiveLog: (obj: Block) => any;
-/**
- * @internal
- */
-export declare const DocumentMetadataFilterSensitiveLog: (obj: DocumentMetadata) => any;
-/**
- * @internal
- */
-export declare const HumanLoopActivationOutputFilterSensitiveLog: (obj: HumanLoopActivationOutput) => any;
-/**
- * @internal
- */
-export declare const AnalyzeDocumentResponseFilterSensitiveLog: (obj: AnalyzeDocumentResponse) => any;
-/**
- * @internal
- */
-export declare const AnalyzeExpenseRequestFilterSensitiveLog: (obj: AnalyzeExpenseRequest) => any;
-/**
- * @internal
- */
-export declare const ExpenseCurrencyFilterSensitiveLog: (obj: ExpenseCurrency) => any;
-/**
- * @internal
- */
-export declare const ExpenseGroupPropertyFilterSensitiveLog: (obj: ExpenseGroupProperty) => any;
-/**
- * @internal
- */
-export declare const ExpenseDetectionFilterSensitiveLog: (obj: ExpenseDetection) => any;
-/**
- * @internal
- */
-export declare const ExpenseTypeFilterSensitiveLog: (obj: ExpenseType) => any;
-/**
- * @internal
- */
-export declare const ExpenseFieldFilterSensitiveLog: (obj: ExpenseField) => any;
-/**
- * @internal
- */
-export declare const LineItemFieldsFilterSensitiveLog: (obj: LineItemFields) => any;
-/**
- * @internal
- */
-export declare const LineItemGroupFilterSensitiveLog: (obj: LineItemGroup) => any;
-/**
- * @internal
- */
-export declare const ExpenseDocumentFilterSensitiveLog: (obj: ExpenseDocument) => any;
-/**
- * @internal
- */
-export declare const AnalyzeExpenseResponseFilterSensitiveLog: (obj: AnalyzeExpenseResponse) => any;
-/**
- * @internal
- */
-export declare const AnalyzeIDRequestFilterSensitiveLog: (obj: AnalyzeIDRequest) => any;
-/**
- * @internal
- */
-export declare const NormalizedValueFilterSensitiveLog: (obj: NormalizedValue) => any;
-/**
- * @internal
- */
-export declare const AnalyzeIDDetectionsFilterSensitiveLog: (obj: AnalyzeIDDetections) => any;
-/**
- * @internal
- */
-export declare const IdentityDocumentFieldFilterSensitiveLog: (obj: IdentityDocumentField) => any;
-/**
- * @internal
- */
-export declare const IdentityDocumentFilterSensitiveLog: (obj: IdentityDocument) => any;
-/**
- * @internal
- */
-export declare const AnalyzeIDResponseFilterSensitiveLog: (obj: AnalyzeIDResponse) => any;
-/**
- * @internal
- */
-export declare const DetectDocumentTextRequestFilterSensitiveLog: (obj: DetectDocumentTextRequest) => any;
-/**
- * @internal
- */
-export declare const DetectDocumentTextResponseFilterSensitiveLog: (obj: DetectDocumentTextResponse) => any;
-/**
- * @internal
- */
-export declare const DetectedSignatureFilterSensitiveLog: (obj: DetectedSignature) => any;
-/**
- * @internal
- */
-export declare const SplitDocumentFilterSensitiveLog: (obj: SplitDocument) => any;
-/**
- * @internal
- */
-export declare const UndetectedSignatureFilterSensitiveLog: (obj: UndetectedSignature) => any;
-/**
- * @internal
- */
-export declare const DocumentGroupFilterSensitiveLog: (obj: DocumentGroup) => any;
-/**
- * @internal
- */
-export declare const DocumentLocationFilterSensitiveLog: (obj: DocumentLocation) => any;
-/**
- * @internal
- */
-export declare const LendingDetectionFilterSensitiveLog: (obj: LendingDetection) => any;
-/**
- * @internal
- */
-export declare const LendingFieldFilterSensitiveLog: (obj: LendingField) => any;
-/**
- * @internal
- */
-export declare const SignatureDetectionFilterSensitiveLog: (obj: SignatureDetection) => any;
-/**
- * @internal
- */
-export declare const LendingDocumentFilterSensitiveLog: (obj: LendingDocument) => any;
-/**
- * @internal
- */
-export declare const ExtractionFilterSensitiveLog: (obj: Extraction) => any;
-/**
- * @internal
- */
-export declare const GetDocumentAnalysisRequestFilterSensitiveLog: (obj: GetDocumentAnalysisRequest) => any;
-/**
- * @internal
- */
-export declare const WarningFilterSensitiveLog: (obj: Warning) => any;
-/**
- * @internal
- */
-export declare const GetDocumentAnalysisResponseFilterSensitiveLog: (obj: GetDocumentAnalysisResponse) => any;
-/**
- * @internal
- */
-export declare const GetDocumentTextDetectionRequestFilterSensitiveLog: (obj: GetDocumentTextDetectionRequest) => any;
-/**
- * @internal
- */
-export declare const GetDocumentTextDetectionResponseFilterSensitiveLog: (obj: GetDocumentTextDetectionResponse) => any;
-/**
- * @internal
- */
-export declare const GetExpenseAnalysisRequestFilterSensitiveLog: (obj: GetExpenseAnalysisRequest) => any;
-/**
- * @internal
- */
-export declare const GetExpenseAnalysisResponseFilterSensitiveLog: (obj: GetExpenseAnalysisResponse) => any;
-/**
- * @internal
- */
-export declare const GetLendingAnalysisRequestFilterSensitiveLog: (obj: GetLendingAnalysisRequest) => any;
-/**
- * @internal
- */
-export declare const PredictionFilterSensitiveLog: (obj: Prediction) => any;
-/**
- * @internal
- */
-export declare const PageClassificationFilterSensitiveLog: (obj: PageClassification) => any;
-/**
- * @internal
- */
-export declare const LendingResultFilterSensitiveLog: (obj: LendingResult) => any;
-/**
- * @internal
- */
-export declare const GetLendingAnalysisResponseFilterSensitiveLog: (obj: GetLendingAnalysisResponse) => any;
-/**
- * @internal
- */
-export declare const GetLendingAnalysisSummaryRequestFilterSensitiveLog: (obj: GetLendingAnalysisSummaryRequest) => any;
-/**
- * @internal
- */
-export declare const LendingSummaryFilterSensitiveLog: (obj: LendingSummary) => any;
-/**
- * @internal
- */
-export declare const GetLendingAnalysisSummaryResponseFilterSensitiveLog: (obj: GetLendingAnalysisSummaryResponse) => any;
-/**
- * @internal
- */
-export declare const NotificationChannelFilterSensitiveLog: (obj: NotificationChannel) => any;
-/**
- * @internal
- */
-export declare const OutputConfigFilterSensitiveLog: (obj: OutputConfig) => any;
-/**
- * @internal
- */
-export declare const StartDocumentAnalysisRequestFilterSensitiveLog: (obj: StartDocumentAnalysisRequest) => any;
-/**
- * @internal
- */
-export declare const StartDocumentAnalysisResponseFilterSensitiveLog: (obj: StartDocumentAnalysisResponse) => any;
-/**
- * @internal
- */
-export declare const StartDocumentTextDetectionRequestFilterSensitiveLog: (obj: StartDocumentTextDetectionRequest) => any;
-/**
- * @internal
- */
-export declare const StartDocumentTextDetectionResponseFilterSensitiveLog: (obj: StartDocumentTextDetectionResponse) => any;
-/**
- * @internal
- */
-export declare const StartExpenseAnalysisRequestFilterSensitiveLog: (obj: StartExpenseAnalysisRequest) => any;
-/**
- * @internal
- */
-export declare const StartExpenseAnalysisResponseFilterSensitiveLog: (obj: StartExpenseAnalysisResponse) => any;
-/**
- * @internal
- */
-export declare const StartLendingAnalysisRequestFilterSensitiveLog: (obj: StartLendingAnalysisRequest) => any;
-/**
- * @internal
- */
-export declare const StartLendingAnalysisResponseFilterSensitiveLog: (obj: StartLendingAnalysisResponse) => any;