feat(client-comprehend): This release supports native document models…

… for custom classification, in addition to plain-text models. You train native document models using documents (PDF, Word, images) in their native format.
aws · Apr 19, 2023 · 413a413 · 413a413
1 parent 29f17b9
commit 413a413
Show file tree

Hide file tree

Showing 16 changed files with 495 additions and 146 deletions.
diff --git a/clients/client-comprehend/src/commands/CreateDocumentClassifierCommand.ts b/clients/client-comprehend/src/commands/CreateDocumentClassifierCommand.ts
@@ -33,10 +33,10 @@ export interface CreateDocumentClassifierCommandOutput extends CreateDocumentCla
 /**
  * @public
  * <p>Creates a new document classifier that you can use to categorize documents. To create a
- *       classifier, you provide a set of training documents that labeled with the categories that you
- *       want to use. After the classifier is trained you can use it to categorize a set of labeled
- *       documents into the categories. For more information, see
- *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html">Document Classification</a> in the Comprehend Developer Guide.
+ *       classifier, you provide a set of training documents that are labeled with the categories that you
+ *       want to use. For more information, see
+ *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/training-classifier-model.html">Training classifier models</a>
+ *       in the Comprehend Developer Guide.
  *     </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -71,6 +71,18 @@ export interface CreateDocumentClassifierCommandOutput extends CreateDocumentCla
  *         DocumentType: "PLAIN_TEXT_DOCUMENT" || "SEMI_STRUCTURED_DOCUMENT",
  *       },
  *     ],
+ *     DocumentType: "PLAIN_TEXT_DOCUMENT" || "SEMI_STRUCTURED_DOCUMENT",
+ *     Documents: { // DocumentClassifierDocuments
+ *       S3Uri: "STRING_VALUE", // required
+ *       TestS3Uri: "STRING_VALUE",
+ *     },
+ *     DocumentReaderConfig: { // DocumentReaderConfig
+ *       DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
+ *       DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
+ *       FeatureTypes: [ // ListOfDocumentReadFeatureTypes
+ *         "TABLES" || "FORMS",
+ *       ],
+ *     },
  *   },
  *   OutputDataConfig: { // DocumentClassifierOutputDataConfig
  *     S3Uri: "STRING_VALUE",

diff --git a/clients/client-comprehend/src/commands/StartDocumentClassificationJobCommand.ts b/clients/client-comprehend/src/commands/StartDocumentClassificationJobCommand.ts
@@ -103,6 +103,10 @@ export interface StartDocumentClassificationJobCommandOutput
  *  <p>The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
  *       re-enter it.</p>
  *
+ * @throws {@link ResourceInUseException} (client fault)
+ *  <p>The specified resource name is already in use. Use a different name and try your request
+ *       again.</p>
+ *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
  *

diff --git a/clients/client-comprehend/src/commands/StartDominantLanguageDetectionJobCommand.ts b/clients/client-comprehend/src/commands/StartDominantLanguageDetectionJobCommand.ts
@@ -104,6 +104,10 @@ export interface StartDominantLanguageDetectionJobCommandOutput
  *  <p>The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
  *       re-enter it.</p>
  *
+ * @throws {@link ResourceInUseException} (client fault)
+ *  <p>The specified resource name is already in use. Use a different name and try your request
+ *       again.</p>
+ *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
  *

diff --git a/clients/client-comprehend/src/commands/StartEntitiesDetectionJobCommand.ts b/clients/client-comprehend/src/commands/StartEntitiesDetectionJobCommand.ts
@@ -101,6 +101,10 @@ export interface StartEntitiesDetectionJobCommandOutput extends StartEntitiesDet
  *  <p>The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
  *       re-enter it.</p>
  *
+ * @throws {@link ResourceInUseException} (client fault)
+ *  <p>The specified resource name is already in use. Use a different name and try your request
+ *       again.</p>
+ *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
  *

diff --git a/clients/client-comprehend/src/commands/StartEventsDetectionJobCommand.ts b/clients/client-comprehend/src/commands/StartEventsDetectionJobCommand.ts
@@ -89,6 +89,10 @@ export interface StartEventsDetectionJobCommandOutput extends StartEventsDetecti
  *  <p>The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
  *       re-enter it.</p>
  *
+ * @throws {@link ResourceInUseException} (client fault)
+ *  <p>The specified resource name is already in use. Use a different name and try your request
+ *       again.</p>
+ *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
  *

diff --git a/clients/client-comprehend/src/commands/StartKeyPhrasesDetectionJobCommand.ts b/clients/client-comprehend/src/commands/StartKeyPhrasesDetectionJobCommand.ts
@@ -99,6 +99,10 @@ export interface StartKeyPhrasesDetectionJobCommandOutput
  *  <p>The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
  *       re-enter it.</p>
  *
+ * @throws {@link ResourceInUseException} (client fault)
+ *  <p>The specified resource name is already in use. Use a different name and try your request
+ *       again.</p>
+ *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
  *

diff --git a/clients/client-comprehend/src/commands/StartPiiEntitiesDetectionJobCommand.ts b/clients/client-comprehend/src/commands/StartPiiEntitiesDetectionJobCommand.ts
@@ -99,6 +99,10 @@ export interface StartPiiEntitiesDetectionJobCommandOutput
  *  <p>The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
  *       re-enter it.</p>
  *
+ * @throws {@link ResourceInUseException} (client fault)
+ *  <p>The specified resource name is already in use. Use a different name and try your request
+ *       again.</p>
+ *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
  *

diff --git a/clients/client-comprehend/src/commands/StartSentimentDetectionJobCommand.ts b/clients/client-comprehend/src/commands/StartSentimentDetectionJobCommand.ts
@@ -97,6 +97,10 @@ export interface StartSentimentDetectionJobCommandOutput extends StartSentimentD
  *  <p>The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
  *       re-enter it.</p>
  *
+ * @throws {@link ResourceInUseException} (client fault)
+ *  <p>The specified resource name is already in use. Use a different name and try your request
+ *       again.</p>
+ *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
  *

diff --git a/clients/client-comprehend/src/commands/StartTargetedSentimentDetectionJobCommand.ts b/clients/client-comprehend/src/commands/StartTargetedSentimentDetectionJobCommand.ts
@@ -105,6 +105,10 @@ export interface StartTargetedSentimentDetectionJobCommandOutput
  *  <p>The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
  *       re-enter it.</p>
  *
+ * @throws {@link ResourceInUseException} (client fault)
+ *  <p>The specified resource name is already in use. Use a different name and try your request
+ *       again.</p>
+ *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
  *

diff --git a/clients/client-comprehend/src/commands/StartTopicsDetectionJobCommand.ts b/clients/client-comprehend/src/commands/StartTopicsDetectionJobCommand.ts
@@ -96,6 +96,10 @@ export interface StartTopicsDetectionJobCommandOutput extends StartTopicsDetecti
  *  <p>The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
  *       re-enter it.</p>
  *
+ * @throws {@link ResourceInUseException} (client fault)
+ *  <p>The specified resource name is already in use. Use a different name and try your request
+ *       again.</p>
+ *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
  *

diff --git a/clients/client-comprehend/src/commands/StopPiiEntitiesDetectionJobCommand.ts b/clients/client-comprehend/src/commands/StopPiiEntitiesDetectionJobCommand.ts
@@ -14,7 +14,7 @@ import {
 } from "@aws-sdk/types";
 
 import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient";
-import { StopPiiEntitiesDetectionJobRequest, StopPiiEntitiesDetectionJobResponse } from "../models/models_0";
+import { StopPiiEntitiesDetectionJobRequest, StopPiiEntitiesDetectionJobResponse } from "../models/models_1";
 import { de_StopPiiEntitiesDetectionJobCommand, se_StopPiiEntitiesDetectionJobCommand } from "../protocols/Aws_json1_1";
 
 /**

diff --git a/clients/client-comprehend/src/commands/StopSentimentDetectionJobCommand.ts b/clients/client-comprehend/src/commands/StopSentimentDetectionJobCommand.ts
@@ -14,7 +14,7 @@ import {
 } from "@aws-sdk/types";
 
 import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient";
-import { StopSentimentDetectionJobRequest, StopSentimentDetectionJobResponse } from "../models/models_0";
+import { StopSentimentDetectionJobRequest, StopSentimentDetectionJobResponse } from "../models/models_1";
 import { de_StopSentimentDetectionJobCommand, se_StopSentimentDetectionJobCommand } from "../protocols/Aws_json1_1";
 
 /**