@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.
- package/dist-cjs/endpoint/ruleset.js +4 -409
- package/dist-cjs/models/models_0.js +2 -0
- package/dist-es/endpoint/ruleset.js +4 -409
- package/dist-es/models/models_0.js +2 -0
- package/dist-types/Transcribe.d.ts +82 -82
- package/dist-types/TranscribeClient.d.ts +4 -4
- package/dist-types/commands/CreateCallAnalyticsCategoryCommand.d.ts +5 -5
- package/dist-types/commands/CreateLanguageModelCommand.d.ts +6 -6
- package/dist-types/commands/CreateMedicalVocabularyCommand.d.ts +3 -3
- package/dist-types/commands/CreateVocabularyCommand.d.ts +3 -3
- package/dist-types/commands/CreateVocabularyFilterCommand.d.ts +3 -3
- package/dist-types/commands/DescribeLanguageModelCommand.d.ts +2 -2
- package/dist-types/commands/GetCallAnalyticsCategoryCommand.d.ts +1 -1
- package/dist-types/commands/GetCallAnalyticsJobCommand.d.ts +4 -4
- package/dist-types/commands/GetMedicalTranscriptionJobCommand.d.ts +2 -2
- package/dist-types/commands/GetMedicalVocabularyCommand.d.ts +2 -2
- package/dist-types/commands/GetTranscriptionJobCommand.d.ts +3 -3
- package/dist-types/commands/GetVocabularyCommand.d.ts +2 -2
- package/dist-types/commands/GetVocabularyFilterCommand.d.ts +1 -1
- package/dist-types/commands/ListCallAnalyticsCategoriesCommand.d.ts +1 -1
- package/dist-types/commands/ListCallAnalyticsJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListLanguageModelsCommand.d.ts +1 -1
- package/dist-types/commands/ListMedicalTranscriptionJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListMedicalVocabulariesCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ListTranscriptionJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListVocabulariesCommand.d.ts +1 -1
- package/dist-types/commands/ListVocabularyFiltersCommand.d.ts +1 -1
- package/dist-types/commands/StartCallAnalyticsJobCommand.d.ts +11 -11
- package/dist-types/commands/StartMedicalTranscriptionJobCommand.d.ts +11 -11
- package/dist-types/commands/StartTranscriptionJobCommand.d.ts +7 -7
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCallAnalyticsCategoryCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +386 -384
- package/dist-types/ts3.4/models/models_0.d.ts +2 -0
- package/package.json +8 -8
|
@@ -2,19 +2,19 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-cl
|
|
|
2
2
|
import { TranscribeServiceException as __BaseException } from "./TranscribeServiceException";
|
|
3
3
|
/**
|
|
4
4
|
* <p>A time range, in milliseconds, between two points in your media file.</p>
|
|
5
|
-
*
|
|
5
|
+
* <p>You can use <code>StartTime</code> and <code>EndTime</code> to search a custom
|
|
6
6
|
* segment. For example, setting <code>StartTime</code> to 10000 and <code>EndTime</code>
|
|
7
7
|
* to 50000 only searches for your specified criteria in the audio contained between the
|
|
8
8
|
* 10,000 millisecond mark and the 50,000 millisecond mark of your media file. You must use
|
|
9
9
|
* <code>StartTime</code> and <code>EndTime</code> as a set; that is, if you include
|
|
10
10
|
* one, you must include both.</p>
|
|
11
|
-
*
|
|
11
|
+
* <p>You can use also <code>First</code> to search from the start of the audio until the
|
|
12
12
|
* time that you specify, or <code>Last</code> to search from the time that you specify
|
|
13
13
|
* until the end of the audio. For example, setting <code>First</code> to 50000 only
|
|
14
14
|
* searches for your specified criteria in the audio contained between the start of the
|
|
15
15
|
* media file to the 50,000 millisecond mark. You can use <code>First</code> and
|
|
16
16
|
* <code>Last</code> independently of each other.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>If you prefer to use percentage instead of milliseconds, see .</p>
|
|
18
18
|
*/
|
|
19
19
|
export interface AbsoluteTimeRange {
|
|
20
20
|
/**
|
|
@@ -118,36 +118,38 @@ export declare enum LanguageCode {
|
|
|
118
118
|
PT_BR = "pt-BR",
|
|
119
119
|
PT_PT = "pt-PT",
|
|
120
120
|
RU_RU = "ru-RU",
|
|
121
|
+
SV_SE = "sv-SE",
|
|
121
122
|
TA_IN = "ta-IN",
|
|
122
123
|
TE_IN = "te-IN",
|
|
123
124
|
TH_TH = "th-TH",
|
|
124
125
|
TR_TR = "tr-TR",
|
|
126
|
+
VI_VN = "vi-VN",
|
|
125
127
|
ZH_CN = "zh-CN",
|
|
126
128
|
ZH_TW = "zh-TW"
|
|
127
129
|
}
|
|
128
130
|
/**
|
|
129
131
|
* <p>Describes the Amazon S3 location of the media file you want to use in your
|
|
130
132
|
* request.</p>
|
|
131
|
-
*
|
|
133
|
+
* <p>For information on supported media formats, refer to the <a href="https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat">MediaFormat</a> parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
|
|
132
134
|
* in the Amazon S3 Developer Guide.</p>
|
|
133
135
|
*/
|
|
134
136
|
export interface Media {
|
|
135
137
|
/**
|
|
136
138
|
* <p>The Amazon S3 location of the media file you want to transcribe. For
|
|
137
139
|
* example:</p>
|
|
138
|
-
*
|
|
140
|
+
* <ul>
|
|
139
141
|
* <li>
|
|
140
|
-
*
|
|
142
|
+
* <p>
|
|
141
143
|
* <code>s3://DOC-EXAMPLE-BUCKET/my-media-file.flac</code>
|
|
142
144
|
* </p>
|
|
143
145
|
* </li>
|
|
144
146
|
* <li>
|
|
145
|
-
*
|
|
147
|
+
* <p>
|
|
146
148
|
* <code>s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac</code>
|
|
147
149
|
* </p>
|
|
148
150
|
* </li>
|
|
149
151
|
* </ul>
|
|
150
|
-
*
|
|
152
|
+
* <p>Note that the Amazon S3 bucket that contains your input media must be located
|
|
151
153
|
* in the same Amazon Web Services Region where you're making your transcription
|
|
152
154
|
* request.</p>
|
|
153
155
|
*/
|
|
@@ -155,27 +157,27 @@ export interface Media {
|
|
|
155
157
|
/**
|
|
156
158
|
* <p>The Amazon S3 location of the media file you want to redact. For
|
|
157
159
|
* example:</p>
|
|
158
|
-
*
|
|
160
|
+
* <ul>
|
|
159
161
|
* <li>
|
|
160
|
-
*
|
|
162
|
+
* <p>
|
|
161
163
|
* <code>s3://DOC-EXAMPLE-BUCKET/my-media-file.flac</code>
|
|
162
164
|
* </p>
|
|
163
165
|
* </li>
|
|
164
166
|
* <li>
|
|
165
|
-
*
|
|
167
|
+
* <p>
|
|
166
168
|
* <code>s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac</code>
|
|
167
169
|
* </p>
|
|
168
170
|
* </li>
|
|
169
171
|
* </ul>
|
|
170
|
-
*
|
|
172
|
+
* <p>Note that the Amazon S3 bucket that contains your input media must be located
|
|
171
173
|
* in the same Amazon Web Services Region where you're making your transcription
|
|
172
174
|
* request.</p>
|
|
173
|
-
*
|
|
175
|
+
* <important>
|
|
174
176
|
* <p>
|
|
175
177
|
* <code>RedactedMediaFileUri</code> produces a redacted audio file in addition to a
|
|
176
178
|
* redacted transcript. It is only supported for Call Analytics
|
|
177
179
|
* (<code>StartCallAnalyticsJob</code>) transcription requests.</p>
|
|
178
|
-
*
|
|
180
|
+
* </important>
|
|
179
181
|
*/
|
|
180
182
|
RedactedMediaFileUri?: string;
|
|
181
183
|
}
|
|
@@ -225,9 +227,9 @@ export interface ContentRedaction {
|
|
|
225
227
|
/**
|
|
226
228
|
* <p>Specify if you want only a redacted transcript, or if you want a redacted and an
|
|
227
229
|
* unredacted transcript.</p>
|
|
228
|
-
*
|
|
230
|
+
* <p>When you choose <code>redacted</code>
|
|
229
231
|
* Amazon Transcribe creates only a redacted transcript.</p>
|
|
230
|
-
*
|
|
232
|
+
* <p>When you choose <code>redacted_and_unredacted</code>
|
|
231
233
|
* Amazon Transcribe creates a redacted and an unredacted transcript (as two separate
|
|
232
234
|
* files).</p>
|
|
233
235
|
*/
|
|
@@ -247,13 +249,13 @@ export interface ContentRedaction {
|
|
|
247
249
|
* <code>VocabularyFilterName</code>). Note that multi-language identification
|
|
248
250
|
* (<code>IdentifyMultipleLanguages</code>) doesn't support custom language
|
|
249
251
|
* models.</p>
|
|
250
|
-
*
|
|
252
|
+
* <p>
|
|
251
253
|
* <code>LanguageIdSettings</code> supports two to five language codes. Each language
|
|
252
254
|
* code you include can have an associated custom language model, custom vocabulary, and
|
|
253
255
|
* custom vocabulary filter. The language codes that you specify must match the languages
|
|
254
256
|
* of the associated custom language models, custom vocabularies, and custom vocabulary
|
|
255
257
|
* filters.</p>
|
|
256
|
-
*
|
|
258
|
+
* <p>It's recommended that you include <code>LanguageOptions</code> when using
|
|
257
259
|
* <code>LanguageIdSettings</code> to ensure that the correct language dialect is
|
|
258
260
|
* identified. For example, if you specify a custom vocabulary that is in
|
|
259
261
|
* <code>en-US</code> but Amazon Transcribe determines that the language spoken in
|
|
@@ -261,7 +263,7 @@ export interface ContentRedaction {
|
|
|
261
263
|
* applied to your transcription. If you include <code>LanguageOptions</code> and include
|
|
262
264
|
* <code>en-US</code> as the only English language dialect, your custom vocabulary
|
|
263
265
|
* <i>is</i> applied to your transcription.</p>
|
|
264
|
-
*
|
|
266
|
+
* <p>If you want to include a custom language model with your request but <b>do not</b> want to use automatic language identification, use
|
|
265
267
|
* instead the <code></code> parameter with the
|
|
266
268
|
* <code>LanguageModelName</code> sub-parameter. If you want to include a custom
|
|
267
269
|
* vocabulary or a custom vocabulary filter (or both) with your request but <b>do not</b> want to use automatic language identification, use
|
|
@@ -273,7 +275,7 @@ export interface LanguageIdSettings {
|
|
|
273
275
|
/**
|
|
274
276
|
* <p>The name of the custom vocabulary you want to use when processing your transcription
|
|
275
277
|
* job. Custom vocabulary names are case sensitive.</p>
|
|
276
|
-
*
|
|
278
|
+
* <p>The language of the specified custom vocabulary must match the language code that you
|
|
277
279
|
* specify in your transcription request. If the languages don't match, the custom
|
|
278
280
|
* vocabulary isn't applied. There are no errors or warnings associated with a language
|
|
279
281
|
* mismatch.</p>
|
|
@@ -282,18 +284,18 @@ export interface LanguageIdSettings {
|
|
|
282
284
|
/**
|
|
283
285
|
* <p>The name of the custom vocabulary filter you want to use when processing your
|
|
284
286
|
* transcription job. Custom vocabulary filter names are case sensitive.</p>
|
|
285
|
-
*
|
|
287
|
+
* <p>The language of the specified custom vocabulary filter must match the language code
|
|
286
288
|
* that you specify in your transcription request. If the languages don't match, the custom
|
|
287
289
|
* vocabulary filter isn't applied. There are no errors or warnings associated with a
|
|
288
290
|
* language mismatch.</p>
|
|
289
|
-
*
|
|
291
|
+
* <p>Note that if you include <code>VocabularyFilterName</code> in your request, you must
|
|
290
292
|
* also include <code>VocabularyFilterMethod</code>.</p>
|
|
291
293
|
*/
|
|
292
294
|
VocabularyFilterName?: string;
|
|
293
295
|
/**
|
|
294
296
|
* <p>The name of the custom language model you want to use when processing your
|
|
295
297
|
* transcription job. Note that custom language model names are case sensitive.</p>
|
|
296
|
-
*
|
|
298
|
+
* <p>The language of the specified custom language model must match the language code that
|
|
297
299
|
* you specify in your transcription request. If the languages don't match, the custom
|
|
298
300
|
* language model isn't applied. There are no errors or warnings associated with a language
|
|
299
301
|
* mismatch.</p>
|
|
@@ -319,21 +321,21 @@ export interface CallAnalyticsJobSettings {
|
|
|
319
321
|
/**
|
|
320
322
|
* <p>The name of the custom vocabulary filter you want to include in your Call Analytics
|
|
321
323
|
* transcription request. Custom vocabulary filter names are case sensitive.</p>
|
|
322
|
-
*
|
|
324
|
+
* <p>Note that if you include <code>VocabularyFilterName</code> in your request, you must
|
|
323
325
|
* also include <code>VocabularyFilterMethod</code>.</p>
|
|
324
326
|
*/
|
|
325
327
|
VocabularyFilterName?: string;
|
|
326
328
|
/**
|
|
327
329
|
* <p>Specify how you want your custom vocabulary filter applied to your transcript.</p>
|
|
328
|
-
*
|
|
329
|
-
*
|
|
330
|
-
*
|
|
330
|
+
* <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
|
|
331
|
+
* <p>To delete words, choose <code>remove</code>.</p>
|
|
332
|
+
* <p>To flag words without changing them, choose <code>tag</code>.</p>
|
|
331
333
|
*/
|
|
332
334
|
VocabularyFilterMethod?: VocabularyFilterMethod | string;
|
|
333
335
|
/**
|
|
334
336
|
* <p>The name of the custom language model you want to use when processing your Call
|
|
335
337
|
* Analytics job. Note that custom language model names are case sensitive.</p>
|
|
336
|
-
*
|
|
338
|
+
* <p>The language of the specified custom language model must match the language code that
|
|
337
339
|
* you specify in your transcription request. If the languages don't match, the custom
|
|
338
340
|
* language model isn't applied. There are no errors or warnings associated with a language
|
|
339
341
|
* mismatch.</p>
|
|
@@ -350,10 +352,10 @@ export interface CallAnalyticsJobSettings {
|
|
|
350
352
|
* <p>You can specify two or more language codes that represent the languages you think may
|
|
351
353
|
* be present in your media. Including more than five is not recommended. If you're unsure
|
|
352
354
|
* what languages are present, do not include this parameter.</p>
|
|
353
|
-
*
|
|
354
|
-
*
|
|
355
|
+
* <p>Including language options can improve the accuracy of language identification.</p>
|
|
356
|
+
* <p>For a list of languages supported with Call Analytics, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported
|
|
355
357
|
* languages</a> table.</p>
|
|
356
|
-
*
|
|
358
|
+
* <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media file
|
|
357
359
|
* must be encoded at a sample rate of 16,000 Hz or higher.</p>
|
|
358
360
|
*/
|
|
359
361
|
LanguageOptions?: (LanguageCode | string)[];
|
|
@@ -363,13 +365,13 @@ export interface CallAnalyticsJobSettings {
|
|
|
363
365
|
* <code>LanguageIdSettings</code> with the relevant sub-parameters
|
|
364
366
|
* (<code>VocabularyName</code>, <code>LanguageModelName</code>, and
|
|
365
367
|
* <code>VocabularyFilterName</code>).</p>
|
|
366
|
-
*
|
|
368
|
+
* <p>
|
|
367
369
|
* <code>LanguageIdSettings</code> supports two to five language codes. Each language
|
|
368
370
|
* code you include can have an associated custom language model, custom vocabulary, and
|
|
369
371
|
* custom vocabulary filter. The language codes that you specify must match the languages
|
|
370
372
|
* of the associated custom language models, custom vocabularies, and custom vocabulary
|
|
371
373
|
* filters.</p>
|
|
372
|
-
*
|
|
374
|
+
* <p>It's recommended that you include <code>LanguageOptions</code> when using
|
|
373
375
|
* <code>LanguageIdSettings</code> to ensure that the correct language dialect is
|
|
374
376
|
* identified. For example, if you specify a custom vocabulary that is in
|
|
375
377
|
* <code>en-US</code> but Amazon Transcribe determines that the language spoken in
|
|
@@ -377,12 +379,12 @@ export interface CallAnalyticsJobSettings {
|
|
|
377
379
|
* applied to your transcription. If you include <code>LanguageOptions</code> and include
|
|
378
380
|
* <code>en-US</code> as the only English language dialect, your custom vocabulary
|
|
379
381
|
* <i>is</i> applied to your transcription.</p>
|
|
380
|
-
*
|
|
382
|
+
* <p>If you want to include a custom language model, custom vocabulary, or custom
|
|
381
383
|
* vocabulary filter with your request but <b>do not</b> want to
|
|
382
384
|
* use automatic language identification, use instead the <code></code> parameter with the
|
|
383
385
|
* <code>LanguageModelName</code>, <code>VocabularyName</code>, or
|
|
384
386
|
* <code>VocabularyFilterName</code> sub-parameters.</p>
|
|
385
|
-
*
|
|
387
|
+
* <p>For a list of languages supported with Call Analytics, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages and
|
|
386
388
|
* language-specific features</a>.</p>
|
|
387
389
|
*/
|
|
388
390
|
LanguageIdSettings?: Record<string, LanguageIdSettings>;
|
|
@@ -395,51 +397,51 @@ export interface Transcript {
|
|
|
395
397
|
/**
|
|
396
398
|
* <p>The Amazon S3 location of your transcript. You can use this URI to access or
|
|
397
399
|
* download your transcript.</p>
|
|
398
|
-
*
|
|
400
|
+
* <p>If you included <code>OutputBucketName</code> in your transcription job request, this
|
|
399
401
|
* is the URI of that bucket. If you also included <code>OutputKey</code> in your request,
|
|
400
402
|
* your output is located in the path you specified in your request.</p>
|
|
401
|
-
*
|
|
403
|
+
* <p>If you didn't include <code>OutputBucketName</code> in your transcription job request,
|
|
402
404
|
* your transcript is stored in a service-managed bucket, and
|
|
403
405
|
* <code>TranscriptFileUri</code> provides you with a temporary URI you can use for
|
|
404
406
|
* secure access to your transcript.</p>
|
|
405
|
-
*
|
|
407
|
+
* <note>
|
|
406
408
|
* <p>Temporary URIs for service-managed Amazon S3 buckets are only valid for 15
|
|
407
409
|
* minutes. If you get an <code>AccesDenied</code> error, you can get a new temporary
|
|
408
410
|
* URI by running a <code>GetTranscriptionJob</code> or
|
|
409
411
|
* <code>ListTranscriptionJob</code> request.</p>
|
|
410
|
-
*
|
|
412
|
+
* </note>
|
|
411
413
|
*/
|
|
412
414
|
TranscriptFileUri?: string;
|
|
413
415
|
/**
|
|
414
416
|
* <p>The Amazon S3 location of your redacted transcript. You can use this URI to
|
|
415
417
|
* access or download your transcript.</p>
|
|
416
|
-
*
|
|
418
|
+
* <p>If you included <code>OutputBucketName</code> in your transcription job request, this
|
|
417
419
|
* is the URI of that bucket. If you also included <code>OutputKey</code> in your request,
|
|
418
420
|
* your output is located in the path you specified in your request.</p>
|
|
419
|
-
*
|
|
421
|
+
* <p>If you didn't include <code>OutputBucketName</code> in your transcription job request,
|
|
420
422
|
* your transcript is stored in a service-managed bucket, and
|
|
421
423
|
* <code>RedactedTranscriptFileUri</code> provides you with a temporary URI you can use
|
|
422
424
|
* for secure access to your transcript.</p>
|
|
423
|
-
*
|
|
425
|
+
* <note>
|
|
424
426
|
* <p>Temporary URIs for service-managed Amazon S3 buckets are only valid for 15
|
|
425
427
|
* minutes. If you get an <code>AccesDenied</code> error, you can get a new temporary
|
|
426
428
|
* URI by running a <code>GetTranscriptionJob</code> or
|
|
427
429
|
* <code>ListTranscriptionJob</code> request.</p>
|
|
428
|
-
*
|
|
430
|
+
* </note>
|
|
429
431
|
*/
|
|
430
432
|
RedactedTranscriptFileUri?: string;
|
|
431
433
|
}
|
|
432
434
|
/**
|
|
433
435
|
* <p>Provides detailed information about a Call Analytics job.</p>
|
|
434
|
-
*
|
|
436
|
+
* <p>To view the job's status, refer to <code>CallAnalyticsJobStatus</code>. If the status
|
|
435
437
|
* is <code>COMPLETED</code>, the job is finished. You can find your completed transcript
|
|
436
438
|
* at the URI specified in <code>TranscriptFileUri</code>. If the status is
|
|
437
439
|
* <code>FAILED</code>, <code>FailureReason</code> provides details on why your
|
|
438
440
|
* transcription job failed.</p>
|
|
439
|
-
*
|
|
441
|
+
* <p>If you enabled personally identifiable information (PII) redaction, the redacted
|
|
440
442
|
* transcript appears at the location specified in
|
|
441
443
|
* <code>RedactedTranscriptFileUri</code>.</p>
|
|
442
|
-
*
|
|
444
|
+
* <p>If you chose to redact the audio in your media file, you can find your redacted media
|
|
443
445
|
* file at the location specified in the <code>RedactedMediaFileUri</code> field of your
|
|
444
446
|
* response.</p>
|
|
445
447
|
*/
|
|
@@ -451,7 +453,7 @@ export interface CallAnalyticsJob {
|
|
|
451
453
|
CallAnalyticsJobName?: string;
|
|
452
454
|
/**
|
|
453
455
|
* <p>Provides the status of the specified Call Analytics job.</p>
|
|
454
|
-
*
|
|
456
|
+
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
455
457
|
* results at the location specified in <code>TranscriptFileUri</code> (or
|
|
456
458
|
* <code>RedactedTranscriptFileUri</code>, if you requested transcript redaction). If
|
|
457
459
|
* the status is <code>FAILED</code>, <code>FailureReason</code> provides details on why
|
|
@@ -462,7 +464,7 @@ export interface CallAnalyticsJob {
|
|
|
462
464
|
* <p>The language code used to create your Call Analytics job. For a list of supported
|
|
463
465
|
* languages and their associated language codes, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a>
|
|
464
466
|
* table.</p>
|
|
465
|
-
*
|
|
467
|
+
* <p>If you don't know the language spoken in your media file, you can omit this field and
|
|
466
468
|
* let Amazon Transcribe automatically identify the language of your media. To improve the
|
|
467
469
|
* accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.</p>
|
|
468
470
|
*/
|
|
@@ -487,21 +489,21 @@ export interface CallAnalyticsJob {
|
|
|
487
489
|
Transcript?: Transcript;
|
|
488
490
|
/**
|
|
489
491
|
* <p>The date and time the specified Call Analytics job began processing.</p>
|
|
490
|
-
*
|
|
492
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
491
493
|
* example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a transcription job
|
|
492
494
|
* that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
|
|
493
495
|
*/
|
|
494
496
|
StartTime?: Date;
|
|
495
497
|
/**
|
|
496
498
|
* <p>The date and time the specified Call Analytics job request was made.</p>
|
|
497
|
-
*
|
|
499
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
498
500
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a transcription job
|
|
499
501
|
* that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
|
|
500
502
|
*/
|
|
501
503
|
CreationTime?: Date;
|
|
502
504
|
/**
|
|
503
505
|
* <p>The date and time the specified Call Analytics job finished processing.</p>
|
|
504
|
-
*
|
|
506
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
505
507
|
* example, <code>2022-05-04T12:33:13.922000-07:00</code> represents a transcription job
|
|
506
508
|
* that started processing at 12:33 PM UTC-7 on May 4, 2022.</p>
|
|
507
509
|
*/
|
|
@@ -510,48 +512,48 @@ export interface CallAnalyticsJob {
|
|
|
510
512
|
* <p>If <code>CallAnalyticsJobStatus</code> is <code>FAILED</code>,
|
|
511
513
|
* <code>FailureReason</code> contains information about why the Call Analytics job
|
|
512
514
|
* request failed.</p>
|
|
513
|
-
*
|
|
514
|
-
*
|
|
515
|
+
* <p>The <code>FailureReason</code> field contains one of the following values:</p>
|
|
516
|
+
* <ul>
|
|
515
517
|
* <li>
|
|
516
|
-
*
|
|
518
|
+
* <p>
|
|
517
519
|
* <code>Unsupported media format</code>.</p>
|
|
518
|
-
*
|
|
520
|
+
* <p>The media format specified in <code>MediaFormat</code> isn't valid. Refer to
|
|
519
521
|
* <b>MediaFormat</b> for a list of supported
|
|
520
522
|
* formats.</p>
|
|
521
523
|
* </li>
|
|
522
524
|
* <li>
|
|
523
|
-
*
|
|
525
|
+
* <p>
|
|
524
526
|
* <code>The media format provided does not match the detected media
|
|
525
527
|
* format</code>.</p>
|
|
526
|
-
*
|
|
528
|
+
* <p>The media format specified in <code>MediaFormat</code> doesn't match the
|
|
527
529
|
* format of the input file. Check the media format of your media file and correct
|
|
528
530
|
* the specified value.</p>
|
|
529
531
|
* </li>
|
|
530
532
|
* <li>
|
|
531
|
-
*
|
|
533
|
+
* <p>
|
|
532
534
|
* <code>Invalid sample rate for audio file</code>.</p>
|
|
533
|
-
*
|
|
535
|
+
* <p>The sample rate specified in <code>MediaSampleRateHertz</code> isn't valid.
|
|
534
536
|
* The sample rate must be between 8,000 and 48,000 hertz.</p>
|
|
535
537
|
* </li>
|
|
536
538
|
* <li>
|
|
537
|
-
*
|
|
539
|
+
* <p>
|
|
538
540
|
* <code>The sample rate provided does not match the detected sample
|
|
539
541
|
* rate</code>.</p>
|
|
540
|
-
*
|
|
542
|
+
* <p>The sample rate specified in <code>MediaSampleRateHertz</code> doesn't match
|
|
541
543
|
* the sample rate detected in your input media file. Check the sample rate of your
|
|
542
544
|
* media file and correct the specified value.</p>
|
|
543
545
|
* </li>
|
|
544
546
|
* <li>
|
|
545
|
-
*
|
|
547
|
+
* <p>
|
|
546
548
|
* <code>Invalid file size: file size too large</code>.</p>
|
|
547
|
-
*
|
|
549
|
+
* <p>The size of your media file is larger than what Amazon Transcribe can
|
|
548
550
|
* process. For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits">Guidelines and
|
|
549
551
|
* quotas</a>.</p>
|
|
550
552
|
* </li>
|
|
551
553
|
* <li>
|
|
552
|
-
*
|
|
554
|
+
* <p>
|
|
553
555
|
* <code>Invalid number of channels: number of channels too large</code>.</p>
|
|
554
|
-
*
|
|
556
|
+
* <p>Your audio contains more channels than Amazon Transcribe is able to process.
|
|
555
557
|
* For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits">Guidelines and
|
|
556
558
|
* quotas</a>.</p>
|
|
557
559
|
* </li>
|
|
@@ -565,7 +567,7 @@ export interface CallAnalyticsJob {
|
|
|
565
567
|
/**
|
|
566
568
|
* <p>The confidence score associated with the language identified in your media
|
|
567
569
|
* file.</p>
|
|
568
|
-
*
|
|
570
|
+
* <p>Confidence scores are values between 0 and 1; a larger value indicates a higher
|
|
569
571
|
* probability that the identified language correctly matches the language spoken in your
|
|
570
572
|
* media.</p>
|
|
571
573
|
*/
|
|
@@ -592,21 +594,21 @@ export interface CallAnalyticsJobSummary {
|
|
|
592
594
|
CallAnalyticsJobName?: string;
|
|
593
595
|
/**
|
|
594
596
|
* <p>The date and time the specified Call Analytics job request was made.</p>
|
|
595
|
-
*
|
|
597
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
596
598
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a transcription job
|
|
597
599
|
* that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
|
|
598
600
|
*/
|
|
599
601
|
CreationTime?: Date;
|
|
600
602
|
/**
|
|
601
603
|
* <p>The date and time your Call Analytics job began processing.</p>
|
|
602
|
-
*
|
|
604
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
603
605
|
* example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a transcription job
|
|
604
606
|
* that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
|
|
605
607
|
*/
|
|
606
608
|
StartTime?: Date;
|
|
607
609
|
/**
|
|
608
610
|
* <p>The date and time the specified Call Analytics job finished processing.</p>
|
|
609
|
-
*
|
|
611
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
610
612
|
* example, <code>2022-05-04T12:33:13.922000-07:00</code> represents a transcription job
|
|
611
613
|
* that started processing at 12:33 PM UTC-7 on May 4, 2022.</p>
|
|
612
614
|
*/
|
|
@@ -617,7 +619,7 @@ export interface CallAnalyticsJobSummary {
|
|
|
617
619
|
LanguageCode?: LanguageCode | string;
|
|
618
620
|
/**
|
|
619
621
|
* <p>Provides the status of your Call Analytics job.</p>
|
|
620
|
-
*
|
|
622
|
+
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
621
623
|
* results at the location specified in <code>TranscriptFileUri</code> (or
|
|
622
624
|
* <code>RedactedTranscriptFileUri</code>, if you requested transcript redaction). If
|
|
623
625
|
* the status is <code>FAILED</code>, <code>FailureReason</code> provides details on why
|
|
@@ -637,17 +639,17 @@ export declare enum InputType {
|
|
|
637
639
|
}
|
|
638
640
|
/**
|
|
639
641
|
* <p>A time range, in percentage, between two points in your media file.</p>
|
|
640
|
-
*
|
|
642
|
+
* <p>You can use <code>StartPercentage</code> and <code>EndPercentage</code> to search a
|
|
641
643
|
* custom segment. For example, setting <code>StartPercentage</code> to 10 and
|
|
642
644
|
* <code>EndPercentage</code> to 50 only searches for your specified criteria in the
|
|
643
645
|
* audio contained between the 10 percent mark and the 50 percent mark of your media
|
|
644
646
|
* file.</p>
|
|
645
|
-
*
|
|
647
|
+
* <p>You can use also <code>First</code> to search from the start of the media file until
|
|
646
648
|
* the time that you specify. Or use <code>Last</code> to search from the time that you
|
|
647
649
|
* specify until the end of the media file. For example, setting <code>First</code> to 10
|
|
648
650
|
* only searches for your specified criteria in the audio contained in the first 10 percent
|
|
649
651
|
* of the media file.</p>
|
|
650
|
-
*
|
|
652
|
+
* <p>If you prefer to use milliseconds instead of percentage, see .</p>
|
|
651
653
|
*/
|
|
652
654
|
export interface RelativeTimeRange {
|
|
653
655
|
/**
|
|
@@ -676,22 +678,22 @@ export interface RelativeTimeRange {
|
|
|
676
678
|
/**
|
|
677
679
|
* <p>Flag the presence or absence of interruptions in your Call Analytics transcription
|
|
678
680
|
* output.</p>
|
|
679
|
-
*
|
|
680
|
-
*
|
|
681
|
+
* <p>Rules using <code>InterruptionFilter</code> are designed to match:</p>
|
|
682
|
+
* <ul>
|
|
681
683
|
* <li>
|
|
682
|
-
*
|
|
684
|
+
* <p>Instances where an agent interrupts a customer</p>
|
|
683
685
|
* </li>
|
|
684
686
|
* <li>
|
|
685
|
-
*
|
|
687
|
+
* <p>Instances where a customer interrupts an agent</p>
|
|
686
688
|
* </li>
|
|
687
689
|
* <li>
|
|
688
|
-
*
|
|
690
|
+
* <p>Either participant interrupting the other</p>
|
|
689
691
|
* </li>
|
|
690
692
|
* <li>
|
|
691
|
-
*
|
|
693
|
+
* <p>A lack of interruptions</p>
|
|
692
694
|
* </li>
|
|
693
695
|
* </ul>
|
|
694
|
-
*
|
|
696
|
+
* <p>See <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch">Rule criteria for batch
|
|
695
697
|
* categories</a> for usage examples.</p>
|
|
696
698
|
*/
|
|
697
699
|
export interface InterruptionFilter {
|
|
@@ -724,16 +726,16 @@ export interface InterruptionFilter {
|
|
|
724
726
|
/**
|
|
725
727
|
* <p>Flag the presence or absence of periods of silence in your Call Analytics
|
|
726
728
|
* transcription output.</p>
|
|
727
|
-
*
|
|
728
|
-
*
|
|
729
|
+
* <p>Rules using <code>NonTalkTimeFilter</code> are designed to match:</p>
|
|
730
|
+
* <ul>
|
|
729
731
|
* <li>
|
|
730
|
-
*
|
|
732
|
+
* <p>The presence of silence at specified periods throughout the call</p>
|
|
731
733
|
* </li>
|
|
732
734
|
* <li>
|
|
733
|
-
*
|
|
735
|
+
* <p>The presence of speech at specified periods throughout the call</p>
|
|
734
736
|
* </li>
|
|
735
737
|
* </ul>
|
|
736
|
-
*
|
|
738
|
+
* <p>See <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch">Rule criteria for batch
|
|
737
739
|
* categories</a> for usage examples.</p>
|
|
738
740
|
*/
|
|
739
741
|
export interface NonTalkTimeFilter {
|
|
@@ -767,26 +769,26 @@ export declare enum SentimentValue {
|
|
|
767
769
|
/**
|
|
768
770
|
* <p>Flag the presence or absence of specific sentiments detected in your Call Analytics
|
|
769
771
|
* transcription output.</p>
|
|
770
|
-
*
|
|
771
|
-
*
|
|
772
|
+
* <p>Rules using <code>SentimentFilter</code> are designed to match:</p>
|
|
773
|
+
* <ul>
|
|
772
774
|
* <li>
|
|
773
|
-
*
|
|
775
|
+
* <p>The presence or absence of a positive sentiment felt by the customer, agent,
|
|
774
776
|
* or both at specified points in the call</p>
|
|
775
777
|
* </li>
|
|
776
778
|
* <li>
|
|
777
|
-
*
|
|
779
|
+
* <p>The presence or absence of a negative sentiment felt by the customer, agent,
|
|
778
780
|
* or both at specified points in the call</p>
|
|
779
781
|
* </li>
|
|
780
782
|
* <li>
|
|
781
|
-
*
|
|
783
|
+
* <p>The presence or absence of a neutral sentiment felt by the customer, agent, or
|
|
782
784
|
* both at specified points in the call</p>
|
|
783
785
|
* </li>
|
|
784
786
|
* <li>
|
|
785
|
-
*
|
|
787
|
+
* <p>The presence or absence of a mixed sentiment felt by the customer, the agent,
|
|
786
788
|
* or both at specified points in the call</p>
|
|
787
789
|
* </li>
|
|
788
790
|
* </ul>
|
|
789
|
-
*
|
|
791
|
+
* <p>See <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch">Rule criteria for batch
|
|
790
792
|
* categories</a> for usage examples.</p>
|
|
791
793
|
*/
|
|
792
794
|
export interface SentimentFilter {
|
|
@@ -822,20 +824,20 @@ export declare enum TranscriptFilterType {
|
|
|
822
824
|
/**
|
|
823
825
|
* <p>Flag the presence or absence of specific words or phrases detected in your Call
|
|
824
826
|
* Analytics transcription output.</p>
|
|
825
|
-
*
|
|
826
|
-
*
|
|
827
|
+
* <p>Rules using <code>TranscriptFilter</code> are designed to match:</p>
|
|
828
|
+
* <ul>
|
|
827
829
|
* <li>
|
|
828
|
-
*
|
|
830
|
+
* <p>Custom words or phrases spoken by the agent, the customer, or both</p>
|
|
829
831
|
* </li>
|
|
830
832
|
* <li>
|
|
831
|
-
*
|
|
833
|
+
* <p>Custom words or phrases <b>not</b> spoken by the
|
|
832
834
|
* agent, the customer, or either</p>
|
|
833
835
|
* </li>
|
|
834
836
|
* <li>
|
|
835
|
-
*
|
|
837
|
+
* <p>Custom words or phrases that occur at a specific time frame</p>
|
|
836
838
|
* </li>
|
|
837
839
|
* </ul>
|
|
838
|
-
*
|
|
840
|
+
* <p>See <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch">Rule criteria for batch
|
|
839
841
|
* categories</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html#tca-rules-stream">Rule criteria for
|
|
840
842
|
* streaming categories</a> for usage examples.</p>
|
|
841
843
|
*/
|
|
@@ -844,7 +846,7 @@ export interface TranscriptFilter {
|
|
|
844
846
|
* <p>Flag the presence or absence of an exact match to the phrases that you specify. For
|
|
845
847
|
* example, if you specify the phrase "speak to a manager" as your <code>Targets</code>
|
|
846
848
|
* value, only that exact phrase is flagged.</p>
|
|
847
|
-
*
|
|
849
|
+
* <p>Note that semantic matching is not supported. For example, if your customer says
|
|
848
850
|
* "speak to <i>the</i> manager", instead of "speak to <i>a</i>
|
|
849
851
|
* manager", your content is not flagged.</p>
|
|
850
852
|
*/
|
|
@@ -878,11 +880,11 @@ export interface TranscriptFilter {
|
|
|
878
880
|
/**
|
|
879
881
|
* <p>A rule is a set of criteria that you can specify to flag an attribute in your Call
|
|
880
882
|
* Analytics output. Rules define a Call Analytics category.</p>
|
|
881
|
-
*
|
|
882
|
-
*
|
|
883
|
+
* <p>Rules can include these parameters: , , , and .</p>
|
|
884
|
+
* <p>To learn more about Call Analytics rules and categories, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html">Creating categories for batch
|
|
883
885
|
* transcriptions</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html">Creating categories for
|
|
884
886
|
* streaming transcriptions</a>.</p>
|
|
885
|
-
*
|
|
887
|
+
* <p>To learn more about Call Analytics, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html">Analyzing call center audio with Call
|
|
886
888
|
* Analytics</a>.</p>
|
|
887
889
|
*/
|
|
888
890
|
export declare type Rule = Rule.InterruptionFilterMember | Rule.NonTalkTimeFilterMember | Rule.SentimentFilterMember | Rule.TranscriptFilterMember | Rule.$UnknownMember;
|
|
@@ -967,14 +969,14 @@ export interface CategoryProperties {
|
|
|
967
969
|
Rules?: Rule[];
|
|
968
970
|
/**
|
|
969
971
|
* <p>The date and time the specified Call Analytics category was created.</p>
|
|
970
|
-
*
|
|
972
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
971
973
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
972
974
|
* 4, 2022.</p>
|
|
973
975
|
*/
|
|
974
976
|
CreateTime?: Date;
|
|
975
977
|
/**
|
|
976
978
|
* <p>The date and time the specified Call Analytics category was last updated.</p>
|
|
977
|
-
*
|
|
979
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
978
980
|
* example, <code>2022-05-05T12:45:32.691000-07:00</code> represents 12:45 PM UTC-7 on May
|
|
979
981
|
* 5, 2022.</p>
|
|
980
982
|
*/
|
|
@@ -1014,7 +1016,7 @@ export interface CreateCallAnalyticsCategoryRequest {
|
|
|
1014
1016
|
* detailed naming system that will make sense to you in the future. For example, it's
|
|
1015
1017
|
* better to use <code>sentiment-positive-last30seconds</code> for a category over a
|
|
1016
1018
|
* generic name like <code>test-category</code>.</p>
|
|
1017
|
-
*
|
|
1019
|
+
* <p>Category names are case sensitive.</p>
|
|
1018
1020
|
*/
|
|
1019
1021
|
CategoryName: string | undefined;
|
|
1020
1022
|
/**
|
|
@@ -1027,13 +1029,13 @@ export interface CreateCallAnalyticsCategoryRequest {
|
|
|
1027
1029
|
/**
|
|
1028
1030
|
* <p>Choose whether you want to create a streaming or a batch category for your Call Analytics
|
|
1029
1031
|
* transcription.</p>
|
|
1030
|
-
*
|
|
1032
|
+
* <p>Specifying <code>POST_CALL</code> assigns your category to batch transcriptions;
|
|
1031
1033
|
* categories with this input type cannot be applied to streaming (real-time)
|
|
1032
1034
|
* transcriptions.</p>
|
|
1033
|
-
*
|
|
1035
|
+
* <p>Specifying <code>REAL_TIME</code> assigns your category to streaming transcriptions;
|
|
1034
1036
|
* categories with this input type cannot be applied to batch (post-call)
|
|
1035
1037
|
* transcriptions.</p>
|
|
1036
|
-
*
|
|
1038
|
+
* <p>If you do not include <code>InputType</code>, your category is created as a batch
|
|
1037
1039
|
* category by default.</p>
|
|
1038
1040
|
*/
|
|
1039
1041
|
InputType?: InputType | string;
|
|
@@ -1074,7 +1076,7 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
1074
1076
|
/**
|
|
1075
1077
|
* <p>Contains the Amazon S3 location of the training data you want to use to create
|
|
1076
1078
|
* a new custom language model, and permissions to access this location.</p>
|
|
1077
|
-
*
|
|
1079
|
+
* <p>When using <code>InputDataConfig</code>, you must include these sub-parameters:
|
|
1078
1080
|
* <code>S3Uri</code> and <code>DataAccessRoleArn</code>. You can optionally include
|
|
1079
1081
|
* <code>TuningDataS3Uri</code>.</p>
|
|
1080
1082
|
*/
|
|
@@ -1082,7 +1084,7 @@ export interface InputDataConfig {
|
|
|
1082
1084
|
/**
|
|
1083
1085
|
* <p>The Amazon S3 location (URI) of the text files you want to use to train your
|
|
1084
1086
|
* custom language model.</p>
|
|
1085
|
-
*
|
|
1087
|
+
* <p>Here's an example URI path:
|
|
1086
1088
|
* <code>s3://DOC-EXAMPLE-BUCKET/my-model-training-data/</code>
|
|
1087
1089
|
* </p>
|
|
1088
1090
|
*/
|
|
@@ -1090,7 +1092,7 @@ export interface InputDataConfig {
|
|
|
1090
1092
|
/**
|
|
1091
1093
|
* <p>The Amazon S3 location (URI) of the text files you want to use to tune your
|
|
1092
1094
|
* custom language model.</p>
|
|
1093
|
-
*
|
|
1095
|
+
* <p>Here's an example URI path:
|
|
1094
1096
|
* <code>s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/</code>
|
|
1095
1097
|
* </p>
|
|
1096
1098
|
*/
|
|
@@ -1099,20 +1101,20 @@ export interface InputDataConfig {
|
|
|
1099
1101
|
* <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
|
|
1100
1102
|
* access the Amazon S3 bucket that contains your input files. If the role that you
|
|
1101
1103
|
* specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.</p>
|
|
1102
|
-
*
|
|
1104
|
+
* <p>IAM role ARNs have the format
|
|
1103
1105
|
* <code>arn:partition:iam::account:role/role-name-with-path</code>. For example:
|
|
1104
1106
|
* <code>arn:aws:iam::111122223333:role/Admin</code>.</p>
|
|
1105
|
-
*
|
|
1107
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
|
|
1106
1108
|
* ARNs</a>.</p>
|
|
1107
1109
|
*/
|
|
1108
1110
|
DataAccessRoleArn: string | undefined;
|
|
1109
1111
|
}
|
|
1110
1112
|
/**
|
|
1111
1113
|
* <p>Adds metadata, in the form of a key:value pair, to the specified resource.</p>
|
|
1112
|
-
*
|
|
1114
|
+
* <p>For example, you could add the tag <code>Department:Sales</code> to a resource to
|
|
1113
1115
|
* indicate that it pertains to your organization's sales department. You can also use tags
|
|
1114
1116
|
* for tag-based access control.</p>
|
|
1115
|
-
*
|
|
1117
|
+
* <p>To learn more about tagging, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging resources</a>.</p>
|
|
1116
1118
|
*/
|
|
1117
1119
|
export interface Tag {
|
|
1118
1120
|
/**
|
|
@@ -1123,7 +1125,7 @@ export interface Tag {
|
|
|
1123
1125
|
/**
|
|
1124
1126
|
* <p>The second part of a key:value pair that forms a tag associated with a given resource.
|
|
1125
1127
|
* For example, in the tag <code>Department:Sales</code>, the value is 'Sales'.</p>
|
|
1126
|
-
*
|
|
1128
|
+
* <p>Note that you can set the value of a tag to an empty string, but you can't set the
|
|
1127
1129
|
* value of a tag to null. Omitting the tag value is the same as using an empty
|
|
1128
1130
|
* string.</p>
|
|
1129
1131
|
*/
|
|
@@ -1134,12 +1136,12 @@ export interface CreateLanguageModelRequest {
|
|
|
1134
1136
|
* <p>The language code that represents the language of your model. Each custom language
|
|
1135
1137
|
* model must contain terms in only one language, and the language you select for your
|
|
1136
1138
|
* custom language model must match the language of your training and tuning data.</p>
|
|
1137
|
-
*
|
|
1139
|
+
* <p>For a list of supported languages and their associated language codes, refer to the
|
|
1138
1140
|
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table. Note that
|
|
1139
1141
|
* US English
|
|
1140
1142
|
* (<code>en-US</code>) is the only language supported with Amazon Transcribe
|
|
1141
1143
|
* Medical.</p>
|
|
1142
|
-
*
|
|
1144
|
+
* <p>A custom language model can only be used to transcribe files in the same language as
|
|
1143
1145
|
* the model. For example, if you create a custom language model using US English
|
|
1144
1146
|
* (<code>en-US</code>), you can only apply this model to files that contain English
|
|
1145
1147
|
* audio.</p>
|
|
@@ -1149,14 +1151,14 @@ export interface CreateLanguageModelRequest {
|
|
|
1149
1151
|
* <p>The Amazon Transcribe standard language model, or base model, used to create your
|
|
1150
1152
|
* custom language model. Amazon Transcribe offers two options for base models: Wideband
|
|
1151
1153
|
* and Narrowband.</p>
|
|
1152
|
-
*
|
|
1154
|
+
* <p>If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose
|
|
1153
1155
|
* <code>WideBand</code>. To transcribe audio with a sample rate less than 16,000 Hz,
|
|
1154
1156
|
* choose <code>NarrowBand</code>.</p>
|
|
1155
1157
|
*/
|
|
1156
1158
|
BaseModelName: BaseModelName | string | undefined;
|
|
1157
1159
|
/**
|
|
1158
1160
|
* <p>A unique name, chosen by you, for your custom language model.</p>
|
|
1159
|
-
*
|
|
1161
|
+
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
1160
1162
|
* Amazon Web Services account. If you try to create a new custom language model with
|
|
1161
1163
|
* the same name as an existing custom language model, you get a
|
|
1162
1164
|
* <code>ConflictException</code> error.</p>
|
|
@@ -1165,7 +1167,7 @@ export interface CreateLanguageModelRequest {
|
|
|
1165
1167
|
/**
|
|
1166
1168
|
* <p>Contains the Amazon S3 location of the training data you want to use to create
|
|
1167
1169
|
* a new custom language model, and permissions to access this location.</p>
|
|
1168
|
-
*
|
|
1170
|
+
* <p>When using <code>InputDataConfig</code>, you must include these sub-parameters:
|
|
1169
1171
|
* <code>S3Uri</code>, which is the Amazon S3 location of your training data,
|
|
1170
1172
|
* and <code>DataAccessRoleArn</code>, which is the Amazon Resource Name (ARN) of the role
|
|
1171
1173
|
* that has permission to access your specified Amazon S3 location. You can
|
|
@@ -1177,7 +1179,7 @@ export interface CreateLanguageModelRequest {
|
|
|
1177
1179
|
/**
|
|
1178
1180
|
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new custom
|
|
1179
1181
|
* language model at the time you create this new model.</p>
|
|
1180
|
-
*
|
|
1182
|
+
* <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
|
|
1181
1183
|
* resources</a>.</p>
|
|
1182
1184
|
*/
|
|
1183
1185
|
Tags?: Tag[];
|
|
@@ -1216,7 +1218,7 @@ export interface CreateLanguageModelResponse {
|
|
|
1216
1218
|
export interface CreateMedicalVocabularyRequest {
|
|
1217
1219
|
/**
|
|
1218
1220
|
* <p>A unique name, chosen by you, for your new custom medical vocabulary.</p>
|
|
1219
|
-
*
|
|
1221
|
+
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
1220
1222
|
* Amazon Web Services account. If you try to create a new custom medical vocabulary
|
|
1221
1223
|
* with the same name as an existing custom medical vocabulary, you get a
|
|
1222
1224
|
* <code>ConflictException</code> error.</p>
|
|
@@ -1231,7 +1233,7 @@ export interface CreateMedicalVocabularyRequest {
|
|
|
1231
1233
|
* <p>The Amazon S3 location (URI) of the text file that contains your custom
|
|
1232
1234
|
* medical vocabulary. The URI must be in the same Amazon Web Services Region as the
|
|
1233
1235
|
* resource you're calling.</p>
|
|
1234
|
-
*
|
|
1236
|
+
* <p>Here's an example URI path:
|
|
1235
1237
|
* <code>s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt</code>
|
|
1236
1238
|
* </p>
|
|
1237
1239
|
*/
|
|
@@ -1239,7 +1241,7 @@ export interface CreateMedicalVocabularyRequest {
|
|
|
1239
1241
|
/**
|
|
1240
1242
|
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new custom
|
|
1241
1243
|
* medical vocabulary at the time you create this new custom vocabulary.</p>
|
|
1242
|
-
*
|
|
1244
|
+
* <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
|
|
1243
1245
|
* resources</a>.</p>
|
|
1244
1246
|
*/
|
|
1245
1247
|
Tags?: Tag[];
|
|
@@ -1268,7 +1270,7 @@ export interface CreateMedicalVocabularyResponse {
|
|
|
1268
1270
|
VocabularyState?: VocabularyState | string;
|
|
1269
1271
|
/**
|
|
1270
1272
|
* <p>The date and time you created your custom medical vocabulary.</p>
|
|
1271
|
-
*
|
|
1273
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1272
1274
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
1273
1275
|
* 4, 2022.</p>
|
|
1274
1276
|
*/
|
|
@@ -1283,7 +1285,7 @@ export interface CreateMedicalVocabularyResponse {
|
|
|
1283
1285
|
export interface CreateVocabularyRequest {
|
|
1284
1286
|
/**
|
|
1285
1287
|
* <p>A unique name, chosen by you, for your new custom vocabulary.</p>
|
|
1286
|
-
*
|
|
1288
|
+
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
1287
1289
|
* Amazon Web Services account. If you try to create a new custom vocabulary with the
|
|
1288
1290
|
* same name as an existing custom vocabulary, you get a <code>ConflictException</code>
|
|
1289
1291
|
* error.</p>
|
|
@@ -1292,11 +1294,11 @@ export interface CreateVocabularyRequest {
|
|
|
1292
1294
|
/**
|
|
1293
1295
|
* <p>The language code that represents the language of the entries in your custom
|
|
1294
1296
|
* vocabulary. Each custom vocabulary must contain terms in only one language.</p>
|
|
1295
|
-
*
|
|
1297
|
+
* <p>A custom vocabulary can only be used to transcribe files in the same language as the
|
|
1296
1298
|
* custom vocabulary. For example, if you create a custom vocabulary using US English
|
|
1297
1299
|
* (<code>en-US</code>), you can only apply this custom vocabulary to files that
|
|
1298
1300
|
* contain English audio.</p>
|
|
1299
|
-
*
|
|
1301
|
+
* <p>For a list of supported languages and their associated language codes, refer to the
|
|
1300
1302
|
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
|
|
1301
1303
|
*/
|
|
1302
1304
|
LanguageCode: LanguageCode | string | undefined;
|
|
@@ -1306,9 +1308,9 @@ export interface CreateVocabularyRequest {
|
|
|
1306
1308
|
* creating your custom vocabulary is to save your entries in a text file and upload them
|
|
1307
1309
|
* to an Amazon S3 bucket, then specify the location of your file using the
|
|
1308
1310
|
* <code>VocabularyFileUri</code> parameter.</p>
|
|
1309
|
-
*
|
|
1311
|
+
* <p>Note that if you include <code>Phrases</code> in your request, you cannot use
|
|
1310
1312
|
* <code>VocabularyFileUri</code>; you must choose one or the other.</p>
|
|
1311
|
-
*
|
|
1313
|
+
* <p>Each language has a character set that contains all allowed characters for that
|
|
1312
1314
|
* specific language. If you use unsupported characters, your custom vocabulary filter
|
|
1313
1315
|
* request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
|
|
1314
1316
|
* Vocabularies</a> to get the character set for your language.</p>
|
|
@@ -1318,17 +1320,17 @@ export interface CreateVocabularyRequest {
|
|
|
1318
1320
|
* <p>The Amazon S3 location of the text file that contains your custom vocabulary.
|
|
1319
1321
|
* The URI must be located in the same Amazon Web Services Region as the resource you're
|
|
1320
1322
|
* calling.</p>
|
|
1321
|
-
*
|
|
1323
|
+
* <p>Here's an example URI path:
|
|
1322
1324
|
* <code>s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt</code>
|
|
1323
1325
|
* </p>
|
|
1324
|
-
*
|
|
1326
|
+
* <p>Note that if you include <code>VocabularyFileUri</code> in your request, you cannot
|
|
1325
1327
|
* use the <code>Phrases</code> flag; you must choose one or the other.</p>
|
|
1326
1328
|
*/
|
|
1327
1329
|
VocabularyFileUri?: string;
|
|
1328
1330
|
/**
|
|
1329
1331
|
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new custom
|
|
1330
1332
|
* vocabulary at the time you create this new custom vocabulary.</p>
|
|
1331
|
-
*
|
|
1333
|
+
* <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
|
|
1332
1334
|
* resources</a>.</p>
|
|
1333
1335
|
*/
|
|
1334
1336
|
Tags?: Tag[];
|
|
@@ -1350,7 +1352,7 @@ export interface CreateVocabularyResponse {
|
|
|
1350
1352
|
VocabularyState?: VocabularyState | string;
|
|
1351
1353
|
/**
|
|
1352
1354
|
* <p>The date and time you created your custom vocabulary.</p>
|
|
1353
|
-
*
|
|
1355
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1354
1356
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
1355
1357
|
* 4, 2022.</p>
|
|
1356
1358
|
*/
|
|
@@ -1365,7 +1367,7 @@ export interface CreateVocabularyResponse {
|
|
|
1365
1367
|
export interface CreateVocabularyFilterRequest {
|
|
1366
1368
|
/**
|
|
1367
1369
|
* <p>A unique name, chosen by you, for your new custom vocabulary filter.</p>
|
|
1368
|
-
*
|
|
1370
|
+
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
1369
1371
|
* Amazon Web Services account. If you try to create a new custom vocabulary filter with
|
|
1370
1372
|
* the same name as an existing custom vocabulary filter, you get a
|
|
1371
1373
|
* <code>ConflictException</code> error.</p>
|
|
@@ -1374,11 +1376,11 @@ export interface CreateVocabularyFilterRequest {
|
|
|
1374
1376
|
/**
|
|
1375
1377
|
* <p>The language code that represents the language of the entries in your vocabulary
|
|
1376
1378
|
* filter. Each custom vocabulary filter must contain terms in only one language.</p>
|
|
1377
|
-
*
|
|
1379
|
+
* <p>A custom vocabulary filter can only be used to transcribe files in the same language
|
|
1378
1380
|
* as the filter. For example, if you create a custom vocabulary filter using US English
|
|
1379
1381
|
* (<code>en-US</code>), you can only apply this filter to files that contain English
|
|
1380
1382
|
* audio.</p>
|
|
1381
|
-
*
|
|
1383
|
+
* <p>For a list of supported languages and their associated language codes, refer to the
|
|
1382
1384
|
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
|
|
1383
1385
|
*/
|
|
1384
1386
|
LanguageCode: LanguageCode | string | undefined;
|
|
@@ -1388,9 +1390,9 @@ export interface CreateVocabularyFilterRequest {
|
|
|
1388
1390
|
* creating your vocabulary filter is to save your entries in a text file and upload them
|
|
1389
1391
|
* to an Amazon S3 bucket, then specify the location of your file using the
|
|
1390
1392
|
* <code>VocabularyFilterFileUri</code> parameter.</p>
|
|
1391
|
-
*
|
|
1393
|
+
* <p>Note that if you include <code>Words</code> in your request, you cannot use
|
|
1392
1394
|
* <code>VocabularyFilterFileUri</code>; you must choose one or the other.</p>
|
|
1393
|
-
*
|
|
1395
|
+
* <p>Each language has a character set that contains all allowed characters for that
|
|
1394
1396
|
* specific language. If you use unsupported characters, your custom vocabulary filter
|
|
1395
1397
|
* request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
|
|
1396
1398
|
* Vocabularies</a> to get the character set for your language.</p>
|
|
@@ -1400,17 +1402,17 @@ export interface CreateVocabularyFilterRequest {
|
|
|
1400
1402
|
* <p>The Amazon S3 location of the text file that contains your custom vocabulary
|
|
1401
1403
|
* filter terms. The URI must be located in the same Amazon Web Services Region as the
|
|
1402
1404
|
* resource you're calling.</p>
|
|
1403
|
-
*
|
|
1405
|
+
* <p>Here's an example URI path:
|
|
1404
1406
|
* <code>s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt</code>
|
|
1405
1407
|
* </p>
|
|
1406
|
-
*
|
|
1408
|
+
* <p>Note that if you include <code>VocabularyFilterFileUri</code> in your request, you
|
|
1407
1409
|
* cannot use <code>Words</code>; you must choose one or the other.</p>
|
|
1408
1410
|
*/
|
|
1409
1411
|
VocabularyFilterFileUri?: string;
|
|
1410
1412
|
/**
|
|
1411
1413
|
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new custom
|
|
1412
1414
|
* vocabulary filter at the time you create this new vocabulary filter.</p>
|
|
1413
|
-
*
|
|
1415
|
+
* <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
|
|
1414
1416
|
* resources</a>.</p>
|
|
1415
1417
|
*/
|
|
1416
1418
|
Tags?: Tag[];
|
|
@@ -1426,7 +1428,7 @@ export interface CreateVocabularyFilterResponse {
|
|
|
1426
1428
|
LanguageCode?: LanguageCode | string;
|
|
1427
1429
|
/**
|
|
1428
1430
|
* <p>The date and time you created your custom vocabulary filter.</p>
|
|
1429
|
-
*
|
|
1431
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1430
1432
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
1431
1433
|
* 4, 2022.</p>
|
|
1432
1434
|
*/
|
|
@@ -1522,20 +1524,20 @@ export interface DescribeLanguageModelRequest {
|
|
|
1522
1524
|
export interface LanguageModel {
|
|
1523
1525
|
/**
|
|
1524
1526
|
* <p>A unique name, chosen by you, for your custom language model.</p>
|
|
1525
|
-
*
|
|
1527
|
+
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
1526
1528
|
* Amazon Web Services account.</p>
|
|
1527
1529
|
*/
|
|
1528
1530
|
ModelName?: string;
|
|
1529
1531
|
/**
|
|
1530
1532
|
* <p>The date and time the specified custom language model was created.</p>
|
|
1531
|
-
*
|
|
1533
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1532
1534
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
1533
1535
|
* 4, 2022.</p>
|
|
1534
1536
|
*/
|
|
1535
1537
|
CreateTime?: Date;
|
|
1536
1538
|
/**
|
|
1537
1539
|
* <p>The date and time the specified custom language model was last modified.</p>
|
|
1538
|
-
*
|
|
1540
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1539
1541
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
1540
1542
|
* 4, 2022.</p>
|
|
1541
1543
|
*/
|
|
@@ -1544,7 +1546,7 @@ export interface LanguageModel {
|
|
|
1544
1546
|
* <p>The language code used to create your custom language model. Each custom language
|
|
1545
1547
|
* model must contain terms in only one language, and the language you select for your
|
|
1546
1548
|
* custom language model must match the language of your training and tuning data.</p>
|
|
1547
|
-
*
|
|
1549
|
+
* <p>For a list of supported languages and their associated language codes, refer to the
|
|
1548
1550
|
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table. Note that U.S. English (<code>en-US</code>) is
|
|
1549
1551
|
* the only language supported with Amazon Transcribe Medical.</p>
|
|
1550
1552
|
*/
|
|
@@ -1562,11 +1564,11 @@ export interface LanguageModel {
|
|
|
1562
1564
|
/**
|
|
1563
1565
|
* <p>Shows if a more current base model is available for use with the specified custom
|
|
1564
1566
|
* language model.</p>
|
|
1565
|
-
*
|
|
1567
|
+
* <p>If <code>false</code>, your custom language model is using the most up-to-date base
|
|
1566
1568
|
* model.</p>
|
|
1567
|
-
*
|
|
1569
|
+
* <p>If <code>true</code>, there is a newer base model available than the one your language
|
|
1568
1570
|
* model is using.</p>
|
|
1569
|
-
*
|
|
1571
|
+
* <p>Note that to update a base model, you must recreate the custom language model using
|
|
1570
1572
|
* the new base model. Base model upgrades for existing custom language models are not
|
|
1571
1573
|
* supported.</p>
|
|
1572
1574
|
*/
|
|
@@ -1588,10 +1590,10 @@ export interface DescribeLanguageModelResponse {
|
|
|
1588
1590
|
/**
|
|
1589
1591
|
* <p>Provides information about the specified custom language
|
|
1590
1592
|
* model.</p>
|
|
1591
|
-
*
|
|
1593
|
+
* <p>This parameter also shows if the base language model you used to create your custom
|
|
1592
1594
|
* language model has been updated. If Amazon Transcribe has updated the base model, you
|
|
1593
1595
|
* can create a new custom language model using the updated base model.</p>
|
|
1594
|
-
*
|
|
1596
|
+
* <p>If you tried to create a new custom language model and the request wasn't successful,
|
|
1595
1597
|
* you can use this <code>DescribeLanguageModel</code> to help identify the reason for this
|
|
1596
1598
|
* failure.</p>
|
|
1597
1599
|
*/
|
|
@@ -1644,63 +1646,63 @@ export interface MedicalTranscriptionSetting {
|
|
|
1644
1646
|
/**
|
|
1645
1647
|
* <p>Enables speaker partitioning (diarization) in your transcription output. Speaker
|
|
1646
1648
|
* partitioning labels the speech from individual speakers in your media file.</p>
|
|
1647
|
-
*
|
|
1649
|
+
* <p>If you enable <code>ShowSpeakerLabels</code> in your request, you must also include
|
|
1648
1650
|
* <code>MaxSpeakerLabels</code>.</p>
|
|
1649
|
-
*
|
|
1651
|
+
* <p>You can't include <code>ShowSpeakerLabels</code> and
|
|
1650
1652
|
* <code>ChannelIdentification</code> in the same request. Including both parameters
|
|
1651
1653
|
* returns a <code>BadRequestException</code>.</p>
|
|
1652
|
-
*
|
|
1654
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers
|
|
1653
1655
|
* (diarization)</a>.</p>
|
|
1654
1656
|
*/
|
|
1655
1657
|
ShowSpeakerLabels?: boolean;
|
|
1656
1658
|
/**
|
|
1657
1659
|
* <p>Specify the maximum number of speakers you want to partition in your media.</p>
|
|
1658
|
-
*
|
|
1660
|
+
* <p>Note that if your media contains more speakers than the specified number, multiple
|
|
1659
1661
|
* speakers are treated as a single speaker.</p>
|
|
1660
|
-
*
|
|
1662
|
+
* <p>If you specify the <code>MaxSpeakerLabels</code> field, you must set the
|
|
1661
1663
|
* <code>ShowSpeakerLabels</code> field to true.</p>
|
|
1662
1664
|
*/
|
|
1663
1665
|
MaxSpeakerLabels?: number;
|
|
1664
1666
|
/**
|
|
1665
1667
|
* <p>Enables channel identification in multi-channel audio.</p>
|
|
1666
|
-
*
|
|
1668
|
+
* <p>Channel identification transcribes the audio on each channel independently, then
|
|
1667
1669
|
* appends the output for each channel into one transcript.</p>
|
|
1668
|
-
*
|
|
1670
|
+
* <p>If you have multi-channel audio and do not enable channel identification, your audio
|
|
1669
1671
|
* is transcribed in a continuous manner and your transcript does not separate the speech
|
|
1670
1672
|
* by channel.</p>
|
|
1671
|
-
*
|
|
1673
|
+
* <p>You can't include both <code>ShowSpeakerLabels</code> and
|
|
1672
1674
|
* <code>ChannelIdentification</code> in the same request. Including both parameters
|
|
1673
1675
|
* returns a <code>BadRequestException</code>.</p>
|
|
1674
|
-
*
|
|
1676
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel
|
|
1675
1677
|
* audio</a>.</p>
|
|
1676
1678
|
*/
|
|
1677
1679
|
ChannelIdentification?: boolean;
|
|
1678
1680
|
/**
|
|
1679
1681
|
* <p>To include alternative transcriptions within your transcription output, include
|
|
1680
1682
|
* <code>ShowAlternatives</code> in your transcription request.</p>
|
|
1681
|
-
*
|
|
1683
|
+
* <p>If you include <code>ShowAlternatives</code>, you must also include
|
|
1682
1684
|
* <code>MaxAlternatives</code>, which is the maximum number of alternative
|
|
1683
1685
|
* transcriptions you want Amazon Transcribe Medical to generate.</p>
|
|
1684
|
-
*
|
|
1686
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative
|
|
1685
1687
|
* transcriptions</a>.</p>
|
|
1686
1688
|
*/
|
|
1687
1689
|
ShowAlternatives?: boolean;
|
|
1688
1690
|
/**
|
|
1689
1691
|
* <p>Indicate the maximum number of alternative transcriptions you want Amazon Transcribe
|
|
1690
1692
|
* Medical to include in your transcript.</p>
|
|
1691
|
-
*
|
|
1693
|
+
* <p>If you select a number greater than the number of alternative transcriptions generated
|
|
1692
1694
|
* by Amazon Transcribe Medical, only the actual number of alternative transcriptions are
|
|
1693
1695
|
* included.</p>
|
|
1694
|
-
*
|
|
1696
|
+
* <p>If you include <code>MaxAlternatives</code> in your request, you must also include
|
|
1695
1697
|
* <code>ShowAlternatives</code> with a value of <code>true</code>.</p>
|
|
1696
|
-
*
|
|
1698
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative
|
|
1697
1699
|
* transcriptions</a>.</p>
|
|
1698
1700
|
*/
|
|
1699
1701
|
MaxAlternatives?: number;
|
|
1700
1702
|
/**
|
|
1701
1703
|
* <p>The name of the custom vocabulary you want to use when processing your medical
|
|
1702
1704
|
* transcription job. Custom vocabulary names are case sensitive.</p>
|
|
1703
|
-
*
|
|
1705
|
+
* <p>The language of the specified custom vocabulary must match the language code that you
|
|
1704
1706
|
* specify in your transcription request. If the languages don't match, the custom
|
|
1705
1707
|
* vocabulary isn't applied. There are no errors or warnings associated with a language
|
|
1706
1708
|
* mismatch. US English (<code>en-US</code>) is the only valid language for Amazon Transcribe Medical.</p>
|
|
@@ -1718,7 +1720,7 @@ export interface MedicalTranscript {
|
|
|
1718
1720
|
/**
|
|
1719
1721
|
* <p>The Amazon S3 location of your transcript. You can use this URI to access or
|
|
1720
1722
|
* download your transcript.</p>
|
|
1721
|
-
*
|
|
1723
|
+
* <p>Note that this is the Amazon S3 location you specified in your request using the
|
|
1722
1724
|
* <code>OutputBucketName</code> parameter.</p>
|
|
1723
1725
|
*/
|
|
1724
1726
|
TranscriptFileUri?: string;
|
|
@@ -1735,7 +1737,7 @@ export declare enum Type {
|
|
|
1735
1737
|
}
|
|
1736
1738
|
/**
|
|
1737
1739
|
* <p>Provides detailed information about a medical transcription job.</p>
|
|
1738
|
-
*
|
|
1740
|
+
* <p>To view the status of the specified medical transcription job, check the
|
|
1739
1741
|
* <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>,
|
|
1740
1742
|
* the job is finished and you can find the results at the location specified in
|
|
1741
1743
|
* <code>TranscriptFileUri</code>. If the status is <code>FAILED</code>,
|
|
@@ -1750,7 +1752,7 @@ export interface MedicalTranscriptionJob {
|
|
|
1750
1752
|
MedicalTranscriptionJobName?: string;
|
|
1751
1753
|
/**
|
|
1752
1754
|
* <p>Provides the status of the specified medical transcription job.</p>
|
|
1753
|
-
*
|
|
1755
|
+
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
1754
1756
|
* results at the location specified in <code>TranscriptFileUri</code>. If the status is
|
|
1755
1757
|
* <code>FAILED</code>, <code>FailureReason</code> provides details on why your
|
|
1756
1758
|
* transcription job failed.</p>
|
|
@@ -1773,7 +1775,7 @@ export interface MedicalTranscriptionJob {
|
|
|
1773
1775
|
/**
|
|
1774
1776
|
* <p>Describes the Amazon S3 location of the media file you want to use in your
|
|
1775
1777
|
* request.</p>
|
|
1776
|
-
*
|
|
1778
|
+
* <p>For information on supported media formats, refer to the <a href="https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat">MediaFormat</a> parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
|
|
1777
1779
|
* in the Amazon S3 Developer Guide.</p>
|
|
1778
1780
|
*/
|
|
1779
1781
|
Media?: Media;
|
|
@@ -1784,21 +1786,21 @@ export interface MedicalTranscriptionJob {
|
|
|
1784
1786
|
Transcript?: MedicalTranscript;
|
|
1785
1787
|
/**
|
|
1786
1788
|
* <p>The date and time the specified medical transcription job began processing.</p>
|
|
1787
|
-
*
|
|
1789
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1788
1790
|
* example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a transcription job
|
|
1789
1791
|
* that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
|
|
1790
1792
|
*/
|
|
1791
1793
|
StartTime?: Date;
|
|
1792
1794
|
/**
|
|
1793
1795
|
* <p>The date and time the specified medical transcription job request was made.</p>
|
|
1794
|
-
*
|
|
1796
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1795
1797
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a transcription job
|
|
1796
1798
|
* that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
|
|
1797
1799
|
*/
|
|
1798
1800
|
CreationTime?: Date;
|
|
1799
1801
|
/**
|
|
1800
1802
|
* <p>The date and time the specified medical transcription job finished processing.</p>
|
|
1801
|
-
*
|
|
1803
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1802
1804
|
* example, <code>2022-05-04T12:33:13.922000-07:00</code> represents a transcription job
|
|
1803
1805
|
* that started processing at 12:33 PM UTC-7 on May 4, 2022.</p>
|
|
1804
1806
|
*/
|
|
@@ -1807,48 +1809,48 @@ export interface MedicalTranscriptionJob {
|
|
|
1807
1809
|
* <p>If <code>TranscriptionJobStatus</code> is <code>FAILED</code>,
|
|
1808
1810
|
* <code>FailureReason</code> contains information about why the transcription job
|
|
1809
1811
|
* request failed.</p>
|
|
1810
|
-
*
|
|
1811
|
-
*
|
|
1812
|
+
* <p>The <code>FailureReason</code> field contains one of the following values:</p>
|
|
1813
|
+
* <ul>
|
|
1812
1814
|
* <li>
|
|
1813
|
-
*
|
|
1815
|
+
* <p>
|
|
1814
1816
|
* <code>Unsupported media format</code>.</p>
|
|
1815
|
-
*
|
|
1817
|
+
* <p>The media format specified in <code>MediaFormat</code> isn't valid. Refer to
|
|
1816
1818
|
* <b>MediaFormat</b> for a list of supported
|
|
1817
1819
|
* formats.</p>
|
|
1818
1820
|
* </li>
|
|
1819
1821
|
* <li>
|
|
1820
|
-
*
|
|
1822
|
+
* <p>
|
|
1821
1823
|
* <code>The media format provided does not match the detected media
|
|
1822
1824
|
* format</code>.</p>
|
|
1823
|
-
*
|
|
1825
|
+
* <p>The media format specified in <code>MediaFormat</code> doesn't match the
|
|
1824
1826
|
* format of the input file. Check the media format of your media file and correct
|
|
1825
1827
|
* the specified value.</p>
|
|
1826
1828
|
* </li>
|
|
1827
1829
|
* <li>
|
|
1828
|
-
*
|
|
1830
|
+
* <p>
|
|
1829
1831
|
* <code>Invalid sample rate for audio file</code>.</p>
|
|
1830
|
-
*
|
|
1832
|
+
* <p>The sample rate specified in <code>MediaSampleRateHertz</code> isn't valid.
|
|
1831
1833
|
* The sample rate must be between 16,000 and 48,000 hertz.</p>
|
|
1832
1834
|
* </li>
|
|
1833
1835
|
* <li>
|
|
1834
|
-
*
|
|
1836
|
+
* <p>
|
|
1835
1837
|
* <code>The sample rate provided does not match the detected sample
|
|
1836
1838
|
* rate</code>.</p>
|
|
1837
|
-
*
|
|
1839
|
+
* <p>The sample rate specified in <code>MediaSampleRateHertz</code> doesn't match
|
|
1838
1840
|
* the sample rate detected in your input media file. Check the sample rate of your
|
|
1839
1841
|
* media file and correct the specified value.</p>
|
|
1840
1842
|
* </li>
|
|
1841
1843
|
* <li>
|
|
1842
|
-
*
|
|
1844
|
+
* <p>
|
|
1843
1845
|
* <code>Invalid file size: file size too large</code>.</p>
|
|
1844
|
-
*
|
|
1846
|
+
* <p>The size of your media file is larger than what Amazon Transcribe can
|
|
1845
1847
|
* process. For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits">Guidelines and
|
|
1846
1848
|
* quotas</a>.</p>
|
|
1847
1849
|
* </li>
|
|
1848
1850
|
* <li>
|
|
1849
|
-
*
|
|
1851
|
+
* <p>
|
|
1850
1852
|
* <code>Invalid number of channels: number of channels too large</code>.</p>
|
|
1851
|
-
*
|
|
1853
|
+
* <p>Your audio contains more channels than Amazon Transcribe is able to process.
|
|
1852
1854
|
* For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits">Guidelines and
|
|
1853
1855
|
* quotas</a>.</p>
|
|
1854
1856
|
* </li>
|
|
@@ -1914,7 +1916,7 @@ export interface GetMedicalVocabularyResponse {
|
|
|
1914
1916
|
VocabularyState?: VocabularyState | string;
|
|
1915
1917
|
/**
|
|
1916
1918
|
* <p>The date and time the specified custom medical vocabulary was last modified.</p>
|
|
1917
|
-
*
|
|
1919
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1918
1920
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
1919
1921
|
* 4, 2022.</p>
|
|
1920
1922
|
*/
|
|
@@ -1942,7 +1944,7 @@ export interface GetTranscriptionJobRequest {
|
|
|
1942
1944
|
* <p>Makes it possible to control how your transcription job is processed. Currently, the
|
|
1943
1945
|
* only <code>JobExecutionSettings</code> modification you can choose is enabling job
|
|
1944
1946
|
* queueing using the <code>AllowDeferredExecution</code> sub-parameter.</p>
|
|
1945
|
-
*
|
|
1947
|
+
* <p>If you include <code>JobExecutionSettings</code> in your request, you must also
|
|
1946
1948
|
* include the sub-parameters: <code>AllowDeferredExecution</code> and
|
|
1947
1949
|
* <code>DataAccessRoleArn</code>.</p>
|
|
1948
1950
|
*/
|
|
@@ -1954,8 +1956,8 @@ export interface JobExecutionSettings {
|
|
|
1954
1956
|
* the concurrent request limit. If <code>AllowDeferredExecution</code> is set to
|
|
1955
1957
|
* <code>false</code> and the number of transcription job requests exceed the
|
|
1956
1958
|
* concurrent request limit, you get a <code>LimitExceededException</code> error.</p>
|
|
1957
|
-
*
|
|
1958
|
-
*
|
|
1959
|
+
* <p>Note that job queuing is enabled by default for Call Analytics jobs.</p>
|
|
1960
|
+
* <p>If you include <code>AllowDeferredExecution</code> in your request, you must also
|
|
1959
1961
|
* include <code>DataAccessRoleArn</code>.</p>
|
|
1960
1962
|
*/
|
|
1961
1963
|
AllowDeferredExecution?: boolean;
|
|
@@ -1964,11 +1966,11 @@ export interface JobExecutionSettings {
|
|
|
1964
1966
|
* access the Amazon S3 bucket that contains your input files. If the role that you
|
|
1965
1967
|
* specify doesn’t have the appropriate permissions to access the specified Amazon S3
|
|
1966
1968
|
* location, your request fails.</p>
|
|
1967
|
-
*
|
|
1969
|
+
* <p>IAM role ARNs have the format
|
|
1968
1970
|
* <code>arn:partition:iam::account:role/role-name-with-path</code>. For example:
|
|
1969
1971
|
* <code>arn:aws:iam::111122223333:role/Admin</code>. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
|
|
1970
1972
|
* ARNs</a>.</p>
|
|
1971
|
-
*
|
|
1973
|
+
* <p>Note that if you include <code>DataAccessRoleArn</code> in your request, you must also
|
|
1972
1974
|
* include <code>AllowDeferredExecution</code>.</p>
|
|
1973
1975
|
*/
|
|
1974
1976
|
DataAccessRoleArn?: string;
|
|
@@ -1993,7 +1995,7 @@ export interface LanguageCodeItem {
|
|
|
1993
1995
|
/**
|
|
1994
1996
|
* <p>Provides the name of the custom language model that was included in the specified
|
|
1995
1997
|
* transcription job.</p>
|
|
1996
|
-
*
|
|
1998
|
+
* <p>Only use <code>ModelSettings</code> with the <code>LanguageModelName</code>
|
|
1997
1999
|
* sub-parameter if you're <b>not</b> using automatic language
|
|
1998
2000
|
* identification (<code></code>). If using
|
|
1999
2001
|
* <code>LanguageIdSettings</code> in your request, this parameter contains a
|
|
@@ -2003,7 +2005,7 @@ export interface ModelSettings {
|
|
|
2003
2005
|
/**
|
|
2004
2006
|
* <p>The name of the custom language model you want to use when processing your
|
|
2005
2007
|
* transcription job. Note that custom language model names are case sensitive.</p>
|
|
2006
|
-
*
|
|
2008
|
+
* <p>The language of the specified custom language model must match the language code that
|
|
2007
2009
|
* you specify in your transcription request. If the languages don't match, the custom
|
|
2008
2010
|
* language model isn't applied. There are no errors or warnings associated with a language
|
|
2009
2011
|
* mismatch.</p>
|
|
@@ -2024,56 +2026,56 @@ export interface Settings {
|
|
|
2024
2026
|
/**
|
|
2025
2027
|
* <p>Enables speaker partitioning (diarization) in your transcription output. Speaker
|
|
2026
2028
|
* partitioning labels the speech from individual speakers in your media file.</p>
|
|
2027
|
-
*
|
|
2029
|
+
* <p>If you enable <code>ShowSpeakerLabels</code> in your request, you must also include
|
|
2028
2030
|
* <code>MaxSpeakerLabels</code>.</p>
|
|
2029
|
-
*
|
|
2031
|
+
* <p>You can't include both <code>ShowSpeakerLabels</code> and
|
|
2030
2032
|
* <code>ChannelIdentification</code> in the same request. Including both parameters
|
|
2031
2033
|
* returns a <code>BadRequestException</code>.</p>
|
|
2032
|
-
*
|
|
2034
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers
|
|
2033
2035
|
* (diarization)</a>.</p>
|
|
2034
2036
|
*/
|
|
2035
2037
|
ShowSpeakerLabels?: boolean;
|
|
2036
2038
|
/**
|
|
2037
2039
|
* <p>Specify the maximum number of speakers you want to partition in your media.</p>
|
|
2038
|
-
*
|
|
2040
|
+
* <p>Note that if your media contains more speakers than the specified number, multiple
|
|
2039
2041
|
* speakers are treated as a single speaker.</p>
|
|
2040
|
-
*
|
|
2042
|
+
* <p>If you specify the <code>MaxSpeakerLabels</code> field, you must set the
|
|
2041
2043
|
* <code>ShowSpeakerLabels</code> field to true.</p>
|
|
2042
2044
|
*/
|
|
2043
2045
|
MaxSpeakerLabels?: number;
|
|
2044
2046
|
/**
|
|
2045
2047
|
* <p>Enables channel identification in multi-channel audio.</p>
|
|
2046
|
-
*
|
|
2048
|
+
* <p>Channel identification transcribes the audio on each channel independently, then
|
|
2047
2049
|
* appends the output for each channel into one transcript.</p>
|
|
2048
|
-
*
|
|
2050
|
+
* <p>You can't include both <code>ShowSpeakerLabels</code> and
|
|
2049
2051
|
* <code>ChannelIdentification</code> in the same request. Including both parameters
|
|
2050
2052
|
* returns a <code>BadRequestException</code>.</p>
|
|
2051
|
-
*
|
|
2053
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel
|
|
2052
2054
|
* audio</a>.</p>
|
|
2053
2055
|
*/
|
|
2054
2056
|
ChannelIdentification?: boolean;
|
|
2055
2057
|
/**
|
|
2056
2058
|
* <p>To include alternative transcriptions within your transcription output, include
|
|
2057
2059
|
* <code>ShowAlternatives</code> in your transcription request.</p>
|
|
2058
|
-
*
|
|
2060
|
+
* <p>If you have multi-channel audio and do not enable channel identification, your audio
|
|
2059
2061
|
* is transcribed in a continuous manner and your transcript does not separate the speech
|
|
2060
2062
|
* by channel.</p>
|
|
2061
|
-
*
|
|
2063
|
+
* <p>If you include <code>ShowAlternatives</code>, you must also include
|
|
2062
2064
|
* <code>MaxAlternatives</code>, which is the maximum number of alternative
|
|
2063
2065
|
* transcriptions you want Amazon Transcribe to generate.</p>
|
|
2064
|
-
*
|
|
2066
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative
|
|
2065
2067
|
* transcriptions</a>.</p>
|
|
2066
2068
|
*/
|
|
2067
2069
|
ShowAlternatives?: boolean;
|
|
2068
2070
|
/**
|
|
2069
2071
|
* <p>Indicate the maximum number of alternative transcriptions you want Amazon Transcribe
|
|
2070
2072
|
* to include in your transcript.</p>
|
|
2071
|
-
*
|
|
2073
|
+
* <p>If you select a number greater than the number of alternative transcriptions generated
|
|
2072
2074
|
* by Amazon Transcribe, only the actual number of alternative transcriptions are
|
|
2073
2075
|
* included.</p>
|
|
2074
|
-
*
|
|
2076
|
+
* <p>If you include <code>MaxAlternatives</code> in your request, you must also include
|
|
2075
2077
|
* <code>ShowAlternatives</code> with a value of <code>true</code>.</p>
|
|
2076
|
-
*
|
|
2078
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative
|
|
2077
2079
|
* transcriptions</a>.</p>
|
|
2078
2080
|
*/
|
|
2079
2081
|
MaxAlternatives?: number;
|
|
@@ -2081,15 +2083,15 @@ export interface Settings {
|
|
|
2081
2083
|
* <p>The name of the custom vocabulary filter you want to use in your transcription job
|
|
2082
2084
|
* request. This name is case sensitive, cannot contain spaces, and must be unique within
|
|
2083
2085
|
* an Amazon Web Services account.</p>
|
|
2084
|
-
*
|
|
2086
|
+
* <p>Note that if you include <code>VocabularyFilterName</code> in your request, you must
|
|
2085
2087
|
* also include <code>VocabularyFilterMethod</code>.</p>
|
|
2086
2088
|
*/
|
|
2087
2089
|
VocabularyFilterName?: string;
|
|
2088
2090
|
/**
|
|
2089
2091
|
* <p>Specify how you want your custom vocabulary filter applied to your transcript.</p>
|
|
2090
|
-
*
|
|
2091
|
-
*
|
|
2092
|
-
*
|
|
2092
|
+
* <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
|
|
2093
|
+
* <p>To delete words, choose <code>remove</code>.</p>
|
|
2094
|
+
* <p>To flag words without changing them, choose <code>tag</code>.</p>
|
|
2093
2095
|
*/
|
|
2094
2096
|
VocabularyFilterMethod?: VocabularyFilterMethod | string;
|
|
2095
2097
|
}
|
|
@@ -2113,19 +2115,19 @@ export interface SubtitlesOutput {
|
|
|
2113
2115
|
* download your subtitle file. Your subtitle file is stored in the same location as your
|
|
2114
2116
|
* transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are
|
|
2115
2117
|
* provided.</p>
|
|
2116
|
-
*
|
|
2118
|
+
* <p>If you included <code>OutputBucketName</code> in your transcription job request, this
|
|
2117
2119
|
* is the URI of that bucket. If you also included <code>OutputKey</code> in your request,
|
|
2118
2120
|
* your output is located in the path you specified in your request.</p>
|
|
2119
|
-
*
|
|
2121
|
+
* <p>If you didn't include <code>OutputBucketName</code> in your transcription job request,
|
|
2120
2122
|
* your subtitle file is stored in a service-managed bucket, and
|
|
2121
2123
|
* <code>TranscriptFileUri</code> provides you with a temporary URI you can use for
|
|
2122
2124
|
* secure access to your subtitle file.</p>
|
|
2123
|
-
*
|
|
2125
|
+
* <note>
|
|
2124
2126
|
* <p>Temporary URIs for service-managed Amazon S3 buckets are only valid for 15
|
|
2125
2127
|
* minutes. If you get an <code>AccesDenied</code> error, you can get a new temporary
|
|
2126
2128
|
* URI by running a <code>GetTranscriptionJob</code> or
|
|
2127
2129
|
* <code>ListTranscriptionJob</code> request.</p>
|
|
2128
|
-
*
|
|
2130
|
+
* </note>
|
|
2129
2131
|
*/
|
|
2130
2132
|
SubtitleFileUris?: string[];
|
|
2131
2133
|
/**
|
|
@@ -2136,13 +2138,13 @@ export interface SubtitlesOutput {
|
|
|
2136
2138
|
}
|
|
2137
2139
|
/**
|
|
2138
2140
|
* <p>Provides detailed information about a transcription job.</p>
|
|
2139
|
-
*
|
|
2141
|
+
* <p>To view the status of the specified transcription job, check the
|
|
2140
2142
|
* <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>,
|
|
2141
2143
|
* the job is finished and you can find the results at the location specified in
|
|
2142
2144
|
* <code>TranscriptFileUri</code>. If the status is <code>FAILED</code>,
|
|
2143
2145
|
* <code>FailureReason</code> provides details on why your transcription job
|
|
2144
2146
|
* failed.</p>
|
|
2145
|
-
*
|
|
2147
|
+
* <p>If you enabled content redaction, the redacted transcript can be found at the location
|
|
2146
2148
|
* specified in <code>RedactedTranscriptFileUri</code>.</p>
|
|
2147
2149
|
*/
|
|
2148
2150
|
export interface TranscriptionJob {
|
|
@@ -2153,7 +2155,7 @@ export interface TranscriptionJob {
|
|
|
2153
2155
|
TranscriptionJobName?: string;
|
|
2154
2156
|
/**
|
|
2155
2157
|
* <p>Provides the status of the specified transcription job.</p>
|
|
2156
|
-
*
|
|
2158
|
+
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
2157
2159
|
* results at the location specified in <code>TranscriptFileUri</code> (or
|
|
2158
2160
|
* <code>RedactedTranscriptFileUri</code>, if you requested transcript redaction). If
|
|
2159
2161
|
* the status is <code>FAILED</code>, <code>FailureReason</code> provides details on why
|
|
@@ -2186,21 +2188,21 @@ export interface TranscriptionJob {
|
|
|
2186
2188
|
Transcript?: Transcript;
|
|
2187
2189
|
/**
|
|
2188
2190
|
* <p>The date and time the specified transcription job began processing.</p>
|
|
2189
|
-
*
|
|
2191
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2190
2192
|
* example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a transcription job
|
|
2191
2193
|
* that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
|
|
2192
2194
|
*/
|
|
2193
2195
|
StartTime?: Date;
|
|
2194
2196
|
/**
|
|
2195
2197
|
* <p>The date and time the specified transcription job request was made.</p>
|
|
2196
|
-
*
|
|
2198
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2197
2199
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a transcription job
|
|
2198
2200
|
* that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
|
|
2199
2201
|
*/
|
|
2200
2202
|
CreationTime?: Date;
|
|
2201
2203
|
/**
|
|
2202
2204
|
* <p>The date and time the specified transcription job finished processing.</p>
|
|
2203
|
-
*
|
|
2205
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2204
2206
|
* example, <code>2022-05-04T12:33:13.922000-07:00</code> represents a transcription job
|
|
2205
2207
|
* that started processing at 12:33 PM UTC-7 on May 4, 2022.</p>
|
|
2206
2208
|
*/
|
|
@@ -2209,48 +2211,48 @@ export interface TranscriptionJob {
|
|
|
2209
2211
|
* <p>If <code>TranscriptionJobStatus</code> is <code>FAILED</code>,
|
|
2210
2212
|
* <code>FailureReason</code> contains information about why the transcription job
|
|
2211
2213
|
* request failed.</p>
|
|
2212
|
-
*
|
|
2213
|
-
*
|
|
2214
|
+
* <p>The <code>FailureReason</code> field contains one of the following values:</p>
|
|
2215
|
+
* <ul>
|
|
2214
2216
|
* <li>
|
|
2215
|
-
*
|
|
2217
|
+
* <p>
|
|
2216
2218
|
* <code>Unsupported media format</code>.</p>
|
|
2217
|
-
*
|
|
2219
|
+
* <p>The media format specified in <code>MediaFormat</code> isn't valid. Refer to
|
|
2218
2220
|
* <b>MediaFormat</b> for a list of supported
|
|
2219
2221
|
* formats.</p>
|
|
2220
2222
|
* </li>
|
|
2221
2223
|
* <li>
|
|
2222
|
-
*
|
|
2224
|
+
* <p>
|
|
2223
2225
|
* <code>The media format provided does not match the detected media
|
|
2224
2226
|
* format</code>.</p>
|
|
2225
|
-
*
|
|
2227
|
+
* <p>The media format specified in <code>MediaFormat</code> doesn't match the
|
|
2226
2228
|
* format of the input file. Check the media format of your media file and correct
|
|
2227
2229
|
* the specified value.</p>
|
|
2228
2230
|
* </li>
|
|
2229
2231
|
* <li>
|
|
2230
|
-
*
|
|
2232
|
+
* <p>
|
|
2231
2233
|
* <code>Invalid sample rate for audio file</code>.</p>
|
|
2232
|
-
*
|
|
2234
|
+
* <p>The sample rate specified in <code>MediaSampleRateHertz</code> isn't valid.
|
|
2233
2235
|
* The sample rate must be between 8,000 and 48,000 hertz.</p>
|
|
2234
2236
|
* </li>
|
|
2235
2237
|
* <li>
|
|
2236
|
-
*
|
|
2238
|
+
* <p>
|
|
2237
2239
|
* <code>The sample rate provided does not match the detected sample
|
|
2238
2240
|
* rate</code>.</p>
|
|
2239
|
-
*
|
|
2241
|
+
* <p>The sample rate specified in <code>MediaSampleRateHertz</code> doesn't match
|
|
2240
2242
|
* the sample rate detected in your input media file. Check the sample rate of your
|
|
2241
2243
|
* media file and correct the specified value.</p>
|
|
2242
2244
|
* </li>
|
|
2243
2245
|
* <li>
|
|
2244
|
-
*
|
|
2246
|
+
* <p>
|
|
2245
2247
|
* <code>Invalid file size: file size too large</code>.</p>
|
|
2246
|
-
*
|
|
2248
|
+
* <p>The size of your media file is larger than what Amazon Transcribe can
|
|
2247
2249
|
* process. For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits">Guidelines and
|
|
2248
2250
|
* quotas</a>.</p>
|
|
2249
2251
|
* </li>
|
|
2250
2252
|
* <li>
|
|
2251
|
-
*
|
|
2253
|
+
* <p>
|
|
2252
2254
|
* <code>Invalid number of channels: number of channels too large</code>.</p>
|
|
2253
|
-
*
|
|
2255
|
+
* <p>Your audio contains more channels than Amazon Transcribe is able to process.
|
|
2254
2256
|
* For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits">Guidelines and
|
|
2255
2257
|
* quotas</a>.</p>
|
|
2256
2258
|
* </li>
|
|
@@ -2293,7 +2295,7 @@ export interface TranscriptionJob {
|
|
|
2293
2295
|
/**
|
|
2294
2296
|
* <p>The confidence score associated with the language identified in your media
|
|
2295
2297
|
* file.</p>
|
|
2296
|
-
*
|
|
2298
|
+
* <p>Confidence scores are values between 0 and 1; a larger value indicates a higher
|
|
2297
2299
|
* probability that the identified language correctly matches the language spoken in your
|
|
2298
2300
|
* media.</p>
|
|
2299
2301
|
*/
|
|
@@ -2350,7 +2352,7 @@ export interface GetVocabularyResponse {
|
|
|
2350
2352
|
VocabularyState?: VocabularyState | string;
|
|
2351
2353
|
/**
|
|
2352
2354
|
* <p>The date and time the specified custom vocabulary was last modified.</p>
|
|
2353
|
-
*
|
|
2355
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2354
2356
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
2355
2357
|
* 4, 2022.</p>
|
|
2356
2358
|
*/
|
|
@@ -2385,7 +2387,7 @@ export interface GetVocabularyFilterResponse {
|
|
|
2385
2387
|
LanguageCode?: LanguageCode | string;
|
|
2386
2388
|
/**
|
|
2387
2389
|
* <p>The date and time the specified custom vocabulary filter was last modified.</p>
|
|
2388
|
-
*
|
|
2390
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2389
2391
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
2390
2392
|
* 4, 2022.</p>
|
|
2391
2393
|
*/
|
|
@@ -2557,21 +2559,21 @@ export interface MedicalTranscriptionJobSummary {
|
|
|
2557
2559
|
MedicalTranscriptionJobName?: string;
|
|
2558
2560
|
/**
|
|
2559
2561
|
* <p>The date and time the specified medical transcription job request was made.</p>
|
|
2560
|
-
*
|
|
2562
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2561
2563
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a transcription job
|
|
2562
2564
|
* that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
|
|
2563
2565
|
*/
|
|
2564
2566
|
CreationTime?: Date;
|
|
2565
2567
|
/**
|
|
2566
2568
|
* <p>The date and time your medical transcription job began processing.</p>
|
|
2567
|
-
*
|
|
2569
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2568
2570
|
* example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a transcription job
|
|
2569
2571
|
* that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
|
|
2570
2572
|
*/
|
|
2571
2573
|
StartTime?: Date;
|
|
2572
2574
|
/**
|
|
2573
2575
|
* <p>The date and time the specified medical transcription job finished processing.</p>
|
|
2574
|
-
*
|
|
2576
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2575
2577
|
* example, <code>2022-05-04T12:33:13.922000-07:00</code> represents a transcription job
|
|
2576
2578
|
* that started processing at 12:33 PM UTC-7 on May 4, 2022.</p>
|
|
2577
2579
|
*/
|
|
@@ -2584,7 +2586,7 @@ export interface MedicalTranscriptionJobSummary {
|
|
|
2584
2586
|
LanguageCode?: LanguageCode | string;
|
|
2585
2587
|
/**
|
|
2586
2588
|
* <p>Provides the status of your medical transcription job.</p>
|
|
2587
|
-
*
|
|
2589
|
+
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
2588
2590
|
* results at the location specified in <code>TranscriptFileUri</code>. If the status is
|
|
2589
2591
|
* <code>FAILED</code>, <code>FailureReason</code> provides details on why your
|
|
2590
2592
|
* transcription job failed.</p>
|
|
@@ -2598,11 +2600,11 @@ export interface MedicalTranscriptionJobSummary {
|
|
|
2598
2600
|
FailureReason?: string;
|
|
2599
2601
|
/**
|
|
2600
2602
|
* <p>Indicates where the specified medical transcription output is stored.</p>
|
|
2601
|
-
*
|
|
2603
|
+
* <p>If the value is <code>CUSTOMER_BUCKET</code>, the location is the Amazon S3
|
|
2602
2604
|
* bucket you specified using the <code>OutputBucketName</code> parameter in your request. If you also included
|
|
2603
2605
|
* <code>OutputKey</code> in your request, your output is located in the path you
|
|
2604
2606
|
* specified in your request.</p>
|
|
2605
|
-
*
|
|
2607
|
+
* <p>If the value is <code>SERVICE_BUCKET</code>, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the
|
|
2606
2608
|
* URI shown in the <code>TranscriptFileUri</code> field.</p>
|
|
2607
2609
|
*/
|
|
2608
2610
|
OutputLocationType?: OutputLocationType | string;
|
|
@@ -2680,7 +2682,7 @@ export interface VocabularyInfo {
|
|
|
2680
2682
|
/**
|
|
2681
2683
|
* <p>The language code used to create your custom vocabulary. Each custom vocabulary must
|
|
2682
2684
|
* contain terms in only one language.</p>
|
|
2683
|
-
*
|
|
2685
|
+
* <p>A custom vocabulary can only be used to transcribe files in the same language as the
|
|
2684
2686
|
* custom vocabulary. For example, if you create a custom vocabulary using US English
|
|
2685
2687
|
* (<code>en-US</code>), you can only apply this custom vocabulary to files that
|
|
2686
2688
|
* contain English audio.</p>
|
|
@@ -2688,7 +2690,7 @@ export interface VocabularyInfo {
|
|
|
2688
2690
|
LanguageCode?: LanguageCode | string;
|
|
2689
2691
|
/**
|
|
2690
2692
|
* <p>The date and time the specified custom vocabulary was last modified.</p>
|
|
2691
|
-
*
|
|
2693
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2692
2694
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
2693
2695
|
* 4, 2022.</p>
|
|
2694
2696
|
*/
|
|
@@ -2726,9 +2728,9 @@ export interface ListTagsForResourceRequest {
|
|
|
2726
2728
|
* <p>Returns a list of all tags associated with the specified Amazon Resource Name (ARN).
|
|
2727
2729
|
* ARNs have the format
|
|
2728
2730
|
* <code>arn:partition:service:region:account-id:resource-type/resource-id</code>.</p>
|
|
2729
|
-
*
|
|
2731
|
+
* <p>For example,
|
|
2730
2732
|
* <code>arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name</code>.</p>
|
|
2731
|
-
*
|
|
2733
|
+
* <p>Valid values for <code>resource-type</code> are: <code>transcription-job</code>,
|
|
2732
2734
|
* <code>medical-transcription-job</code>, <code>vocabulary</code>,
|
|
2733
2735
|
* <code>medical-vocabulary</code>, <code>vocabulary-filter</code>, and
|
|
2734
2736
|
* <code>language-model</code>.</p>
|
|
@@ -2784,21 +2786,21 @@ export interface TranscriptionJobSummary {
|
|
|
2784
2786
|
TranscriptionJobName?: string;
|
|
2785
2787
|
/**
|
|
2786
2788
|
* <p>The date and time the specified transcription job request was made.</p>
|
|
2787
|
-
*
|
|
2789
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2788
2790
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a transcription job
|
|
2789
2791
|
* that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
|
|
2790
2792
|
*/
|
|
2791
2793
|
CreationTime?: Date;
|
|
2792
2794
|
/**
|
|
2793
2795
|
* <p>The date and time your transcription job began processing.</p>
|
|
2794
|
-
*
|
|
2796
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2795
2797
|
* example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a transcription job
|
|
2796
2798
|
* that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
|
|
2797
2799
|
*/
|
|
2798
2800
|
StartTime?: Date;
|
|
2799
2801
|
/**
|
|
2800
2802
|
* <p>The date and time the specified transcription job finished processing.</p>
|
|
2801
|
-
*
|
|
2803
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2802
2804
|
* example, <code>2022-05-04T12:33:13.922000-07:00</code> represents a transcription job
|
|
2803
2805
|
* that started processing at 12:33 PM UTC-7 on May 4, 2022.</p>
|
|
2804
2806
|
*/
|
|
@@ -2809,7 +2811,7 @@ export interface TranscriptionJobSummary {
|
|
|
2809
2811
|
LanguageCode?: LanguageCode | string;
|
|
2810
2812
|
/**
|
|
2811
2813
|
* <p>Provides the status of your transcription job.</p>
|
|
2812
|
-
*
|
|
2814
|
+
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
2813
2815
|
* results at the location specified in <code>TranscriptFileUri</code> (or
|
|
2814
2816
|
* <code>RedactedTranscriptFileUri</code>, if you requested transcript redaction). If
|
|
2815
2817
|
* the status is <code>FAILED</code>, <code>FailureReason</code> provides details on why
|
|
@@ -2824,11 +2826,11 @@ export interface TranscriptionJobSummary {
|
|
|
2824
2826
|
FailureReason?: string;
|
|
2825
2827
|
/**
|
|
2826
2828
|
* <p>Indicates where the specified transcription output is stored.</p>
|
|
2827
|
-
*
|
|
2829
|
+
* <p>If the value is <code>CUSTOMER_BUCKET</code>, the location is the Amazon S3
|
|
2828
2830
|
* bucket you specified using the <code>OutputBucketName</code> parameter in your request. If you also included
|
|
2829
2831
|
* <code>OutputKey</code> in your request, your output is located in the path you
|
|
2830
2832
|
* specified in your request.</p>
|
|
2831
|
-
*
|
|
2833
|
+
* <p>If the value is <code>SERVICE_BUCKET</code>, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the
|
|
2832
2834
|
* URI shown in the <code>TranscriptFileUri</code> or
|
|
2833
2835
|
* <code>RedactedTranscriptFileUri</code> field.</p>
|
|
2834
2836
|
*/
|
|
@@ -2840,7 +2842,7 @@ export interface TranscriptionJobSummary {
|
|
|
2840
2842
|
/**
|
|
2841
2843
|
* <p>Provides the name of the custom language model that was included in the specified
|
|
2842
2844
|
* transcription job.</p>
|
|
2843
|
-
*
|
|
2845
|
+
* <p>Only use <code>ModelSettings</code> with the <code>LanguageModelName</code>
|
|
2844
2846
|
* sub-parameter if you're <b>not</b> using automatic language
|
|
2845
2847
|
* identification (<code></code>). If using
|
|
2846
2848
|
* <code>LanguageIdSettings</code> in your request, this parameter contains a
|
|
@@ -2860,7 +2862,7 @@ export interface TranscriptionJobSummary {
|
|
|
2860
2862
|
/**
|
|
2861
2863
|
* <p>The confidence score associated with the language identified in your media
|
|
2862
2864
|
* file.</p>
|
|
2863
|
-
*
|
|
2865
|
+
* <p>Confidence scores are values between 0 and 1; a larger value indicates a higher
|
|
2864
2866
|
* probability that the identified language correctly matches the language spoken in your
|
|
2865
2867
|
* media.</p>
|
|
2866
2868
|
*/
|
|
@@ -2972,17 +2974,17 @@ export interface VocabularyFilterInfo {
|
|
|
2972
2974
|
/**
|
|
2973
2975
|
* <p>The language code that represents the language of the entries in your vocabulary
|
|
2974
2976
|
* filter. Each custom vocabulary filter must contain terms in only one language.</p>
|
|
2975
|
-
*
|
|
2977
|
+
* <p>A custom vocabulary filter can only be used to transcribe files in the same language
|
|
2976
2978
|
* as the filter. For example, if you create a custom vocabulary filter using US English
|
|
2977
2979
|
* (<code>en-US</code>), you can only apply this filter to files that contain English
|
|
2978
2980
|
* audio.</p>
|
|
2979
|
-
*
|
|
2981
|
+
* <p>For a list of supported languages and their associated language codes, refer to the
|
|
2980
2982
|
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
|
|
2981
2983
|
*/
|
|
2982
2984
|
LanguageCode?: LanguageCode | string;
|
|
2983
2985
|
/**
|
|
2984
2986
|
* <p>The date and time the specified custom vocabulary filter was last modified.</p>
|
|
2985
|
-
*
|
|
2987
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2986
2988
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
2987
2989
|
* 4, 2022.</p>
|
|
2988
2990
|
*/
|
|
@@ -3006,7 +3008,7 @@ export interface ListVocabularyFiltersResponse {
|
|
|
3006
3008
|
export interface StartCallAnalyticsJobRequest {
|
|
3007
3009
|
/**
|
|
3008
3010
|
* <p>A unique name, chosen by you, for your Call Analytics job.</p>
|
|
3009
|
-
*
|
|
3011
|
+
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
3010
3012
|
* Amazon Web Services account. If you try to create a new job with the same name as an
|
|
3011
3013
|
* existing job, you get a <code>ConflictException</code> error.</p>
|
|
3012
3014
|
*/
|
|
@@ -3019,24 +3021,24 @@ export interface StartCallAnalyticsJobRequest {
|
|
|
3019
3021
|
/**
|
|
3020
3022
|
* <p>The Amazon S3 location where you want your Call Analytics transcription output
|
|
3021
3023
|
* stored. You can use any of the following formats to specify the output location:</p>
|
|
3022
|
-
*
|
|
3024
|
+
* <ol>
|
|
3023
3025
|
* <li>
|
|
3024
|
-
*
|
|
3026
|
+
* <p>s3://DOC-EXAMPLE-BUCKET</p>
|
|
3025
3027
|
* </li>
|
|
3026
3028
|
* <li>
|
|
3027
|
-
*
|
|
3029
|
+
* <p>s3://DOC-EXAMPLE-BUCKET/my-output-folder/</p>
|
|
3028
3030
|
* </li>
|
|
3029
3031
|
* <li>
|
|
3030
|
-
*
|
|
3032
|
+
* <p>s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json</p>
|
|
3031
3033
|
* </li>
|
|
3032
3034
|
* </ol>
|
|
3033
|
-
*
|
|
3035
|
+
* <p>Unless you specify a file name (option 3), the name of your output file has a default
|
|
3034
3036
|
* value that matches the name you specified for your transcription job using the
|
|
3035
3037
|
* <code>CallAnalyticsJobName</code> parameter.</p>
|
|
3036
|
-
*
|
|
3038
|
+
* <p>You can specify a KMS key to encrypt your output using the
|
|
3037
3039
|
* <code>OutputEncryptionKMSKeyId</code> parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for
|
|
3038
3040
|
* server-side encryption.</p>
|
|
3039
|
-
*
|
|
3041
|
+
* <p>If you don't specify <code>OutputLocation</code>, your transcript is placed in a
|
|
3040
3042
|
* service-managed Amazon S3 bucket and you are provided with a URI to access your
|
|
3041
3043
|
* transcript.</p>
|
|
3042
3044
|
*/
|
|
@@ -3044,46 +3046,46 @@ export interface StartCallAnalyticsJobRequest {
|
|
|
3044
3046
|
/**
|
|
3045
3047
|
* <p>The KMS key you want to use to encrypt your Call Analytics
|
|
3046
3048
|
* output.</p>
|
|
3047
|
-
*
|
|
3049
|
+
* <p>If using a key located in the <b>current</b>
|
|
3048
3050
|
* Amazon Web Services account, you can specify your KMS key in one of four
|
|
3049
3051
|
* ways:</p>
|
|
3050
|
-
*
|
|
3052
|
+
* <ol>
|
|
3051
3053
|
* <li>
|
|
3052
|
-
*
|
|
3054
|
+
* <p>Use the KMS key ID itself. For example,
|
|
3053
3055
|
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
3054
3056
|
* </li>
|
|
3055
3057
|
* <li>
|
|
3056
|
-
*
|
|
3058
|
+
* <p>Use an alias for the KMS key ID. For example,
|
|
3057
3059
|
* <code>alias/ExampleAlias</code>.</p>
|
|
3058
3060
|
* </li>
|
|
3059
3061
|
* <li>
|
|
3060
|
-
*
|
|
3062
|
+
* <p>Use the Amazon Resource Name (ARN) for the KMS key ID. For
|
|
3061
3063
|
* example,
|
|
3062
3064
|
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
3063
3065
|
* </li>
|
|
3064
3066
|
* <li>
|
|
3065
|
-
*
|
|
3067
|
+
* <p>Use the ARN for the KMS key alias. For example,
|
|
3066
3068
|
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
|
|
3067
3069
|
* </li>
|
|
3068
3070
|
* </ol>
|
|
3069
|
-
*
|
|
3071
|
+
* <p>If using a key located in a <b>different</b>
|
|
3070
3072
|
* Amazon Web Services account than the current Amazon Web Services account, you can specify
|
|
3071
3073
|
* your KMS key in one of two ways:</p>
|
|
3072
|
-
*
|
|
3074
|
+
* <ol>
|
|
3073
3075
|
* <li>
|
|
3074
|
-
*
|
|
3076
|
+
* <p>Use the ARN for the KMS key ID. For example,
|
|
3075
3077
|
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
3076
3078
|
* </li>
|
|
3077
3079
|
* <li>
|
|
3078
|
-
*
|
|
3080
|
+
* <p>Use the ARN for the KMS key alias. For example,
|
|
3079
3081
|
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
|
|
3080
3082
|
* </li>
|
|
3081
3083
|
* </ol>
|
|
3082
|
-
*
|
|
3084
|
+
* <p>If you don't specify an encryption key, your output is encrypted with the default
|
|
3083
3085
|
* Amazon S3 key (SSE-S3).</p>
|
|
3084
|
-
*
|
|
3086
|
+
* <p>If you specify a KMS key to encrypt your output, you must also specify
|
|
3085
3087
|
* an output location using the <code>OutputLocation</code> parameter.</p>
|
|
3086
|
-
*
|
|
3088
|
+
* <p>Note that the user making the request must
|
|
3087
3089
|
* have permission to use the specified KMS key.</p>
|
|
3088
3090
|
*/
|
|
3089
3091
|
OutputEncryptionKMSKeyId?: string;
|
|
@@ -3091,10 +3093,10 @@ export interface StartCallAnalyticsJobRequest {
|
|
|
3091
3093
|
* <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
|
|
3092
3094
|
* access the Amazon S3 bucket that contains your input files. If the role that you
|
|
3093
3095
|
* specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.</p>
|
|
3094
|
-
*
|
|
3096
|
+
* <p>IAM role ARNs have the format
|
|
3095
3097
|
* <code>arn:partition:iam::account:role/role-name-with-path</code>. For example:
|
|
3096
3098
|
* <code>arn:aws:iam::111122223333:role/Admin</code>.</p>
|
|
3097
|
-
*
|
|
3099
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
|
|
3098
3100
|
* ARNs</a>.</p>
|
|
3099
3101
|
*/
|
|
3100
3102
|
DataAccessRoleArn?: string;
|
|
@@ -3124,7 +3126,7 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
3124
3126
|
* specify is also used as the default name of your transcription output file. If you want
|
|
3125
3127
|
* to specify a different name for your transcription output, use the
|
|
3126
3128
|
* <code>OutputKey</code> parameter.</p>
|
|
3127
|
-
*
|
|
3129
|
+
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
3128
3130
|
* Amazon Web Services account. If you try to create a new job with the same name as an
|
|
3129
3131
|
* existing job, you get a <code>ConflictException</code> error.</p>
|
|
3130
3132
|
*/
|
|
@@ -3138,7 +3140,7 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
3138
3140
|
LanguageCode: LanguageCode | string | undefined;
|
|
3139
3141
|
/**
|
|
3140
3142
|
* <p>The sample rate, in hertz, of the audio track in your input media file.</p>
|
|
3141
|
-
*
|
|
3143
|
+
* <p>If you don't specify the media sample rate, Amazon Transcribe Medical determines it
|
|
3142
3144
|
* for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the value that you specify and the
|
|
3143
3145
|
* value detected, your job fails. Therefore, in most cases, it's advised to omit
|
|
3144
3146
|
* <code>MediaSampleRateHertz</code> and let Amazon Transcribe Medical determine the
|
|
@@ -3152,7 +3154,7 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
3152
3154
|
/**
|
|
3153
3155
|
* <p>Describes the Amazon S3 location of the media file you want to use in your
|
|
3154
3156
|
* request.</p>
|
|
3155
|
-
*
|
|
3157
|
+
* <p>For information on supported media formats, refer to the <a href="https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat">MediaFormat</a> parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
|
|
3156
3158
|
* in the Amazon S3 Developer Guide.</p>
|
|
3157
3159
|
*/
|
|
3158
3160
|
Media: Media | undefined;
|
|
@@ -3160,15 +3162,15 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
3160
3162
|
* <p>The name of the Amazon S3 bucket where you want your medical transcription
|
|
3161
3163
|
* output stored. Do not include the <code>S3://</code> prefix of the specified
|
|
3162
3164
|
* bucket.</p>
|
|
3163
|
-
*
|
|
3165
|
+
* <p>If you want your output to go to a sub-folder of this bucket, specify it using the
|
|
3164
3166
|
* <code>OutputKey</code> parameter; <code>OutputBucketName</code> only accepts the
|
|
3165
3167
|
* name of a bucket.</p>
|
|
3166
|
-
*
|
|
3168
|
+
* <p>For example, if you want your output stored in <code>S3://DOC-EXAMPLE-BUCKET</code>,
|
|
3167
3169
|
* set <code>OutputBucketName</code> to <code>DOC-EXAMPLE-BUCKET</code>. However, if you
|
|
3168
3170
|
* want your output stored in <code>S3://DOC-EXAMPLE-BUCKET/test-files/</code>, set
|
|
3169
3171
|
* <code>OutputBucketName</code> to <code>DOC-EXAMPLE-BUCKET</code> and
|
|
3170
3172
|
* <code>OutputKey</code> to <code>test-files/</code>.</p>
|
|
3171
|
-
*
|
|
3173
|
+
* <p>Note that Amazon Transcribe must have permission to use the specified location. You
|
|
3172
3174
|
* can change Amazon S3 permissions using the <a href="https://console.aws.amazon.com/s3">Amazon Web Services Management Console</a>. See also <a href="https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user">Permissions Required for IAM User Roles</a>.</p>
|
|
3173
3175
|
*/
|
|
3174
3176
|
OutputBucketName: string | undefined;
|
|
@@ -3177,81 +3179,81 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
3177
3179
|
* of your transcript and, optionally, a unique name for your output file. The default name
|
|
3178
3180
|
* for your transcription output is the same as the name you specified for your medical
|
|
3179
3181
|
* transcription job (<code>MedicalTranscriptionJobName</code>).</p>
|
|
3180
|
-
*
|
|
3181
|
-
*
|
|
3182
|
+
* <p>Here are some examples of how you can use <code>OutputKey</code>:</p>
|
|
3183
|
+
* <ul>
|
|
3182
3184
|
* <li>
|
|
3183
|
-
*
|
|
3185
|
+
* <p>If you specify 'DOC-EXAMPLE-BUCKET' as the <code>OutputBucketName</code> and
|
|
3184
3186
|
* 'my-transcript.json' as the <code>OutputKey</code>, your transcription output
|
|
3185
3187
|
* path is <code>s3://DOC-EXAMPLE-BUCKET/my-transcript.json</code>.</p>
|
|
3186
3188
|
* </li>
|
|
3187
3189
|
* <li>
|
|
3188
|
-
*
|
|
3190
|
+
* <p>If you specify 'my-first-transcription' as the
|
|
3189
3191
|
* <code>MedicalTranscriptionJobName</code>, 'DOC-EXAMPLE-BUCKET' as the
|
|
3190
3192
|
* <code>OutputBucketName</code>, and 'my-transcript' as the
|
|
3191
3193
|
* <code>OutputKey</code>, your transcription output path is
|
|
3192
3194
|
* <code>s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json</code>.</p>
|
|
3193
3195
|
* </li>
|
|
3194
3196
|
* <li>
|
|
3195
|
-
*
|
|
3197
|
+
* <p>If you specify 'DOC-EXAMPLE-BUCKET' as the <code>OutputBucketName</code> and
|
|
3196
3198
|
* 'test-files/my-transcript.json' as the <code>OutputKey</code>, your
|
|
3197
3199
|
* transcription output path is
|
|
3198
3200
|
* <code>s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json</code>.</p>
|
|
3199
3201
|
* </li>
|
|
3200
3202
|
* <li>
|
|
3201
|
-
*
|
|
3203
|
+
* <p>If you specify 'my-first-transcription' as the
|
|
3202
3204
|
* <code>MedicalTranscriptionJobName</code>, 'DOC-EXAMPLE-BUCKET' as the
|
|
3203
3205
|
* <code>OutputBucketName</code>, and 'test-files/my-transcript' as the
|
|
3204
3206
|
* <code>OutputKey</code>, your transcription output path is
|
|
3205
3207
|
* <code>s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json</code>.</p>
|
|
3206
3208
|
* </li>
|
|
3207
3209
|
* </ul>
|
|
3208
|
-
*
|
|
3210
|
+
* <p>If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist,
|
|
3209
3211
|
* one is created for you.</p>
|
|
3210
3212
|
*/
|
|
3211
3213
|
OutputKey?: string;
|
|
3212
3214
|
/**
|
|
3213
3215
|
* <p>The KMS key you want to use to encrypt your medical transcription
|
|
3214
3216
|
* output.</p>
|
|
3215
|
-
*
|
|
3217
|
+
* <p>If using a key located in the <b>current</b>
|
|
3216
3218
|
* Amazon Web Services account, you can specify your KMS key in one of four
|
|
3217
3219
|
* ways:</p>
|
|
3218
|
-
*
|
|
3220
|
+
* <ol>
|
|
3219
3221
|
* <li>
|
|
3220
|
-
*
|
|
3222
|
+
* <p>Use the KMS key ID itself. For example,
|
|
3221
3223
|
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
3222
3224
|
* </li>
|
|
3223
3225
|
* <li>
|
|
3224
|
-
*
|
|
3226
|
+
* <p>Use an alias for the KMS key ID. For example,
|
|
3225
3227
|
* <code>alias/ExampleAlias</code>.</p>
|
|
3226
3228
|
* </li>
|
|
3227
3229
|
* <li>
|
|
3228
|
-
*
|
|
3230
|
+
* <p>Use the Amazon Resource Name (ARN) for the KMS key ID. For
|
|
3229
3231
|
* example,
|
|
3230
3232
|
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
3231
3233
|
* </li>
|
|
3232
3234
|
* <li>
|
|
3233
|
-
*
|
|
3235
|
+
* <p>Use the ARN for the KMS key alias. For example,
|
|
3234
3236
|
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
|
|
3235
3237
|
* </li>
|
|
3236
3238
|
* </ol>
|
|
3237
|
-
*
|
|
3239
|
+
* <p>If using a key located in a <b>different</b>
|
|
3238
3240
|
* Amazon Web Services account than the current Amazon Web Services account, you can specify
|
|
3239
3241
|
* your KMS key in one of two ways:</p>
|
|
3240
|
-
*
|
|
3242
|
+
* <ol>
|
|
3241
3243
|
* <li>
|
|
3242
|
-
*
|
|
3244
|
+
* <p>Use the ARN for the KMS key ID. For example,
|
|
3243
3245
|
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
3244
3246
|
* </li>
|
|
3245
3247
|
* <li>
|
|
3246
|
-
*
|
|
3248
|
+
* <p>Use the ARN for the KMS key alias. For example,
|
|
3247
3249
|
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
|
|
3248
3250
|
* </li>
|
|
3249
3251
|
* </ol>
|
|
3250
|
-
*
|
|
3252
|
+
* <p>If you don't specify an encryption key, your output is encrypted with the default
|
|
3251
3253
|
* Amazon S3 key (SSE-S3).</p>
|
|
3252
|
-
*
|
|
3254
|
+
* <p>If you specify a KMS key to encrypt your output, you must also specify
|
|
3253
3255
|
* an output location using the <code>OutputLocation</code> parameter.</p>
|
|
3254
|
-
*
|
|
3256
|
+
* <p>Note that the user making the request must
|
|
3255
3257
|
* have permission to use the specified KMS key.</p>
|
|
3256
3258
|
*/
|
|
3257
3259
|
OutputEncryptionKMSKeyId?: string;
|
|
@@ -3280,7 +3282,7 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
3280
3282
|
/**
|
|
3281
3283
|
* <p>Specify whether your input media contains only one person (<code>DICTATION</code>) or
|
|
3282
3284
|
* contains a conversation between two people (<code>CONVERSATION</code>).</p>
|
|
3283
|
-
*
|
|
3285
|
+
* <p>For example, <code>DICTATION</code> could be used for a medical professional wanting
|
|
3284
3286
|
* to transcribe voice memos; <code>CONVERSATION</code> could be used for transcribing the
|
|
3285
3287
|
* doctor-patient dialogue during the patient's office visit.</p>
|
|
3286
3288
|
*/
|
|
@@ -3288,7 +3290,7 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
3288
3290
|
/**
|
|
3289
3291
|
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new medical
|
|
3290
3292
|
* transcription job at the time you start this new job.</p>
|
|
3291
|
-
*
|
|
3293
|
+
* <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
|
|
3292
3294
|
* resources</a>.</p>
|
|
3293
3295
|
*/
|
|
3294
3296
|
Tags?: Tag[];
|
|
@@ -3302,9 +3304,9 @@ export interface StartMedicalTranscriptionJobResponse {
|
|
|
3302
3304
|
}
|
|
3303
3305
|
/**
|
|
3304
3306
|
* <p>Generate subtitles for your media file with your transcription request.</p>
|
|
3305
|
-
*
|
|
3307
|
+
* <p>You can choose a start index of 0 or 1, and you can specify either WebVTT or SubRip
|
|
3306
3308
|
* (or both) as your output format.</p>
|
|
3307
|
-
*
|
|
3309
|
+
* <p>Note that your subtitle files are placed in the same location as your transcription
|
|
3308
3310
|
* output.</p>
|
|
3309
3311
|
*/
|
|
3310
3312
|
export interface Subtitles {
|
|
@@ -3316,7 +3318,7 @@ export interface Subtitles {
|
|
|
3316
3318
|
Formats?: (SubtitleFormat | string)[];
|
|
3317
3319
|
/**
|
|
3318
3320
|
* <p>Specify the starting value that is assigned to the first subtitle segment.</p>
|
|
3319
|
-
*
|
|
3321
|
+
* <p>The default start index for Amazon Transcribe is <code>0</code>, which differs from
|
|
3320
3322
|
* the more widely used standard of <code>1</code>. If you're uncertain which value to use,
|
|
3321
3323
|
* we recommend choosing <code>1</code>, as this may improve compatibility with other
|
|
3322
3324
|
* services.</p>
|
|
@@ -3329,31 +3331,31 @@ export interface StartTranscriptionJobRequest {
|
|
|
3329
3331
|
* also used as the default name of your transcription output file. If you want to specify
|
|
3330
3332
|
* a different name for your transcription output, use the <code>OutputKey</code>
|
|
3331
3333
|
* parameter.</p>
|
|
3332
|
-
*
|
|
3334
|
+
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
3333
3335
|
* Amazon Web Services account. If you try to create a new job with the same name as an
|
|
3334
3336
|
* existing job, you get a <code>ConflictException</code> error.</p>
|
|
3335
3337
|
*/
|
|
3336
3338
|
TranscriptionJobName: string | undefined;
|
|
3337
3339
|
/**
|
|
3338
3340
|
* <p>The language code that represents the language spoken in the input media file.</p>
|
|
3339
|
-
*
|
|
3341
|
+
* <p>If you're unsure of the language spoken in your media file, consider using
|
|
3340
3342
|
* <code>IdentifyLanguage</code> or <code>IdentifyMultipleLanguages</code> to enable
|
|
3341
3343
|
* automatic language identification.</p>
|
|
3342
|
-
*
|
|
3344
|
+
* <p>Note that you must include one of <code>LanguageCode</code>,
|
|
3343
3345
|
* <code>IdentifyLanguage</code>, or <code>IdentifyMultipleLanguages</code> in your
|
|
3344
3346
|
* request. If you include more than one of these parameters, your transcription job
|
|
3345
3347
|
* fails.</p>
|
|
3346
|
-
*
|
|
3348
|
+
* <p>For a list of supported languages and their associated language codes, refer to the
|
|
3347
3349
|
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
|
|
3348
|
-
*
|
|
3350
|
+
* <note>
|
|
3349
3351
|
* <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media
|
|
3350
3352
|
* file must be encoded at a sample rate of 16,000 Hz or higher.</p>
|
|
3351
|
-
*
|
|
3353
|
+
* </note>
|
|
3352
3354
|
*/
|
|
3353
3355
|
LanguageCode?: LanguageCode | string;
|
|
3354
3356
|
/**
|
|
3355
3357
|
* <p>The sample rate, in hertz, of the audio track in your input media file.</p>
|
|
3356
|
-
*
|
|
3358
|
+
* <p>If you don't specify the media sample rate, Amazon Transcribe determines it for you.
|
|
3357
3359
|
* If you specify the sample rate, it must match the rate detected by Amazon Transcribe.
|
|
3358
3360
|
* If there's a mismatch between the value that you specify and the value detected, your
|
|
3359
3361
|
* job fails. In most cases, you can omit <code>MediaSampleRateHertz</code> and let Amazon Transcribe determine the sample rate.</p>
|
|
@@ -3371,17 +3373,17 @@ export interface StartTranscriptionJobRequest {
|
|
|
3371
3373
|
/**
|
|
3372
3374
|
* <p>The name of the Amazon S3 bucket where you want your transcription output
|
|
3373
3375
|
* stored. Do not include the <code>S3://</code> prefix of the specified bucket.</p>
|
|
3374
|
-
*
|
|
3376
|
+
* <p>If you want your output to go to a sub-folder of this bucket, specify it using the
|
|
3375
3377
|
* <code>OutputKey</code> parameter; <code>OutputBucketName</code> only accepts the
|
|
3376
3378
|
* name of a bucket.</p>
|
|
3377
|
-
*
|
|
3379
|
+
* <p>For example, if you want your output stored in <code>S3://DOC-EXAMPLE-BUCKET</code>,
|
|
3378
3380
|
* set <code>OutputBucketName</code> to <code>DOC-EXAMPLE-BUCKET</code>. However, if you
|
|
3379
3381
|
* want your output stored in <code>S3://DOC-EXAMPLE-BUCKET/test-files/</code>, set
|
|
3380
3382
|
* <code>OutputBucketName</code> to <code>DOC-EXAMPLE-BUCKET</code> and
|
|
3381
3383
|
* <code>OutputKey</code> to <code>test-files/</code>.</p>
|
|
3382
|
-
*
|
|
3384
|
+
* <p>Note that Amazon Transcribe must have permission to use the specified location. You
|
|
3383
3385
|
* can change Amazon S3 permissions using the <a href="https://console.aws.amazon.com/s3">Amazon Web Services Management Console</a>. See also <a href="https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user">Permissions Required for IAM User Roles</a>.</p>
|
|
3384
|
-
*
|
|
3386
|
+
* <p>If you don't specify <code>OutputBucketName</code>, your transcript is placed in a
|
|
3385
3387
|
* service-managed Amazon S3 bucket and you are provided with a URI to access your
|
|
3386
3388
|
* transcript.</p>
|
|
3387
3389
|
*/
|
|
@@ -3391,81 +3393,81 @@ export interface StartTranscriptionJobRequest {
|
|
|
3391
3393
|
* of your transcript and, optionally, a unique name for your output file. The default name
|
|
3392
3394
|
* for your transcription output is the same as the name you specified for your
|
|
3393
3395
|
* transcription job (<code>TranscriptionJobName</code>).</p>
|
|
3394
|
-
*
|
|
3395
|
-
*
|
|
3396
|
+
* <p>Here are some examples of how you can use <code>OutputKey</code>:</p>
|
|
3397
|
+
* <ul>
|
|
3396
3398
|
* <li>
|
|
3397
|
-
*
|
|
3399
|
+
* <p>If you specify 'DOC-EXAMPLE-BUCKET' as the <code>OutputBucketName</code> and
|
|
3398
3400
|
* 'my-transcript.json' as the <code>OutputKey</code>, your transcription output
|
|
3399
3401
|
* path is <code>s3://DOC-EXAMPLE-BUCKET/my-transcript.json</code>.</p>
|
|
3400
3402
|
* </li>
|
|
3401
3403
|
* <li>
|
|
3402
|
-
*
|
|
3404
|
+
* <p>If you specify 'my-first-transcription' as the
|
|
3403
3405
|
* <code>TranscriptionJobName</code>, 'DOC-EXAMPLE-BUCKET' as the
|
|
3404
3406
|
* <code>OutputBucketName</code>, and 'my-transcript' as the
|
|
3405
3407
|
* <code>OutputKey</code>, your transcription output path is
|
|
3406
3408
|
* <code>s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json</code>.</p>
|
|
3407
3409
|
* </li>
|
|
3408
3410
|
* <li>
|
|
3409
|
-
*
|
|
3411
|
+
* <p>If you specify 'DOC-EXAMPLE-BUCKET' as the <code>OutputBucketName</code> and
|
|
3410
3412
|
* 'test-files/my-transcript.json' as the <code>OutputKey</code>, your
|
|
3411
3413
|
* transcription output path is
|
|
3412
3414
|
* <code>s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json</code>.</p>
|
|
3413
3415
|
* </li>
|
|
3414
3416
|
* <li>
|
|
3415
|
-
*
|
|
3417
|
+
* <p>If you specify 'my-first-transcription' as the
|
|
3416
3418
|
* <code>TranscriptionJobName</code>, 'DOC-EXAMPLE-BUCKET' as the
|
|
3417
3419
|
* <code>OutputBucketName</code>, and 'test-files/my-transcript' as the
|
|
3418
3420
|
* <code>OutputKey</code>, your transcription output path is
|
|
3419
3421
|
* <code>s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json</code>.</p>
|
|
3420
3422
|
* </li>
|
|
3421
3423
|
* </ul>
|
|
3422
|
-
*
|
|
3424
|
+
* <p>If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist,
|
|
3423
3425
|
* one is created for you.</p>
|
|
3424
3426
|
*/
|
|
3425
3427
|
OutputKey?: string;
|
|
3426
3428
|
/**
|
|
3427
3429
|
* <p>The KMS key you want to use to encrypt your transcription
|
|
3428
3430
|
* output.</p>
|
|
3429
|
-
*
|
|
3431
|
+
* <p>If using a key located in the <b>current</b>
|
|
3430
3432
|
* Amazon Web Services account, you can specify your KMS key in one of four
|
|
3431
3433
|
* ways:</p>
|
|
3432
|
-
*
|
|
3434
|
+
* <ol>
|
|
3433
3435
|
* <li>
|
|
3434
|
-
*
|
|
3436
|
+
* <p>Use the KMS key ID itself. For example,
|
|
3435
3437
|
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
3436
3438
|
* </li>
|
|
3437
3439
|
* <li>
|
|
3438
|
-
*
|
|
3440
|
+
* <p>Use an alias for the KMS key ID. For example,
|
|
3439
3441
|
* <code>alias/ExampleAlias</code>.</p>
|
|
3440
3442
|
* </li>
|
|
3441
3443
|
* <li>
|
|
3442
|
-
*
|
|
3444
|
+
* <p>Use the Amazon Resource Name (ARN) for the KMS key ID. For
|
|
3443
3445
|
* example,
|
|
3444
3446
|
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
3445
3447
|
* </li>
|
|
3446
3448
|
* <li>
|
|
3447
|
-
*
|
|
3449
|
+
* <p>Use the ARN for the KMS key alias. For example,
|
|
3448
3450
|
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
|
|
3449
3451
|
* </li>
|
|
3450
3452
|
* </ol>
|
|
3451
|
-
*
|
|
3453
|
+
* <p>If using a key located in a <b>different</b>
|
|
3452
3454
|
* Amazon Web Services account than the current Amazon Web Services account, you can specify
|
|
3453
3455
|
* your KMS key in one of two ways:</p>
|
|
3454
|
-
*
|
|
3456
|
+
* <ol>
|
|
3455
3457
|
* <li>
|
|
3456
|
-
*
|
|
3458
|
+
* <p>Use the ARN for the KMS key ID. For example,
|
|
3457
3459
|
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
3458
3460
|
* </li>
|
|
3459
3461
|
* <li>
|
|
3460
|
-
*
|
|
3462
|
+
* <p>Use the ARN for the KMS key alias. For example,
|
|
3461
3463
|
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
|
|
3462
3464
|
* </li>
|
|
3463
3465
|
* </ol>
|
|
3464
|
-
*
|
|
3466
|
+
* <p>If you don't specify an encryption key, your output is encrypted with the default
|
|
3465
3467
|
* Amazon S3 key (SSE-S3).</p>
|
|
3466
|
-
*
|
|
3468
|
+
* <p>If you specify a KMS key to encrypt your output, you must also specify
|
|
3467
3469
|
* an output location using the <code>OutputLocation</code> parameter.</p>
|
|
3468
|
-
*
|
|
3470
|
+
* <p>Note that the user making the request must
|
|
3469
3471
|
* have permission to use the specified KMS key.</p>
|
|
3470
3472
|
*/
|
|
3471
3473
|
OutputEncryptionKMSKeyId?: string;
|
|
@@ -3477,11 +3479,11 @@ export interface StartTranscriptionJobRequest {
|
|
|
3477
3479
|
/**
|
|
3478
3480
|
* <p>Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker
|
|
3479
3481
|
* partitioning. You can use that to apply custom vocabularies and vocabulary filters.</p>
|
|
3480
|
-
*
|
|
3482
|
+
* <p>If you want to include a custom vocabulary or a custom vocabulary filter (or both)
|
|
3481
3483
|
* with your request but <b>do not</b> want to use automatic
|
|
3482
3484
|
* language identification, use <code>Settings</code> with the <code>VocabularyName</code>
|
|
3483
3485
|
* or <code>VocabularyFilterName</code> (or both) sub-parameter.</p>
|
|
3484
|
-
*
|
|
3486
|
+
* <p>If you're using automatic language identification with your request and want to
|
|
3485
3487
|
* include a custom language model, a custom vocabulary, or a custom vocabulary filter, use
|
|
3486
3488
|
* instead the <code></code> parameter with the
|
|
3487
3489
|
* <code>LanguageModelName</code>, <code>VocabularyName</code> or
|
|
@@ -3492,7 +3494,7 @@ export interface StartTranscriptionJobRequest {
|
|
|
3492
3494
|
* <p>Specify the custom language model you want to include with your transcription job. If
|
|
3493
3495
|
* you include <code>ModelSettings</code> in your request, you must include the
|
|
3494
3496
|
* <code>LanguageModelName</code> sub-parameter.</p>
|
|
3495
|
-
*
|
|
3497
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language
|
|
3496
3498
|
* models</a>.</p>
|
|
3497
3499
|
*/
|
|
3498
3500
|
ModelSettings?: ModelSettings;
|
|
@@ -3500,7 +3502,7 @@ export interface StartTranscriptionJobRequest {
|
|
|
3500
3502
|
* <p>Makes it possible to control how your transcription job is processed. Currently, the
|
|
3501
3503
|
* only <code>JobExecutionSettings</code> modification you can choose is enabling job
|
|
3502
3504
|
* queueing using the <code>AllowDeferredExecution</code> sub-parameter.</p>
|
|
3503
|
-
*
|
|
3505
|
+
* <p>If you include <code>JobExecutionSettings</code> in your request, you must also
|
|
3504
3506
|
* include the sub-parameters: <code>AllowDeferredExecution</code> and
|
|
3505
3507
|
* <code>DataAccessRoleArn</code>.</p>
|
|
3506
3508
|
*/
|
|
@@ -3516,18 +3518,18 @@ export interface StartTranscriptionJobRequest {
|
|
|
3516
3518
|
* <p>Enables automatic language identification in your transcription job request. Use this
|
|
3517
3519
|
* parameter if your media file contains only one language. If your media contains multiple
|
|
3518
3520
|
* languages, use <code>IdentifyMultipleLanguages</code> instead.</p>
|
|
3519
|
-
*
|
|
3521
|
+
* <p>If you include <code>IdentifyLanguage</code>, you can optionally include a list of
|
|
3520
3522
|
* language codes, using <code>LanguageOptions</code>, that you think may be present in
|
|
3521
3523
|
* your media file. Including <code>LanguageOptions</code> restricts
|
|
3522
3524
|
* <code>IdentifyLanguage</code> to only the language options that you specify, which
|
|
3523
3525
|
* can improve transcription accuracy.</p>
|
|
3524
|
-
*
|
|
3526
|
+
* <p>If you want to apply a custom language model, a custom vocabulary, or a custom
|
|
3525
3527
|
* vocabulary filter to your automatic language identification request, include
|
|
3526
3528
|
* <code>LanguageIdSettings</code> with the relevant sub-parameters
|
|
3527
3529
|
* (<code>VocabularyName</code>, <code>LanguageModelName</code>, and
|
|
3528
3530
|
* <code>VocabularyFilterName</code>). If you include <code>LanguageIdSettings</code>,
|
|
3529
3531
|
* also include <code>LanguageOptions</code>.</p>
|
|
3530
|
-
*
|
|
3532
|
+
* <p>Note that you must include one of <code>LanguageCode</code>,
|
|
3531
3533
|
* <code>IdentifyLanguage</code>, or <code>IdentifyMultipleLanguages</code> in your
|
|
3532
3534
|
* request. If you include more than one of these parameters, your transcription job
|
|
3533
3535
|
* fails.</p>
|
|
@@ -3537,17 +3539,17 @@ export interface StartTranscriptionJobRequest {
|
|
|
3537
3539
|
* <p>Enables automatic multi-language identification in your transcription job request. Use
|
|
3538
3540
|
* this parameter if your media file contains more than one language. If your media
|
|
3539
3541
|
* contains only one language, use <code>IdentifyLanguage</code> instead.</p>
|
|
3540
|
-
*
|
|
3542
|
+
* <p>If you include <code>IdentifyMultipleLanguages</code>, you can optionally include a
|
|
3541
3543
|
* list of language codes, using <code>LanguageOptions</code>, that you think may be
|
|
3542
3544
|
* present in your media file. Including <code>LanguageOptions</code> restricts
|
|
3543
3545
|
* <code>IdentifyLanguage</code> to only the language options that you specify, which
|
|
3544
3546
|
* can improve transcription accuracy.</p>
|
|
3545
|
-
*
|
|
3547
|
+
* <p>If you want to apply a custom vocabulary or a custom vocabulary filter to your
|
|
3546
3548
|
* automatic language identification request, include <code>LanguageIdSettings</code> with
|
|
3547
3549
|
* the relevant sub-parameters (<code>VocabularyName</code> and
|
|
3548
3550
|
* <code>VocabularyFilterName</code>). If you include <code>LanguageIdSettings</code>,
|
|
3549
3551
|
* also include <code>LanguageOptions</code>.</p>
|
|
3550
|
-
*
|
|
3552
|
+
* <p>Note that you must include one of <code>LanguageCode</code>,
|
|
3551
3553
|
* <code>IdentifyLanguage</code>, or <code>IdentifyMultipleLanguages</code> in your
|
|
3552
3554
|
* request. If you include more than one of these parameters, your transcription job
|
|
3553
3555
|
* fails.</p>
|
|
@@ -3557,11 +3559,11 @@ export interface StartTranscriptionJobRequest {
|
|
|
3557
3559
|
* <p>You can specify two or more language codes that represent the languages you think may
|
|
3558
3560
|
* be present in your media. Including more than five is not recommended. If you're unsure
|
|
3559
3561
|
* what languages are present, do not include this parameter.</p>
|
|
3560
|
-
*
|
|
3562
|
+
* <p>If you include <code>LanguageOptions</code> in your request, you must also include
|
|
3561
3563
|
* <code>IdentifyLanguage</code>.</p>
|
|
3562
|
-
*
|
|
3564
|
+
* <p>For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported
|
|
3563
3565
|
* languages</a>.</p>
|
|
3564
|
-
*
|
|
3566
|
+
* <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media file
|
|
3565
3567
|
* must be encoded at a sample rate of 16,000 Hz or higher.</p>
|
|
3566
3568
|
*/
|
|
3567
3569
|
LanguageOptions?: (LanguageCode | string)[];
|
|
@@ -3573,7 +3575,7 @@ export interface StartTranscriptionJobRequest {
|
|
|
3573
3575
|
/**
|
|
3574
3576
|
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new
|
|
3575
3577
|
* transcription job at the time you start this new job.</p>
|
|
3576
|
-
*
|
|
3578
|
+
* <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
|
|
3577
3579
|
* resources</a>.</p>
|
|
3578
3580
|
*/
|
|
3579
3581
|
Tags?: Tag[];
|
|
@@ -3585,13 +3587,13 @@ export interface StartTranscriptionJobRequest {
|
|
|
3585
3587
|
* <code>VocabularyFilterName</code>). Note that multi-language identification
|
|
3586
3588
|
* (<code>IdentifyMultipleLanguages</code>) doesn't support custom language
|
|
3587
3589
|
* models.</p>
|
|
3588
|
-
*
|
|
3590
|
+
* <p>
|
|
3589
3591
|
* <code>LanguageIdSettings</code> supports two to five language codes. Each language
|
|
3590
3592
|
* code you include can have an associated custom language model, custom vocabulary, and
|
|
3591
3593
|
* custom vocabulary filter. The language codes that you specify must match the languages
|
|
3592
3594
|
* of the associated custom language models, custom vocabularies, and custom vocabulary
|
|
3593
3595
|
* filters.</p>
|
|
3594
|
-
*
|
|
3596
|
+
* <p>It's recommended that you include <code>LanguageOptions</code> when using
|
|
3595
3597
|
* <code>LanguageIdSettings</code> to ensure that the correct language dialect is
|
|
3596
3598
|
* identified. For example, if you specify a custom vocabulary that is in
|
|
3597
3599
|
* <code>en-US</code> but Amazon Transcribe determines that the language spoken in
|
|
@@ -3599,7 +3601,7 @@ export interface StartTranscriptionJobRequest {
|
|
|
3599
3601
|
* applied to your transcription. If you include <code>LanguageOptions</code> and include
|
|
3600
3602
|
* <code>en-US</code> as the only English language dialect, your custom vocabulary
|
|
3601
3603
|
* <i>is</i> applied to your transcription.</p>
|
|
3602
|
-
*
|
|
3604
|
+
* <p>If you want to include a custom language model with your request but <b>do not</b> want to use automatic language identification, use
|
|
3603
3605
|
* instead the <code></code> parameter with the
|
|
3604
3606
|
* <code>LanguageModelName</code> sub-parameter. If you want to include a custom
|
|
3605
3607
|
* vocabulary or a custom vocabulary filter (or both) with your request but <b>do not</b> want to use automatic language identification, use
|
|
@@ -3620,9 +3622,9 @@ export interface TagResourceRequest {
|
|
|
3620
3622
|
/**
|
|
3621
3623
|
* <p>The Amazon Resource Name (ARN) of the resource you want to tag. ARNs have the format
|
|
3622
3624
|
* <code>arn:partition:service:region:account-id:resource-type/resource-id</code>.</p>
|
|
3623
|
-
*
|
|
3625
|
+
* <p>For example,
|
|
3624
3626
|
* <code>arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name</code>.</p>
|
|
3625
|
-
*
|
|
3627
|
+
* <p>Valid values for <code>resource-type</code> are: <code>transcription-job</code>,
|
|
3626
3628
|
* <code>medical-transcription-job</code>, <code>vocabulary</code>,
|
|
3627
3629
|
* <code>medical-vocabulary</code>, <code>vocabulary-filter</code>, and
|
|
3628
3630
|
* <code>language-model</code>.</p>
|
|
@@ -3631,7 +3633,7 @@ export interface TagResourceRequest {
|
|
|
3631
3633
|
/**
|
|
3632
3634
|
* <p>Adds one or more custom tags, each in the form of a key:value pair, to the specified
|
|
3633
3635
|
* resource.</p>
|
|
3634
|
-
*
|
|
3636
|
+
* <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
|
|
3635
3637
|
* resources</a>.</p>
|
|
3636
3638
|
*/
|
|
3637
3639
|
Tags: Tag[] | undefined;
|
|
@@ -3643,9 +3645,9 @@ export interface UntagResourceRequest {
|
|
|
3643
3645
|
* <p>The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove
|
|
3644
3646
|
* tags from. ARNs have the format
|
|
3645
3647
|
* <code>arn:partition:service:region:account-id:resource-type/resource-id</code>.</p>
|
|
3646
|
-
*
|
|
3648
|
+
* <p>For example,
|
|
3647
3649
|
* <code>arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name</code>.</p>
|
|
3648
|
-
*
|
|
3650
|
+
* <p>Valid values for <code>resource-type</code> are: <code>transcription-job</code>,
|
|
3649
3651
|
* <code>medical-transcription-job</code>, <code>vocabulary</code>,
|
|
3650
3652
|
* <code>medical-vocabulary</code>, <code>vocabulary-filter</code>, and
|
|
3651
3653
|
* <code>language-model</code>.</p>
|
|
@@ -3700,7 +3702,7 @@ export interface UpdateMedicalVocabularyRequest {
|
|
|
3700
3702
|
* <p>The Amazon S3 location of the text file that contains your custom medical
|
|
3701
3703
|
* vocabulary. The URI must be located in the same Amazon Web Services Region as the
|
|
3702
3704
|
* resource you're calling.</p>
|
|
3703
|
-
*
|
|
3705
|
+
* <p>Here's an example URI path:
|
|
3704
3706
|
* <code>s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt</code>
|
|
3705
3707
|
* </p>
|
|
3706
3708
|
*/
|
|
@@ -3719,7 +3721,7 @@ export interface UpdateMedicalVocabularyResponse {
|
|
|
3719
3721
|
LanguageCode?: LanguageCode | string;
|
|
3720
3722
|
/**
|
|
3721
3723
|
* <p>The date and time the specified custom medical vocabulary was last updated.</p>
|
|
3722
|
-
*
|
|
3724
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
3723
3725
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
3724
3726
|
* 4, 2022.</p>
|
|
3725
3727
|
*/
|
|
@@ -3741,11 +3743,11 @@ export interface UpdateVocabularyRequest {
|
|
|
3741
3743
|
* <p>The language code that represents the language of the entries in the custom vocabulary
|
|
3742
3744
|
* you want to update. Each custom vocabulary must contain terms in only one
|
|
3743
3745
|
* language.</p>
|
|
3744
|
-
*
|
|
3746
|
+
* <p>A custom vocabulary can only be used to transcribe files in the same language as the
|
|
3745
3747
|
* custom vocabulary. For example, if you create a custom vocabulary using US English
|
|
3746
3748
|
* (<code>en-US</code>), you can only apply this custom vocabulary to files that
|
|
3747
3749
|
* contain English audio.</p>
|
|
3748
|
-
*
|
|
3750
|
+
* <p>For a list of supported languages and their associated language codes, refer to the
|
|
3749
3751
|
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
|
|
3750
3752
|
*/
|
|
3751
3753
|
LanguageCode: LanguageCode | string | undefined;
|
|
@@ -3755,9 +3757,9 @@ export interface UpdateVocabularyRequest {
|
|
|
3755
3757
|
* updating your custom vocabulary is to save your entries in a text file and upload them
|
|
3756
3758
|
* to an Amazon S3 bucket, then specify the location of your file using the
|
|
3757
3759
|
* <code>VocabularyFileUri</code> parameter.</p>
|
|
3758
|
-
*
|
|
3760
|
+
* <p>Note that if you include <code>Phrases</code> in your request, you cannot use
|
|
3759
3761
|
* <code>VocabularyFileUri</code>; you must choose one or the other.</p>
|
|
3760
|
-
*
|
|
3762
|
+
* <p>Each language has a character set that contains all allowed characters for that
|
|
3761
3763
|
* specific language. If you use unsupported characters, your custom vocabulary filter
|
|
3762
3764
|
* request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
|
|
3763
3765
|
* Vocabularies</a> to get the character set for your language.</p>
|
|
@@ -3767,10 +3769,10 @@ export interface UpdateVocabularyRequest {
|
|
|
3767
3769
|
* <p>The Amazon S3 location of the text file that contains your custom vocabulary.
|
|
3768
3770
|
* The URI must be located in the same Amazon Web Services Region as the resource you're
|
|
3769
3771
|
* calling.</p>
|
|
3770
|
-
*
|
|
3772
|
+
* <p>Here's an example URI path:
|
|
3771
3773
|
* <code>s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt</code>
|
|
3772
3774
|
* </p>
|
|
3773
|
-
*
|
|
3775
|
+
* <p>Note that if you include <code>VocabularyFileUri</code> in your request, you cannot
|
|
3774
3776
|
* use the <code>Phrases</code> flag; you must choose one or the other.</p>
|
|
3775
3777
|
*/
|
|
3776
3778
|
VocabularyFileUri?: string;
|
|
@@ -3786,7 +3788,7 @@ export interface UpdateVocabularyResponse {
|
|
|
3786
3788
|
LanguageCode?: LanguageCode | string;
|
|
3787
3789
|
/**
|
|
3788
3790
|
* <p>The date and time the specified custom vocabulary was last updated.</p>
|
|
3789
|
-
*
|
|
3791
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
3790
3792
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
3791
3793
|
* 4, 2022.</p>
|
|
3792
3794
|
*/
|
|
@@ -3810,9 +3812,9 @@ export interface UpdateVocabularyFilterRequest {
|
|
|
3810
3812
|
* updating your vocabulary filter is to save your entries in a text file and upload them
|
|
3811
3813
|
* to an Amazon S3 bucket, then specify the location of your file using the
|
|
3812
3814
|
* <code>VocabularyFilterFileUri</code> parameter.</p>
|
|
3813
|
-
*
|
|
3815
|
+
* <p>Note that if you include <code>Words</code> in your request, you cannot use
|
|
3814
3816
|
* <code>VocabularyFilterFileUri</code>; you must choose one or the other.</p>
|
|
3815
|
-
*
|
|
3817
|
+
* <p>Each language has a character set that contains all allowed characters for that
|
|
3816
3818
|
* specific language. If you use unsupported characters, your custom vocabulary filter
|
|
3817
3819
|
* request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
|
|
3818
3820
|
* Vocabularies</a> to get the character set for your language.</p>
|
|
@@ -3822,10 +3824,10 @@ export interface UpdateVocabularyFilterRequest {
|
|
|
3822
3824
|
* <p>The Amazon S3 location of the text file that contains your custom vocabulary
|
|
3823
3825
|
* filter terms. The URI must be located in the same Amazon Web Services Region as the
|
|
3824
3826
|
* resource you're calling.</p>
|
|
3825
|
-
*
|
|
3827
|
+
* <p>Here's an example URI path:
|
|
3826
3828
|
* <code>s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt</code>
|
|
3827
3829
|
* </p>
|
|
3828
|
-
*
|
|
3830
|
+
* <p>Note that if you include <code>VocabularyFilterFileUri</code> in your request, you
|
|
3829
3831
|
* cannot use <code>Words</code>; you must choose one or the other.</p>
|
|
3830
3832
|
*/
|
|
3831
3833
|
VocabularyFilterFileUri?: string;
|
|
@@ -3841,7 +3843,7 @@ export interface UpdateVocabularyFilterResponse {
|
|
|
3841
3843
|
LanguageCode?: LanguageCode | string;
|
|
3842
3844
|
/**
|
|
3843
3845
|
* <p>The date and time the specified custom vocabulary filter was last updated.</p>
|
|
3844
|
-
*
|
|
3846
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
3845
3847
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
3846
3848
|
* 4, 2022.</p>
|
|
3847
3849
|
*/
|