@aws-sdk/client-comprehend 3.465.0 → 3.470.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (20) hide show
  1. package/dist-types/commands/BatchDetectEntitiesCommand.d.ts +1 -3
  2. package/dist-types/commands/BatchDetectKeyPhrasesCommand.d.ts +1 -3
  3. package/dist-types/commands/BatchDetectSentimentCommand.d.ts +1 -3
  4. package/dist-types/commands/BatchDetectSyntaxCommand.d.ts +1 -3
  5. package/dist-types/commands/BatchDetectTargetedSentimentCommand.d.ts +1 -3
  6. package/dist-types/commands/ClassifyDocumentCommand.d.ts +7 -6
  7. package/dist-types/commands/ContainsPiiEntitiesCommand.d.ts +1 -3
  8. package/dist-types/commands/CreateDocumentClassifierCommand.d.ts +1 -3
  9. package/dist-types/commands/CreateEntityRecognizerCommand.d.ts +1 -3
  10. package/dist-types/commands/CreateFlywheelCommand.d.ts +1 -3
  11. package/dist-types/commands/DetectEntitiesCommand.d.ts +1 -3
  12. package/dist-types/commands/DetectKeyPhrasesCommand.d.ts +1 -3
  13. package/dist-types/commands/DetectPiiEntitiesCommand.d.ts +1 -3
  14. package/dist-types/commands/DetectSentimentCommand.d.ts +1 -3
  15. package/dist-types/commands/DetectSyntaxCommand.d.ts +1 -3
  16. package/dist-types/commands/DetectTargetedSentimentCommand.d.ts +1 -3
  17. package/dist-types/commands/DetectToxicContentCommand.d.ts +3 -6
  18. package/dist-types/commands/StartDocumentClassificationJobCommand.d.ts +1 -1
  19. package/dist-types/models/models_0.d.ts +45 -50
  20. package/package.json +34 -34
package/dist-types/commands/BatchDetectEntitiesCommand.d.ts CHANGED
@@ -101,9 +101,7 @@ export interface BatchDetectEntitiesCommandOutput extends BatchDetectEntitiesRes
101
101
  * <p>The size of the input text exceeds the limit. Use a smaller document.</p>
102
102
  *
103
103
  * @throws {@link UnsupportedLanguageException} (client fault)
104
- * <p>Amazon Comprehend can't process the language of the input text. For custom entity
105
- * recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
106
- * For a list of supported languages,
104
+ * <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
107
105
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
108
106
  * </p>
109
107
  *
package/dist-types/commands/BatchDetectKeyPhrasesCommand.d.ts CHANGED
@@ -83,9 +83,7 @@ export interface BatchDetectKeyPhrasesCommandOutput extends BatchDetectKeyPhrase
83
83
  * <p>The size of the input text exceeds the limit. Use a smaller document.</p>
84
84
  *
85
85
  * @throws {@link UnsupportedLanguageException} (client fault)
86
- * <p>Amazon Comprehend can't process the language of the input text. For custom entity
87
- * recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
88
- * For a list of supported languages,
86
+ * <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
89
87
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
90
88
  * </p>
91
89
  *
package/dist-types/commands/BatchDetectSentimentCommand.d.ts CHANGED
@@ -84,9 +84,7 @@ export interface BatchDetectSentimentCommandOutput extends BatchDetectSentimentR
84
84
  * <p>The size of the input text exceeds the limit. Use a smaller document.</p>
85
85
  *
86
86
  * @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,
90
88
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
91
89
  * </p>
92
90
  *
package/dist-types/commands/BatchDetectSyntaxCommand.d.ts CHANGED
@@ -90,9 +90,7 @@ export interface BatchDetectSyntaxCommandOutput extends BatchDetectSyntaxRespons
90
90
  * <p>The size of the input text exceeds the limit. Use a smaller document.</p>
91
91
  *
92
92
  * @throws {@link UnsupportedLanguageException} (client fault)
93
- * <p>Amazon Comprehend can't process the language of the input text. For custom entity
94
- * recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
95
- * For a list of supported languages,
93
+ * <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
96
94
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
97
95
  * </p>
98
96
  *
package/dist-types/commands/BatchDetectTargetedSentimentCommand.d.ts CHANGED
@@ -103,9 +103,7 @@ export interface BatchDetectTargetedSentimentCommandOutput extends BatchDetectTa
103
103
  * <p>The size of the input text exceeds the limit. Use a smaller document.</p>
104
104
  *
105
105
  * @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,
109
107
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
110
108
  * </p>
111
109
  *
package/dist-types/commands/ClassifyDocumentCommand.d.ts CHANGED
@@ -28,18 +28,19 @@ export interface ClassifyDocumentCommandOutput extends ClassifyDocumentResponse,
28
28
  * <ul>
29
29
  * <li>
30
30
  * <p>Custom classifier - a custom model that you have created and trained.
31
- * For input, you can provide plain text, a single-page document (PDF, Word, or image), or Textract API output.
32
- * 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>
31
+ * For input, you can provide plain text, a single-page document (PDF, Word, or image), or
32
+ * 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>
33
33
  * </li>
34
34
  * <li>
35
- * <p>Prompt classifier - Amazon Comprehend provides a model for classifying prompts.
35
+ * <p>Prompt safety classifier - Amazon Comprehend provides a pre-trained model for classifying
36
+ * input prompts for generative AI applications.
36
37
  * For input, you provide English plain text input.
37
- * For prompt classification, the response includes only the <code>Classes</code> field.
38
- * 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>
38
+ * For prompt safety classification, the response includes only the <code>Classes</code> field.
39
+ * 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>
39
40
  * </li>
40
41
  * </ul>
41
42
  * <p>If the system detects errors while processing a page in the input document,
42
- * the API response includes an entry in <code>Errors</code> that describes the errors.</p>
43
+ * the API response includes an <code>Errors</code> field that describes the errors.</p>
43
44
  * <p>If the system detects a document-level error in your input document, the API returns an
44
45
  * <code>InvalidRequestException</code> error response.
45
46
  * For details about this exception, see
package/dist-types/commands/ContainsPiiEntitiesCommand.d.ts CHANGED
@@ -65,9 +65,7 @@ export interface ContainsPiiEntitiesCommandOutput extends ContainsPiiEntitiesRes
65
65
  * <p>The size of the input text exceeds the limit. Use a smaller document.</p>
66
66
  *
67
67
  * @throws {@link UnsupportedLanguageException} (client fault)
68
- * <p>Amazon Comprehend can't process the language of the input text. For custom entity
69
- * recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
70
- * For a list of supported languages,
68
+ * <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
71
69
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
72
70
  * </p>
73
71
  *
package/dist-types/commands/CreateDocumentClassifierCommand.d.ts CHANGED
@@ -136,9 +136,7 @@ export interface CreateDocumentClassifierCommandOutput extends CreateDocumentCla
136
136
  * current request. </p>
137
137
  *
138
138
  * @throws {@link UnsupportedLanguageException} (client fault)
139
- * <p>Amazon Comprehend can't process the language of the input text. For custom entity
140
- * recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
141
- * For a list of supported languages,
139
+ * <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
142
140
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
143
141
  * </p>
144
142
  *
package/dist-types/commands/CreateEntityRecognizerCommand.d.ts CHANGED
@@ -129,9 +129,7 @@ export interface CreateEntityRecognizerCommandOutput extends CreateEntityRecogni
129
129
  * current request. </p>
130
130
  *
131
131
  * @throws {@link UnsupportedLanguageException} (client fault)
132
- * <p>Amazon Comprehend can't process the language of the input text. For custom entity
133
- * recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
134
- * For a list of supported languages,
132
+ * <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
135
133
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
136
134
  * </p>
137
135
  *
package/dist-types/commands/CreateFlywheelCommand.d.ts CHANGED
@@ -132,9 +132,7 @@ export interface CreateFlywheelCommandOutput extends CreateFlywheelResponse, __M
132
132
  * current request. </p>
133
133
  *
134
134
  * @throws {@link UnsupportedLanguageException} (client fault)
135
- * <p>Amazon Comprehend can't process the language of the input text. For custom entity
136
- * recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
137
- * For a list of supported languages,
135
+ * <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
138
136
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
139
137
  * </p>
140
138
  *
package/dist-types/commands/DetectEntitiesCommand.d.ts CHANGED
@@ -160,9 +160,7 @@ export interface DetectEntitiesCommandOutput extends DetectEntitiesResponse, __M
160
160
  * <p>The size of the input text exceeds the limit. Use a smaller document.</p>
161
161
  *
162
162
  * @throws {@link UnsupportedLanguageException} (client fault)
163
- * <p>Amazon Comprehend can't process the language of the input text. For custom entity
164
- * recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
165
- * For a list of supported languages,
163
+ * <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
166
164
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
167
165
  * </p>
168
166
  *
package/dist-types/commands/DetectKeyPhrasesCommand.d.ts CHANGED
@@ -65,9 +65,7 @@ export interface DetectKeyPhrasesCommandOutput extends DetectKeyPhrasesResponse,
65
65
  * <p>The size of the input text exceeds the limit. Use a smaller document.</p>
66
66
  *
67
67
  * @throws {@link UnsupportedLanguageException} (client fault)
68
- * <p>Amazon Comprehend can't process the language of the input text. For custom entity
69
- * recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
70
- * For a list of supported languages,
68
+ * <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
71
69
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
72
70
  * </p>
73
71
  *
package/dist-types/commands/DetectPiiEntitiesCommand.d.ts CHANGED
@@ -66,9 +66,7 @@ export interface DetectPiiEntitiesCommandOutput extends DetectPiiEntitiesRespons
66
66
  * <p>The size of the input text exceeds the limit. Use a smaller document.</p>
67
67
  *
68
68
  * @throws {@link UnsupportedLanguageException} (client fault)
69
- * <p>Amazon Comprehend can't process the language of the input text. For custom entity
70
- * recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
71
- * For a list of supported languages,
69
+ * <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
72
70
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
73
71
  * </p>
74
72
  *
package/dist-types/commands/DetectSentimentCommand.d.ts CHANGED
@@ -65,9 +65,7 @@ export interface DetectSentimentCommandOutput extends DetectSentimentResponse, _
65
65
  * <p>The size of the input text exceeds the limit. Use a smaller document.</p>
66
66
  *
67
67
  * @throws {@link UnsupportedLanguageException} (client fault)
68
- * <p>Amazon Comprehend can't process the language of the input text. For custom entity
69
- * recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
70
- * For a list of supported languages,
68
+ * <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
71
69
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
72
70
  * </p>
73
71
  *
package/dist-types/commands/DetectSyntaxCommand.d.ts CHANGED
@@ -72,9 +72,7 @@ export interface DetectSyntaxCommandOutput extends DetectSyntaxResponse, __Metad
72
72
  * <p>The size of the input text exceeds the limit. Use a smaller document.</p>
73
73
  *
74
74
  * @throws {@link UnsupportedLanguageException} (client fault)
75
- * <p>Amazon Comprehend can't process the language of the input text. For custom entity
76
- * recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
77
- * For a list of supported languages,
75
+ * <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
78
76
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
79
77
  * </p>
80
78
  *
package/dist-types/commands/DetectTargetedSentimentCommand.d.ts CHANGED
@@ -84,9 +84,7 @@ export interface DetectTargetedSentimentCommandOutput extends DetectTargetedSent
84
84
  * <p>The size of the input text exceeds the limit. Use a smaller document.</p>
85
85
  *
86
86
  * @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,
90
88
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
91
89
  * </p>
92
90
  *
package/dist-types/commands/DetectToxicContentCommand.d.ts CHANGED
@@ -24,10 +24,9 @@ export interface DetectToxicContentCommandOutput extends DetectToxicContentRespo
24
24
  /**
25
25
  * @public
26
26
  * <p>Performs toxicity analysis on the list of text strings that you provide as input.
27
- * The analysis uses the order of strings in the list to determine context when predicting toxicity.
28
27
  * The API response contains a results list that matches the size of the input list.
29
- * 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>
30
- * </p>
28
+ * 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>.
29
+ * </p>
31
30
  * @example
32
31
  * Use a bare-bones client and the command you need to make an API call.
33
32
  * ```javascript
@@ -76,9 +75,7 @@ export interface DetectToxicContentCommandOutput extends DetectToxicContentRespo
76
75
  * <p>The size of the input text exceeds the limit. Use a smaller document.</p>
77
76
  *
78
77
  * @throws {@link UnsupportedLanguageException} (client fault)
79
- * <p>Amazon Comprehend can't process the language of the input text. For custom entity
80
- * recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
81
- * For a list of supported languages,
78
+ * <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
82
79
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
83
80
  * </p>
84
81
  *
package/dist-types/commands/StartDocumentClassificationJobCommand.d.ts CHANGED
@@ -23,7 +23,7 @@ export interface StartDocumentClassificationJobCommandOutput extends StartDocume
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Starts an asynchronous document classification job. Use the
26
+ * <p>Starts an asynchronous document classification job using a custom classification model. Use the
27
27
  * <code>DescribeDocumentClassificationJob</code>
28
28
  * operation to track the progress of the job.</p>
29
29
  * @example
package/dist-types/models/models_0.d.ts CHANGED
@@ -226,26 +226,35 @@ export declare const InvalidRequestDetailReason: {
226
226
  export type InvalidRequestDetailReason = (typeof InvalidRequestDetailReason)[keyof typeof InvalidRequestDetailReason];
227
227
  /**
228
228
  * @public
229
- * <p>Provides additional detail about why the request failed:</p>
230
- * <ul>
231
- * <li>
232
- * <p>Document size is too large - Check the size of your file and resubmit the request.</p>
233
- * </li>
234
- * <li>
235
- * <p>Document type is not supported - Check the file type and resubmit the request.</p>
236
- * </li>
237
- * <li>
238
- * <p>Too many pages in the document - Check the number of pages in your file and resubmit the request.</p>
239
- * </li>
240
- * <li>
241
- * <p>Access denied to Amazon Textract - Verify that your account has permission to use Amazon Textract API operations and resubmit the request.</p>
242
- * </li>
243
- * </ul>
229
+ * <p>Provides additional detail about why the request failed.</p>
244
230
  */
245
231
  export interface InvalidRequestDetail {
246
232
  /**
247
233
  * @public
248
- * <p>Reason code is <code>INVALID_DOCUMENT</code>.</p>
234
+ * <p>Reason codes include the following values:</p>
235
+ * <ul>
236
+ * <li>
237
+ * <p>DOCUMENT_SIZE_EXCEEDED - Document size is too large. Check the size of your file and resubmit the request.</p>
238
+ * </li>
239
+ * <li>
240
+ * <p>UNSUPPORTED_DOC_TYPE - Document type is not supported. Check the file type and resubmit the request.</p>
241
+ * </li>
242
+ * <li>
243
+ * <p>PAGE_LIMIT_EXCEEDED - Too many pages in the document. Check the number of pages in your file and resubmit the request.</p>
244
+ * </li>
245
+ * <li>
246
+ * <p>TEXTRACT_ACCESS_DENIED - Access denied to Amazon Textract. Verify that your account has permission to use Amazon Textract API operations and resubmit the request.</p>
247
+ * </li>
248
+ * <li>
249
+ * <p>NOT_TEXTRACT_JSON - Document is not Amazon Textract JSON format. Verify the format and resubmit the request.</p>
250
+ * </li>
251
+ * <li>
252
+ * <p>MISMATCHED_TOTAL_PAGE_COUNT - Check the number of pages in your file and resubmit the request.</p>
253
+ * </li>
254
+ * <li>
255
+ * <p>INVALID_DOCUMENT - Invalid document. Check the file and resubmit the request.</p>
256
+ * </li>
257
+ * </ul>
249
258
  */
250
259
  Reason?: InvalidRequestDetailReason;
251
260
  }
@@ -271,21 +280,7 @@ export declare class InvalidRequestException extends __BaseException {
271
280
  Reason?: InvalidRequestReason;
272
281
  /**
273
282
  * @public
274
- * <p>Provides additional detail about why the request failed:</p>
275
- * <ul>
276
- * <li>
277
- * <p>Document size is too large - Check the size of your file and resubmit the request.</p>
278
- * </li>
279
- * <li>
280
- * <p>Document type is not supported - Check the file type and resubmit the request.</p>
281
- * </li>
282
- * <li>
283
- * <p>Too many pages in the document - Check the number of pages in your file and resubmit the request.</p>
284
- * </li>
285
- * <li>
286
- * <p>Access denied to Amazon Textract - Verify that your account has permission to use Amazon Textract API operations and resubmit the request.</p>
287
- * </li>
288
- * </ul>
283
+ * <p>Provides additional detail about why the request failed.</p>
289
284
  */
290
285
  Detail?: InvalidRequestDetail;
291
286
  /**
@@ -498,9 +493,7 @@ export interface BatchDetectEntitiesResponse {
498
493
  }
499
494
  /**
500
495
  * @public
501
- * <p>Amazon Comprehend can't process the language of the input text. For custom entity
502
- * recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
503
- * For a list of supported languages,
496
+ * <p>Amazon Comprehend can't process the language of the input text. For a list of supported languages,
504
497
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
505
498
  * </p>
506
499
  */
@@ -1374,11 +1367,11 @@ export interface DocumentReaderConfig {
1374
1367
  * <ul>
1375
1368
  * <li>
1376
1369
  * <p>
1377
- * <code>TABLES</code> - Returns information about any tables that are detected in the input document. </p>
1370
+ * <code>TABLES</code> - Returns additional information about any tables that are detected in the input document. </p>
1378
1371
  * </li>
1379
1372
  * <li>
1380
1373
  * <p>
1381
- * <code>FORMS</code> - Returns information and the data from any forms that are detected in the input document. </p>
1374
+ * <code>FORMS</code> - Returns additional information about any forms that are detected in the input document. </p>
1382
1375
  * </li>
1383
1376
  * </ul>
1384
1377
  */
@@ -1397,7 +1390,8 @@ export interface ClassifyDocumentRequest {
1397
1390
  /**
1398
1391
  * @public
1399
1392
  * <p>The Amazon Resource Number (ARN) of the endpoint. </p>
1400
- * <p>For prompt classification, Amazon Comprehend provides the endpoint ARN: <code>zzz</code>.</p>
1393
+ * <p>For prompt safety classification, Amazon Comprehend provides the endpoint ARN. 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>
1394
+ * </p>
1401
1395
  * <p>For custom classification, you create an endpoint for your custom model. For more information,
1402
1396
  * see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/using-endpoints.html">Using Amazon Comprehend endpoints</a>.</p>
1403
1397
  */
@@ -1407,7 +1401,7 @@ export interface ClassifyDocumentRequest {
1407
1401
  * <p>Use the <code>Bytes</code> parameter to input a text, PDF, Word or image file.</p>
1408
1402
  * <p>When you classify a document using a custom model, you can also use the <code>Bytes</code> parameter to input an Amazon Textract <code>DetectDocumentText</code>
1409
1403
  * or <code>AnalyzeDocument</code> output file.</p>
1410
- * <p>To classify a document using the prompt classifier, use the <code>Text</code> parameter for input.</p>
1404
+ * <p>To classify a document using the prompt safety classifier, use the <code>Text</code> parameter for input.</p>
1411
1405
  * <p>Provide the input document as a sequence of base64-encoded bytes.
1412
1406
  * If your code uses an Amazon Web Services SDK to classify documents, the SDK may encode
1413
1407
  * the document file bytes for you. </p>
@@ -1638,17 +1632,17 @@ export interface WarningsListItem {
1638
1632
  export interface ClassifyDocumentResponse {
1639
1633
  /**
1640
1634
  * @public
1641
- * <p>The classes used by the document being analyzed. These are used for multi-class trained
1642
- * models. Individual classes are mutually exclusive and each document is expected to have only a
1635
+ * <p>The classes used by the document being analyzed. These are used for models trained in multi-class mode.
1636
+ * Individual classes are mutually exclusive and each document is expected to have only a
1643
1637
  * single class assigned to it. For example, an animal can be a dog or a cat, but not both at the
1644
1638
  * same time. </p>
1645
- * <p>For prompt classification, the response includes a single class (<code>UNDESIRED_PROMPT</code>), along with a confidence score.
1646
- * A higher confidence score indicates that the input prompt is undesired in nature.</p>
1639
+ * <p>For prompt safety classification, the response includes only two classes (SAFE_PROMPT and UNSAFE_PROMPT),
1640
+ * along with a confidence score for each class. The value range of the score is zero to one, where one is the highest confidence.</p>
1647
1641
  */
1648
1642
  Classes?: DocumentClass[];
1649
1643
  /**
1650
1644
  * @public
1651
- * <p>The labels used the document being analyzed. These are used for multi-label trained
1645
+ * <p>The labels used in the document being analyzed. These are used for multi-label trained
1652
1646
  * models. Individual labels represent different categories that are related in some manner and
1653
1647
  * are not mutually exclusive. For example, a movie can be just an action movie, or it can be an
1654
1648
  * action movie, a science fiction movie, and a comedy, all at the same time. </p>
@@ -2467,8 +2461,9 @@ export interface CreateDocumentClassifierRequest {
2467
2461
  /**
2468
2462
  * @public
2469
2463
  * <p>Indicates the mode in which the classifier will be trained. The classifier can be trained
2470
- * in multi-class mode, which identifies one and only one class for each document, or multi-label
2471
- * mode, which identifies one or more labels for each document. In multi-label mode, multiple
2464
+ * in multi-class (single-label) mode or multi-label mode.
2465
+ * Multi-class mode identifies a single class label for each document and
2466
+ * multi-label mode identifies one or more class labels for each document. Multiple
2472
2467
  * labels for an individual document are separated by a delimiter. The default delimiter between
2473
2468
  * labels is a pipe (|).</p>
2474
2469
  */
@@ -2683,7 +2678,7 @@ export interface EntityTypesListItem {
2683
2678
  * custom entity recognizer.</p>
2684
2679
  * <p>Entity types must not contain the following invalid characters: \n (line break), \\n
2685
2680
  * (escaped line break, \r (carriage return), \\r (escaped carriage return), \t (tab), \\t
2686
- * (escaped tab), space, and , (comma).</p>
2681
+ * (escaped tab), and , (comma).</p>
2687
2682
  */
2688
2683
  Type: string | undefined;
2689
2684
  }
@@ -5620,7 +5615,8 @@ export interface TextSegment {
5620
5615
  export interface DetectToxicContentRequest {
5621
5616
  /**
5622
5617
  * @public
5623
- * <p>A list of up to 10 text strings. The maximum size for the list is 10 KB.</p>
5618
+ * <p>A list of up to 10 text strings. Each string has a maximum size of 1 KB, and
5619
+ * the maximum size of the list is 10 KB.</p>
5624
5620
  */
5625
5621
  TextSegments: TextSegment[] | undefined;
5626
5622
  /**
@@ -5666,8 +5662,7 @@ export interface ToxicContent {
5666
5662
  }
5667
5663
  /**
5668
5664
  * @public
5669
- * <p>Toxicity analysis result for one string. 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>
5670
- * </p>
5665
+ * <p>Toxicity analysis result for one string. 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>
5671
5666
  */
5672
5667
  export interface ToxicLabels {
5673
5668
  /**
@@ -5677,7 +5672,7 @@ export interface ToxicLabels {
5677
5672
  Labels?: ToxicContent[];
5678
5673
  /**
5679
5674
  * @public
5680
- * <p>Overall toxicity score for the string.</p>
5675
+ * <p>Overall toxicity score for the string. Value range is zero to one, where one is the highest confidence.</p>
5681
5676
  */
5682
5677
  Toxicity?: number;
5683
5678
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-comprehend",
3
3
  "description": "AWS SDK for JavaScript Comprehend Client for Node.js, Browser and React Native",
4
- "version": "3.465.0",
4
+ "version": "3.470.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,41 +20,41 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.465.0",
24
- "@aws-sdk/core": "3.465.0",
25
- "@aws-sdk/credential-provider-node": "3.465.0",
26
- "@aws-sdk/middleware-host-header": "3.465.0",
27
- "@aws-sdk/middleware-logger": "3.465.0",
28
- "@aws-sdk/middleware-recursion-detection": "3.465.0",
29
- "@aws-sdk/middleware-signing": "3.465.0",
30
- "@aws-sdk/middleware-user-agent": "3.465.0",
31
- "@aws-sdk/region-config-resolver": "3.465.0",
32
- "@aws-sdk/types": "3.465.0",
33
- "@aws-sdk/util-endpoints": "3.465.0",
34
- "@aws-sdk/util-user-agent-browser": "3.465.0",
35
- "@aws-sdk/util-user-agent-node": "3.465.0",
36
- "@smithy/config-resolver": "^2.0.18",
37
- "@smithy/fetch-http-handler": "^2.2.6",
38
- "@smithy/hash-node": "^2.0.15",
39
- "@smithy/invalid-dependency": "^2.0.13",
40
- "@smithy/middleware-content-length": "^2.0.15",
41
- "@smithy/middleware-endpoint": "^2.2.0",
42
- "@smithy/middleware-retry": "^2.0.20",
43
- "@smithy/middleware-serde": "^2.0.13",
44
- "@smithy/middleware-stack": "^2.0.7",
45
- "@smithy/node-config-provider": "^2.1.5",
46
- "@smithy/node-http-handler": "^2.1.9",
47
- "@smithy/protocol-http": "^3.0.9",
48
- "@smithy/smithy-client": "^2.1.15",
49
- "@smithy/types": "^2.5.0",
50
- "@smithy/url-parser": "^2.0.13",
23
+ "@aws-sdk/client-sts": "3.470.0",
24
+ "@aws-sdk/core": "3.468.0",
25
+ "@aws-sdk/credential-provider-node": "3.470.0",
26
+ "@aws-sdk/middleware-host-header": "3.468.0",
27
+ "@aws-sdk/middleware-logger": "3.468.0",
28
+ "@aws-sdk/middleware-recursion-detection": "3.468.0",
29
+ "@aws-sdk/middleware-signing": "3.468.0",
30
+ "@aws-sdk/middleware-user-agent": "3.470.0",
31
+ "@aws-sdk/region-config-resolver": "3.470.0",
32
+ "@aws-sdk/types": "3.468.0",
33
+ "@aws-sdk/util-endpoints": "3.470.0",
34
+ "@aws-sdk/util-user-agent-browser": "3.468.0",
35
+ "@aws-sdk/util-user-agent-node": "3.470.0",
36
+ "@smithy/config-resolver": "^2.0.21",
37
+ "@smithy/fetch-http-handler": "^2.3.1",
38
+ "@smithy/hash-node": "^2.0.17",
39
+ "@smithy/invalid-dependency": "^2.0.15",
40
+ "@smithy/middleware-content-length": "^2.0.17",
41
+ "@smithy/middleware-endpoint": "^2.2.3",
42
+ "@smithy/middleware-retry": "^2.0.24",
43
+ "@smithy/middleware-serde": "^2.0.15",
44
+ "@smithy/middleware-stack": "^2.0.9",
45
+ "@smithy/node-config-provider": "^2.1.8",
46
+ "@smithy/node-http-handler": "^2.2.1",
47
+ "@smithy/protocol-http": "^3.0.11",
48
+ "@smithy/smithy-client": "^2.1.18",
49
+ "@smithy/types": "^2.7.0",
50
+ "@smithy/url-parser": "^2.0.15",
51
51
  "@smithy/util-base64": "^2.0.1",
52
- "@smithy/util-body-length-browser": "^2.0.0",
52
+ "@smithy/util-body-length-browser": "^2.0.1",
53
53
  "@smithy/util-body-length-node": "^2.1.0",
54
- "@smithy/util-defaults-mode-browser": "^2.0.19",
55
- "@smithy/util-defaults-mode-node": "^2.0.25",
56
- "@smithy/util-endpoints": "^1.0.4",
57
- "@smithy/util-retry": "^2.0.6",
54
+ "@smithy/util-defaults-mode-browser": "^2.0.22",
55
+ "@smithy/util-defaults-mode-node": "^2.0.29",
56
+ "@smithy/util-endpoints": "^1.0.7",
57
+ "@smithy/util-retry": "^2.0.8",
58
58
  "@smithy/util-utf8": "^2.0.2",
59
59
  "tslib": "^2.5.0",
60
60
  "uuid": "^8.3.2"