@aws-sdk/client-transcribe 3.454.0 → 3.459.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/README.md +71 -39
- package/dist-cjs/Transcribe.js +8 -0
- package/dist-cjs/commands/DeleteMedicalScribeJobCommand.js +51 -0
- package/dist-cjs/commands/GetMedicalScribeJobCommand.js +51 -0
- package/dist-cjs/commands/ListMedicalScribeJobsCommand.js +51 -0
- package/dist-cjs/commands/StartMedicalScribeJobCommand.js +51 -0
- package/dist-cjs/commands/index.js +4 -0
- package/dist-cjs/models/models_0.js +78 -1
- package/dist-cjs/pagination/ListMedicalScribeJobsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_json1_1.js +242 -2
- package/dist-es/Transcribe.js +8 -0
- package/dist-es/commands/DeleteMedicalScribeJobCommand.js +47 -0
- package/dist-es/commands/GetMedicalScribeJobCommand.js +47 -0
- package/dist-es/commands/ListMedicalScribeJobsCommand.js +47 -0
- package/dist-es/commands/StartMedicalScribeJobCommand.js +47 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/models_0.js +77 -0
- package/dist-es/pagination/ListMedicalScribeJobsPaginator.js +25 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +232 -0
- package/dist-types/Transcribe.d.ts +28 -0
- package/dist-types/TranscribeClient.d.ts +6 -2
- package/dist-types/commands/CreateMedicalVocabularyCommand.d.ts +2 -2
- package/dist-types/commands/CreateVocabularyCommand.d.ts +2 -2
- package/dist-types/commands/CreateVocabularyFilterCommand.d.ts +2 -2
- package/dist-types/commands/DeleteMedicalScribeJobCommand.d.ts +87 -0
- package/dist-types/commands/GetCallAnalyticsJobCommand.d.ts +5 -2
- package/dist-types/commands/GetMedicalScribeJobCommand.d.ts +135 -0
- package/dist-types/commands/GetMedicalTranscriptionJobCommand.d.ts +1 -1
- package/dist-types/commands/GetMedicalVocabularyCommand.d.ts +1 -1
- package/dist-types/commands/GetTranscriptionJobCommand.d.ts +3 -3
- package/dist-types/commands/GetVocabularyCommand.d.ts +1 -1
- package/dist-types/commands/GetVocabularyFilterCommand.d.ts +1 -1
- package/dist-types/commands/ListCallAnalyticsJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListMedicalScribeJobsCommand.d.ts +104 -0
- package/dist-types/commands/ListMedicalTranscriptionJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListMedicalVocabulariesCommand.d.ts +1 -1
- package/dist-types/commands/ListTranscriptionJobsCommand.d.ts +2 -2
- 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 +9 -3
- package/dist-types/commands/StartMedicalScribeJobCommand.d.ts +203 -0
- package/dist-types/commands/StartMedicalTranscriptionJobCommand.d.ts +3 -3
- package/dist-types/commands/StartTranscriptionJobCommand.d.ts +6 -6
- package/dist-types/commands/UpdateMedicalVocabularyCommand.d.ts +2 -2
- package/dist-types/commands/UpdateVocabularyCommand.d.ts +2 -2
- package/dist-types/commands/UpdateVocabularyFilterCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/models_0.d.ts +709 -77
- package/dist-types/pagination/ListMedicalScribeJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +36 -0
- package/dist-types/ts3.4/Transcribe.d.ts +68 -0
- package/dist-types/ts3.4/TranscribeClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/DeleteMedicalScribeJobCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/GetMedicalScribeJobCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListMedicalScribeJobsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/StartMedicalScribeJobCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/models_0.d.ts +161 -0
- package/dist-types/ts3.4/pagination/ListMedicalScribeJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +48 -0
- package/package.json +3 -3
|
@@ -124,12 +124,26 @@ export interface ChannelDefinition {
|
|
|
124
124
|
* @enum
|
|
125
125
|
*/
|
|
126
126
|
export declare const LanguageCode: {
|
|
127
|
+
readonly AB_GE: "ab-GE";
|
|
127
128
|
readonly AF_ZA: "af-ZA";
|
|
128
129
|
readonly AR_AE: "ar-AE";
|
|
129
130
|
readonly AR_SA: "ar-SA";
|
|
131
|
+
readonly AST_ES: "ast-ES";
|
|
132
|
+
readonly AZ_AZ: "az-AZ";
|
|
133
|
+
readonly BA_RU: "ba-RU";
|
|
134
|
+
readonly BE_BY: "be-BY";
|
|
135
|
+
readonly BG_BG: "bg-BG";
|
|
136
|
+
readonly BN_IN: "bn-IN";
|
|
137
|
+
readonly BS_BA: "bs-BA";
|
|
138
|
+
readonly CA_ES: "ca-ES";
|
|
139
|
+
readonly CKB_IQ: "ckb-IQ";
|
|
140
|
+
readonly CKB_IR: "ckb-IR";
|
|
141
|
+
readonly CS_CZ: "cs-CZ";
|
|
142
|
+
readonly CY_WL: "cy-WL";
|
|
130
143
|
readonly DA_DK: "da-DK";
|
|
131
144
|
readonly DE_CH: "de-CH";
|
|
132
145
|
readonly DE_DE: "de-DE";
|
|
146
|
+
readonly EL_GR: "el-GR";
|
|
133
147
|
readonly EN_AB: "en-AB";
|
|
134
148
|
readonly EN_AU: "en-AU";
|
|
135
149
|
readonly EN_GB: "en-GB";
|
|
@@ -141,28 +155,78 @@ export declare const LanguageCode: {
|
|
|
141
155
|
readonly EN_ZA: "en-ZA";
|
|
142
156
|
readonly ES_ES: "es-ES";
|
|
143
157
|
readonly ES_US: "es-US";
|
|
158
|
+
readonly ET_ET: "et-ET";
|
|
159
|
+
readonly EU_ES: "eu-ES";
|
|
144
160
|
readonly FA_IR: "fa-IR";
|
|
161
|
+
readonly FI_FI: "fi-FI";
|
|
145
162
|
readonly FR_CA: "fr-CA";
|
|
146
163
|
readonly FR_FR: "fr-FR";
|
|
164
|
+
readonly GL_ES: "gl-ES";
|
|
165
|
+
readonly GU_IN: "gu-IN";
|
|
166
|
+
readonly HA_NG: "ha-NG";
|
|
147
167
|
readonly HE_IL: "he-IL";
|
|
148
168
|
readonly HI_IN: "hi-IN";
|
|
169
|
+
readonly HR_HR: "hr-HR";
|
|
170
|
+
readonly HU_HU: "hu-HU";
|
|
171
|
+
readonly HY_AM: "hy-AM";
|
|
149
172
|
readonly ID_ID: "id-ID";
|
|
173
|
+
readonly IS_IS: "is-IS";
|
|
150
174
|
readonly IT_IT: "it-IT";
|
|
151
175
|
readonly JA_JP: "ja-JP";
|
|
176
|
+
readonly KAB_DZ: "kab-DZ";
|
|
177
|
+
readonly KA_GE: "ka-GE";
|
|
178
|
+
readonly KK_KZ: "kk-KZ";
|
|
179
|
+
readonly KN_IN: "kn-IN";
|
|
152
180
|
readonly KO_KR: "ko-KR";
|
|
181
|
+
readonly KY_KG: "ky-KG";
|
|
182
|
+
readonly LG_IN: "lg-IN";
|
|
183
|
+
readonly LT_LT: "lt-LT";
|
|
184
|
+
readonly LV_LV: "lv-LV";
|
|
185
|
+
readonly MHR_RU: "mhr-RU";
|
|
186
|
+
readonly MI_NZ: "mi-NZ";
|
|
187
|
+
readonly MK_MK: "mk-MK";
|
|
188
|
+
readonly ML_IN: "ml-IN";
|
|
189
|
+
readonly MN_MN: "mn-MN";
|
|
190
|
+
readonly MR_IN: "mr-IN";
|
|
153
191
|
readonly MS_MY: "ms-MY";
|
|
192
|
+
readonly MT_MT: "mt-MT";
|
|
154
193
|
readonly NL_NL: "nl-NL";
|
|
194
|
+
readonly NO_NO: "no-NO";
|
|
195
|
+
readonly OR_IN: "or-IN";
|
|
196
|
+
readonly PA_IN: "pa-IN";
|
|
197
|
+
readonly PL_PL: "pl-PL";
|
|
198
|
+
readonly PS_AF: "ps-AF";
|
|
155
199
|
readonly PT_BR: "pt-BR";
|
|
156
200
|
readonly PT_PT: "pt-PT";
|
|
201
|
+
readonly RO_RO: "ro-RO";
|
|
157
202
|
readonly RU_RU: "ru-RU";
|
|
203
|
+
readonly RW_RW: "rw-RW";
|
|
204
|
+
readonly SI_LK: "si-LK";
|
|
205
|
+
readonly SK_SK: "sk-SK";
|
|
206
|
+
readonly SL_SI: "sl-SI";
|
|
207
|
+
readonly SO_SO: "so-SO";
|
|
208
|
+
readonly SR_RS: "sr-RS";
|
|
209
|
+
readonly SU_ID: "su-ID";
|
|
158
210
|
readonly SV_SE: "sv-SE";
|
|
211
|
+
readonly SW_BI: "sw-BI";
|
|
212
|
+
readonly SW_KE: "sw-KE";
|
|
213
|
+
readonly SW_RW: "sw-RW";
|
|
214
|
+
readonly SW_TZ: "sw-TZ";
|
|
215
|
+
readonly SW_UG: "sw-UG";
|
|
159
216
|
readonly TA_IN: "ta-IN";
|
|
160
217
|
readonly TE_IN: "te-IN";
|
|
161
218
|
readonly TH_TH: "th-TH";
|
|
219
|
+
readonly TL_PH: "tl-PH";
|
|
162
220
|
readonly TR_TR: "tr-TR";
|
|
221
|
+
readonly TT_RU: "tt-RU";
|
|
222
|
+
readonly UG_CN: "ug-CN";
|
|
223
|
+
readonly UK_UA: "uk-UA";
|
|
224
|
+
readonly UZ_UZ: "uz-UZ";
|
|
163
225
|
readonly VI_VN: "vi-VN";
|
|
226
|
+
readonly WO_SN: "wo-SN";
|
|
164
227
|
readonly ZH_CN: "zh-CN";
|
|
165
228
|
readonly ZH_TW: "zh-TW";
|
|
229
|
+
readonly ZU_ZA: "zu-ZA";
|
|
166
230
|
};
|
|
167
231
|
/**
|
|
168
232
|
* @public
|
|
@@ -172,7 +236,8 @@ export type LanguageCode = (typeof LanguageCode)[keyof typeof LanguageCode];
|
|
|
172
236
|
* @public
|
|
173
237
|
* <p>Describes the Amazon S3 location of the media file you want to use in your
|
|
174
238
|
* request.</p>
|
|
175
|
-
* <p>For information on supported media formats, refer to the <
|
|
239
|
+
* <p>For information on supported media formats, refer to the <code>MediaFormat</code>
|
|
240
|
+
* parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
|
|
176
241
|
* in the Amazon S3 Developer Guide.</p>
|
|
177
242
|
*/
|
|
178
243
|
export interface Media {
|
|
@@ -290,17 +355,19 @@ export declare const RedactionType: {
|
|
|
290
355
|
export type RedactionType = (typeof RedactionType)[keyof typeof RedactionType];
|
|
291
356
|
/**
|
|
292
357
|
* @public
|
|
293
|
-
* <p>Makes it possible to redact or flag specified personally identifiable information
|
|
294
|
-
*
|
|
295
|
-
*
|
|
296
|
-
*
|
|
358
|
+
* <p>Makes it possible to redact or flag specified personally identifiable information (PII) in
|
|
359
|
+
* your transcript. If you use <code>ContentRedaction</code>, you must also include the
|
|
360
|
+
* sub-parameters: <code>RedactionOutput</code> and <code>RedactionType</code>. You can
|
|
361
|
+
* optionally include <code>PiiEntityTypes</code> to choose which types of PII you want to
|
|
362
|
+
* redact.</p>
|
|
297
363
|
*/
|
|
298
364
|
export interface ContentRedaction {
|
|
299
365
|
/**
|
|
300
366
|
* @public
|
|
301
367
|
* <p>Specify the category of information you want to redact; <code>PII</code> (personally
|
|
302
|
-
* identifiable information) is the only valid value. You can use
|
|
303
|
-
*
|
|
368
|
+
* identifiable information) is the only valid value. You can use <code>PiiEntityTypes</code> to
|
|
369
|
+
* choose which types of PII you want to redact. If you do not include <code>PiiEntityTypes</code> in
|
|
370
|
+
* your request, all PII is redacted.</p>
|
|
304
371
|
*/
|
|
305
372
|
RedactionType: RedactionType | undefined;
|
|
306
373
|
/**
|
|
@@ -318,7 +385,8 @@ export interface ContentRedaction {
|
|
|
318
385
|
* @public
|
|
319
386
|
* <p>Specify which types of personally identifiable information (PII) you want to redact in
|
|
320
387
|
* your transcript. You can include as many types as you'd like, or you can select
|
|
321
|
-
*
|
|
388
|
+
* <code>ALL</code>. If you do not include <code>PiiEntityTypes</code> in your request, all PII is
|
|
389
|
+
* redacted.</p>
|
|
322
390
|
*/
|
|
323
391
|
PiiEntityTypes?: PiiEntityType[];
|
|
324
392
|
}
|
|
@@ -359,7 +427,7 @@ export interface LanguageIdSettings {
|
|
|
359
427
|
* <p>The name of the custom vocabulary you want to use when processing your transcription
|
|
360
428
|
* job. Custom vocabulary names are case sensitive.</p>
|
|
361
429
|
* <p>The language of the specified custom vocabulary must match the language code that you
|
|
362
|
-
* specify in your transcription request. If the languages
|
|
430
|
+
* specify in your transcription request. If the languages do not match, the custom
|
|
363
431
|
* vocabulary isn't applied. There are no errors or warnings associated with a language
|
|
364
432
|
* mismatch.</p>
|
|
365
433
|
*/
|
|
@@ -369,7 +437,7 @@ export interface LanguageIdSettings {
|
|
|
369
437
|
* <p>The name of the custom vocabulary filter you want to use when processing your
|
|
370
438
|
* transcription job. Custom vocabulary filter names are case sensitive.</p>
|
|
371
439
|
* <p>The language of the specified custom vocabulary filter must match the language code
|
|
372
|
-
* that you specify in your transcription request. If the languages
|
|
440
|
+
* that you specify in your transcription request. If the languages do not match, the custom
|
|
373
441
|
* vocabulary filter isn't applied. There are no errors or warnings associated with a
|
|
374
442
|
* language mismatch.</p>
|
|
375
443
|
* <p>Note that if you include <code>VocabularyFilterName</code> in your request, you must
|
|
@@ -381,12 +449,28 @@ export interface LanguageIdSettings {
|
|
|
381
449
|
* <p>The name of the custom language model you want to use when processing your
|
|
382
450
|
* transcription job. Note that custom language model names are case sensitive.</p>
|
|
383
451
|
* <p>The language of the specified custom language model must match the language code that
|
|
384
|
-
* you specify in your transcription request. If the languages
|
|
452
|
+
* you specify in your transcription request. If the languages do not match, the custom
|
|
385
453
|
* language model isn't applied. There are no errors or warnings associated with a language
|
|
386
454
|
* mismatch.</p>
|
|
387
455
|
*/
|
|
388
456
|
LanguageModelName?: string;
|
|
389
457
|
}
|
|
458
|
+
/**
|
|
459
|
+
* @public
|
|
460
|
+
* <p>Contains <code>GenerateAbstractiveSummary</code>, which is a required parameter if you
|
|
461
|
+
* want to enable Generative call summarization in your Call Analytics request.</p>
|
|
462
|
+
*/
|
|
463
|
+
export interface Summarization {
|
|
464
|
+
/**
|
|
465
|
+
* @public
|
|
466
|
+
* <p>Enables Generative call summarization in your Call Analytics request</p>
|
|
467
|
+
* <p>Generative call summarization provides a summary of the transcript including important
|
|
468
|
+
* components discussed in the conversation.</p>
|
|
469
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-enable-summarization.html">Enabling generative call
|
|
470
|
+
* summarization</a>.</p>
|
|
471
|
+
*/
|
|
472
|
+
GenerateAbstractiveSummary: boolean | undefined;
|
|
473
|
+
}
|
|
390
474
|
/**
|
|
391
475
|
* @public
|
|
392
476
|
* @enum
|
|
@@ -434,17 +518,18 @@ export interface CallAnalyticsJobSettings {
|
|
|
434
518
|
* <p>The name of the custom language model you want to use when processing your Call
|
|
435
519
|
* Analytics job. Note that custom language model names are case sensitive.</p>
|
|
436
520
|
* <p>The language of the specified custom language model must match the language code that
|
|
437
|
-
* you specify in your transcription request. If the languages
|
|
521
|
+
* you specify in your transcription request. If the languages do not match, the custom
|
|
438
522
|
* language model isn't applied. There are no errors or warnings associated with a language
|
|
439
523
|
* mismatch.</p>
|
|
440
524
|
*/
|
|
441
525
|
LanguageModelName?: string;
|
|
442
526
|
/**
|
|
443
527
|
* @public
|
|
444
|
-
* <p>Makes it possible to redact or flag specified personally identifiable information
|
|
445
|
-
*
|
|
446
|
-
*
|
|
447
|
-
*
|
|
528
|
+
* <p>Makes it possible to redact or flag specified personally identifiable information (PII) in
|
|
529
|
+
* your transcript. If you use <code>ContentRedaction</code>, you must also include the
|
|
530
|
+
* sub-parameters: <code>RedactionOutput</code> and <code>RedactionType</code>. You can
|
|
531
|
+
* optionally include <code>PiiEntityTypes</code> to choose which types of PII you want to
|
|
532
|
+
* redact.</p>
|
|
448
533
|
*/
|
|
449
534
|
ContentRedaction?: ContentRedaction;
|
|
450
535
|
/**
|
|
@@ -489,6 +574,12 @@ export interface CallAnalyticsJobSettings {
|
|
|
489
574
|
* language-specific features</a>.</p>
|
|
490
575
|
*/
|
|
491
576
|
LanguageIdSettings?: Partial<Record<LanguageCode, LanguageIdSettings>>;
|
|
577
|
+
/**
|
|
578
|
+
* @public
|
|
579
|
+
* <p>Contains <code>GenerateAbstractiveSummary</code>, which is a required parameter if you
|
|
580
|
+
* want to enable Generative call summarization in your Call Analytics request.</p>
|
|
581
|
+
*/
|
|
582
|
+
Summarization?: Summarization;
|
|
492
583
|
}
|
|
493
584
|
/**
|
|
494
585
|
* @public
|
|
@@ -572,7 +663,7 @@ export interface CallAnalyticsJob {
|
|
|
572
663
|
* <p>The language code used to create your Call Analytics job. For a list of supported
|
|
573
664
|
* 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>
|
|
574
665
|
* table.</p>
|
|
575
|
-
* <p>If you
|
|
666
|
+
* <p>If you do not know the language spoken in your media file, you can omit this field and
|
|
576
667
|
* let Amazon Transcribe automatically identify the language of your media. To improve the
|
|
577
668
|
* accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.</p>
|
|
578
669
|
*/
|
|
@@ -634,7 +725,7 @@ export interface CallAnalyticsJob {
|
|
|
634
725
|
* <p>
|
|
635
726
|
* <code>Unsupported media format</code>.</p>
|
|
636
727
|
* <p>The media format specified in <code>MediaFormat</code> isn't valid. Refer to
|
|
637
|
-
*
|
|
728
|
+
* refer to the <code>MediaFormat</code> parameter for a list of supported
|
|
638
729
|
* formats.</p>
|
|
639
730
|
* </li>
|
|
640
731
|
* <li>
|
|
@@ -663,14 +754,14 @@ export interface CallAnalyticsJob {
|
|
|
663
754
|
* <p>
|
|
664
755
|
* <code>Invalid file size: file size too large</code>.</p>
|
|
665
756
|
* <p>The size of your media file is larger than what Amazon Transcribe can
|
|
666
|
-
* process. For more information, refer to <a href="https://docs.aws.amazon.com/
|
|
757
|
+
* process. For more information, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe">Service
|
|
667
758
|
* quotas</a>.</p>
|
|
668
759
|
* </li>
|
|
669
760
|
* <li>
|
|
670
761
|
* <p>
|
|
671
762
|
* <code>Invalid number of channels: number of channels too large</code>.</p>
|
|
672
763
|
* <p>Your audio contains more channels than Amazon Transcribe is able to process.
|
|
673
|
-
* For more information, refer to <a href="https://docs.aws.amazon.com/
|
|
764
|
+
* For more information, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe">Service
|
|
674
765
|
* quotas</a>.</p>
|
|
675
766
|
* </li>
|
|
676
767
|
* </ul>
|
|
@@ -1367,10 +1458,8 @@ export interface CreateLanguageModelRequest {
|
|
|
1367
1458
|
* model must contain terms in only one language, and the language you select for your
|
|
1368
1459
|
* custom language model must match the language of your training and tuning data.</p>
|
|
1369
1460
|
* <p>For a list of supported languages and their associated language codes, refer to the
|
|
1370
|
-
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table. Note that
|
|
1371
|
-
*
|
|
1372
|
-
* (<code>en-US</code>) is the only language supported with Amazon Transcribe
|
|
1373
|
-
* Medical.</p>
|
|
1461
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table. Note that US English (<code>en-US</code>) is the
|
|
1462
|
+
* only language supported with Amazon Transcribe Medical.</p>
|
|
1374
1463
|
* <p>A custom language model can only be used to transcribe files in the same language as
|
|
1375
1464
|
* the model. For example, if you create a custom language model using US English
|
|
1376
1465
|
* (<code>en-US</code>), you can only apply this model to files that contain English
|
|
@@ -1820,6 +1909,17 @@ export interface DeleteLanguageModelRequest {
|
|
|
1820
1909
|
*/
|
|
1821
1910
|
ModelName: string | undefined;
|
|
1822
1911
|
}
|
|
1912
|
+
/**
|
|
1913
|
+
* @public
|
|
1914
|
+
*/
|
|
1915
|
+
export interface DeleteMedicalScribeJobRequest {
|
|
1916
|
+
/**
|
|
1917
|
+
* @public
|
|
1918
|
+
* <p>The name of the Medical Scribe job you want to delete. Job names are case
|
|
1919
|
+
* sensitive.</p>
|
|
1920
|
+
*/
|
|
1921
|
+
MedicalScribeJobName: string | undefined;
|
|
1922
|
+
}
|
|
1823
1923
|
/**
|
|
1824
1924
|
* @public
|
|
1825
1925
|
*/
|
|
@@ -1946,7 +2046,7 @@ export interface LanguageModel {
|
|
|
1946
2046
|
* model must contain terms in only one language, and the language you select for your
|
|
1947
2047
|
* custom language model must match the language of your training and tuning data.</p>
|
|
1948
2048
|
* <p>For a list of supported languages and their associated language codes, refer to the
|
|
1949
|
-
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table. Note that
|
|
2049
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table. Note that US English (<code>en-US</code>) is
|
|
1950
2050
|
* the only language supported with Amazon Transcribe Medical.</p>
|
|
1951
2051
|
*/
|
|
1952
2052
|
LanguageCode?: CLMLanguageCode;
|
|
@@ -2050,6 +2150,290 @@ export interface GetCallAnalyticsJobResponse {
|
|
|
2050
2150
|
*/
|
|
2051
2151
|
CallAnalyticsJob?: CallAnalyticsJob;
|
|
2052
2152
|
}
|
|
2153
|
+
/**
|
|
2154
|
+
* @public
|
|
2155
|
+
*/
|
|
2156
|
+
export interface GetMedicalScribeJobRequest {
|
|
2157
|
+
/**
|
|
2158
|
+
* @public
|
|
2159
|
+
* <p>The name of the Medical Scribe job you want information about. Job names are
|
|
2160
|
+
* case sensitive.</p>
|
|
2161
|
+
*/
|
|
2162
|
+
MedicalScribeJobName: string | undefined;
|
|
2163
|
+
}
|
|
2164
|
+
/**
|
|
2165
|
+
* @public
|
|
2166
|
+
* @enum
|
|
2167
|
+
*/
|
|
2168
|
+
export declare const MedicalScribeParticipantRole: {
|
|
2169
|
+
readonly CLINICIAN: "CLINICIAN";
|
|
2170
|
+
readonly PATIENT: "PATIENT";
|
|
2171
|
+
};
|
|
2172
|
+
/**
|
|
2173
|
+
* @public
|
|
2174
|
+
*/
|
|
2175
|
+
export type MedicalScribeParticipantRole = (typeof MedicalScribeParticipantRole)[keyof typeof MedicalScribeParticipantRole];
|
|
2176
|
+
/**
|
|
2177
|
+
* @public
|
|
2178
|
+
* <p>Indicates which speaker is on which channel. The options are
|
|
2179
|
+
* <code>CLINICIAN</code> and <code>PATIENT</code>
|
|
2180
|
+
* </p>
|
|
2181
|
+
*/
|
|
2182
|
+
export interface MedicalScribeChannelDefinition {
|
|
2183
|
+
/**
|
|
2184
|
+
* @public
|
|
2185
|
+
* <p>Specify the audio channel you want to define.</p>
|
|
2186
|
+
*/
|
|
2187
|
+
ChannelId: number | undefined;
|
|
2188
|
+
/**
|
|
2189
|
+
* @public
|
|
2190
|
+
* <p>Specify the participant that you want to flag.
|
|
2191
|
+
* The options are <code>CLINICIAN</code> and <code>PATIENT</code>
|
|
2192
|
+
* </p>
|
|
2193
|
+
*/
|
|
2194
|
+
ParticipantRole: MedicalScribeParticipantRole | undefined;
|
|
2195
|
+
}
|
|
2196
|
+
/**
|
|
2197
|
+
* @public
|
|
2198
|
+
* @enum
|
|
2199
|
+
*/
|
|
2200
|
+
export declare const MedicalScribeLanguageCode: {
|
|
2201
|
+
readonly EN_US: "en-US";
|
|
2202
|
+
};
|
|
2203
|
+
/**
|
|
2204
|
+
* @public
|
|
2205
|
+
*/
|
|
2206
|
+
export type MedicalScribeLanguageCode = (typeof MedicalScribeLanguageCode)[keyof typeof MedicalScribeLanguageCode];
|
|
2207
|
+
/**
|
|
2208
|
+
* @public
|
|
2209
|
+
* @enum
|
|
2210
|
+
*/
|
|
2211
|
+
export declare const MedicalScribeJobStatus: {
|
|
2212
|
+
readonly COMPLETED: "COMPLETED";
|
|
2213
|
+
readonly FAILED: "FAILED";
|
|
2214
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
2215
|
+
readonly QUEUED: "QUEUED";
|
|
2216
|
+
};
|
|
2217
|
+
/**
|
|
2218
|
+
* @public
|
|
2219
|
+
*/
|
|
2220
|
+
export type MedicalScribeJobStatus = (typeof MedicalScribeJobStatus)[keyof typeof MedicalScribeJobStatus];
|
|
2221
|
+
/**
|
|
2222
|
+
* @public
|
|
2223
|
+
* <p>The location of the output of your Medical Scribe job.
|
|
2224
|
+
* <code>ClinicalDocumentUri</code> holds the Amazon S3 URI for the Clinical Document
|
|
2225
|
+
* and <code>TranscriptFileUri</code> holds the Amazon S3 URI for the Transcript.</p>
|
|
2226
|
+
*/
|
|
2227
|
+
export interface MedicalScribeOutput {
|
|
2228
|
+
/**
|
|
2229
|
+
* @public
|
|
2230
|
+
* <p>Holds the Amazon S3 URI for the Transcript.</p>
|
|
2231
|
+
*/
|
|
2232
|
+
TranscriptFileUri: string | undefined;
|
|
2233
|
+
/**
|
|
2234
|
+
* @public
|
|
2235
|
+
* <p>Holds the Amazon S3 URI for the Clinical Document.</p>
|
|
2236
|
+
*/
|
|
2237
|
+
ClinicalDocumentUri: string | undefined;
|
|
2238
|
+
}
|
|
2239
|
+
/**
|
|
2240
|
+
* @public
|
|
2241
|
+
* <p>Makes it possible to control how your Medical Scribe job is processed using a
|
|
2242
|
+
* <code>MedicalScribeSettings</code> object. Specify <code>ChannelIdentification</code> if
|
|
2243
|
+
* <code>ChannelDefinitions</code> are set. Enabled <code>ShowSpeakerLabels</code> if <code>ChannelIdentification</code>
|
|
2244
|
+
* and <code>ChannelDefinitions</code> are not set. One and only one of <code>ChannelIdentification</code> and <code>ShowSpeakerLabels</code>
|
|
2245
|
+
* must be set. If <code>ShowSpeakerLabels</code> is set, <code>MaxSpeakerLabels</code> must also be set. Use <code>Settings</code>
|
|
2246
|
+
* to specify a vocabulary or vocabulary filter or both using <code>VocabularyName</code>, <code>VocabularyFilterName</code>.
|
|
2247
|
+
* <code>VocabularyFilterMethod</code> must be specified if <code>VocabularyFilterName</code> is set.
|
|
2248
|
+
* </p>
|
|
2249
|
+
*/
|
|
2250
|
+
export interface MedicalScribeSettings {
|
|
2251
|
+
/**
|
|
2252
|
+
* @public
|
|
2253
|
+
* <p>Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker
|
|
2254
|
+
* partitioning labels the speech from individual speakers in your media file.</p>
|
|
2255
|
+
* <p>If you enable <code>ShowSpeakerLabels</code> in your request, you must also include
|
|
2256
|
+
* <code>MaxSpeakerLabels</code>.</p>
|
|
2257
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers
|
|
2258
|
+
* (diarization)</a>.</p>
|
|
2259
|
+
*/
|
|
2260
|
+
ShowSpeakerLabels?: boolean;
|
|
2261
|
+
/**
|
|
2262
|
+
* @public
|
|
2263
|
+
* <p>Specify the maximum number of speakers you want to partition in your media.</p>
|
|
2264
|
+
* <p>Note that if your media contains more speakers than the specified number, multiple
|
|
2265
|
+
* speakers are treated as a single speaker.</p>
|
|
2266
|
+
* <p>If you specify the <code>MaxSpeakerLabels</code> field, you must set the
|
|
2267
|
+
* <code>ShowSpeakerLabels</code> field to true.</p>
|
|
2268
|
+
*/
|
|
2269
|
+
MaxSpeakerLabels?: number;
|
|
2270
|
+
/**
|
|
2271
|
+
* @public
|
|
2272
|
+
* <p>Enables channel identification in multi-channel audio.</p>
|
|
2273
|
+
* <p>Channel identification transcribes the audio on each channel independently, then
|
|
2274
|
+
* appends the output for each channel into one transcript.</p>
|
|
2275
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel
|
|
2276
|
+
* audio</a>.</p>
|
|
2277
|
+
*/
|
|
2278
|
+
ChannelIdentification?: boolean;
|
|
2279
|
+
/**
|
|
2280
|
+
* @public
|
|
2281
|
+
* <p>The name of the custom vocabulary you want to include in your Medical Scribe
|
|
2282
|
+
* request. Custom vocabulary names are case sensitive.</p>
|
|
2283
|
+
*/
|
|
2284
|
+
VocabularyName?: string;
|
|
2285
|
+
/**
|
|
2286
|
+
* @public
|
|
2287
|
+
* <p>The name of the custom vocabulary filter you want to include in your Medical Scribe
|
|
2288
|
+
* request. Custom vocabulary filter names are case sensitive.</p>
|
|
2289
|
+
* <p>Note that if you include <code>VocabularyFilterName</code> in your request, you must
|
|
2290
|
+
* also include <code>VocabularyFilterMethod</code>.</p>
|
|
2291
|
+
*/
|
|
2292
|
+
VocabularyFilterName?: string;
|
|
2293
|
+
/**
|
|
2294
|
+
* @public
|
|
2295
|
+
* <p>Specify how you want your custom vocabulary filter applied to your transcript.</p>
|
|
2296
|
+
* <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
|
|
2297
|
+
* <p>To delete words, choose <code>remove</code>.</p>
|
|
2298
|
+
* <p>To flag words without changing them, choose <code>tag</code>.</p>
|
|
2299
|
+
*/
|
|
2300
|
+
VocabularyFilterMethod?: VocabularyFilterMethod;
|
|
2301
|
+
}
|
|
2302
|
+
/**
|
|
2303
|
+
* @public
|
|
2304
|
+
* <p>Provides detailed information about a Medical Scribe job.</p>
|
|
2305
|
+
* <p>To view the status of the specified Medical Scribe job, check the
|
|
2306
|
+
* <code>MedicalScribeJobStatus</code> field. If the status is <code>COMPLETED</code>,
|
|
2307
|
+
* the job is finished and you can find the results at the locations specified in
|
|
2308
|
+
* <code>MedicalScribeOutput</code>. If the status is <code>FAILED</code>,
|
|
2309
|
+
* <code>FailureReason</code> provides details on why your Medical Scribe job
|
|
2310
|
+
* failed.</p>
|
|
2311
|
+
*/
|
|
2312
|
+
export interface MedicalScribeJob {
|
|
2313
|
+
/**
|
|
2314
|
+
* @public
|
|
2315
|
+
* <p>The name of the Medical Scribe job. Job names are case sensitive and must be
|
|
2316
|
+
* unique within an Amazon Web Services account.</p>
|
|
2317
|
+
*/
|
|
2318
|
+
MedicalScribeJobName?: string;
|
|
2319
|
+
/**
|
|
2320
|
+
* @public
|
|
2321
|
+
* <p>Provides the status of the specified Medical Scribe job.</p>
|
|
2322
|
+
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
2323
|
+
* results at the location specified in <code>MedicalScribeOutput</code> If
|
|
2324
|
+
* the status is <code>FAILED</code>, <code>FailureReason</code> provides details on why
|
|
2325
|
+
* your Medical Scribe job failed.</p>
|
|
2326
|
+
*/
|
|
2327
|
+
MedicalScribeJobStatus?: MedicalScribeJobStatus;
|
|
2328
|
+
/**
|
|
2329
|
+
* @public
|
|
2330
|
+
* <p>The language code used to create your Medical Scribe job. US English
|
|
2331
|
+
* (<code>en-US</code>) is the only supported language for Medical Scribe jobs. </p>
|
|
2332
|
+
*/
|
|
2333
|
+
LanguageCode?: MedicalScribeLanguageCode;
|
|
2334
|
+
/**
|
|
2335
|
+
* @public
|
|
2336
|
+
* <p>Describes the Amazon S3 location of the media file you want to use in your
|
|
2337
|
+
* request.</p>
|
|
2338
|
+
* <p>For information on supported media formats, refer to the <code>MediaFormat</code>
|
|
2339
|
+
* parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
|
|
2340
|
+
* in the Amazon S3 Developer Guide.</p>
|
|
2341
|
+
*/
|
|
2342
|
+
Media?: Media;
|
|
2343
|
+
/**
|
|
2344
|
+
* @public
|
|
2345
|
+
* <p>The location of the output of your Medical Scribe job.
|
|
2346
|
+
* <code>ClinicalDocumentUri</code> holds the Amazon S3 URI for the Clinical Document
|
|
2347
|
+
* and <code>TranscriptFileUri</code> holds the Amazon S3 URI for the Transcript.</p>
|
|
2348
|
+
*/
|
|
2349
|
+
MedicalScribeOutput?: MedicalScribeOutput;
|
|
2350
|
+
/**
|
|
2351
|
+
* @public
|
|
2352
|
+
* <p>The date and time your Medical Scribe job began processing.</p>
|
|
2353
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2354
|
+
* example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a Medical Scribe job
|
|
2355
|
+
* that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
|
|
2356
|
+
*/
|
|
2357
|
+
StartTime?: Date;
|
|
2358
|
+
/**
|
|
2359
|
+
* @public
|
|
2360
|
+
* <p>The date and time the specified Medical Scribe job request was made.</p>
|
|
2361
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2362
|
+
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a Medical Scribe job
|
|
2363
|
+
* that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
|
|
2364
|
+
*/
|
|
2365
|
+
CreationTime?: Date;
|
|
2366
|
+
/**
|
|
2367
|
+
* @public
|
|
2368
|
+
* <p>The date and time the specified Medical Scribe job finished processing.</p>
|
|
2369
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2370
|
+
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a Medical Scribe job
|
|
2371
|
+
* that finished processing at 12:32 PM UTC-7 on May 4, 2022.</p>
|
|
2372
|
+
*/
|
|
2373
|
+
CompletionTime?: Date;
|
|
2374
|
+
/**
|
|
2375
|
+
* @public
|
|
2376
|
+
* <p>If <code>MedicalScribeJobStatus</code> is <code>FAILED</code>,
|
|
2377
|
+
* <code>FailureReason</code> contains information about why the transcription job
|
|
2378
|
+
* failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
|
|
2379
|
+
*/
|
|
2380
|
+
FailureReason?: string;
|
|
2381
|
+
/**
|
|
2382
|
+
* @public
|
|
2383
|
+
* <p>Makes it possible to control how your Medical Scribe job is processed using a
|
|
2384
|
+
* <code>MedicalScribeSettings</code> object. Specify <code>ChannelIdentification</code> if
|
|
2385
|
+
* <code>ChannelDefinitions</code> are set. Enabled <code>ShowSpeakerLabels</code> if <code>ChannelIdentification</code>
|
|
2386
|
+
* and <code>ChannelDefinitions</code> are not set. One and only one of <code>ChannelIdentification</code> and <code>ShowSpeakerLabels</code>
|
|
2387
|
+
* must be set. If <code>ShowSpeakerLabels</code> is set, <code>MaxSpeakerLabels</code> must also be set. Use <code>Settings</code>
|
|
2388
|
+
* to specify a vocabulary or vocabulary filter or both using <code>VocabularyName</code>, <code>VocabularyFilterName</code>.
|
|
2389
|
+
* <code>VocabularyFilterMethod</code> must be specified if <code>VocabularyFilterName</code> is set.
|
|
2390
|
+
* </p>
|
|
2391
|
+
*/
|
|
2392
|
+
Settings?: MedicalScribeSettings;
|
|
2393
|
+
/**
|
|
2394
|
+
* @public
|
|
2395
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
|
|
2396
|
+
* access the Amazon S3 bucket that contains your input files,
|
|
2397
|
+
* write to the output bucket, and use your KMS key if supplied.
|
|
2398
|
+
* If the role that you specify doesn’t have the appropriate permissions your request fails.</p>
|
|
2399
|
+
* <p>IAM role ARNs have the format
|
|
2400
|
+
* <code>arn:partition:iam::account:role/role-name-with-path</code>. For example:
|
|
2401
|
+
* <code>arn:aws:iam::111122223333:role/Admin</code>.</p>
|
|
2402
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
|
|
2403
|
+
* ARNs</a>.</p>
|
|
2404
|
+
*/
|
|
2405
|
+
DataAccessRoleArn?: string;
|
|
2406
|
+
/**
|
|
2407
|
+
* @public
|
|
2408
|
+
* <p>Makes it possible to specify which speaker is on which channel. For example, if the clinician
|
|
2409
|
+
* is the first participant to speak, you would set <code>ChannelId</code> of the first <code>ChannelDefinition</code>
|
|
2410
|
+
* in the list to <code>0</code> (to indicate the first channel) and <code>ParticipantRole</code> to
|
|
2411
|
+
* <code>CLINICIAN</code> (to indicate that it's the clinician speaking).
|
|
2412
|
+
* Then you would set the <code>ChannelId</code> of the second <code>ChannelDefinition</code> in the list to
|
|
2413
|
+
* <code>1</code> (to indicate the second channel) and <code>ParticipantRole</code> to
|
|
2414
|
+
* <code>PATIENT</code> (to indicate that it's the patient speaking).
|
|
2415
|
+
* </p>
|
|
2416
|
+
*/
|
|
2417
|
+
ChannelDefinitions?: MedicalScribeChannelDefinition[];
|
|
2418
|
+
/**
|
|
2419
|
+
* @public
|
|
2420
|
+
* <p>Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.</p>
|
|
2421
|
+
* <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
|
|
2422
|
+
* resources</a>.</p>
|
|
2423
|
+
*/
|
|
2424
|
+
Tags?: Tag[];
|
|
2425
|
+
}
|
|
2426
|
+
/**
|
|
2427
|
+
* @public
|
|
2428
|
+
*/
|
|
2429
|
+
export interface GetMedicalScribeJobResponse {
|
|
2430
|
+
/**
|
|
2431
|
+
* @public
|
|
2432
|
+
* <p>Provides detailed information about the specified Medical Scribe job, including
|
|
2433
|
+
* job status and, if applicable, failure reason</p>
|
|
2434
|
+
*/
|
|
2435
|
+
MedicalScribeJob?: MedicalScribeJob;
|
|
2436
|
+
}
|
|
2053
2437
|
/**
|
|
2054
2438
|
* @public
|
|
2055
2439
|
*/
|
|
@@ -2085,9 +2469,6 @@ export interface MedicalTranscriptionSetting {
|
|
|
2085
2469
|
* partitioning labels the speech from individual speakers in your media file.</p>
|
|
2086
2470
|
* <p>If you enable <code>ShowSpeakerLabels</code> in your request, you must also include
|
|
2087
2471
|
* <code>MaxSpeakerLabels</code>.</p>
|
|
2088
|
-
* <p>You can't include <code>ShowSpeakerLabels</code> and
|
|
2089
|
-
* <code>ChannelIdentification</code> in the same request. Including both parameters
|
|
2090
|
-
* returns a <code>BadRequestException</code>.</p>
|
|
2091
2472
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers
|
|
2092
2473
|
* (diarization)</a>.</p>
|
|
2093
2474
|
*/
|
|
@@ -2109,9 +2490,6 @@ export interface MedicalTranscriptionSetting {
|
|
|
2109
2490
|
* <p>If you have multi-channel audio and do not enable channel identification, your audio
|
|
2110
2491
|
* is transcribed in a continuous manner and your transcript does not separate the speech
|
|
2111
2492
|
* by channel.</p>
|
|
2112
|
-
* <p>You can't include both <code>ShowSpeakerLabels</code> and
|
|
2113
|
-
* <code>ChannelIdentification</code> in the same request. Including both parameters
|
|
2114
|
-
* returns a <code>BadRequestException</code>.</p>
|
|
2115
2493
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel
|
|
2116
2494
|
* audio</a>.</p>
|
|
2117
2495
|
*/
|
|
@@ -2145,7 +2523,7 @@ export interface MedicalTranscriptionSetting {
|
|
|
2145
2523
|
* <p>The name of the custom vocabulary you want to use when processing your medical
|
|
2146
2524
|
* transcription job. Custom vocabulary names are case sensitive.</p>
|
|
2147
2525
|
* <p>The language of the specified custom vocabulary must match the language code that you
|
|
2148
|
-
* specify in your transcription request. If the languages
|
|
2526
|
+
* specify in your transcription request. If the languages do not match, the custom
|
|
2149
2527
|
* vocabulary isn't applied. There are no errors or warnings associated with a language
|
|
2150
2528
|
* mismatch. US English (<code>en-US</code>) is the only valid language for Amazon Transcribe Medical.</p>
|
|
2151
2529
|
*/
|
|
@@ -2250,7 +2628,8 @@ export interface MedicalTranscriptionJob {
|
|
|
2250
2628
|
* @public
|
|
2251
2629
|
* <p>Describes the Amazon S3 location of the media file you want to use in your
|
|
2252
2630
|
* request.</p>
|
|
2253
|
-
* <p>For information on supported media formats, refer to the <
|
|
2631
|
+
* <p>For information on supported media formats, refer to the <code>MediaFormat</code>
|
|
2632
|
+
* parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
|
|
2254
2633
|
* in the Amazon S3 Developer Guide.</p>
|
|
2255
2634
|
*/
|
|
2256
2635
|
Media?: Media;
|
|
@@ -2295,7 +2674,7 @@ export interface MedicalTranscriptionJob {
|
|
|
2295
2674
|
* <p>
|
|
2296
2675
|
* <code>Unsupported media format</code>.</p>
|
|
2297
2676
|
* <p>The media format specified in <code>MediaFormat</code> isn't valid. Refer to
|
|
2298
|
-
*
|
|
2677
|
+
* refer to the <code>MediaFormat</code> parameter for a list of supported
|
|
2299
2678
|
* formats.</p>
|
|
2300
2679
|
* </li>
|
|
2301
2680
|
* <li>
|
|
@@ -2324,14 +2703,14 @@ export interface MedicalTranscriptionJob {
|
|
|
2324
2703
|
* <p>
|
|
2325
2704
|
* <code>Invalid file size: file size too large</code>.</p>
|
|
2326
2705
|
* <p>The size of your media file is larger than what Amazon Transcribe can
|
|
2327
|
-
* process. For more information, refer to <a href="https://docs.aws.amazon.com/
|
|
2706
|
+
* process. For more information, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe">Service
|
|
2328
2707
|
* quotas</a>.</p>
|
|
2329
2708
|
* </li>
|
|
2330
2709
|
* <li>
|
|
2331
2710
|
* <p>
|
|
2332
2711
|
* <code>Invalid number of channels: number of channels too large</code>.</p>
|
|
2333
2712
|
* <p>Your audio contains more channels than Amazon Transcribe is able to process.
|
|
2334
|
-
* For more information, refer to <a href="https://docs.aws.amazon.com/
|
|
2713
|
+
* For more information, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe">Service
|
|
2335
2714
|
* quotas</a>.</p>
|
|
2336
2715
|
* </li>
|
|
2337
2716
|
* </ul>
|
|
@@ -2430,7 +2809,7 @@ export interface GetMedicalVocabularyResponse {
|
|
|
2430
2809
|
FailureReason?: string;
|
|
2431
2810
|
/**
|
|
2432
2811
|
* @public
|
|
2433
|
-
* <p>The S3 location where the specified custom medical vocabulary is stored; use this URI
|
|
2812
|
+
* <p>The Amazon S3 location where the specified custom medical vocabulary is stored; use this URI
|
|
2434
2813
|
* to view or download the custom vocabulary.</p>
|
|
2435
2814
|
*/
|
|
2436
2815
|
DownloadUri?: string;
|
|
@@ -2519,7 +2898,7 @@ export interface ModelSettings {
|
|
|
2519
2898
|
* <p>The name of the custom language model you want to use when processing your
|
|
2520
2899
|
* transcription job. Note that custom language model names are case sensitive.</p>
|
|
2521
2900
|
* <p>The language of the specified custom language model must match the language code that
|
|
2522
|
-
* you specify in your transcription request. If the languages
|
|
2901
|
+
* you specify in your transcription request. If the languages do not match, the custom
|
|
2523
2902
|
* language model isn't applied. There are no errors or warnings associated with a language
|
|
2524
2903
|
* mismatch.</p>
|
|
2525
2904
|
*/
|
|
@@ -2527,7 +2906,8 @@ export interface ModelSettings {
|
|
|
2527
2906
|
}
|
|
2528
2907
|
/**
|
|
2529
2908
|
* @public
|
|
2530
|
-
* <p>Allows additional optional settings in your
|
|
2909
|
+
* <p>Allows additional optional settings in your
|
|
2910
|
+
* request, including channel identification, alternative transcriptions, and speaker
|
|
2531
2911
|
* partitioning. You can use that to apply custom vocabularies to your transcription
|
|
2532
2912
|
* job.</p>
|
|
2533
2913
|
*/
|
|
@@ -2544,9 +2924,6 @@ export interface Settings {
|
|
|
2544
2924
|
* partitioning labels the speech from individual speakers in your media file.</p>
|
|
2545
2925
|
* <p>If you enable <code>ShowSpeakerLabels</code> in your request, you must also include
|
|
2546
2926
|
* <code>MaxSpeakerLabels</code>.</p>
|
|
2547
|
-
* <p>You can't include both <code>ShowSpeakerLabels</code> and
|
|
2548
|
-
* <code>ChannelIdentification</code> in the same request. Including both parameters
|
|
2549
|
-
* returns a <code>BadRequestException</code>.</p>
|
|
2550
2927
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers
|
|
2551
2928
|
* (diarization)</a>.</p>
|
|
2552
2929
|
*/
|
|
@@ -2565,9 +2942,6 @@ export interface Settings {
|
|
|
2565
2942
|
* <p>Enables channel identification in multi-channel audio.</p>
|
|
2566
2943
|
* <p>Channel identification transcribes the audio on each channel independently, then
|
|
2567
2944
|
* appends the output for each channel into one transcript.</p>
|
|
2568
|
-
* <p>You can't include both <code>ShowSpeakerLabels</code> and
|
|
2569
|
-
* <code>ChannelIdentification</code> in the same request. Including both parameters
|
|
2570
|
-
* returns a <code>BadRequestException</code>.</p>
|
|
2571
2945
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel
|
|
2572
2946
|
* audio</a>.</p>
|
|
2573
2947
|
*/
|
|
@@ -2789,7 +3163,7 @@ export interface TranscriptionJob {
|
|
|
2789
3163
|
* <p>
|
|
2790
3164
|
* <code>Unsupported media format</code>.</p>
|
|
2791
3165
|
* <p>The media format specified in <code>MediaFormat</code> isn't valid. Refer to
|
|
2792
|
-
*
|
|
3166
|
+
* refer to the <code>MediaFormat</code> parameter for a list of supported
|
|
2793
3167
|
* formats.</p>
|
|
2794
3168
|
* </li>
|
|
2795
3169
|
* <li>
|
|
@@ -2818,14 +3192,14 @@ export interface TranscriptionJob {
|
|
|
2818
3192
|
* <p>
|
|
2819
3193
|
* <code>Invalid file size: file size too large</code>.</p>
|
|
2820
3194
|
* <p>The size of your media file is larger than what Amazon Transcribe can
|
|
2821
|
-
* process. For more information, refer to <a href="https://docs.aws.amazon.com/
|
|
3195
|
+
* process. For more information, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe">Service
|
|
2822
3196
|
* quotas</a>.</p>
|
|
2823
3197
|
* </li>
|
|
2824
3198
|
* <li>
|
|
2825
3199
|
* <p>
|
|
2826
3200
|
* <code>Invalid number of channels: number of channels too large</code>.</p>
|
|
2827
3201
|
* <p>Your audio contains more channels than Amazon Transcribe is able to process.
|
|
2828
|
-
* For more information, refer to <a href="https://docs.aws.amazon.com/
|
|
3202
|
+
* For more information, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe">Service
|
|
2829
3203
|
* quotas</a>.</p>
|
|
2830
3204
|
* </li>
|
|
2831
3205
|
* </ul>
|
|
@@ -2970,7 +3344,7 @@ export interface GetVocabularyResponse {
|
|
|
2970
3344
|
FailureReason?: string;
|
|
2971
3345
|
/**
|
|
2972
3346
|
* @public
|
|
2973
|
-
* <p>The S3 location where the custom vocabulary is stored; use this URI to view or
|
|
3347
|
+
* <p>The Amazon S3 location where the custom vocabulary is stored; use this URI to view or
|
|
2974
3348
|
* download the custom vocabulary.</p>
|
|
2975
3349
|
*/
|
|
2976
3350
|
DownloadUri?: string;
|
|
@@ -3032,7 +3406,7 @@ export interface ListCallAnalyticsCategoriesRequest {
|
|
|
3032
3406
|
* @public
|
|
3033
3407
|
* <p>The maximum number of Call Analytics categories to return in each page of results. If
|
|
3034
3408
|
* there are fewer results than the value that you specify, only the actual results are
|
|
3035
|
-
* returned. If you
|
|
3409
|
+
* returned. If you do not specify a value, a default of 5 is used.</p>
|
|
3036
3410
|
*/
|
|
3037
3411
|
MaxResults?: number;
|
|
3038
3412
|
}
|
|
@@ -3063,7 +3437,7 @@ export interface ListCallAnalyticsJobsRequest {
|
|
|
3063
3437
|
/**
|
|
3064
3438
|
* @public
|
|
3065
3439
|
* <p>Returns only Call Analytics jobs with the specified status. Jobs are ordered by
|
|
3066
|
-
* creation date, with the newest job first. If you
|
|
3440
|
+
* creation date, with the newest job first. If you do not include <code>Status</code>, all
|
|
3067
3441
|
* Call Analytics jobs are returned.</p>
|
|
3068
3442
|
*/
|
|
3069
3443
|
Status?: CallAnalyticsJobStatus;
|
|
@@ -3086,7 +3460,7 @@ export interface ListCallAnalyticsJobsRequest {
|
|
|
3086
3460
|
* @public
|
|
3087
3461
|
* <p>The maximum number of Call Analytics jobs to return in each page of results. If there
|
|
3088
3462
|
* are fewer results than the value that you specify, only the actual results are returned.
|
|
3089
|
-
* If you
|
|
3463
|
+
* If you do not specify a value, a default of 5 is used.</p>
|
|
3090
3464
|
*/
|
|
3091
3465
|
MaxResults?: number;
|
|
3092
3466
|
}
|
|
@@ -3122,7 +3496,7 @@ export interface ListLanguageModelsRequest {
|
|
|
3122
3496
|
/**
|
|
3123
3497
|
* @public
|
|
3124
3498
|
* <p>Returns only custom language models with the specified status. Language models are
|
|
3125
|
-
* ordered by creation date, with the newest model first. If you
|
|
3499
|
+
* ordered by creation date, with the newest model first. If you do not include
|
|
3126
3500
|
* <code>StatusEquals</code>, all custom language models are returned.</p>
|
|
3127
3501
|
*/
|
|
3128
3502
|
StatusEquals?: ModelStatus;
|
|
@@ -3145,7 +3519,7 @@ export interface ListLanguageModelsRequest {
|
|
|
3145
3519
|
* @public
|
|
3146
3520
|
* <p>The maximum number of custom language models to return in each page of results. If
|
|
3147
3521
|
* there are fewer results than the value that you specify, only the actual results are
|
|
3148
|
-
* returned. If you
|
|
3522
|
+
* returned. If you do not specify a value, a default of 5 is used.</p>
|
|
3149
3523
|
*/
|
|
3150
3524
|
MaxResults?: number;
|
|
3151
3525
|
}
|
|
@@ -3169,6 +3543,123 @@ export interface ListLanguageModelsResponse {
|
|
|
3169
3543
|
*/
|
|
3170
3544
|
Models?: LanguageModel[];
|
|
3171
3545
|
}
|
|
3546
|
+
/**
|
|
3547
|
+
* @public
|
|
3548
|
+
*/
|
|
3549
|
+
export interface ListMedicalScribeJobsRequest {
|
|
3550
|
+
/**
|
|
3551
|
+
* @public
|
|
3552
|
+
* <p>Returns only Medical Scribe jobs with the specified status. Jobs are ordered by
|
|
3553
|
+
* creation date, with the newest job first. If you do not include <code>Status</code>, all
|
|
3554
|
+
* Medical Scribe jobs are returned.</p>
|
|
3555
|
+
*/
|
|
3556
|
+
Status?: MedicalScribeJobStatus;
|
|
3557
|
+
/**
|
|
3558
|
+
* @public
|
|
3559
|
+
* <p>Returns only the Medical Scribe jobs that contain the specified string. The
|
|
3560
|
+
* search is not case sensitive.</p>
|
|
3561
|
+
*/
|
|
3562
|
+
JobNameContains?: string;
|
|
3563
|
+
/**
|
|
3564
|
+
* @public
|
|
3565
|
+
* <p>If your <code>ListMedicalScribeJobs</code> request returns more results than
|
|
3566
|
+
* can be displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
3567
|
+
* string. To get the next page of results, copy this string and repeat your request,
|
|
3568
|
+
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
3569
|
+
* to view all your results.</p>
|
|
3570
|
+
*/
|
|
3571
|
+
NextToken?: string;
|
|
3572
|
+
/**
|
|
3573
|
+
* @public
|
|
3574
|
+
* <p>The maximum number of Medical Scribe jobs to return in each page of results. If
|
|
3575
|
+
* there are fewer results than the value that you specify, only the actual results are
|
|
3576
|
+
* returned. If you do not specify a value, a default of 5 is used.</p>
|
|
3577
|
+
*/
|
|
3578
|
+
MaxResults?: number;
|
|
3579
|
+
}
|
|
3580
|
+
/**
|
|
3581
|
+
* @public
|
|
3582
|
+
* <p>Provides detailed information about a specific Medical Scribe job.</p>
|
|
3583
|
+
*/
|
|
3584
|
+
export interface MedicalScribeJobSummary {
|
|
3585
|
+
/**
|
|
3586
|
+
* @public
|
|
3587
|
+
* <p>The name of the Medical Scribe job. Job names are case sensitive and must be
|
|
3588
|
+
* unique within an Amazon Web Services account.</p>
|
|
3589
|
+
*/
|
|
3590
|
+
MedicalScribeJobName?: string;
|
|
3591
|
+
/**
|
|
3592
|
+
* @public
|
|
3593
|
+
* <p>The date and time the specified Medical Scribe job request was made.</p>
|
|
3594
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
3595
|
+
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a Medical Scribe job
|
|
3596
|
+
* that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
|
|
3597
|
+
*/
|
|
3598
|
+
CreationTime?: Date;
|
|
3599
|
+
/**
|
|
3600
|
+
* @public
|
|
3601
|
+
* <p>The date and time your Medical Scribe job began processing.</p>
|
|
3602
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
3603
|
+
* example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a Medical Scribe job
|
|
3604
|
+
* that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
|
|
3605
|
+
*/
|
|
3606
|
+
StartTime?: Date;
|
|
3607
|
+
/**
|
|
3608
|
+
* @public
|
|
3609
|
+
* <p>The date and time the specified Medical Scribe job finished processing.</p>
|
|
3610
|
+
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
3611
|
+
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a Medical Scribe job
|
|
3612
|
+
* that finished processing at 12:32 PM UTC-7 on May 4, 2022.</p>
|
|
3613
|
+
*/
|
|
3614
|
+
CompletionTime?: Date;
|
|
3615
|
+
/**
|
|
3616
|
+
* @public
|
|
3617
|
+
* <p>The language code used to create your Medical Scribe job. US English
|
|
3618
|
+
* (<code>en-US</code>) is the only supported language for Medical Scribe jobs. </p>
|
|
3619
|
+
*/
|
|
3620
|
+
LanguageCode?: MedicalScribeLanguageCode;
|
|
3621
|
+
/**
|
|
3622
|
+
* @public
|
|
3623
|
+
* <p>Provides the status of the specified Medical Scribe job.</p>
|
|
3624
|
+
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
3625
|
+
* results at the location specified in <code>MedicalScribeOutput</code> If
|
|
3626
|
+
* the status is <code>FAILED</code>, <code>FailureReason</code> provides details on why
|
|
3627
|
+
* your Medical Scribe job failed.</p>
|
|
3628
|
+
*/
|
|
3629
|
+
MedicalScribeJobStatus?: MedicalScribeJobStatus;
|
|
3630
|
+
/**
|
|
3631
|
+
* @public
|
|
3632
|
+
* <p>If <code>MedicalScribeJobStatus</code> is <code>FAILED</code>,
|
|
3633
|
+
* <code>FailureReason</code> contains information about why the transcription job
|
|
3634
|
+
* failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
|
|
3635
|
+
*/
|
|
3636
|
+
FailureReason?: string;
|
|
3637
|
+
}
|
|
3638
|
+
/**
|
|
3639
|
+
* @public
|
|
3640
|
+
*/
|
|
3641
|
+
export interface ListMedicalScribeJobsResponse {
|
|
3642
|
+
/**
|
|
3643
|
+
* @public
|
|
3644
|
+
* <p>Lists all Medical Scribe jobs that have the status specified in your request.
|
|
3645
|
+
* Jobs are ordered by creation date, with the newest job first.</p>
|
|
3646
|
+
*/
|
|
3647
|
+
Status?: MedicalScribeJobStatus;
|
|
3648
|
+
/**
|
|
3649
|
+
* @public
|
|
3650
|
+
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
3651
|
+
* results are displayed. To view the next set of results, copy the string associated with
|
|
3652
|
+
* the <code>NextToken</code> parameter in your results output, then run your request again
|
|
3653
|
+
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
3654
|
+
* to view all your results.</p>
|
|
3655
|
+
*/
|
|
3656
|
+
NextToken?: string;
|
|
3657
|
+
/**
|
|
3658
|
+
* @public
|
|
3659
|
+
* <p>Provides a summary of information about each result.</p>
|
|
3660
|
+
*/
|
|
3661
|
+
MedicalScribeJobSummaries?: MedicalScribeJobSummary[];
|
|
3662
|
+
}
|
|
3172
3663
|
/**
|
|
3173
3664
|
* @public
|
|
3174
3665
|
*/
|
|
@@ -3176,7 +3667,7 @@ export interface ListMedicalTranscriptionJobsRequest {
|
|
|
3176
3667
|
/**
|
|
3177
3668
|
* @public
|
|
3178
3669
|
* <p>Returns only medical transcription jobs with the specified status. Jobs are ordered by
|
|
3179
|
-
* creation date, with the newest job first. If you
|
|
3670
|
+
* creation date, with the newest job first. If you do not include <code>Status</code>, all
|
|
3180
3671
|
* medical transcription jobs are returned.</p>
|
|
3181
3672
|
*/
|
|
3182
3673
|
Status?: TranscriptionJobStatus;
|
|
@@ -3199,7 +3690,7 @@ export interface ListMedicalTranscriptionJobsRequest {
|
|
|
3199
3690
|
* @public
|
|
3200
3691
|
* <p>The maximum number of medical transcription jobs to return in each page of results. If
|
|
3201
3692
|
* there are fewer results than the value that you specify, only the actual results are
|
|
3202
|
-
* returned. If you
|
|
3693
|
+
* returned. If you do not specify a value, a default of 5 is used.</p>
|
|
3203
3694
|
*/
|
|
3204
3695
|
MaxResults?: number;
|
|
3205
3696
|
}
|
|
@@ -3344,13 +3835,13 @@ export interface ListMedicalVocabulariesRequest {
|
|
|
3344
3835
|
* @public
|
|
3345
3836
|
* <p>The maximum number of custom medical vocabularies to return in each page of results.
|
|
3346
3837
|
* If there are fewer results than the value that you specify, only the actual results are
|
|
3347
|
-
* returned. If you
|
|
3838
|
+
* returned. If you do not specify a value, a default of 5 is used.</p>
|
|
3348
3839
|
*/
|
|
3349
3840
|
MaxResults?: number;
|
|
3350
3841
|
/**
|
|
3351
3842
|
* @public
|
|
3352
3843
|
* <p>Returns only custom medical vocabularies with the specified state. Custom vocabularies
|
|
3353
|
-
* are ordered by creation date, with the newest vocabulary first. If you
|
|
3844
|
+
* are ordered by creation date, with the newest vocabulary first. If you do not include
|
|
3354
3845
|
* <code>StateEquals</code>, all custom medical vocabularies are returned.</p>
|
|
3355
3846
|
*/
|
|
3356
3847
|
StateEquals?: VocabularyState;
|
|
@@ -3467,7 +3958,7 @@ export interface ListTranscriptionJobsRequest {
|
|
|
3467
3958
|
/**
|
|
3468
3959
|
* @public
|
|
3469
3960
|
* <p>Returns only transcription jobs with the specified status. Jobs are ordered by
|
|
3470
|
-
* creation date, with the newest job first. If you
|
|
3961
|
+
* creation date, with the newest job first. If you do not include <code>Status</code>, all
|
|
3471
3962
|
* transcription jobs are returned.</p>
|
|
3472
3963
|
*/
|
|
3473
3964
|
Status?: TranscriptionJobStatus;
|
|
@@ -3490,7 +3981,7 @@ export interface ListTranscriptionJobsRequest {
|
|
|
3490
3981
|
* @public
|
|
3491
3982
|
* <p>The maximum number of transcription jobs to return in each page of results. If there
|
|
3492
3983
|
* are fewer results than the value that you specify, only the actual results are returned.
|
|
3493
|
-
* If you
|
|
3984
|
+
* If you do not specify a value, a default of 5 is used.</p>
|
|
3494
3985
|
*/
|
|
3495
3986
|
MaxResults?: number;
|
|
3496
3987
|
}
|
|
@@ -3656,13 +4147,13 @@ export interface ListVocabulariesRequest {
|
|
|
3656
4147
|
* @public
|
|
3657
4148
|
* <p>The maximum number of custom vocabularies to return in each page of results. If there
|
|
3658
4149
|
* are fewer results than the value that you specify, only the actual results are returned.
|
|
3659
|
-
* If you
|
|
4150
|
+
* If you do not specify a value, a default of 5 is used.</p>
|
|
3660
4151
|
*/
|
|
3661
4152
|
MaxResults?: number;
|
|
3662
4153
|
/**
|
|
3663
4154
|
* @public
|
|
3664
4155
|
* <p>Returns only custom vocabularies with the specified state. Vocabularies are ordered by
|
|
3665
|
-
* creation date, with the newest vocabulary first. If you
|
|
4156
|
+
* creation date, with the newest vocabulary first. If you do not include
|
|
3666
4157
|
* <code>StateEquals</code>, all custom medical vocabularies are returned.</p>
|
|
3667
4158
|
*/
|
|
3668
4159
|
StateEquals?: VocabularyState;
|
|
@@ -3716,7 +4207,7 @@ export interface ListVocabularyFiltersRequest {
|
|
|
3716
4207
|
* @public
|
|
3717
4208
|
* <p>The maximum number of custom vocabulary filters to return in each page of results. If
|
|
3718
4209
|
* there are fewer results than the value that you specify, only the actual results are
|
|
3719
|
-
* returned. If you
|
|
4210
|
+
* returned. If you do not specify a value, a default of 5 is used.</p>
|
|
3720
4211
|
*/
|
|
3721
4212
|
MaxResults?: number;
|
|
3722
4213
|
/**
|
|
@@ -3816,9 +4307,9 @@ export interface StartCallAnalyticsJobRequest {
|
|
|
3816
4307
|
* value that matches the name you specified for your transcription job using the
|
|
3817
4308
|
* <code>CallAnalyticsJobName</code> parameter.</p>
|
|
3818
4309
|
* <p>You can specify a KMS key to encrypt your output using the
|
|
3819
|
-
* <code>OutputEncryptionKMSKeyId</code> parameter. If you
|
|
4310
|
+
* <code>OutputEncryptionKMSKeyId</code> parameter. If you do not specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for
|
|
3820
4311
|
* server-side encryption.</p>
|
|
3821
|
-
* <p>If you
|
|
4312
|
+
* <p>If you do not specify <code>OutputLocation</code>, your transcript is placed in a
|
|
3822
4313
|
* service-managed Amazon S3 bucket and you are provided with a URI to access your
|
|
3823
4314
|
* transcript.</p>
|
|
3824
4315
|
*/
|
|
@@ -3862,7 +4353,7 @@ export interface StartCallAnalyticsJobRequest {
|
|
|
3862
4353
|
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
|
|
3863
4354
|
* </li>
|
|
3864
4355
|
* </ol>
|
|
3865
|
-
* <p>If you
|
|
4356
|
+
* <p>If you do not specify an encryption key, your output is encrypted with the default
|
|
3866
4357
|
* Amazon S3 key (SSE-S3).</p>
|
|
3867
4358
|
* <p>If you specify a KMS key to encrypt your output, you must also specify
|
|
3868
4359
|
* an output location using the <code>OutputLocation</code> parameter.</p>
|
|
@@ -3908,6 +4399,144 @@ export interface StartCallAnalyticsJobResponse {
|
|
|
3908
4399
|
*/
|
|
3909
4400
|
CallAnalyticsJob?: CallAnalyticsJob;
|
|
3910
4401
|
}
|
|
4402
|
+
/**
|
|
4403
|
+
* @public
|
|
4404
|
+
*/
|
|
4405
|
+
export interface StartMedicalScribeJobRequest {
|
|
4406
|
+
/**
|
|
4407
|
+
* @public
|
|
4408
|
+
* <p>A unique name, chosen by you, for your Medical Scribe job.</p>
|
|
4409
|
+
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
4410
|
+
* Amazon Web Services account. If you try to create a new job with the same name as an
|
|
4411
|
+
* existing job, you get a <code>ConflictException</code> error.</p>
|
|
4412
|
+
*/
|
|
4413
|
+
MedicalScribeJobName: string | undefined;
|
|
4414
|
+
/**
|
|
4415
|
+
* @public
|
|
4416
|
+
* <p>Describes the Amazon S3 location of the media file you want to use in your
|
|
4417
|
+
* request.</p>
|
|
4418
|
+
* <p>For information on supported media formats, refer to the <code>MediaFormat</code>
|
|
4419
|
+
* parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
|
|
4420
|
+
* in the Amazon S3 Developer Guide.</p>
|
|
4421
|
+
*/
|
|
4422
|
+
Media: Media | undefined;
|
|
4423
|
+
/**
|
|
4424
|
+
* @public
|
|
4425
|
+
* <p>The name of the Amazon S3 bucket where you want your Medical Scribe
|
|
4426
|
+
* output stored. Do not include the <code>S3://</code> prefix of the specified
|
|
4427
|
+
* bucket.</p>
|
|
4428
|
+
* <p>Note that the role specified in the <code>DataAccessRoleArn</code> request parameter
|
|
4429
|
+
* must have permission to use the specified location. You
|
|
4430
|
+
* 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>
|
|
4431
|
+
*/
|
|
4432
|
+
OutputBucketName: string | undefined;
|
|
4433
|
+
/**
|
|
4434
|
+
* @public
|
|
4435
|
+
* <p>The KMS key you want to use to encrypt your Medical Scribe
|
|
4436
|
+
* output.</p>
|
|
4437
|
+
* <p>If using a key located in the <b>current</b>
|
|
4438
|
+
* Amazon Web Services account, you can specify your KMS key in one of four
|
|
4439
|
+
* ways:</p>
|
|
4440
|
+
* <ol>
|
|
4441
|
+
* <li>
|
|
4442
|
+
* <p>Use the KMS key ID itself. For example,
|
|
4443
|
+
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
4444
|
+
* </li>
|
|
4445
|
+
* <li>
|
|
4446
|
+
* <p>Use an alias for the KMS key ID. For example,
|
|
4447
|
+
* <code>alias/ExampleAlias</code>.</p>
|
|
4448
|
+
* </li>
|
|
4449
|
+
* <li>
|
|
4450
|
+
* <p>Use the Amazon Resource Name (ARN) for the KMS key ID. For
|
|
4451
|
+
* example,
|
|
4452
|
+
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
4453
|
+
* </li>
|
|
4454
|
+
* <li>
|
|
4455
|
+
* <p>Use the ARN for the KMS key alias. For example,
|
|
4456
|
+
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
|
|
4457
|
+
* </li>
|
|
4458
|
+
* </ol>
|
|
4459
|
+
* <p>If using a key located in a <b>different</b>
|
|
4460
|
+
* Amazon Web Services account than the current Amazon Web Services account, you can specify
|
|
4461
|
+
* your KMS key in one of two ways:</p>
|
|
4462
|
+
* <ol>
|
|
4463
|
+
* <li>
|
|
4464
|
+
* <p>Use the ARN for the KMS key ID. For example,
|
|
4465
|
+
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
4466
|
+
* </li>
|
|
4467
|
+
* <li>
|
|
4468
|
+
* <p>Use the ARN for the KMS key alias. For example,
|
|
4469
|
+
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
|
|
4470
|
+
* </li>
|
|
4471
|
+
* </ol>
|
|
4472
|
+
* <p>If you do not specify an encryption key, your output is encrypted with the default
|
|
4473
|
+
* Amazon S3 key (SSE-S3).</p>
|
|
4474
|
+
* <p>Note that the role specified in the <code>DataAccessRoleArn</code> request parameter
|
|
4475
|
+
* must have permission to use the specified KMS key.</p>
|
|
4476
|
+
*/
|
|
4477
|
+
OutputEncryptionKMSKeyId?: string;
|
|
4478
|
+
/**
|
|
4479
|
+
* @public
|
|
4480
|
+
* <p>A map of plain text, non-secret key:value pairs, known as encryption context pairs,
|
|
4481
|
+
* that provide an added layer of security for your data. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context">KMS encryption context</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html">Asymmetric keys in KMS</a>.</p>
|
|
4482
|
+
*/
|
|
4483
|
+
KMSEncryptionContext?: Record<string, string>;
|
|
4484
|
+
/**
|
|
4485
|
+
* @public
|
|
4486
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
|
|
4487
|
+
* access the Amazon S3 bucket that contains your input files,
|
|
4488
|
+
* write to the output bucket, and use your KMS key if supplied.
|
|
4489
|
+
* If the role that you specify doesn’t have the appropriate permissions your request fails.</p>
|
|
4490
|
+
* <p>IAM role ARNs have the format
|
|
4491
|
+
* <code>arn:partition:iam::account:role/role-name-with-path</code>. For example:
|
|
4492
|
+
* <code>arn:aws:iam::111122223333:role/Admin</code>.</p>
|
|
4493
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
|
|
4494
|
+
* ARNs</a>.</p>
|
|
4495
|
+
*/
|
|
4496
|
+
DataAccessRoleArn: string | undefined;
|
|
4497
|
+
/**
|
|
4498
|
+
* @public
|
|
4499
|
+
* <p>Makes it possible to control how your Medical Scribe job is processed using a
|
|
4500
|
+
* <code>MedicalScribeSettings</code> object. Specify <code>ChannelIdentification</code> if
|
|
4501
|
+
* <code>ChannelDefinitions</code> are set. Enabled <code>ShowSpeakerLabels</code> if <code>ChannelIdentification</code>
|
|
4502
|
+
* and <code>ChannelDefinitions</code> are not set. One and only one of <code>ChannelIdentification</code> and <code>ShowSpeakerLabels</code>
|
|
4503
|
+
* must be set. If <code>ShowSpeakerLabels</code> is set, <code>MaxSpeakerLabels</code> must also be set. Use <code>Settings</code>
|
|
4504
|
+
* to specify a vocabulary or vocabulary filter or both using <code>VocabularyName</code>, <code>VocabularyFilterName</code>.
|
|
4505
|
+
* <code>VocabularyFilterMethod</code> must be specified if <code>VocabularyFilterName</code> is set.
|
|
4506
|
+
* </p>
|
|
4507
|
+
*/
|
|
4508
|
+
Settings: MedicalScribeSettings | undefined;
|
|
4509
|
+
/**
|
|
4510
|
+
* @public
|
|
4511
|
+
* <p>Makes it possible to specify which speaker is on which channel. For example, if the clinician
|
|
4512
|
+
* is the first participant to speak, you would set <code>ChannelId</code> of the first <code>ChannelDefinition</code>
|
|
4513
|
+
* in the list to <code>0</code> (to indicate the first channel) and <code>ParticipantRole</code> to
|
|
4514
|
+
* <code>CLINICIAN</code> (to indicate that it's the clinician speaking).
|
|
4515
|
+
* Then you would set the <code>ChannelId</code> of the second <code>ChannelDefinition</code> in the list to
|
|
4516
|
+
* <code>1</code> (to indicate the second channel) and <code>ParticipantRole</code> to
|
|
4517
|
+
* <code>PATIENT</code> (to indicate that it's the patient speaking).
|
|
4518
|
+
* </p>
|
|
4519
|
+
*/
|
|
4520
|
+
ChannelDefinitions?: MedicalScribeChannelDefinition[];
|
|
4521
|
+
/**
|
|
4522
|
+
* @public
|
|
4523
|
+
* <p>Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.</p>
|
|
4524
|
+
* <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
|
|
4525
|
+
* resources</a>.</p>
|
|
4526
|
+
*/
|
|
4527
|
+
Tags?: Tag[];
|
|
4528
|
+
}
|
|
4529
|
+
/**
|
|
4530
|
+
* @public
|
|
4531
|
+
*/
|
|
4532
|
+
export interface StartMedicalScribeJobResponse {
|
|
4533
|
+
/**
|
|
4534
|
+
* @public
|
|
4535
|
+
* <p>Provides detailed information about the current Medical Scribe job, including
|
|
4536
|
+
* job status and, if applicable, failure reason.</p>
|
|
4537
|
+
*/
|
|
4538
|
+
MedicalScribeJob?: MedicalScribeJob;
|
|
4539
|
+
}
|
|
3911
4540
|
/**
|
|
3912
4541
|
* @public
|
|
3913
4542
|
*/
|
|
@@ -3934,7 +4563,7 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
3934
4563
|
/**
|
|
3935
4564
|
* @public
|
|
3936
4565
|
* <p>The sample rate, in hertz, of the audio track in your input media file.</p>
|
|
3937
|
-
* <p>If you
|
|
4566
|
+
* <p>If you do not specify the media sample rate, Amazon Transcribe Medical determines it
|
|
3938
4567
|
* 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
|
|
3939
4568
|
* value detected, your job fails. Therefore, in most cases, it's advised to omit
|
|
3940
4569
|
* <code>MediaSampleRateHertz</code> and let Amazon Transcribe Medical determine the
|
|
@@ -3950,7 +4579,8 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
3950
4579
|
* @public
|
|
3951
4580
|
* <p>Describes the Amazon S3 location of the media file you want to use in your
|
|
3952
4581
|
* request.</p>
|
|
3953
|
-
* <p>For information on supported media formats, refer to the <
|
|
4582
|
+
* <p>For information on supported media formats, refer to the <code>MediaFormat</code>
|
|
4583
|
+
* parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
|
|
3954
4584
|
* in the Amazon S3 Developer Guide.</p>
|
|
3955
4585
|
*/
|
|
3956
4586
|
Media: Media | undefined;
|
|
@@ -4048,7 +4678,7 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
4048
4678
|
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
|
|
4049
4679
|
* </li>
|
|
4050
4680
|
* </ol>
|
|
4051
|
-
* <p>If you
|
|
4681
|
+
* <p>If you do not specify an encryption key, your output is encrypted with the default
|
|
4052
4682
|
* Amazon S3 key (SSE-S3).</p>
|
|
4053
4683
|
* <p>If you specify a KMS key to encrypt your output, you must also specify
|
|
4054
4684
|
* an output location using the <code>OutputLocation</code> parameter.</p>
|
|
@@ -4173,7 +4803,7 @@ export interface StartTranscriptionJobRequest {
|
|
|
4173
4803
|
/**
|
|
4174
4804
|
* @public
|
|
4175
4805
|
* <p>The sample rate, in hertz, of the audio track in your input media file.</p>
|
|
4176
|
-
* <p>If you
|
|
4806
|
+
* <p>If you do not specify the media sample rate, Amazon Transcribe determines it for you.
|
|
4177
4807
|
* If you specify the sample rate, it must match the rate detected by Amazon Transcribe.
|
|
4178
4808
|
* If there's a mismatch between the value that you specify and the value detected, your
|
|
4179
4809
|
* job fails. In most cases, you can omit <code>MediaSampleRateHertz</code> and let Amazon Transcribe determine the sample rate.</p>
|
|
@@ -4204,7 +4834,7 @@ export interface StartTranscriptionJobRequest {
|
|
|
4204
4834
|
* <code>OutputKey</code> to <code>test-files/</code>.</p>
|
|
4205
4835
|
* <p>Note that Amazon Transcribe must have permission to use the specified location. You
|
|
4206
4836
|
* 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>
|
|
4207
|
-
* <p>If you
|
|
4837
|
+
* <p>If you do not specify <code>OutputBucketName</code>, your transcript is placed in a
|
|
4208
4838
|
* service-managed Amazon S3 bucket and you are provided with a URI to access your
|
|
4209
4839
|
* transcript.</p>
|
|
4210
4840
|
*/
|
|
@@ -4286,7 +4916,7 @@ export interface StartTranscriptionJobRequest {
|
|
|
4286
4916
|
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
|
|
4287
4917
|
* </li>
|
|
4288
4918
|
* </ol>
|
|
4289
|
-
* <p>If you
|
|
4919
|
+
* <p>If you do not specify an encryption key, your output is encrypted with the default
|
|
4290
4920
|
* Amazon S3 key (SSE-S3).</p>
|
|
4291
4921
|
* <p>If you specify a KMS key to encrypt your output, you must also specify
|
|
4292
4922
|
* an output location using the <code>OutputLocation</code> parameter.</p>
|
|
@@ -4302,7 +4932,8 @@ export interface StartTranscriptionJobRequest {
|
|
|
4302
4932
|
KMSEncryptionContext?: Record<string, string>;
|
|
4303
4933
|
/**
|
|
4304
4934
|
* @public
|
|
4305
|
-
* <p>Specify additional optional settings in your
|
|
4935
|
+
* <p>Specify additional optional settings in your
|
|
4936
|
+
* request, including channel identification, alternative transcriptions, speaker
|
|
4306
4937
|
* partitioning. You can use that to apply custom vocabularies and vocabulary filters.</p>
|
|
4307
4938
|
* <p>If you want to include a custom vocabulary or a custom vocabulary filter (or both)
|
|
4308
4939
|
* with your request but <b>do not</b> want to use automatic
|
|
@@ -4336,10 +4967,11 @@ export interface StartTranscriptionJobRequest {
|
|
|
4336
4967
|
JobExecutionSettings?: JobExecutionSettings;
|
|
4337
4968
|
/**
|
|
4338
4969
|
* @public
|
|
4339
|
-
* <p>Makes it possible to redact or flag specified personally identifiable information
|
|
4340
|
-
*
|
|
4341
|
-
*
|
|
4342
|
-
*
|
|
4970
|
+
* <p>Makes it possible to redact or flag specified personally identifiable information (PII) in
|
|
4971
|
+
* your transcript. If you use <code>ContentRedaction</code>, you must also include the
|
|
4972
|
+
* sub-parameters: <code>RedactionOutput</code> and <code>RedactionType</code>. You can
|
|
4973
|
+
* optionally include <code>PiiEntityTypes</code> to choose which types of PII you want to redact.
|
|
4974
|
+
* If you do not include <code>PiiEntityTypes</code> in your request, all PII is redacted.</p>
|
|
4343
4975
|
*/
|
|
4344
4976
|
ContentRedaction?: ContentRedaction;
|
|
4345
4977
|
/**
|