feat(client-comprehend): Comprehend now supports semi-structured documents (such as PDF files or image files) as inputs for custom analysis using the synchronous APIs (ClassifyDocument and DetectEntities).

Author: awstools

clients/client-comprehend/package.json

@@ -47,6 +47,7 @@
     "@aws-sdk/util-defaults-mode-browser": "*",
     "@aws-sdk/util-defaults-mode-node": "*",
     "@aws-sdk/util-endpoints": "*",
+    "@aws-sdk/util-retry": "*",
     "@aws-sdk/util-user-agent-browser": "*",
     "@aws-sdk/util-user-agent-node": "*",
     "@aws-sdk/util-utf8-browser": "*",

clients/client-comprehend/src/Comprehend.ts

@@ -574,6 +574,15 @@ export class Comprehend extends ComprehendClient {
   /**
    * <p>Creates a new document classification request to analyze a single document in real-time,
    *       using a previously created and trained custom model and an endpoint.</p>
+   *          <p>You can input plain text or you can upload a single-page input document (text, PDF, Word, or image). </p>
+   *          <p>If the system detects errors while processing a page in the input document,
+   *       the API response includes an entry in <code>Errors</code> that describes the errors.</p>
+   *          <p>If the system detects a document-level error in your input document, the API returns an
+   *       <code>InvalidRequestException</code> error response.
+   *       For details about this exception, see
+   *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html">
+   *         Errors in semi-structured documents</a> in the Comprehend Developer Guide.
+   *     </p>
    */
   public classifyDocument(
     args: ClassifyDocumentCommandInput,
@@ -1349,9 +1358,22 @@ export class Comprehend extends ComprehendClient {
   }
 
   /**
-   * <p>Inspects text for named entities, and returns information about them. For more
-   *       information, about named entities, see
+   * <p>Detects named entities in input text when you use the pre-trained model.
+   *       Detects custom entities if you have a custom entity recognition model. </p>
+   *          <p>
+   *       When detecting named entities using the pre-trained model, use plain text as the input.
+   *       For more information about named entities, see
    *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html">Entities</a> in the Comprehend Developer Guide.</p>
+   *          <p>When you use a custom entity recognition model,
+   *       you can input plain text or you can upload a single-page input document (text, PDF, Word, or image). </p>
+   *          <p>If the system detects errors while processing a page in the input document, the API response
+   *        includes an entry in <code>Errors</code> for each error. </p>
+   *          <p>If the system detects a document-level error in your input document, the API returns an
+   *        <code>InvalidRequestException</code> error response.
+   *       For details about this exception, see
+   *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html">
+   *         Errors in semi-structured documents</a> in the Comprehend Developer Guide.
+   *     </p>
    */
   public detectEntities(
     args: DetectEntitiesCommandInput,

clients/client-comprehend/src/commands/ClassifyDocumentCommand.ts

@@ -31,6 +31,15 @@ export interface ClassifyDocumentCommandOutput extends ClassifyDocumentResponse,
 /**
  * <p>Creates a new document classification request to analyze a single document in real-time,
  *       using a previously created and trained custom model and an endpoint.</p>
+ *          <p>You can input plain text or you can upload a single-page input document (text, PDF, Word, or image). </p>
+ *          <p>If the system detects errors while processing a page in the input document,
+ *       the API response includes an entry in <code>Errors</code> that describes the errors.</p>
+ *          <p>If the system detects a document-level error in your input document, the API returns an
+ *       <code>InvalidRequestException</code> error response.
+ *       For details about this exception, see
+ *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html">
+ *         Errors in semi-structured documents</a> in the Comprehend Developer Guide.
+ *     </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-comprehend/src/commands/DetectEntitiesCommand.ts

@@ -29,9 +29,22 @@ export interface DetectEntitiesCommandInput extends DetectEntitiesRequest {}
 export interface DetectEntitiesCommandOutput extends DetectEntitiesResponse, __MetadataBearer {}
 
 /**
- * <p>Inspects text for named entities, and returns information about them. For more
- *       information, about named entities, see
+ * <p>Detects named entities in input text when you use the pre-trained model.
+ *       Detects custom entities if you have a custom entity recognition model. </p>
+ *          <p>
+ *       When detecting named entities using the pre-trained model, use plain text as the input.
+ *       For more information about named entities, see
  *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html">Entities</a> in the Comprehend Developer Guide.</p>
+ *          <p>When you use a custom entity recognition model,
+ *       you can input plain text or you can upload a single-page input document (text, PDF, Word, or image). </p>
+ *          <p>If the system detects errors while processing a page in the input document, the API response
+ *        includes an entry in <code>Errors</code> for each error. </p>
+ *          <p>If the system detects a document-level error in your input document, the API returns an
+ *        <code>InvalidRequestException</code> error response.
+ *       For details about this exception, see
+ *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html">
+ *         Errors in semi-structured documents</a> in the Comprehend Developer Guide.
+ *     </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-comprehend/src/endpoint/EndpointParameters.ts

@@ -24,7 +24,7 @@ export const resolveClientEndpointParameters = <T>(
 };
 
 export interface EndpointParameters extends __EndpointParameters {
-  Region?: string;
+  Region: string;
   UseDualStack?: boolean;
   UseFIPS?: boolean;
   Endpoint?: string;

clients/client-comprehend/src/endpoint/ruleset.ts

@@ -6,7 +6,7 @@ export const ruleSet: RuleSetObject = {
   parameters: {
     Region: {
       builtIn: "AWS::Region",
-      required: false,
+      required: true,
       documentation: "The AWS region used to dispatch the request.",
       type: "String",
     },