Skip to content

Commit 2a70f0c

Browse files
author
awstools
committed
docs(client-comprehend): Documentation updates for Trust and Safety features.
1 parent 35fbeb8 commit 2a70f0c

20 files changed

+88
-125
lines changed

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,7 @@ export interface BatchDetectEntitiesCommandOutput extends BatchDetectEntitiesRes
120120
* <p>The size of the input text exceeds the limit. Use a smaller document.</p>
121121
*
122122
* @throws {@link UnsupportedLanguageException} (client fault)
123-
* <p>Amazon Comprehend can't process the language of the input text. For custom entity
124-
* recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
125-
* For a list of supported languages,
123+
* <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
126124
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
127125
* </p>
128126
*

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -102,9 +102,7 @@ export interface BatchDetectKeyPhrasesCommandOutput extends BatchDetectKeyPhrase
102102
* <p>The size of the input text exceeds the limit. Use a smaller document.</p>
103103
*
104104
* @throws {@link UnsupportedLanguageException} (client fault)
105-
* <p>Amazon Comprehend can't process the language of the input text. For custom entity
106-
* recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
107-
* For a list of supported languages,
105+
* <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
108106
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
109107
* </p>
110108
*

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,7 @@ export interface BatchDetectSentimentCommandOutput extends BatchDetectSentimentR
103103
* <p>The size of the input text exceeds the limit. Use a smaller document.</p>
104104
*
105105
* @throws {@link UnsupportedLanguageException} (client fault)
106-
* <p>Amazon Comprehend can't process the language of the input text. For custom entity
107-
* recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
108-
* For a list of supported languages,
106+
* <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
109107
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
110108
* </p>
111109
*

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,7 @@ export interface BatchDetectSyntaxCommandOutput extends BatchDetectSyntaxRespons
109109
* <p>The size of the input text exceeds the limit. Use a smaller document.</p>
110110
*
111111
* @throws {@link UnsupportedLanguageException} (client fault)
112-
* <p>Amazon Comprehend can't process the language of the input text. For custom entity
113-
* recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
114-
* For a list of supported languages,
112+
* <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
115113
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
116114
* </p>
117115
*

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -127,9 +127,7 @@ export interface BatchDetectTargetedSentimentCommandOutput
127127
* <p>The size of the input text exceeds the limit. Use a smaller document.</p>
128128
*
129129
* @throws {@link UnsupportedLanguageException} (client fault)
130-
* <p>Amazon Comprehend can't process the language of the input text. For custom entity
131-
* recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
132-
* For a list of supported languages,
130+
* <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
133131
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
134132
* </p>
135133
*

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

+7-6
Original file line numberDiff line numberDiff line change
@@ -47,18 +47,19 @@ export interface ClassifyDocumentCommandOutput extends ClassifyDocumentResponse,
4747
* <ul>
4848
* <li>
4949
* <p>Custom classifier - a custom model that you have created and trained.
50-
* For input, you can provide plain text, a single-page document (PDF, Word, or image), or Textract API output.
51-
* 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>
50+
* For input, you can provide plain text, a single-page document (PDF, Word, or image), or
51+
* 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>
5252
* </li>
5353
* <li>
54-
* <p>Prompt classifier - Amazon Comprehend provides a model for classifying prompts.
54+
* <p>Prompt safety classifier - Amazon Comprehend provides a pre-trained model for classifying
55+
* input prompts for generative AI applications.
5556
* For input, you provide English plain text input.
56-
* For prompt classification, the response includes only the <code>Classes</code> field.
57-
* 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>
57+
* For prompt safety classification, the response includes only the <code>Classes</code> field.
58+
* 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>
5859
* </li>
5960
* </ul>
6061
* <p>If the system detects errors while processing a page in the input document,
61-
* the API response includes an entry in <code>Errors</code> that describes the errors.</p>
62+
* the API response includes an <code>Errors</code> field that describes the errors.</p>
6263
* <p>If the system detects a document-level error in your input document, the API returns an
6364
* <code>InvalidRequestException</code> error response.
6465
* For details about this exception, see

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,7 @@ export interface ContainsPiiEntitiesCommandOutput extends ContainsPiiEntitiesRes
7979
* <p>The size of the input text exceeds the limit. Use a smaller document.</p>
8080
*
8181
* @throws {@link UnsupportedLanguageException} (client fault)
82-
* <p>Amazon Comprehend can't process the language of the input text. For custom entity
83-
* recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
84-
* For a list of supported languages,
82+
* <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
8583
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
8684
* </p>
8785
*

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -150,9 +150,7 @@ export interface CreateDocumentClassifierCommandOutput extends CreateDocumentCla
150150
* current request. </p>
151151
*
152152
* @throws {@link UnsupportedLanguageException} (client fault)
153-
* <p>Amazon Comprehend can't process the language of the input text. For custom entity
154-
* recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
155-
* For a list of supported languages,
153+
* <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
156154
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
157155
* </p>
158156
*

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -143,9 +143,7 @@ export interface CreateEntityRecognizerCommandOutput extends CreateEntityRecogni
143143
* current request. </p>
144144
*
145145
* @throws {@link UnsupportedLanguageException} (client fault)
146-
* <p>Amazon Comprehend can't process the language of the input text. For custom entity
147-
* recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
148-
* For a list of supported languages,
146+
* <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
149147
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
150148
* </p>
151149
*

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -146,9 +146,7 @@ export interface CreateFlywheelCommandOutput extends CreateFlywheelResponse, __M
146146
* current request. </p>
147147
*
148148
* @throws {@link UnsupportedLanguageException} (client fault)
149-
* <p>Amazon Comprehend can't process the language of the input text. For custom entity
150-
* recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
151-
* For a list of supported languages,
149+
* <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
152150
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
153151
* </p>
154152
*

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -179,9 +179,7 @@ export interface DetectEntitiesCommandOutput extends DetectEntitiesResponse, __M
179179
* <p>The size of the input text exceeds the limit. Use a smaller document.</p>
180180
*
181181
* @throws {@link UnsupportedLanguageException} (client fault)
182-
* <p>Amazon Comprehend can't process the language of the input text. For custom entity
183-
* recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
184-
* For a list of supported languages,
182+
* <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
185183
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
186184
* </p>
187185
*

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,7 @@ export interface DetectKeyPhrasesCommandOutput extends DetectKeyPhrasesResponse,
8484
* <p>The size of the input text exceeds the limit. Use a smaller document.</p>
8585
*
8686
* @throws {@link UnsupportedLanguageException} (client fault)
87-
* <p>Amazon Comprehend can't process the language of the input text. For custom entity
88-
* recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
89-
* For a list of supported languages,
87+
* <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
9088
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
9189
* </p>
9290
*

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,7 @@ export interface DetectPiiEntitiesCommandOutput extends DetectPiiEntitiesRespons
8080
* <p>The size of the input text exceeds the limit. Use a smaller document.</p>
8181
*
8282
* @throws {@link UnsupportedLanguageException} (client fault)
83-
* <p>Amazon Comprehend can't process the language of the input text. For custom entity
84-
* recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
85-
* For a list of supported languages,
83+
* <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
8684
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
8785
* </p>
8886
*

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,7 @@ export interface DetectSentimentCommandOutput extends DetectSentimentResponse, _
8484
* <p>The size of the input text exceeds the limit. Use a smaller document.</p>
8585
*
8686
* @throws {@link UnsupportedLanguageException} (client fault)
87-
* <p>Amazon Comprehend can't process the language of the input text. For custom entity
88-
* recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
89-
* For a list of supported languages,
87+
* <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
9088
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
9189
* </p>
9290
*

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,7 @@ export interface DetectSyntaxCommandOutput extends DetectSyntaxResponse, __Metad
9191
* <p>The size of the input text exceeds the limit. Use a smaller document.</p>
9292
*
9393
* @throws {@link UnsupportedLanguageException} (client fault)
94-
* <p>Amazon Comprehend can't process the language of the input text. For custom entity
95-
* recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
96-
* For a list of supported languages,
94+
* <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
9795
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
9896
* </p>
9997
*

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,7 @@ export interface DetectTargetedSentimentCommandOutput extends DetectTargetedSent
103103
* <p>The size of the input text exceeds the limit. Use a smaller document.</p>
104104
*
105105
* @throws {@link UnsupportedLanguageException} (client fault)
106-
* <p>Amazon Comprehend can't process the language of the input text. For custom entity
107-
* recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
108-
* For a list of supported languages,
106+
* <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
109107
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
110108
* </p>
111109
*

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

+3-6
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,9 @@ export interface DetectToxicContentCommandOutput extends DetectToxicContentRespo
4242
/**
4343
* @public
4444
* <p>Performs toxicity analysis on the list of text strings that you provide as input.
45-
* The analysis uses the order of strings in the list to determine context when predicting toxicity.
4645
* The API response contains a results list that matches the size of the input list.
47-
* 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>
48-
* </p>
46+
* 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>.
47+
* </p>
4948
* @example
5049
* Use a bare-bones client and the command you need to make an API call.
5150
* ```javascript
@@ -94,9 +93,7 @@ export interface DetectToxicContentCommandOutput extends DetectToxicContentRespo
9493
* <p>The size of the input text exceeds the limit. Use a smaller document.</p>
9594
*
9695
* @throws {@link UnsupportedLanguageException} (client fault)
97-
* <p>Amazon Comprehend can't process the language of the input text. For custom entity
98-
* recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
99-
* For a list of supported languages,
96+
* <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
10097
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
10198
* </p>
10299
*

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export interface StartDocumentClassificationJobCommandOutput
4242

4343
/**
4444
* @public
45-
* <p>Starts an asynchronous document classification job. Use the
45+
* <p>Starts an asynchronous document classification job using a custom classification model. Use the
4646
* <code>DescribeDocumentClassificationJob</code>
4747
* operation to track the progress of the job.</p>
4848
* @example

0 commit comments

Comments
 (0)