docs(client-comprehendmedical): Update to Amazon Comprehend Medical d…

…ocumentation.
aws · Jul 5, 2023 · 0c8e3b0 · 0c8e3b0
1 parent 2192142
commit 0c8e3b0
Show file tree

Hide file tree

Showing 13 changed files with 108 additions and 121 deletions.
diff --git a/clients/client-comprehendmedical/README.md b/clients/client-comprehendmedical/README.md
@@ -6,8 +6,7 @@
 
 AWS SDK for JavaScript ComprehendMedical Client for Node.js, Browser and React Native.
 
-<p> Comprehend Medical; extracts structured information from unstructured clinical text. Use these actions
-to gain insight in your documents. </p>
+<p>Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents. Amazon Comprehend Medical only detects entities in English language texts. Amazon Comprehend Medical places limits on the sizes of files allowed for different API operations. To learn more, see <a href="https://docs.aws.amazon.com/comprehend-medical/latest/dev/comprehendmedical-quotas.html">Guidelines and quotas</a> in the <i>Amazon Comprehend Medical Developer Guide</i>.</p>
 
 ## Installing
 

diff --git a/clients/client-comprehendmedical/src/ComprehendMedical.ts b/clients/client-comprehendmedical/src/ComprehendMedical.ts
@@ -574,8 +574,7 @@ export interface ComprehendMedical {
 
 /**
  * @public
- * <p> Comprehend Medical; extracts structured information from unstructured clinical text. Use these actions
- *       to gain insight in your documents. </p>
+ * <p>Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents. Amazon Comprehend Medical only detects entities in English language texts. Amazon Comprehend Medical places limits on the sizes of files allowed for different API operations. To learn more, see <a href="https://docs.aws.amazon.com/comprehend-medical/latest/dev/comprehendmedical-quotas.html">Guidelines and quotas</a> in the <i>Amazon Comprehend Medical Developer Guide</i>.</p>
  */
 export class ComprehendMedical extends ComprehendMedicalClient implements ComprehendMedical {}
 createAggregatedClient(commands, ComprehendMedical);
diff --git a/clients/client-comprehendmedical/src/ComprehendMedicalClient.ts b/clients/client-comprehendmedical/src/ComprehendMedicalClient.ts
@@ -371,8 +371,7 @@ export interface ComprehendMedicalClientResolvedConfig extends ComprehendMedical
 
 /**
  * @public
- * <p> Comprehend Medical; extracts structured information from unstructured clinical text. Use these actions
- *       to gain insight in your documents. </p>
+ * <p>Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents. Amazon Comprehend Medical only detects entities in English language texts. Amazon Comprehend Medical places limits on the sizes of files allowed for different API operations. To learn more, see <a href="https://docs.aws.amazon.com/comprehend-medical/latest/dev/comprehendmedical-quotas.html">Guidelines and quotas</a> in the <i>Amazon Comprehend Medical Developer Guide</i>.</p>
  */
 export class ComprehendMedicalClient extends __Client<
   __HttpHandlerOptions,

diff --git a/clients/client-comprehendmedical/src/commands/DetectEntitiesCommand.ts b/clients/client-comprehendmedical/src/commands/DetectEntitiesCommand.ts
@@ -43,9 +43,9 @@ export interface DetectEntitiesCommandOutput extends DetectEntitiesResponse, __M
  * @deprecated
  *
  * <p>The <code>DetectEntities</code> operation is deprecated. You should use the <a>DetectEntitiesV2</a> operation instead.</p>
- *          <p> Inspects the clinical text for a variety of medical entities and returns specific
+ *          <p>Inspects the clinical text for a variety of medical entities and returns specific
  *       information about them such as entity category, location, and confidence score on that
- *       information .</p>
+ *       information.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -135,7 +135,7 @@ export interface DetectEntitiesCommandOutput extends DetectEntitiesResponse, __M
  *       and then retry the request.</p>
  *
  * @throws {@link ServiceUnavailableException} (server fault)
- *  <p> The Comprehend Medical; service is temporarily unavailable. Please wait and then retry your request.
+ *  <p> The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
  *     </p>
  *
  * @throws {@link TextSizeLimitExceededException} (client fault)

diff --git a/clients/client-comprehendmedical/src/commands/DetectEntitiesV2Command.ts b/clients/client-comprehendmedical/src/commands/DetectEntitiesV2Command.ts
@@ -48,6 +48,7 @@ export interface DetectEntitiesV2CommandOutput extends DetectEntitiesV2Response,
  *       operation. This new action uses a different model for determining the entities in your medical
  *       text and changes the way that some entities are returned in the output. You should use the
  *         <code>DetectEntitiesV2</code> operation in all new applications.</p>
+ *
  *          <p>The <code>DetectEntitiesV2</code> operation returns the <code>Acuity</code> and
  *         <code>Direction</code> entities as attributes instead of types. </p>
  * @example
@@ -139,7 +140,7 @@ export interface DetectEntitiesV2CommandOutput extends DetectEntitiesV2Response,
  *       and then retry the request.</p>
  *
  * @throws {@link ServiceUnavailableException} (server fault)
- *  <p> The Comprehend Medical; service is temporarily unavailable. Please wait and then retry your request.
+ *  <p> The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
  *     </p>
  *
  * @throws {@link TextSizeLimitExceededException} (client fault)

diff --git a/clients/client-comprehendmedical/src/commands/DetectPHICommand.ts b/clients/client-comprehendmedical/src/commands/DetectPHICommand.ts
@@ -40,7 +40,7 @@ export interface DetectPHICommandOutput extends DetectPHIResponse, __MetadataBea
 
 /**
  * @public
- * <p> Inspects the clinical text for protected health information (PHI) entities and returns
+ * <p>Inspects the clinical text for protected health information (PHI) entities and returns
  *       the entity category, location, and confidence score for each entity. Amazon Comprehend Medical
  *       only detects entities in English language texts.</p>
  * @example
@@ -115,7 +115,7 @@ export interface DetectPHICommandOutput extends DetectPHIResponse, __MetadataBea
  *       and then retry the request.</p>
  *
  * @throws {@link ServiceUnavailableException} (server fault)
- *  <p> The Comprehend Medical; service is temporarily unavailable. Please wait and then retry your request.
+ *  <p> The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
  *     </p>
  *
  * @throws {@link TextSizeLimitExceededException} (client fault)

diff --git a/clients/client-comprehendmedical/src/commands/InferICD10CMCommand.ts b/clients/client-comprehendmedical/src/commands/InferICD10CMCommand.ts
@@ -123,7 +123,7 @@ export interface InferICD10CMCommandOutput extends InferICD10CMResponse, __Metad
  *       and then retry the request.</p>
  *
  * @throws {@link ServiceUnavailableException} (server fault)
- *  <p> The Comprehend Medical; service is temporarily unavailable. Please wait and then retry your request.
+ *  <p> The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
  *     </p>
  *
  * @throws {@link TextSizeLimitExceededException} (client fault)

diff --git a/clients/client-comprehendmedical/src/commands/InferRxNormCommand.ts b/clients/client-comprehendmedical/src/commands/InferRxNormCommand.ts
@@ -120,7 +120,7 @@ export interface InferRxNormCommandOutput extends InferRxNormResponse, __Metadat
  *       and then retry the request.</p>
  *
  * @throws {@link ServiceUnavailableException} (server fault)
- *  <p> The Comprehend Medical; service is temporarily unavailable. Please wait and then retry your request.
+ *  <p> The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
  *     </p>
  *
  * @throws {@link TextSizeLimitExceededException} (client fault)

diff --git a/clients/client-comprehendmedical/src/commands/InferSNOMEDCTCommand.ts b/clients/client-comprehendmedical/src/commands/InferSNOMEDCTCommand.ts
@@ -136,7 +136,7 @@ export interface InferSNOMEDCTCommandOutput extends InferSNOMEDCTResponse, __Met
  *       and then retry the request.</p>
  *
  * @throws {@link ServiceUnavailableException} (server fault)
- *  <p> The Comprehend Medical; service is temporarily unavailable. Please wait and then retry your request.
+ *  <p> The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
  *     </p>
  *
  * @throws {@link TextSizeLimitExceededException} (client fault)

diff --git a/clients/client-comprehendmedical/src/commands/ListPHIDetectionJobsCommand.ts b/clients/client-comprehendmedical/src/commands/ListPHIDetectionJobsCommand.ts
@@ -40,7 +40,7 @@ export interface ListPHIDetectionJobsCommandOutput extends ListPHIDetectionJobsR
 
 /**
  * @public
- * <p>Gets a list of protected health information (PHI) detection jobs that you have
+ * <p>Gets a list of protected health information (PHI) detection jobs you have
  *       submitted.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-comprehendmedical/src/index.ts b/clients/client-comprehendmedical/src/index.ts
@@ -1,8 +1,7 @@
 // smithy-typescript generated code
 /* eslint-disable */
 /**
- * <p> Comprehend Medical; extracts structured information from unstructured clinical text. Use these actions
- *       to gain insight in your documents. </p>
+ * <p>Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents. Amazon Comprehend Medical only detects entities in English language texts. Amazon Comprehend Medical places limits on the sizes of files allowed for different API operations. To learn more, see <a href="https://docs.aws.amazon.com/comprehend-medical/latest/dev/comprehendmedical-quotas.html">Guidelines and quotas</a> in the <i>Amazon Comprehend Medical Developer Guide</i>.</p>
  *
  * @packageDocumentation
  */