@aws-sdk/client-comprehend 3.218.0 → 3.223.0

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

@@ -166,6 +166,38 @@ export declare class InternalServerException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
+export declare enum InvalidRequestDetailReason {
+    DOCUMENT_SIZE_EXCEEDED = "DOCUMENT_SIZE_EXCEEDED",
+    PAGE_LIMIT_EXCEEDED = "PAGE_LIMIT_EXCEEDED",
+    TEXTRACT_ACCESS_DENIED = "TEXTRACT_ACCESS_DENIED",
+    UNSUPPORTED_DOC_TYPE = "UNSUPPORTED_DOC_TYPE"
+}
+/**
+ * <p>Provides additional detail about why the request failed:</p>
+ *          <ul>
+ *             <li>
+ *                <p>Document size is too large - Check the size of your file and resubmit the request.</p>
+ *             </li>
+ *             <li>
+ *                <p>Document type is not supported - Check the file type and resubmit the request.</p>
+ *             </li>
+ *             <li>
+ *                <p>Too many pages in the document - Check the number of pages in your file and resubmit the request.</p>
+ *             </li>
+ *             <li>
+ *                <p>Access denied to Amazon Textract - Verify that your account has permission to use Amazon Textract API operations and resubmit the request.</p>
+ *             </li>
+ *          </ul>
+ */
+export interface InvalidRequestDetail {
+    /**
+     * <p>Reason code is <code>INVALID_DOCUMENT</code>.</p>
+     */
+    Reason?: InvalidRequestDetailReason | string;
+}
+export declare enum InvalidRequestReason {
+    INVALID_DOCUMENT = "INVALID_DOCUMENT"
+}
 /**
  * <p>The request is invalid.</p>
  */
@@ -173,6 +205,25 @@ export declare class InvalidRequestException extends __BaseException {
     readonly name: "InvalidRequestException";
     readonly $fault: "client";
     Message?: string;
+    Reason?: InvalidRequestReason | string;
+    /**
+     * <p>Provides additional detail about why the request failed:</p>
+     *          <ul>
+     *             <li>
+     *                <p>Document size is too large - Check the size of your file and resubmit the request.</p>
+     *             </li>
+     *             <li>
+     *                <p>Document type is not supported - Check the file type and resubmit the request.</p>
+     *             </li>
+     *             <li>
+     *                <p>Too many pages in the document - Check the number of pages in your file and resubmit the request.</p>
+     *             </li>
+     *             <li>
+     *                <p>Access denied to Amazon Textract - Verify that your account has permission to use Amazon Textract API operations and resubmit the request.</p>
+     *             </li>
+     *          </ul>
+     */
+    Detail?: InvalidRequestDetail;
     /**
      * @internal
      */
@@ -216,6 +267,44 @@ export interface BatchDetectEntitiesRequest {
      */
     LanguageCode: LanguageCode | string | undefined;
 }
+/**
+ * <p>Nested block contained within a block.</p>
+ */
+export interface ChildBlock {
+    /**
+     * <p>Unique identifier for the child block.</p>
+     */
+    ChildBlockId?: string;
+    /**
+     * <p>Offset of the start of the child block within its parent block.</p>
+     */
+    BeginOffset?: number;
+    /**
+     * <p>Offset of the end of the child block within its parent block.</p>
+     */
+    EndOffset?: number;
+}
+/**
+ * <p>A reference to a block. </p>
+ */
+export interface BlockReference {
+    /**
+     * <p>Unique identifier for the block.</p>
+     */
+    BlockId?: string;
+    /**
+     * <p>Offset of the start of the block within its parent block.</p>
+     */
+    BeginOffset?: number;
+    /**
+     * <p>Offset of the end of the block within its parent block.</p>
+     */
+    EndOffset?: number;
+    /**
+     * <p>List of child blocks within this block.</p>
+     */
+    ChildBlocks?: ChildBlock[];
+}
 export declare enum EntityType {
     COMMERCIAL_ITEM = "COMMERCIAL_ITEM",
     DATE = "DATE",
@@ -238,7 +327,10 @@ export interface Entity {
      */
     Score?: number;
     /**
-     * <p>The entity's type.</p>
+     * <p>The entity type. For entity detection using the built-in model, this field contains one of the
+     *       standard entity types listed below.</p>
+     *          <p>For custom entity detection, this field contains one of the
+     *       entity types that you specified when you trained your custom model.</p>
      */
     Type?: EntityType | string;
     /**
@@ -248,13 +340,19 @@ export interface Entity {
     /**
      * <p>The zero-based offset from the beginning of the source text to the first character in the
      *       entity.</p>
+     *          <p>This field is empty for non-text input.</p>
      */
     BeginOffset?: number;
     /**
      * <p>The zero-based offset from the beginning of the source text to the last character in the
      *       entity.</p>
+     *          <p>This field is empty for non-text input.</p>
      */
     EndOffset?: number;
+    /**
+     * <p>A reference to each block for this entity. This field is empty for plain-text input.</p>
+     */
+    BlockReferences?: BlockReference[];
 }
 /**
  * <p>The result of calling the  operation. The
@@ -697,6 +795,122 @@ export interface BatchDetectTargetedSentimentResponse {
      */
     ErrorList: BatchItemError[] | undefined;
 }
+export declare enum BlockType {
+    LINE = "LINE",
+    WORD = "WORD"
+}
+/**
+ * <p>The bounding box around the detected page
+ *      or around an 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). </p>
+ *          <p>For additional information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/API_BoundingBox.html">BoundingBox</a> in the Amazon Textract API reference.</p>
+ */
+export interface BoundingBox {
+    /**
+     * <p>The height of the bounding box as a ratio of the overall document page height.</p>
+     */
+    Height?: number;
+    /**
+     * <p>The left coordinate of the bounding box as a ratio of overall document page width.</p>
+     */
+    Left?: number;
+    /**
+     * <p>The top coordinate of the bounding box as a ratio of overall document page height.</p>
+     */
+    Top?: number;
+    /**
+     * <p>The width of the bounding box as a ratio of the overall document page width.</p>
+     */
+    Width?: number;
+}
+/**
+ * <p>The X and Y coordinates of a point on a document page.</p>
+ *          <p>For additional information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/API_Point.html">Point</a> in the Amazon Textract API reference.</p>
+ */
+export interface Point {
+    /**
+     * <p>The value of the X coordinate for a point on a polygon</p>
+     */
+    X?: number;
+    /**
+     * <p>The value of the Y coordinate for a point on a polygon</p>
+     */
+    Y?: number;
+}
+/**
+ * <p>Information about the location of items on a document page.</p>
+ *          <p>For additional information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/API_Geometry.html">Geometry</a> in the Amazon Textract API reference.</p>
+ */
+export interface Geometry {
+    /**
+     * <p>An axis-aligned coarse representation of the location of the recognized item on the
+     *       document page.</p>
+     */
+    BoundingBox?: BoundingBox;
+    /**
+     * <p>Within the bounding box, a fine-grained polygon around the recognized item.</p>
+     */
+    Polygon?: Point[];
+}
+export declare enum RelationshipType {
+    CHILD = "CHILD"
+}
+/**
+ * <p>List of child blocks for the current block.</p>
+ */
+export interface RelationshipsListItem {
+    /**
+     * <p>Identifers of the child blocks.</p>
+     */
+    Ids?: string[];
+    /**
+     * <p>Only supported relationship is a child relationship.</p>
+     */
+    Type?: RelationshipType | string;
+}
+/**
+ * <p>Information about each word or line of text in the input document.</p>
+ *          <p>For additional information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/API_Block.html">Block</a> in the Amazon Textract API reference.</p>
+ */
+export interface Block {
+    /**
+     * <p>Unique identifier for the block.</p>
+     */
+    Id?: string;
+    /**
+     * <p>The block represents a line of text or one word of text.</p>
+     *          <ul>
+     *             <li>
+     *                <p>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.</p>
+     *             </li>
+     *             <li>
+     *                <p>LINE - A string of tab-delimited, contiguous words
+     *         that are detected on a document page</p>
+     *             </li>
+     *          </ul>
+     */
+    BlockType?: BlockType | string;
+    /**
+     * <p>The word or line of text extracted from the block.</p>
+     */
+    Text?: string;
+    /**
+     * <p>Page number where the block appears.</p>
+     */
+    Page?: number;
+    /**
+     * <p>Co-ordinates of the rectangle or polygon that contains the text.</p>
+     */
+    Geometry?: Geometry;
+    /**
+     * <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. </p>
+     */
+    Relationships?: RelationshipsListItem[];
+}
 /**
  * <p>Describes the result metrics for the test data associated with an documentation
  *       classifier.</p>
@@ -779,15 +993,121 @@ export interface ClassifierMetadata {
      */
     EvaluationMetrics?: ClassifierEvaluationMetrics;
 }
+export declare enum DocumentReadAction {
+    TEXTRACT_ANALYZE_DOCUMENT = "TEXTRACT_ANALYZE_DOCUMENT",
+    TEXTRACT_DETECT_DOCUMENT_TEXT = "TEXTRACT_DETECT_DOCUMENT_TEXT"
+}
+export declare enum DocumentReadMode {
+    FORCE_DOCUMENT_READ_ACTION = "FORCE_DOCUMENT_READ_ACTION",
+    SERVICE_DEFAULT = "SERVICE_DEFAULT"
+}
+export declare enum DocumentReadFeatureTypes {
+    FORMS = "FORMS",
+    TABLES = "TABLES"
+}
+/**
+ * <p>Provides configuration parameters to override the default actions for extracting text from PDF documents and image files. </p>
+ *          <p> By default, Amazon Comprehend performs the following actions to extract text from files, based on the input file type: </p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <b>Word files</b> - Amazon Comprehend parser extracts the text. </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <b>Digital PDF files</b> - Amazon Comprehend parser extracts the text. </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <b>Image files and scanned PDF files</b> - Amazon Comprehend uses the Amazon Textract <code>DetectDocumentText</code>
+ *           API to extract the text. </p>
+ *             </li>
+ *          </ul>
+ *          <p>
+ *             <code>DocumentReaderConfig</code> does not apply to plain text files or Word files.</p>
+ *          <p>
+ *         For image files and PDF documents, you can override these default actions using the fields listed below.
+ *         For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/detecting-cer.html#detecting-cer-pdf">
+ *         Setting text extraction options</a>.
+ *     </p>
+ */
+export interface DocumentReaderConfig {
+    /**
+     * <p>This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files.
+     *       Enter one of the following values:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>TEXTRACT_DETECT_DOCUMENT_TEXT</code> - The Amazon Comprehend service uses the <code>DetectDocumentText</code>
+     *            API operation. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>TEXTRACT_ANALYZE_DOCUMENT</code> - The Amazon Comprehend service uses the <code>AnalyzeDocument</code>
+     *           API operation. </p>
+     *             </li>
+     *          </ul>
+     */
+    DocumentReadAction: DocumentReadAction | string | undefined;
+    /**
+     * <p>Determines the text extraction actions for PDF files. Enter one of the following values:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>SERVICE_DEFAULT</code> - use the Amazon Comprehend service defaults for PDF files.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>FORCE_DOCUMENT_READ_ACTION</code> - Amazon Comprehend uses the Textract API specified by
+     *           DocumentReadAction for all PDF files, including digital PDF files. </p>
+     *             </li>
+     *          </ul>
+     */
+    DocumentReadMode?: DocumentReadMode | string;
+    /**
+     * <p>Specifies the type of Amazon Textract features to apply. If you chose <code>TEXTRACT_ANALYZE_DOCUMENT</code>
+     *       as the read action, you must specify one or both of the following values:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>TABLES</code> - Returns information about any tables that are detected in the input document. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>FORMS</code> - Returns information and the data from any forms that are detected in the input document. </p>
+     *             </li>
+     *          </ul>
+     */
+    FeatureTypes?: (DocumentReadFeatureTypes | string)[];
+}
 export interface ClassifyDocumentRequest {
     /**
-     * <p>The document text to be analyzed.</p>
+     * <p>The document text to be analyzed. If you enter text using this parameter,
+     *       do not use the <code>Bytes</code> parameter.</p>
      */
-    Text: string | undefined;
+    Text?: string;
     /**
      * <p>The Amazon Resource Number (ARN) of the endpoint. For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html">Managing endpoints</a>.</p>
      */
     EndpointArn: string | undefined;
+    /**
+     * <p>Use the <code>Bytes</code> parameter to input a text, PDF, Word or image file.
+     *       You can also use the <code>Bytes</code> parameter to input an Amazon Textract <code>DetectDocumentText</code>
+     *       or <code>AnalyzeDocument</code> output file.</p>
+     *          <p>Provide the input document as a sequence of base64-encoded bytes.
+     *       If your code uses an Amazon Web Services SDK to classify documents, the SDK may encode
+     *       the document file bytes for you. </p>
+     *          <p>The maximum length of this field depends on the input document type. For details, see
+     *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html">
+     *         Inputs for real-time custom analysis</a> in the Comprehend Developer Guide. </p>
+     *          <p>If you use the <code>Bytes</code> parameter, do not use the <code>Text</code> parameter.</p>
+     */
+    Bytes?: Uint8Array;
+    /**
+     * <p>Provides configuration parameters to override the default actions for extracting text
+     *       from PDF documents and image files.</p>
+     */
+    DocumentReaderConfig?: DocumentReaderConfig;
 }
 /**
  * <p>Specifies the class that categorizes the document being analyzed</p>
@@ -801,6 +1121,105 @@ export interface DocumentClass {
      * <p>The confidence score that Amazon Comprehend has this class correctly attributed.</p>
      */
     Score?: number;
+    /**
+     * <p>Page number in the input document. This field is present
+     *       in the response only if your request includes the <code>Byte</code> parameter. </p>
+     */
+    Page?: number;
+}
+/**
+ * <p>Array of the number of characters extracted from each page.</p>
+ */
+export interface ExtractedCharactersListItem {
+    /**
+     * <p>Page number.</p>
+     */
+    Page?: number;
+    /**
+     * <p>Number of characters extracted from each page.</p>
+     */
+    Count?: number;
+}
+/**
+ * <p>Information about the document, discovered during text extraction.</p>
+ */
+export interface DocumentMetadata {
+    /**
+     * <p>Number of pages in the document.</p>
+     */
+    Pages?: number;
+    /**
+     * <p>List of pages in the document, with the number of characters extracted from each page.</p>
+     */
+    ExtractedCharacters?: ExtractedCharactersListItem[];
+}
+export declare enum DocumentType {
+    IMAGE = "IMAGE",
+    MS_WORD = "MS_WORD",
+    NATIVE_PDF = "NATIVE_PDF",
+    PLAIN_TEXT = "PLAIN_TEXT",
+    SCANNED_PDF = "SCANNED_PDF",
+    TEXTRACT_ANALYZE_DOCUMENT_JSON = "TEXTRACT_ANALYZE_DOCUMENT_JSON",
+    TEXTRACT_DETECT_DOCUMENT_TEXT_JSON = "TEXTRACT_DETECT_DOCUMENT_TEXT_JSON"
+}
+/**
+ * <p>Document type for each page in the document.</p>
+ */
+export interface DocumentTypeListItem {
+    /**
+     * <p>Page number.</p>
+     */
+    Page?: number;
+    /**
+     * <p>Document type.</p>
+     */
+    Type?: DocumentType | string;
+}
+export declare enum PageBasedErrorCode {
+    INTERNAL_SERVER_ERROR = "INTERNAL_SERVER_ERROR",
+    PAGE_CHARACTERS_EXCEEDED = "PAGE_CHARACTERS_EXCEEDED",
+    PAGE_SIZE_EXCEEDED = "PAGE_SIZE_EXCEEDED",
+    TEXTRACT_BAD_PAGE = "TEXTRACT_BAD_PAGE",
+    TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED = "TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED"
+}
+/**
+ * <p>Text extraction encountered one or more page-level errors in the input document.</p>
+ *          <p>The <code>ErrorCode</code> contains one of the following values:</p>
+ *          <ul>
+ *             <li>
+ *                <p>TEXTRACT_BAD_PAGE - Amazon Textract cannot read the page. For more information
+ *           about page limits in Amazon Textract, see <a href="https://docs.aws.amazon.com/textract/latest/dg/limits-document.html">
+ *             Page Quotas in Amazon Textract</a>.</p>
+ *             </li>
+ *             <li>
+ *                <p>TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED - The number of requests exceeded your throughput limit.
+ *           For more information about throughput quotas in Amazon Textract, see <a href="https://docs.aws.amazon.com/textract/latest/dg/limits-quotas-explained.html">
+ *             Default quotas in Amazon Textract</a>.</p>
+ *             </li>
+ *             <li>
+ *                <p>PAGE_CHARACTERS_EXCEEDED - Too many text characters on the page (10,000 characters maximum).</p>
+ *             </li>
+ *             <li>
+ *                <p>PAGE_SIZE_EXCEEDED - The maximum page size is 10 MB.</p>
+ *             </li>
+ *             <li>
+ *                <p>INTERNAL_SERVER_ERROR - The request encountered a service issue. Try the API request again.</p>
+ *             </li>
+ *          </ul>
+ */
+export interface ErrorsListItem {
+    /**
+     * <p>Page number where the error occurred.</p>
+     */
+    Page?: number;
+    /**
+     * <p>Error code for the cause of the error.</p>
+     */
+    ErrorCode?: PageBasedErrorCode | string;
+    /**
+     * <p>Text message explaining the reason for the error.</p>
+     */
+    ErrorMessage?: string;
 }
 /**
  * <p>Specifies one of the label or labels that categorize the document being analyzed.</p>
@@ -814,6 +1233,11 @@ export interface DocumentLabel {
      * <p>The confidence score that Amazon Comprehend has this label correctly attributed.</p>
      */
     Score?: number;
+    /**
+     * <p>Page number where the label occurs. This field is present
+     *       in the response only if your request includes the <code>Byte</code> parameter. </p>
+     */
+    Page?: number;
 }
 export interface ClassifyDocumentResponse {
     /**
@@ -830,6 +1254,21 @@ export interface ClassifyDocumentResponse {
      *       action movie, a science fiction movie, and a comedy, all at the same time. </p>
      */
     Labels?: DocumentLabel[];
+    /**
+     * <p>Extraction information about the document. This field is present
+     *       in the response only if your request includes the <code>Byte</code> parameter. </p>
+     */
+    DocumentMetadata?: DocumentMetadata;
+    /**
+     * <p>The document type for each page in the input document. This field is present
+     *       in the response only if your request includes the <code>Byte</code> parameter. </p>
+     */
+    DocumentType?: DocumentTypeListItem[];
+    /**
+     * <p>Page-level errors that the system detected while processing the input document.
+     *       The field is empty if the system encountered no errors.</p>
+     */
+    Errors?: ErrorsListItem[];
 }
 /**
  * <p>The specified resource is not available. Check the resource and try your request
@@ -1480,9 +1919,11 @@ export interface CreateEntityRecognizerRequest {
      */
     ClientRequestToken?: string;
     /**
-     * <p> You can specify any of the following languages supported by Amazon Comprehend: English
+     * <p> You can specify any of the following languages: English
      *       ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt").
-     *       All documents must be in the same language.</p>
+     *       If you plan to use this entity recognizer with PDF, Word, or image input files, you must
+     *       specify English as the language.
+     *       All training documents must be in the same language.</p>
      */
     LanguageCode: LanguageCode | string | undefined;
     /**
@@ -1592,61 +2033,9 @@ export interface DescribeDocumentClassificationJobRequest {
      */
     JobId: string | undefined;
 }
-export declare enum DocumentReadAction {
-    TEXTRACT_ANALYZE_DOCUMENT = "TEXTRACT_ANALYZE_DOCUMENT",
-    TEXTRACT_DETECT_DOCUMENT_TEXT = "TEXTRACT_DETECT_DOCUMENT_TEXT"
-}
-export declare enum DocumentReadMode {
-    FORCE_DOCUMENT_READ_ACTION = "FORCE_DOCUMENT_READ_ACTION",
-    SERVICE_DEFAULT = "SERVICE_DEFAULT"
-}
-export declare enum DocumentReadFeatureTypes {
-    FORMS = "FORMS",
-    TABLES = "TABLES"
-}
-/**
- * <p>The input properties for a topic detection job.</p>
- */
-export interface DocumentReaderConfig {
-    /**
-     * <p>This enum field will start with two values which will apply to PDFs:</p>
-     *          <ul>
-     *             <li>
-     *                <p>
-     *                   <code>TEXTRACT_DETECT_DOCUMENT_TEXT</code> - The service calls DetectDocumentText
-     *           for PDF documents per page.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>TEXTRACT_ANALYZE_DOCUMENT</code> - The service calls AnalyzeDocument for PDF
-     *           documents per page.</p>
-     *             </li>
-     *          </ul>
-     */
-    DocumentReadAction: DocumentReadAction | string | undefined;
-    /**
-     * <p>This enum field provides two values:</p>
-     *          <ul>
-     *             <li>
-     *                <p>
-     *                   <code>SERVICE_DEFAULT</code> - use service defaults for Document reading. For
-     *           Digital PDF it would mean using an internal parser instead of Textract APIs</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>FORCE_DOCUMENT_READ_ACTION</code> - Always use specified action for
-     *           DocumentReadAction, including Digital PDF. </p>
-     *             </li>
-     *          </ul>
-     */
-    DocumentReadMode?: DocumentReadMode | string;
-    /**
-     * <p>Specifies how the text in an input file should be processed:</p>
-     */
-    FeatureTypes?: (DocumentReadFeatureTypes | string)[];
-}
 /**
- * <p>The input properties for an inference job.</p>
+ * <p>The input properties for an inference job. The document reader config field applies
+ *       only to non-text inputs for custom analysis.</p>
  */
 export interface InputDataConfig {
     /**
@@ -1677,11 +2066,8 @@ export interface InputDataConfig {
      */
     InputFormat?: InputFormat | string;
     /**
-     * <p>The document reader config field applies only for InputDataConfig of
-     *       StartEntitiesDetectionJob. </p>
-     *          <p>Use DocumentReaderConfig to provide specifications about how you want your inference
-     *       documents read. Currently it applies for PDF documents in StartEntitiesDetectionJob custom
-     *       inference.</p>
+     * <p>Provides configuration parameters to override the default actions for extracting text
+     *       from PDF documents and image files.</p>
      */
     DocumentReaderConfig?: DocumentReaderConfig;
 }
@@ -2770,7 +3156,7 @@ export interface DescribePiiEntitiesDetectionJobResponse {
 }
 export interface DescribeResourcePolicyRequest {
     /**
-     * <p>The Amazon Resource Name (ARN) of the policy to describe.</p>
+     * <p>The Amazon Resource Name (ARN) of the custom model version that has the resource policy.</p>
      */
     ResourceArn: string | undefined;
 }
@@ -2941,7 +3327,8 @@ export interface TargetedSentimentDetectionJobProperties {
      */
     EndTime?: Date;
     /**
-     * <p>The input properties for an inference job.</p>
+     * <p>The input properties for an inference job. The document reader config field applies
+     *       only to non-text inputs for custom analysis.</p>
      */
     InputDataConfig?: InputDataConfig;
     /**
@@ -3103,15 +3490,16 @@ export interface DetectDominantLanguageResponse {
 }
 export interface DetectEntitiesRequest {
     /**
-     * <p>A UTF-8 text string. The maximum string size is 100 KB.</p>
+     * <p>A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter,
+     *     do not use the <code>Bytes</code> parameter.</p>
      */
-    Text: string | undefined;
+    Text?: string;
     /**
      * <p>The language of the input documents. You can specify any of the primary languages
-     *       supported by Amazon Comprehend. All documents must be in the same language.</p>
-     *          <p>If your request includes the endpoint for a custom entity recognition model, Amazon
+     *       supported by Amazon Comprehend. If your request includes the endpoint for a custom entity recognition model, Amazon
      *       Comprehend uses the language of your custom model, and it ignores any language code that you
      *       specify here.</p>
+     *          <p>All input documents must be in the same language.</p>
      */
     LanguageCode?: LanguageCode | string;
     /**
@@ -3123,6 +3511,30 @@ export interface DetectEntitiesRequest {
      *          <p>For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html">Managing endpoints</a>.</p>
      */
     EndpointArn?: string;
+    /**
+     * <p>This field applies only when you use a custom entity recognition model that
+     *       was trained with PDF annotations. For other cases,
+     *       enter your text input in the <code>Text</code> field.</p>
+     *          <p>
+     *       Use the <code>Bytes</code> parameter to input a text, PDF, Word or image file.
+     *       Using a plain-text file in the <code>Bytes</code> parameter is equivelent to using the
+     *       <code>Text</code> parameter (the <code>Entities</code> field in the response is identical).</p>
+     *          <p>You can also use the <code>Bytes</code> parameter to input an Amazon Textract <code>DetectDocumentText</code>
+     *       or <code>AnalyzeDocument</code> output file.</p>
+     *          <p>Provide the input document as a sequence of base64-encoded bytes.
+     *       If your code uses an Amazon Web Services SDK to detect entities, the SDK may encode
+     *       the document file bytes for you. </p>
+     *          <p>The maximum length of this field depends on the input document type. For details, see
+     *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html">
+     *         Inputs for real-time custom analysis</a> in the Comprehend Developer Guide. </p>
+     *          <p>If you use the <code>Bytes</code> parameter, do not use the <code>Text</code> parameter.</p>
+     */
+    Bytes?: Uint8Array;
+    /**
+     * <p>Provides configuration parameters to override the default actions for extracting text
+     *       from PDF documents and image files.</p>
+     */
+    DocumentReaderConfig?: DocumentReaderConfig;
 }
 export interface DetectEntitiesResponse {
     /**
@@ -3136,6 +3548,29 @@ export interface DetectEntitiesResponse {
      *     </p>
      */
     Entities?: Entity[];
+    /**
+     * <p>Information about the document, discovered during text extraction. This field is present
+     *       in the response only if your request used the <code>Byte</code> parameter. </p>
+     */
+    DocumentMetadata?: DocumentMetadata;
+    /**
+     * <p>The document type for each page in the input document. This field is present
+     *       in the response only if your request used the <code>Byte</code> parameter. </p>
+     */
+    DocumentType?: DocumentTypeListItem[];
+    /**
+     * <p>Information about each block of text in the input document.
+     *       Blocks are nested. A page block contains a block for each line of text,
+     *       which contains a block for each word. </p>
+     *          <p>The <code>Block</code> content for a Word input document does not include a <code>Geometry</code> field.</p>
+     *          <p>The <code>Block</code> field is not present in the response for plain-text inputs.</p>
+     */
+    Blocks?: Block[];
+    /**
+     * <p>Page-level errors that the system detected while processing the input document.
+     *       The field is empty if the system encountered no errors.</p>
+     */
+    Errors?: ErrorsListItem[];
 }
 export interface DetectKeyPhrasesRequest {
     /**
@@ -4729,7 +5164,8 @@ export interface StartSentimentDetectionJobResponse {
 }
 export interface StartTargetedSentimentDetectionJobRequest {
     /**
-     * <p>The input properties for an inference job.</p>
+     * <p>The input properties for an inference job. The document reader config field applies
+     *       only to non-text inputs for custom analysis.</p>
      */
     InputDataConfig: InputDataConfig | undefined;
     /**
@@ -5163,10 +5599,22 @@ export declare const BatchDetectDominantLanguageItemResultFilterSensitiveLog: (o
  * @internal
  */
 export declare const BatchDetectDominantLanguageResponseFilterSensitiveLog: (obj: BatchDetectDominantLanguageResponse) => any;
+/**
+ * @internal
+ */
+export declare const InvalidRequestDetailFilterSensitiveLog: (obj: InvalidRequestDetail) => any;
 /**
  * @internal
  */
 export declare const BatchDetectEntitiesRequestFilterSensitiveLog: (obj: BatchDetectEntitiesRequest) => any;
+/**
+ * @internal
+ */
+export declare const ChildBlockFilterSensitiveLog: (obj: ChildBlock) => any;
+/**
+ * @internal
+ */
+export declare const BlockReferenceFilterSensitiveLog: (obj: BlockReference) => any;
 /**
  * @internal
  */
@@ -5255,6 +5703,26 @@ export declare const BatchDetectTargetedSentimentItemResultFilterSensitiveLog: (
  * @internal
  */
 export declare const BatchDetectTargetedSentimentResponseFilterSensitiveLog: (obj: BatchDetectTargetedSentimentResponse) => 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 RelationshipsListItemFilterSensitiveLog: (obj: RelationshipsListItem) => any;
+/**
+ * @internal
+ */
+export declare const BlockFilterSensitiveLog: (obj: Block) => any;
 /**
  * @internal
  */
@@ -5263,6 +5731,10 @@ export declare const ClassifierEvaluationMetricsFilterSensitiveLog: (obj: Classi
  * @internal
  */
 export declare const ClassifierMetadataFilterSensitiveLog: (obj: ClassifierMetadata) => any;
+/**
+ * @internal
+ */
+export declare const DocumentReaderConfigFilterSensitiveLog: (obj: DocumentReaderConfig) => any;
 /**
  * @internal
  */
@@ -5271,6 +5743,22 @@ export declare const ClassifyDocumentRequestFilterSensitiveLog: (obj: ClassifyDo
  * @internal
  */
 export declare const DocumentClassFilterSensitiveLog: (obj: DocumentClass) => any;
+/**
+ * @internal
+ */
+export declare const ExtractedCharactersListItemFilterSensitiveLog: (obj: ExtractedCharactersListItem) => any;
+/**
+ * @internal
+ */
+export declare const DocumentMetadataFilterSensitiveLog: (obj: DocumentMetadata) => any;
+/**
+ * @internal
+ */
+export declare const DocumentTypeListItemFilterSensitiveLog: (obj: DocumentTypeListItem) => any;
+/**
+ * @internal
+ */
+export declare const ErrorsListItemFilterSensitiveLog: (obj: ErrorsListItem) => any;
 /**
  * @internal
  */
@@ -5387,10 +5875,6 @@ export declare const DeleteResourcePolicyResponseFilterSensitiveLog: (obj: Delet
  * @internal
  */
 export declare const DescribeDocumentClassificationJobRequestFilterSensitiveLog: (obj: DescribeDocumentClassificationJobRequest) => any;
-/**
- * @internal
- */
-export declare const DocumentReaderConfigFilterSensitiveLog: (obj: DocumentReaderConfig) => any;
 /**
  * @internal
  */