@aws-sdk/client-comprehend 3.218.0 → 3.223.0

package/dist-es/protocols/Aws_json1_1.js

@@ -4019,6 +4019,10 @@ const serializeAws_json1_1BatchDetectTargetedSentimentRequest = (input, context)
 };
 const serializeAws_json1_1ClassifyDocumentRequest = (input, context) => {
     return {
+        ...(input.Bytes != null && { Bytes: context.base64Encoder(input.Bytes) }),
+        ...(input.DocumentReaderConfig != null && {
+            DocumentReaderConfig: serializeAws_json1_1DocumentReaderConfig(input.DocumentReaderConfig, context),
+        }),
         ...(input.EndpointArn != null && { EndpointArn: input.EndpointArn }),
         ...(input.Text != null && { Text: input.Text }),
     };
@@ -4177,6 +4181,10 @@ const serializeAws_json1_1DetectDominantLanguageRequest = (input, context) => {
 };
 const serializeAws_json1_1DetectEntitiesRequest = (input, context) => {
     return {
+        ...(input.Bytes != null && { Bytes: context.base64Encoder(input.Bytes) }),
+        ...(input.DocumentReaderConfig != null && {
+            DocumentReaderConfig: serializeAws_json1_1DocumentReaderConfig(input.DocumentReaderConfig, context),
+        }),
         ...(input.EndpointArn != null && { EndpointArn: input.EndpointArn }),
         ...(input.LanguageCode != null && { LanguageCode: input.LanguageCode }),
         ...(input.Text != null && { Text: input.Text }),
@@ -4961,6 +4969,41 @@ const deserializeAws_json1_1BatchSizeLimitExceededException = (output, context)
         Message: __expectString(output.Message),
     };
 };
+const deserializeAws_json1_1Block = (output, context) => {
+    return {
+        BlockType: __expectString(output.BlockType),
+        Geometry: output.Geometry != null ? deserializeAws_json1_1Geometry(output.Geometry, context) : undefined,
+        Id: __expectString(output.Id),
+        Page: __expectInt32(output.Page),
+        Relationships: output.Relationships != null
+            ? deserializeAws_json1_1ListOfRelationships(output.Relationships, context)
+            : undefined,
+        Text: __expectString(output.Text),
+    };
+};
+const deserializeAws_json1_1BlockReference = (output, context) => {
+    return {
+        BeginOffset: __expectInt32(output.BeginOffset),
+        BlockId: __expectString(output.BlockId),
+        ChildBlocks: output.ChildBlocks != null ? deserializeAws_json1_1ListOfChildBlocks(output.ChildBlocks, context) : undefined,
+        EndOffset: __expectInt32(output.EndOffset),
+    };
+};
+const deserializeAws_json1_1BoundingBox = (output, context) => {
+    return {
+        Height: __limitedParseFloat32(output.Height),
+        Left: __limitedParseFloat32(output.Left),
+        Top: __limitedParseFloat32(output.Top),
+        Width: __limitedParseFloat32(output.Width),
+    };
+};
+const deserializeAws_json1_1ChildBlock = (output, context) => {
+    return {
+        BeginOffset: __expectInt32(output.BeginOffset),
+        ChildBlockId: __expectString(output.ChildBlockId),
+        EndOffset: __expectInt32(output.EndOffset),
+    };
+};
 const deserializeAws_json1_1ClassifierEvaluationMetrics = (output, context) => {
     return {
         Accuracy: __limitedParseDouble(output.Accuracy),
@@ -4986,6 +5029,11 @@ const deserializeAws_json1_1ClassifierMetadata = (output, context) => {
 const deserializeAws_json1_1ClassifyDocumentResponse = (output, context) => {
     return {
         Classes: output.Classes != null ? deserializeAws_json1_1ListOfClasses(output.Classes, context) : undefined,
+        DocumentMetadata: output.DocumentMetadata != null
+            ? deserializeAws_json1_1DocumentMetadata(output.DocumentMetadata, context)
+            : undefined,
+        DocumentType: output.DocumentType != null ? deserializeAws_json1_1ListOfDocumentType(output.DocumentType, context) : undefined,
+        Errors: output.Errors != null ? deserializeAws_json1_1ListOfErrors(output.Errors, context) : undefined,
         Labels: output.Labels != null ? deserializeAws_json1_1ListOfLabels(output.Labels, context) : undefined,
     };
 };
@@ -5129,7 +5177,13 @@ const deserializeAws_json1_1DetectDominantLanguageResponse = (output, context) =
 };
 const deserializeAws_json1_1DetectEntitiesResponse = (output, context) => {
     return {
+        Blocks: output.Blocks != null ? deserializeAws_json1_1ListOfBlocks(output.Blocks, context) : undefined,
+        DocumentMetadata: output.DocumentMetadata != null
+            ? deserializeAws_json1_1DocumentMetadata(output.DocumentMetadata, context)
+            : undefined,
+        DocumentType: output.DocumentType != null ? deserializeAws_json1_1ListOfDocumentType(output.DocumentType, context) : undefined,
         Entities: output.Entities != null ? deserializeAws_json1_1ListOfEntities(output.Entities, context) : undefined,
+        Errors: output.Errors != null ? deserializeAws_json1_1ListOfErrors(output.Errors, context) : undefined,
     };
 };
 const deserializeAws_json1_1DetectKeyPhrasesResponse = (output, context) => {
@@ -5163,6 +5217,7 @@ const deserializeAws_json1_1DetectTargetedSentimentResponse = (output, context)
 const deserializeAws_json1_1DocumentClass = (output, context) => {
     return {
         Name: __expectString(output.Name),
+        Page: __expectInt32(output.Page),
         Score: __limitedParseFloat32(output.Score),
     };
 };
@@ -5294,9 +5349,18 @@ const deserializeAws_json1_1DocumentClassifierSummary = (output, context) => {
 const deserializeAws_json1_1DocumentLabel = (output, context) => {
     return {
         Name: __expectString(output.Name),
+        Page: __expectInt32(output.Page),
         Score: __limitedParseFloat32(output.Score),
     };
 };
+const deserializeAws_json1_1DocumentMetadata = (output, context) => {
+    return {
+        ExtractedCharacters: output.ExtractedCharacters != null
+            ? deserializeAws_json1_1ListOfExtractedCharacters(output.ExtractedCharacters, context)
+            : undefined,
+        Pages: __expectInt32(output.Pages),
+    };
+};
 const deserializeAws_json1_1DocumentReaderConfig = (output, context) => {
     return {
         DocumentReadAction: __expectString(output.DocumentReadAction),
@@ -5306,6 +5370,12 @@ const deserializeAws_json1_1DocumentReaderConfig = (output, context) => {
             : undefined,
     };
 };
+const deserializeAws_json1_1DocumentTypeListItem = (output, context) => {
+    return {
+        Page: __expectInt32(output.Page),
+        Type: __expectString(output.Type),
+    };
+};
 const deserializeAws_json1_1DominantLanguage = (output, context) => {
     return {
         LanguageCode: __expectString(output.LanguageCode),
@@ -5409,6 +5479,9 @@ const deserializeAws_json1_1EntitiesDetectionJobPropertiesList = (output, contex
 const deserializeAws_json1_1Entity = (output, context) => {
     return {
         BeginOffset: __expectInt32(output.BeginOffset),
+        BlockReferences: output.BlockReferences != null
+            ? deserializeAws_json1_1ListOfBlockReferences(output.BlockReferences, context)
+            : undefined,
         EndOffset: __expectInt32(output.EndOffset),
         Score: __limitedParseFloat32(output.Score),
         Text: __expectString(output.Text),
@@ -5589,6 +5662,13 @@ const deserializeAws_json1_1EntityTypesListItem = (output, context) => {
         Type: __expectString(output.Type),
     };
 };
+const deserializeAws_json1_1ErrorsListItem = (output, context) => {
+    return {
+        ErrorCode: __expectString(output.ErrorCode),
+        ErrorMessage: __expectString(output.ErrorMessage),
+        Page: __expectInt32(output.Page),
+    };
+};
 const deserializeAws_json1_1EventsDetectionJobProperties = (output, context) => {
     return {
         DataAccessRoleArn: __expectString(output.DataAccessRoleArn),
@@ -5622,6 +5702,18 @@ const deserializeAws_json1_1EventsDetectionJobPropertiesList = (output, context)
     });
     return retVal;
 };
+const deserializeAws_json1_1ExtractedCharactersListItem = (output, context) => {
+    return {
+        Count: __expectInt32(output.Count),
+        Page: __expectInt32(output.Page),
+    };
+};
+const deserializeAws_json1_1Geometry = (output, context) => {
+    return {
+        BoundingBox: output.BoundingBox != null ? deserializeAws_json1_1BoundingBox(output.BoundingBox, context) : undefined,
+        Polygon: output.Polygon != null ? deserializeAws_json1_1Polygon(output.Polygon, context) : undefined,
+    };
+};
 const deserializeAws_json1_1ImportModelResponse = (output, context) => {
     return {
         ModelArn: __expectString(output.ModelArn),
@@ -5646,9 +5738,16 @@ const deserializeAws_json1_1InvalidFilterException = (output, context) => {
         Message: __expectString(output.Message),
     };
 };
+const deserializeAws_json1_1InvalidRequestDetail = (output, context) => {
+    return {
+        Reason: __expectString(output.Reason),
+    };
+};
 const deserializeAws_json1_1InvalidRequestException = (output, context) => {
     return {
+        Detail: output.Detail != null ? deserializeAws_json1_1InvalidRequestDetail(output.Detail, context) : undefined,
         Message: __expectString(output.Message),
+        Reason: __expectString(output.Reason),
     };
 };
 const deserializeAws_json1_1JobNotFoundException = (output, context) => {
@@ -5781,6 +5880,39 @@ const deserializeAws_json1_1ListKeyPhrasesDetectionJobsResponse = (output, conte
         NextToken: __expectString(output.NextToken),
     };
 };
+const deserializeAws_json1_1ListOfBlockReferences = (output, context) => {
+    const retVal = (output || [])
+        .filter((e) => e != null)
+        .map((entry) => {
+        if (entry === null) {
+            return null;
+        }
+        return deserializeAws_json1_1BlockReference(entry, context);
+    });
+    return retVal;
+};
+const deserializeAws_json1_1ListOfBlocks = (output, context) => {
+    const retVal = (output || [])
+        .filter((e) => e != null)
+        .map((entry) => {
+        if (entry === null) {
+            return null;
+        }
+        return deserializeAws_json1_1Block(entry, context);
+    });
+    return retVal;
+};
+const deserializeAws_json1_1ListOfChildBlocks = (output, context) => {
+    const retVal = (output || [])
+        .filter((e) => e != null)
+        .map((entry) => {
+        if (entry === null) {
+            return null;
+        }
+        return deserializeAws_json1_1ChildBlock(entry, context);
+    });
+    return retVal;
+};
 const deserializeAws_json1_1ListOfClasses = (output, context) => {
     const retVal = (output || [])
         .filter((e) => e != null)
@@ -5880,6 +6012,17 @@ const deserializeAws_json1_1ListOfDocumentReadFeatureTypes = (output, context) =
     });
     return retVal;
 };
+const deserializeAws_json1_1ListOfDocumentType = (output, context) => {
+    const retVal = (output || [])
+        .filter((e) => e != null)
+        .map((entry) => {
+        if (entry === null) {
+            return null;
+        }
+        return deserializeAws_json1_1DocumentTypeListItem(entry, context);
+    });
+    return retVal;
+};
 const deserializeAws_json1_1ListOfDominantLanguages = (output, context) => {
     const retVal = (output || [])
         .filter((e) => e != null)
@@ -5913,6 +6056,28 @@ const deserializeAws_json1_1ListOfEntityLabels = (output, context) => {
     });
     return retVal;
 };
+const deserializeAws_json1_1ListOfErrors = (output, context) => {
+    const retVal = (output || [])
+        .filter((e) => e != null)
+        .map((entry) => {
+        if (entry === null) {
+            return null;
+        }
+        return deserializeAws_json1_1ErrorsListItem(entry, context);
+    });
+    return retVal;
+};
+const deserializeAws_json1_1ListOfExtractedCharacters = (output, context) => {
+    const retVal = (output || [])
+        .filter((e) => e != null)
+        .map((entry) => {
+        if (entry === null) {
+            return null;
+        }
+        return deserializeAws_json1_1ExtractedCharactersListItem(entry, context);
+    });
+    return retVal;
+};
 const deserializeAws_json1_1ListOfKeyPhrases = (output, context) => {
     const retVal = (output || [])
         .filter((e) => e != null)
@@ -5968,6 +6133,17 @@ const deserializeAws_json1_1ListOfPiiEntityTypes = (output, context) => {
     });
     return retVal;
 };
+const deserializeAws_json1_1ListOfRelationships = (output, context) => {
+    const retVal = (output || [])
+        .filter((e) => e != null)
+        .map((entry) => {
+        if (entry === null) {
+            return null;
+        }
+        return deserializeAws_json1_1RelationshipsListItem(entry, context);
+    });
+    return retVal;
+};
 const deserializeAws_json1_1ListOfSyntaxTokens = (output, context) => {
     const retVal = (output || [])
         .filter((e) => e != null)
@@ -6094,6 +6270,23 @@ const deserializeAws_json1_1PiiOutputDataConfig = (output, context) => {
         S3Uri: __expectString(output.S3Uri),
     };
 };
+const deserializeAws_json1_1Point = (output, context) => {
+    return {
+        X: __limitedParseFloat32(output.X),
+        Y: __limitedParseFloat32(output.Y),
+    };
+};
+const deserializeAws_json1_1Polygon = (output, context) => {
+    const retVal = (output || [])
+        .filter((e) => e != null)
+        .map((entry) => {
+        if (entry === null) {
+            return null;
+        }
+        return deserializeAws_json1_1Point(entry, context);
+    });
+    return retVal;
+};
 const deserializeAws_json1_1PutResourcePolicyResponse = (output, context) => {
     return {
         PolicyRevisionId: __expectString(output.PolicyRevisionId),
@@ -6108,6 +6301,12 @@ const deserializeAws_json1_1RedactionConfig = (output, context) => {
             : undefined,
     };
 };
+const deserializeAws_json1_1RelationshipsListItem = (output, context) => {
+    return {
+        Ids: output.Ids != null ? deserializeAws_json1_1StringList(output.Ids, context) : undefined,
+        Type: __expectString(output.Type),
+    };
+};
 const deserializeAws_json1_1ResourceInUseException = (output, context) => {
     return {
         Message: __expectString(output.Message),
@@ -6290,6 +6489,17 @@ const deserializeAws_json1_1StopTrainingDocumentClassifierResponse = (output, co
 const deserializeAws_json1_1StopTrainingEntityRecognizerResponse = (output, context) => {
     return {};
 };
+const deserializeAws_json1_1StringList = (output, context) => {
+    const retVal = (output || [])
+        .filter((e) => e != null)
+        .map((entry) => {
+        if (entry === null) {
+            return null;
+        }
+        return __expectString(entry);
+    });
+    return retVal;
+};
 const deserializeAws_json1_1Subnets = (output, context) => {
     const retVal = (output || [])
         .filter((e) => e != null)

package/dist-types/Comprehend.d.ts

@@ -131,6 +131,15 @@ export declare 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>
      */
     classifyDocument(args: ClassifyDocumentCommandInput, options?: __HttpHandlerOptions): Promise<ClassifyDocumentCommandOutput>;
     classifyDocument(args: ClassifyDocumentCommandInput, cb: (err: any, data?: ClassifyDocumentCommandOutput) => void): void;
@@ -306,9 +315,22 @@ export declare class Comprehend extends ComprehendClient {
     detectDominantLanguage(args: DetectDominantLanguageCommandInput, cb: (err: any, data?: DetectDominantLanguageCommandOutput) => void): void;
     detectDominantLanguage(args: DetectDominantLanguageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectDominantLanguageCommandOutput) => void): void;
     /**
-     * <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>
      */
     detectEntities(args: DetectEntitiesCommandInput, options?: __HttpHandlerOptions): Promise<DetectEntitiesCommandOutput>;
     detectEntities(args: DetectEntitiesCommandInput, cb: (err: any, data?: DetectEntitiesCommandOutput) => void): void;

package/dist-types/commands/ClassifyDocumentCommand.d.ts

@@ -10,6 +10,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

package/dist-types/commands/DetectEntitiesCommand.d.ts

@@ -8,9 +8,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

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
     defaultSigningName: string;
 };
 export interface EndpointParameters extends __EndpointParameters {
-    Region?: string;
+    Region: string;
     UseDualStack?: boolean;
     UseFIPS?: boolean;
     Endpoint?: string;