@aws-sdk/client-textract 3.199.0 → 3.201.0

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

@@ -125,7 +125,8 @@ export interface Query {
      */
     Alias?: string;
     /**
-     * <p>List of pages associated with the query. The following is a list of rules for using this parameter.</p>
+     * <p>Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a
+     *          list of rules for using this parameter.</p>
      *          <ul>
      *             <li>
      *                <p>If a page is not specified, it is set to <code>["1"]</code> by default.</p>
@@ -135,8 +136,7 @@ export interface Query {
      *                <code>0 1 2 3 4 5 6 7 8 9 - *</code>. No whitespace is allowed.</p>
      *             </li>
      *             <li>
-     *                <p>When using <code>*</code> to indicate all pages, it must be the only element
-     *                in the string.</p>
+     *                <p>When using * to indicate all pages, it must be the only element in the list.</p>
      *             </li>
      *             <li>
      *                <p>You can use page intervals, such as <code>[“1-3”, “1-1”, “4-*”]</code>. Where <code>*</code> indicates last page of
@@ -160,23 +160,24 @@ export interface QueriesConfig {
 }
 export interface AnalyzeDocumentRequest {
     /**
-     * <p>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 JPEG, PNG, PDF, or TIFF format.</p>
+     * <p>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 JPEG, PNG, PDF, or TIFF format.</p>
      *          <p>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 <code>Bytes</code> field. </p>
      */
     Document: Document | undefined;
     /**
      * <p>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 form data.
-     *          To perform both types of analysis, add TABLES and FORMS to
-     *             <code>FeatureTypes</code>. All lines and words detected in the document are included in
-     *          the response (including text that isn't related to the value of <code>FeatureTypes</code>). </p>
+     *          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 <code>FeatureTypes</code>.
+     *          All lines and words detected in the document are included in the response (including text
+     *          that isn't related to the value of <code>FeatureTypes</code>). </p>
      */
     FeatureTypes: (FeatureType | string)[] | undefined;
     /**
-     * <p>Sets the configuration for the human in the loop workflow for analyzing documents.</p>
+     * <p>Sets the configuration for the human in the loop workflow for analyzing
+     *          documents.</p>
      */
     HumanLoopConfig?: HumanLoopConfig;
     /**
@@ -394,7 +395,7 @@ export interface Block {
      *             <li>
      *                <p>
      *                   <i>QUERY</i> - A question asked during the call of AnalyzeDocument. Contains an
-     *                alias and an ID that attachs it to its answer.</p>
+     *                alias and an ID that attaches it to its answer.</p>
      *             </li>
      *             <li>
      *                <p>
@@ -492,12 +493,13 @@ export interface Block {
      */
     SelectionStatus?: SelectionStatus | string;
     /**
-     * <p>The page on which a block was detected. <code>Page</code> is returned by asynchronous
-     *          operations. Page values greater than 1 are only returned for multipage documents that are
-     *          in PDF or TIFF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is
-     *          considered to be a single-page document. The value of <code>Page</code> is always 1.
-     *          Synchronous operations don't return <code>Page</code> because every input document is
-     *          considered to be a single-page document.</p>
+     * <p>The page on which a block was detected. <code>Page</code> is returned by synchronous and
+     *          asynchronous operations. Page values greater than 1 are only returned for multipage
+     *          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
+     *          because every input document is considered to be a single-page document.</p>
      */
     Page?: number;
     /**
@@ -714,6 +716,72 @@ export interface AnalyzeExpenseRequest {
      */
     Document: Document | undefined;
 }
+/**
+ * <p>Returns the kind of currency detected.</p>
+ */
+export interface ExpenseCurrency {
+    /**
+     * <p>Currency code for detected currency. the current supported codes are:</p>
+     *          <ul>
+     *             <li>
+     *                <p>USD</p>
+     *             </li>
+     *             <li>
+     *                <p>EUR</p>
+     *             </li>
+     *             <li>
+     *                <p>GBP</p>
+     *             </li>
+     *             <li>
+     *                <p>CAD</p>
+     *             </li>
+     *             <li>
+     *                <p>INR</p>
+     *             </li>
+     *             <li>
+     *                <p>JPY</p>
+     *             </li>
+     *             <li>
+     *                <p>CHF</p>
+     *             </li>
+     *             <li>
+     *                <p>AUD</p>
+     *             </li>
+     *             <li>
+     *                <p>CNY</p>
+     *             </li>
+     *             <li>
+     *                <p>BZR</p>
+     *             </li>
+     *             <li>
+     *                <p>SEK</p>
+     *             </li>
+     *             <li>
+     *                <p>HKD</p>
+     *             </li>
+     *          </ul>
+     */
+    Code?: string;
+    /**
+     * <p>Percentage confideence in the detected currency.</p>
+     */
+    Confidence?: number;
+}
+/**
+ * <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>
+ */
+export interface ExpenseGroupProperty {
+    /**
+     * <p>Informs you on whether the expense group is a name or an address.</p>
+     */
+    Types?: string[];
+    /**
+     * <p>Provides a group Id number, which will be the same for each in the group.</p>
+     */
+    Id?: string;
+}
 /**
  * <p>An object used to store information about the Value or Label detected by Amazon Textract.</p>
  */
@@ -766,6 +834,16 @@ export interface ExpenseField {
      * <p>The page number the value was detected on.</p>
      */
     PageNumber?: number;
+    /**
+     * <p>Shows the kind of currency, both the code and confidence associated with any monatary value
+     *          detected.</p>
+     */
+    Currency?: ExpenseCurrency;
+    /**
+     * <p>Shows which group a response object belongs to, such as whether an address line
+     *          belongs to the vendor's address or the recipent's address.</p>
+     */
+    GroupProperties?: ExpenseGroupProperty[];
 }
 /**
  * <p>A structure that holds information about the different lines found in a document's tables.</p>
@@ -806,6 +884,11 @@ export interface ExpenseDocument {
      * <p>Information detected on each table of a document, seperated into <code>LineItems</code>.</p>
      */
     LineItemGroups?: LineItemGroup[];
+    /**
+     * <p>This is a block object, the same as reported when DetectDocumentText is run on a document.
+     *       It provides word level recognition of text.</p>
+     */
+    Blocks?: Block[];
 }
 export interface AnalyzeExpenseResponse {
     /**
@@ -886,11 +969,15 @@ export interface IdentityDocument {
      *          Contains both normalized field and value of the extracted text.</p>
      */
     IdentityDocumentFields?: IdentityDocumentField[];
+    /**
+     * <p>Individual word recognition, as returned by document detection.</p>
+     */
+    Blocks?: Block[];
 }
 export interface AnalyzeIDResponse {
     /**
-     * <p>The list of documents processed by AnalyzeID. Includes a number denoting their
-     *          place in the list and the response structure for the document.</p>
+     * <p>The list of documents processed by AnalyzeID. Includes a number denoting their place in
+     *          the list and the response structure for the document.</p>
      */
     IdentityDocuments?: IdentityDocument[];
     /**
@@ -943,7 +1030,8 @@ export interface DocumentLocation {
 export interface GetDocumentAnalysisRequest {
     /**
      * <p>A unique identifier for the text-detection job. The <code>JobId</code> is returned from
-     *          <code>StartDocumentAnalysis</code>. A <code>JobId</code> value is only valid for 7 days.</p>
+     *             <code>StartDocumentAnalysis</code>. A <code>JobId</code> value is only valid for 7
+     *          days.</p>
      */
     JobId: string | undefined;
     /**
@@ -953,8 +1041,9 @@ export interface GetDocumentAnalysisRequest {
      */
     MaxResults?: number;
     /**
-     * <p>If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination
-     *          token in the response. You can use this pagination token to retrieve the next set of blocks.</p>
+     * <p>If the previous response was incomplete (because there are more blocks to retrieve),
+     *          Amazon Textract returns a pagination token in the response. You can use this pagination
+     *          token to retrieve the next set of blocks.</p>
      */
     NextToken?: string;
 }
@@ -979,8 +1068,9 @@ export interface Warning {
 }
 export interface GetDocumentAnalysisResponse {
     /**
-     * <p>Information about a document that Amazon Textract processed. <code>DocumentMetadata</code> is
-     *          returned in every page of paginated responses from an Amazon Textract video operation.</p>
+     * <p>Information about a document that Amazon Textract processed.
+     *             <code>DocumentMetadata</code> is returned in every page of paginated responses from an
+     *          Amazon Textract video operation.</p>
      */
     DocumentMetadata?: DocumentMetadata;
     /**
@@ -988,8 +1078,8 @@ export interface GetDocumentAnalysisResponse {
      */
     JobStatus?: JobStatus | string;
     /**
-     * <p>If the response is truncated, Amazon Textract returns this token. You can use this token in
-     *          the subsequent request to retrieve the next set of text detection results.</p>
+     * <p>If the response is truncated, Amazon Textract returns this token. You can use this token
+     *          in the subsequent request to retrieve the next set of text detection results.</p>
      */
     NextToken?: string;
     /**
@@ -1001,7 +1091,8 @@ export interface GetDocumentAnalysisResponse {
      */
     Warnings?: Warning[];
     /**
-     * <p>Returns if the detection job could not be completed. Contains explanation for what error occured.</p>
+     * <p>Returns if the detection job could not be completed. Contains explanation for what error
+     *          occured.</p>
      */
     StatusMessage?: string;
     /**
@@ -1431,6 +1522,14 @@ export declare const AnalyzeDocumentResponseFilterSensitiveLog: (obj: AnalyzeDoc
  * @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
  */

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

@@ -228,6 +228,14 @@ export declare class UnsupportedDocumentException extends __BaseException {
 export interface AnalyzeExpenseRequest {
   Document: Document | undefined;
 }
+export interface ExpenseCurrency {
+  Code?: string;
+  Confidence?: number;
+}
+export interface ExpenseGroupProperty {
+  Types?: string[];
+  Id?: string;
+}
 export interface ExpenseDetection {
   Text?: string;
   Geometry?: Geometry;
@@ -242,6 +250,8 @@ export interface ExpenseField {
   LabelDetection?: ExpenseDetection;
   ValueDetection?: ExpenseDetection;
   PageNumber?: number;
+  Currency?: ExpenseCurrency;
+  GroupProperties?: ExpenseGroupProperty[];
 }
 export interface LineItemFields {
   LineItemExpenseFields?: ExpenseField[];
@@ -254,6 +264,7 @@ export interface ExpenseDocument {
   ExpenseIndex?: number;
   SummaryFields?: ExpenseField[];
   LineItemGroups?: LineItemGroup[];
+  Blocks?: Block[];
 }
 export interface AnalyzeExpenseResponse {
   DocumentMetadata?: DocumentMetadata;
@@ -281,6 +292,7 @@ export interface IdentityDocumentField {
 export interface IdentityDocument {
   DocumentIndex?: number;
   IdentityDocumentFields?: IdentityDocumentField[];
+  Blocks?: Block[];
 }
 export interface AnalyzeIDResponse {
   IdentityDocuments?: IdentityDocument[];
@@ -464,6 +476,12 @@ export declare const AnalyzeDocumentResponseFilterSensitiveLog: (
 export declare const AnalyzeExpenseRequestFilterSensitiveLog: (
   obj: AnalyzeExpenseRequest
 ) => any;
+export declare const ExpenseCurrencyFilterSensitiveLog: (
+  obj: ExpenseCurrency
+) => any;
+export declare const ExpenseGroupPropertyFilterSensitiveLog: (
+  obj: ExpenseGroupProperty
+) => any;
 export declare const ExpenseDetectionFilterSensitiveLog: (
   obj: ExpenseDetection
 ) => any;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-textract",
   "description": "AWS SDK for JavaScript Textract Client for Node.js, Browser and React Native",
-  "version": "3.199.0",
+  "version": "3.201.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -19,44 +19,44 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "2.0.0",
     "@aws-crypto/sha256-js": "2.0.0",
-    "@aws-sdk/client-sts": "3.199.0",
-    "@aws-sdk/config-resolver": "3.198.0",
-    "@aws-sdk/credential-provider-node": "3.199.0",
-    "@aws-sdk/fetch-http-handler": "3.199.0",
-    "@aws-sdk/hash-node": "3.198.0",
-    "@aws-sdk/invalid-dependency": "3.198.0",
-    "@aws-sdk/middleware-content-length": "3.199.0",
-    "@aws-sdk/middleware-endpoint": "3.198.0",
-    "@aws-sdk/middleware-host-header": "3.198.0",
-    "@aws-sdk/middleware-logger": "3.198.0",
-    "@aws-sdk/middleware-recursion-detection": "3.198.0",
-    "@aws-sdk/middleware-retry": "3.198.0",
-    "@aws-sdk/middleware-serde": "3.198.0",
-    "@aws-sdk/middleware-signing": "3.198.0",
-    "@aws-sdk/middleware-stack": "3.198.0",
-    "@aws-sdk/middleware-user-agent": "3.198.0",
-    "@aws-sdk/node-config-provider": "3.198.0",
-    "@aws-sdk/node-http-handler": "3.199.0",
-    "@aws-sdk/protocol-http": "3.198.0",
-    "@aws-sdk/smithy-client": "3.198.0",
-    "@aws-sdk/types": "3.198.0",
-    "@aws-sdk/url-parser": "3.198.0",
+    "@aws-sdk/client-sts": "3.201.0",
+    "@aws-sdk/config-resolver": "3.201.0",
+    "@aws-sdk/credential-provider-node": "3.201.0",
+    "@aws-sdk/fetch-http-handler": "3.201.0",
+    "@aws-sdk/hash-node": "3.201.0",
+    "@aws-sdk/invalid-dependency": "3.201.0",
+    "@aws-sdk/middleware-content-length": "3.201.0",
+    "@aws-sdk/middleware-endpoint": "3.201.0",
+    "@aws-sdk/middleware-host-header": "3.201.0",
+    "@aws-sdk/middleware-logger": "3.201.0",
+    "@aws-sdk/middleware-recursion-detection": "3.201.0",
+    "@aws-sdk/middleware-retry": "3.201.0",
+    "@aws-sdk/middleware-serde": "3.201.0",
+    "@aws-sdk/middleware-signing": "3.201.0",
+    "@aws-sdk/middleware-stack": "3.201.0",
+    "@aws-sdk/middleware-user-agent": "3.201.0",
+    "@aws-sdk/node-config-provider": "3.201.0",
+    "@aws-sdk/node-http-handler": "3.201.0",
+    "@aws-sdk/protocol-http": "3.201.0",
+    "@aws-sdk/smithy-client": "3.201.0",
+    "@aws-sdk/types": "3.201.0",
+    "@aws-sdk/url-parser": "3.201.0",
     "@aws-sdk/util-base64-browser": "3.188.0",
-    "@aws-sdk/util-base64-node": "3.188.0",
+    "@aws-sdk/util-base64-node": "3.201.0",
     "@aws-sdk/util-body-length-browser": "3.188.0",
-    "@aws-sdk/util-body-length-node": "3.188.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.198.0",
-    "@aws-sdk/util-defaults-mode-node": "3.198.0",
-    "@aws-sdk/util-endpoints": "3.198.0",
-    "@aws-sdk/util-user-agent-browser": "3.198.0",
-    "@aws-sdk/util-user-agent-node": "3.198.0",
+    "@aws-sdk/util-body-length-node": "3.201.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.201.0",
+    "@aws-sdk/util-defaults-mode-node": "3.201.0",
+    "@aws-sdk/util-endpoints": "3.201.0",
+    "@aws-sdk/util-user-agent-browser": "3.201.0",
+    "@aws-sdk/util-user-agent-node": "3.201.0",
     "@aws-sdk/util-utf8-browser": "3.188.0",
-    "@aws-sdk/util-utf8-node": "3.199.0",
+    "@aws-sdk/util-utf8-node": "3.201.0",
     "tslib": "^2.3.1"
   },
   "devDependencies": {
     "@aws-sdk/service-client-documentation-generator": "3.188.0",
-    "@tsconfig/recommended": "1.0.1",
+    "@tsconfig/node14": "1.0.3",
     "@types/node": "^12.7.5",
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
@@ -70,7 +70,7 @@
     }
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=14.0.0"
   },
   "typesVersions": {
     "<4.0": {