docs(client-comprehend): Documentation updates for Trust and Safety f…

…eatures.
aws · Dec 6, 2023 · 2a70f0c · 2a70f0c
1 parent 35fbeb8
commit 2a70f0c
Show file tree

Hide file tree

Showing 20 changed files with 88 additions and 125 deletions.
diff --git a/clients/client-comprehend/src/commands/BatchDetectEntitiesCommand.ts b/clients/client-comprehend/src/commands/BatchDetectEntitiesCommand.ts
@@ -120,9 +120,7 @@ export interface BatchDetectEntitiesCommandOutput extends BatchDetectEntitiesRes
  *  <p>The size of the input text exceeds the limit. Use a smaller document.</p>
  *
  * @throws {@link UnsupportedLanguageException} (client fault)
- *  <p>Amazon Comprehend can't process the language of the input text. For custom entity
- *       recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
- *       For a list of supported languages,
+ *  <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
  *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
  *     </p>
  *

diff --git a/clients/client-comprehend/src/commands/BatchDetectKeyPhrasesCommand.ts b/clients/client-comprehend/src/commands/BatchDetectKeyPhrasesCommand.ts
@@ -102,9 +102,7 @@ export interface BatchDetectKeyPhrasesCommandOutput extends BatchDetectKeyPhrase
  *  <p>The size of the input text exceeds the limit. Use a smaller document.</p>
  *
  * @throws {@link UnsupportedLanguageException} (client fault)
- *  <p>Amazon Comprehend can't process the language of the input text. For custom entity
- *       recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
- *       For a list of supported languages,
+ *  <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
  *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
  *     </p>
  *

diff --git a/clients/client-comprehend/src/commands/BatchDetectSentimentCommand.ts b/clients/client-comprehend/src/commands/BatchDetectSentimentCommand.ts
@@ -103,9 +103,7 @@ export interface BatchDetectSentimentCommandOutput extends BatchDetectSentimentR
  *  <p>The size of the input text exceeds the limit. Use a smaller document.</p>
  *
  * @throws {@link UnsupportedLanguageException} (client fault)
- *  <p>Amazon Comprehend can't process the language of the input text. For custom entity
- *       recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
- *       For a list of supported languages,
+ *  <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
  *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
  *     </p>
  *

diff --git a/clients/client-comprehend/src/commands/BatchDetectSyntaxCommand.ts b/clients/client-comprehend/src/commands/BatchDetectSyntaxCommand.ts
@@ -109,9 +109,7 @@ export interface BatchDetectSyntaxCommandOutput extends BatchDetectSyntaxRespons
  *  <p>The size of the input text exceeds the limit. Use a smaller document.</p>
  *
  * @throws {@link UnsupportedLanguageException} (client fault)
- *  <p>Amazon Comprehend can't process the language of the input text. For custom entity
- *       recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
- *       For a list of supported languages,
+ *  <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
  *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
  *     </p>
  *

diff --git a/clients/client-comprehend/src/commands/BatchDetectTargetedSentimentCommand.ts b/clients/client-comprehend/src/commands/BatchDetectTargetedSentimentCommand.ts
@@ -127,9 +127,7 @@ export interface BatchDetectTargetedSentimentCommandOutput
  *  <p>The size of the input text exceeds the limit. Use a smaller document.</p>
  *
  * @throws {@link UnsupportedLanguageException} (client fault)
- *  <p>Amazon Comprehend can't process the language of the input text. For custom entity
- *       recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
- *       For a list of supported languages,
+ *  <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
  *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
  *     </p>
  *

diff --git a/clients/client-comprehend/src/commands/ClassifyDocumentCommand.ts b/clients/client-comprehend/src/commands/ClassifyDocumentCommand.ts
@@ -47,18 +47,19 @@ export interface ClassifyDocumentCommandOutput extends ClassifyDocumentResponse,
  *          <ul>
  *             <li>
  *                <p>Custom classifier - a custom model that you have created and trained.
- *         For input, you can provide plain text, a single-page document (PDF, Word, or image), or Textract API output.
- *         For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html">Custom classification</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
+ *         For input, you can provide plain text, a single-page document (PDF, Word, or image), or
+ *         Amazon Textract API output. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html">Custom classification</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
  *             </li>
  *             <li>
- *                <p>Prompt classifier - Amazon Comprehend provides a model for classifying prompts.
+ *                <p>Prompt safety classifier - Amazon Comprehend provides a pre-trained model for classifying
+ *         input prompts for generative AI applications.
  *         For input, you provide English plain text input.
- *         For prompt classification, the response includes only the <code>Classes</code> field.
- *         For more information about prompt classifiers, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/prompt-classification.html">Prompt classifiers</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
+ *         For prompt safety classification, the response includes only the <code>Classes</code> field.
+ *         For more information about prompt safety classifiers, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/trust-safety.html#prompt-classification">Prompt safety classification</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
  *             </li>
  *          </ul>
  *          <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>
+ *       the API response includes an <code>Errors</code> field 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

diff --git a/clients/client-comprehend/src/commands/ContainsPiiEntitiesCommand.ts b/clients/client-comprehend/src/commands/ContainsPiiEntitiesCommand.ts
@@ -79,9 +79,7 @@ export interface ContainsPiiEntitiesCommandOutput extends ContainsPiiEntitiesRes
  *  <p>The size of the input text exceeds the limit. Use a smaller document.</p>
  *
  * @throws {@link UnsupportedLanguageException} (client fault)
- *  <p>Amazon Comprehend can't process the language of the input text. For custom entity
- *       recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
- *       For a list of supported languages,
+ *  <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
  *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
  *     </p>
  *

diff --git a/clients/client-comprehend/src/commands/CreateDocumentClassifierCommand.ts b/clients/client-comprehend/src/commands/CreateDocumentClassifierCommand.ts
@@ -150,9 +150,7 @@ export interface CreateDocumentClassifierCommandOutput extends CreateDocumentCla
  *       current request. </p>
  *
  * @throws {@link UnsupportedLanguageException} (client fault)
- *  <p>Amazon Comprehend can't process the language of the input text. For custom entity
- *       recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
- *       For a list of supported languages,
+ *  <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
  *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
  *     </p>
  *

diff --git a/clients/client-comprehend/src/commands/CreateEntityRecognizerCommand.ts b/clients/client-comprehend/src/commands/CreateEntityRecognizerCommand.ts
@@ -143,9 +143,7 @@ export interface CreateEntityRecognizerCommandOutput extends CreateEntityRecogni
  *       current request. </p>
  *
  * @throws {@link UnsupportedLanguageException} (client fault)
- *  <p>Amazon Comprehend can't process the language of the input text. For custom entity
- *       recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
- *       For a list of supported languages,
+ *  <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
  *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
  *     </p>
  *

diff --git a/clients/client-comprehend/src/commands/CreateFlywheelCommand.ts b/clients/client-comprehend/src/commands/CreateFlywheelCommand.ts
@@ -146,9 +146,7 @@ export interface CreateFlywheelCommandOutput extends CreateFlywheelResponse, __M
  *       current request. </p>
  *
  * @throws {@link UnsupportedLanguageException} (client fault)
- *  <p>Amazon Comprehend can't process the language of the input text. For custom entity
- *       recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
- *       For a list of supported languages,
+ *  <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
  *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
  *     </p>
  *

diff --git a/clients/client-comprehend/src/commands/DetectEntitiesCommand.ts b/clients/client-comprehend/src/commands/DetectEntitiesCommand.ts
@@ -179,9 +179,7 @@ export interface DetectEntitiesCommandOutput extends DetectEntitiesResponse, __M
  *  <p>The size of the input text exceeds the limit. Use a smaller document.</p>
  *
  * @throws {@link UnsupportedLanguageException} (client fault)
- *  <p>Amazon Comprehend can't process the language of the input text. For custom entity
- *       recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
- *       For a list of supported languages,
+ *  <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
  *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
  *     </p>
  *

diff --git a/clients/client-comprehend/src/commands/DetectKeyPhrasesCommand.ts b/clients/client-comprehend/src/commands/DetectKeyPhrasesCommand.ts
@@ -84,9 +84,7 @@ export interface DetectKeyPhrasesCommandOutput extends DetectKeyPhrasesResponse,
  *  <p>The size of the input text exceeds the limit. Use a smaller document.</p>
  *
  * @throws {@link UnsupportedLanguageException} (client fault)
- *  <p>Amazon Comprehend can't process the language of the input text. For custom entity
- *       recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
- *       For a list of supported languages,
+ *  <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
  *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
  *     </p>
  *

diff --git a/clients/client-comprehend/src/commands/DetectPiiEntitiesCommand.ts b/clients/client-comprehend/src/commands/DetectPiiEntitiesCommand.ts
@@ -80,9 +80,7 @@ export interface DetectPiiEntitiesCommandOutput extends DetectPiiEntitiesRespons
  *  <p>The size of the input text exceeds the limit. Use a smaller document.</p>
  *
  * @throws {@link UnsupportedLanguageException} (client fault)
- *  <p>Amazon Comprehend can't process the language of the input text. For custom entity
- *       recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
- *       For a list of supported languages,
+ *  <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
  *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
  *     </p>
  *

diff --git a/clients/client-comprehend/src/commands/DetectSentimentCommand.ts b/clients/client-comprehend/src/commands/DetectSentimentCommand.ts
@@ -84,9 +84,7 @@ export interface DetectSentimentCommandOutput extends DetectSentimentResponse, _
  *  <p>The size of the input text exceeds the limit. Use a smaller document.</p>
  *
  * @throws {@link UnsupportedLanguageException} (client fault)
- *  <p>Amazon Comprehend can't process the language of the input text. For custom entity
- *       recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
- *       For a list of supported languages,
+ *  <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
  *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
  *     </p>
  *

diff --git a/clients/client-comprehend/src/commands/DetectSyntaxCommand.ts b/clients/client-comprehend/src/commands/DetectSyntaxCommand.ts
@@ -91,9 +91,7 @@ export interface DetectSyntaxCommandOutput extends DetectSyntaxResponse, __Metad
  *  <p>The size of the input text exceeds the limit. Use a smaller document.</p>
  *
  * @throws {@link UnsupportedLanguageException} (client fault)
- *  <p>Amazon Comprehend can't process the language of the input text. For custom entity
- *       recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
- *       For a list of supported languages,
+ *  <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
  *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
  *     </p>
  *

diff --git a/clients/client-comprehend/src/commands/DetectTargetedSentimentCommand.ts b/clients/client-comprehend/src/commands/DetectTargetedSentimentCommand.ts
@@ -103,9 +103,7 @@ export interface DetectTargetedSentimentCommandOutput extends DetectTargetedSent
  *  <p>The size of the input text exceeds the limit. Use a smaller document.</p>
  *
  * @throws {@link UnsupportedLanguageException} (client fault)
- *  <p>Amazon Comprehend can't process the language of the input text. For custom entity
- *       recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
- *       For a list of supported languages,
+ *  <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
  *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
  *     </p>
  *

diff --git a/clients/client-comprehend/src/commands/DetectToxicContentCommand.ts b/clients/client-comprehend/src/commands/DetectToxicContentCommand.ts
@@ -42,10 +42,9 @@ export interface DetectToxicContentCommandOutput extends DetectToxicContentRespo
 /**
  * @public
  * <p>Performs toxicity analysis on the list of text strings that you provide as input.
- *       The analysis uses the order of strings in the list to determine context when predicting toxicity.
  *       The API response contains a results list that matches the size of the input list.
- *       For more information about toxicity detection, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/toxicity-detection.html">Toxicity detection</a> in the <i>Amazon Comprehend Developer Guide</i>
- *          </p>
+ *       For more information about toxicity detection, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/toxicity-detection.html">Toxicity detection</a> in the <i>Amazon Comprehend Developer Guide</i>.
+ *     </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -94,9 +93,7 @@ export interface DetectToxicContentCommandOutput extends DetectToxicContentRespo
  *  <p>The size of the input text exceeds the limit. Use a smaller document.</p>
  *
  * @throws {@link UnsupportedLanguageException} (client fault)
- *  <p>Amazon Comprehend can't process the language of the input text. For custom entity
- *       recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
- *       For a list of supported languages,
+ *  <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
  *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
  *     </p>
  *

diff --git a/clients/client-comprehend/src/commands/StartDocumentClassificationJobCommand.ts b/clients/client-comprehend/src/commands/StartDocumentClassificationJobCommand.ts
@@ -42,7 +42,7 @@ export interface StartDocumentClassificationJobCommandOutput
 
 /**
  * @public
- * <p>Starts an asynchronous document classification job. Use the
+ * <p>Starts an asynchronous document classification job using a custom classification model.  Use the
  *       <code>DescribeDocumentClassificationJob</code>
  *           operation to track the progress of the job.</p>
  * @example