@aws-sdk/client-transcribe 3.231.0 → 3.235.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 (37) hide show
  1. package/dist-cjs/endpoint/ruleset.js +4 -409
  2. package/dist-cjs/models/models_0.js +2 -0
  3. package/dist-es/endpoint/ruleset.js +4 -409
  4. package/dist-es/models/models_0.js +2 -0
  5. package/dist-types/Transcribe.d.ts +82 -82
  6. package/dist-types/TranscribeClient.d.ts +4 -4
  7. package/dist-types/commands/CreateCallAnalyticsCategoryCommand.d.ts +5 -5
  8. package/dist-types/commands/CreateLanguageModelCommand.d.ts +6 -6
  9. package/dist-types/commands/CreateMedicalVocabularyCommand.d.ts +3 -3
  10. package/dist-types/commands/CreateVocabularyCommand.d.ts +3 -3
  11. package/dist-types/commands/CreateVocabularyFilterCommand.d.ts +3 -3
  12. package/dist-types/commands/DescribeLanguageModelCommand.d.ts +2 -2
  13. package/dist-types/commands/GetCallAnalyticsCategoryCommand.d.ts +1 -1
  14. package/dist-types/commands/GetCallAnalyticsJobCommand.d.ts +4 -4
  15. package/dist-types/commands/GetMedicalTranscriptionJobCommand.d.ts +2 -2
  16. package/dist-types/commands/GetMedicalVocabularyCommand.d.ts +2 -2
  17. package/dist-types/commands/GetTranscriptionJobCommand.d.ts +3 -3
  18. package/dist-types/commands/GetVocabularyCommand.d.ts +2 -2
  19. package/dist-types/commands/GetVocabularyFilterCommand.d.ts +1 -1
  20. package/dist-types/commands/ListCallAnalyticsCategoriesCommand.d.ts +1 -1
  21. package/dist-types/commands/ListCallAnalyticsJobsCommand.d.ts +1 -1
  22. package/dist-types/commands/ListLanguageModelsCommand.d.ts +1 -1
  23. package/dist-types/commands/ListMedicalTranscriptionJobsCommand.d.ts +1 -1
  24. package/dist-types/commands/ListMedicalVocabulariesCommand.d.ts +1 -1
  25. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  26. package/dist-types/commands/ListTranscriptionJobsCommand.d.ts +1 -1
  27. package/dist-types/commands/ListVocabulariesCommand.d.ts +1 -1
  28. package/dist-types/commands/ListVocabularyFiltersCommand.d.ts +1 -1
  29. package/dist-types/commands/StartCallAnalyticsJobCommand.d.ts +11 -11
  30. package/dist-types/commands/StartMedicalTranscriptionJobCommand.d.ts +11 -11
  31. package/dist-types/commands/StartTranscriptionJobCommand.d.ts +7 -7
  32. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  33. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  34. package/dist-types/commands/UpdateCallAnalyticsCategoryCommand.d.ts +1 -1
  35. package/dist-types/models/models_0.d.ts +386 -384
  36. package/dist-types/ts3.4/models/models_0.d.ts +2 -0
  37. package/package.json +8 -8
package/dist-types/Transcribe.d.ts CHANGED
@@ -42,21 +42,21 @@ import { TranscribeClient } from "./TranscribeClient";
42
42
  /**
43
43
  * <p>Amazon Transcribe offers three main types of batch transcription: <b>Standard</b>, <b>Medical</b>, and
44
44
  * <b>Call Analytics</b>.</p>
45
- * <ul>
45
+ * <ul>
46
46
  * <li>
47
- * <p>
47
+ * <p>
48
48
  * <b>Standard transcriptions</b> are the most common
49
49
  * option. Refer to for details.</p>
50
50
  * </li>
51
51
  * <li>
52
- * <p>
52
+ * <p>
53
53
  * <b>Medical transcriptions</b> are tailored to
54
54
  * medical professionals and incorporate medical terms. A common use case for this
55
55
  * service is transcribing doctor-patient dialogue into after-visit notes. Refer to
56
56
  * for details.</p>
57
57
  * </li>
58
58
  * <li>
59
- * <p>
59
+ * <p>
60
60
  * <b>Call Analytics transcriptions</b> are designed
61
61
  * for use with call center audio on two different channels; if you're looking for
62
62
  * insight into customer service calls, use this option. Refer to for details.</p>
@@ -66,18 +66,18 @@ import { TranscribeClient } from "./TranscribeClient";
66
66
  export declare class Transcribe extends TranscribeClient {
67
67
  /**
68
68
  * <p>Creates a new Call Analytics category.</p>
69
- * <p>All categories are automatically applied to your Call Analytics transcriptions. Note that in
69
+ * <p>All categories are automatically applied to your Call Analytics transcriptions. Note that in
70
70
  * order to apply categories to your transcriptions, you must create them before submitting your
71
71
  * transcription request, as categories cannot be applied retroactively.</p>
72
- * <p>When creating a new category, you can use the <code>InputType</code> parameter to
72
+ * <p>When creating a new category, you can use the <code>InputType</code> parameter to
73
73
  * label the category as a batch category (<code>POST_CALL</code>) or a streaming category
74
74
  * (<code>REAL_TIME</code>). Batch categories can only be applied to batch transcriptions and
75
75
  * streaming categories can only be applied to streaming transcriptions. If you do not include
76
76
  * <code>InputType</code>, your category is created as a batch category by default.</p>
77
- * <p>Call Analytics categories are composed of rules. For each category, you must create
77
+ * <p>Call Analytics categories are composed of rules. For each category, you must create
78
78
  * between 1 and 20 rules. Rules can include these parameters: , , , and .</p>
79
- * <p>To update an existing category, see .</p>
80
- * <p>To learn more about Call Analytics categories, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html">Creating categories for batch
79
+ * <p>To update an existing category, see .</p>
80
+ * <p>To learn more about Call Analytics categories, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html">Creating categories for batch
81
81
  * transcriptions</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html">Creating categories for
82
82
  * streaming transcriptions</a>.</p>
83
83
  */
@@ -86,20 +86,20 @@ export declare class Transcribe extends TranscribeClient {
86
86
  createCallAnalyticsCategory(args: CreateCallAnalyticsCategoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCallAnalyticsCategoryCommandOutput) => void): void;
87
87
  /**
88
88
  * <p>Creates a new custom language model.</p>
89
- * <p>When creating a new custom language model, you must specify:</p>
90
- * <ul>
89
+ * <p>When creating a new custom language model, you must specify:</p>
90
+ * <ul>
91
91
  * <li>
92
- * <p>If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband
92
+ * <p>If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband
93
93
  * (audio sample rates under 16,000 Hz) base model</p>
94
94
  * </li>
95
95
  * <li>
96
- * <p>The location of your training and tuning files (this must be an Amazon S3 URI)</p>
96
+ * <p>The location of your training and tuning files (this must be an Amazon S3 URI)</p>
97
97
  * </li>
98
98
  * <li>
99
- * <p>The language of your model</p>
99
+ * <p>The language of your model</p>
100
100
  * </li>
101
101
  * <li>
102
- * <p>A unique name for your model</p>
102
+ * <p>A unique name for your model</p>
103
103
  * </li>
104
104
  * </ul>
105
105
  */
@@ -108,17 +108,17 @@ export declare class Transcribe extends TranscribeClient {
108
108
  createLanguageModel(args: CreateLanguageModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLanguageModelCommandOutput) => void): void;
109
109
  /**
110
110
  * <p>Creates a new custom medical vocabulary.</p>
111
- * <p>Before creating a new custom medical vocabulary, you must first upload a text file
111
+ * <p>Before creating a new custom medical vocabulary, you must first upload a text file
112
112
  * that contains your new entries, phrases, and terms into an Amazon S3 bucket.
113
113
  * Note that this differs from , where you can
114
114
  * include a list of terms within your request using the <code>Phrases</code> flag;
115
115
  * <code>CreateMedicalVocabulary</code> does not support the <code>Phrases</code>
116
116
  * flag.</p>
117
- * <p>Each language has a character set that contains all allowed characters for that
117
+ * <p>Each language has a character set that contains all allowed characters for that
118
118
  * specific language. If you use unsupported characters, your custom vocabulary request
119
119
  * fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom Vocabularies</a> to get the character set for your
120
120
  * language.</p>
121
- * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom
121
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom
122
122
  * vocabularies</a>.</p>
123
123
  */
124
124
  createMedicalVocabulary(args: CreateMedicalVocabularyCommandInput, options?: __HttpHandlerOptions): Promise<CreateMedicalVocabularyCommandOutput>;
@@ -126,15 +126,15 @@ export declare class Transcribe extends TranscribeClient {
126
126
  createMedicalVocabulary(args: CreateMedicalVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMedicalVocabularyCommandOutput) => void): void;
127
127
  /**
128
128
  * <p>Creates a new custom vocabulary.</p>
129
- * <p>When creating a new custom vocabulary, you can either upload a text file that contains
129
+ * <p>When creating a new custom vocabulary, you can either upload a text file that contains
130
130
  * your new entries, phrases, and terms into an Amazon S3 bucket and include the
131
131
  * URI in your request. Or you can include a list of terms directly in your request using
132
132
  * the <code>Phrases</code> flag.</p>
133
- * <p>Each language has a character set that contains all allowed characters for that
133
+ * <p>Each language has a character set that contains all allowed characters for that
134
134
  * specific language. If you use unsupported characters, your custom vocabulary request
135
135
  * fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom Vocabularies</a> to get the character set for your
136
136
  * language.</p>
137
- * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom
137
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom
138
138
  * vocabularies</a>.</p>
139
139
  */
140
140
  createVocabulary(args: CreateVocabularyCommandInput, options?: __HttpHandlerOptions): Promise<CreateVocabularyCommandOutput>;
@@ -142,14 +142,14 @@ export declare class Transcribe extends TranscribeClient {
142
142
  createVocabulary(args: CreateVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVocabularyCommandOutput) => void): void;
143
143
  /**
144
144
  * <p>Creates a new custom vocabulary filter.</p>
145
- * <p>You can use custom vocabulary filters to mask, delete, or flag specific words from
145
+ * <p>You can use custom vocabulary filters to mask, delete, or flag specific words from
146
146
  * your transcript. Custom vocabulary filters are commonly used to mask profanity in
147
147
  * transcripts.</p>
148
- * <p>Each language has a character set that contains all allowed characters for that
148
+ * <p>Each language has a character set that contains all allowed characters for that
149
149
  * specific language. If you use unsupported characters, your custom vocabulary filter
150
150
  * request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
151
151
  * Vocabularies</a> to get the character set for your language.</p>
152
- * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html">Vocabulary
152
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html">Vocabulary
153
153
  * filtering</a>.</p>
154
154
  */
155
155
  createVocabularyFilter(args: CreateVocabularyFilterCommandInput, options?: __HttpHandlerOptions): Promise<CreateVocabularyFilterCommandOutput>;
@@ -221,10 +221,10 @@ export declare class Transcribe extends TranscribeClient {
221
221
  deleteVocabularyFilter(args: DeleteVocabularyFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVocabularyFilterCommandOutput) => void): void;
222
222
  /**
223
223
  * <p>Provides information about the specified custom language model.</p>
224
- * <p>This operation also shows if the base language model that you used to create your
224
+ * <p>This operation also shows if the base language model that you used to create your
225
225
  * custom language model has been updated. If Amazon Transcribe has updated the base
226
226
  * model, you can create a new custom language model using the updated base model.</p>
227
- * <p>If you tried to create a new custom language model and the request wasn't successful,
227
+ * <p>If you tried to create a new custom language model and the request wasn't successful,
228
228
  * you can use <code>DescribeLanguageModel</code> to help identify the reason for this
229
229
  * failure.</p>
230
230
  */
@@ -233,82 +233,82 @@ export declare class Transcribe extends TranscribeClient {
233
233
  describeLanguageModel(args: DescribeLanguageModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLanguageModelCommandOutput) => void): void;
234
234
  /**
235
235
  * <p>Provides information about the specified Call Analytics category.</p>
236
- * <p>To get a list of your Call Analytics categories, use the operation.</p>
236
+ * <p>To get a list of your Call Analytics categories, use the operation.</p>
237
237
  */
238
238
  getCallAnalyticsCategory(args: GetCallAnalyticsCategoryCommandInput, options?: __HttpHandlerOptions): Promise<GetCallAnalyticsCategoryCommandOutput>;
239
239
  getCallAnalyticsCategory(args: GetCallAnalyticsCategoryCommandInput, cb: (err: any, data?: GetCallAnalyticsCategoryCommandOutput) => void): void;
240
240
  getCallAnalyticsCategory(args: GetCallAnalyticsCategoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCallAnalyticsCategoryCommandOutput) => void): void;
241
241
  /**
242
242
  * <p>Provides information about the specified Call Analytics job.</p>
243
- * <p>To view the job's status, refer to <code>CallAnalyticsJobStatus</code>. If the status
243
+ * <p>To view the job's status, refer to <code>CallAnalyticsJobStatus</code>. If the status
244
244
  * is <code>COMPLETED</code>, the job is finished. You can find your completed transcript
245
245
  * at the URI specified in <code>TranscriptFileUri</code>. If the status is
246
246
  * <code>FAILED</code>, <code>FailureReason</code> provides details on why your
247
247
  * transcription job failed.</p>
248
- * <p>If you enabled personally identifiable information (PII) redaction, the redacted
248
+ * <p>If you enabled personally identifiable information (PII) redaction, the redacted
249
249
  * transcript appears at the location specified in
250
250
  * <code>RedactedTranscriptFileUri</code>.</p>
251
- * <p>If you chose to redact the audio in your media file, you can find your redacted media
251
+ * <p>If you chose to redact the audio in your media file, you can find your redacted media
252
252
  * file at the location specified in <code>RedactedMediaFileUri</code>.</p>
253
- * <p>To get a list of your Call Analytics jobs, use the operation.</p>
253
+ * <p>To get a list of your Call Analytics jobs, use the operation.</p>
254
254
  */
255
255
  getCallAnalyticsJob(args: GetCallAnalyticsJobCommandInput, options?: __HttpHandlerOptions): Promise<GetCallAnalyticsJobCommandOutput>;
256
256
  getCallAnalyticsJob(args: GetCallAnalyticsJobCommandInput, cb: (err: any, data?: GetCallAnalyticsJobCommandOutput) => void): void;
257
257
  getCallAnalyticsJob(args: GetCallAnalyticsJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCallAnalyticsJobCommandOutput) => void): void;
258
258
  /**
259
259
  * <p>Provides information about the specified medical transcription job.</p>
260
- * <p>To view the status of the specified medical transcription job, check the
260
+ * <p>To view the status of the specified medical transcription job, check the
261
261
  * <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>,
262
262
  * the job is finished. You can find the results at the location specified in
263
263
  * <code>TranscriptFileUri</code>. If the status is <code>FAILED</code>,
264
264
  * <code>FailureReason</code> provides details on why your transcription job
265
265
  * failed.</p>
266
- * <p>To get a list of your medical transcription jobs, use the operation.</p>
266
+ * <p>To get a list of your medical transcription jobs, use the operation.</p>
267
267
  */
268
268
  getMedicalTranscriptionJob(args: GetMedicalTranscriptionJobCommandInput, options?: __HttpHandlerOptions): Promise<GetMedicalTranscriptionJobCommandOutput>;
269
269
  getMedicalTranscriptionJob(args: GetMedicalTranscriptionJobCommandInput, cb: (err: any, data?: GetMedicalTranscriptionJobCommandOutput) => void): void;
270
270
  getMedicalTranscriptionJob(args: GetMedicalTranscriptionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMedicalTranscriptionJobCommandOutput) => void): void;
271
271
  /**
272
272
  * <p>Provides information about the specified custom medical vocabulary.</p>
273
- * <p>To view the status of the specified custom medical vocabulary, check the
273
+ * <p>To view the status of the specified custom medical vocabulary, check the
274
274
  * <code>VocabularyState</code> field. If the status is <code>READY</code>, your custom
275
275
  * vocabulary is available to use. If the status is <code>FAILED</code>,
276
276
  * <code>FailureReason</code> provides details on why your vocabulary failed.</p>
277
- * <p>To get a list of your custom medical vocabularies, use the operation.</p>
277
+ * <p>To get a list of your custom medical vocabularies, use the operation.</p>
278
278
  */
279
279
  getMedicalVocabulary(args: GetMedicalVocabularyCommandInput, options?: __HttpHandlerOptions): Promise<GetMedicalVocabularyCommandOutput>;
280
280
  getMedicalVocabulary(args: GetMedicalVocabularyCommandInput, cb: (err: any, data?: GetMedicalVocabularyCommandOutput) => void): void;
281
281
  getMedicalVocabulary(args: GetMedicalVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMedicalVocabularyCommandOutput) => void): void;
282
282
  /**
283
283
  * <p>Provides information about the specified transcription job.</p>
284
- * <p>To view the status of the specified transcription job, check the
284
+ * <p>To view the status of the specified transcription job, check the
285
285
  * <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>,
286
286
  * the job is finished. You can find the results at the location specified in
287
287
  * <code>TranscriptFileUri</code>. If the status is <code>FAILED</code>,
288
288
  * <code>FailureReason</code> provides details on why your transcription job
289
289
  * failed.</p>
290
- * <p>If you enabled content redaction, the redacted transcript can be found at the location
290
+ * <p>If you enabled content redaction, the redacted transcript can be found at the location
291
291
  * specified in <code>RedactedTranscriptFileUri</code>.</p>
292
- * <p>To get a list of your transcription jobs, use the operation.</p>
292
+ * <p>To get a list of your transcription jobs, use the operation.</p>
293
293
  */
294
294
  getTranscriptionJob(args: GetTranscriptionJobCommandInput, options?: __HttpHandlerOptions): Promise<GetTranscriptionJobCommandOutput>;
295
295
  getTranscriptionJob(args: GetTranscriptionJobCommandInput, cb: (err: any, data?: GetTranscriptionJobCommandOutput) => void): void;
296
296
  getTranscriptionJob(args: GetTranscriptionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTranscriptionJobCommandOutput) => void): void;
297
297
  /**
298
298
  * <p>Provides information about the specified custom vocabulary.</p>
299
- * <p>To view the status of the specified custom vocabulary, check the
299
+ * <p>To view the status of the specified custom vocabulary, check the
300
300
  * <code>VocabularyState</code> field. If the status is <code>READY</code>, your custom
301
301
  * vocabulary is available to use. If the status is <code>FAILED</code>,
302
302
  * <code>FailureReason</code> provides details on why your custom vocabulary
303
303
  * failed.</p>
304
- * <p>To get a list of your custom vocabularies, use the operation.</p>
304
+ * <p>To get a list of your custom vocabularies, use the operation.</p>
305
305
  */
306
306
  getVocabulary(args: GetVocabularyCommandInput, options?: __HttpHandlerOptions): Promise<GetVocabularyCommandOutput>;
307
307
  getVocabulary(args: GetVocabularyCommandInput, cb: (err: any, data?: GetVocabularyCommandOutput) => void): void;
308
308
  getVocabulary(args: GetVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVocabularyCommandOutput) => void): void;
309
309
  /**
310
310
  * <p>Provides information about the specified custom vocabulary filter.</p>
311
- * <p>To get a list of your custom vocabulary filters, use the operation.</p>
311
+ * <p>To get a list of your custom vocabulary filters, use the operation.</p>
312
312
  */
313
313
  getVocabularyFilter(args: GetVocabularyFilterCommandInput, options?: __HttpHandlerOptions): Promise<GetVocabularyFilterCommandOutput>;
314
314
  getVocabularyFilter(args: GetVocabularyFilterCommandInput, cb: (err: any, data?: GetVocabularyFilterCommandOutput) => void): void;
@@ -316,7 +316,7 @@ export declare class Transcribe extends TranscribeClient {
316
316
  /**
317
317
  * <p>Provides a list of Call Analytics categories, including all rules that make up each
318
318
  * category.</p>
319
- * <p>To get detailed information about a specific Call Analytics category, use the operation.</p>
319
+ * <p>To get detailed information about a specific Call Analytics category, use the operation.</p>
320
320
  */
321
321
  listCallAnalyticsCategories(args: ListCallAnalyticsCategoriesCommandInput, options?: __HttpHandlerOptions): Promise<ListCallAnalyticsCategoriesCommandOutput>;
322
322
  listCallAnalyticsCategories(args: ListCallAnalyticsCategoriesCommandInput, cb: (err: any, data?: ListCallAnalyticsCategoriesCommandOutput) => void): void;
@@ -324,7 +324,7 @@ export declare class Transcribe extends TranscribeClient {
324
324
  /**
325
325
  * <p>Provides a list of Call Analytics jobs that match the specified criteria. If no
326
326
  * criteria are specified, all Call Analytics jobs are returned.</p>
327
- * <p>To get detailed information about a specific Call Analytics job, use the operation.</p>
327
+ * <p>To get detailed information about a specific Call Analytics job, use the operation.</p>
328
328
  */
329
329
  listCallAnalyticsJobs(args: ListCallAnalyticsJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListCallAnalyticsJobsCommandOutput>;
330
330
  listCallAnalyticsJobs(args: ListCallAnalyticsJobsCommandInput, cb: (err: any, data?: ListCallAnalyticsJobsCommandOutput) => void): void;
@@ -332,7 +332,7 @@ export declare class Transcribe extends TranscribeClient {
332
332
  /**
333
333
  * <p>Provides a list of custom language models that match the specified criteria. If no
334
334
  * criteria are specified, all custom language models are returned.</p>
335
- * <p>To get detailed information about a specific custom language model, use the operation.</p>
335
+ * <p>To get detailed information about a specific custom language model, use the operation.</p>
336
336
  */
337
337
  listLanguageModels(args: ListLanguageModelsCommandInput, options?: __HttpHandlerOptions): Promise<ListLanguageModelsCommandOutput>;
338
338
  listLanguageModels(args: ListLanguageModelsCommandInput, cb: (err: any, data?: ListLanguageModelsCommandOutput) => void): void;
@@ -340,7 +340,7 @@ export declare class Transcribe extends TranscribeClient {
340
340
  /**
341
341
  * <p>Provides a list of medical transcription jobs that match the specified criteria. If no
342
342
  * criteria are specified, all medical transcription jobs are returned.</p>
343
- * <p>To get detailed information about a specific medical transcription job, use the operation.</p>
343
+ * <p>To get detailed information about a specific medical transcription job, use the operation.</p>
344
344
  */
345
345
  listMedicalTranscriptionJobs(args: ListMedicalTranscriptionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListMedicalTranscriptionJobsCommandOutput>;
346
346
  listMedicalTranscriptionJobs(args: ListMedicalTranscriptionJobsCommandInput, cb: (err: any, data?: ListMedicalTranscriptionJobsCommandOutput) => void): void;
@@ -348,7 +348,7 @@ export declare class Transcribe extends TranscribeClient {
348
348
  /**
349
349
  * <p>Provides a list of custom medical vocabularies that match the specified criteria. If
350
350
  * no criteria are specified, all custom medical vocabularies are returned.</p>
351
- * <p>To get detailed information about a specific custom medical vocabulary, use the operation.</p>
351
+ * <p>To get detailed information about a specific custom medical vocabulary, use the operation.</p>
352
352
  */
353
353
  listMedicalVocabularies(args: ListMedicalVocabulariesCommandInput, options?: __HttpHandlerOptions): Promise<ListMedicalVocabulariesCommandOutput>;
354
354
  listMedicalVocabularies(args: ListMedicalVocabulariesCommandInput, cb: (err: any, data?: ListMedicalVocabulariesCommandOutput) => void): void;
@@ -356,7 +356,7 @@ export declare class Transcribe extends TranscribeClient {
356
356
  /**
357
357
  * <p>Lists all tags associated with the specified transcription job, vocabulary, model, or
358
358
  * resource.</p>
359
- * <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
359
+ * <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
360
360
  * resources</a>.</p>
361
361
  */
362
362
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
@@ -365,7 +365,7 @@ export declare class Transcribe extends TranscribeClient {
365
365
  /**
366
366
  * <p>Provides a list of transcription jobs that match the specified criteria. If no
367
367
  * criteria are specified, all transcription jobs are returned.</p>
368
- * <p>To get detailed information about a specific transcription job, use the operation.</p>
368
+ * <p>To get detailed information about a specific transcription job, use the operation.</p>
369
369
  */
370
370
  listTranscriptionJobs(args: ListTranscriptionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListTranscriptionJobsCommandOutput>;
371
371
  listTranscriptionJobs(args: ListTranscriptionJobsCommandInput, cb: (err: any, data?: ListTranscriptionJobsCommandOutput) => void): void;
@@ -373,7 +373,7 @@ export declare class Transcribe extends TranscribeClient {
373
373
  /**
374
374
  * <p>Provides a list of custom vocabularies that match the specified criteria. If no
375
375
  * criteria are specified, all custom vocabularies are returned.</p>
376
- * <p>To get detailed information about a specific custom vocabulary, use the operation.</p>
376
+ * <p>To get detailed information about a specific custom vocabulary, use the operation.</p>
377
377
  */
378
378
  listVocabularies(args: ListVocabulariesCommandInput, options?: __HttpHandlerOptions): Promise<ListVocabulariesCommandOutput>;
379
379
  listVocabularies(args: ListVocabulariesCommandInput, cb: (err: any, data?: ListVocabulariesCommandOutput) => void): void;
@@ -381,7 +381,7 @@ export declare class Transcribe extends TranscribeClient {
381
381
  /**
382
382
  * <p>Provides a list of custom vocabulary filters that match the specified criteria. If no
383
383
  * criteria are specified, all custom vocabularies are returned.</p>
384
- * <p>To get detailed information about a specific custom vocabulary filter, use the operation.</p>
384
+ * <p>To get detailed information about a specific custom vocabulary filter, use the operation.</p>
385
385
  */
386
386
  listVocabularyFilters(args: ListVocabularyFiltersCommandInput, options?: __HttpHandlerOptions): Promise<ListVocabularyFiltersCommandOutput>;
387
387
  listVocabularyFilters(args: ListVocabularyFiltersCommandInput, cb: (err: any, data?: ListVocabularyFiltersCommandOutput) => void): void;
@@ -389,54 +389,54 @@ export declare class Transcribe extends TranscribeClient {
389
389
  /**
390
390
  * <p>Transcribes the audio from a customer service call and applies any additional Request
391
391
  * Parameters you choose to include in your request.</p>
392
- * <p>In addition to many standard transcription features, Call Analytics provides you with
392
+ * <p>In addition to many standard transcription features, Call Analytics provides you with
393
393
  * call characteristics, call summarization, speaker sentiment, and optional redaction of
394
394
  * your text transcript and your audio file. You can also apply custom categories to flag
395
395
  * specified conditions. To learn more about these features and insights, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html">Analyzing call
396
396
  * center audio with Call Analytics</a>.</p>
397
- * <p>If you want to apply categories to your Call Analytics job, you must create them
397
+ * <p>If you want to apply categories to your Call Analytics job, you must create them
398
398
  * before submitting your job request. Categories cannot be retroactively applied to a job.
399
399
  * To create a new category, use the
400
400
  * operation. To learn more about Call Analytics categories, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html">Creating categories for batch
401
401
  * transcriptions</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html">Creating categories for
402
402
  * streaming transcriptions</a>.</p>
403
- * <p>To make a <code>StartCallAnalyticsJob</code> request, you must first upload your media
403
+ * <p>To make a <code>StartCallAnalyticsJob</code> request, you must first upload your media
404
404
  * file into an Amazon S3 bucket; you can then specify the Amazon S3
405
405
  * location of the file using the <code>Media</code> parameter.</p>
406
- * <p>You must include the following parameters in your <code>StartCallAnalyticsJob</code>
406
+ * <p>You must include the following parameters in your <code>StartCallAnalyticsJob</code>
407
407
  * request:</p>
408
- * <ul>
408
+ * <ul>
409
409
  * <li>
410
- * <p>
410
+ * <p>
411
411
  * <code>region</code>: The Amazon Web Services Region where you are making your
412
412
  * request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html">Amazon Transcribe endpoints and
413
413
  * quotas</a>.</p>
414
414
  * </li>
415
415
  * <li>
416
- * <p>
416
+ * <p>
417
417
  * <code>CallAnalyticsJobName</code>: A custom name that you create for your
418
418
  * transcription job that's unique within your Amazon Web Services account.</p>
419
419
  * </li>
420
420
  * <li>
421
- * <p>
421
+ * <p>
422
422
  * <code>DataAccessRoleArn</code>: The Amazon Resource Name (ARN) of an IAM role
423
423
  * that has permissions to access the Amazon S3 bucket that contains your
424
424
  * input files.</p>
425
425
  * </li>
426
426
  * <li>
427
- * <p>
427
+ * <p>
428
428
  * <code>Media</code> (<code>MediaFileUri</code> or
429
429
  * <code>RedactedMediaFileUri</code>): The Amazon S3 location of your
430
430
  * media file.</p>
431
431
  * </li>
432
432
  * </ul>
433
- * <note>
433
+ * <note>
434
434
  * <p>With Call Analytics, you can redact the audio contained in your media file by
435
435
  * including <code>RedactedMediaFileUri</code>, instead of <code>MediaFileUri</code>,
436
436
  * to specify the location of your input audio. If you choose to redact your audio, you
437
437
  * can find your redacted media at the location specified in the
438
438
  * <code>RedactedMediaFileUri</code> field of your response.</p>
439
- * </note>
439
+ * </note>
440
440
  */
441
441
  startCallAnalyticsJob(args: StartCallAnalyticsJobCommandInput, options?: __HttpHandlerOptions): Promise<StartCallAnalyticsJobCommandOutput>;
442
442
  startCallAnalyticsJob(args: StartCallAnalyticsJobCommandInput, cb: (err: any, data?: StartCallAnalyticsJobCommandOutput) => void): void;
@@ -444,49 +444,49 @@ export declare class Transcribe extends TranscribeClient {
444
444
  /**
445
445
  * <p>Transcribes the audio from a medical dictation or conversation and applies any
446
446
  * additional Request Parameters you choose to include in your request.</p>
447
- * <p>In addition to many standard transcription features, Amazon Transcribe Medical
447
+ * <p>In addition to many standard transcription features, Amazon Transcribe Medical
448
448
  * provides you with a robust medical vocabulary and, optionally, content identification,
449
449
  * which adds flags to personal health information (PHI). To learn more about these
450
450
  * features, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-it-works-med.html">How Amazon Transcribe Medical
451
451
  * works</a>.</p>
452
- * <p>To make a <code>StartMedicalTranscriptionJob</code> request, you must first upload
452
+ * <p>To make a <code>StartMedicalTranscriptionJob</code> request, you must first upload
453
453
  * your media file into an Amazon S3 bucket; you can then specify the S3 location
454
454
  * of the file using the <code>Media</code> parameter.</p>
455
- * <p>You must include the following parameters in your
455
+ * <p>You must include the following parameters in your
456
456
  * <code>StartMedicalTranscriptionJob</code> request:</p>
457
- * <ul>
457
+ * <ul>
458
458
  * <li>
459
- * <p>
459
+ * <p>
460
460
  * <code>region</code>: The Amazon Web Services Region where you are making your
461
461
  * request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html">Amazon Transcribe endpoints and
462
462
  * quotas</a>.</p>
463
463
  * </li>
464
464
  * <li>
465
- * <p>
465
+ * <p>
466
466
  * <code>MedicalTranscriptionJobName</code>: A custom name you create for your
467
467
  * transcription job that is unique within your Amazon Web Services account.</p>
468
468
  * </li>
469
469
  * <li>
470
- * <p>
470
+ * <p>
471
471
  * <code>Media</code> (<code>MediaFileUri</code>): The Amazon S3 location
472
472
  * of your media file.</p>
473
473
  * </li>
474
474
  * <li>
475
- * <p>
475
+ * <p>
476
476
  * <code>LanguageCode</code>: This must be <code>en-US</code>.</p>
477
477
  * </li>
478
478
  * <li>
479
- * <p>
479
+ * <p>
480
480
  * <code>OutputBucketName</code>: The Amazon S3 bucket where you want
481
481
  * your transcript stored. If you want your output stored in a sub-folder of this
482
482
  * bucket, you must also include <code>OutputKey</code>.</p>
483
483
  * </li>
484
484
  * <li>
485
- * <p>
485
+ * <p>
486
486
  * <code>Specialty</code>: This must be <code>PRIMARYCARE</code>.</p>
487
487
  * </li>
488
488
  * <li>
489
- * <p>
489
+ * <p>
490
490
  * <code>Type</code>: Choose whether your audio is a conversation or a
491
491
  * dictation.</p>
492
492
  * </li>
@@ -498,30 +498,30 @@ export declare class Transcribe extends TranscribeClient {
498
498
  /**
499
499
  * <p>Transcribes the audio from a media file and applies any additional Request Parameters
500
500
  * you choose to include in your request.</p>
501
- * <p>To make a <code>StartTranscriptionJob</code> request, you must first upload your media
501
+ * <p>To make a <code>StartTranscriptionJob</code> request, you must first upload your media
502
502
  * file into an Amazon S3 bucket; you can then specify the Amazon S3
503
503
  * location of the file using the <code>Media</code> parameter.</p>
504
- * <p>You must include the following parameters in your <code>StartTranscriptionJob</code>
504
+ * <p>You must include the following parameters in your <code>StartTranscriptionJob</code>
505
505
  * request:</p>
506
- * <ul>
506
+ * <ul>
507
507
  * <li>
508
- * <p>
508
+ * <p>
509
509
  * <code>region</code>: The Amazon Web Services Region where you are making your
510
510
  * request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html">Amazon Transcribe endpoints and
511
511
  * quotas</a>.</p>
512
512
  * </li>
513
513
  * <li>
514
- * <p>
514
+ * <p>
515
515
  * <code>TranscriptionJobName</code>: A custom name you create for your
516
516
  * transcription job that is unique within your Amazon Web Services account.</p>
517
517
  * </li>
518
518
  * <li>
519
- * <p>
519
+ * <p>
520
520
  * <code>Media</code> (<code>MediaFileUri</code>): The Amazon S3 location
521
521
  * of your media file.</p>
522
522
  * </li>
523
523
  * <li>
524
- * <p>One of <code>LanguageCode</code>, <code>IdentifyLanguage</code>, or
524
+ * <p>One of <code>LanguageCode</code>, <code>IdentifyLanguage</code>, or
525
525
  * <code>IdentifyMultipleLanguages</code>: If you know the language of your
526
526
  * media file, specify it using the <code>LanguageCode</code> parameter; you can
527
527
  * find all valid language codes in the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported
@@ -538,7 +538,7 @@ export declare class Transcribe extends TranscribeClient {
538
538
  /**
539
539
  * <p>Adds one or more custom tags, each in the form of a key:value pair, to the specified
540
540
  * resource.</p>
541
- * <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
541
+ * <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
542
542
  * resources</a>.</p>
543
543
  */
544
544
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
@@ -546,7 +546,7 @@ export declare class Transcribe extends TranscribeClient {
546
546
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
547
547
  /**
548
548
  * <p>Removes the specified tags from the specified Amazon Transcribe resource.</p>
549
- * <p>If you include <code>UntagResource</code> in your request, you must also include
549
+ * <p>If you include <code>UntagResource</code> in your request, you must also include
550
550
  * <code>ResourceArn</code> and <code>TagKeys</code>.</p>
551
551
  */
552
552
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
@@ -557,7 +557,7 @@ export declare class Transcribe extends TranscribeClient {
557
557
  * <code>UpdateCallAnalyticsCategory</code> operation overwrites all existing rules
558
558
  * contained in the specified category. You cannot append additional rules onto an existing
559
559
  * category.</p>
560
- * <p>To create a new category, see .</p>
560
+ * <p>To create a new category, see .</p>
561
561
  */
562
562
  updateCallAnalyticsCategory(args: UpdateCallAnalyticsCategoryCommandInput, options?: __HttpHandlerOptions): Promise<UpdateCallAnalyticsCategoryCommandOutput>;
563
563
  updateCallAnalyticsCategory(args: UpdateCallAnalyticsCategoryCommandInput, cb: (err: any, data?: UpdateCallAnalyticsCategoryCommandOutput) => void): void;
package/dist-types/TranscribeClient.d.ts CHANGED
@@ -164,21 +164,21 @@ export interface TranscribeClientResolvedConfig extends TranscribeClientResolved
164
164
  /**
165
165
  * <p>Amazon Transcribe offers three main types of batch transcription: <b>Standard</b>, <b>Medical</b>, and
166
166
  * <b>Call Analytics</b>.</p>
167
- * <ul>
167
+ * <ul>
168
168
  * <li>
169
- * <p>
169
+ * <p>
170
170
  * <b>Standard transcriptions</b> are the most common
171
171
  * option. Refer to for details.</p>
172
172
  * </li>
173
173
  * <li>
174
- * <p>
174
+ * <p>
175
175
  * <b>Medical transcriptions</b> are tailored to
176
176
  * medical professionals and incorporate medical terms. A common use case for this
177
177
  * service is transcribing doctor-patient dialogue into after-visit notes. Refer to
178
178
  * for details.</p>
179
179
  * </li>
180
180
  * <li>
181
- * <p>
181
+ * <p>
182
182
  * <b>Call Analytics transcriptions</b> are designed
183
183
  * for use with call center audio on two different channels; if you're looking for
184
184
  * insight into customer service calls, use this option. Refer to for details.</p>
package/dist-types/commands/CreateCallAnalyticsCategoryCommand.d.ts CHANGED
@@ -9,18 +9,18 @@ export interface CreateCallAnalyticsCategoryCommandOutput extends CreateCallAnal
9
9
  }
10
10
  /**
11
11
  * <p>Creates a new Call Analytics category.</p>
12
- * <p>All categories are automatically applied to your Call Analytics transcriptions. Note that in
12
+ * <p>All categories are automatically applied to your Call Analytics transcriptions. Note that in
13
13
  * order to apply categories to your transcriptions, you must create them before submitting your
14
14
  * transcription request, as categories cannot be applied retroactively.</p>
15
- * <p>When creating a new category, you can use the <code>InputType</code> parameter to
15
+ * <p>When creating a new category, you can use the <code>InputType</code> parameter to
16
16
  * label the category as a batch category (<code>POST_CALL</code>) or a streaming category
17
17
  * (<code>REAL_TIME</code>). Batch categories can only be applied to batch transcriptions and
18
18
  * streaming categories can only be applied to streaming transcriptions. If you do not include
19
19
  * <code>InputType</code>, your category is created as a batch category by default.</p>
20
- * <p>Call Analytics categories are composed of rules. For each category, you must create
20
+ * <p>Call Analytics categories are composed of rules. For each category, you must create
21
21
  * between 1 and 20 rules. Rules can include these parameters: , , , and .</p>
22
- * <p>To update an existing category, see .</p>
23
- * <p>To learn more about Call Analytics categories, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html">Creating categories for batch
22
+ * <p>To update an existing category, see .</p>
23
+ * <p>To learn more about Call Analytics categories, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html">Creating categories for batch
24
24
  * transcriptions</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html">Creating categories for
25
25
  * streaming transcriptions</a>.</p>
26
26
  * @example
package/dist-types/commands/CreateLanguageModelCommand.d.ts CHANGED
@@ -9,20 +9,20 @@ export interface CreateLanguageModelCommandOutput extends CreateLanguageModelRes
9
9
  }
10
10
  /**
11
11
  * <p>Creates a new custom language model.</p>
12
- * <p>When creating a new custom language model, you must specify:</p>
13
- * <ul>
12
+ * <p>When creating a new custom language model, you must specify:</p>
13
+ * <ul>
14
14
  * <li>
15
- * <p>If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband
15
+ * <p>If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband
16
16
  * (audio sample rates under 16,000 Hz) base model</p>
17
17
  * </li>
18
18
  * <li>
19
- * <p>The location of your training and tuning files (this must be an Amazon S3 URI)</p>
19
+ * <p>The location of your training and tuning files (this must be an Amazon S3 URI)</p>
20
20
  * </li>
21
21
  * <li>
22
- * <p>The language of your model</p>
22
+ * <p>The language of your model</p>
23
23
  * </li>
24
24
  * <li>
25
- * <p>A unique name for your model</p>
25
+ * <p>A unique name for your model</p>
26
26
  * </li>
27
27
  * </ul>
28
28
  * @example