@aws-sdk/client-transcribe 3.47.2 → 3.48.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/CHANGELOG.md +11 -0
- package/dist-cjs/models/models_0.js +18 -3
- package/dist-cjs/protocols/Aws_json1_1.js +27 -0
- package/dist-es/models/models_0.js +15 -0
- package/dist-es/protocols/Aws_json1_1.js +27 -1
- package/dist-types/Transcribe.d.ts +37 -28
- package/dist-types/commands/CreateCallAnalyticsCategoryCommand.d.ts +3 -3
- package/dist-types/commands/CreateLanguageModelCommand.d.ts +3 -2
- package/dist-types/commands/CreateMedicalVocabularyCommand.d.ts +2 -1
- package/dist-types/commands/CreateVocabularyFilterCommand.d.ts +2 -2
- package/dist-types/commands/ListCallAnalyticsCategoriesCommand.d.ts +2 -1
- package/dist-types/commands/ListLanguageModelsCommand.d.ts +4 -3
- package/dist-types/commands/ListMedicalTranscriptionJobsCommand.d.ts +2 -1
- package/dist-types/commands/ListMedicalVocabulariesCommand.d.ts +2 -2
- package/dist-types/commands/ListVocabulariesCommand.d.ts +2 -2
- package/dist-types/commands/StartCallAnalyticsJobCommand.d.ts +5 -4
- package/dist-types/commands/UpdateCallAnalyticsCategoryCommand.d.ts +3 -2
- package/dist-types/commands/UpdateMedicalVocabularyCommand.d.ts +4 -3
- package/dist-types/commands/UpdateVocabularyCommand.d.ts +3 -2
- package/dist-types/models/models_0.d.ts +855 -664
- package/dist-types/ts3.4/models/models_0.d.ts +16 -0
- package/package.json +3 -3
|
@@ -4,8 +4,9 @@ import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException
|
|
|
4
4
|
*/
|
|
5
5
|
export interface AbsoluteTimeRange {
|
|
6
6
|
/**
|
|
7
|
-
* <p>A value that indicates the beginning of the time range in seconds. To set absolute time
|
|
8
|
-
* start time and an end time. For example, if you specify the following
|
|
7
|
+
* <p>A value that indicates the beginning of the time range in seconds. To set absolute time
|
|
8
|
+
* range, you must specify a start time and an end time. For example, if you specify the following
|
|
9
|
+
* values:</p>
|
|
9
10
|
* <ul>
|
|
10
11
|
* <li>
|
|
11
12
|
* <p>StartTime - 10000</p>
|
|
@@ -14,12 +15,14 @@ export interface AbsoluteTimeRange {
|
|
|
14
15
|
* <p>Endtime - 50000</p>
|
|
15
16
|
* </li>
|
|
16
17
|
* </ul>
|
|
17
|
-
* <p>The time range is set between 10,000 milliseconds and 50,000 milliseconds into the
|
|
18
|
+
* <p>The time range is set between 10,000 milliseconds and 50,000 milliseconds into the
|
|
19
|
+
* call.</p>
|
|
18
20
|
*/
|
|
19
21
|
StartTime?: number;
|
|
20
22
|
/**
|
|
21
|
-
* <p>A value that indicates the end of the time range in milliseconds. To set absolute time
|
|
22
|
-
* time and an end time. For example, if you specify the following
|
|
23
|
+
* <p>A value that indicates the end of the time range in milliseconds. To set absolute time
|
|
24
|
+
* range, you must specify a start time and an end time. For example, if you specify the following
|
|
25
|
+
* values:</p>
|
|
23
26
|
* <ul>
|
|
24
27
|
* <li>
|
|
25
28
|
* <p>StartTime - 10000</p>
|
|
@@ -28,17 +31,20 @@ export interface AbsoluteTimeRange {
|
|
|
28
31
|
* <p>Endtime - 50000</p>
|
|
29
32
|
* </li>
|
|
30
33
|
* </ul>
|
|
31
|
-
* <p>The time range is set between 10,000 milliseconds and 50,000 milliseconds into the
|
|
34
|
+
* <p>The time range is set between 10,000 milliseconds and 50,000 milliseconds into the
|
|
35
|
+
* call.</p>
|
|
32
36
|
*/
|
|
33
37
|
EndTime?: number;
|
|
34
38
|
/**
|
|
35
|
-
* <p>A time range from the beginning of the call to the value that you've specified. For example,
|
|
36
|
-
* time range is set to the first 100,000 milliseconds
|
|
39
|
+
* <p>A time range from the beginning of the call to the value that you've specified. For example,
|
|
40
|
+
* if you specify <code>100000</code>, the time range is set to the first 100,000 milliseconds
|
|
41
|
+
* of the call.</p>
|
|
37
42
|
*/
|
|
38
43
|
First?: number;
|
|
39
44
|
/**
|
|
40
|
-
* <p>A time range from the value that you've specified to the end of the call. For example, if you
|
|
41
|
-
* range is set to the last 100,000 milliseconds of the
|
|
45
|
+
* <p>A time range from the value that you've specified to the end of the call. For example, if you
|
|
46
|
+
* specify <code>100000</code>, the time range is set to the last 100,000 milliseconds of the
|
|
47
|
+
* call.</p>
|
|
42
48
|
*/
|
|
43
49
|
Last?: number;
|
|
44
50
|
}
|
|
@@ -49,9 +55,9 @@ export declare namespace AbsoluteTimeRange {
|
|
|
49
55
|
const filterSensitiveLog: (obj: AbsoluteTimeRange) => any;
|
|
50
56
|
}
|
|
51
57
|
/**
|
|
52
|
-
* <p>Your request didn't pass one or more validation tests. For example, if the entity that
|
|
53
|
-
* doesn't exist or if it is in a non-terminal state (for example, it's
|
|
54
|
-
* field for more information.</p>
|
|
58
|
+
* <p>Your request didn't pass one or more validation tests. For example, if the entity that
|
|
59
|
+
* you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's
|
|
60
|
+
* "in progress"). See the exception <code>Message</code> field for more information.</p>
|
|
55
61
|
*/
|
|
56
62
|
export interface BadRequestException extends __SmithyException, $MetadataBearer {
|
|
57
63
|
name: "BadRequestException";
|
|
@@ -73,8 +79,8 @@ export declare enum ParticipantRole {
|
|
|
73
79
|
CUSTOMER = "CUSTOMER"
|
|
74
80
|
}
|
|
75
81
|
/**
|
|
76
|
-
* <p>For a call analytics job, an object that indicates the audio channel that belongs to the
|
|
77
|
-
* channel that belongs to the customer.</p>
|
|
82
|
+
* <p>For a call analytics job, an object that indicates the audio channel that belongs to the
|
|
83
|
+
* agent and the audio channel that belongs to the customer.</p>
|
|
78
84
|
*/
|
|
79
85
|
export interface ChannelDefinition {
|
|
80
86
|
/**
|
|
@@ -82,7 +88,8 @@ export interface ChannelDefinition {
|
|
|
82
88
|
*/
|
|
83
89
|
ChannelId?: number;
|
|
84
90
|
/**
|
|
85
|
-
* <p>Indicates whether the person speaking on the audio channel is the agent or
|
|
91
|
+
* <p>Indicates whether the person speaking on the audio channel is the agent or
|
|
92
|
+
* customer.</p>
|
|
86
93
|
*/
|
|
87
94
|
ParticipantRole?: ParticipantRole | string;
|
|
88
95
|
}
|
|
@@ -139,18 +146,25 @@ export declare enum LanguageCode {
|
|
|
139
146
|
*/
|
|
140
147
|
export interface Media {
|
|
141
148
|
/**
|
|
142
|
-
* <p>The S3 object location of the input media file. The URI must be in the same region as
|
|
143
|
-
* are calling. The general form is:</p>
|
|
144
|
-
*
|
|
149
|
+
* <p>The S3 object location of the input media file. The URI must be in the same region as
|
|
150
|
+
* the API endpoint that you are calling. The general form is:</p>
|
|
151
|
+
* <p>
|
|
152
|
+
* <code> s3://<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey></code>
|
|
153
|
+
* </p>
|
|
145
154
|
* <p>For example:</p>
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
*
|
|
149
|
-
*
|
|
155
|
+
* <p>
|
|
156
|
+
* <code>s3://AWSDOC-EXAMPLE-BUCKET/example.mp4</code>
|
|
157
|
+
* </p>
|
|
158
|
+
* <p>
|
|
159
|
+
* <code>s3://AWSDOC-EXAMPLE-BUCKET/mediadocs/example.mp4</code>
|
|
160
|
+
* </p>
|
|
161
|
+
* <p>For more information about S3 object names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys">Object Keys</a> in the
|
|
162
|
+
* <i>Amazon S3 Developer Guide</i>.</p>
|
|
150
163
|
*/
|
|
151
164
|
MediaFileUri?: string;
|
|
152
165
|
/**
|
|
153
|
-
* <p>
|
|
166
|
+
* <p>The S3 object location for your redacted output media file. This is only supported for
|
|
167
|
+
* call analytics jobs.</p>
|
|
154
168
|
*/
|
|
155
169
|
RedactedMediaFileUri?: string;
|
|
156
170
|
}
|
|
@@ -169,6 +183,20 @@ export declare enum MediaFormat {
|
|
|
169
183
|
WAV = "wav",
|
|
170
184
|
WEBM = "webm"
|
|
171
185
|
}
|
|
186
|
+
export declare enum PiiEntityType {
|
|
187
|
+
ADDRESS = "ADDRESS",
|
|
188
|
+
ALL = "ALL",
|
|
189
|
+
BANK_ACCOUNT_NUMBER = "BANK_ACCOUNT_NUMBER",
|
|
190
|
+
BANK_ROUTING = "BANK_ROUTING",
|
|
191
|
+
CREDIT_DEBIT_CVV = "CREDIT_DEBIT_CVV",
|
|
192
|
+
CREDIT_DEBIT_EXPIRY = "CREDIT_DEBIT_EXPIRY",
|
|
193
|
+
CREDIT_DEBIT_NUMBER = "CREDIT_DEBIT_NUMBER",
|
|
194
|
+
EMAIL = "EMAIL",
|
|
195
|
+
NAME = "NAME",
|
|
196
|
+
PHONE = "PHONE",
|
|
197
|
+
PIN = "PIN",
|
|
198
|
+
SSN = "SSN"
|
|
199
|
+
}
|
|
172
200
|
export declare enum RedactionOutput {
|
|
173
201
|
REDACTED = "redacted",
|
|
174
202
|
REDACTED_AND_UNREDACTED = "redacted_and_unredacted"
|
|
@@ -181,16 +209,24 @@ export declare enum RedactionType {
|
|
|
181
209
|
*/
|
|
182
210
|
export interface ContentRedaction {
|
|
183
211
|
/**
|
|
184
|
-
* <p>Request parameter that defines the entities to be redacted. The only accepted value is
|
|
212
|
+
* <p>Request parameter that defines the entities to be redacted. The only accepted value is
|
|
213
|
+
* <code>PII</code>.</p>
|
|
185
214
|
*/
|
|
186
215
|
RedactionType: RedactionType | string | undefined;
|
|
187
216
|
/**
|
|
188
|
-
* <p>The output transcript file stored in either the default S3 bucket or in a bucket you
|
|
189
|
-
*
|
|
190
|
-
* <p>When you choose <code>
|
|
191
|
-
*
|
|
217
|
+
* <p>The output transcript file stored in either the default S3 bucket or in a bucket you
|
|
218
|
+
* specify.</p>
|
|
219
|
+
* <p>When you choose <code>redacted</code> Amazon Transcribe outputs only the redacted
|
|
220
|
+
* transcript.</p>
|
|
221
|
+
* <p>When you choose <code>redacted_and_unredacted</code> Amazon Transcribe outputs both the
|
|
222
|
+
* redacted and unredacted transcripts.</p>
|
|
192
223
|
*/
|
|
193
224
|
RedactionOutput: RedactionOutput | string | undefined;
|
|
225
|
+
/**
|
|
226
|
+
* <p>The types of personally identifiable information (PII) you want to redact in your
|
|
227
|
+
* transcript.</p>
|
|
228
|
+
*/
|
|
229
|
+
PiiEntityTypes?: (PiiEntityType | string)[];
|
|
194
230
|
}
|
|
195
231
|
export declare namespace ContentRedaction {
|
|
196
232
|
/**
|
|
@@ -199,25 +235,26 @@ export declare namespace ContentRedaction {
|
|
|
199
235
|
const filterSensitiveLog: (obj: ContentRedaction) => any;
|
|
200
236
|
}
|
|
201
237
|
/**
|
|
202
|
-
* <p>Language-specific settings that can be specified when language identification is
|
|
238
|
+
* <p>Language-specific settings that can be specified when language identification is
|
|
239
|
+
* enabled.</p>
|
|
203
240
|
*/
|
|
204
241
|
export interface LanguageIdSettings {
|
|
205
242
|
/**
|
|
206
243
|
* <p>The name of the vocabulary you want to use when processing your transcription job. The
|
|
207
|
-
* vocabulary you specify must have the same language
|
|
208
|
-
* match, the vocabulary
|
|
244
|
+
* vocabulary you specify must have the same language codes as the transcription job; if the
|
|
245
|
+
* languages don't match, the vocabulary isn't applied.</p>
|
|
209
246
|
*/
|
|
210
247
|
VocabularyName?: string;
|
|
211
248
|
/**
|
|
212
|
-
* <p>The name of the vocabulary filter you want to use when transcribing your audio. The filter
|
|
213
|
-
* must have the same language
|
|
214
|
-
* filter
|
|
249
|
+
* <p>The name of the vocabulary filter you want to use when transcribing your audio. The filter
|
|
250
|
+
* you specify must have the same language codes as the transcription job; if the languages
|
|
251
|
+
* don't match, the vocabulary filter isn't be applied.</p>
|
|
215
252
|
*/
|
|
216
253
|
VocabularyFilterName?: string;
|
|
217
254
|
/**
|
|
218
|
-
* <p>The name of the language model you want to use when transcribing your audio. The
|
|
219
|
-
* must have the same language
|
|
220
|
-
*
|
|
255
|
+
* <p>The name of the language model you want to use when transcribing your audio. The
|
|
256
|
+
* model you specify must have the same language codes as the transcription job; if the
|
|
257
|
+
* languages don't match, the language model isn't be applied.</p>
|
|
221
258
|
*/
|
|
222
259
|
LanguageModelName?: string;
|
|
223
260
|
}
|
|
@@ -241,15 +278,17 @@ export interface CallAnalyticsJobSettings {
|
|
|
241
278
|
*/
|
|
242
279
|
VocabularyName?: string;
|
|
243
280
|
/**
|
|
244
|
-
* <p>The name of the vocabulary filter to use when running a call analytics job. The filter that
|
|
245
|
-
* same language code as the analytics job.</p>
|
|
281
|
+
* <p>The name of the vocabulary filter to use when running a call analytics job. The filter that
|
|
282
|
+
* you specify must have the same language code as the analytics job.</p>
|
|
246
283
|
*/
|
|
247
284
|
VocabularyFilterName?: string;
|
|
248
285
|
/**
|
|
249
|
-
* <p>Set to mask to remove filtered text from the transcript and replace it with three
|
|
250
|
-
* Set to <code>remove</code> to remove filtered text
|
|
251
|
-
* <code>tag</code> to mark the word
|
|
252
|
-
*
|
|
286
|
+
* <p>Set to mask to remove filtered text from the transcript and replace it with three
|
|
287
|
+
* asterisks ("***") as placeholder text. Set to <code>remove</code> to remove filtered text
|
|
288
|
+
* from the transcript without using placeholder text. Set to <code>tag</code> to mark the word
|
|
289
|
+
* in the transcription output that matches the vocabulary filter. When you set the filter method
|
|
290
|
+
* to <code>tag</code>, the words matching your vocabulary filter are not masked or
|
|
291
|
+
* removed.</p>
|
|
253
292
|
*/
|
|
254
293
|
VocabularyFilterMethod?: VocabularyFilterMethod | string;
|
|
255
294
|
/**
|
|
@@ -261,18 +300,19 @@ export interface CallAnalyticsJobSettings {
|
|
|
261
300
|
*/
|
|
262
301
|
ContentRedaction?: ContentRedaction;
|
|
263
302
|
/**
|
|
264
|
-
* <p>When you run a call analytics job, you can specify the language spoken in the audio, or
|
|
265
|
-
* the language for you.</p>
|
|
266
|
-
* <p>To specify a language, specify an array with one language code. If you don't know the
|
|
267
|
-
* field blank and Amazon Transcribe will use machine learning to identify the
|
|
268
|
-
*
|
|
269
|
-
*
|
|
270
|
-
*
|
|
303
|
+
* <p>When you run a call analytics job, you can specify the language spoken in the audio, or
|
|
304
|
+
* you can have Amazon Transcribe identify the language for you.</p>
|
|
305
|
+
* <p>To specify a language, specify an array with one language code. If you don't know the
|
|
306
|
+
* language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the
|
|
307
|
+
* language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can
|
|
308
|
+
* provide an array of the languages that can be present in the audio. Refer to
|
|
309
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> for
|
|
310
|
+
* additional information.</p>
|
|
271
311
|
*/
|
|
272
312
|
LanguageOptions?: (LanguageCode | string)[];
|
|
273
313
|
/**
|
|
274
|
-
* <p>The language identification settings associated with your call analytics job. These settings
|
|
275
|
-
* <code>VocabularyName</code>, <code>VocabularyFilterName</code>, and
|
|
314
|
+
* <p>The language identification settings associated with your call analytics job. These settings
|
|
315
|
+
* include <code>VocabularyName</code>, <code>VocabularyFilterName</code>, and
|
|
276
316
|
* <code>LanguageModelName</code>.</p>
|
|
277
317
|
*/
|
|
278
318
|
LanguageIdSettings?: {
|
|
@@ -291,16 +331,18 @@ export declare namespace CallAnalyticsJobSettings {
|
|
|
291
331
|
export interface Transcript {
|
|
292
332
|
/**
|
|
293
333
|
* <p>The S3 object location of the transcript.</p>
|
|
294
|
-
* <p>Use this URI to access the transcript. If you specified an S3 bucket in the
|
|
295
|
-
* field when you created the job, this is the URI of that
|
|
296
|
-
*
|
|
334
|
+
* <p>Use this URI to access the transcript. If you specified an S3 bucket in the
|
|
335
|
+
* <code>OutputBucketName</code> field when you created the job, this is the URI of that
|
|
336
|
+
* bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides
|
|
337
|
+
* secure access to that location.</p>
|
|
297
338
|
*/
|
|
298
339
|
TranscriptFileUri?: string;
|
|
299
340
|
/**
|
|
300
341
|
* <p>The S3 object location of the redacted transcript.</p>
|
|
301
342
|
* <p>Use this URI to access the redacted transcript. If you specified an S3 bucket in the
|
|
302
|
-
* <code>OutputBucketName</code> field when you created the job, this is the URI of that
|
|
303
|
-
* the transcript in Amazon Transcribe, this is a shareable URL that provides
|
|
343
|
+
* <code>OutputBucketName</code> field when you created the job, this is the URI of that
|
|
344
|
+
* bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides
|
|
345
|
+
* secure access to that location.</p>
|
|
304
346
|
*/
|
|
305
347
|
RedactedTranscriptFileUri?: string;
|
|
306
348
|
}
|
|
@@ -311,8 +353,8 @@ export declare namespace Transcript {
|
|
|
311
353
|
const filterSensitiveLog: (obj: Transcript) => any;
|
|
312
354
|
}
|
|
313
355
|
/**
|
|
314
|
-
* <p>Describes an asynchronous analytics job that was created with the
|
|
315
|
-
* operation.</p>
|
|
356
|
+
* <p>Describes an asynchronous analytics job that was created with the
|
|
357
|
+
* <code>StartAnalyticsJob</code> operation.</p>
|
|
316
358
|
*/
|
|
317
359
|
export interface CallAnalyticsJob {
|
|
318
360
|
/**
|
|
@@ -324,10 +366,12 @@ export interface CallAnalyticsJob {
|
|
|
324
366
|
*/
|
|
325
367
|
CallAnalyticsJobStatus?: CallAnalyticsJobStatus | string;
|
|
326
368
|
/**
|
|
327
|
-
* <p>If you know the language spoken between the customer and the agent, specify a
|
|
328
|
-
*
|
|
329
|
-
*
|
|
330
|
-
*
|
|
369
|
+
* <p>If you know the language spoken between the customer and the agent, specify a
|
|
370
|
+
* language code for this field.</p>
|
|
371
|
+
* <p>If you don't know the language, you can leave this field blank, and Amazon Transcribe will use machine
|
|
372
|
+
* learning to automatically identify the language. To improve the accuracy of language
|
|
373
|
+
* identification, you can provide an array containing the possible language codes for the
|
|
374
|
+
* language spoken in your audio. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> for
|
|
331
375
|
* additional information.</p>
|
|
332
376
|
*/
|
|
333
377
|
LanguageCode?: LanguageCode | string;
|
|
@@ -336,8 +380,8 @@ export interface CallAnalyticsJob {
|
|
|
336
380
|
*/
|
|
337
381
|
MediaSampleRateHertz?: number;
|
|
338
382
|
/**
|
|
339
|
-
* <p>The format of the input audio file. Note: for call analytics jobs, only the following media
|
|
340
|
-
* MP4, WAV, FLAC, OGG, and WebM
|
|
383
|
+
* <p>The format of the input audio file. Note: for call analytics jobs, only the following media
|
|
384
|
+
* formats are supported: MP3, MP4, WAV, FLAC, OGG, and WebM.</p>
|
|
341
385
|
*/
|
|
342
386
|
MediaFormat?: MediaFormat | string;
|
|
343
387
|
/**
|
|
@@ -361,59 +405,64 @@ export interface CallAnalyticsJob {
|
|
|
361
405
|
*/
|
|
362
406
|
CompletionTime?: Date;
|
|
363
407
|
/**
|
|
364
|
-
* <p>If the <code>AnalyticsJobStatus</code> is <code>FAILED</code>, this field contains
|
|
365
|
-
* the job failed.</p>
|
|
408
|
+
* <p>If the <code>AnalyticsJobStatus</code> is <code>FAILED</code>, this field contains
|
|
409
|
+
* information about why the job failed.</p>
|
|
366
410
|
* <p>The <code>FailureReason</code> field can contain one of the following values:</p>
|
|
367
411
|
* <ul>
|
|
368
412
|
* <li>
|
|
369
|
-
*
|
|
413
|
+
* <p>
|
|
370
414
|
* <code>Unsupported media format</code>: The media format specified in the
|
|
371
|
-
* <code>MediaFormat</code> field of the request isn't valid. See the description of the
|
|
372
|
-
* field for a list of valid values.</p>
|
|
415
|
+
* <code>MediaFormat</code> field of the request isn't valid. See the description of the
|
|
416
|
+
* <code>MediaFormat</code> field for a list of valid values.</p>
|
|
373
417
|
* </li>
|
|
374
418
|
* <li>
|
|
375
|
-
*
|
|
376
|
-
* <code>The media format provided does not match the detected media
|
|
377
|
-
*
|
|
378
|
-
*
|
|
419
|
+
* <p>
|
|
420
|
+
* <code>The media format provided does not match the detected media
|
|
421
|
+
* format</code>: The media format of the audio file doesn't match the format specified
|
|
422
|
+
* in the <code>MediaFormat</code> field in the request. Check the media format of your
|
|
423
|
+
* media file and make sure the two values match.</p>
|
|
379
424
|
* </li>
|
|
380
425
|
* <li>
|
|
381
|
-
*
|
|
426
|
+
* <p>
|
|
382
427
|
* <code>Invalid sample rate for audio file</code>: The sample rate specified in the
|
|
383
|
-
* <code>MediaSampleRateHertz</code> of the request isn't valid. The sample rate must be
|
|
384
|
-
*
|
|
428
|
+
* <code>MediaSampleRateHertz</code> of the request isn't valid. The sample rate must be
|
|
429
|
+
* between 8,000 and 48,000 Hertz.</p>
|
|
385
430
|
* </li>
|
|
386
431
|
* <li>
|
|
387
432
|
* <p>
|
|
388
|
-
* <code>The sample rate provided does not match the detected sample
|
|
389
|
-
* in the audio file doesn't match the sample rate specified in
|
|
390
|
-
* request. Check the sample rate of
|
|
433
|
+
* <code>The sample rate provided does not match the detected sample
|
|
434
|
+
* rate</code>: The sample rate in the audio file doesn't match the sample rate specified in
|
|
435
|
+
* the <code>MediaSampleRateHertz</code> field in the request. Check the sample rate of
|
|
436
|
+
* your media file and make sure that the two values match.</p>
|
|
391
437
|
* </li>
|
|
392
438
|
* <li>
|
|
393
|
-
*
|
|
394
|
-
* <code>Invalid file size: file size too large</code>: The size of your audio file is larger
|
|
395
|
-
*
|
|
396
|
-
*
|
|
439
|
+
* <p>
|
|
440
|
+
* <code>Invalid file size: file size too large</code>: The size of your audio file is larger
|
|
441
|
+
* than what Amazon Transcribe Medical can process. For more information, see <i>Guidelines and
|
|
442
|
+
* Quotas</i> in the Amazon Transcribe Medical Guide.</p>
|
|
397
443
|
* </li>
|
|
398
444
|
* <li>
|
|
399
|
-
*
|
|
400
|
-
* <code>Invalid number of channels: number of channels too large</code>: Your
|
|
401
|
-
*
|
|
402
|
-
*
|
|
403
|
-
*
|
|
445
|
+
* <p>
|
|
446
|
+
* <code>Invalid number of channels: number of channels too large</code>: Your
|
|
447
|
+
* audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional
|
|
448
|
+
* channels, see Amazon Transcribe Medical Endpoints and Quotas in the
|
|
449
|
+
* <a href="https://docs.aws.amazon.com/general/latest/gr/Welcome.html">Amazon Web
|
|
450
|
+
* Services General Reference</a>.</p>
|
|
404
451
|
* </li>
|
|
405
452
|
* </ul>
|
|
406
453
|
*/
|
|
407
454
|
FailureReason?: string;
|
|
408
455
|
/**
|
|
409
|
-
* <p>The Amazon Resource Number (ARN) that you use to access the analytics job. ARNs
|
|
456
|
+
* <p>The Amazon Resource Number (ARN) that you use to access the analytics job. ARNs
|
|
457
|
+
* have the format
|
|
410
458
|
* <code>arn:partition:service:region:account-id:resource-type/resource-id</code>.</p>
|
|
411
459
|
*/
|
|
412
460
|
DataAccessRoleArn?: string;
|
|
413
461
|
/**
|
|
414
|
-
* <p>A value between zero and one that Amazon Transcribe assigned to the language that it identified in
|
|
415
|
-
* appears only when you don't provide a single language code.
|
|
416
|
-
* the language that it
|
|
462
|
+
* <p>A value between zero and one that Amazon Transcribe assigned to the language that it identified in
|
|
463
|
+
* the source audio. This value appears only when you don't provide a single language code.
|
|
464
|
+
* Larger values indicate that Amazon Transcribe has higher confidence in the language that it
|
|
465
|
+
* identified.</p>
|
|
417
466
|
*/
|
|
418
467
|
IdentifiedLanguageScore?: number;
|
|
419
468
|
/**
|
|
@@ -421,8 +470,8 @@ export interface CallAnalyticsJob {
|
|
|
421
470
|
*/
|
|
422
471
|
Settings?: CallAnalyticsJobSettings;
|
|
423
472
|
/**
|
|
424
|
-
* <p>Shows numeric values to indicate the channel assigned to the agent's audio and the
|
|
425
|
-
* customer's audio. </p>
|
|
473
|
+
* <p>Shows numeric values to indicate the channel assigned to the agent's audio and the
|
|
474
|
+
* channel assigned to the customer's audio. </p>
|
|
426
475
|
*/
|
|
427
476
|
ChannelDefinitions?: ChannelDefinition[];
|
|
428
477
|
}
|
|
@@ -461,7 +510,8 @@ export interface CallAnalyticsJobSummary {
|
|
|
461
510
|
*/
|
|
462
511
|
CallAnalyticsJobStatus?: CallAnalyticsJobStatus | string;
|
|
463
512
|
/**
|
|
464
|
-
* <p>If the <code>CallAnalyticsJobStatus</code> is <code>FAILED</code>, a description of
|
|
513
|
+
* <p>If the <code>CallAnalyticsJobStatus</code> is <code>FAILED</code>, a description of
|
|
514
|
+
* the error.</p>
|
|
465
515
|
*/
|
|
466
516
|
FailureReason?: string;
|
|
467
517
|
}
|
|
@@ -472,15 +522,17 @@ export declare namespace CallAnalyticsJobSummary {
|
|
|
472
522
|
const filterSensitiveLog: (obj: CallAnalyticsJobSummary) => any;
|
|
473
523
|
}
|
|
474
524
|
/**
|
|
475
|
-
* <p>An object that allows percentages to specify the proportion of the call where you
|
|
476
|
-
* example, you can specify the first half of the call. You can
|
|
477
|
-
*
|
|
525
|
+
* <p>An object that allows percentages to specify the proportion of the call where you
|
|
526
|
+
* would like to apply a filter. For example, you can specify the first half of the call. You can
|
|
527
|
+
* also specify the period of time between halfway through to three-quarters of the way
|
|
528
|
+
* through the call. Because the length of conversation can vary between calls, you can apply
|
|
478
529
|
* relative time ranges across all calls. </p>
|
|
479
530
|
*/
|
|
480
531
|
export interface RelativeTimeRange {
|
|
481
532
|
/**
|
|
482
|
-
* <p>A value that indicates the percentage of the beginning of the time range. To set a
|
|
483
|
-
* specify a start percentage and an end percentage. For
|
|
533
|
+
* <p>A value that indicates the percentage of the beginning of the time range. To set a
|
|
534
|
+
* relative time range, you must specify a start percentage and an end percentage. For
|
|
535
|
+
* example, if you specify the following values:</p>
|
|
484
536
|
* <ul>
|
|
485
537
|
* <li>
|
|
486
538
|
* <p>StartPercentage - 10</p>
|
|
@@ -489,14 +541,15 @@ export interface RelativeTimeRange {
|
|
|
489
541
|
* <p>EndPercentage - 50</p>
|
|
490
542
|
* </li>
|
|
491
543
|
* </ul>
|
|
492
|
-
* <p>This looks at the time range starting from 10% of the way into the call to 50% of
|
|
493
|
-
* a call that lasts 100,000 milliseconds, this example range
|
|
494
|
-
* 50,000 millisecond mark.</p>
|
|
544
|
+
* <p>This looks at the time range starting from 10% of the way into the call to 50% of
|
|
545
|
+
* the way through the call. For a call that lasts 100,000 milliseconds, this example range
|
|
546
|
+
* would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.</p>
|
|
495
547
|
*/
|
|
496
548
|
StartPercentage?: number;
|
|
497
549
|
/**
|
|
498
|
-
* <p>A value that indicates the percentage of the end of the time range. To set a relative
|
|
499
|
-
* a start percentage and an end percentage. For example, if
|
|
550
|
+
* <p>A value that indicates the percentage of the end of the time range. To set a relative
|
|
551
|
+
* time range, you must specify a start percentage and an end percentage. For example, if
|
|
552
|
+
* you specify the following values:</p>
|
|
500
553
|
* <ul>
|
|
501
554
|
* <li>
|
|
502
555
|
* <p>StartPercentage - 10</p>
|
|
@@ -505,20 +558,22 @@ export interface RelativeTimeRange {
|
|
|
505
558
|
* <p>EndPercentage - 50</p>
|
|
506
559
|
* </li>
|
|
507
560
|
* </ul>
|
|
508
|
-
* <p>This looks at the time range starting from 10% of the way into the call to 50% of the
|
|
509
|
-
* call that lasts 100,000 milliseconds, this example range would
|
|
510
|
-
* millisecond mark.</p>
|
|
561
|
+
* <p>This looks at the time range starting from 10% of the way into the call to 50% of the
|
|
562
|
+
* way through the call. For a call that lasts 100,000 milliseconds, this example range would
|
|
563
|
+
* apply from the 10,000 millisecond mark to the 50,000 millisecond mark.</p>
|
|
511
564
|
*/
|
|
512
565
|
EndPercentage?: number;
|
|
513
566
|
/**
|
|
514
|
-
* <p>A range that takes the portion of the call up to the time in milliseconds set by the
|
|
515
|
-
* example, if you specify <code>120000</code>, the time
|
|
567
|
+
* <p>A range that takes the portion of the call up to the time in milliseconds set by the
|
|
568
|
+
* value that you've specified. For example, if you specify <code>120000</code>, the time
|
|
569
|
+
* range is set for the first 120,000 milliseconds of the call.</p>
|
|
516
570
|
*/
|
|
517
571
|
First?: number;
|
|
518
572
|
/**
|
|
519
|
-
* <p>A range that takes the portion of the call from the time in milliseconds set by the
|
|
520
|
-
* the end of the call. For example, if you specify
|
|
521
|
-
* milliseconds of the
|
|
573
|
+
* <p>A range that takes the portion of the call from the time in milliseconds set by the
|
|
574
|
+
* value that you've specified to the end of the call. For example, if you specify
|
|
575
|
+
* <code>120000</code>, the time range is set for the last 120,000 milliseconds of the
|
|
576
|
+
* call.</p>
|
|
522
577
|
*/
|
|
523
578
|
Last?: number;
|
|
524
579
|
}
|
|
@@ -529,8 +584,8 @@ export declare namespace RelativeTimeRange {
|
|
|
529
584
|
const filterSensitiveLog: (obj: RelativeTimeRange) => any;
|
|
530
585
|
}
|
|
531
586
|
/**
|
|
532
|
-
* <p>An object that enables you to configure your category to be applied to call analytics
|
|
533
|
-
* customer or agent was interrupted.</p>
|
|
587
|
+
* <p>An object that enables you to configure your category to be applied to call analytics
|
|
588
|
+
* jobs where either the customer or agent was interrupted.</p>
|
|
534
589
|
*/
|
|
535
590
|
export interface InterruptionFilter {
|
|
536
591
|
/**
|
|
@@ -542,16 +597,18 @@ export interface InterruptionFilter {
|
|
|
542
597
|
*/
|
|
543
598
|
ParticipantRole?: ParticipantRole | string;
|
|
544
599
|
/**
|
|
545
|
-
* <p>An object you can use to specify a time range (in milliseconds) for when you'd want to
|
|
546
|
-
* example, you could search for an interruption between the 30,000
|
|
547
|
-
*
|
|
600
|
+
* <p>An object you can use to specify a time range (in milliseconds) for when you'd want to
|
|
601
|
+
* find the interruption. For example, you could search for an interruption between the 30,000
|
|
602
|
+
* millisecond mark and the 45,000 millisecond mark. You could also specify the time period as
|
|
603
|
+
* the first 15,000 milliseconds or the last 15,000 milliseconds.</p>
|
|
548
604
|
*/
|
|
549
605
|
AbsoluteTimeRange?: AbsoluteTimeRange;
|
|
550
606
|
/**
|
|
551
|
-
* <p>An object that allows percentages to specify the proportion of the call where there was
|
|
552
|
-
* example, you can specify the first half of the call. You can also specify the
|
|
553
|
-
* three-quarters of the way through the call.
|
|
554
|
-
*
|
|
607
|
+
* <p>An object that allows percentages to specify the proportion of the call where there was
|
|
608
|
+
* a interruption. For example, you can specify the first half of the call. You can also specify the
|
|
609
|
+
* period of time between halfway through to three-quarters of the way through the call.
|
|
610
|
+
* Because the length of conversation can vary between calls, you can apply relative time
|
|
611
|
+
* ranges across all calls.</p>
|
|
555
612
|
*/
|
|
556
613
|
RelativeTimeRange?: RelativeTimeRange;
|
|
557
614
|
/**
|
|
@@ -566,8 +623,8 @@ export declare namespace InterruptionFilter {
|
|
|
566
623
|
const filterSensitiveLog: (obj: InterruptionFilter) => any;
|
|
567
624
|
}
|
|
568
625
|
/**
|
|
569
|
-
* <p>An object that enables you to configure your category to be applied to call analytics
|
|
570
|
-
* customer or agent was interrupted.</p>
|
|
626
|
+
* <p>An object that enables you to configure your category to be applied to call analytics
|
|
627
|
+
* jobs where either the customer or agent was interrupted.</p>
|
|
571
628
|
*/
|
|
572
629
|
export interface NonTalkTimeFilter {
|
|
573
630
|
/**
|
|
@@ -575,15 +632,17 @@ export interface NonTalkTimeFilter {
|
|
|
575
632
|
*/
|
|
576
633
|
Threshold?: number;
|
|
577
634
|
/**
|
|
578
|
-
* <p>An object you can use to specify a time range (in milliseconds) for when no one is
|
|
579
|
-
* could specify a time period between the 30,000 millisecond mark
|
|
580
|
-
* specify the time period as the first 15,000
|
|
635
|
+
* <p>An object you can use to specify a time range (in milliseconds) for when no one is
|
|
636
|
+
* talking. For example, you could specify a time period between the 30,000 millisecond mark
|
|
637
|
+
* and the 45,000 millisecond mark. You could also specify the time period as the first 15,000
|
|
638
|
+
* milliseconds or the last 15,000 milliseconds.</p>
|
|
581
639
|
*/
|
|
582
640
|
AbsoluteTimeRange?: AbsoluteTimeRange;
|
|
583
641
|
/**
|
|
584
|
-
* <p>An object that allows percentages to specify the proportion of the call where there
|
|
585
|
-
* can specify the first half of the call. You can also specify
|
|
586
|
-
*
|
|
642
|
+
* <p>An object that allows percentages to specify the proportion of the call where there
|
|
643
|
+
* was silence. For example, you can specify the first half of the call. You can also specify
|
|
644
|
+
* the period of time between halfway through to three-quarters of the way through the call.
|
|
645
|
+
* Because the length of conversation can vary between calls, you can apply relative time
|
|
587
646
|
* ranges across all calls.</p>
|
|
588
647
|
*/
|
|
589
648
|
RelativeTimeRange?: RelativeTimeRange;
|
|
@@ -605,13 +664,15 @@ export declare enum SentimentValue {
|
|
|
605
664
|
POSITIVE = "POSITIVE"
|
|
606
665
|
}
|
|
607
666
|
/**
|
|
608
|
-
* <p>An object that enables you to specify a particular customer or agent sentiment. If at
|
|
609
|
-
* conversation turns (the back-and-forth between two speakers) in a
|
|
610
|
-
* sentiment, Amazon Transcribe will consider the sentiment a
|
|
667
|
+
* <p>An object that enables you to specify a particular customer or agent sentiment. If at
|
|
668
|
+
* least 50 percent of the conversation turns (the back-and-forth between two speakers) in a
|
|
669
|
+
* specified time period match the specified sentiment, Amazon Transcribe will consider the sentiment a
|
|
670
|
+
* match.</p>
|
|
611
671
|
*/
|
|
612
672
|
export interface SentimentFilter {
|
|
613
673
|
/**
|
|
614
|
-
* <p>An array that enables you to specify sentiments for the customer or agent. You can
|
|
674
|
+
* <p>An array that enables you to specify sentiments for the customer or agent. You can
|
|
675
|
+
* specify one or more values.</p>
|
|
615
676
|
*/
|
|
616
677
|
Sentiments: (SentimentValue | string)[] | undefined;
|
|
617
678
|
/**
|
|
@@ -627,7 +688,7 @@ export interface SentimentFilter {
|
|
|
627
688
|
*/
|
|
628
689
|
ParticipantRole?: ParticipantRole | string;
|
|
629
690
|
/**
|
|
630
|
-
* <p>Set to <code>TRUE</code> to look for sentiments that weren't specified in the request
|
|
691
|
+
* <p>Set to <code>TRUE</code> to look for sentiments that weren't specified in the request.</p>
|
|
631
692
|
*/
|
|
632
693
|
Negate?: boolean;
|
|
633
694
|
}
|
|
@@ -641,14 +702,14 @@ export declare enum TranscriptFilterType {
|
|
|
641
702
|
EXACT = "EXACT"
|
|
642
703
|
}
|
|
643
704
|
/**
|
|
644
|
-
* <p>Matches the output of the transcription to either the specific phrases that you specify,
|
|
645
|
-
* that you specify.</p>
|
|
705
|
+
* <p>Matches the output of the transcription to either the specific phrases that you specify,
|
|
706
|
+
* or the intent of the phrases that you specify.</p>
|
|
646
707
|
*/
|
|
647
708
|
export interface TranscriptFilter {
|
|
648
709
|
/**
|
|
649
|
-
* <p>Matches the phrase to the transcription output in a word
|
|
650
|
-
* For example, if you specify the phrase "I want to speak to the manager."
|
|
651
|
-
* phrase to the transcription.</p>
|
|
710
|
+
* <p>Matches the phrase to the transcription output in a word
|
|
711
|
+
* for word fashion. For example, if you specify the phrase "I want to speak to the manager."
|
|
712
|
+
* Amazon Transcribe attempts to match that specific phrase to the transcription.</p>
|
|
652
713
|
*/
|
|
653
714
|
TranscriptFilterType: TranscriptFilterType | string | undefined;
|
|
654
715
|
/**
|
|
@@ -656,19 +717,21 @@ export interface TranscriptFilter {
|
|
|
656
717
|
*/
|
|
657
718
|
AbsoluteTimeRange?: AbsoluteTimeRange;
|
|
658
719
|
/**
|
|
659
|
-
* <p>An object that allows percentages to specify the proportion of the call where you would
|
|
660
|
-
* example, you can specify the first half of the call. You can also
|
|
661
|
-
*
|
|
662
|
-
*
|
|
720
|
+
* <p>An object that allows percentages to specify the proportion of the call where you would
|
|
721
|
+
* like to apply a filter. For example, you can specify the first half of the call. You can also
|
|
722
|
+
* specify the period of time between halfway through to three-quarters of the way through
|
|
723
|
+
* the call. Because the length of conversation can vary between calls, you can apply relative
|
|
724
|
+
* time ranges across all calls.</p>
|
|
663
725
|
*/
|
|
664
726
|
RelativeTimeRange?: RelativeTimeRange;
|
|
665
727
|
/**
|
|
666
|
-
* <p>Determines whether the customer or the agent is speaking the phrases that you've
|
|
728
|
+
* <p>Determines whether the customer or the agent is speaking the phrases that you've
|
|
729
|
+
* specified.</p>
|
|
667
730
|
*/
|
|
668
731
|
ParticipantRole?: ParticipantRole | string;
|
|
669
732
|
/**
|
|
670
|
-
* <p>If <code>TRUE</code>, the rule that you specify is applied to everything except for the
|
|
671
|
-
* specify.</p>
|
|
733
|
+
* <p>If <code>TRUE</code>, the rule that you specify is applied to everything except for the
|
|
734
|
+
* phrases that you specify.</p>
|
|
672
735
|
*/
|
|
673
736
|
Negate?: boolean;
|
|
674
737
|
/**
|
|
@@ -683,7 +746,8 @@ export declare namespace TranscriptFilter {
|
|
|
683
746
|
const filterSensitiveLog: (obj: TranscriptFilter) => any;
|
|
684
747
|
}
|
|
685
748
|
/**
|
|
686
|
-
* <p>A condition in the call between the customer and the agent that you want to filter
|
|
749
|
+
* <p>A condition in the call between the customer and the agent that you want to filter
|
|
750
|
+
* for.</p>
|
|
687
751
|
*/
|
|
688
752
|
export declare type Rule = Rule.InterruptionFilterMember | Rule.NonTalkTimeFilterMember | Rule.SentimentFilterMember | Rule.TranscriptFilterMember | Rule.$UnknownMember;
|
|
689
753
|
export declare namespace Rule {
|
|
@@ -709,8 +773,9 @@ export declare namespace Rule {
|
|
|
709
773
|
$unknown?: never;
|
|
710
774
|
}
|
|
711
775
|
/**
|
|
712
|
-
* <p>A condition that catches particular words or phrases based on a exact match. For
|
|
713
|
-
* phrase "I want to speak to the manager", only that exact phrase will
|
|
776
|
+
* <p>A condition that catches particular words or phrases based on a exact match. For
|
|
777
|
+
* example, if you set the phrase "I want to speak to the manager", only that exact phrase will
|
|
778
|
+
* be returned.</p>
|
|
714
779
|
*/
|
|
715
780
|
interface TranscriptFilterMember {
|
|
716
781
|
NonTalkTimeFilter?: never;
|
|
@@ -750,7 +815,8 @@ export declare namespace Rule {
|
|
|
750
815
|
const filterSensitiveLog: (obj: Rule) => any;
|
|
751
816
|
}
|
|
752
817
|
/**
|
|
753
|
-
* <p>An object that contains the rules and additional information about a call analytics
|
|
818
|
+
* <p>An object that contains the rules and additional information about a call analytics
|
|
819
|
+
* category.</p>
|
|
754
820
|
*/
|
|
755
821
|
export interface CategoryProperties {
|
|
756
822
|
/**
|
|
@@ -766,7 +832,8 @@ export interface CategoryProperties {
|
|
|
766
832
|
*/
|
|
767
833
|
CreateTime?: Date;
|
|
768
834
|
/**
|
|
769
|
-
* <p>A timestamp that shows when the call analytics category was most recently
|
|
835
|
+
* <p>A timestamp that shows when the call analytics category was most recently
|
|
836
|
+
* updated.</p>
|
|
770
837
|
*/
|
|
771
838
|
LastUpdateTime?: Date;
|
|
772
839
|
}
|
|
@@ -797,9 +864,9 @@ export interface CreateCallAnalyticsCategoryRequest {
|
|
|
797
864
|
*/
|
|
798
865
|
CategoryName: string | undefined;
|
|
799
866
|
/**
|
|
800
|
-
* <p>To create a category, you must specify between 1 and 20 rules. For each rule, you
|
|
801
|
-
* filter to be applied to the attributes of the call. For example, you can specify a
|
|
802
|
-
* filter to detect if the customer's sentiment was negative or neutral
|
|
867
|
+
* <p>To create a category, you must specify between 1 and 20 rules. For each rule, you
|
|
868
|
+
* specify a filter to be applied to the attributes of the call. For example, you can specify a
|
|
869
|
+
* sentiment filter to detect if the customer's sentiment was negative or neutral.</p>
|
|
803
870
|
*/
|
|
804
871
|
Rules: Rule[] | undefined;
|
|
805
872
|
}
|
|
@@ -830,8 +897,8 @@ export interface InternalFailureException extends __SmithyException, $MetadataBe
|
|
|
830
897
|
Message?: string;
|
|
831
898
|
}
|
|
832
899
|
/**
|
|
833
|
-
* <p>Either you have sent too many requests or your input file is too long. Wait before you
|
|
834
|
-
* use a smaller file and resend the request.</p>
|
|
900
|
+
* <p>Either you have sent too many requests or your input file is too long. Wait before you
|
|
901
|
+
* resend your request, or use a smaller file and resend the request.</p>
|
|
835
902
|
*/
|
|
836
903
|
export interface LimitExceededException extends __SmithyException, $MetadataBearer {
|
|
837
904
|
name: "LimitExceededException";
|
|
@@ -839,21 +906,24 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear
|
|
|
839
906
|
Message?: string;
|
|
840
907
|
}
|
|
841
908
|
/**
|
|
842
|
-
* <p>The object that contains the Amazon S3 object location and access role required to train and
|
|
843
|
-
* language model.</p>
|
|
909
|
+
* <p>The object that contains the Amazon S3 object location and access role required to train and
|
|
910
|
+
* tune your custom language model.</p>
|
|
844
911
|
*/
|
|
845
912
|
export interface InputDataConfig {
|
|
846
913
|
/**
|
|
847
|
-
* <p>The Amazon S3 prefix you specify to access the plain text files that you use to train your
|
|
914
|
+
* <p>The Amazon S3 prefix you specify to access the plain text files that you use to train your
|
|
915
|
+
* custom language model.</p>
|
|
848
916
|
*/
|
|
849
917
|
S3Uri: string | undefined;
|
|
850
918
|
/**
|
|
851
|
-
* <p>The Amazon S3 prefix you specify to access the plain text files that you use to tune your
|
|
919
|
+
* <p>The Amazon S3 prefix you specify to access the plain text files that you use to tune your
|
|
920
|
+
* custom language model.</p>
|
|
852
921
|
*/
|
|
853
922
|
TuningDataS3Uri?: string;
|
|
854
923
|
/**
|
|
855
|
-
* <p>The Amazon Resource Name (ARN) that uniquely identifies the permissions you've given
|
|
856
|
-
* Amazon S3 buckets containing your media files or text data. ARNs have the
|
|
924
|
+
* <p>The Amazon Resource Name (ARN) that uniquely identifies the permissions you've given
|
|
925
|
+
* Amazon Transcribe to access your Amazon S3 buckets containing your media files or text data. ARNs have the
|
|
926
|
+
* format
|
|
857
927
|
* <code>arn:partition:service:region:account-id:resource-type/resource-id</code>.</p>
|
|
858
928
|
*/
|
|
859
929
|
DataAccessRoleArn: string | undefined;
|
|
@@ -865,18 +935,19 @@ export declare namespace InputDataConfig {
|
|
|
865
935
|
const filterSensitiveLog: (obj: InputDataConfig) => any;
|
|
866
936
|
}
|
|
867
937
|
/**
|
|
868
|
-
* <p>A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag
|
|
869
|
-
* ‘Department’:’Sales’ might be added to a resource to indicate its use
|
|
938
|
+
* <p>A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag
|
|
939
|
+
* with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use
|
|
940
|
+
* by your organization's sales department.</p>
|
|
870
941
|
*/
|
|
871
942
|
export interface Tag {
|
|
872
943
|
/**
|
|
873
|
-
* <p>The first part of a key:value pair that forms a tag associated with a given resource. For
|
|
874
|
-
* ‘Department’:’Sales’, the key is 'Department'.</p>
|
|
944
|
+
* <p>The first part of a key:value pair that forms a tag associated with a given resource. For
|
|
945
|
+
* example, in the tag ‘Department’:’Sales’, the key is 'Department'.</p>
|
|
875
946
|
*/
|
|
876
947
|
Key: string | undefined;
|
|
877
948
|
/**
|
|
878
|
-
* <p>The second part of a key:value pair that forms a tag associated with a given resource.
|
|
879
|
-
* ‘Department’:’Sales’, the value is 'Sales'.</p>
|
|
949
|
+
* <p>The second part of a key:value pair that forms a tag associated with a given resource.
|
|
950
|
+
* For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.</p>
|
|
880
951
|
*/
|
|
881
952
|
Value: string | undefined;
|
|
882
953
|
}
|
|
@@ -893,11 +964,12 @@ export interface CreateLanguageModelRequest {
|
|
|
893
964
|
*/
|
|
894
965
|
LanguageCode: CLMLanguageCode | string | undefined;
|
|
895
966
|
/**
|
|
896
|
-
* <p>The Amazon Transcribe standard language model, or base model used to create your custom
|
|
897
|
-
*
|
|
898
|
-
*
|
|
899
|
-
*
|
|
900
|
-
*
|
|
967
|
+
* <p>The Amazon Transcribe standard language model, or base model used to create your custom
|
|
968
|
+
* language model.</p>
|
|
969
|
+
* <p>If you want to use your custom language model to transcribe audio with a sample rate
|
|
970
|
+
* of 16,000 Hz or greater, choose <code>Wideband</code>.</p>
|
|
971
|
+
* <p>If you want to use your custom language model to transcribe audio with a sample rate
|
|
972
|
+
* that is less than 16,000 Hz, choose <code>Narrowband</code>.</p>
|
|
901
973
|
*/
|
|
902
974
|
BaseModelName: BaseModelName | string | undefined;
|
|
903
975
|
/**
|
|
@@ -905,13 +977,13 @@ export interface CreateLanguageModelRequest {
|
|
|
905
977
|
*/
|
|
906
978
|
ModelName: string | undefined;
|
|
907
979
|
/**
|
|
908
|
-
* <p>Contains the data access role and the Amazon S3 prefixes to read the required input files to
|
|
909
|
-
* language model.</p>
|
|
980
|
+
* <p>Contains the data access role and the Amazon S3 prefixes to read the required input files to
|
|
981
|
+
* create a custom language model.</p>
|
|
910
982
|
*/
|
|
911
983
|
InputDataConfig: InputDataConfig | undefined;
|
|
912
984
|
/**
|
|
913
|
-
* <p>Adds one or more tags, each in the form of a key:value pair, to a new language model
|
|
914
|
-
* this new model.</p>
|
|
985
|
+
* <p>Adds one or more tags, each in the form of a key:value pair, to a new language model
|
|
986
|
+
* at the time you create this new model.</p>
|
|
915
987
|
*/
|
|
916
988
|
Tags?: Tag[];
|
|
917
989
|
}
|
|
@@ -932,7 +1004,8 @@ export interface CreateLanguageModelResponse {
|
|
|
932
1004
|
*/
|
|
933
1005
|
LanguageCode?: CLMLanguageCode | string;
|
|
934
1006
|
/**
|
|
935
|
-
* <p>The Amazon Transcribe standard language model, or base model you've used to create a custom
|
|
1007
|
+
* <p>The Amazon Transcribe standard language model, or base model you've used to create a custom
|
|
1008
|
+
* language model.</p>
|
|
936
1009
|
*/
|
|
937
1010
|
BaseModelName?: BaseModelName | string;
|
|
938
1011
|
/**
|
|
@@ -944,8 +1017,8 @@ export interface CreateLanguageModelResponse {
|
|
|
944
1017
|
*/
|
|
945
1018
|
InputDataConfig?: InputDataConfig;
|
|
946
1019
|
/**
|
|
947
|
-
* <p>The status of the custom language model. When the status is
|
|
948
|
-
* to use.</p>
|
|
1020
|
+
* <p>The status of the custom language model. When the status is
|
|
1021
|
+
* <code>COMPLETED</code> the model is ready to use.</p>
|
|
949
1022
|
*/
|
|
950
1023
|
ModelStatus?: ModelStatus | string;
|
|
951
1024
|
}
|
|
@@ -957,38 +1030,37 @@ export declare namespace CreateLanguageModelResponse {
|
|
|
957
1030
|
}
|
|
958
1031
|
export interface CreateMedicalVocabularyRequest {
|
|
959
1032
|
/**
|
|
960
|
-
* <p>The name of the custom vocabulary. This case-sensitive name must be unique within
|
|
961
|
-
* account. If you try to create a vocabulary with the same name
|
|
962
|
-
* <code>ConflictException</code> error.</p>
|
|
1033
|
+
* <p>The name of the custom vocabulary. This case-sensitive name must be unique within
|
|
1034
|
+
* an Amazon Web Services account. If you try to create a vocabulary with the same name
|
|
1035
|
+
* as a previous vocabulary, you get a <code>ConflictException</code> error.</p>
|
|
963
1036
|
*/
|
|
964
1037
|
VocabularyName: string | undefined;
|
|
965
1038
|
/**
|
|
966
|
-
* <p>The language code for the language used for the entries in your custom vocabulary.
|
|
967
|
-
* custom vocabulary must match the language code of your
|
|
968
|
-
* code available for Amazon Transcribe Medical.</p>
|
|
1039
|
+
* <p>The language code for the language used for the entries in your custom vocabulary.
|
|
1040
|
+
* The language code of your custom vocabulary must match the language code of your
|
|
1041
|
+
* transcription job. US English (en-US) is the only language code available for Amazon Transcribe Medical.</p>
|
|
969
1042
|
*/
|
|
970
1043
|
LanguageCode: LanguageCode | string | undefined;
|
|
971
1044
|
/**
|
|
972
|
-
* <p>The location in Amazon S3 of the text file you use to define your custom vocabulary. The URI
|
|
973
|
-
* Amazon Web Services Region as the resource that you're calling. Enter
|
|
974
|
-
* <code>VocabularyFileUri</code> in the following format:</p>
|
|
975
|
-
*
|
|
976
|
-
* <code>
|
|
977
|
-
* https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
|
|
978
|
-
* </code>
|
|
1045
|
+
* <p>The location in Amazon S3 of the text file you use to define your custom vocabulary. The URI
|
|
1046
|
+
* must be in the same Amazon Web Services Region as the resource that you're calling. Enter
|
|
1047
|
+
* information about your <code>VocabularyFileUri</code> in the following format:</p>
|
|
1048
|
+
* <p>
|
|
1049
|
+
* <code>https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey></code>
|
|
979
1050
|
* </p>
|
|
980
1051
|
* <p>The following is an example URI for a vocabulary file that is stored in Amazon S3:</p>
|
|
981
1052
|
* <p>
|
|
982
1053
|
* <code>https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt</code>
|
|
983
1054
|
* </p>
|
|
984
|
-
* <p>For more information about Amazon S3 object names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys">Object Keys</a> in
|
|
985
|
-
*
|
|
986
|
-
* <p>For more information about custom vocabularies, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/
|
|
1055
|
+
* <p>For more information about Amazon S3 object names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys">Object Keys</a> in
|
|
1056
|
+
* the <i>Amazon S3 Developer Guide</i>.</p>
|
|
1057
|
+
* <p>For more information about custom vocabularies, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-med.html">Medical Custom
|
|
1058
|
+
* Vocabularies</a>.</p>
|
|
987
1059
|
*/
|
|
988
1060
|
VocabularyFileUri: string | undefined;
|
|
989
1061
|
/**
|
|
990
|
-
* <p>Adds one or more tags, each in the form of a key:value pair, to a new medical
|
|
991
|
-
* create this new vocabulary.</p>
|
|
1062
|
+
* <p>Adds one or more tags, each in the form of a key:value pair, to a new medical
|
|
1063
|
+
* vocabulary at the time you create this new vocabulary.</p>
|
|
992
1064
|
*/
|
|
993
1065
|
Tags?: Tag[];
|
|
994
1066
|
}
|
|
@@ -1005,18 +1077,19 @@ export declare enum VocabularyState {
|
|
|
1005
1077
|
}
|
|
1006
1078
|
export interface CreateMedicalVocabularyResponse {
|
|
1007
1079
|
/**
|
|
1008
|
-
* <p>The name of the vocabulary. The name must be unique within an Amazon Web Services
|
|
1009
|
-
* sensitive.</p>
|
|
1080
|
+
* <p>The name of the vocabulary. The name must be unique within an Amazon Web Services
|
|
1081
|
+
* account and is case sensitive.</p>
|
|
1010
1082
|
*/
|
|
1011
1083
|
VocabularyName?: string;
|
|
1012
1084
|
/**
|
|
1013
|
-
* <p>The language code for the entries in your custom vocabulary. US English (en-US) is the
|
|
1014
|
-
* code for Amazon Transcribe Medical.</p>
|
|
1085
|
+
* <p>The language code for the entries in your custom vocabulary. US English (en-US) is the
|
|
1086
|
+
* only valid language code for Amazon Transcribe Medical.</p>
|
|
1015
1087
|
*/
|
|
1016
1088
|
LanguageCode?: LanguageCode | string;
|
|
1017
1089
|
/**
|
|
1018
|
-
* <p>The processing state of your custom vocabulary in Amazon Transcribe Medical. If the state is
|
|
1019
|
-
* use the vocabulary in a
|
|
1090
|
+
* <p>The processing state of your custom vocabulary in Amazon Transcribe Medical. If the state is
|
|
1091
|
+
* <code>READY</code>, you can use the vocabulary in a
|
|
1092
|
+
* <code>StartMedicalTranscriptionJob</code> request.</p>
|
|
1020
1093
|
*/
|
|
1021
1094
|
VocabularyState?: VocabularyState | string;
|
|
1022
1095
|
/**
|
|
@@ -1024,8 +1097,8 @@ export interface CreateMedicalVocabularyResponse {
|
|
|
1024
1097
|
*/
|
|
1025
1098
|
LastModifiedTime?: Date;
|
|
1026
1099
|
/**
|
|
1027
|
-
* <p>If the <code>VocabularyState</code> field is <code>FAILED</code>, this field contains
|
|
1028
|
-
* why the job failed.</p>
|
|
1100
|
+
* <p>If the <code>VocabularyState</code> field is <code>FAILED</code>, this field contains
|
|
1101
|
+
* information about why the job failed.</p>
|
|
1029
1102
|
*/
|
|
1030
1103
|
FailureReason?: string;
|
|
1031
1104
|
}
|
|
@@ -1037,14 +1110,15 @@ export declare namespace CreateMedicalVocabularyResponse {
|
|
|
1037
1110
|
}
|
|
1038
1111
|
export interface CreateVocabularyRequest {
|
|
1039
1112
|
/**
|
|
1040
|
-
* <p>The name of the vocabulary. The name must be unique within an
|
|
1041
|
-
* is case sensitive. If you try to create a vocabulary
|
|
1113
|
+
* <p>The name of the vocabulary. The name must be unique within an
|
|
1114
|
+
* Amazon Web Services account. The name is case sensitive. If you try to create a vocabulary
|
|
1115
|
+
* with the same name as a previous vocabulary you will receive a
|
|
1042
1116
|
* <code>ConflictException</code> error.</p>
|
|
1043
1117
|
*/
|
|
1044
1118
|
VocabularyName: string | undefined;
|
|
1045
1119
|
/**
|
|
1046
|
-
* <p>The language code of the vocabulary entries. For a list of languages and their
|
|
1047
|
-
* codes, see <a>
|
|
1120
|
+
* <p>The language code of the vocabulary entries. For a list of languages and their
|
|
1121
|
+
* corresponding language codes, see <a>table-language-matrix</a>.</p>
|
|
1048
1122
|
*/
|
|
1049
1123
|
LanguageCode: LanguageCode | string | undefined;
|
|
1050
1124
|
/**
|
|
@@ -1052,19 +1126,24 @@ export interface CreateVocabularyRequest {
|
|
|
1052
1126
|
*/
|
|
1053
1127
|
Phrases?: string[];
|
|
1054
1128
|
/**
|
|
1055
|
-
* <p>The S3 location of the text file that contains the definition of the custom vocabulary. The
|
|
1056
|
-
* same region as the API endpoint that you are calling. The general form
|
|
1057
|
-
*
|
|
1058
|
-
*
|
|
1059
|
-
*
|
|
1129
|
+
* <p>The S3 location of the text file that contains the definition of the custom vocabulary. The
|
|
1130
|
+
* URI must be in the same region as the API endpoint that you are calling. The general form
|
|
1131
|
+
* is:</p>
|
|
1132
|
+
* <p>
|
|
1133
|
+
* <code>https://s3.<Amazon Web Services-region>.amazonaws.com/<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey> </code>
|
|
1134
|
+
* </p>
|
|
1135
|
+
* <p>For example:</p>
|
|
1136
|
+
* <p>
|
|
1137
|
+
* <code>https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt</code>
|
|
1138
|
+
* </p>
|
|
1060
1139
|
* <p>For more information about S3 object names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys">Object Keys</a> in the
|
|
1061
1140
|
* <i>Amazon S3 Developer Guide</i>.</p>
|
|
1062
|
-
* <p>For more information about custom vocabularies, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/
|
|
1141
|
+
* <p>For more information about custom vocabularies, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
|
|
1063
1142
|
*/
|
|
1064
1143
|
VocabularyFileUri?: string;
|
|
1065
1144
|
/**
|
|
1066
|
-
* <p>Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary at
|
|
1067
|
-
* this new vocabulary.</p>
|
|
1145
|
+
* <p>Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary at
|
|
1146
|
+
* the time you create this new vocabulary.</p>
|
|
1068
1147
|
*/
|
|
1069
1148
|
Tags?: Tag[];
|
|
1070
1149
|
}
|
|
@@ -1084,8 +1163,8 @@ export interface CreateVocabularyResponse {
|
|
|
1084
1163
|
*/
|
|
1085
1164
|
LanguageCode?: LanguageCode | string;
|
|
1086
1165
|
/**
|
|
1087
|
-
* <p>The processing state of the vocabulary. When the <code>VocabularyState</code> field
|
|
1088
|
-
* <code>READY</code> the vocabulary is ready to be used in a <code>StartTranscriptionJob</code>
|
|
1166
|
+
* <p>The processing state of the vocabulary. When the <code>VocabularyState</code> field
|
|
1167
|
+
* contains <code>READY</code> the vocabulary is ready to be used in a <code>StartTranscriptionJob</code>
|
|
1089
1168
|
* request.</p>
|
|
1090
1169
|
*/
|
|
1091
1170
|
VocabularyState?: VocabularyState | string;
|
|
@@ -1094,8 +1173,8 @@ export interface CreateVocabularyResponse {
|
|
|
1094
1173
|
*/
|
|
1095
1174
|
LastModifiedTime?: Date;
|
|
1096
1175
|
/**
|
|
1097
|
-
* <p>If the <code>VocabularyState</code> field is <code>FAILED</code>, this field contains
|
|
1098
|
-
* why the job failed.</p>
|
|
1176
|
+
* <p>If the <code>VocabularyState</code> field is <code>FAILED</code>, this field contains
|
|
1177
|
+
* information about why the job failed.</p>
|
|
1099
1178
|
*/
|
|
1100
1179
|
FailureReason?: string;
|
|
1101
1180
|
}
|
|
@@ -1107,34 +1186,38 @@ export declare namespace CreateVocabularyResponse {
|
|
|
1107
1186
|
}
|
|
1108
1187
|
export interface CreateVocabularyFilterRequest {
|
|
1109
1188
|
/**
|
|
1110
|
-
* <p>The vocabulary filter name. The name must be unique within the account that contains
|
|
1111
|
-
* vocabulary filter with the same name as another vocabulary filter, you
|
|
1112
|
-
* error.</p>
|
|
1189
|
+
* <p>The vocabulary filter name. The name must be unique within the account that contains
|
|
1190
|
+
* it. If you try to create a vocabulary filter with the same name as another vocabulary filter, you
|
|
1191
|
+
* get a <code>ConflictException</code> error.</p>
|
|
1113
1192
|
*/
|
|
1114
1193
|
VocabularyFilterName: string | undefined;
|
|
1115
1194
|
/**
|
|
1116
|
-
* <p>The language code of the words in the vocabulary filter. All words in the filter must be
|
|
1117
|
-
* The vocabulary filter can only be used with transcription jobs in the
|
|
1195
|
+
* <p>The language code of the words in the vocabulary filter. All words in the filter must be
|
|
1196
|
+
* in the same language. The vocabulary filter can only be used with transcription jobs in the
|
|
1197
|
+
* specified language.</p>
|
|
1118
1198
|
*/
|
|
1119
1199
|
LanguageCode: LanguageCode | string | undefined;
|
|
1120
1200
|
/**
|
|
1121
|
-
* <p>The words to use in the vocabulary filter. Only use characters from the character set
|
|
1122
|
-
* vocabularies. For a list of character sets, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/
|
|
1201
|
+
* <p>The words to use in the vocabulary filter. Only use characters from the character set
|
|
1202
|
+
* defined for custom vocabularies. For a list of character sets, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
|
|
1203
|
+
* Vocabularies</a>.</p>
|
|
1123
1204
|
* <p>If you provide a list of words in the <code>Words</code> parameter, you can't use the
|
|
1124
1205
|
* <code>VocabularyFilterFileUri</code> parameter.</p>
|
|
1125
1206
|
*/
|
|
1126
1207
|
Words?: string[];
|
|
1127
1208
|
/**
|
|
1128
|
-
* <p>The Amazon S3 location of a text file used as input to create the vocabulary filter. Only
|
|
1129
|
-
* the character set defined for custom vocabularies. For a list of character
|
|
1209
|
+
* <p>The Amazon S3 location of a text file used as input to create the vocabulary filter. Only
|
|
1210
|
+
* use characters from the character set defined for custom vocabularies. For a list of character
|
|
1211
|
+
* sets, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
|
|
1212
|
+
* Vocabularies</a>.</p>
|
|
1130
1213
|
* <p>The specified file must be less than 50 KB of UTF-8 characters.</p>
|
|
1131
|
-
* <p>If you provide the location of a list of words in the <code>VocabularyFilterFileUri</code>
|
|
1132
|
-
* use the <code>Words</code> parameter.</p>
|
|
1214
|
+
* <p>If you provide the location of a list of words in the <code>VocabularyFilterFileUri</code>
|
|
1215
|
+
* parameter, you can't use the <code>Words</code> parameter.</p>
|
|
1133
1216
|
*/
|
|
1134
1217
|
VocabularyFilterFileUri?: string;
|
|
1135
1218
|
/**
|
|
1136
|
-
* <p>Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary
|
|
1137
|
-
* create this new vocabulary filter.</p>
|
|
1219
|
+
* <p>Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary
|
|
1220
|
+
* filter at the time you create this new vocabulary filter.</p>
|
|
1138
1221
|
*/
|
|
1139
1222
|
Tags?: Tag[];
|
|
1140
1223
|
}
|
|
@@ -1319,17 +1402,19 @@ export interface LanguageModel {
|
|
|
1319
1402
|
*/
|
|
1320
1403
|
LanguageCode?: CLMLanguageCode | string;
|
|
1321
1404
|
/**
|
|
1322
|
-
* <p>The Amazon Transcribe standard language model, or base model used to create the custom language
|
|
1405
|
+
* <p>The Amazon Transcribe standard language model, or base model used to create the custom language
|
|
1406
|
+
* model.</p>
|
|
1323
1407
|
*/
|
|
1324
1408
|
BaseModelName?: BaseModelName | string;
|
|
1325
1409
|
/**
|
|
1326
|
-
* <p>The creation status of a custom language model. When the status is
|
|
1327
|
-
* ready for use.</p>
|
|
1410
|
+
* <p>The creation status of a custom language model. When the status is
|
|
1411
|
+
* <code>COMPLETED</code> the model is ready for use.</p>
|
|
1328
1412
|
*/
|
|
1329
1413
|
ModelStatus?: ModelStatus | string;
|
|
1330
1414
|
/**
|
|
1331
|
-
* <p>Whether the base model used for the custom language model is up to date. If this field
|
|
1332
|
-
* then you are running the most up-to-date version of the base model
|
|
1415
|
+
* <p>Whether the base model used for the custom language model is up to date. If this field
|
|
1416
|
+
* is <code>true</code> then you are running the most up-to-date version of the base model
|
|
1417
|
+
* in your custom language model.</p>
|
|
1333
1418
|
*/
|
|
1334
1419
|
UpgradeAvailability?: boolean;
|
|
1335
1420
|
/**
|
|
@@ -1337,7 +1422,8 @@ export interface LanguageModel {
|
|
|
1337
1422
|
*/
|
|
1338
1423
|
FailureReason?: string;
|
|
1339
1424
|
/**
|
|
1340
|
-
* <p>The data access role and Amazon S3 prefixes for the input files used to train the custom
|
|
1425
|
+
* <p>The data access role and Amazon S3 prefixes for the input files used to train the custom
|
|
1426
|
+
* language model.</p>
|
|
1341
1427
|
*/
|
|
1342
1428
|
InputDataConfig?: InputDataConfig;
|
|
1343
1429
|
}
|
|
@@ -1424,45 +1510,48 @@ export declare enum MedicalContentIdentificationType {
|
|
|
1424
1510
|
PHI = "PHI"
|
|
1425
1511
|
}
|
|
1426
1512
|
/**
|
|
1427
|
-
* <p>Optional settings for the <a>StartMedicalTranscriptionJob</a>
|
|
1428
|
-
* operation.</p>
|
|
1513
|
+
* <p>Optional settings for the <a>StartMedicalTranscriptionJob</a> operation.</p>
|
|
1429
1514
|
*/
|
|
1430
1515
|
export interface MedicalTranscriptionSetting {
|
|
1431
1516
|
/**
|
|
1432
|
-
* <p>Determines whether the transcription job uses speaker recognition to identify different
|
|
1433
|
-
* audio. Speaker recognition labels individual speakers in the audio file.
|
|
1434
|
-
* field to true, you must also set the
|
|
1435
|
-
* field.</p>
|
|
1436
|
-
* <p>You can't set both <code>ShowSpeakerLabels</code> and
|
|
1437
|
-
* request. If you set both, your request
|
|
1517
|
+
* <p>Determines whether the transcription job uses speaker recognition to identify different
|
|
1518
|
+
* speakers in the input audio. Speaker recognition labels individual speakers in the audio file.
|
|
1519
|
+
* If you set the <code>ShowSpeakerLabels</code> field to true, you must also set the
|
|
1520
|
+
* maximum number of speaker labels in the <code>MaxSpeakerLabels</code> field.</p>
|
|
1521
|
+
* <p>You can't set both <code>ShowSpeakerLabels</code> and
|
|
1522
|
+
* <code>ChannelIdentification</code> in the same request. If you set both, your request
|
|
1523
|
+
* returns a <code>BadRequestException</code>.</p>
|
|
1438
1524
|
*/
|
|
1439
1525
|
ShowSpeakerLabels?: boolean;
|
|
1440
1526
|
/**
|
|
1441
|
-
* <p>The maximum number of speakers to identify in the input audio. If there are more
|
|
1442
|
-
* number, multiple speakers are identified as a single speaker.
|
|
1443
|
-
* you
|
|
1527
|
+
* <p>The maximum number of speakers to identify in the input audio. If there are more
|
|
1528
|
+
* speakers in the audio than this number, multiple speakers are identified as a single speaker.
|
|
1529
|
+
* If you specify the <code>MaxSpeakerLabels</code> field, you must set the
|
|
1530
|
+
* <code>ShowSpeakerLabels</code> field to true.</p>
|
|
1444
1531
|
*/
|
|
1445
1532
|
MaxSpeakerLabels?: number;
|
|
1446
1533
|
/**
|
|
1447
|
-
* <p>Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the
|
|
1448
|
-
* channel into a single transcription.</p>
|
|
1449
|
-
* <p>Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel,
|
|
1450
|
-
* time of the item and alternative transcriptions of item.
|
|
1451
|
-
* provided by Amazon Transcribe Medical.</p>
|
|
1452
|
-
* <p>You can't set both <code>ShowSpeakerLabels</code> and
|
|
1453
|
-
* request. If you set both, your request
|
|
1454
|
-
*
|
|
1534
|
+
* <p>Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the
|
|
1535
|
+
* transcription output of each channel into a single transcription.</p>
|
|
1536
|
+
* <p>Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel,
|
|
1537
|
+
* including the start time and end time of the item and alternative transcriptions of item.
|
|
1538
|
+
* The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical.</p>
|
|
1539
|
+
* <p>You can't set both <code>ShowSpeakerLabels</code> and
|
|
1540
|
+
* <code>ChannelIdentification</code> in the same request. If you set both, your request
|
|
1541
|
+
* returns a <code>BadRequestException</code>.</p>
|
|
1455
1542
|
*/
|
|
1456
1543
|
ChannelIdentification?: boolean;
|
|
1457
1544
|
/**
|
|
1458
|
-
* <p>Determines whether alternative transcripts are generated along with the transcript that
|
|
1459
|
-
* If you set <code>ShowAlternatives</code> field to true, you must
|
|
1460
|
-
* return in the <code>MaxAlternatives</code>
|
|
1545
|
+
* <p>Determines whether alternative transcripts are generated along with the transcript that
|
|
1546
|
+
* has the highest confidence. If you set <code>ShowAlternatives</code> field to true, you must
|
|
1547
|
+
* also set the maximum number of alternatives to return in the <code>MaxAlternatives</code>
|
|
1548
|
+
* field.</p>
|
|
1461
1549
|
*/
|
|
1462
1550
|
ShowAlternatives?: boolean;
|
|
1463
1551
|
/**
|
|
1464
|
-
* <p>The maximum number of alternatives that you tell the service to return. If you specify
|
|
1465
|
-
* <code>MaxAlternatives</code> field, you must set the <code>ShowAlternatives</code>
|
|
1552
|
+
* <p>The maximum number of alternatives that you tell the service to return. If you specify
|
|
1553
|
+
* the <code>MaxAlternatives</code> field, you must set the <code>ShowAlternatives</code>
|
|
1554
|
+
* field to true.</p>
|
|
1466
1555
|
*/
|
|
1467
1556
|
MaxAlternatives?: number;
|
|
1468
1557
|
/**
|
|
@@ -1485,8 +1574,8 @@ export declare enum Specialty {
|
|
|
1485
1574
|
export interface MedicalTranscript {
|
|
1486
1575
|
/**
|
|
1487
1576
|
* <p>The S3 object location of the medical transcript.</p>
|
|
1488
|
-
* <p>Use this URI to access the medical transcript. This URI points to the S3 bucket you created
|
|
1489
|
-
* transcript.</p>
|
|
1577
|
+
* <p>Use this URI to access the medical transcript. This URI points to the S3 bucket you created
|
|
1578
|
+
* to store the medical transcript.</p>
|
|
1490
1579
|
*/
|
|
1491
1580
|
TranscriptFileUri?: string;
|
|
1492
1581
|
}
|
|
@@ -1519,16 +1608,15 @@ export interface MedicalTranscriptionJob {
|
|
|
1519
1608
|
*/
|
|
1520
1609
|
TranscriptionJobStatus?: TranscriptionJobStatus | string;
|
|
1521
1610
|
/**
|
|
1522
|
-
* <p>The language code for the language spoken in the source audio file. US English (en-US)
|
|
1523
|
-
* language for medical transcriptions. Any other value you enter for
|
|
1524
|
-
* <code>BadRequestException</code> error.</p>
|
|
1611
|
+
* <p>The language code for the language spoken in the source audio file. US English (en-US)
|
|
1612
|
+
* is the only supported language for medical transcriptions. Any other value you enter for
|
|
1613
|
+
* language code results in a <code>BadRequestException</code> error.</p>
|
|
1525
1614
|
*/
|
|
1526
1615
|
LanguageCode?: LanguageCode | string;
|
|
1527
1616
|
/**
|
|
1528
1617
|
* <p>The sample rate, in Hertz, of the source audio containing medical information.</p>
|
|
1529
|
-
* <p>If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to
|
|
1530
|
-
* must match the rate detected by Amazon Transcribe Medical
|
|
1531
|
-
* <code>MedicalMediaSampleHertz</code> blank and let Amazon Transcribe Medical determine the sample rate.</p>
|
|
1618
|
+
* <p>If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to
|
|
1619
|
+
* specify the sample rate, it must match the rate detected by Amazon Transcribe Medical.</p>
|
|
1532
1620
|
*/
|
|
1533
1621
|
MediaSampleRateHertz?: number;
|
|
1534
1622
|
/**
|
|
@@ -1540,8 +1628,8 @@ export interface MedicalTranscriptionJob {
|
|
|
1540
1628
|
*/
|
|
1541
1629
|
Media?: Media;
|
|
1542
1630
|
/**
|
|
1543
|
-
* <p>An object that contains the <code>MedicalTranscript</code>. The
|
|
1544
|
-
* <code>TranscriptFileUri</code>.</p>
|
|
1631
|
+
* <p>An object that contains the <code>MedicalTranscript</code>. The
|
|
1632
|
+
* <code>MedicalTranscript</code> contains the <code>TranscriptFileUri</code>.</p>
|
|
1545
1633
|
*/
|
|
1546
1634
|
Transcript?: MedicalTranscript;
|
|
1547
1635
|
/**
|
|
@@ -1557,8 +1645,8 @@ export interface MedicalTranscriptionJob {
|
|
|
1557
1645
|
*/
|
|
1558
1646
|
CompletionTime?: Date;
|
|
1559
1647
|
/**
|
|
1560
|
-
* <p>If the <code>TranscriptionJobStatus</code> field is <code>FAILED</code>, this field
|
|
1561
|
-
* about why the job failed.</p>
|
|
1648
|
+
* <p>If the <code>TranscriptionJobStatus</code> field is <code>FAILED</code>, this field
|
|
1649
|
+
* contains information about why the job failed.</p>
|
|
1562
1650
|
* <p>The <code>FailureReason</code> field contains one of the following values:</p>
|
|
1563
1651
|
* <ul>
|
|
1564
1652
|
* <li>
|
|
@@ -1569,35 +1657,38 @@ export interface MedicalTranscriptionJob {
|
|
|
1569
1657
|
* </li>
|
|
1570
1658
|
* <li>
|
|
1571
1659
|
* <p>
|
|
1572
|
-
* <code>The media format provided does not match the detected media
|
|
1573
|
-
* of the audio file doesn't match the format specified
|
|
1574
|
-
*
|
|
1660
|
+
* <code>The media format provided does not match the detected media
|
|
1661
|
+
* format</code>- The media format of the audio file doesn't match the format specified
|
|
1662
|
+
* in the <code>MediaFormat</code> field in the request. Check the media format of
|
|
1663
|
+
* your media file and make sure the two values match.</p>
|
|
1575
1664
|
* </li>
|
|
1576
1665
|
* <li>
|
|
1577
1666
|
* <p>
|
|
1578
1667
|
* <code>Invalid sample rate for audio file</code>- The sample rate specified in the
|
|
1579
|
-
* <code>MediaSampleRateHertz</code> of the request isn't valid. The sample rate must
|
|
1580
|
-
* 48,000 Hertz.</p>
|
|
1668
|
+
* <code>MediaSampleRateHertz</code> of the request isn't valid. The sample rate must
|
|
1669
|
+
* be between 8,000 and 48,000 Hertz.</p>
|
|
1581
1670
|
* </li>
|
|
1582
1671
|
* <li>
|
|
1583
1672
|
* <p>
|
|
1584
|
-
* <code>The sample rate provided does not match the detected sample
|
|
1585
|
-
* audio file doesn't match the sample rate specified
|
|
1586
|
-
*
|
|
1673
|
+
* <code>The sample rate provided does not match the detected sample
|
|
1674
|
+
* rate</code>- The sample rate in the audio file doesn't match the sample rate specified
|
|
1675
|
+
* in the <code>MediaSampleRateHertz</code> field in the request. Check the sample rate
|
|
1676
|
+
* of your media file and make sure that the two values match.</p>
|
|
1587
1677
|
* </li>
|
|
1588
1678
|
* <li>
|
|
1589
1679
|
* <p>
|
|
1590
|
-
* <code>Invalid file size: file size too large</code>- The size of your audio file is
|
|
1591
|
-
* process. For more information, see
|
|
1592
|
-
*
|
|
1593
|
-
*
|
|
1680
|
+
* <code>Invalid file size: file size too large</code>- The size of your audio file is
|
|
1681
|
+
* larger than what Amazon Transcribe Medical can process. For more information, see
|
|
1682
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits">Guidelines
|
|
1683
|
+
* and Quotas</a> in the <i>Amazon Transcribe Medical Guide</i>.</p>
|
|
1594
1684
|
* </li>
|
|
1595
1685
|
* <li>
|
|
1596
1686
|
* <p>
|
|
1597
|
-
* <code>Invalid number of channels: number of channels too large</code>- Your
|
|
1598
|
-
* than Amazon Transcribe Medical is configured to process. To request
|
|
1599
|
-
*
|
|
1600
|
-
*
|
|
1687
|
+
* <code>Invalid number of channels: number of channels too large</code>- Your
|
|
1688
|
+
* audio contains more channels than Amazon Transcribe Medical is configured to process. To request
|
|
1689
|
+
* additional channels, see <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe-medical.html">Amazon Transcribe Medical Endpoints and
|
|
1690
|
+
* Quotas</a> in the <i>Amazon Web Services General
|
|
1691
|
+
* Reference</i>.</p>
|
|
1601
1692
|
* </li>
|
|
1602
1693
|
* </ul>
|
|
1603
1694
|
*/
|
|
@@ -1607,20 +1698,23 @@ export interface MedicalTranscriptionJob {
|
|
|
1607
1698
|
*/
|
|
1608
1699
|
Settings?: MedicalTranscriptionSetting;
|
|
1609
1700
|
/**
|
|
1610
|
-
* <p>Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription
|
|
1611
|
-
* <code>PHI</code>, you've configured the job to identify personal health
|
|
1701
|
+
* <p>Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription
|
|
1702
|
+
* job. If the value is <code>PHI</code>, you've configured the job to identify personal health
|
|
1703
|
+
* information (PHI) in the transcription output.</p>
|
|
1612
1704
|
*/
|
|
1613
1705
|
ContentIdentificationType?: MedicalContentIdentificationType | string;
|
|
1614
1706
|
/**
|
|
1615
|
-
* <p>The medical specialty of any clinicians providing a dictation or having a conversation.
|
|
1616
|
-
*
|
|
1707
|
+
* <p>The medical specialty of any clinicians providing a dictation or having a conversation.
|
|
1708
|
+
* Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-medical-conversation.html">Transcribing a medical
|
|
1709
|
+
* conversation</a>for a list of supported specialties.</p>
|
|
1617
1710
|
*/
|
|
1618
1711
|
Specialty?: Specialty | string;
|
|
1619
1712
|
/**
|
|
1620
|
-
* <p>The type of speech in the transcription job. <code>CONVERSATION</code> is generally
|
|
1621
|
-
* dialogues. <code>DICTATION</code> is the setting for physicians
|
|
1622
|
-
*
|
|
1623
|
-
*
|
|
1713
|
+
* <p>The type of speech in the transcription job. <code>CONVERSATION</code> is generally
|
|
1714
|
+
* used for patient-physician dialogues. <code>DICTATION</code> is the setting for physicians
|
|
1715
|
+
* speaking their notes after seeing a patient. For more information, see
|
|
1716
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/what-is-transcribe-med.html">What
|
|
1717
|
+
* is Amazon Transcribe Medical?</a>.</p>
|
|
1624
1718
|
*/
|
|
1625
1719
|
Type?: Type | string;
|
|
1626
1720
|
/**
|
|
@@ -1711,10 +1805,10 @@ export declare namespace GetTranscriptionJobRequest {
|
|
|
1711
1805
|
*/
|
|
1712
1806
|
export interface JobExecutionSettings {
|
|
1713
1807
|
/**
|
|
1714
|
-
* <p>Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit
|
|
1715
|
-
* <code>AllowDeferredExecution</code> field is true, jobs are queued
|
|
1716
|
-
* jobs falls below the concurrent execution limit. If
|
|
1717
|
-
* <code>LimitExceededException</code> exception.</p>
|
|
1808
|
+
* <p>Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit
|
|
1809
|
+
* is exceeded. When the <code>AllowDeferredExecution</code> field is true, jobs are queued
|
|
1810
|
+
* and executed when the number of executing jobs falls below the concurrent execution limit. If
|
|
1811
|
+
* the field is false, Amazon Transcribe returns a <code>LimitExceededException</code> exception.</p>
|
|
1718
1812
|
* <p>Note that job queuing is enabled by default for call analytics jobs.</p>
|
|
1719
1813
|
* <p>If you specify the <code>AllowDeferredExecution</code> field, you must specify the
|
|
1720
1814
|
* <code>DataAccessRoleArn</code> field.</p>
|
|
@@ -1723,9 +1817,9 @@ export interface JobExecutionSettings {
|
|
|
1723
1817
|
/**
|
|
1724
1818
|
* <p>The Amazon Resource Name (ARN), in the form
|
|
1725
1819
|
* <code>arn:partition:service:region:account-id:resource-type/resource-id</code>, of a role
|
|
1726
|
-
* that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to
|
|
1727
|
-
* media files. If you have specified an output S3 bucket for the transcription
|
|
1728
|
-
* have access to the output bucket as well.</p>
|
|
1820
|
+
* that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to
|
|
1821
|
+
* read queued media files. If you have specified an output S3 bucket for the transcription
|
|
1822
|
+
* results, this role should have access to the output bucket as well.</p>
|
|
1729
1823
|
* <p>If you specify the <code>AllowDeferredExecution</code> field, you must specify the
|
|
1730
1824
|
* <code>DataAccessRoleArn</code> field.</p>
|
|
1731
1825
|
*/
|
|
@@ -1761,51 +1855,57 @@ export interface Settings {
|
|
|
1761
1855
|
*/
|
|
1762
1856
|
VocabularyName?: string;
|
|
1763
1857
|
/**
|
|
1764
|
-
* <p>Determines whether the transcription job uses speaker recognition to identify different
|
|
1765
|
-
* audio. Speaker recognition labels individual speakers in the audio file.
|
|
1766
|
-
* field to true, you must also set the
|
|
1767
|
-
*
|
|
1768
|
-
*
|
|
1858
|
+
* <p>Determines whether the transcription job uses speaker recognition to identify different
|
|
1859
|
+
* speakers in the input audio. Speaker recognition labels individual speakers in the audio file.
|
|
1860
|
+
* If you set the <code>ShowSpeakerLabels</code> field to true, you must also set the
|
|
1861
|
+
* maximum number of speaker labels <code>MaxSpeakerLabels</code> field.</p>
|
|
1862
|
+
* <p>You can't set both <code>ShowSpeakerLabels</code> and
|
|
1863
|
+
* <code>ChannelIdentification</code> in the same request. If you set both, your request returns
|
|
1864
|
+
* a <code>BadRequestException</code>.</p>
|
|
1769
1865
|
*/
|
|
1770
1866
|
ShowSpeakerLabels?: boolean;
|
|
1771
1867
|
/**
|
|
1772
|
-
* <p>The maximum number of speakers to identify in the input audio. If there are more
|
|
1773
|
-
* this number, multiple speakers are identified as a single speaker.
|
|
1774
|
-
*
|
|
1868
|
+
* <p>The maximum number of speakers to identify in the input audio. If there are more
|
|
1869
|
+
* speakers in the audio than this number, multiple speakers are identified as a single speaker.
|
|
1870
|
+
* If you specify the <code>MaxSpeakerLabels</code> field, you must set the
|
|
1871
|
+
* <code>ShowSpeakerLabels</code> field to true.</p>
|
|
1775
1872
|
*/
|
|
1776
1873
|
MaxSpeakerLabels?: number;
|
|
1777
1874
|
/**
|
|
1778
|
-
* <p>Instructs Amazon Transcribe to process each audio channel separately and then merge the
|
|
1779
|
-
* channel into a single transcription
|
|
1780
|
-
* <p>Amazon Transcribe also produces a transcription of each item detected on an audio channel,
|
|
1781
|
-
* end time of the item and alternative transcriptions of the item
|
|
1782
|
-
* transcription.</p>
|
|
1783
|
-
* <p>You can't set both <code>ShowSpeakerLabels</code> and
|
|
1784
|
-
* request. If you set both, your request
|
|
1875
|
+
* <p>Instructs Amazon Transcribe to process each audio channel separately and then merge the
|
|
1876
|
+
* transcription output of each channel into a single transcription.</p>
|
|
1877
|
+
* <p>Amazon Transcribe also produces a transcription of each item detected on an audio channel,
|
|
1878
|
+
* including the start time and end time of the item and alternative transcriptions of the item
|
|
1879
|
+
* including the confidence that Amazon Transcribe has in the transcription.</p>
|
|
1880
|
+
* <p>You can't set both <code>ShowSpeakerLabels</code> and
|
|
1881
|
+
* <code>ChannelIdentification</code> in the same request. If you set both, your request
|
|
1882
|
+
* returns a <code>BadRequestException</code>.</p>
|
|
1785
1883
|
*/
|
|
1786
1884
|
ChannelIdentification?: boolean;
|
|
1787
1885
|
/**
|
|
1788
1886
|
* <p>Determines whether the transcription contains alternative transcriptions. If you set the
|
|
1789
|
-
* <code>ShowAlternatives</code> field to true, you must also set the maximum number of
|
|
1790
|
-
* <code>MaxAlternatives</code> field.</p>
|
|
1887
|
+
* <code>ShowAlternatives</code> field to true, you must also set the maximum number of
|
|
1888
|
+
* alternatives to return in the <code>MaxAlternatives</code> field.</p>
|
|
1791
1889
|
*/
|
|
1792
1890
|
ShowAlternatives?: boolean;
|
|
1793
1891
|
/**
|
|
1794
|
-
* <p>The number of alternative transcriptions that the service should return. If you specify
|
|
1795
|
-
* <code>MaxAlternatives</code> field, you must set the <code>ShowAlternatives</code>
|
|
1892
|
+
* <p>The number of alternative transcriptions that the service should return. If you specify
|
|
1893
|
+
* the <code>MaxAlternatives</code> field, you must set the <code>ShowAlternatives</code>
|
|
1894
|
+
* field to true.</p>
|
|
1796
1895
|
*/
|
|
1797
1896
|
MaxAlternatives?: number;
|
|
1798
1897
|
/**
|
|
1799
|
-
* <p>The name of the vocabulary filter to use when transcribing the audio. The filter that you
|
|
1800
|
-
* same language code as the transcription job.</p>
|
|
1898
|
+
* <p>The name of the vocabulary filter to use when transcribing the audio. The filter that you
|
|
1899
|
+
* specify must have the same language code as the transcription job.</p>
|
|
1801
1900
|
*/
|
|
1802
1901
|
VocabularyFilterName?: string;
|
|
1803
1902
|
/**
|
|
1804
|
-
* <p>Set to <code>mask</code> to remove filtered text from the transcript and replace it
|
|
1805
|
-
* as placeholder text. Set to <code>remove</code> to remove
|
|
1806
|
-
* placeholder text. Set to <code>tag</code> to
|
|
1807
|
-
*
|
|
1808
|
-
*
|
|
1903
|
+
* <p>Set to <code>mask</code> to remove filtered text from the transcript and replace it
|
|
1904
|
+
* with three asterisks ("***") as placeholder text. Set to <code>remove</code> to remove
|
|
1905
|
+
* filtered text from the transcript without using placeholder text. Set to <code>tag</code> to
|
|
1906
|
+
* mark the word in the transcription output that matches the vocabulary filter. When you set
|
|
1907
|
+
* the filter method to <code>tag</code>, the words matching your vocabulary filter are not
|
|
1908
|
+
* masked or removed.</p>
|
|
1809
1909
|
*/
|
|
1810
1910
|
VocabularyFilterMethod?: VocabularyFilterMethod | string;
|
|
1811
1911
|
}
|
|
@@ -1824,11 +1924,13 @@ export declare enum SubtitleFormat {
|
|
|
1824
1924
|
*/
|
|
1825
1925
|
export interface SubtitlesOutput {
|
|
1826
1926
|
/**
|
|
1827
|
-
* <p>Specify the output format for your subtitle file; if you select both SRT and VTT formats,
|
|
1927
|
+
* <p>Specify the output format for your subtitle file; if you select both SRT and VTT formats,
|
|
1928
|
+
* two output files are generated.</p>
|
|
1828
1929
|
*/
|
|
1829
1930
|
Formats?: (SubtitleFormat | string)[];
|
|
1830
1931
|
/**
|
|
1831
|
-
* <p>Choose the output location for your subtitle file. This location must be an S3
|
|
1932
|
+
* <p>Choose the output location for your subtitle file. This location must be an S3
|
|
1933
|
+
* bucket.</p>
|
|
1832
1934
|
*/
|
|
1833
1935
|
SubtitleFileUris?: string[];
|
|
1834
1936
|
}
|
|
@@ -1839,8 +1941,8 @@ export declare namespace SubtitlesOutput {
|
|
|
1839
1941
|
const filterSensitiveLog: (obj: SubtitlesOutput) => any;
|
|
1840
1942
|
}
|
|
1841
1943
|
/**
|
|
1842
|
-
* <p>Describes an asynchronous transcription job that was created with the
|
|
1843
|
-
* operation. </p>
|
|
1944
|
+
* <p>Describes an asynchronous transcription job that was created with the
|
|
1945
|
+
* <code>StartTranscriptionJob</code> operation. </p>
|
|
1844
1946
|
*/
|
|
1845
1947
|
export interface TranscriptionJob {
|
|
1846
1948
|
/**
|
|
@@ -1856,7 +1958,7 @@ export interface TranscriptionJob {
|
|
|
1856
1958
|
*/
|
|
1857
1959
|
LanguageCode?: LanguageCode | string;
|
|
1858
1960
|
/**
|
|
1859
|
-
* <p>The sample rate, in Hertz, of the audio track in the input media file
|
|
1961
|
+
* <p>The sample rate, in Hertz (Hz), of the audio track in the input media file.</p>
|
|
1860
1962
|
*/
|
|
1861
1963
|
MediaSampleRateHertz?: number;
|
|
1862
1964
|
/**
|
|
@@ -1884,52 +1986,57 @@ export interface TranscriptionJob {
|
|
|
1884
1986
|
*/
|
|
1885
1987
|
CompletionTime?: Date;
|
|
1886
1988
|
/**
|
|
1887
|
-
* <p>If the <code>TranscriptionJobStatus</code> field is <code>FAILED</code>, this field
|
|
1888
|
-
* about why the job failed.</p>
|
|
1989
|
+
* <p>If the <code>TranscriptionJobStatus</code> field is <code>FAILED</code>, this field
|
|
1990
|
+
* contains information about why the job failed.</p>
|
|
1889
1991
|
* <p>The <code>FailureReason</code> field can contain one of the following values:</p>
|
|
1890
1992
|
* <ul>
|
|
1891
1993
|
* <li>
|
|
1892
1994
|
* <p>
|
|
1893
|
-
* <code>Unsupported media format</code> - The media format specified in the
|
|
1894
|
-
* field of the request isn't valid. See the description of the
|
|
1895
|
-
* values.</p>
|
|
1995
|
+
* <code>Unsupported media format</code> - The media format specified in the
|
|
1996
|
+
* <code>MediaFormat</code> field of the request isn't valid. See the description of the
|
|
1997
|
+
* <code>MediaFormat</code> field for a list of valid values.</p>
|
|
1896
1998
|
* </li>
|
|
1897
1999
|
* <li>
|
|
1898
2000
|
* <p>
|
|
1899
|
-
* <code>The media format provided does not match the detected media
|
|
1900
|
-
* of the audio file doesn't match the format specified
|
|
1901
|
-
* the
|
|
2001
|
+
* <code>The media format provided does not match the detected media
|
|
2002
|
+
* format</code> - The media format of the audio file doesn't match the format specified
|
|
2003
|
+
* in the <code>MediaFormat</code> field in the request. Check the media format of
|
|
2004
|
+
* your media file and make sure that the two values match.</p>
|
|
1902
2005
|
* </li>
|
|
1903
2006
|
* <li>
|
|
1904
2007
|
* <p>
|
|
1905
2008
|
* <code>Invalid sample rate for audio file</code> - The sample rate specified in the
|
|
1906
|
-
* <code>MediaSampleRateHertz</code> of the request isn't valid. The sample rate must
|
|
1907
|
-
* 48,000 Hertz.</p>
|
|
2009
|
+
* <code>MediaSampleRateHertz</code> of the request isn't valid. The sample rate must
|
|
2010
|
+
* be between 8,000 and 48,000 Hertz.</p>
|
|
1908
2011
|
* </li>
|
|
1909
2012
|
* <li>
|
|
1910
2013
|
* <p>
|
|
1911
|
-
* <code>The sample rate provided does not match the detected sample
|
|
1912
|
-
*
|
|
1913
|
-
*
|
|
2014
|
+
* <code>The sample rate provided does not match the detected sample
|
|
2015
|
+
* rate</code> - The sample rate in the audio file doesn't match the sample rate
|
|
2016
|
+
* specified in the <code>MediaSampleRateHertz</code> field in the request. Check
|
|
2017
|
+
* the sample rate of your media file and make sure that the two values match.</p>
|
|
1914
2018
|
* </li>
|
|
1915
2019
|
* <li>
|
|
1916
2020
|
* <p>
|
|
1917
|
-
* <code>Invalid file size: file size too large</code> - The size of your audio file is
|
|
1918
|
-
* For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits">Limits</a> in the
|
|
2021
|
+
* <code>Invalid file size: file size too large</code> - The size of your audio file is
|
|
2022
|
+
* larger than Amazon Transcribe can process. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits">Limits</a> in the
|
|
2023
|
+
* <i>Amazon Transcribe Developer Guide</i>.</p>
|
|
1919
2024
|
* </li>
|
|
1920
2025
|
* <li>
|
|
1921
2026
|
* <p>
|
|
1922
|
-
* <code>Invalid number of channels: number of channels too large</code> - Your
|
|
1923
|
-
* channels than Amazon Transcribe is configured to process. To request additional
|
|
1924
|
-
*
|
|
2027
|
+
* <code>Invalid number of channels: number of channels too large</code> - Your
|
|
2028
|
+
* audio contains more channels than Amazon Transcribe is configured to process. To request additional
|
|
2029
|
+
* channels, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits-amazon-transcribe">Amazon
|
|
2030
|
+
* Transcribe Limits</a> in the <i>Amazon Web Services General
|
|
2031
|
+
* Reference</i>.</p>
|
|
1925
2032
|
* </li>
|
|
1926
2033
|
* </ul>
|
|
1927
2034
|
*/
|
|
1928
2035
|
FailureReason?: string;
|
|
1929
2036
|
/**
|
|
1930
|
-
* <p>Optional settings for the transcription job. Use these settings to turn on speaker
|
|
1931
|
-
* maximum number of speakers that should be identified and to specify
|
|
1932
|
-
* the transcription job.</p>
|
|
2037
|
+
* <p>Optional settings for the transcription job. Use these settings to turn on speaker
|
|
2038
|
+
* recognition, to set the maximum number of speakers that should be identified and to specify
|
|
2039
|
+
* a custom vocabulary to use when processing the transcription job.</p>
|
|
1933
2040
|
*/
|
|
1934
2041
|
Settings?: Settings;
|
|
1935
2042
|
/**
|
|
@@ -1945,17 +2052,19 @@ export interface TranscriptionJob {
|
|
|
1945
2052
|
*/
|
|
1946
2053
|
ContentRedaction?: ContentRedaction;
|
|
1947
2054
|
/**
|
|
1948
|
-
* <p>A value that shows if automatic language identification was enabled for a transcription
|
|
2055
|
+
* <p>A value that shows if automatic language identification was enabled for a transcription
|
|
2056
|
+
* job.</p>
|
|
1949
2057
|
*/
|
|
1950
2058
|
IdentifyLanguage?: boolean;
|
|
1951
2059
|
/**
|
|
1952
|
-
* <p>An object that shows the optional array of languages inputted for transcription jobs
|
|
1953
|
-
* identification enabled.</p>
|
|
2060
|
+
* <p>An object that shows the optional array of languages inputted for transcription jobs with
|
|
2061
|
+
* automatic language identification enabled.</p>
|
|
1954
2062
|
*/
|
|
1955
2063
|
LanguageOptions?: (LanguageCode | string)[];
|
|
1956
2064
|
/**
|
|
1957
|
-
* <p>A value between zero and one that Amazon Transcribe assigned to the language that it identified in
|
|
1958
|
-
* values indicate that Amazon Transcribe has higher confidence in the language it
|
|
2065
|
+
* <p>A value between zero and one that Amazon Transcribe assigned to the language that it identified in
|
|
2066
|
+
* the source audio. Larger values indicate that Amazon Transcribe has higher confidence in the language it
|
|
2067
|
+
* identified.</p>
|
|
1959
2068
|
*/
|
|
1960
2069
|
IdentifiedLanguageScore?: number;
|
|
1961
2070
|
/**
|
|
@@ -1967,9 +2076,9 @@ export interface TranscriptionJob {
|
|
|
1967
2076
|
*/
|
|
1968
2077
|
Subtitles?: SubtitlesOutput;
|
|
1969
2078
|
/**
|
|
1970
|
-
* <p>Language-specific settings that can be specified when language identification is enabled
|
|
1971
|
-
* job. These settings include <code>VocabularyName</code>,
|
|
1972
|
-
* <code>
|
|
2079
|
+
* <p>Language-specific settings that can be specified when language identification is enabled
|
|
2080
|
+
* for your transcription job. These settings include <code>VocabularyName</code>,
|
|
2081
|
+
* <code>VocabularyFilterName</code>, and <code>LanguageModelName</code>.</p>
|
|
1973
2082
|
*/
|
|
1974
2083
|
LanguageIdSettings?: {
|
|
1975
2084
|
[key: string]: LanguageIdSettings;
|
|
@@ -2097,11 +2206,12 @@ export declare namespace ListCallAnalyticsCategoriesRequest {
|
|
|
2097
2206
|
}
|
|
2098
2207
|
export interface ListCallAnalyticsCategoriesResponse {
|
|
2099
2208
|
/**
|
|
2100
|
-
* <p>The operation returns a page of jobs at
|
|
2101
|
-
* maximum size of the list is set by the <code>MaxResults</code> parameter. If
|
|
2102
|
-
* more categories in the list than the page size, Amazon Transcribe returns the
|
|
2103
|
-
* token. Include the token in the next request to the
|
|
2104
|
-
*
|
|
2209
|
+
* <p>The operation returns a page of jobs at
|
|
2210
|
+
* a time. The maximum size of the list is set by the <code>MaxResults</code> parameter. If
|
|
2211
|
+
* there are more categories in the list than the page size, Amazon Transcribe returns the
|
|
2212
|
+
* <code>NextPage</code> token. Include the token in the next request to the
|
|
2213
|
+
* operation to return the next page of analytics
|
|
2214
|
+
* categories.</p>
|
|
2105
2215
|
*/
|
|
2106
2216
|
NextToken?: string;
|
|
2107
2217
|
/**
|
|
@@ -2129,14 +2239,14 @@ export interface ListCallAnalyticsJobsRequest {
|
|
|
2129
2239
|
JobNameContains?: string;
|
|
2130
2240
|
/**
|
|
2131
2241
|
* <p>If you receive a truncated result in the previous request of
|
|
2132
|
-
* ,
|
|
2133
|
-
*
|
|
2242
|
+
* , include <code>NextToken</code> to fetch the
|
|
2243
|
+
* next set of jobs.</p>
|
|
2134
2244
|
*/
|
|
2135
2245
|
NextToken?: string;
|
|
2136
2246
|
/**
|
|
2137
|
-
* <p> The maximum number of call analytics jobs to return in each page of results. If there
|
|
2138
|
-
* fewer results than the value you specify, only the actual results are returned. If you do
|
|
2139
|
-
* specify a value, the default of 5 is used. </p>
|
|
2247
|
+
* <p> The maximum number of call analytics jobs to return in each page of results. If there
|
|
2248
|
+
* are fewer results than the value you specify, only the actual results are returned. If you do
|
|
2249
|
+
* not specify a value, the default of 5 is used. </p>
|
|
2140
2250
|
*/
|
|
2141
2251
|
MaxResults?: number;
|
|
2142
2252
|
}
|
|
@@ -2154,10 +2264,11 @@ export interface ListCallAnalyticsJobsResponse {
|
|
|
2154
2264
|
*/
|
|
2155
2265
|
Status?: CallAnalyticsJobStatus | string;
|
|
2156
2266
|
/**
|
|
2157
|
-
* <p>The operation returns a page of jobs at a time.
|
|
2158
|
-
* maximum size of the page is set by the <code>MaxResults</code> parameter. If there are
|
|
2159
|
-
* jobs in the list than the page size, Amazon Transcribe returns the <code>NextPage</code> token.
|
|
2160
|
-
* token in your next request to the
|
|
2267
|
+
* <p>The operation returns a page of jobs at a time.
|
|
2268
|
+
* The maximum size of the page is set by the <code>MaxResults</code> parameter. If there are
|
|
2269
|
+
* more jobs in the list than the page size, Amazon Transcribe returns the <code>NextPage</code> token.
|
|
2270
|
+
* Include the token in your next request to the
|
|
2271
|
+
* operation to return next page of jobs.</p>
|
|
2161
2272
|
*/
|
|
2162
2273
|
NextToken?: string;
|
|
2163
2274
|
/**
|
|
@@ -2173,22 +2284,25 @@ export declare namespace ListCallAnalyticsJobsResponse {
|
|
|
2173
2284
|
}
|
|
2174
2285
|
export interface ListLanguageModelsRequest {
|
|
2175
2286
|
/**
|
|
2176
|
-
* <p>When specified, returns only custom language models with the specified status. Language
|
|
2177
|
-
* by creation date, with the newest models first. If you don't specify a
|
|
2178
|
-
* models ordered by date.</p>
|
|
2287
|
+
* <p>When specified, returns only custom language models with the specified status. Language
|
|
2288
|
+
* models are ordered by creation date, with the newest models first. If you don't specify a
|
|
2289
|
+
* status, Amazon Transcribe returns all custom language models ordered by date.</p>
|
|
2179
2290
|
*/
|
|
2180
2291
|
StatusEquals?: ModelStatus | string;
|
|
2181
2292
|
/**
|
|
2182
|
-
* <p>When specified, the custom language model names returned contain the substring you've
|
|
2293
|
+
* <p>When specified, the custom language model names returned contain the substring you've
|
|
2294
|
+
* specified.</p>
|
|
2183
2295
|
*/
|
|
2184
2296
|
NameContains?: string;
|
|
2185
2297
|
/**
|
|
2186
|
-
* <p>When included, fetches the next set of jobs if the result of the previous request was
|
|
2298
|
+
* <p>When included, fetches the next set of jobs if the result of the previous request was
|
|
2299
|
+
* truncated.</p>
|
|
2187
2300
|
*/
|
|
2188
2301
|
NextToken?: string;
|
|
2189
2302
|
/**
|
|
2190
|
-
* <p> The maximum number of language models to return in each page of results. If there are
|
|
2191
|
-
* value you specify, only the actual results are returned. If you do not
|
|
2303
|
+
* <p> The maximum number of language models to return in each page of results. If there are
|
|
2304
|
+
* fewer results than the value you specify, only the actual results are returned. If you do not
|
|
2305
|
+
* specify a value, the default of 5 is used.</p>
|
|
2192
2306
|
*/
|
|
2193
2307
|
MaxResults?: number;
|
|
2194
2308
|
}
|
|
@@ -2200,9 +2314,12 @@ export declare namespace ListLanguageModelsRequest {
|
|
|
2200
2314
|
}
|
|
2201
2315
|
export interface ListLanguageModelsResponse {
|
|
2202
2316
|
/**
|
|
2203
|
-
* <p>The operation returns a page of jobs at a
|
|
2204
|
-
* of the list is set by the MaxResults parameter. If there are more
|
|
2205
|
-
*
|
|
2317
|
+
* <p>The operation returns a page of jobs at a
|
|
2318
|
+
* time. The maximum size of the list is set by the MaxResults parameter. If there are more
|
|
2319
|
+
* language models in the list than the page size, Amazon Transcribe returns the <code>NextPage</code>
|
|
2320
|
+
* token. Include the token in the next request to the
|
|
2321
|
+
* operation to return the next page of language
|
|
2322
|
+
* models.</p>
|
|
2206
2323
|
*/
|
|
2207
2324
|
NextToken?: string;
|
|
2208
2325
|
/**
|
|
@@ -2218,24 +2335,26 @@ export declare namespace ListLanguageModelsResponse {
|
|
|
2218
2335
|
}
|
|
2219
2336
|
export interface ListMedicalTranscriptionJobsRequest {
|
|
2220
2337
|
/**
|
|
2221
|
-
* <p>When specified, returns only medical transcription jobs with the specified status. Jobs
|
|
2222
|
-
* date, with the newest jobs returned first. If you don't specify a status,
|
|
2223
|
-
* by creation date.</p>
|
|
2338
|
+
* <p>When specified, returns only medical transcription jobs with the specified status. Jobs
|
|
2339
|
+
* are ordered by creation date, with the newest jobs returned first. If you don't specify a status,
|
|
2340
|
+
* Amazon Transcribe Medical returns all transcription jobs ordered by creation date.</p>
|
|
2224
2341
|
*/
|
|
2225
2342
|
Status?: TranscriptionJobStatus | string;
|
|
2226
2343
|
/**
|
|
2227
|
-
* <p>When specified, the jobs returned in the list are limited to jobs whose name contains the
|
|
2344
|
+
* <p>When specified, the jobs returned in the list are limited to jobs whose name contains the
|
|
2345
|
+
* specified string.</p>
|
|
2228
2346
|
*/
|
|
2229
2347
|
JobNameContains?: string;
|
|
2230
2348
|
/**
|
|
2231
|
-
* <p>If you a receive a truncated result in the previous request of
|
|
2232
|
-
* include <code>NextToken</code> to fetch the
|
|
2349
|
+
* <p>If you a receive a truncated result in the previous request of
|
|
2350
|
+
* <code>ListMedicalTranscriptionJobs</code>, include <code>NextToken</code> to fetch the
|
|
2351
|
+
* next set of jobs.</p>
|
|
2233
2352
|
*/
|
|
2234
2353
|
NextToken?: string;
|
|
2235
2354
|
/**
|
|
2236
|
-
* <p> The maximum number of medical transcription jobs to return in each page of results. If
|
|
2237
|
-
* results than the value you specify, only the actual results are returned. If you
|
|
2238
|
-
* 5 is used.</p>
|
|
2355
|
+
* <p> The maximum number of medical transcription jobs to return in each page of results. If
|
|
2356
|
+
* there are fewer results than the value you specify, only the actual results are returned. If you
|
|
2357
|
+
* do not specify a value, the default of 5 is used.</p>
|
|
2239
2358
|
*/
|
|
2240
2359
|
MaxResults?: number;
|
|
2241
2360
|
}
|
|
@@ -2278,22 +2397,25 @@ export interface MedicalTranscriptionJobSummary {
|
|
|
2278
2397
|
*/
|
|
2279
2398
|
TranscriptionJobStatus?: TranscriptionJobStatus | string;
|
|
2280
2399
|
/**
|
|
2281
|
-
* <p>If the <code>TranscriptionJobStatus</code> field is <code>FAILED</code>, a description
|
|
2400
|
+
* <p>If the <code>TranscriptionJobStatus</code> field is <code>FAILED</code>, a description
|
|
2401
|
+
* of the error.</p>
|
|
2282
2402
|
*/
|
|
2283
2403
|
FailureReason?: string;
|
|
2284
2404
|
/**
|
|
2285
|
-
* <p>Indicates the location of the transcription job's output. This field must be the path of an
|
|
2286
|
-
* already have an S3 bucket, one is created based on the path you
|
|
2405
|
+
* <p>Indicates the location of the transcription job's output. This field must be the path of an
|
|
2406
|
+
* S3 bucket; if you don't already have an S3 bucket, one is created based on the path you
|
|
2407
|
+
* add.</p>
|
|
2287
2408
|
*/
|
|
2288
2409
|
OutputLocationType?: OutputLocationType | string;
|
|
2289
2410
|
/**
|
|
2290
|
-
* <p>The medical specialty of the transcription job. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-medical-conversation.html">Transcribing a medical
|
|
2291
|
-
* list of supported specialties.</p>
|
|
2411
|
+
* <p>The medical specialty of the transcription job. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-medical-conversation.html">Transcribing a medical
|
|
2412
|
+
* conversation</a>for a list of supported specialties.</p>
|
|
2292
2413
|
*/
|
|
2293
2414
|
Specialty?: Specialty | string;
|
|
2294
2415
|
/**
|
|
2295
|
-
* <p>Shows the type of information you've configured Amazon Transcribe Medical to identify in a transcription job.
|
|
2296
|
-
* <code>PHI</code>, you've configured the transcription job to identify personal
|
|
2416
|
+
* <p>Shows the type of information you've configured Amazon Transcribe Medical to identify in a transcription job.
|
|
2417
|
+
* If the value is <code>PHI</code>, you've configured the transcription job to identify personal
|
|
2418
|
+
* health information (PHI).</p>
|
|
2297
2419
|
*/
|
|
2298
2420
|
ContentIdentificationType?: MedicalContentIdentificationType | string;
|
|
2299
2421
|
/**
|
|
@@ -2313,10 +2435,12 @@ export interface ListMedicalTranscriptionJobsResponse {
|
|
|
2313
2435
|
*/
|
|
2314
2436
|
Status?: TranscriptionJobStatus | string;
|
|
2315
2437
|
/**
|
|
2316
|
-
* <p>The <code>ListMedicalTranscriptionJobs</code> operation returns a page of jobs at a
|
|
2317
|
-
* size of the page is set by the <code>MaxResults</code> parameter. If
|
|
2318
|
-
*
|
|
2319
|
-
* <code>
|
|
2438
|
+
* <p>The <code>ListMedicalTranscriptionJobs</code> operation returns a page of jobs at a
|
|
2439
|
+
* time. The maximum size of the page is set by the <code>MaxResults</code> parameter. If
|
|
2440
|
+
* the number of jobs exceeds what can fit on a page, Amazon Transcribe Medical returns the
|
|
2441
|
+
* <code>NextPage</code> token. Include the token in the next request to the
|
|
2442
|
+
* <code>ListMedicalTranscriptionJobs</code> operation to return in the next page of
|
|
2443
|
+
* jobs.</p>
|
|
2320
2444
|
*/
|
|
2321
2445
|
NextToken?: string;
|
|
2322
2446
|
/**
|
|
@@ -2332,24 +2456,26 @@ export declare namespace ListMedicalTranscriptionJobsResponse {
|
|
|
2332
2456
|
}
|
|
2333
2457
|
export interface ListMedicalVocabulariesRequest {
|
|
2334
2458
|
/**
|
|
2335
|
-
* <p>If the result of your previous request to <code>ListMedicalVocabularies</code> was
|
|
2336
|
-
* <code>NextToken</code> to fetch the next set of vocabularies.</p>
|
|
2459
|
+
* <p>If the result of your previous request to <code>ListMedicalVocabularies</code> was
|
|
2460
|
+
* truncated, include the <code>NextToken</code> to fetch the next set of vocabularies.</p>
|
|
2337
2461
|
*/
|
|
2338
2462
|
NextToken?: string;
|
|
2339
2463
|
/**
|
|
2340
|
-
* <p>The maximum number of vocabularies to return in each page of results. If there are fewer
|
|
2341
|
-
* value you specify, only the actual results are returned. If you do not specify
|
|
2464
|
+
* <p>The maximum number of vocabularies to return in each page of results. If there are fewer
|
|
2465
|
+
* results than the value you specify, only the actual results are returned. If you do not specify
|
|
2466
|
+
* a value, the default of 5 is used.</p>
|
|
2342
2467
|
*/
|
|
2343
2468
|
MaxResults?: number;
|
|
2344
2469
|
/**
|
|
2345
|
-
* <p>When specified, returns only vocabularies with the <code>VocabularyState</code> equal
|
|
2346
|
-
* vocabulary state. Use this field to see which vocabularies are ready for your
|
|
2470
|
+
* <p>When specified, returns only vocabularies with the <code>VocabularyState</code> equal
|
|
2471
|
+
* to the specified vocabulary state. Use this field to see which vocabularies are ready for your
|
|
2472
|
+
* medical transcription jobs.</p>
|
|
2347
2473
|
*/
|
|
2348
2474
|
StateEquals?: VocabularyState | string;
|
|
2349
2475
|
/**
|
|
2350
|
-
* <p>Returns vocabularies whose names contain the specified string. The search is not case
|
|
2351
|
-
* <code>ListMedicalVocabularies</code> returns both
|
|
2352
|
-
* "<code>VocabularyName</code>".</p>
|
|
2476
|
+
* <p>Returns vocabularies whose names contain the specified string. The search is not case
|
|
2477
|
+
* sensitive. <code>ListMedicalVocabularies</code> returns both
|
|
2478
|
+
* "<code>vocabularyname</code>" and "<code>VocabularyName</code>".</p>
|
|
2353
2479
|
*/
|
|
2354
2480
|
NameContains?: string;
|
|
2355
2481
|
}
|
|
@@ -2360,7 +2486,7 @@ export declare namespace ListMedicalVocabulariesRequest {
|
|
|
2360
2486
|
const filterSensitiveLog: (obj: ListMedicalVocabulariesRequest) => any;
|
|
2361
2487
|
}
|
|
2362
2488
|
/**
|
|
2363
|
-
* <p>Provides information about a custom vocabulary
|
|
2489
|
+
* <p>Provides information about a custom vocabulary.</p>
|
|
2364
2490
|
*/
|
|
2365
2491
|
export interface VocabularyInfo {
|
|
2366
2492
|
/**
|
|
@@ -2376,8 +2502,8 @@ export interface VocabularyInfo {
|
|
|
2376
2502
|
*/
|
|
2377
2503
|
LastModifiedTime?: Date;
|
|
2378
2504
|
/**
|
|
2379
|
-
* <p>The processing state of the vocabulary. If the state is <code>READY</code> you
|
|
2380
|
-
* the vocabulary in a <code>StartTranscriptionJob</code> request.</p>
|
|
2505
|
+
* <p>The processing state of the vocabulary. If the state is <code>READY</code> you
|
|
2506
|
+
* can use the vocabulary in a <code>StartTranscriptionJob</code> request.</p>
|
|
2381
2507
|
*/
|
|
2382
2508
|
VocabularyState?: VocabularyState | string;
|
|
2383
2509
|
}
|
|
@@ -2393,10 +2519,11 @@ export interface ListMedicalVocabulariesResponse {
|
|
|
2393
2519
|
*/
|
|
2394
2520
|
Status?: VocabularyState | string;
|
|
2395
2521
|
/**
|
|
2396
|
-
* <p>The <code>ListMedicalVocabularies</code> operation returns a page of vocabularies at a
|
|
2397
|
-
* maximum number of vocabularies to return on a page with the
|
|
2398
|
-
* are more jobs in the list will fit on a page,
|
|
2399
|
-
*
|
|
2522
|
+
* <p>The <code>ListMedicalVocabularies</code> operation returns a page of vocabularies at a
|
|
2523
|
+
* time. You set the maximum number of vocabularies to return on a page with the
|
|
2524
|
+
* <code>MaxResults</code> parameter. If there are more jobs in the list will fit on a page,
|
|
2525
|
+
* Amazon Transcribe Medical returns the <code>NextPage</code> token. To return the next page of vocabularies,
|
|
2526
|
+
* include the token in the next request to the <code>ListMedicalVocabularies</code>
|
|
2400
2527
|
* operation .</p>
|
|
2401
2528
|
*/
|
|
2402
2529
|
NextToken?: string;
|
|
@@ -2447,23 +2574,25 @@ export declare namespace ListTagsForResourceResponse {
|
|
|
2447
2574
|
}
|
|
2448
2575
|
export interface ListTranscriptionJobsRequest {
|
|
2449
2576
|
/**
|
|
2450
|
-
* <p>When specified, returns only transcription jobs with the specified status. Jobs are ordered
|
|
2451
|
-
* the newest jobs returned first. If you don’t specify a status, Amazon Transcribe
|
|
2452
|
-
* date.</p>
|
|
2577
|
+
* <p>When specified, returns only transcription jobs with the specified status. Jobs are ordered
|
|
2578
|
+
* by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe
|
|
2579
|
+
* returns all transcription jobs ordered by creation date.</p>
|
|
2453
2580
|
*/
|
|
2454
2581
|
Status?: TranscriptionJobStatus | string;
|
|
2455
2582
|
/**
|
|
2456
|
-
* <p>When specified, the jobs returned in the list are limited to jobs whose name contains the
|
|
2583
|
+
* <p>When specified, the jobs returned in the list are limited to jobs whose name contains the
|
|
2584
|
+
* specified string.</p>
|
|
2457
2585
|
*/
|
|
2458
2586
|
JobNameContains?: string;
|
|
2459
2587
|
/**
|
|
2460
|
-
* <p>If the result of the previous request to <code>ListTranscriptionJobs</code> is truncated,
|
|
2461
|
-
* <code>NextToken</code> to fetch the next set of jobs.</p>
|
|
2588
|
+
* <p>If the result of the previous request to <code>ListTranscriptionJobs</code> is truncated,
|
|
2589
|
+
* include the <code>NextToken</code> to fetch the next set of jobs.</p>
|
|
2462
2590
|
*/
|
|
2463
2591
|
NextToken?: string;
|
|
2464
2592
|
/**
|
|
2465
|
-
* <p>The maximum number of jobs to return in each page of results. If there are fewer results
|
|
2466
|
-
* specify, only the actual results are returned. If you do not specify a value,
|
|
2593
|
+
* <p>The maximum number of jobs to return in each page of results. If there are fewer results
|
|
2594
|
+
* than the value you specify, only the actual results are returned. If you do not specify a value,
|
|
2595
|
+
* the default of 5 is used.</p>
|
|
2467
2596
|
*/
|
|
2468
2597
|
MaxResults?: number;
|
|
2469
2598
|
}
|
|
@@ -2498,21 +2627,24 @@ export interface TranscriptionJobSummary {
|
|
|
2498
2627
|
*/
|
|
2499
2628
|
LanguageCode?: LanguageCode | string;
|
|
2500
2629
|
/**
|
|
2501
|
-
* <p>The status of the transcription job. When the status is <code>COMPLETED</code>,
|
|
2502
|
-
* <code>GetTranscriptionJob</code> operation to get the results of the
|
|
2630
|
+
* <p>The status of the transcription job. When the status is <code>COMPLETED</code>,
|
|
2631
|
+
* use the <code>GetTranscriptionJob</code> operation to get the results of the
|
|
2632
|
+
* transcription.</p>
|
|
2503
2633
|
*/
|
|
2504
2634
|
TranscriptionJobStatus?: TranscriptionJobStatus | string;
|
|
2505
2635
|
/**
|
|
2506
|
-
* <p>If the <code>TranscriptionJobStatus</code> field is <code>FAILED</code>, a
|
|
2636
|
+
* <p>If the <code>TranscriptionJobStatus</code> field is <code>FAILED</code>, a
|
|
2637
|
+
* description of the error.</p>
|
|
2507
2638
|
*/
|
|
2508
2639
|
FailureReason?: string;
|
|
2509
2640
|
/**
|
|
2510
2641
|
* <p>Indicates the location of the output of the transcription job.</p>
|
|
2511
|
-
* <p>If the value is <code>CUSTOMER_BUCKET</code> then the location is the S3 bucket
|
|
2512
|
-
* <code>outputBucketName</code> field when the transcription job was
|
|
2513
|
-
* <code>StartTranscriptionJob</code> operation.</p>
|
|
2514
|
-
* <p>If the value is <code>SERVICE_BUCKET</code> then the output is stored by Amazon Transcribe and
|
|
2515
|
-
* the URI in the <code>GetTranscriptionJob</code> response's
|
|
2642
|
+
* <p>If the value is <code>CUSTOMER_BUCKET</code> then the location is the S3 bucket
|
|
2643
|
+
* specified in the <code>outputBucketName</code> field when the transcription job was
|
|
2644
|
+
* started with the <code>StartTranscriptionJob</code> operation.</p>
|
|
2645
|
+
* <p>If the value is <code>SERVICE_BUCKET</code> then the output is stored by Amazon Transcribe and
|
|
2646
|
+
* can be retrieved using the URI in the <code>GetTranscriptionJob</code> response's
|
|
2647
|
+
* <code>TranscriptFileUri</code> field.</p>
|
|
2516
2648
|
*/
|
|
2517
2649
|
OutputLocationType?: OutputLocationType | string;
|
|
2518
2650
|
/**
|
|
@@ -2528,8 +2660,9 @@ export interface TranscriptionJobSummary {
|
|
|
2528
2660
|
*/
|
|
2529
2661
|
IdentifyLanguage?: boolean;
|
|
2530
2662
|
/**
|
|
2531
|
-
* <p>A value between zero and one that Amazon Transcribe assigned to the language it identified in
|
|
2532
|
-
* score indicates that Amazon Transcribe is more confident in the language it
|
|
2663
|
+
* <p>A value between zero and one that Amazon Transcribe assigned to the language it identified in
|
|
2664
|
+
* the source audio. A higher score indicates that Amazon Transcribe is more confident in the language it
|
|
2665
|
+
* identified.</p>
|
|
2533
2666
|
*/
|
|
2534
2667
|
IdentifiedLanguageScore?: number;
|
|
2535
2668
|
}
|
|
@@ -2545,10 +2678,11 @@ export interface ListTranscriptionJobsResponse {
|
|
|
2545
2678
|
*/
|
|
2546
2679
|
Status?: TranscriptionJobStatus | string;
|
|
2547
2680
|
/**
|
|
2548
|
-
* <p>The <code>ListTranscriptionJobs</code> operation returns a page of jobs at a time. The
|
|
2549
|
-
* page is set by the <code>MaxResults</code> parameter. If there are
|
|
2550
|
-
* returns the <code>NextPage</code> token.
|
|
2551
|
-
*
|
|
2681
|
+
* <p>The <code>ListTranscriptionJobs</code> operation returns a page of jobs at a time. The
|
|
2682
|
+
* maximum size of the page is set by the <code>MaxResults</code> parameter. If there are
|
|
2683
|
+
* more jobs in the list than the page size, Amazon Transcribe returns the <code>NextPage</code> token.
|
|
2684
|
+
* Include the token in the next request to the <code>ListTranscriptionJobs</code> operation to
|
|
2685
|
+
* return in the next page of jobs.</p>
|
|
2552
2686
|
*/
|
|
2553
2687
|
NextToken?: string;
|
|
2554
2688
|
/**
|
|
@@ -2564,24 +2698,26 @@ export declare namespace ListTranscriptionJobsResponse {
|
|
|
2564
2698
|
}
|
|
2565
2699
|
export interface ListVocabulariesRequest {
|
|
2566
2700
|
/**
|
|
2567
|
-
* <p>If the result of the previous request to <code>ListVocabularies</code> was truncated,
|
|
2568
|
-
* <code>NextToken</code> to fetch the next set of jobs.</p>
|
|
2701
|
+
* <p>If the result of the previous request to <code>ListVocabularies</code> was truncated,
|
|
2702
|
+
* include the <code>NextToken</code> to fetch the next set of jobs.</p>
|
|
2569
2703
|
*/
|
|
2570
2704
|
NextToken?: string;
|
|
2571
2705
|
/**
|
|
2572
|
-
* <p>The maximum number of vocabularies to return in each page of results. If there are fewer
|
|
2573
|
-
* value you specify, only the actual results are returned. If you do not specify a
|
|
2706
|
+
* <p>The maximum number of vocabularies to return in each page of results. If there are fewer
|
|
2707
|
+
* results than the value you specify, only the actual results are returned. If you do not specify a
|
|
2708
|
+
* value, the default of 5 is used.</p>
|
|
2574
2709
|
*/
|
|
2575
2710
|
MaxResults?: number;
|
|
2576
2711
|
/**
|
|
2577
|
-
* <p>When specified, only returns vocabularies with the <code>VocabularyState</code> field
|
|
2578
|
-
* specified state.</p>
|
|
2712
|
+
* <p>When specified, only returns vocabularies with the <code>VocabularyState</code> field
|
|
2713
|
+
* equal to the specified state.</p>
|
|
2579
2714
|
*/
|
|
2580
2715
|
StateEquals?: VocabularyState | string;
|
|
2581
2716
|
/**
|
|
2582
|
-
* <p>When specified, the vocabularies returned in the list are limited to vocabularies whose
|
|
2583
|
-
* specified string. The search is not case sensitive,
|
|
2584
|
-
* and "VocabularyName" in the
|
|
2717
|
+
* <p>When specified, the vocabularies returned in the list are limited to vocabularies whose
|
|
2718
|
+
* name contains the specified string. The search is not case sensitive,
|
|
2719
|
+
* <code>ListVocabularies</code> returns both "vocabularyname" and "VocabularyName" in the
|
|
2720
|
+
* response list.</p>
|
|
2585
2721
|
*/
|
|
2586
2722
|
NameContains?: string;
|
|
2587
2723
|
}
|
|
@@ -2597,14 +2733,16 @@ export interface ListVocabulariesResponse {
|
|
|
2597
2733
|
*/
|
|
2598
2734
|
Status?: VocabularyState | string;
|
|
2599
2735
|
/**
|
|
2600
|
-
* <p>The <code>ListVocabularies</code> operation returns a page of vocabularies at a time.
|
|
2601
|
-
* the page is set in the <code>MaxResults</code> parameter. If there are
|
|
2602
|
-
* page, Amazon Transcribe returns the <code>NextPage</code> token.
|
|
2603
|
-
* next request to the
|
|
2736
|
+
* <p>The <code>ListVocabularies</code> operation returns a page of vocabularies at a time.
|
|
2737
|
+
* The maximum size of the page is set in the <code>MaxResults</code> parameter. If there are
|
|
2738
|
+
* more jobs in the list than will fit on the page, Amazon Transcribe returns the <code>NextPage</code> token.
|
|
2739
|
+
* To return in the next page of jobs, include the token in the next request to the
|
|
2740
|
+
* <code>ListVocabularies</code> operation.</p>
|
|
2604
2741
|
*/
|
|
2605
2742
|
NextToken?: string;
|
|
2606
2743
|
/**
|
|
2607
|
-
* <p>A list of objects that describe the vocabularies that match the search criteria in the
|
|
2744
|
+
* <p>A list of objects that describe the vocabularies that match the search criteria in the
|
|
2745
|
+
* request.</p>
|
|
2608
2746
|
*/
|
|
2609
2747
|
Vocabularies?: VocabularyInfo[];
|
|
2610
2748
|
}
|
|
@@ -2616,17 +2754,19 @@ export declare namespace ListVocabulariesResponse {
|
|
|
2616
2754
|
}
|
|
2617
2755
|
export interface ListVocabularyFiltersRequest {
|
|
2618
2756
|
/**
|
|
2619
|
-
* <p>If the result of the previous request to <code>ListVocabularyFilters</code> was truncated,
|
|
2620
|
-
* <code>NextToken</code> to fetch the next set of collections.</p>
|
|
2757
|
+
* <p>If the result of the previous request to <code>ListVocabularyFilters</code> was truncated,
|
|
2758
|
+
* include the <code>NextToken</code> to fetch the next set of collections.</p>
|
|
2621
2759
|
*/
|
|
2622
2760
|
NextToken?: string;
|
|
2623
2761
|
/**
|
|
2624
|
-
* <p>The maximum number of filters to return in each page of results. If there are fewer
|
|
2625
|
-
* specify, only the actual results are returned. If you do not specify
|
|
2762
|
+
* <p>The maximum number of filters to return in each page of results. If there are fewer
|
|
2763
|
+
* results than the value you specify, only the actual results are returned. If you do not specify
|
|
2764
|
+
* a value, the default of 5 is used.</p>
|
|
2626
2765
|
*/
|
|
2627
2766
|
MaxResults?: number;
|
|
2628
2767
|
/**
|
|
2629
|
-
* <p>Filters the response so that it only contains vocabulary filters whose name contains the
|
|
2768
|
+
* <p>Filters the response so that it only contains vocabulary filters whose name contains the
|
|
2769
|
+
* specified string.</p>
|
|
2630
2770
|
*/
|
|
2631
2771
|
NameContains?: string;
|
|
2632
2772
|
}
|
|
@@ -2641,7 +2781,8 @@ export declare namespace ListVocabularyFiltersRequest {
|
|
|
2641
2781
|
*/
|
|
2642
2782
|
export interface VocabularyFilterInfo {
|
|
2643
2783
|
/**
|
|
2644
|
-
* <p>The name of the vocabulary filter. The name must be unique in the account that
|
|
2784
|
+
* <p>The name of the vocabulary filter. The name must be unique in the account that
|
|
2785
|
+
* holds the filter.</p>
|
|
2645
2786
|
*/
|
|
2646
2787
|
VocabularyFilterName?: string;
|
|
2647
2788
|
/**
|
|
@@ -2661,16 +2802,18 @@ export declare namespace VocabularyFilterInfo {
|
|
|
2661
2802
|
}
|
|
2662
2803
|
export interface ListVocabularyFiltersResponse {
|
|
2663
2804
|
/**
|
|
2664
|
-
* <p>The <code>ListVocabularyFilters</code> operation returns a page of collections at a time.
|
|
2665
|
-
* of the page is set by the <code>MaxResults</code> parameter. If there
|
|
2666
|
-
* Amazon Transcribe returns the <code>NextPage</code> token.
|
|
2667
|
-
*
|
|
2805
|
+
* <p>The <code>ListVocabularyFilters</code> operation returns a page of collections at a time.
|
|
2806
|
+
* The maximum size of the page is set by the <code>MaxResults</code> parameter. If there
|
|
2807
|
+
* are more jobs in the list than the page size, Amazon Transcribe returns the <code>NextPage</code> token.
|
|
2808
|
+
* Include the token in the next request to the <code>ListVocabularyFilters</code> operation to
|
|
2809
|
+
* return in the next page of jobs.</p>
|
|
2668
2810
|
*/
|
|
2669
2811
|
NextToken?: string;
|
|
2670
2812
|
/**
|
|
2671
|
-
* <p>The list of vocabulary filters. It contains at most <code>MaxResults</code> number of
|
|
2672
|
-
* filters, call the <code>ListVocabularyFilters</code> operation again
|
|
2673
|
-
* in the request set to the value of the
|
|
2813
|
+
* <p>The list of vocabulary filters. It contains at most <code>MaxResults</code> number of
|
|
2814
|
+
* filters. If there are more filters, call the <code>ListVocabularyFilters</code> operation again
|
|
2815
|
+
* with the <code>NextToken</code> parameter in the request set to the value of the
|
|
2816
|
+
* <code>NextToken</code> field in the response.</p>
|
|
2674
2817
|
*/
|
|
2675
2818
|
VocabularyFilters?: VocabularyFilterInfo[];
|
|
2676
2819
|
}
|
|
@@ -2682,9 +2825,10 @@ export declare namespace ListVocabularyFiltersResponse {
|
|
|
2682
2825
|
}
|
|
2683
2826
|
export interface StartCallAnalyticsJobRequest {
|
|
2684
2827
|
/**
|
|
2685
|
-
* <p>The name of the call analytics job. You can't use the string "." or ".." by themselves as
|
|
2686
|
-
* must also be unique within an Amazon Web Services account. If you
|
|
2687
|
-
* name as a previous call analytics job, you get
|
|
2828
|
+
* <p>The name of the call analytics job. You can't use the string "." or ".." by themselves as
|
|
2829
|
+
* the job name. The name must also be unique within an Amazon Web Services account. If you
|
|
2830
|
+
* try to create a call analytics job with the same name as a previous call analytics job, you get
|
|
2831
|
+
* a <code>ConflictException</code> error.</p>
|
|
2688
2832
|
*/
|
|
2689
2833
|
CallAnalyticsJobName: string | undefined;
|
|
2690
2834
|
/**
|
|
@@ -2692,37 +2836,39 @@ export interface StartCallAnalyticsJobRequest {
|
|
|
2692
2836
|
*/
|
|
2693
2837
|
Media: Media | undefined;
|
|
2694
2838
|
/**
|
|
2695
|
-
* <p>The Amazon S3 location where the output of the call analytics job is stored. You can
|
|
2696
|
-
* location types to store the output of call analytics job:</p>
|
|
2839
|
+
* <p>The Amazon S3 location where the output of the call analytics job is stored. You can
|
|
2840
|
+
* provide the following location types to store the output of call analytics job:</p>
|
|
2697
2841
|
* <ul>
|
|
2698
2842
|
* <li>
|
|
2699
2843
|
* <p>s3://DOC-EXAMPLE-BUCKET1</p>
|
|
2700
|
-
* <p> If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file
|
|
2701
|
-
* bucket.</p>
|
|
2844
|
+
* <p> If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file
|
|
2845
|
+
* at the root level of the bucket.</p>
|
|
2702
2846
|
* </li>
|
|
2703
2847
|
* <li>
|
|
2704
2848
|
* <p>s3://DOC-EXAMPLE-BUCKET1/folder/</p>
|
|
2705
2849
|
* <p>f you specify a path, Amazon Transcribe saves the output of the analytics job as
|
|
2706
|
-
* s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json
|
|
2850
|
+
* s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json.</p>
|
|
2707
2851
|
* <p>If you specify a folder, you must provide a trailing slash.</p>
|
|
2708
2852
|
* </li>
|
|
2709
2853
|
* <li>
|
|
2710
|
-
* <p>s3://DOC-EXAMPLE-BUCKET1/folder/filename.json
|
|
2711
|
-
* <p> If you provide a path that has the filename specified, Amazon Transcribe saves the output of
|
|
2712
|
-
* s3://DOC-EXAMPLEBUCKET1/folder/filename.json
|
|
2854
|
+
* <p>s3://DOC-EXAMPLE-BUCKET1/folder/filename.json.</p>
|
|
2855
|
+
* <p> If you provide a path that has the filename specified, Amazon Transcribe saves the output of
|
|
2856
|
+
* the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json.</p>
|
|
2713
2857
|
* </li>
|
|
2714
2858
|
* </ul>
|
|
2715
|
-
* <p>You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt
|
|
2716
|
-
* analytics job using the <code>OutputEncryptionKMSKeyId</code> parameter.
|
|
2717
|
-
* Amazon Transcribe uses the default Amazon S3 key for server-side encryption
|
|
2718
|
-
* S3 bucket.</p>
|
|
2859
|
+
* <p>You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt
|
|
2860
|
+
* the output of our analytics job using the <code>OutputEncryptionKMSKeyId</code> parameter.
|
|
2861
|
+
* If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption
|
|
2862
|
+
* of the analytics job output that is placed in your S3 bucket.</p>
|
|
2719
2863
|
*/
|
|
2720
2864
|
OutputLocation?: string;
|
|
2721
2865
|
/**
|
|
2722
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service
|
|
2723
|
-
* the output of the call analytics job. The user calling the
|
|
2724
|
-
*
|
|
2725
|
-
*
|
|
2866
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service
|
|
2867
|
+
* key used to encrypt the output of the call analytics job. The user calling the
|
|
2868
|
+
* operation must have permission to use the
|
|
2869
|
+
* specified KMS key.</p>
|
|
2870
|
+
* <p>You use either of the following to identify an Amazon Web Services KMS key in the current
|
|
2871
|
+
* account:</p>
|
|
2726
2872
|
* <ul>
|
|
2727
2873
|
* <li>
|
|
2728
2874
|
* <p>KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"</p>
|
|
@@ -2731,36 +2877,42 @@ export interface StartCallAnalyticsJobRequest {
|
|
|
2731
2877
|
* <p>KMS Key Alias: "alias/ExampleAlias"</p>
|
|
2732
2878
|
* </li>
|
|
2733
2879
|
* </ul>
|
|
2734
|
-
* <p> You can use either of the following to identify a KMS key in the current account or
|
|
2880
|
+
* <p> You can use either of the following to identify a KMS key in the current account or
|
|
2881
|
+
* another account:</p>
|
|
2735
2882
|
* <ul>
|
|
2736
2883
|
* <li>
|
|
2737
|
-
* <p>Amazon Resource Name (ARN) of a KMS key in the current account or
|
|
2884
|
+
* <p>Amazon Resource Name (ARN) of a KMS key in the current account or
|
|
2885
|
+
* another account:
|
|
2738
2886
|
* "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab"</p>
|
|
2739
2887
|
* </li>
|
|
2740
2888
|
* <li>
|
|
2741
|
-
* <p>ARN of a KMS Key Alias:
|
|
2889
|
+
* <p>ARN of a KMS Key Alias:
|
|
2890
|
+
* "arn:aws:kms:region:accountID:alias/ExampleAlias"</p>
|
|
2742
2891
|
* </li>
|
|
2743
2892
|
* </ul>
|
|
2744
|
-
* <p>If you don't specify an encryption key, the output of the call analytics job is encrypted
|
|
2745
|
-
* S3 key (SSE-S3).</p>
|
|
2746
|
-
* <p>If you specify a KMS key to encrypt your output, you must also specify an output location
|
|
2747
|
-
* <code>OutputLocation</code> parameter. </p>
|
|
2893
|
+
* <p>If you don't specify an encryption key, the output of the call analytics job is encrypted
|
|
2894
|
+
* with the default Amazon S3 key (SSE-S3).</p>
|
|
2895
|
+
* <p>If you specify a KMS key to encrypt your output, you must also specify an output location
|
|
2896
|
+
* in the <code>OutputLocation</code> parameter. </p>
|
|
2748
2897
|
*/
|
|
2749
2898
|
OutputEncryptionKMSKeyId?: string;
|
|
2750
2899
|
/**
|
|
2751
|
-
* <p>The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that
|
|
2752
|
-
* Amazon Transcribe assumes this role to read queued audio files. If you have
|
|
2753
|
-
* results, this role should have access to
|
|
2900
|
+
* <p>The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that
|
|
2901
|
+
* contains your input files. Amazon Transcribe assumes this role to read queued audio files. If you have
|
|
2902
|
+
* specified an output S3 bucket for your transcription results, this role should have access to
|
|
2903
|
+
* the output bucket as well.</p>
|
|
2754
2904
|
*/
|
|
2755
2905
|
DataAccessRoleArn: string | undefined;
|
|
2756
2906
|
/**
|
|
2757
|
-
* <p>A <code>Settings</code> object that provides optional settings for a call analytics
|
|
2907
|
+
* <p>A <code>Settings</code> object that provides optional settings for a call analytics
|
|
2908
|
+
* job.</p>
|
|
2758
2909
|
*/
|
|
2759
2910
|
Settings?: CallAnalyticsJobSettings;
|
|
2760
2911
|
/**
|
|
2761
|
-
* <p>When you start a call analytics job, you must pass an array that maps the agent and the
|
|
2762
|
-
* audio channels. The values you can assign to a channel are 0 and 1. The
|
|
2763
|
-
* their own channel. You can't assign more than one
|
|
2912
|
+
* <p>When you start a call analytics job, you must pass an array that maps the agent and the
|
|
2913
|
+
* customer to specific audio channels. The values you can assign to a channel are 0 and 1. The
|
|
2914
|
+
* agent and the customer must each have their own channel. You can't assign more than one
|
|
2915
|
+
* channel to an agent or customer. </p>
|
|
2764
2916
|
*/
|
|
2765
2917
|
ChannelDefinitions?: ChannelDefinition[];
|
|
2766
2918
|
}
|
|
@@ -2784,23 +2936,25 @@ export declare namespace StartCallAnalyticsJobResponse {
|
|
|
2784
2936
|
}
|
|
2785
2937
|
export interface StartMedicalTranscriptionJobRequest {
|
|
2786
2938
|
/**
|
|
2787
|
-
* <p>The name of the medical transcription job. You can't use the strings "<code>.</code>"
|
|
2788
|
-
* by themselves as the job name. The name must also be unique within an
|
|
2789
|
-
*
|
|
2790
|
-
* <code>ConflictException</code>
|
|
2939
|
+
* <p>The name of the medical transcription job. You can't use the strings "<code>.</code>"
|
|
2940
|
+
* or "<code>..</code>" by themselves as the job name. The name must also be unique within an
|
|
2941
|
+
* Amazon Web Services account. If you try to create a medical transcription job with the same
|
|
2942
|
+
* name as a previous medical transcription job, you get a <code>ConflictException</code>
|
|
2943
|
+
* error.</p>
|
|
2791
2944
|
*/
|
|
2792
2945
|
MedicalTranscriptionJobName: string | undefined;
|
|
2793
2946
|
/**
|
|
2794
|
-
* <p>The language code for the language spoken in the input media file. US English (en-US) is
|
|
2795
|
-
* medical transcription jobs. Any other value you enter for language code
|
|
2796
|
-
* <code>BadRequestException</code> error.</p>
|
|
2947
|
+
* <p>The language code for the language spoken in the input media file. US English (en-US) is
|
|
2948
|
+
* the valid value for medical transcription jobs. Any other value you enter for language code
|
|
2949
|
+
* results in a <code>BadRequestException</code> error.</p>
|
|
2797
2950
|
*/
|
|
2798
2951
|
LanguageCode: LanguageCode | string | undefined;
|
|
2799
2952
|
/**
|
|
2800
2953
|
* <p>The sample rate, in Hertz, of the audio track in the input media file.</p>
|
|
2801
|
-
* <p>If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you
|
|
2802
|
-
* it must match the rate detected by Amazon Transcribe Medical. In most cases, you
|
|
2803
|
-
* <code>MediaSampleRateHertz</code> field blank and let Amazon Transcribe Medical determine
|
|
2954
|
+
* <p>If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you
|
|
2955
|
+
* specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you
|
|
2956
|
+
* should leave the <code>MediaSampleRateHertz</code> field blank and let Amazon Transcribe Medical determine
|
|
2957
|
+
* the sample rate.</p>
|
|
2804
2958
|
*/
|
|
2805
2959
|
MediaSampleRateHertz?: number;
|
|
2806
2960
|
/**
|
|
@@ -2813,33 +2967,38 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
2813
2967
|
Media: Media | undefined;
|
|
2814
2968
|
/**
|
|
2815
2969
|
* <p>The Amazon S3 location where the transcription is stored.</p>
|
|
2816
|
-
* <p>You must set <code>OutputBucketName</code> for Amazon Transcribe Medical to store the transcription
|
|
2817
|
-
* appears in the S3 location you specify. When you call the
|
|
2818
|
-
*
|
|
2819
|
-
*
|
|
2820
|
-
*
|
|
2821
|
-
* <p>You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt
|
|
2822
|
-
* transcription using the <code>OutputEncryptionKMSKeyId</code> parameter.
|
|
2823
|
-
* uses the default Amazon S3 key for server-side
|
|
2970
|
+
* <p>You must set <code>OutputBucketName</code> for Amazon Transcribe Medical to store the transcription
|
|
2971
|
+
* results. Your transcript appears in the S3 location you specify. When you call the
|
|
2972
|
+
* <a>GetMedicalTranscriptionJob</a>, the operation returns this location in the
|
|
2973
|
+
* <code>TranscriptFileUri</code> field. The S3 bucket must have permissions that allow
|
|
2974
|
+
* Amazon Transcribe Medical to put files in the bucket. For more information, see <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>
|
|
2975
|
+
* <p>You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt
|
|
2976
|
+
* the output of your transcription using the <code>OutputEncryptionKMSKeyId</code> parameter.
|
|
2977
|
+
* If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side
|
|
2978
|
+
* encryption of transcripts that are placed in your S3 bucket.</p>
|
|
2824
2979
|
*/
|
|
2825
2980
|
OutputBucketName: string | undefined;
|
|
2826
2981
|
/**
|
|
2827
|
-
* <p>You can specify a location in an Amazon S3 bucket to store the output of your medical
|
|
2828
|
-
*
|
|
2829
|
-
*
|
|
2830
|
-
*
|
|
2831
|
-
*
|
|
2832
|
-
*
|
|
2833
|
-
*
|
|
2834
|
-
*
|
|
2835
|
-
*
|
|
2836
|
-
*
|
|
2982
|
+
* <p>You can specify a location in an Amazon S3 bucket to store the output of your medical
|
|
2983
|
+
* transcription job.</p>
|
|
2984
|
+
* <p>If you don't specify an output key, Amazon Transcribe Medical stores the output of your transcription job in
|
|
2985
|
+
* the Amazon S3 bucket you specified. By default, the object key is
|
|
2986
|
+
* "your-transcription-job-name.json".</p>
|
|
2987
|
+
* <p>You can use output keys to specify the Amazon S3 prefix and file name of the transcription
|
|
2988
|
+
* output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would
|
|
2989
|
+
* lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you
|
|
2990
|
+
* specify "my-other-job-name.json" as the output key, the object key is changed to
|
|
2991
|
+
* "my-other-job-name.json". You can use an output key to change both the prefix and the file
|
|
2992
|
+
* name, for example "folder/my-other-job-name.json".</p>
|
|
2993
|
+
* <p>If you specify an output key, you must also specify an S3 bucket in the
|
|
2994
|
+
* <code>OutputBucketName</code> parameter.</p>
|
|
2837
2995
|
*/
|
|
2838
2996
|
OutputKey?: string;
|
|
2839
2997
|
/**
|
|
2840
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service
|
|
2841
|
-
* encrypt the output of the transcription job. The user calling the
|
|
2842
|
-
* operation must have permission to use the
|
|
2998
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service
|
|
2999
|
+
* (KMS) key used to encrypt the output of the transcription job. The user calling the
|
|
3000
|
+
* <a>StartMedicalTranscriptionJob</a> operation must have permission to use the
|
|
3001
|
+
* specified KMS key.</p>
|
|
2843
3002
|
* <p>You use either of the following to identify a KMS key in the current account:</p>
|
|
2844
3003
|
* <ul>
|
|
2845
3004
|
* <li>
|
|
@@ -2849,7 +3008,8 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
2849
3008
|
* <p>KMS Key Alias: "alias/ExampleAlias"</p>
|
|
2850
3009
|
* </li>
|
|
2851
3010
|
* </ul>
|
|
2852
|
-
* <p>You can use either of the following to identify a KMS key in the current account or
|
|
3011
|
+
* <p>You can use either of the following to identify a KMS key in the current account or
|
|
3012
|
+
* another account:</p>
|
|
2853
3013
|
* <ul>
|
|
2854
3014
|
* <li>
|
|
2855
3015
|
* <p>Amazon Resource Name (ARN) of a KMS key in the current account or another
|
|
@@ -2859,15 +3019,15 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
2859
3019
|
* <p>ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"</p>
|
|
2860
3020
|
* </li>
|
|
2861
3021
|
* </ul>
|
|
2862
|
-
* <p>If you don't specify an encryption key, the output of the medical transcription job is
|
|
2863
|
-
* key (SSE-S3).</p>
|
|
2864
|
-
* <p>If you specify a KMS key to encrypt your output, you must also specify an output location
|
|
2865
|
-
* <code>OutputBucketName</code> parameter.</p>
|
|
3022
|
+
* <p>If you don't specify an encryption key, the output of the medical transcription job is
|
|
3023
|
+
* encrypted with the default Amazon S3 key (SSE-S3).</p>
|
|
3024
|
+
* <p>If you specify a KMS key to encrypt your output, you must also specify an output location
|
|
3025
|
+
* in the <code>OutputBucketName</code> parameter.</p>
|
|
2866
3026
|
*/
|
|
2867
3027
|
OutputEncryptionKMSKeyId?: string;
|
|
2868
3028
|
/**
|
|
2869
|
-
* <p>A map of plain text, non-secret key:value pairs, known as encryption context pairs, that
|
|
2870
|
-
* layer of security for your data.</p>
|
|
3029
|
+
* <p>A map of plain text, non-secret key:value pairs, known as encryption context pairs, that
|
|
3030
|
+
* provide an added layer of security for your data.</p>
|
|
2871
3031
|
*/
|
|
2872
3032
|
KMSEncryptionContext?: {
|
|
2873
3033
|
[key: string]: string;
|
|
@@ -2877,8 +3037,9 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
2877
3037
|
*/
|
|
2878
3038
|
Settings?: MedicalTranscriptionSetting;
|
|
2879
3039
|
/**
|
|
2880
|
-
* <p>You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify
|
|
2881
|
-
* Amazon Transcribe Medical labels the personal health information (PHI) that it identifies in the
|
|
3040
|
+
* <p>You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify
|
|
3041
|
+
* <code>PHI</code>, Amazon Transcribe Medical labels the personal health information (PHI) that it identifies in the
|
|
3042
|
+
* transcription output.</p>
|
|
2882
3043
|
*/
|
|
2883
3044
|
ContentIdentificationType?: MedicalContentIdentificationType | string;
|
|
2884
3045
|
/**
|
|
@@ -2886,9 +3047,10 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
2886
3047
|
*/
|
|
2887
3048
|
Specialty: Specialty | string | undefined;
|
|
2888
3049
|
/**
|
|
2889
|
-
* <p>The type of speech in the input audio. <code>CONVERSATION</code> refers to
|
|
2890
|
-
* more speakers, e.g., a conversations between doctors and
|
|
2891
|
-
* single-speaker dictated speech, such as clinical
|
|
3050
|
+
* <p>The type of speech in the input audio. <code>CONVERSATION</code> refers to
|
|
3051
|
+
* conversations between two or more speakers, e.g., a conversations between doctors and
|
|
3052
|
+
* patients. <code>DICTATION</code> refers to single-speaker dictated speech, such as clinical
|
|
3053
|
+
* notes.</p>
|
|
2892
3054
|
*/
|
|
2893
3055
|
Type: Type | string | undefined;
|
|
2894
3056
|
/**
|
|
@@ -2931,22 +3093,24 @@ export declare namespace Subtitles {
|
|
|
2931
3093
|
}
|
|
2932
3094
|
export interface StartTranscriptionJobRequest {
|
|
2933
3095
|
/**
|
|
2934
|
-
* <p>The name of the job. You can't use the strings "<code>.</code>" or "<code>..</code>"
|
|
2935
|
-
* job name. The name must also be unique within an Amazon Web Services
|
|
2936
|
-
*
|
|
3096
|
+
* <p>The name of the job. You can't use the strings "<code>.</code>" or "<code>..</code>"
|
|
3097
|
+
* by themselves as the job name. The name must also be unique within an Amazon Web Services
|
|
3098
|
+
* account. If you try to create a transcription job with the same name as a previous
|
|
3099
|
+
* transcription job, you get a <code>ConflictException</code> error.</p>
|
|
2937
3100
|
*/
|
|
2938
3101
|
TranscriptionJobName: string | undefined;
|
|
2939
3102
|
/**
|
|
2940
3103
|
* <p>The language code for the language used in the input media file.</p>
|
|
2941
|
-
* <p>To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must
|
|
2942
|
-
* rate of 16,000 Hz or higher.</p>
|
|
3104
|
+
* <p>To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must
|
|
3105
|
+
* be encoded at a sample rate of 16,000 Hz or higher.</p>
|
|
2943
3106
|
*/
|
|
2944
3107
|
LanguageCode?: LanguageCode | string;
|
|
2945
3108
|
/**
|
|
2946
3109
|
* <p>The sample rate, in Hertz, of the audio track in the input media file. </p>
|
|
2947
|
-
* <p>If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you
|
|
2948
|
-
* must match the sample rate detected by Amazon Transcribe. In most cases,
|
|
2949
|
-
* <code>MediaSampleRateHertz</code> field blank and let Amazon Transcribe
|
|
3110
|
+
* <p>If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you
|
|
3111
|
+
* specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases,
|
|
3112
|
+
* you should leave the <code>MediaSampleRateHertz</code> field blank and let Amazon Transcribe
|
|
3113
|
+
* determine the sample rate.</p>
|
|
2950
3114
|
*/
|
|
2951
3115
|
MediaSampleRateHertz?: number;
|
|
2952
3116
|
/**
|
|
@@ -2959,38 +3123,45 @@ export interface StartTranscriptionJobRequest {
|
|
|
2959
3123
|
Media: Media | undefined;
|
|
2960
3124
|
/**
|
|
2961
3125
|
* <p>The location where the transcription is stored.</p>
|
|
2962
|
-
* <p>If you set the <code>OutputBucketName</code>, Amazon Transcribe puts the transcript in the
|
|
2963
|
-
* you call the <a>GetTranscriptionJob</a> operation, the
|
|
2964
|
-
* <code>TranscriptFileUri</code> field. If you enable
|
|
2965
|
-
*
|
|
2966
|
-
*
|
|
2967
|
-
*
|
|
2968
|
-
*
|
|
2969
|
-
*
|
|
2970
|
-
*
|
|
2971
|
-
*
|
|
2972
|
-
*
|
|
2973
|
-
*
|
|
2974
|
-
*
|
|
3126
|
+
* <p>If you set the <code>OutputBucketName</code>, Amazon Transcribe puts the transcript in the
|
|
3127
|
+
* specified S3 bucket. When you call the <a>GetTranscriptionJob</a> operation, the
|
|
3128
|
+
* operation returns this location in the <code>TranscriptFileUri</code> field. If you enable
|
|
3129
|
+
* content redaction, the redacted transcript appears in
|
|
3130
|
+
* <code>RedactedTranscriptFileUri</code>. If you enable content redaction and choose to
|
|
3131
|
+
* output an unredacted transcript, that transcript's location still appears in the
|
|
3132
|
+
* <code>TranscriptFileUri</code>. The S3 bucket must have permissions that allow Amazon Transcribe to
|
|
3133
|
+
* put files in the bucket. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user">Permissions
|
|
3134
|
+
* Required for IAM User Roles</a>.</p>
|
|
3135
|
+
* <p>You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt
|
|
3136
|
+
* the output of your transcription using the <code>OutputEncryptionKMSKeyId</code>
|
|
3137
|
+
* parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for
|
|
3138
|
+
* server-side encryption of transcripts that are placed in your S3 bucket.</p>
|
|
3139
|
+
* <p>If you don't set the <code>OutputBucketName</code>, Amazon Transcribe generates a pre-signed URL,
|
|
3140
|
+
* a shareable URL that provides secure access to your transcription, and returns it in the
|
|
3141
|
+
* <code>TranscriptFileUri</code> field. Use this URL to download the transcription.</p>
|
|
2975
3142
|
*/
|
|
2976
3143
|
OutputBucketName?: string;
|
|
2977
3144
|
/**
|
|
2978
|
-
* <p>You can specify a location in an Amazon S3 bucket to store the output of your transcription
|
|
2979
|
-
*
|
|
2980
|
-
*
|
|
2981
|
-
*
|
|
2982
|
-
*
|
|
2983
|
-
*
|
|
2984
|
-
*
|
|
3145
|
+
* <p>You can specify a location in an Amazon S3 bucket to store the output of your transcription
|
|
3146
|
+
* job.</p>
|
|
3147
|
+
* <p>If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in
|
|
3148
|
+
* the Amazon S3 bucket you specified. By default, the object key is
|
|
3149
|
+
* "your-transcription-job-name.json".</p>
|
|
3150
|
+
* <p>You can use output keys to specify the Amazon S3 prefix and file name of the transcription
|
|
3151
|
+
* output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would
|
|
3152
|
+
* lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you
|
|
3153
|
+
* specify "my-other-job-name.json" as the output key, the object key is changed to
|
|
3154
|
+
* "my-other-job-name.json". You can use an output key to change both the prefix and the file
|
|
2985
3155
|
* name, for example "folder/my-other-job-name.json".</p>
|
|
2986
|
-
* <p>If you specify an output key, you must also specify an S3 bucket in the
|
|
2987
|
-
* parameter.</p>
|
|
3156
|
+
* <p>If you specify an output key, you must also specify an S3 bucket in the
|
|
3157
|
+
* <code>OutputBucketName</code> parameter.</p>
|
|
2988
3158
|
*/
|
|
2989
3159
|
OutputKey?: string;
|
|
2990
3160
|
/**
|
|
2991
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services Key Management
|
|
2992
|
-
* encrypt the output of the transcription job. The user calling the
|
|
2993
|
-
* operation must have permission to use the specified
|
|
3161
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Web Services Key Management
|
|
3162
|
+
* Service (KMS) key used to encrypt the output of the transcription job. The user calling the
|
|
3163
|
+
* <code>StartTranscriptionJob</code> operation must have permission to use the specified
|
|
3164
|
+
* KMS key.</p>
|
|
2994
3165
|
* <p>You can use either of the following to identify a KMS key in the current account:</p>
|
|
2995
3166
|
* <ul>
|
|
2996
3167
|
* <li>
|
|
@@ -3000,7 +3171,8 @@ export interface StartTranscriptionJobRequest {
|
|
|
3000
3171
|
* <p>KMS Key Alias: "alias/ExampleAlias"</p>
|
|
3001
3172
|
* </li>
|
|
3002
3173
|
* </ul>
|
|
3003
|
-
* <p>You can use either of the following to identify a KMS key in the current account or
|
|
3174
|
+
* <p>You can use either of the following to identify a KMS key in the current account or
|
|
3175
|
+
* another account:</p>
|
|
3004
3176
|
* <ul>
|
|
3005
3177
|
* <li>
|
|
3006
3178
|
* <p>Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account
|
|
@@ -3010,31 +3182,33 @@ export interface StartTranscriptionJobRequest {
|
|
|
3010
3182
|
* <p>ARN of a KMS Key Alias: "arn:aws:kms:region:account-ID:alias/ExampleAlias"</p>
|
|
3011
3183
|
* </li>
|
|
3012
3184
|
* </ul>
|
|
3013
|
-
* <p>If you don't specify an encryption key, the output of the transcription job is encrypted
|
|
3014
|
-
* Amazon S3 key (SSE-S3).</p>
|
|
3015
|
-
* <p>If you specify a KMS key to encrypt your output, you must also specify an output location
|
|
3016
|
-
* <code>OutputBucketName</code> parameter.</p>
|
|
3185
|
+
* <p>If you don't specify an encryption key, the output of the transcription job is encrypted
|
|
3186
|
+
* with the default Amazon S3 key (SSE-S3).</p>
|
|
3187
|
+
* <p>If you specify a KMS key to encrypt your output, you must also specify an output location
|
|
3188
|
+
* in the <code>OutputBucketName</code> parameter.</p>
|
|
3017
3189
|
*/
|
|
3018
3190
|
OutputEncryptionKMSKeyId?: string;
|
|
3019
3191
|
/**
|
|
3020
|
-
* <p>A map of plain text, non-secret key:value pairs, known as encryption context pairs, that
|
|
3021
|
-
*
|
|
3192
|
+
* <p>A map of plain text, non-secret key:value pairs, known as encryption context pairs, that
|
|
3193
|
+
* provide an added layer of security for your data.</p>
|
|
3022
3194
|
*/
|
|
3023
3195
|
KMSEncryptionContext?: {
|
|
3024
3196
|
[key: string]: string;
|
|
3025
3197
|
};
|
|
3026
3198
|
/**
|
|
3027
|
-
* <p>A <code>Settings</code> object that provides optional settings for a transcription
|
|
3199
|
+
* <p>A <code>Settings</code> object that provides optional settings for a transcription
|
|
3200
|
+
* job.</p>
|
|
3028
3201
|
*/
|
|
3029
3202
|
Settings?: Settings;
|
|
3030
3203
|
/**
|
|
3031
|
-
* <p>Choose the custom language model you use for your transcription job in this
|
|
3204
|
+
* <p>Choose the custom language model you use for your transcription job in this
|
|
3205
|
+
* parameter.</p>
|
|
3032
3206
|
*/
|
|
3033
3207
|
ModelSettings?: ModelSettings;
|
|
3034
3208
|
/**
|
|
3035
|
-
* <p>Provides information about how a transcription job is executed. Use this field to indicate
|
|
3036
|
-
* queued for deferred execution if the concurrency limit is reached and
|
|
3037
|
-
* the job.</p>
|
|
3209
|
+
* <p>Provides information about how a transcription job is executed. Use this field to indicate
|
|
3210
|
+
* that the job can be queued for deferred execution if the concurrency limit is reached and
|
|
3211
|
+
* there are no slots available to immediately run the job.</p>
|
|
3038
3212
|
*/
|
|
3039
3213
|
JobExecutionSettings?: JobExecutionSettings;
|
|
3040
3214
|
/**
|
|
@@ -3042,16 +3216,18 @@ export interface StartTranscriptionJobRequest {
|
|
|
3042
3216
|
*/
|
|
3043
3217
|
ContentRedaction?: ContentRedaction;
|
|
3044
3218
|
/**
|
|
3045
|
-
* <p>Set this field to <code>true</code> to enable automatic language identification.
|
|
3046
|
-
* is disabled by default. You receive a
|
|
3219
|
+
* <p>Set this field to <code>true</code> to enable automatic language identification.
|
|
3220
|
+
* Automatic language identification is disabled by default. You receive a
|
|
3221
|
+
* <code>BadRequestException</code> error if you enter a value for a
|
|
3047
3222
|
* <code>LanguageCode</code>.</p>
|
|
3048
3223
|
*/
|
|
3049
3224
|
IdentifyLanguage?: boolean;
|
|
3050
3225
|
/**
|
|
3051
|
-
* <p>An object containing a list of languages that might be present in your collection of
|
|
3052
|
-
* identification chooses a language that best matches the
|
|
3053
|
-
*
|
|
3054
|
-
*
|
|
3226
|
+
* <p>An object containing a list of languages that might be present in your collection of
|
|
3227
|
+
* audio files. Automatic language identification chooses a language that best matches the
|
|
3228
|
+
* source audio from that list.</p>
|
|
3229
|
+
* <p>To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must
|
|
3230
|
+
* be encoded at a sample rate of 16,000 Hz or higher.</p>
|
|
3055
3231
|
*/
|
|
3056
3232
|
LanguageOptions?: (LanguageCode | string)[];
|
|
3057
3233
|
/**
|
|
@@ -3063,9 +3239,9 @@ export interface StartTranscriptionJobRequest {
|
|
|
3063
3239
|
*/
|
|
3064
3240
|
Tags?: Tag[];
|
|
3065
3241
|
/**
|
|
3066
|
-
* <p>The language identification settings associated with your transcription job. These
|
|
3067
|
-
* <code>VocabularyName</code>, <code>VocabularyFilterName</code>,
|
|
3068
|
-
* <code>LanguageModelName</code>.</p>
|
|
3242
|
+
* <p>The language identification settings associated with your transcription job. These
|
|
3243
|
+
* settings include <code>VocabularyName</code>, <code>VocabularyFilterName</code>,
|
|
3244
|
+
* and <code>LanguageModelName</code>.</p>
|
|
3069
3245
|
*/
|
|
3070
3246
|
LanguageIdSettings?: {
|
|
3071
3247
|
[key: string]: LanguageIdSettings;
|
|
@@ -3091,10 +3267,11 @@ export declare namespace StartTranscriptionJobResponse {
|
|
|
3091
3267
|
}
|
|
3092
3268
|
export interface TagResourceRequest {
|
|
3093
3269
|
/**
|
|
3094
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to tag. ARNs have
|
|
3095
|
-
* <code>arn:partition:service:region:account-id:resource-type/resource-id</code>
|
|
3096
|
-
*
|
|
3097
|
-
*
|
|
3270
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to tag. ARNs have
|
|
3271
|
+
* the format <code>arn:partition:service:region:account-id:resource-type/resource-id</code>
|
|
3272
|
+
* (for example,
|
|
3273
|
+
* <code>arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name</code>).
|
|
3274
|
+
* Valid values for <code>resource-type</code> are: <code>transcription-job</code>,
|
|
3098
3275
|
* <code>medical-transcription-job</code>, <code>vocabulary</code>,
|
|
3099
3276
|
* <code>medical-vocabulary</code>, <code>vocabulary-filter</code>, and
|
|
3100
3277
|
* <code>language-model</code>.</p>
|
|
@@ -3121,11 +3298,11 @@ export declare namespace TagResourceResponse {
|
|
|
3121
3298
|
}
|
|
3122
3299
|
export interface UntagResourceRequest {
|
|
3123
3300
|
/**
|
|
3124
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove tags
|
|
3125
|
-
* ARNs have the format
|
|
3301
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove tags
|
|
3302
|
+
* from. ARNs have the format
|
|
3126
3303
|
* <code>arn:partition:service:region:account-id:resource-type/resource-id</code> (for example,
|
|
3127
|
-
* <code>arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name</code>).
|
|
3128
|
-
* values for <code>resource-type</code> are: <code>transcription-job</code>,
|
|
3304
|
+
* <code>arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name</code>).
|
|
3305
|
+
* Valid values for <code>resource-type</code> are: <code>transcription-job</code>,
|
|
3129
3306
|
* <code>medical-transcription-job</code>, <code>vocabulary</code>,
|
|
3130
3307
|
* <code>medical-vocabulary</code>, <code>vocabulary-filter</code>, and
|
|
3131
3308
|
* <code>language-model</code>.</p>
|
|
@@ -3152,13 +3329,14 @@ export declare namespace UntagResourceResponse {
|
|
|
3152
3329
|
}
|
|
3153
3330
|
export interface UpdateCallAnalyticsCategoryRequest {
|
|
3154
3331
|
/**
|
|
3155
|
-
* <p>The name of the analytics category to update. The name is case sensitive. If you try
|
|
3156
|
-
* category with the same name as a previous category you will
|
|
3332
|
+
* <p>The name of the analytics category to update. The name is case sensitive. If you try
|
|
3333
|
+
* to update a call analytics category with the same name as a previous category you will
|
|
3334
|
+
* receive a <code>ConflictException</code> error.</p>
|
|
3157
3335
|
*/
|
|
3158
3336
|
CategoryName: string | undefined;
|
|
3159
3337
|
/**
|
|
3160
|
-
* <p>The rules used for the updated analytics category. The rules that you provide in this
|
|
3161
|
-
* that are currently being used
|
|
3338
|
+
* <p>The rules used for the updated analytics category. The rules that you provide in this
|
|
3339
|
+
* field replace the ones that are currently being used.</p>
|
|
3162
3340
|
*/
|
|
3163
3341
|
Rules: Rule[] | undefined;
|
|
3164
3342
|
}
|
|
@@ -3170,8 +3348,9 @@ export declare namespace UpdateCallAnalyticsCategoryRequest {
|
|
|
3170
3348
|
}
|
|
3171
3349
|
export interface UpdateCallAnalyticsCategoryResponse {
|
|
3172
3350
|
/**
|
|
3173
|
-
* <p>The attributes describing the analytics category. You can see information such as the
|
|
3174
|
-
* to update the category and when the category was originally
|
|
3351
|
+
* <p>The attributes describing the analytics category. You can see information such as the
|
|
3352
|
+
* rules that you've used to update the category and when the category was originally
|
|
3353
|
+
* created.</p>
|
|
3175
3354
|
*/
|
|
3176
3355
|
CategoryProperties?: CategoryProperties;
|
|
3177
3356
|
}
|
|
@@ -3183,30 +3362,31 @@ export declare namespace UpdateCallAnalyticsCategoryResponse {
|
|
|
3183
3362
|
}
|
|
3184
3363
|
export interface UpdateMedicalVocabularyRequest {
|
|
3185
3364
|
/**
|
|
3186
|
-
* <p>The name of the vocabulary to update. The name is case sensitive. If you try to update
|
|
3187
|
-
* same name as a vocabulary you've already made, you get a
|
|
3365
|
+
* <p>The name of the vocabulary to update. The name is case sensitive. If you try to update
|
|
3366
|
+
* a vocabulary with the same name as a vocabulary you've already made, you get a
|
|
3367
|
+
* <code>ConflictException</code> error.</p>
|
|
3188
3368
|
*/
|
|
3189
3369
|
VocabularyName: string | undefined;
|
|
3190
3370
|
/**
|
|
3191
|
-
* <p>The language code of the language used for the entries in the updated vocabulary.
|
|
3192
|
-
* only valid language code in Amazon Transcribe Medical.</p>
|
|
3371
|
+
* <p>The language code of the language used for the entries in the updated vocabulary.
|
|
3372
|
+
* U.S. English (en-US) is the only valid language code in Amazon Transcribe Medical.</p>
|
|
3193
3373
|
*/
|
|
3194
3374
|
LanguageCode: LanguageCode | string | undefined;
|
|
3195
3375
|
/**
|
|
3196
|
-
* <p>The location in Amazon S3 of the text file that contains your custom vocabulary. The URI must
|
|
3197
|
-
* Amazon Web Services Region as the resource that you are calling. The following
|
|
3376
|
+
* <p>The location in Amazon S3 of the text file that contains your custom vocabulary. The URI must
|
|
3377
|
+
* be in the same Amazon Web Services Region as the resource that you are calling. The following
|
|
3378
|
+
* is the format for a URI:</p>
|
|
3198
3379
|
* <p>
|
|
3199
|
-
* <code>
|
|
3200
|
-
* https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
|
|
3201
|
-
* </code>
|
|
3380
|
+
* <code> https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey> </code>
|
|
3202
3381
|
* </p>
|
|
3203
3382
|
* <p>For example:</p>
|
|
3204
3383
|
* <p>
|
|
3205
3384
|
* <code>https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt</code>
|
|
3206
3385
|
* </p>
|
|
3207
|
-
* <p>For more information about Amazon S3 object names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys">Object Keys</a> in the
|
|
3208
|
-
*
|
|
3209
|
-
* <p>For more information about custom vocabularies in Amazon Transcribe Medical, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/
|
|
3386
|
+
* <p>For more information about Amazon S3 object names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys">Object Keys</a> in the
|
|
3387
|
+
* <i>Amazon S3 Developer Guide</i>.</p>
|
|
3388
|
+
* <p>For more information about custom vocabularies in Amazon Transcribe Medical, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-med.html">Medical Custom
|
|
3389
|
+
* Vocabularies</a>.</p>
|
|
3210
3390
|
*/
|
|
3211
3391
|
VocabularyFileUri?: string;
|
|
3212
3392
|
}
|
|
@@ -3222,8 +3402,8 @@ export interface UpdateMedicalVocabularyResponse {
|
|
|
3222
3402
|
*/
|
|
3223
3403
|
VocabularyName?: string;
|
|
3224
3404
|
/**
|
|
3225
|
-
* <p>The language code for the language of the text file used to update the custom
|
|
3226
|
-
* is the only language supported in Amazon Transcribe Medical.</p>
|
|
3405
|
+
* <p>The language code for the language of the text file used to update the custom
|
|
3406
|
+
* vocabulary. US English (en-US) is the only language supported in Amazon Transcribe Medical.</p>
|
|
3227
3407
|
*/
|
|
3228
3408
|
LanguageCode?: LanguageCode | string;
|
|
3229
3409
|
/**
|
|
@@ -3231,9 +3411,9 @@ export interface UpdateMedicalVocabularyResponse {
|
|
|
3231
3411
|
*/
|
|
3232
3412
|
LastModifiedTime?: Date;
|
|
3233
3413
|
/**
|
|
3234
|
-
* <p>The processing state of the update to the vocabulary. When the
|
|
3235
|
-
* <code>READY</code>, the vocabulary is ready to
|
|
3236
|
-
* request.</p>
|
|
3414
|
+
* <p>The processing state of the update to the vocabulary. When the
|
|
3415
|
+
* <code>VocabularyState</code> field is <code>READY</code>, the vocabulary is ready to
|
|
3416
|
+
* be used in a <code>StartMedicalTranscriptionJob</code> request.</p>
|
|
3237
3417
|
*/
|
|
3238
3418
|
VocabularyState?: VocabularyState | string;
|
|
3239
3419
|
}
|
|
@@ -3245,13 +3425,14 @@ export declare namespace UpdateMedicalVocabularyResponse {
|
|
|
3245
3425
|
}
|
|
3246
3426
|
export interface UpdateVocabularyRequest {
|
|
3247
3427
|
/**
|
|
3248
|
-
* <p>The name of the vocabulary to update. The name is case sensitive. If you try to update
|
|
3249
|
-
* same name as a previous vocabulary you will receive a
|
|
3428
|
+
* <p>The name of the vocabulary to update. The name is case sensitive. If you try to update
|
|
3429
|
+
* a vocabulary with the same name as a previous vocabulary you will receive a
|
|
3430
|
+
* <code>ConflictException</code> error.</p>
|
|
3250
3431
|
*/
|
|
3251
3432
|
VocabularyName: string | undefined;
|
|
3252
3433
|
/**
|
|
3253
|
-
* <p>The language code of the vocabulary entries. For a list of languages and their
|
|
3254
|
-
* see <a
|
|
3434
|
+
* <p>The language code of the vocabulary entries. For a list of languages and their
|
|
3435
|
+
* corresponding language codes, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a>.</p>
|
|
3255
3436
|
*/
|
|
3256
3437
|
LanguageCode: LanguageCode | string | undefined;
|
|
3257
3438
|
/**
|
|
@@ -3259,14 +3440,20 @@ export interface UpdateVocabularyRequest {
|
|
|
3259
3440
|
*/
|
|
3260
3441
|
Phrases?: string[];
|
|
3261
3442
|
/**
|
|
3262
|
-
* <p>The S3 location of the text file that contains the definition of the custom vocabulary.
|
|
3263
|
-
* same region as the API endpoint that you are calling. The general form
|
|
3264
|
-
*
|
|
3443
|
+
* <p>The S3 location of the text file that contains the definition of the custom vocabulary.
|
|
3444
|
+
* The URI must be in the same region as the API endpoint that you are calling. The general form
|
|
3445
|
+
* is:</p>
|
|
3446
|
+
* <p>
|
|
3447
|
+
* <code>https://s3.<aws-region>.amazonaws.com/<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey></code>
|
|
3448
|
+
* </p>
|
|
3265
3449
|
* <p>For example:</p>
|
|
3266
|
-
*
|
|
3267
|
-
*
|
|
3268
|
-
*
|
|
3269
|
-
* <p>For more information about
|
|
3450
|
+
* <p>
|
|
3451
|
+
* <code>https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt</code>
|
|
3452
|
+
* </p>
|
|
3453
|
+
* <p>For more information about S3 object names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys">Object Keys</a> in the
|
|
3454
|
+
* <i>Amazon S3 Developer Guide</i>.</p>
|
|
3455
|
+
* <p>For more information about custom vocabularies, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom
|
|
3456
|
+
* Vocabularies</a>.</p>
|
|
3270
3457
|
*/
|
|
3271
3458
|
VocabularyFileUri?: string;
|
|
3272
3459
|
}
|
|
@@ -3290,9 +3477,9 @@ export interface UpdateVocabularyResponse {
|
|
|
3290
3477
|
*/
|
|
3291
3478
|
LastModifiedTime?: Date;
|
|
3292
3479
|
/**
|
|
3293
|
-
* <p>The processing state of the vocabulary. When the <code>VocabularyState</code>
|
|
3294
|
-
* <code>READY</code> the vocabulary is ready to be used in a
|
|
3295
|
-
* request.</p>
|
|
3480
|
+
* <p>The processing state of the vocabulary. When the <code>VocabularyState</code>
|
|
3481
|
+
* field contains <code>READY</code> the vocabulary is ready to be used in a
|
|
3482
|
+
* <code>StartTranscriptionJob</code> request.</p>
|
|
3296
3483
|
*/
|
|
3297
3484
|
VocabularyState?: VocabularyState | string;
|
|
3298
3485
|
}
|
|
@@ -3304,24 +3491,28 @@ export declare namespace UpdateVocabularyResponse {
|
|
|
3304
3491
|
}
|
|
3305
3492
|
export interface UpdateVocabularyFilterRequest {
|
|
3306
3493
|
/**
|
|
3307
|
-
* <p>The name of the vocabulary filter to update. If you try to update a vocabulary filter with
|
|
3308
|
-
* another vocabulary filter, you get a <code>ConflictException</code>
|
|
3494
|
+
* <p>The name of the vocabulary filter to update. If you try to update a vocabulary filter with
|
|
3495
|
+
* the same name as another vocabulary filter, you get a <code>ConflictException</code>
|
|
3496
|
+
* error.</p>
|
|
3309
3497
|
*/
|
|
3310
3498
|
VocabularyFilterName: string | undefined;
|
|
3311
3499
|
/**
|
|
3312
|
-
* <p>The words to use in the vocabulary filter. Only use characters from the character
|
|
3313
|
-
* vocabularies. For a list of character sets, see
|
|
3500
|
+
* <p>The words to use in the vocabulary filter. Only use characters from the character
|
|
3501
|
+
* set defined for custom vocabularies. For a list of character sets, see
|
|
3502
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character
|
|
3503
|
+
* Sets for Custom Vocabularies</a>.</p>
|
|
3314
3504
|
* <p>If you provide a list of words in the <code>Words</code> parameter, you can't use the
|
|
3315
3505
|
* <code>VocabularyFilterFileUri</code> parameter.</p>
|
|
3316
3506
|
*/
|
|
3317
3507
|
Words?: string[];
|
|
3318
3508
|
/**
|
|
3319
|
-
* <p>The Amazon S3 location of a text file used as input to create the vocabulary filter.
|
|
3320
|
-
* the character set defined for custom vocabularies. For a list of
|
|
3509
|
+
* <p>The Amazon S3 location of a text file used as input to create the vocabulary filter.
|
|
3510
|
+
* Only use characters from the character set defined for custom vocabularies. For a list of
|
|
3511
|
+
* character sets, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
|
|
3512
|
+
* Vocabularies</a>.</p>
|
|
3321
3513
|
* <p>The specified file must be less than 50 KB of UTF-8 characters.</p>
|
|
3322
|
-
* <p>If you provide the location of a list of words in the
|
|
3323
|
-
*
|
|
3324
|
-
* parameter.</p>
|
|
3514
|
+
* <p>If you provide the location of a list of words in the <code>VocabularyFilterFileUri</code>
|
|
3515
|
+
* parameter, you can't use the <code>Words</code> parameter.</p>
|
|
3325
3516
|
*/
|
|
3326
3517
|
VocabularyFilterFileUri?: string;
|
|
3327
3518
|
}
|