@aws-sdk/client-textract 3.33.0 → 3.36.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (155) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/{dist/cjs → dist-cjs}/Textract.js +1 -7
  3. package/{dist/cjs → dist-cjs}/TextractClient.js +8 -19
  4. package/dist-cjs/commands/AnalyzeDocumentCommand.js +36 -0
  5. package/dist-cjs/commands/AnalyzeExpenseCommand.js +36 -0
  6. package/dist-cjs/commands/DetectDocumentTextCommand.js +36 -0
  7. package/dist-cjs/commands/GetDocumentAnalysisCommand.js +36 -0
  8. package/dist-cjs/commands/GetDocumentTextDetectionCommand.js +36 -0
  9. package/dist-cjs/commands/StartDocumentAnalysisCommand.js +36 -0
  10. package/dist-cjs/commands/StartDocumentTextDetectionCommand.js +36 -0
  11. package/{dist/cjs → dist-cjs}/endpoints.js +0 -1
  12. package/{dist/cjs → dist-cjs}/index.js +0 -1
  13. package/{dist/cjs → dist-cjs}/models/index.js +0 -1
  14. package/{dist/cjs → dist-cjs}/models/models_0.js +0 -148
  15. package/{dist/cjs → dist-cjs}/protocols/Aws_json1_1.js +0 -6
  16. package/{dist/cjs → dist-cjs}/runtimeConfig.browser.js +1 -5
  17. package/{dist/cjs → dist-cjs}/runtimeConfig.js +1 -5
  18. package/{dist/cjs → dist-cjs}/runtimeConfig.native.js +0 -4
  19. package/{dist/cjs → dist-cjs}/runtimeConfig.shared.js +1 -5
  20. package/{dist/es → dist-es}/Textract.js +2 -8
  21. package/{dist/es → dist-es}/TextractClient.js +2 -13
  22. package/dist-es/commands/AnalyzeDocumentCommand.js +39 -0
  23. package/{dist/es → dist-es}/commands/AnalyzeExpenseCommand.js +4 -43
  24. package/dist-es/commands/DetectDocumentTextCommand.js +39 -0
  25. package/dist-es/commands/GetDocumentAnalysisCommand.js +39 -0
  26. package/dist-es/commands/GetDocumentTextDetectionCommand.js +39 -0
  27. package/dist-es/commands/StartDocumentAnalysisCommand.js +39 -0
  28. package/dist-es/commands/StartDocumentTextDetectionCommand.js +39 -0
  29. package/{dist/es → dist-es}/endpoints.js +1 -2
  30. package/{dist/types/index.d.ts → dist-es/index.js} +0 -0
  31. package/{dist/types/models/index.d.ts → dist-es/models/index.js} +0 -0
  32. package/{dist/es → dist-es}/models/models_0.js +0 -148
  33. package/{dist/es → dist-es}/protocols/Aws_json1_1.js +338 -344
  34. package/{dist/es → dist-es}/runtimeConfig.browser.js +1 -5
  35. package/{dist/es → dist-es}/runtimeConfig.js +1 -5
  36. package/{dist/es → dist-es}/runtimeConfig.native.js +0 -4
  37. package/{dist/es → dist-es}/runtimeConfig.shared.js +1 -5
  38. package/{dist/types → dist-types}/Textract.d.ts +2 -2
  39. package/{dist/types → dist-types}/TextractClient.d.ts +8 -8
  40. package/{dist/types → dist-types}/commands/AnalyzeDocumentCommand.d.ts +3 -3
  41. package/{dist/types → dist-types}/commands/AnalyzeExpenseCommand.d.ts +3 -3
  42. package/{dist/types → dist-types}/commands/DetectDocumentTextCommand.d.ts +3 -3
  43. package/{dist/types → dist-types}/commands/GetDocumentAnalysisCommand.d.ts +3 -3
  44. package/{dist/types → dist-types}/commands/GetDocumentTextDetectionCommand.d.ts +3 -3
  45. package/{dist/types → dist-types}/commands/StartDocumentAnalysisCommand.d.ts +3 -3
  46. package/{dist/types → dist-types}/commands/StartDocumentTextDetectionCommand.d.ts +3 -3
  47. package/{dist/types → dist-types}/endpoints.d.ts +0 -0
  48. package/{index.ts → dist-types/index.d.ts} +0 -0
  49. package/{models/index.ts → dist-types/models/index.d.ts} +0 -0
  50. package/{dist/types → dist-types}/models/models_0.d.ts +0 -0
  51. package/{dist/types → dist-types}/protocols/Aws_json1_1.d.ts +2 -2
  52. package/{dist/types → dist-types}/runtimeConfig.browser.d.ts +0 -0
  53. package/{dist/types → dist-types}/runtimeConfig.d.ts +1 -1
  54. package/{dist/types → dist-types}/runtimeConfig.native.d.ts +0 -0
  55. package/{dist/types → dist-types}/runtimeConfig.shared.d.ts +0 -0
  56. package/dist-types/ts3.4/Textract.d.ts +40 -0
  57. package/{dist/types → dist-types}/ts3.4/TextractClient.d.ts +32 -99
  58. package/dist-types/ts3.4/commands/AnalyzeDocumentCommand.d.ts +17 -0
  59. package/dist-types/ts3.4/commands/AnalyzeExpenseCommand.d.ts +17 -0
  60. package/dist-types/ts3.4/commands/DetectDocumentTextCommand.d.ts +17 -0
  61. package/dist-types/ts3.4/commands/GetDocumentAnalysisCommand.d.ts +17 -0
  62. package/dist-types/ts3.4/commands/GetDocumentTextDetectionCommand.d.ts +17 -0
  63. package/dist-types/ts3.4/commands/StartDocumentAnalysisCommand.d.ts +17 -0
  64. package/dist-types/ts3.4/commands/StartDocumentTextDetectionCommand.d.ts +17 -0
  65. package/{dist/types → dist-types}/ts3.4/endpoints.d.ts +0 -0
  66. package/{dist/types → dist-types}/ts3.4/index.d.ts +0 -0
  67. package/{dist/types → dist-types}/ts3.4/models/index.d.ts +0 -0
  68. package/dist-types/ts3.4/models/models_0.d.ts +649 -0
  69. package/{dist/types → dist-types}/ts3.4/protocols/Aws_json1_1.d.ts +2 -2
  70. package/{dist/types → dist-types}/ts3.4/runtimeConfig.browser.d.ts +1 -3
  71. package/{dist/types → dist-types}/ts3.4/runtimeConfig.d.ts +2 -4
  72. package/{dist/types → dist-types}/ts3.4/runtimeConfig.native.d.ts +1 -3
  73. package/{dist/types → dist-types}/ts3.4/runtimeConfig.shared.d.ts +1 -3
  74. package/package.json +52 -49
  75. package/Textract.ts +0 -422
  76. package/TextractClient.ts +0 -270
  77. package/commands/AnalyzeDocumentCommand.ts +0 -124
  78. package/commands/AnalyzeExpenseCommand.ts +0 -107
  79. package/commands/DetectDocumentTextCommand.ts +0 -104
  80. package/commands/GetDocumentAnalysisCommand.ts +0 -138
  81. package/commands/GetDocumentTextDetectionCommand.ts +0 -118
  82. package/commands/StartDocumentAnalysisCommand.ts +0 -111
  83. package/commands/StartDocumentTextDetectionCommand.ts +0 -113
  84. package/dist/cjs/Textract.js.map +0 -1
  85. package/dist/cjs/TextractClient.js.map +0 -1
  86. package/dist/cjs/commands/AnalyzeDocumentCommand.js +0 -91
  87. package/dist/cjs/commands/AnalyzeDocumentCommand.js.map +0 -1
  88. package/dist/cjs/commands/AnalyzeExpenseCommand.js +0 -74
  89. package/dist/cjs/commands/AnalyzeExpenseCommand.js.map +0 -1
  90. package/dist/cjs/commands/DetectDocumentTextCommand.js +0 -71
  91. package/dist/cjs/commands/DetectDocumentTextCommand.js.map +0 -1
  92. package/dist/cjs/commands/GetDocumentAnalysisCommand.js +0 -105
  93. package/dist/cjs/commands/GetDocumentAnalysisCommand.js.map +0 -1
  94. package/dist/cjs/commands/GetDocumentTextDetectionCommand.js +0 -85
  95. package/dist/cjs/commands/GetDocumentTextDetectionCommand.js.map +0 -1
  96. package/dist/cjs/commands/StartDocumentAnalysisCommand.js +0 -78
  97. package/dist/cjs/commands/StartDocumentAnalysisCommand.js.map +0 -1
  98. package/dist/cjs/commands/StartDocumentTextDetectionCommand.js +0 -77
  99. package/dist/cjs/commands/StartDocumentTextDetectionCommand.js.map +0 -1
  100. package/dist/cjs/endpoints.js.map +0 -1
  101. package/dist/cjs/index.js.map +0 -1
  102. package/dist/cjs/models/index.js.map +0 -1
  103. package/dist/cjs/models/models_0.js.map +0 -1
  104. package/dist/cjs/package.json +0 -91
  105. package/dist/cjs/protocols/Aws_json1_1.js.map +0 -1
  106. package/dist/cjs/runtimeConfig.browser.js.map +0 -1
  107. package/dist/cjs/runtimeConfig.js.map +0 -1
  108. package/dist/cjs/runtimeConfig.native.js.map +0 -1
  109. package/dist/cjs/runtimeConfig.shared.js.map +0 -1
  110. package/dist/es/Textract.js.map +0 -1
  111. package/dist/es/TextractClient.js.map +0 -1
  112. package/dist/es/commands/AnalyzeDocumentCommand.js +0 -95
  113. package/dist/es/commands/AnalyzeDocumentCommand.js.map +0 -1
  114. package/dist/es/commands/AnalyzeExpenseCommand.js.map +0 -1
  115. package/dist/es/commands/DetectDocumentTextCommand.js +0 -75
  116. package/dist/es/commands/DetectDocumentTextCommand.js.map +0 -1
  117. package/dist/es/commands/GetDocumentAnalysisCommand.js +0 -109
  118. package/dist/es/commands/GetDocumentAnalysisCommand.js.map +0 -1
  119. package/dist/es/commands/GetDocumentTextDetectionCommand.js +0 -89
  120. package/dist/es/commands/GetDocumentTextDetectionCommand.js.map +0 -1
  121. package/dist/es/commands/StartDocumentAnalysisCommand.js +0 -82
  122. package/dist/es/commands/StartDocumentAnalysisCommand.js.map +0 -1
  123. package/dist/es/commands/StartDocumentTextDetectionCommand.js +0 -81
  124. package/dist/es/commands/StartDocumentTextDetectionCommand.js.map +0 -1
  125. package/dist/es/endpoints.js.map +0 -1
  126. package/dist/es/index.js +0 -11
  127. package/dist/es/index.js.map +0 -1
  128. package/dist/es/models/index.js +0 -2
  129. package/dist/es/models/index.js.map +0 -1
  130. package/dist/es/models/models_0.js.map +0 -1
  131. package/dist/es/package.json +0 -91
  132. package/dist/es/protocols/Aws_json1_1.js.map +0 -1
  133. package/dist/es/runtimeConfig.browser.js.map +0 -1
  134. package/dist/es/runtimeConfig.js.map +0 -1
  135. package/dist/es/runtimeConfig.native.js.map +0 -1
  136. package/dist/es/runtimeConfig.shared.js.map +0 -1
  137. package/dist/types/ts3.4/Textract.d.ts +0 -212
  138. package/dist/types/ts3.4/commands/AnalyzeDocumentCommand.d.ts +0 -65
  139. package/dist/types/ts3.4/commands/AnalyzeExpenseCommand.d.ts +0 -48
  140. package/dist/types/ts3.4/commands/DetectDocumentTextCommand.d.ts +0 -45
  141. package/dist/types/ts3.4/commands/GetDocumentAnalysisCommand.d.ts +0 -79
  142. package/dist/types/ts3.4/commands/GetDocumentTextDetectionCommand.d.ts +0 -59
  143. package/dist/types/ts3.4/commands/StartDocumentAnalysisCommand.d.ts +0 -52
  144. package/dist/types/ts3.4/commands/StartDocumentTextDetectionCommand.d.ts +0 -51
  145. package/dist/types/ts3.4/models/models_0.d.ts +0 -1347
  146. package/endpoints.ts +0 -57
  147. package/jest.config.js +0 -4
  148. package/models/models_0.ts +0 -1627
  149. package/protocols/Aws_json1_1.ts +0 -2060
  150. package/runtimeConfig.browser.ts +0 -40
  151. package/runtimeConfig.native.ts +0 -16
  152. package/runtimeConfig.shared.ts +0 -16
  153. package/runtimeConfig.ts +0 -45
  154. package/tsconfig.es.json +0 -12
  155. package/tsconfig.json +0 -32
package/package.json CHANGED
@@ -1,64 +1,58 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-textract",
3
3
  "description": "AWS SDK for JavaScript Textract Client for Node.js, Browser and React Native",
4
- "version": "3.33.0",
4
+ "version": "3.36.1",
5
5
  "scripts": {
6
- "clean": "yarn remove-definitions && yarn remove-dist && yarn remove-documentation",
7
- "build-documentation": "yarn remove-documentation && typedoc ./",
8
- "remove-definitions": "rimraf ./types",
9
- "remove-dist": "rimraf ./dist",
10
- "remove-documentation": "rimraf ./docs",
11
- "test": "exit 0",
6
+ "build": "yarn build:cjs && yarn build:es && yarn build:types",
12
7
  "build:cjs": "tsc -p tsconfig.json",
8
+ "build:docs": "yarn clean:docs && typedoc ./",
13
9
  "build:es": "tsc -p tsconfig.es.json",
14
- "build": "yarn build:cjs && yarn build:es",
15
- "downlevel-dts": "downlevel-dts dist/types dist/types/ts3.4"
16
- },
17
- "main": "./dist/cjs/index.js",
18
- "types": "./dist/types/index.d.ts",
19
- "module": "./dist/es/index.js",
20
- "browser": {
21
- "./runtimeConfig": "./runtimeConfig.browser"
22
- },
23
- "react-native": {
24
- "./runtimeConfig": "./runtimeConfig.native"
10
+ "build:types": "tsc -p tsconfig.types.json",
11
+ "clean": "yarn clean:dist && yarn clean:docs",
12
+ "clean:dist": "rimraf ./dist",
13
+ "clean:docs": "rimraf ./docs",
14
+ "downlevel-dts": "downlevel-dts dist-types dist-types/ts3.4",
15
+ "test": "exit 0"
25
16
  },
17
+ "main": "./dist-cjs/index.js",
18
+ "types": "./dist-types/index.d.ts",
19
+ "module": "./dist-es/index.js",
26
20
  "sideEffects": false,
27
21
  "dependencies": {
28
22
  "@aws-crypto/sha256-browser": "^1.0.0",
29
23
  "@aws-crypto/sha256-js": "^1.0.0",
30
- "@aws-sdk/client-sts": "3.33.0",
31
- "@aws-sdk/config-resolver": "3.33.0",
32
- "@aws-sdk/credential-provider-node": "3.33.0",
33
- "@aws-sdk/fetch-http-handler": "3.32.0",
34
- "@aws-sdk/hash-node": "3.32.0",
35
- "@aws-sdk/invalid-dependency": "3.32.0",
36
- "@aws-sdk/middleware-content-length": "3.32.0",
37
- "@aws-sdk/middleware-host-header": "3.32.0",
38
- "@aws-sdk/middleware-logger": "3.32.0",
39
- "@aws-sdk/middleware-retry": "3.32.0",
40
- "@aws-sdk/middleware-serde": "3.32.0",
41
- "@aws-sdk/middleware-signing": "3.33.0",
42
- "@aws-sdk/middleware-stack": "3.32.0",
43
- "@aws-sdk/middleware-user-agent": "3.32.0",
44
- "@aws-sdk/node-config-provider": "3.32.0",
45
- "@aws-sdk/node-http-handler": "3.32.0",
46
- "@aws-sdk/protocol-http": "3.32.0",
47
- "@aws-sdk/smithy-client": "3.32.0",
48
- "@aws-sdk/types": "3.32.0",
49
- "@aws-sdk/url-parser": "3.32.0",
50
- "@aws-sdk/util-base64-browser": "3.32.0",
51
- "@aws-sdk/util-base64-node": "3.32.0",
52
- "@aws-sdk/util-body-length-browser": "3.32.0",
53
- "@aws-sdk/util-body-length-node": "3.32.0",
54
- "@aws-sdk/util-user-agent-browser": "3.32.0",
55
- "@aws-sdk/util-user-agent-node": "3.33.0",
56
- "@aws-sdk/util-utf8-browser": "3.32.0",
57
- "@aws-sdk/util-utf8-node": "3.32.0",
24
+ "@aws-sdk/client-sts": "3.36.1",
25
+ "@aws-sdk/config-resolver": "3.36.0",
26
+ "@aws-sdk/credential-provider-node": "3.36.1",
27
+ "@aws-sdk/fetch-http-handler": "3.36.0",
28
+ "@aws-sdk/hash-node": "3.36.0",
29
+ "@aws-sdk/invalid-dependency": "3.36.0",
30
+ "@aws-sdk/middleware-content-length": "3.36.0",
31
+ "@aws-sdk/middleware-host-header": "3.36.0",
32
+ "@aws-sdk/middleware-logger": "3.36.0",
33
+ "@aws-sdk/middleware-retry": "3.36.0",
34
+ "@aws-sdk/middleware-serde": "3.36.0",
35
+ "@aws-sdk/middleware-signing": "3.36.0",
36
+ "@aws-sdk/middleware-stack": "3.36.0",
37
+ "@aws-sdk/middleware-user-agent": "3.36.0",
38
+ "@aws-sdk/node-config-provider": "3.36.0",
39
+ "@aws-sdk/node-http-handler": "3.36.0",
40
+ "@aws-sdk/protocol-http": "3.36.0",
41
+ "@aws-sdk/smithy-client": "3.36.0",
42
+ "@aws-sdk/types": "3.36.0",
43
+ "@aws-sdk/url-parser": "3.36.0",
44
+ "@aws-sdk/util-base64-browser": "3.36.0",
45
+ "@aws-sdk/util-base64-node": "3.36.0",
46
+ "@aws-sdk/util-body-length-browser": "3.36.0",
47
+ "@aws-sdk/util-body-length-node": "3.36.0",
48
+ "@aws-sdk/util-user-agent-browser": "3.36.0",
49
+ "@aws-sdk/util-user-agent-node": "3.36.0",
50
+ "@aws-sdk/util-utf8-browser": "3.36.0",
51
+ "@aws-sdk/util-utf8-node": "3.36.0",
58
52
  "tslib": "^2.3.0"
59
53
  },
60
54
  "devDependencies": {
61
- "@aws-sdk/client-documentation-generator": "3.32.0",
55
+ "@aws-sdk/client-documentation-generator": "3.36.0",
62
56
  "@types/node": "^12.7.5",
63
57
  "downlevel-dts": "0.7.0",
64
58
  "jest": "^26.1.0",
@@ -72,16 +66,25 @@
72
66
  },
73
67
  "typesVersions": {
74
68
  "<4.0": {
75
- "dist/types/*": [
76
- "dist/types/ts3.4/*"
69
+ "dist-types/*": [
70
+ "dist-types/ts3.4/*"
77
71
  ]
78
72
  }
79
73
  },
74
+ "files": [
75
+ "dist-*"
76
+ ],
80
77
  "author": {
81
78
  "name": "AWS SDK for JavaScript Team",
82
79
  "url": "https://aws.amazon.com/javascript/"
83
80
  },
84
81
  "license": "Apache-2.0",
82
+ "browser": {
83
+ "./dist-es/runtimeConfig": "./dist-es/runtimeConfig.browser"
84
+ },
85
+ "react-native": {
86
+ "./dist-es/runtimeConfig": "./dist-es/runtimeConfig.native"
87
+ },
85
88
  "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-textract",
86
89
  "repository": {
87
90
  "type": "git",
package/Textract.ts DELETED
@@ -1,422 +0,0 @@
1
- import { TextractClient } from "./TextractClient";
2
- import {
3
- AnalyzeDocumentCommand,
4
- AnalyzeDocumentCommandInput,
5
- AnalyzeDocumentCommandOutput,
6
- } from "./commands/AnalyzeDocumentCommand";
7
- import {
8
- AnalyzeExpenseCommand,
9
- AnalyzeExpenseCommandInput,
10
- AnalyzeExpenseCommandOutput,
11
- } from "./commands/AnalyzeExpenseCommand";
12
- import {
13
- DetectDocumentTextCommand,
14
- DetectDocumentTextCommandInput,
15
- DetectDocumentTextCommandOutput,
16
- } from "./commands/DetectDocumentTextCommand";
17
- import {
18
- GetDocumentAnalysisCommand,
19
- GetDocumentAnalysisCommandInput,
20
- GetDocumentAnalysisCommandOutput,
21
- } from "./commands/GetDocumentAnalysisCommand";
22
- import {
23
- GetDocumentTextDetectionCommand,
24
- GetDocumentTextDetectionCommandInput,
25
- GetDocumentTextDetectionCommandOutput,
26
- } from "./commands/GetDocumentTextDetectionCommand";
27
- import {
28
- StartDocumentAnalysisCommand,
29
- StartDocumentAnalysisCommandInput,
30
- StartDocumentAnalysisCommandOutput,
31
- } from "./commands/StartDocumentAnalysisCommand";
32
- import {
33
- StartDocumentTextDetectionCommand,
34
- StartDocumentTextDetectionCommandInput,
35
- StartDocumentTextDetectionCommandOutput,
36
- } from "./commands/StartDocumentTextDetectionCommand";
37
- import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
38
-
39
- /**
40
- * <p>Amazon Textract detects and analyzes text in documents and converts it
41
- * into machine-readable text. This is the API reference documentation for
42
- * Amazon Textract.</p>
43
- */
44
- export class Textract extends TextractClient {
45
- /**
46
- * <p>Analyzes an input document for relationships between detected items. </p>
47
- * <p>The types of information returned are as follows: </p>
48
- * <ul>
49
- * <li>
50
- * <p>Form data (key-value pairs). The related information is returned in two <a>Block</a> objects, each of type <code>KEY_VALUE_SET</code>: a KEY
51
- * <code>Block</code> object and a VALUE <code>Block</code> object. For example,
52
- * <i>Name: Ana Silva Carolina</i> contains a key and value.
53
- * <i>Name:</i> is the key. <i>Ana Silva Carolina</i> is
54
- * the value.</p>
55
- * </li>
56
- * <li>
57
- * <p>Table and table cell data. A TABLE <code>Block</code> object contains information about a detected table. A CELL
58
- * <code>Block</code> object is returned for each cell in a table.</p>
59
- * </li>
60
- * <li>
61
- * <p>Lines and words of text. A LINE <code>Block</code> object contains one or more WORD <code>Block</code> objects.
62
- * All lines and words that are detected in the document are returned (including text that doesn't have a
63
- * relationship with the value of <code>FeatureTypes</code>). </p>
64
- * </li>
65
- * </ul>
66
- *
67
- * <p>Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.
68
- * A SELECTION_ELEMENT <code>Block</code> object contains information about a selection element,
69
- * including the selection status.</p>
70
- * <p>You can choose which type of analysis to perform by specifying the <code>FeatureTypes</code> list.
71
- * </p>
72
- * <p>The output is returned in a list of <code>Block</code> objects.</p>
73
- * <p>
74
- * <code>AnalyzeDocument</code> is a synchronous operation. To analyze documents
75
- * asynchronously, use <a>StartDocumentAnalysis</a>.</p>
76
- * <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html">Document Text Analysis</a>.</p>
77
- */
78
- public analyzeDocument(
79
- args: AnalyzeDocumentCommandInput,
80
- options?: __HttpHandlerOptions
81
- ): Promise<AnalyzeDocumentCommandOutput>;
82
- public analyzeDocument(
83
- args: AnalyzeDocumentCommandInput,
84
- cb: (err: any, data?: AnalyzeDocumentCommandOutput) => void
85
- ): void;
86
- public analyzeDocument(
87
- args: AnalyzeDocumentCommandInput,
88
- options: __HttpHandlerOptions,
89
- cb: (err: any, data?: AnalyzeDocumentCommandOutput) => void
90
- ): void;
91
- public analyzeDocument(
92
- args: AnalyzeDocumentCommandInput,
93
- optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AnalyzeDocumentCommandOutput) => void),
94
- cb?: (err: any, data?: AnalyzeDocumentCommandOutput) => void
95
- ): Promise<AnalyzeDocumentCommandOutput> | void {
96
- const command = new AnalyzeDocumentCommand(args);
97
- if (typeof optionsOrCb === "function") {
98
- this.send(command, optionsOrCb);
99
- } else if (typeof cb === "function") {
100
- if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
101
- this.send(command, optionsOrCb || {}, cb);
102
- } else {
103
- return this.send(command, optionsOrCb);
104
- }
105
- }
106
-
107
- /**
108
- * <p>Analyzes an input document for financially related relationships between text.</p>
109
- * <p>Information is returned as <code>ExpenseDocuments</code> and seperated as follows.</p>
110
- * <ul>
111
- * <li>
112
- * <p>
113
- * <code>LineItemGroups</code>- A data set containing <code>LineItems</code> which
114
- * store information about the lines of text, such as an item purchased and its price on a receipt.</p>
115
- * </li>
116
- * <li>
117
- * <p>
118
- * <code>SummaryFields</code>- Contains all other information a receipt, such as header information
119
- * or the vendors name.</p>
120
- * </li>
121
- * </ul>
122
- */
123
- public analyzeExpense(
124
- args: AnalyzeExpenseCommandInput,
125
- options?: __HttpHandlerOptions
126
- ): Promise<AnalyzeExpenseCommandOutput>;
127
- public analyzeExpense(
128
- args: AnalyzeExpenseCommandInput,
129
- cb: (err: any, data?: AnalyzeExpenseCommandOutput) => void
130
- ): void;
131
- public analyzeExpense(
132
- args: AnalyzeExpenseCommandInput,
133
- options: __HttpHandlerOptions,
134
- cb: (err: any, data?: AnalyzeExpenseCommandOutput) => void
135
- ): void;
136
- public analyzeExpense(
137
- args: AnalyzeExpenseCommandInput,
138
- optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: AnalyzeExpenseCommandOutput) => void),
139
- cb?: (err: any, data?: AnalyzeExpenseCommandOutput) => void
140
- ): Promise<AnalyzeExpenseCommandOutput> | void {
141
- const command = new AnalyzeExpenseCommand(args);
142
- if (typeof optionsOrCb === "function") {
143
- this.send(command, optionsOrCb);
144
- } else if (typeof cb === "function") {
145
- if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
146
- this.send(command, optionsOrCb || {}, cb);
147
- } else {
148
- return this.send(command, optionsOrCb);
149
- }
150
- }
151
-
152
- /**
153
- * <p>Detects text in the input document. Amazon Textract can detect lines of text and the
154
- * words that make up a line of text. The input document must be an image in JPEG or PNG
155
- * format. <code>DetectDocumentText</code> returns the detected text in an array of <a>Block</a> objects. </p>
156
- * <p>Each document page has as an associated <code>Block</code> of type PAGE. Each PAGE <code>Block</code> object
157
- * is the parent of LINE <code>Block</code> objects that represent the lines of detected text on a page. A LINE <code>Block</code> object is
158
- * a parent for each word that makes up the line. Words are represented by <code>Block</code> objects of type WORD.</p>
159
- *
160
- * <p>
161
- * <code>DetectDocumentText</code> is a synchronous operation. To analyze documents
162
- * asynchronously, use <a>StartDocumentTextDetection</a>.</p>
163
- * <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html">Document Text Detection</a>.</p>
164
- */
165
- public detectDocumentText(
166
- args: DetectDocumentTextCommandInput,
167
- options?: __HttpHandlerOptions
168
- ): Promise<DetectDocumentTextCommandOutput>;
169
- public detectDocumentText(
170
- args: DetectDocumentTextCommandInput,
171
- cb: (err: any, data?: DetectDocumentTextCommandOutput) => void
172
- ): void;
173
- public detectDocumentText(
174
- args: DetectDocumentTextCommandInput,
175
- options: __HttpHandlerOptions,
176
- cb: (err: any, data?: DetectDocumentTextCommandOutput) => void
177
- ): void;
178
- public detectDocumentText(
179
- args: DetectDocumentTextCommandInput,
180
- optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DetectDocumentTextCommandOutput) => void),
181
- cb?: (err: any, data?: DetectDocumentTextCommandOutput) => void
182
- ): Promise<DetectDocumentTextCommandOutput> | void {
183
- const command = new DetectDocumentTextCommand(args);
184
- if (typeof optionsOrCb === "function") {
185
- this.send(command, optionsOrCb);
186
- } else if (typeof cb === "function") {
187
- if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
188
- this.send(command, optionsOrCb || {}, cb);
189
- } else {
190
- return this.send(command, optionsOrCb);
191
- }
192
- }
193
-
194
- /**
195
- * <p>Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.</p>
196
- * <p>You start asynchronous text analysis by calling <a>StartDocumentAnalysis</a>, which returns a job identifier
197
- * (<code>JobId</code>). When the text analysis operation finishes, Amazon Textract publishes a
198
- * completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to
199
- * <code>StartDocumentAnalysis</code>. To get the results of the text-detection operation,
200
- * first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>.
201
- * If so, call <code>GetDocumentAnalysis</code>, and pass the job identifier
202
- * (<code>JobId</code>) from the initial call to <code>StartDocumentAnalysis</code>.</p>
203
- * <p>
204
- * <code>GetDocumentAnalysis</code> returns an array of <a>Block</a> objects. The following
205
- * types of information are returned: </p>
206
- * <ul>
207
- * <li>
208
- * <p>Form data (key-value pairs). The related information is returned in two <a>Block</a> objects, each of type <code>KEY_VALUE_SET</code>: a KEY
209
- * <code>Block</code> object and a VALUE <code>Block</code> object. For example,
210
- * <i>Name: Ana Silva Carolina</i> contains a key and value.
211
- * <i>Name:</i> is the key. <i>Ana Silva Carolina</i> is
212
- * the value.</p>
213
- * </li>
214
- * <li>
215
- * <p>Table and table cell data. A TABLE <code>Block</code> object contains information about a detected table. A CELL
216
- * <code>Block</code> object is returned for each cell in a table.</p>
217
- * </li>
218
- * <li>
219
- * <p>Lines and words of text. A LINE <code>Block</code> object contains one or more WORD <code>Block</code> objects.
220
- * All lines and words that are detected in the document are returned (including text that doesn't have a
221
- * relationship with the value of the <code>StartDocumentAnalysis</code>
222
- * <code>FeatureTypes</code> input parameter). </p>
223
- * </li>
224
- * </ul>
225
- *
226
- * <p>Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.
227
- * A SELECTION_ELEMENT <code>Block</code> object contains information about a selection element,
228
- * including the selection status.</p>
229
- *
230
- *
231
- *
232
- * <p>Use the <code>MaxResults</code> parameter to limit the number of blocks that are
233
- * returned. If there are more results than specified in <code>MaxResults</code>, the value of
234
- * <code>NextToken</code> in the operation response contains a pagination token for getting
235
- * the next set of results. To get the next page of results, call
236
- * <code>GetDocumentAnalysis</code>, and populate the <code>NextToken</code> request
237
- * parameter with the token value that's returned from the previous call to
238
- * <code>GetDocumentAnalysis</code>.</p>
239
- * <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html">Document Text Analysis</a>.</p>
240
- */
241
- public getDocumentAnalysis(
242
- args: GetDocumentAnalysisCommandInput,
243
- options?: __HttpHandlerOptions
244
- ): Promise<GetDocumentAnalysisCommandOutput>;
245
- public getDocumentAnalysis(
246
- args: GetDocumentAnalysisCommandInput,
247
- cb: (err: any, data?: GetDocumentAnalysisCommandOutput) => void
248
- ): void;
249
- public getDocumentAnalysis(
250
- args: GetDocumentAnalysisCommandInput,
251
- options: __HttpHandlerOptions,
252
- cb: (err: any, data?: GetDocumentAnalysisCommandOutput) => void
253
- ): void;
254
- public getDocumentAnalysis(
255
- args: GetDocumentAnalysisCommandInput,
256
- optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDocumentAnalysisCommandOutput) => void),
257
- cb?: (err: any, data?: GetDocumentAnalysisCommandOutput) => void
258
- ): Promise<GetDocumentAnalysisCommandOutput> | void {
259
- const command = new GetDocumentAnalysisCommand(args);
260
- if (typeof optionsOrCb === "function") {
261
- this.send(command, optionsOrCb);
262
- } else if (typeof cb === "function") {
263
- if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
264
- this.send(command, optionsOrCb || {}, cb);
265
- } else {
266
- return this.send(command, optionsOrCb);
267
- }
268
- }
269
-
270
- /**
271
- * <p>Gets the results for an Amazon Textract asynchronous operation that detects text in a document.
272
- * Amazon Textract can detect lines of text and the words that make up a line of text.</p>
273
- * <p>You start asynchronous text detection by calling <a>StartDocumentTextDetection</a>, which returns a job identifier
274
- * (<code>JobId</code>). When the text detection operation finishes, Amazon Textract publishes a
275
- * completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to
276
- * <code>StartDocumentTextDetection</code>. To get the results of the text-detection
277
- * operation, first check that the status value published to the Amazon SNS topic is
278
- * <code>SUCCEEDED</code>. If so, call <code>GetDocumentTextDetection</code>, and pass the
279
- * job identifier (<code>JobId</code>) from the initial call to
280
- * <code>StartDocumentTextDetection</code>.</p>
281
- * <p>
282
- * <code>GetDocumentTextDetection</code> returns an array of <a>Block</a>
283
- * objects. </p>
284
- * <p>Each document page has as an associated <code>Block</code> of type PAGE. Each PAGE <code>Block</code> object
285
- * is the parent of LINE <code>Block</code> objects that represent the lines of detected text on a page. A LINE <code>Block</code> object is
286
- * a parent for each word that makes up the line. Words are represented by <code>Block</code> objects of type WORD.</p>
287
- *
288
- * <p>Use the MaxResults parameter to limit the number of blocks that are returned. If there
289
- * are more results than specified in <code>MaxResults</code>, the value of
290
- * <code>NextToken</code> in the operation response contains a pagination token for getting
291
- * the next set of results. To get the next page of results, call
292
- * <code>GetDocumentTextDetection</code>, and populate the <code>NextToken</code> request
293
- * parameter with the token value that's returned from the previous call to
294
- * <code>GetDocumentTextDetection</code>.</p>
295
- * <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html">Document Text Detection</a>.</p>
296
- */
297
- public getDocumentTextDetection(
298
- args: GetDocumentTextDetectionCommandInput,
299
- options?: __HttpHandlerOptions
300
- ): Promise<GetDocumentTextDetectionCommandOutput>;
301
- public getDocumentTextDetection(
302
- args: GetDocumentTextDetectionCommandInput,
303
- cb: (err: any, data?: GetDocumentTextDetectionCommandOutput) => void
304
- ): void;
305
- public getDocumentTextDetection(
306
- args: GetDocumentTextDetectionCommandInput,
307
- options: __HttpHandlerOptions,
308
- cb: (err: any, data?: GetDocumentTextDetectionCommandOutput) => void
309
- ): void;
310
- public getDocumentTextDetection(
311
- args: GetDocumentTextDetectionCommandInput,
312
- optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetDocumentTextDetectionCommandOutput) => void),
313
- cb?: (err: any, data?: GetDocumentTextDetectionCommandOutput) => void
314
- ): Promise<GetDocumentTextDetectionCommandOutput> | void {
315
- const command = new GetDocumentTextDetectionCommand(args);
316
- if (typeof optionsOrCb === "function") {
317
- this.send(command, optionsOrCb);
318
- } else if (typeof cb === "function") {
319
- if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
320
- this.send(command, optionsOrCb || {}, cb);
321
- } else {
322
- return this.send(command, optionsOrCb);
323
- }
324
- }
325
-
326
- /**
327
- * <p>Starts the asynchronous analysis of an input document for relationships between detected
328
- * items such as key-value pairs, tables, and selection elements.</p>
329
- *
330
- * <p>
331
- * <code>StartDocumentAnalysis</code> can analyze text in documents that are in JPEG, PNG, and PDF format. The
332
- * documents are stored in an Amazon S3 bucket. Use <a>DocumentLocation</a> to specify the bucket name and file name
333
- * of the document.
334
- * </p>
335
- * <p>
336
- * <code>StartDocumentAnalysis</code> returns a job identifier
337
- * (<code>JobId</code>) that you use to get the results of the operation. When text
338
- * analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS)
339
- * topic that you specify in <code>NotificationChannel</code>. To get the results of the text
340
- * analysis operation, first check that the status value published to the Amazon SNS topic is
341
- * <code>SUCCEEDED</code>. If so, call <a>GetDocumentAnalysis</a>, and pass
342
- * the job identifier (<code>JobId</code>) from the initial call to
343
- * <code>StartDocumentAnalysis</code>.</p>
344
- * <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html">Document Text Analysis</a>.</p>
345
- */
346
- public startDocumentAnalysis(
347
- args: StartDocumentAnalysisCommandInput,
348
- options?: __HttpHandlerOptions
349
- ): Promise<StartDocumentAnalysisCommandOutput>;
350
- public startDocumentAnalysis(
351
- args: StartDocumentAnalysisCommandInput,
352
- cb: (err: any, data?: StartDocumentAnalysisCommandOutput) => void
353
- ): void;
354
- public startDocumentAnalysis(
355
- args: StartDocumentAnalysisCommandInput,
356
- options: __HttpHandlerOptions,
357
- cb: (err: any, data?: StartDocumentAnalysisCommandOutput) => void
358
- ): void;
359
- public startDocumentAnalysis(
360
- args: StartDocumentAnalysisCommandInput,
361
- optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDocumentAnalysisCommandOutput) => void),
362
- cb?: (err: any, data?: StartDocumentAnalysisCommandOutput) => void
363
- ): Promise<StartDocumentAnalysisCommandOutput> | void {
364
- const command = new StartDocumentAnalysisCommand(args);
365
- if (typeof optionsOrCb === "function") {
366
- this.send(command, optionsOrCb);
367
- } else if (typeof cb === "function") {
368
- if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
369
- this.send(command, optionsOrCb || {}, cb);
370
- } else {
371
- return this.send(command, optionsOrCb);
372
- }
373
- }
374
-
375
- /**
376
- * <p>Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of
377
- * text and the words that make up a line of text.</p>
378
- * <p>
379
- * <code>StartDocumentTextDetection</code> can analyze text in documents that are in JPEG, PNG, and PDF format. The
380
- * documents are stored in an Amazon S3 bucket. Use <a>DocumentLocation</a> to specify the bucket name and file name
381
- * of the document.
382
- * </p>
383
- * <p>
384
- * <code>StartTextDetection</code> returns a job identifier
385
- * (<code>JobId</code>) that you use to get the results of the operation. When text
386
- * detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS)
387
- * topic that you specify in <code>NotificationChannel</code>. To get the results of the text
388
- * detection operation, first check that the status value published to the Amazon SNS topic is
389
- * <code>SUCCEEDED</code>. If so, call <a>GetDocumentTextDetection</a>, and
390
- * pass the job identifier (<code>JobId</code>) from the initial call to
391
- * <code>StartDocumentTextDetection</code>.</p>
392
- * <p>For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html">Document Text Detection</a>.</p>
393
- */
394
- public startDocumentTextDetection(
395
- args: StartDocumentTextDetectionCommandInput,
396
- options?: __HttpHandlerOptions
397
- ): Promise<StartDocumentTextDetectionCommandOutput>;
398
- public startDocumentTextDetection(
399
- args: StartDocumentTextDetectionCommandInput,
400
- cb: (err: any, data?: StartDocumentTextDetectionCommandOutput) => void
401
- ): void;
402
- public startDocumentTextDetection(
403
- args: StartDocumentTextDetectionCommandInput,
404
- options: __HttpHandlerOptions,
405
- cb: (err: any, data?: StartDocumentTextDetectionCommandOutput) => void
406
- ): void;
407
- public startDocumentTextDetection(
408
- args: StartDocumentTextDetectionCommandInput,
409
- optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartDocumentTextDetectionCommandOutput) => void),
410
- cb?: (err: any, data?: StartDocumentTextDetectionCommandOutput) => void
411
- ): Promise<StartDocumentTextDetectionCommandOutput> | void {
412
- const command = new StartDocumentTextDetectionCommand(args);
413
- if (typeof optionsOrCb === "function") {
414
- this.send(command, optionsOrCb);
415
- } else if (typeof cb === "function") {
416
- if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
417
- this.send(command, optionsOrCb || {}, cb);
418
- } else {
419
- return this.send(command, optionsOrCb);
420
- }
421
- }
422
- }