@aws-sdk/client-comprehend 3.31.0 → 3.32.0

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 (171) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/dist/cjs/ComprehendClient.js +13 -13
  3. package/dist/cjs/ComprehendClient.js.map +1 -1
  4. package/dist/cjs/commands/BatchDetectDominantLanguageCommand.js +3 -3
  5. package/dist/cjs/commands/BatchDetectDominantLanguageCommand.js.map +1 -1
  6. package/dist/cjs/commands/BatchDetectEntitiesCommand.js +3 -3
  7. package/dist/cjs/commands/BatchDetectEntitiesCommand.js.map +1 -1
  8. package/dist/cjs/commands/BatchDetectKeyPhrasesCommand.js +3 -3
  9. package/dist/cjs/commands/BatchDetectKeyPhrasesCommand.js.map +1 -1
  10. package/dist/cjs/commands/BatchDetectSentimentCommand.js +3 -3
  11. package/dist/cjs/commands/BatchDetectSentimentCommand.js.map +1 -1
  12. package/dist/cjs/commands/BatchDetectSyntaxCommand.js +3 -3
  13. package/dist/cjs/commands/BatchDetectSyntaxCommand.js.map +1 -1
  14. package/dist/cjs/commands/ClassifyDocumentCommand.js +3 -3
  15. package/dist/cjs/commands/ClassifyDocumentCommand.js.map +1 -1
  16. package/dist/cjs/commands/ContainsPiiEntitiesCommand.js +3 -3
  17. package/dist/cjs/commands/ContainsPiiEntitiesCommand.js.map +1 -1
  18. package/dist/cjs/commands/CreateDocumentClassifierCommand.js +3 -3
  19. package/dist/cjs/commands/CreateDocumentClassifierCommand.js.map +1 -1
  20. package/dist/cjs/commands/CreateEndpointCommand.js +3 -3
  21. package/dist/cjs/commands/CreateEndpointCommand.js.map +1 -1
  22. package/dist/cjs/commands/CreateEntityRecognizerCommand.js +3 -3
  23. package/dist/cjs/commands/CreateEntityRecognizerCommand.js.map +1 -1
  24. package/dist/cjs/commands/DeleteDocumentClassifierCommand.js +3 -3
  25. package/dist/cjs/commands/DeleteDocumentClassifierCommand.js.map +1 -1
  26. package/dist/cjs/commands/DeleteEndpointCommand.js +3 -3
  27. package/dist/cjs/commands/DeleteEndpointCommand.js.map +1 -1
  28. package/dist/cjs/commands/DeleteEntityRecognizerCommand.js +3 -3
  29. package/dist/cjs/commands/DeleteEntityRecognizerCommand.js.map +1 -1
  30. package/dist/cjs/commands/DescribeDocumentClassificationJobCommand.js +3 -3
  31. package/dist/cjs/commands/DescribeDocumentClassificationJobCommand.js.map +1 -1
  32. package/dist/cjs/commands/DescribeDocumentClassifierCommand.js +3 -3
  33. package/dist/cjs/commands/DescribeDocumentClassifierCommand.js.map +1 -1
  34. package/dist/cjs/commands/DescribeDominantLanguageDetectionJobCommand.js +3 -3
  35. package/dist/cjs/commands/DescribeDominantLanguageDetectionJobCommand.js.map +1 -1
  36. package/dist/cjs/commands/DescribeEndpointCommand.js +3 -3
  37. package/dist/cjs/commands/DescribeEndpointCommand.js.map +1 -1
  38. package/dist/cjs/commands/DescribeEntitiesDetectionJobCommand.js +3 -3
  39. package/dist/cjs/commands/DescribeEntitiesDetectionJobCommand.js.map +1 -1
  40. package/dist/cjs/commands/DescribeEntityRecognizerCommand.js +3 -3
  41. package/dist/cjs/commands/DescribeEntityRecognizerCommand.js.map +1 -1
  42. package/dist/cjs/commands/DescribeEventsDetectionJobCommand.js +3 -3
  43. package/dist/cjs/commands/DescribeEventsDetectionJobCommand.js.map +1 -1
  44. package/dist/cjs/commands/DescribeKeyPhrasesDetectionJobCommand.js +3 -3
  45. package/dist/cjs/commands/DescribeKeyPhrasesDetectionJobCommand.js.map +1 -1
  46. package/dist/cjs/commands/DescribePiiEntitiesDetectionJobCommand.js +3 -3
  47. package/dist/cjs/commands/DescribePiiEntitiesDetectionJobCommand.js.map +1 -1
  48. package/dist/cjs/commands/DescribeSentimentDetectionJobCommand.js +3 -3
  49. package/dist/cjs/commands/DescribeSentimentDetectionJobCommand.js.map +1 -1
  50. package/dist/cjs/commands/DescribeTopicsDetectionJobCommand.js +3 -3
  51. package/dist/cjs/commands/DescribeTopicsDetectionJobCommand.js.map +1 -1
  52. package/dist/cjs/commands/DetectDominantLanguageCommand.js +3 -3
  53. package/dist/cjs/commands/DetectDominantLanguageCommand.js.map +1 -1
  54. package/dist/cjs/commands/DetectEntitiesCommand.js +3 -3
  55. package/dist/cjs/commands/DetectEntitiesCommand.js.map +1 -1
  56. package/dist/cjs/commands/DetectKeyPhrasesCommand.js +3 -3
  57. package/dist/cjs/commands/DetectKeyPhrasesCommand.js.map +1 -1
  58. package/dist/cjs/commands/DetectPiiEntitiesCommand.js +3 -3
  59. package/dist/cjs/commands/DetectPiiEntitiesCommand.js.map +1 -1
  60. package/dist/cjs/commands/DetectSentimentCommand.js +3 -3
  61. package/dist/cjs/commands/DetectSentimentCommand.js.map +1 -1
  62. package/dist/cjs/commands/DetectSyntaxCommand.js +3 -3
  63. package/dist/cjs/commands/DetectSyntaxCommand.js.map +1 -1
  64. package/dist/cjs/commands/ListDocumentClassificationJobsCommand.js +3 -3
  65. package/dist/cjs/commands/ListDocumentClassificationJobsCommand.js.map +1 -1
  66. package/dist/cjs/commands/ListDocumentClassifiersCommand.js +3 -3
  67. package/dist/cjs/commands/ListDocumentClassifiersCommand.js.map +1 -1
  68. package/dist/cjs/commands/ListDominantLanguageDetectionJobsCommand.js +3 -3
  69. package/dist/cjs/commands/ListDominantLanguageDetectionJobsCommand.js.map +1 -1
  70. package/dist/cjs/commands/ListEndpointsCommand.js +3 -3
  71. package/dist/cjs/commands/ListEndpointsCommand.js.map +1 -1
  72. package/dist/cjs/commands/ListEntitiesDetectionJobsCommand.js +3 -3
  73. package/dist/cjs/commands/ListEntitiesDetectionJobsCommand.js.map +1 -1
  74. package/dist/cjs/commands/ListEntityRecognizersCommand.js +3 -3
  75. package/dist/cjs/commands/ListEntityRecognizersCommand.js.map +1 -1
  76. package/dist/cjs/commands/ListEventsDetectionJobsCommand.js +3 -3
  77. package/dist/cjs/commands/ListEventsDetectionJobsCommand.js.map +1 -1
  78. package/dist/cjs/commands/ListKeyPhrasesDetectionJobsCommand.js +3 -3
  79. package/dist/cjs/commands/ListKeyPhrasesDetectionJobsCommand.js.map +1 -1
  80. package/dist/cjs/commands/ListPiiEntitiesDetectionJobsCommand.js +3 -3
  81. package/dist/cjs/commands/ListPiiEntitiesDetectionJobsCommand.js.map +1 -1
  82. package/dist/cjs/commands/ListSentimentDetectionJobsCommand.js +3 -3
  83. package/dist/cjs/commands/ListSentimentDetectionJobsCommand.js.map +1 -1
  84. package/dist/cjs/commands/ListTagsForResourceCommand.js +3 -3
  85. package/dist/cjs/commands/ListTagsForResourceCommand.js.map +1 -1
  86. package/dist/cjs/commands/ListTopicsDetectionJobsCommand.js +3 -3
  87. package/dist/cjs/commands/ListTopicsDetectionJobsCommand.js.map +1 -1
  88. package/dist/cjs/commands/StartDocumentClassificationJobCommand.js +3 -3
  89. package/dist/cjs/commands/StartDocumentClassificationJobCommand.js.map +1 -1
  90. package/dist/cjs/commands/StartDominantLanguageDetectionJobCommand.js +3 -3
  91. package/dist/cjs/commands/StartDominantLanguageDetectionJobCommand.js.map +1 -1
  92. package/dist/cjs/commands/StartEntitiesDetectionJobCommand.js +3 -3
  93. package/dist/cjs/commands/StartEntitiesDetectionJobCommand.js.map +1 -1
  94. package/dist/cjs/commands/StartEventsDetectionJobCommand.js +3 -3
  95. package/dist/cjs/commands/StartEventsDetectionJobCommand.js.map +1 -1
  96. package/dist/cjs/commands/StartKeyPhrasesDetectionJobCommand.js +3 -3
  97. package/dist/cjs/commands/StartKeyPhrasesDetectionJobCommand.js.map +1 -1
  98. package/dist/cjs/commands/StartPiiEntitiesDetectionJobCommand.js +3 -3
  99. package/dist/cjs/commands/StartPiiEntitiesDetectionJobCommand.js.map +1 -1
  100. package/dist/cjs/commands/StartSentimentDetectionJobCommand.js +3 -3
  101. package/dist/cjs/commands/StartSentimentDetectionJobCommand.js.map +1 -1
  102. package/dist/cjs/commands/StartTopicsDetectionJobCommand.js +3 -3
  103. package/dist/cjs/commands/StartTopicsDetectionJobCommand.js.map +1 -1
  104. package/dist/cjs/commands/StopDominantLanguageDetectionJobCommand.js +3 -3
  105. package/dist/cjs/commands/StopDominantLanguageDetectionJobCommand.js.map +1 -1
  106. package/dist/cjs/commands/StopEntitiesDetectionJobCommand.js +3 -3
  107. package/dist/cjs/commands/StopEntitiesDetectionJobCommand.js.map +1 -1
  108. package/dist/cjs/commands/StopEventsDetectionJobCommand.js +3 -3
  109. package/dist/cjs/commands/StopEventsDetectionJobCommand.js.map +1 -1
  110. package/dist/cjs/commands/StopKeyPhrasesDetectionJobCommand.js +3 -3
  111. package/dist/cjs/commands/StopKeyPhrasesDetectionJobCommand.js.map +1 -1
  112. package/dist/cjs/commands/StopPiiEntitiesDetectionJobCommand.js +3 -3
  113. package/dist/cjs/commands/StopPiiEntitiesDetectionJobCommand.js.map +1 -1
  114. package/dist/cjs/commands/StopSentimentDetectionJobCommand.js +3 -3
  115. package/dist/cjs/commands/StopSentimentDetectionJobCommand.js.map +1 -1
  116. package/dist/cjs/commands/StopTrainingDocumentClassifierCommand.js +3 -3
  117. package/dist/cjs/commands/StopTrainingDocumentClassifierCommand.js.map +1 -1
  118. package/dist/cjs/commands/StopTrainingEntityRecognizerCommand.js +3 -3
  119. package/dist/cjs/commands/StopTrainingEntityRecognizerCommand.js.map +1 -1
  120. package/dist/cjs/commands/TagResourceCommand.js +3 -3
  121. package/dist/cjs/commands/TagResourceCommand.js.map +1 -1
  122. package/dist/cjs/commands/UntagResourceCommand.js +3 -3
  123. package/dist/cjs/commands/UntagResourceCommand.js.map +1 -1
  124. package/dist/cjs/commands/UpdateEndpointCommand.js +3 -3
  125. package/dist/cjs/commands/UpdateEndpointCommand.js.map +1 -1
  126. package/dist/cjs/endpoints.js +1 -1
  127. package/dist/cjs/endpoints.js.map +1 -1
  128. package/dist/cjs/index.js +74 -74
  129. package/dist/cjs/index.js.map +1 -1
  130. package/dist/cjs/models/index.js +1 -1
  131. package/dist/cjs/models/index.js.map +1 -1
  132. package/dist/cjs/models/models_0.js +34 -5
  133. package/dist/cjs/models/models_0.js.map +1 -1
  134. package/dist/cjs/package.json +31 -31
  135. package/dist/cjs/protocols/Aws_json1_1.js +333 -277
  136. package/dist/cjs/protocols/Aws_json1_1.js.map +1 -1
  137. package/dist/cjs/runtimeConfig.browser.js +4 -4
  138. package/dist/cjs/runtimeConfig.browser.js.map +1 -1
  139. package/dist/cjs/runtimeConfig.js +8 -8
  140. package/dist/cjs/runtimeConfig.js.map +1 -1
  141. package/dist/cjs/runtimeConfig.native.js +1 -1
  142. package/dist/cjs/runtimeConfig.native.js.map +1 -1
  143. package/dist/es/models/models_0.js +27 -0
  144. package/dist/es/models/models_0.js.map +1 -1
  145. package/dist/es/package.json +31 -31
  146. package/dist/es/pagination/ListDocumentClassificationJobsPaginator.js +4 -4
  147. package/dist/es/pagination/ListDocumentClassificationJobsPaginator.js.map +1 -1
  148. package/dist/es/pagination/ListDocumentClassifiersPaginator.js +4 -4
  149. package/dist/es/pagination/ListDocumentClassifiersPaginator.js.map +1 -1
  150. package/dist/es/pagination/ListDominantLanguageDetectionJobsPaginator.js +4 -4
  151. package/dist/es/pagination/ListDominantLanguageDetectionJobsPaginator.js.map +1 -1
  152. package/dist/es/pagination/ListEntitiesDetectionJobsPaginator.js +4 -4
  153. package/dist/es/pagination/ListEntitiesDetectionJobsPaginator.js.map +1 -1
  154. package/dist/es/pagination/ListEntityRecognizersPaginator.js +4 -4
  155. package/dist/es/pagination/ListEntityRecognizersPaginator.js.map +1 -1
  156. package/dist/es/pagination/ListEventsDetectionJobsPaginator.js +4 -4
  157. package/dist/es/pagination/ListEventsDetectionJobsPaginator.js.map +1 -1
  158. package/dist/es/pagination/ListKeyPhrasesDetectionJobsPaginator.js +4 -4
  159. package/dist/es/pagination/ListKeyPhrasesDetectionJobsPaginator.js.map +1 -1
  160. package/dist/es/pagination/ListSentimentDetectionJobsPaginator.js +4 -4
  161. package/dist/es/pagination/ListSentimentDetectionJobsPaginator.js.map +1 -1
  162. package/dist/es/pagination/ListTopicsDetectionJobsPaginator.js +4 -4
  163. package/dist/es/pagination/ListTopicsDetectionJobsPaginator.js.map +1 -1
  164. package/dist/es/protocols/Aws_json1_1.js +51 -3
  165. package/dist/es/protocols/Aws_json1_1.js.map +1 -1
  166. package/dist/types/models/models_0.d.ts +90 -1
  167. package/dist/types/ts3.4/models/models_0.d.ts +90 -1
  168. package/models/models_0.ts +104 -1
  169. package/package.json +31 -31
  170. package/protocols/Aws_json1_1.ts +70 -0
  171. package/tsconfig.json +1 -2
@@ -1,4 +1,8 @@
1
1
  import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
+ export declare enum AugmentedManifestsDocumentTypeFormat {
3
+ PLAIN_TEXT_DOCUMENT = "PLAIN_TEXT_DOCUMENT",
4
+ SEMI_STRUCTURED_DOCUMENT = "SEMI_STRUCTURED_DOCUMENT"
5
+ }
2
6
  /**
3
7
  * <p>An augmented manifest file that provides training data for your custom model. An augmented
4
8
  * manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.</p>
@@ -19,6 +23,29 @@ export interface AugmentedManifestsListItem {
19
23
  * an individual job.</p>
20
24
  */
21
25
  AttributeNames: string[] | undefined;
26
+ /**
27
+ * <p>The S3 prefix to the annotation files that are referred in the augmented manifest file.</p>
28
+ */
29
+ AnnotationDataS3Uri?: string;
30
+ /**
31
+ * <p>The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.</p>
32
+ */
33
+ SourceDocumentsS3Uri?: string;
34
+ /**
35
+ * <p>The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument. </p>
36
+ * <ul>
37
+ * <li>
38
+ * <p>
39
+ * <code>PLAIN_TEXT_DOCUMENT</code> A document type that represents any unicode text that is encoded in UTF-8.</p>
40
+ * </li>
41
+ * <li>
42
+ * <p>
43
+ * <code>SEMI_STRUCTURED_DOCUMENT</code> A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported.
44
+ * For inference, Amazon Comprehend support PDFs, DOCX and TXT.</p>
45
+ * </li>
46
+ * </ul>
47
+ */
48
+ DocumentType?: AugmentedManifestsDocumentTypeFormat | string;
22
49
  }
23
50
  export declare namespace AugmentedManifestsListItem {
24
51
  /**
@@ -1674,12 +1701,68 @@ export declare namespace DescribeDocumentClassificationJobRequest {
1674
1701
  */
1675
1702
  const filterSensitiveLog: (obj: DescribeDocumentClassificationJobRequest) => any;
1676
1703
  }
1704
+ export declare enum DocumentReadAction {
1705
+ TEXTRACT_ANALYZE_DOCUMENT = "TEXTRACT_ANALYZE_DOCUMENT",
1706
+ TEXTRACT_DETECT_DOCUMENT_TEXT = "TEXTRACT_DETECT_DOCUMENT_TEXT"
1707
+ }
1708
+ export declare enum DocumentReadMode {
1709
+ FORCE_DOCUMENT_READ_ACTION = "FORCE_DOCUMENT_READ_ACTION",
1710
+ SERVICE_DEFAULT = "SERVICE_DEFAULT"
1711
+ }
1712
+ export declare enum DocumentReadFeatureTypes {
1713
+ FORMS = "FORMS",
1714
+ TABLES = "TABLES"
1715
+ }
1716
+ /**
1717
+ * <p>The input properties for a topic detection job.</p>
1718
+ */
1719
+ export interface DocumentReaderConfig {
1720
+ /**
1721
+ * <p>This enum field will start with two values which will apply to PDFs:</p>
1722
+ * <ul>
1723
+ * <li>
1724
+ * <p>
1725
+ * <code>TEXTRACT_DETECT_DOCUMENT_TEXT</code> - The service calls DetectDocumentText for PDF documents per page.</p>
1726
+ * </li>
1727
+ * <li>
1728
+ * <p>
1729
+ * <code>TEXTRACT_ANALYZE_DOCUMENT</code> - The service calls AnalyzeDocument for PDF documents per page.</p>
1730
+ * </li>
1731
+ * </ul>
1732
+ */
1733
+ DocumentReadAction: DocumentReadAction | string | undefined;
1734
+ /**
1735
+ * <p>This enum field provides two values:</p>
1736
+ * <ul>
1737
+ * <li>
1738
+ * <p>
1739
+ * <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>
1740
+ * </li>
1741
+ * <li>
1742
+ * <p>
1743
+ * <code>FORCE_DOCUMENT_READ_ACTION</code> - Always use specified action for DocumentReadAction, including Digital PDF.
1744
+ * </p>
1745
+ * </li>
1746
+ * </ul>
1747
+ */
1748
+ DocumentReadMode?: DocumentReadMode | string;
1749
+ /**
1750
+ * <p>Specifies how the text in an input file should be processed:</p>
1751
+ */
1752
+ FeatureTypes?: (DocumentReadFeatureTypes | string)[];
1753
+ }
1754
+ export declare namespace DocumentReaderConfig {
1755
+ /**
1756
+ * @internal
1757
+ */
1758
+ const filterSensitiveLog: (obj: DocumentReaderConfig) => any;
1759
+ }
1677
1760
  export declare enum InputFormat {
1678
1761
  ONE_DOC_PER_FILE = "ONE_DOC_PER_FILE",
1679
1762
  ONE_DOC_PER_LINE = "ONE_DOC_PER_LINE"
1680
1763
  }
1681
1764
  /**
1682
- * <p>The input properties for a topic detection job.</p>
1765
+ * <p>The input properties for an inference job.</p>
1683
1766
  */
1684
1767
  export interface InputDataConfig {
1685
1768
  /**
@@ -1709,6 +1792,12 @@ export interface InputDataConfig {
1709
1792
  * </ul>
1710
1793
  */
1711
1794
  InputFormat?: InputFormat | string;
1795
+ /**
1796
+ * <p>The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob. </p>
1797
+ * <p>Use DocumentReaderConfig to provide specifications about how you want your inference documents read.
1798
+ * Currently it applies for PDF documents in StartEntitiesDetectionJob custom inference.</p>
1799
+ */
1800
+ DocumentReaderConfig?: DocumentReaderConfig;
1712
1801
  }
1713
1802
  export declare namespace InputDataConfig {
1714
1803
  /**
@@ -1,4 +1,8 @@
1
1
  import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
+ export declare enum AugmentedManifestsDocumentTypeFormat {
3
+ PLAIN_TEXT_DOCUMENT = "PLAIN_TEXT_DOCUMENT",
4
+ SEMI_STRUCTURED_DOCUMENT = "SEMI_STRUCTURED_DOCUMENT"
5
+ }
2
6
  /**
3
7
  * <p>An augmented manifest file that provides training data for your custom model. An augmented
4
8
  * manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.</p>
@@ -19,6 +23,29 @@ export interface AugmentedManifestsListItem {
19
23
  * an individual job.</p>
20
24
  */
21
25
  AttributeNames: string[] | undefined;
26
+ /**
27
+ * <p>The S3 prefix to the annotation files that are referred in the augmented manifest file.</p>
28
+ */
29
+ AnnotationDataS3Uri?: string;
30
+ /**
31
+ * <p>The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.</p>
32
+ */
33
+ SourceDocumentsS3Uri?: string;
34
+ /**
35
+ * <p>The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument. </p>
36
+ * <ul>
37
+ * <li>
38
+ * <p>
39
+ * <code>PLAIN_TEXT_DOCUMENT</code> A document type that represents any unicode text that is encoded in UTF-8.</p>
40
+ * </li>
41
+ * <li>
42
+ * <p>
43
+ * <code>SEMI_STRUCTURED_DOCUMENT</code> A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported.
44
+ * For inference, Amazon Comprehend support PDFs, DOCX and TXT.</p>
45
+ * </li>
46
+ * </ul>
47
+ */
48
+ DocumentType?: AugmentedManifestsDocumentTypeFormat | string;
22
49
  }
23
50
  export declare namespace AugmentedManifestsListItem {
24
51
  /**
@@ -1674,12 +1701,68 @@ export declare namespace DescribeDocumentClassificationJobRequest {
1674
1701
  */
1675
1702
  const filterSensitiveLog: (obj: DescribeDocumentClassificationJobRequest) => any;
1676
1703
  }
1704
+ export declare enum DocumentReadAction {
1705
+ TEXTRACT_ANALYZE_DOCUMENT = "TEXTRACT_ANALYZE_DOCUMENT",
1706
+ TEXTRACT_DETECT_DOCUMENT_TEXT = "TEXTRACT_DETECT_DOCUMENT_TEXT"
1707
+ }
1708
+ export declare enum DocumentReadMode {
1709
+ FORCE_DOCUMENT_READ_ACTION = "FORCE_DOCUMENT_READ_ACTION",
1710
+ SERVICE_DEFAULT = "SERVICE_DEFAULT"
1711
+ }
1712
+ export declare enum DocumentReadFeatureTypes {
1713
+ FORMS = "FORMS",
1714
+ TABLES = "TABLES"
1715
+ }
1716
+ /**
1717
+ * <p>The input properties for a topic detection job.</p>
1718
+ */
1719
+ export interface DocumentReaderConfig {
1720
+ /**
1721
+ * <p>This enum field will start with two values which will apply to PDFs:</p>
1722
+ * <ul>
1723
+ * <li>
1724
+ * <p>
1725
+ * <code>TEXTRACT_DETECT_DOCUMENT_TEXT</code> - The service calls DetectDocumentText for PDF documents per page.</p>
1726
+ * </li>
1727
+ * <li>
1728
+ * <p>
1729
+ * <code>TEXTRACT_ANALYZE_DOCUMENT</code> - The service calls AnalyzeDocument for PDF documents per page.</p>
1730
+ * </li>
1731
+ * </ul>
1732
+ */
1733
+ DocumentReadAction: DocumentReadAction | string | undefined;
1734
+ /**
1735
+ * <p>This enum field provides two values:</p>
1736
+ * <ul>
1737
+ * <li>
1738
+ * <p>
1739
+ * <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>
1740
+ * </li>
1741
+ * <li>
1742
+ * <p>
1743
+ * <code>FORCE_DOCUMENT_READ_ACTION</code> - Always use specified action for DocumentReadAction, including Digital PDF.
1744
+ * </p>
1745
+ * </li>
1746
+ * </ul>
1747
+ */
1748
+ DocumentReadMode?: DocumentReadMode | string;
1749
+ /**
1750
+ * <p>Specifies how the text in an input file should be processed:</p>
1751
+ */
1752
+ FeatureTypes?: (DocumentReadFeatureTypes | string)[];
1753
+ }
1754
+ export declare namespace DocumentReaderConfig {
1755
+ /**
1756
+ * @internal
1757
+ */
1758
+ const filterSensitiveLog: (obj: DocumentReaderConfig) => any;
1759
+ }
1677
1760
  export declare enum InputFormat {
1678
1761
  ONE_DOC_PER_FILE = "ONE_DOC_PER_FILE",
1679
1762
  ONE_DOC_PER_LINE = "ONE_DOC_PER_LINE"
1680
1763
  }
1681
1764
  /**
1682
- * <p>The input properties for a topic detection job.</p>
1765
+ * <p>The input properties for an inference job.</p>
1683
1766
  */
1684
1767
  export interface InputDataConfig {
1685
1768
  /**
@@ -1709,6 +1792,12 @@ export interface InputDataConfig {
1709
1792
  * </ul>
1710
1793
  */
1711
1794
  InputFormat?: InputFormat | string;
1795
+ /**
1796
+ * <p>The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob. </p>
1797
+ * <p>Use DocumentReaderConfig to provide specifications about how you want your inference documents read.
1798
+ * Currently it applies for PDF documents in StartEntitiesDetectionJob custom inference.</p>
1799
+ */
1800
+ DocumentReaderConfig?: DocumentReaderConfig;
1712
1801
  }
1713
1802
  export declare namespace InputDataConfig {
1714
1803
  /**
@@ -1,6 +1,11 @@
1
1
  import { SENSITIVE_STRING } from "@aws-sdk/smithy-client";
2
2
  import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
3
3
 
4
+ export enum AugmentedManifestsDocumentTypeFormat {
5
+ PLAIN_TEXT_DOCUMENT = "PLAIN_TEXT_DOCUMENT",
6
+ SEMI_STRUCTURED_DOCUMENT = "SEMI_STRUCTURED_DOCUMENT",
7
+ }
8
+
4
9
  /**
5
10
  * <p>An augmented manifest file that provides training data for your custom model. An augmented
6
11
  * manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.</p>
@@ -22,6 +27,32 @@ export interface AugmentedManifestsListItem {
22
27
  * an individual job.</p>
23
28
  */
24
29
  AttributeNames: string[] | undefined;
30
+
31
+ /**
32
+ * <p>The S3 prefix to the annotation files that are referred in the augmented manifest file.</p>
33
+ */
34
+ AnnotationDataS3Uri?: string;
35
+
36
+ /**
37
+ * <p>The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.</p>
38
+ */
39
+ SourceDocumentsS3Uri?: string;
40
+
41
+ /**
42
+ * <p>The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument. </p>
43
+ * <ul>
44
+ * <li>
45
+ * <p>
46
+ * <code>PLAIN_TEXT_DOCUMENT</code> A document type that represents any unicode text that is encoded in UTF-8.</p>
47
+ * </li>
48
+ * <li>
49
+ * <p>
50
+ * <code>SEMI_STRUCTURED_DOCUMENT</code> A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported.
51
+ * For inference, Amazon Comprehend support PDFs, DOCX and TXT.</p>
52
+ * </li>
53
+ * </ul>
54
+ */
55
+ DocumentType?: AugmentedManifestsDocumentTypeFormat | string;
25
56
  }
26
57
 
27
58
  export namespace AugmentedManifestsListItem {
@@ -2036,13 +2067,78 @@ export namespace DescribeDocumentClassificationJobRequest {
2036
2067
  });
2037
2068
  }
2038
2069
 
2070
+ export enum DocumentReadAction {
2071
+ TEXTRACT_ANALYZE_DOCUMENT = "TEXTRACT_ANALYZE_DOCUMENT",
2072
+ TEXTRACT_DETECT_DOCUMENT_TEXT = "TEXTRACT_DETECT_DOCUMENT_TEXT",
2073
+ }
2074
+
2075
+ export enum DocumentReadMode {
2076
+ FORCE_DOCUMENT_READ_ACTION = "FORCE_DOCUMENT_READ_ACTION",
2077
+ SERVICE_DEFAULT = "SERVICE_DEFAULT",
2078
+ }
2079
+
2080
+ export enum DocumentReadFeatureTypes {
2081
+ FORMS = "FORMS",
2082
+ TABLES = "TABLES",
2083
+ }
2084
+
2085
+ /**
2086
+ * <p>The input properties for a topic detection job.</p>
2087
+ */
2088
+ export interface DocumentReaderConfig {
2089
+ /**
2090
+ * <p>This enum field will start with two values which will apply to PDFs:</p>
2091
+ * <ul>
2092
+ * <li>
2093
+ * <p>
2094
+ * <code>TEXTRACT_DETECT_DOCUMENT_TEXT</code> - The service calls DetectDocumentText for PDF documents per page.</p>
2095
+ * </li>
2096
+ * <li>
2097
+ * <p>
2098
+ * <code>TEXTRACT_ANALYZE_DOCUMENT</code> - The service calls AnalyzeDocument for PDF documents per page.</p>
2099
+ * </li>
2100
+ * </ul>
2101
+ */
2102
+ DocumentReadAction: DocumentReadAction | string | undefined;
2103
+
2104
+ /**
2105
+ * <p>This enum field provides two values:</p>
2106
+ * <ul>
2107
+ * <li>
2108
+ * <p>
2109
+ * <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>
2110
+ * </li>
2111
+ * <li>
2112
+ * <p>
2113
+ * <code>FORCE_DOCUMENT_READ_ACTION</code> - Always use specified action for DocumentReadAction, including Digital PDF.
2114
+ * </p>
2115
+ * </li>
2116
+ * </ul>
2117
+ */
2118
+ DocumentReadMode?: DocumentReadMode | string;
2119
+
2120
+ /**
2121
+ * <p>Specifies how the text in an input file should be processed:</p>
2122
+ */
2123
+ FeatureTypes?: (DocumentReadFeatureTypes | string)[];
2124
+ }
2125
+
2126
+ export namespace DocumentReaderConfig {
2127
+ /**
2128
+ * @internal
2129
+ */
2130
+ export const filterSensitiveLog = (obj: DocumentReaderConfig): any => ({
2131
+ ...obj,
2132
+ });
2133
+ }
2134
+
2039
2135
  export enum InputFormat {
2040
2136
  ONE_DOC_PER_FILE = "ONE_DOC_PER_FILE",
2041
2137
  ONE_DOC_PER_LINE = "ONE_DOC_PER_LINE",
2042
2138
  }
2043
2139
 
2044
2140
  /**
2045
- * <p>The input properties for a topic detection job.</p>
2141
+ * <p>The input properties for an inference job.</p>
2046
2142
  */
2047
2143
  export interface InputDataConfig {
2048
2144
  /**
@@ -2073,6 +2169,13 @@ export interface InputDataConfig {
2073
2169
  * </ul>
2074
2170
  */
2075
2171
  InputFormat?: InputFormat | string;
2172
+
2173
+ /**
2174
+ * <p>The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob. </p>
2175
+ * <p>Use DocumentReaderConfig to provide specifications about how you want your inference documents read.
2176
+ * Currently it applies for PDF documents in StartEntitiesDetectionJob custom inference.</p>
2177
+ */
2178
+ DocumentReaderConfig?: DocumentReaderConfig;
2076
2179
  }
2077
2180
 
2078
2181
  export namespace InputDataConfig {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-comprehend",
3
3
  "description": "AWS SDK for JavaScript Comprehend Client for Node.js, Browser and React Native",
4
- "version": "3.31.0",
4
+ "version": "3.32.0",
5
5
  "scripts": {
6
6
  "clean": "yarn remove-definitions && yarn remove-dist && yarn remove-documentation",
7
7
  "build-documentation": "yarn remove-documentation && typedoc ./",
@@ -27,39 +27,39 @@
27
27
  "dependencies": {
28
28
  "@aws-crypto/sha256-browser": "^1.0.0",
29
29
  "@aws-crypto/sha256-js": "^1.0.0",
30
- "@aws-sdk/client-sts": "3.31.0",
31
- "@aws-sdk/config-resolver": "3.30.0",
32
- "@aws-sdk/credential-provider-node": "3.31.0",
33
- "@aws-sdk/fetch-http-handler": "3.29.0",
34
- "@aws-sdk/hash-node": "3.29.0",
35
- "@aws-sdk/invalid-dependency": "3.29.0",
36
- "@aws-sdk/middleware-content-length": "3.29.0",
37
- "@aws-sdk/middleware-host-header": "3.29.0",
38
- "@aws-sdk/middleware-logger": "3.29.0",
39
- "@aws-sdk/middleware-retry": "3.29.0",
40
- "@aws-sdk/middleware-serde": "3.29.0",
41
- "@aws-sdk/middleware-signing": "3.30.0",
42
- "@aws-sdk/middleware-stack": "3.29.0",
43
- "@aws-sdk/middleware-user-agent": "3.29.0",
44
- "@aws-sdk/node-config-provider": "3.29.0",
45
- "@aws-sdk/node-http-handler": "3.29.0",
46
- "@aws-sdk/protocol-http": "3.29.0",
47
- "@aws-sdk/smithy-client": "3.31.0",
48
- "@aws-sdk/types": "3.29.0",
49
- "@aws-sdk/url-parser": "3.29.0",
50
- "@aws-sdk/util-base64-browser": "3.29.0",
51
- "@aws-sdk/util-base64-node": "3.29.0",
52
- "@aws-sdk/util-body-length-browser": "3.29.0",
53
- "@aws-sdk/util-body-length-node": "3.29.0",
54
- "@aws-sdk/util-user-agent-browser": "3.29.0",
55
- "@aws-sdk/util-user-agent-node": "3.29.0",
56
- "@aws-sdk/util-utf8-browser": "3.29.0",
57
- "@aws-sdk/util-utf8-node": "3.29.0",
30
+ "@aws-sdk/client-sts": "3.32.0",
31
+ "@aws-sdk/config-resolver": "3.32.0",
32
+ "@aws-sdk/credential-provider-node": "3.32.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.32.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.32.0",
56
+ "@aws-sdk/util-utf8-browser": "3.32.0",
57
+ "@aws-sdk/util-utf8-node": "3.32.0",
58
58
  "tslib": "^2.3.0",
59
59
  "uuid": "^8.3.2"
60
60
  },
61
61
  "devDependencies": {
62
- "@aws-sdk/client-documentation-generator": "3.29.0",
62
+ "@aws-sdk/client-documentation-generator": "3.32.0",
63
63
  "@types/node": "^12.7.5",
64
64
  "@types/uuid": "^8.3.0",
65
65
  "downlevel-dts": "0.7.0",
@@ -67,7 +67,7 @@
67
67
  "rimraf": "^3.0.0",
68
68
  "ts-jest": "^26.4.1",
69
69
  "typedoc": "^0.19.2",
70
- "typescript": "~4.4.2"
70
+ "typescript": "~4.3.5"
71
71
  },
72
72
  "engines": {
73
73
  "node": ">=10.0.0"
@@ -280,6 +280,8 @@ import {
280
280
  DocumentClassifierOutputDataConfig,
281
281
  DocumentClassifierProperties,
282
282
  DocumentLabel,
283
+ DocumentReadFeatureTypes,
284
+ DocumentReaderConfig,
283
285
  DominantLanguage,
284
286
  DominantLanguageDetectionJobFilter,
285
287
  DominantLanguageDetectionJobProperties,
@@ -6466,11 +6468,16 @@ const serializeAws_json1_1AugmentedManifestsListItem = (
6466
6468
  context: __SerdeContext
6467
6469
  ): any => {
6468
6470
  return {
6471
+ ...(input.AnnotationDataS3Uri !== undefined &&
6472
+ input.AnnotationDataS3Uri !== null && { AnnotationDataS3Uri: input.AnnotationDataS3Uri }),
6469
6473
  ...(input.AttributeNames !== undefined &&
6470
6474
  input.AttributeNames !== null && {
6471
6475
  AttributeNames: serializeAws_json1_1AttributeNamesList(input.AttributeNames, context),
6472
6476
  }),
6477
+ ...(input.DocumentType !== undefined && input.DocumentType !== null && { DocumentType: input.DocumentType }),
6473
6478
  ...(input.S3Uri !== undefined && input.S3Uri !== null && { S3Uri: input.S3Uri }),
6479
+ ...(input.SourceDocumentsS3Uri !== undefined &&
6480
+ input.SourceDocumentsS3Uri !== null && { SourceDocumentsS3Uri: input.SourceDocumentsS3Uri }),
6474
6481
  };
6475
6482
  };
6476
6483
 
@@ -6864,6 +6871,19 @@ const serializeAws_json1_1DocumentClassifierOutputDataConfig = (
6864
6871
  };
6865
6872
  };
6866
6873
 
6874
+ const serializeAws_json1_1DocumentReaderConfig = (input: DocumentReaderConfig, context: __SerdeContext): any => {
6875
+ return {
6876
+ ...(input.DocumentReadAction !== undefined &&
6877
+ input.DocumentReadAction !== null && { DocumentReadAction: input.DocumentReadAction }),
6878
+ ...(input.DocumentReadMode !== undefined &&
6879
+ input.DocumentReadMode !== null && { DocumentReadMode: input.DocumentReadMode }),
6880
+ ...(input.FeatureTypes !== undefined &&
6881
+ input.FeatureTypes !== null && {
6882
+ FeatureTypes: serializeAws_json1_1ListOfDocumentReadFeatureTypes(input.FeatureTypes, context),
6883
+ }),
6884
+ };
6885
+ };
6886
+
6867
6887
  const serializeAws_json1_1DominantLanguageDetectionJobFilter = (
6868
6888
  input: DominantLanguageDetectionJobFilter,
6869
6889
  context: __SerdeContext
@@ -7019,6 +7039,10 @@ const serializeAws_json1_1EventsDetectionJobFilter = (
7019
7039
 
7020
7040
  const serializeAws_json1_1InputDataConfig = (input: InputDataConfig, context: __SerdeContext): any => {
7021
7041
  return {
7042
+ ...(input.DocumentReaderConfig !== undefined &&
7043
+ input.DocumentReaderConfig !== null && {
7044
+ DocumentReaderConfig: serializeAws_json1_1DocumentReaderConfig(input.DocumentReaderConfig, context),
7045
+ }),
7022
7046
  ...(input.InputFormat !== undefined && input.InputFormat !== null && { InputFormat: input.InputFormat }),
7023
7047
  ...(input.S3Uri !== undefined && input.S3Uri !== null && { S3Uri: input.S3Uri }),
7024
7048
  };
@@ -7133,6 +7157,20 @@ const serializeAws_json1_1ListKeyPhrasesDetectionJobsRequest = (
7133
7157
  };
7134
7158
  };
7135
7159
 
7160
+ const serializeAws_json1_1ListOfDocumentReadFeatureTypes = (
7161
+ input: (DocumentReadFeatureTypes | string)[],
7162
+ context: __SerdeContext
7163
+ ): any => {
7164
+ return input
7165
+ .filter((e: any) => e != null)
7166
+ .map((entry) => {
7167
+ if (entry === null) {
7168
+ return null as any;
7169
+ }
7170
+ return entry;
7171
+ });
7172
+ };
7173
+
7136
7174
  const serializeAws_json1_1ListOfPiiEntityTypes = (input: (PiiEntityType | string)[], context: __SerdeContext): any => {
7137
7175
  return input
7138
7176
  .filter((e: any) => e != null)
@@ -7647,11 +7685,14 @@ const deserializeAws_json1_1AugmentedManifestsListItem = (
7647
7685
  context: __SerdeContext
7648
7686
  ): AugmentedManifestsListItem => {
7649
7687
  return {
7688
+ AnnotationDataS3Uri: __expectString(output.AnnotationDataS3Uri),
7650
7689
  AttributeNames:
7651
7690
  output.AttributeNames !== undefined && output.AttributeNames !== null
7652
7691
  ? deserializeAws_json1_1AttributeNamesList(output.AttributeNames, context)
7653
7692
  : undefined,
7693
+ DocumentType: __expectString(output.DocumentType),
7654
7694
  S3Uri: __expectString(output.S3Uri),
7695
+ SourceDocumentsS3Uri: __expectString(output.SourceDocumentsS3Uri),
7655
7696
  } as any;
7656
7697
  };
7657
7698
 
@@ -8304,6 +8345,17 @@ const deserializeAws_json1_1DocumentLabel = (output: any, context: __SerdeContex
8304
8345
  } as any;
8305
8346
  };
8306
8347
 
8348
+ const deserializeAws_json1_1DocumentReaderConfig = (output: any, context: __SerdeContext): DocumentReaderConfig => {
8349
+ return {
8350
+ DocumentReadAction: __expectString(output.DocumentReadAction),
8351
+ DocumentReadMode: __expectString(output.DocumentReadMode),
8352
+ FeatureTypes:
8353
+ output.FeatureTypes !== undefined && output.FeatureTypes !== null
8354
+ ? deserializeAws_json1_1ListOfDocumentReadFeatureTypes(output.FeatureTypes, context)
8355
+ : undefined,
8356
+ } as any;
8357
+ };
8358
+
8307
8359
  const deserializeAws_json1_1DominantLanguage = (output: any, context: __SerdeContext): DominantLanguage => {
8308
8360
  return {
8309
8361
  LanguageCode: __expectString(output.LanguageCode),
@@ -8722,6 +8774,10 @@ const deserializeAws_json1_1EventsDetectionJobPropertiesList = (
8722
8774
 
8723
8775
  const deserializeAws_json1_1InputDataConfig = (output: any, context: __SerdeContext): InputDataConfig => {
8724
8776
  return {
8777
+ DocumentReaderConfig:
8778
+ output.DocumentReaderConfig !== undefined && output.DocumentReaderConfig !== null
8779
+ ? deserializeAws_json1_1DocumentReaderConfig(output.DocumentReaderConfig, context)
8780
+ : undefined,
8725
8781
  InputFormat: __expectString(output.InputFormat),
8726
8782
  S3Uri: __expectString(output.S3Uri),
8727
8783
  } as any;
@@ -9018,6 +9074,20 @@ const deserializeAws_json1_1ListOfDetectSyntaxResult = (
9018
9074
  });
9019
9075
  };
9020
9076
 
9077
+ const deserializeAws_json1_1ListOfDocumentReadFeatureTypes = (
9078
+ output: any,
9079
+ context: __SerdeContext
9080
+ ): (DocumentReadFeatureTypes | string)[] => {
9081
+ return (output || [])
9082
+ .filter((e: any) => e != null)
9083
+ .map((entry: any) => {
9084
+ if (entry === null) {
9085
+ return null as any;
9086
+ }
9087
+ return __expectString(entry) as any;
9088
+ });
9089
+ };
9090
+
9021
9091
  const deserializeAws_json1_1ListOfDominantLanguages = (output: any, context: __SerdeContext): DominantLanguage[] => {
9022
9092
  return (output || [])
9023
9093
  .filter((e: any) => e != null)
package/tsconfig.json CHANGED
@@ -13,8 +13,7 @@
13
13
  "resolveJsonModule": true,
14
14
  "esModuleInterop": true,
15
15
  "declarationDir": "./dist/types",
16
- "outDir": "dist/cjs",
17
- "useUnknownInCatchVariables": false
16
+ "outDir": "dist/cjs"
18
17
  },
19
18
  "typedocOptions": {
20
19
  "exclude": ["**/node_modules/**", "**/*.spec.ts", "**/protocols/*.ts", "**/e2e/*.ts", "**/endpoints.ts"],