@aws-sdk/client-transcribe 3.215.0 → 3.218.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -9
- package/dist-cjs/models/models_0.js +8 -3
- package/dist-cjs/protocols/Aws_json1_1.js +3 -0
- package/dist-es/models/models_0.js +5 -0
- package/dist-es/protocols/Aws_json1_1.js +3 -0
- package/dist-types/Transcribe.d.ts +234 -251
- package/dist-types/TranscribeClient.d.ts +9 -11
- package/dist-types/commands/CreateCallAnalyticsCategoryCommand.d.ts +12 -22
- package/dist-types/commands/CreateLanguageModelCommand.d.ts +3 -4
- package/dist-types/commands/CreateMedicalVocabularyCommand.d.ts +12 -11
- package/dist-types/commands/CreateVocabularyCommand.d.ts +10 -9
- package/dist-types/commands/CreateVocabularyFilterCommand.d.ts +9 -8
- package/dist-types/commands/DeleteCallAnalyticsCategoryCommand.d.ts +2 -2
- package/dist-types/commands/DeleteCallAnalyticsJobCommand.d.ts +3 -2
- package/dist-types/commands/DeleteLanguageModelCommand.d.ts +3 -3
- package/dist-types/commands/DeleteMedicalTranscriptionJobCommand.d.ts +3 -3
- package/dist-types/commands/DeleteMedicalVocabularyCommand.d.ts +2 -2
- package/dist-types/commands/DeleteTranscriptionJobCommand.d.ts +3 -2
- package/dist-types/commands/DeleteVocabularyCommand.d.ts +3 -3
- package/dist-types/commands/DeleteVocabularyFilterCommand.d.ts +3 -3
- package/dist-types/commands/DescribeLanguageModelCommand.d.ts +3 -5
- package/dist-types/commands/GetCallAnalyticsCategoryCommand.d.ts +1 -2
- package/dist-types/commands/GetCallAnalyticsJobCommand.d.ts +11 -10
- package/dist-types/commands/GetMedicalTranscriptionJobCommand.d.ts +6 -6
- package/dist-types/commands/GetMedicalVocabularyCommand.d.ts +5 -6
- package/dist-types/commands/GetTranscriptionJobCommand.d.ts +8 -8
- package/dist-types/commands/GetVocabularyCommand.d.ts +6 -6
- package/dist-types/commands/GetVocabularyFilterCommand.d.ts +1 -6
- package/dist-types/commands/ListCallAnalyticsCategoriesCommand.d.ts +3 -3
- package/dist-types/commands/ListCallAnalyticsJobsCommand.d.ts +3 -4
- package/dist-types/commands/ListLanguageModelsCommand.d.ts +3 -4
- package/dist-types/commands/ListMedicalTranscriptionJobsCommand.d.ts +3 -4
- package/dist-types/commands/ListMedicalVocabulariesCommand.d.ts +3 -4
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListTranscriptionJobsCommand.d.ts +3 -4
- package/dist-types/commands/ListVocabulariesCommand.d.ts +3 -4
- package/dist-types/commands/ListVocabularyFiltersCommand.d.ts +1 -2
- package/dist-types/commands/StartCallAnalyticsJobCommand.d.ts +28 -26
- package/dist-types/commands/StartMedicalTranscriptionJobCommand.d.ts +20 -20
- package/dist-types/commands/StartTranscriptionJobCommand.d.ts +29 -29
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCallAnalyticsCategoryCommand.d.ts +3 -2
- package/dist-types/commands/UpdateMedicalVocabularyCommand.d.ts +3 -3
- package/dist-types/commands/UpdateVocabularyCommand.d.ts +3 -2
- package/dist-types/commands/UpdateVocabularyFilterCommand.d.ts +3 -3
- package/dist-types/models/models_0.d.ts +1349 -1305
- package/dist-types/ts3.4/models/models_0.d.ts +7 -0
- package/package.json +4 -4
|
@@ -4,47 +4,47 @@ import { TranscribeServiceException as __BaseException } from "./TranscribeServi
|
|
|
4
4
|
* <p>A time range, in milliseconds, between two points in your media file.</p>
|
|
5
5
|
* <p>You can use <code>StartTime</code> and <code>EndTime</code> to search a custom
|
|
6
6
|
* segment. For example, setting <code>StartTime</code> to 10000 and <code>EndTime</code>
|
|
7
|
-
* to 50000 only searches for your specified criteria in the audio contained between the
|
|
8
|
-
* millisecond mark and the 50,000 millisecond mark of your media file. You must use
|
|
9
|
-
*
|
|
10
|
-
* you must include both.</p>
|
|
11
|
-
* <p>You can use also <code>First</code> to search from the start of the audio until the
|
|
12
|
-
* you specify, or <code>Last</code> to search from the time you specify
|
|
13
|
-
* audio. For example, setting <code>First</code> to 50000 only
|
|
14
|
-
* criteria in the audio contained between the start of the
|
|
15
|
-
* mark. You can use <code>First</code> and
|
|
16
|
-
*
|
|
17
|
-
* <p>If you prefer to use percentage instead of milliseconds, see
|
|
18
|
-
* .</p>
|
|
7
|
+
* to 50000 only searches for your specified criteria in the audio contained between the
|
|
8
|
+
* 10,000 millisecond mark and the 50,000 millisecond mark of your media file. You must use
|
|
9
|
+
* <code>StartTime</code> and <code>EndTime</code> as a set; that is, if you include
|
|
10
|
+
* one, you must include both.</p>
|
|
11
|
+
* <p>You can use also <code>First</code> to search from the start of the audio until the
|
|
12
|
+
* time that you specify, or <code>Last</code> to search from the time that you specify
|
|
13
|
+
* until the end of the audio. For example, setting <code>First</code> to 50000 only
|
|
14
|
+
* searches for your specified criteria in the audio contained between the start of the
|
|
15
|
+
* media file to the 50,000 millisecond mark. You can use <code>First</code> and
|
|
16
|
+
* <code>Last</code> independently of each other.</p>
|
|
17
|
+
* <p>If you prefer to use percentage instead of milliseconds, see .</p>
|
|
19
18
|
*/
|
|
20
19
|
export interface AbsoluteTimeRange {
|
|
21
20
|
/**
|
|
22
21
|
* <p>The time, in milliseconds, when Amazon Transcribe starts searching for the specified
|
|
23
|
-
* criteria in your audio. If you include <code>StartTime</code> in your request, you must
|
|
24
|
-
* include <code>EndTime</code>.</p>
|
|
22
|
+
* criteria in your audio. If you include <code>StartTime</code> in your request, you must
|
|
23
|
+
* also include <code>EndTime</code>.</p>
|
|
25
24
|
*/
|
|
26
25
|
StartTime?: number;
|
|
27
26
|
/**
|
|
28
|
-
* <p>The time, in milliseconds, when Amazon Transcribe stops searching for the specified
|
|
29
|
-
* in your audio. If you include <code>EndTime</code> in your request, you must
|
|
30
|
-
* <code>StartTime</code>.</p>
|
|
27
|
+
* <p>The time, in milliseconds, when Amazon Transcribe stops searching for the specified
|
|
28
|
+
* criteria in your audio. If you include <code>EndTime</code> in your request, you must
|
|
29
|
+
* also include <code>StartTime</code>.</p>
|
|
31
30
|
*/
|
|
32
31
|
EndTime?: number;
|
|
33
32
|
/**
|
|
34
|
-
* <p>The time, in milliseconds, from the start of your media file until the value
|
|
35
|
-
*
|
|
33
|
+
* <p>The time, in milliseconds, from the start of your media file until the specified value.
|
|
34
|
+
* Amazon Transcribe searches for your specified criteria in this time segment.</p>
|
|
36
35
|
*/
|
|
37
36
|
First?: number;
|
|
38
37
|
/**
|
|
39
|
-
* <p>The time, in milliseconds, from the value
|
|
40
|
-
*
|
|
38
|
+
* <p>The time, in milliseconds, from the specified value until the end of your media file.
|
|
39
|
+
* Amazon Transcribe searches for your specified criteria in this time segment.</p>
|
|
41
40
|
*/
|
|
42
41
|
Last?: number;
|
|
43
42
|
}
|
|
44
43
|
/**
|
|
45
|
-
* <p>Your request didn't pass one or more validation tests. This can occur when the entity
|
|
46
|
-
* trying to delete doesn't exist or if it's in a non-terminal state (such as
|
|
47
|
-
*
|
|
44
|
+
* <p>Your request didn't pass one or more validation tests. This can occur when the entity
|
|
45
|
+
* you're trying to delete doesn't exist or if it's in a non-terminal state (such as
|
|
46
|
+
* <code>IN PROGRESS</code>). See the exception message field for more
|
|
47
|
+
* information.</p>
|
|
48
48
|
*/
|
|
49
49
|
export declare class BadRequestException extends __BaseException {
|
|
50
50
|
readonly name: "BadRequestException";
|
|
@@ -70,10 +70,10 @@ export declare enum ParticipantRole {
|
|
|
70
70
|
CUSTOMER = "CUSTOMER"
|
|
71
71
|
}
|
|
72
72
|
/**
|
|
73
|
-
* <p>
|
|
74
|
-
* first participant to speak, you would set <code>ChannelId</code> to
|
|
75
|
-
*
|
|
76
|
-
*
|
|
73
|
+
* <p>Makes it possible to specify which speaker is on which channel. For example, if your
|
|
74
|
+
* agent is the first participant to speak, you would set <code>ChannelId</code> to
|
|
75
|
+
* <code>0</code> (to indicate the first channel) and <code>ParticipantRole</code> to
|
|
76
|
+
* <code>AGENT</code> (to indicate that it's the agent speaking).</p>
|
|
77
77
|
*/
|
|
78
78
|
export interface ChannelDefinition {
|
|
79
79
|
/**
|
|
@@ -81,8 +81,8 @@ export interface ChannelDefinition {
|
|
|
81
81
|
*/
|
|
82
82
|
ChannelId?: number;
|
|
83
83
|
/**
|
|
84
|
-
* <p>Specify the speaker you want to define. Omitting this parameter is equivalent to
|
|
85
|
-
* both participants.</p>
|
|
84
|
+
* <p>Specify the speaker you want to define. Omitting this parameter is equivalent to
|
|
85
|
+
* specifying both participants.</p>
|
|
86
86
|
*/
|
|
87
87
|
ParticipantRole?: ParticipantRole | string;
|
|
88
88
|
}
|
|
@@ -128,6 +128,8 @@ export declare enum LanguageCode {
|
|
|
128
128
|
/**
|
|
129
129
|
* <p>Describes the Amazon S3 location of the media file you want to use in your
|
|
130
130
|
* request.</p>
|
|
131
|
+
* <p>For information on supported media formats, refer to the <a href="https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat">MediaFormat</a> parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
|
|
132
|
+
* in the Amazon S3 Developer Guide.</p>
|
|
131
133
|
*/
|
|
132
134
|
export interface Media {
|
|
133
135
|
/**
|
|
@@ -170,7 +172,8 @@ export interface Media {
|
|
|
170
172
|
* request.</p>
|
|
171
173
|
* <important>
|
|
172
174
|
* <p>
|
|
173
|
-
* <code>RedactedMediaFileUri</code>
|
|
175
|
+
* <code>RedactedMediaFileUri</code> produces a redacted audio file in addition to a
|
|
176
|
+
* redacted transcript. It is only supported for Call Analytics
|
|
174
177
|
* (<code>StartCallAnalyticsJob</code>) transcription requests.</p>
|
|
175
178
|
* </important>
|
|
176
179
|
*/
|
|
@@ -207,85 +210,93 @@ export declare enum RedactionType {
|
|
|
207
210
|
PII = "PII"
|
|
208
211
|
}
|
|
209
212
|
/**
|
|
210
|
-
* <p>
|
|
211
|
-
* you use <code>ContentRedaction</code>, you must also
|
|
212
|
-
* <code>PiiEntityTypes</code>, <code>RedactionOutput</code>,
|
|
213
|
-
* <code>RedactionType</code>.</p>
|
|
213
|
+
* <p>Makes it possible to redact or flag specified personally identifiable information
|
|
214
|
+
* (PII) in your transcript. If you use <code>ContentRedaction</code>, you must also
|
|
215
|
+
* include the sub-parameters: <code>PiiEntityTypes</code>, <code>RedactionOutput</code>,
|
|
216
|
+
* and <code>RedactionType</code>.</p>
|
|
214
217
|
*/
|
|
215
218
|
export interface ContentRedaction {
|
|
216
219
|
/**
|
|
217
220
|
* <p>Specify the category of information you want to redact; <code>PII</code> (personally
|
|
218
|
-
* identifiable information) is the only valid value. You can use
|
|
219
|
-
*
|
|
221
|
+
* identifiable information) is the only valid value. You can use
|
|
222
|
+
* <code>PiiEntityTypes</code> to choose which types of PII you want to redact.</p>
|
|
220
223
|
*/
|
|
221
224
|
RedactionType: RedactionType | string | undefined;
|
|
222
225
|
/**
|
|
223
|
-
* <p>Specify if you want only a redacted transcript, or if you want a redacted and an
|
|
224
|
-
* transcript.</p>
|
|
225
|
-
* <p>When you choose <code>redacted</code>
|
|
226
|
-
* transcript.</p>
|
|
227
|
-
* <p>When you choose <code>redacted_and_unredacted</code>
|
|
228
|
-
* a redacted and an unredacted transcript (as two separate
|
|
226
|
+
* <p>Specify if you want only a redacted transcript, or if you want a redacted and an
|
|
227
|
+
* unredacted transcript.</p>
|
|
228
|
+
* <p>When you choose <code>redacted</code>
|
|
229
|
+
* Amazon Transcribe creates only a redacted transcript.</p>
|
|
230
|
+
* <p>When you choose <code>redacted_and_unredacted</code>
|
|
231
|
+
* Amazon Transcribe creates a redacted and an unredacted transcript (as two separate
|
|
232
|
+
* files).</p>
|
|
229
233
|
*/
|
|
230
234
|
RedactionOutput: RedactionOutput | string | undefined;
|
|
231
235
|
/**
|
|
232
|
-
* <p>Specify which types of personally identifiable information (PII) you want to redact in
|
|
233
|
-
* transcript. You can include as many types as you'd like, or you can select
|
|
234
|
-
*
|
|
236
|
+
* <p>Specify which types of personally identifiable information (PII) you want to redact in
|
|
237
|
+
* your transcript. You can include as many types as you'd like, or you can select
|
|
238
|
+
* <code>ALL</code>.</p>
|
|
235
239
|
*/
|
|
236
240
|
PiiEntityTypes?: (PiiEntityType | string)[];
|
|
237
241
|
}
|
|
238
242
|
/**
|
|
239
|
-
* <p>If using automatic language identification
|
|
240
|
-
*
|
|
241
|
-
*
|
|
242
|
-
*
|
|
243
|
-
*
|
|
244
|
-
*
|
|
245
|
-
*
|
|
246
|
-
*
|
|
247
|
-
*
|
|
248
|
-
*
|
|
249
|
-
*
|
|
250
|
-
*
|
|
251
|
-
*
|
|
252
|
-
*
|
|
253
|
-
*
|
|
254
|
-
*
|
|
255
|
-
*
|
|
256
|
-
*
|
|
257
|
-
* <code>
|
|
258
|
-
*
|
|
259
|
-
*
|
|
260
|
-
*
|
|
261
|
-
*
|
|
262
|
-
*
|
|
243
|
+
* <p>If using automatic language identification in your request and you want to apply a
|
|
244
|
+
* custom language model, a custom vocabulary, or a custom vocabulary filter, include
|
|
245
|
+
* <code>LanguageIdSettings</code> with the relevant sub-parameters
|
|
246
|
+
* (<code>VocabularyName</code>, <code>LanguageModelName</code>, and
|
|
247
|
+
* <code>VocabularyFilterName</code>). Note that multi-language identification
|
|
248
|
+
* (<code>IdentifyMultipleLanguages</code>) doesn't support custom language
|
|
249
|
+
* models.</p>
|
|
250
|
+
* <p>
|
|
251
|
+
* <code>LanguageIdSettings</code> supports two to five language codes. Each language
|
|
252
|
+
* code you include can have an associated custom language model, custom vocabulary, and
|
|
253
|
+
* custom vocabulary filter. The language codes that you specify must match the languages
|
|
254
|
+
* of the associated custom language models, custom vocabularies, and custom vocabulary
|
|
255
|
+
* filters.</p>
|
|
256
|
+
* <p>It's recommended that you include <code>LanguageOptions</code> when using
|
|
257
|
+
* <code>LanguageIdSettings</code> to ensure that the correct language dialect is
|
|
258
|
+
* identified. For example, if you specify a custom vocabulary that is in
|
|
259
|
+
* <code>en-US</code> but Amazon Transcribe determines that the language spoken in
|
|
260
|
+
* your media is <code>en-AU</code>, your custom vocabulary <i>is not</i>
|
|
261
|
+
* applied to your transcription. If you include <code>LanguageOptions</code> and include
|
|
262
|
+
* <code>en-US</code> as the only English language dialect, your custom vocabulary
|
|
263
|
+
* <i>is</i> applied to your transcription.</p>
|
|
264
|
+
* <p>If you want to include a custom language model with your request but <b>do not</b> want to use automatic language identification, use
|
|
265
|
+
* instead the <code></code> parameter with the
|
|
266
|
+
* <code>LanguageModelName</code> sub-parameter. If you want to include a custom
|
|
267
|
+
* vocabulary or a custom vocabulary filter (or both) with your request but <b>do not</b> want to use automatic language identification, use
|
|
268
|
+
* instead the <code></code> parameter with the
|
|
269
|
+
* <code>VocabularyName</code> or <code>VocabularyFilterName</code> (or both)
|
|
270
|
+
* sub-parameter.</p>
|
|
263
271
|
*/
|
|
264
272
|
export interface LanguageIdSettings {
|
|
265
273
|
/**
|
|
266
|
-
* <p>The name of the custom vocabulary you want to use when processing your transcription
|
|
267
|
-
*
|
|
268
|
-
* <p>The language of the specified vocabulary must match the language code you
|
|
269
|
-
* your transcription request. If the languages don't match, the
|
|
270
|
-
* are no errors or warnings associated with a language
|
|
274
|
+
* <p>The name of the custom vocabulary you want to use when processing your transcription
|
|
275
|
+
* job. Custom vocabulary names are case sensitive.</p>
|
|
276
|
+
* <p>The language of the specified custom vocabulary must match the language code that you
|
|
277
|
+
* specify in your transcription request. If the languages don't match, the custom
|
|
278
|
+
* vocabulary isn't applied. There are no errors or warnings associated with a language
|
|
279
|
+
* mismatch.</p>
|
|
271
280
|
*/
|
|
272
281
|
VocabularyName?: string;
|
|
273
282
|
/**
|
|
274
283
|
* <p>The name of the custom vocabulary filter you want to use when processing your
|
|
275
|
-
* transcription job.
|
|
276
|
-
* <p>The language of the specified vocabulary filter must match the language code
|
|
277
|
-
* in your transcription request. If the languages don't match, the
|
|
278
|
-
* There are no errors or warnings associated with a
|
|
284
|
+
* transcription job. Custom vocabulary filter names are case sensitive.</p>
|
|
285
|
+
* <p>The language of the specified custom vocabulary filter must match the language code
|
|
286
|
+
* that you specify in your transcription request. If the languages don't match, the custom
|
|
287
|
+
* vocabulary filter isn't applied. There are no errors or warnings associated with a
|
|
288
|
+
* language mismatch.</p>
|
|
279
289
|
* <p>Note that if you include <code>VocabularyFilterName</code> in your request, you must
|
|
280
290
|
* also include <code>VocabularyFilterMethod</code>.</p>
|
|
281
291
|
*/
|
|
282
292
|
VocabularyFilterName?: string;
|
|
283
293
|
/**
|
|
284
294
|
* <p>The name of the custom language model you want to use when processing your
|
|
285
|
-
* transcription job. Note that language model names are case sensitive.</p>
|
|
286
|
-
* <p>The language of the specified language model must match the language code
|
|
287
|
-
* in your transcription request. If the languages don't match, the
|
|
288
|
-
* There are no errors or warnings associated with a language
|
|
295
|
+
* transcription job. Note that custom language model names are case sensitive.</p>
|
|
296
|
+
* <p>The language of the specified custom language model must match the language code that
|
|
297
|
+
* you specify in your transcription request. If the languages don't match, the custom
|
|
298
|
+
* language model isn't applied. There are no errors or warnings associated with a language
|
|
299
|
+
* mismatch.</p>
|
|
289
300
|
*/
|
|
290
301
|
LanguageModelName?: string;
|
|
291
302
|
}
|
|
@@ -295,131 +306,141 @@ export declare enum VocabularyFilterMethod {
|
|
|
295
306
|
TAG = "tag"
|
|
296
307
|
}
|
|
297
308
|
/**
|
|
298
|
-
* <p>Provides additional optional settings for your
|
|
299
|
-
*
|
|
300
|
-
*
|
|
309
|
+
* <p>Provides additional optional settings for your request, including content redaction,
|
|
310
|
+
* automatic language identification; allows you to apply custom language models, custom
|
|
311
|
+
* vocabulary filters, and custom vocabularies.</p>
|
|
301
312
|
*/
|
|
302
313
|
export interface CallAnalyticsJobSettings {
|
|
303
314
|
/**
|
|
304
315
|
* <p>The name of the custom vocabulary you want to include in your Call Analytics
|
|
305
|
-
* transcription request.
|
|
316
|
+
* transcription request. Custom vocabulary names are case sensitive.</p>
|
|
306
317
|
*/
|
|
307
318
|
VocabularyName?: string;
|
|
308
319
|
/**
|
|
309
320
|
* <p>The name of the custom vocabulary filter you want to include in your Call Analytics
|
|
310
|
-
* transcription request.
|
|
321
|
+
* transcription request. Custom vocabulary filter names are case sensitive.</p>
|
|
311
322
|
* <p>Note that if you include <code>VocabularyFilterName</code> in your request, you must
|
|
312
323
|
* also include <code>VocabularyFilterMethod</code>.</p>
|
|
313
324
|
*/
|
|
314
325
|
VocabularyFilterName?: string;
|
|
315
326
|
/**
|
|
316
|
-
* <p>Specify how you want your vocabulary filter applied to your transcript.</p>
|
|
327
|
+
* <p>Specify how you want your custom vocabulary filter applied to your transcript.</p>
|
|
317
328
|
* <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
|
|
318
329
|
* <p>To delete words, choose <code>remove</code>.</p>
|
|
319
330
|
* <p>To flag words without changing them, choose <code>tag</code>.</p>
|
|
320
331
|
*/
|
|
321
332
|
VocabularyFilterMethod?: VocabularyFilterMethod | string;
|
|
322
333
|
/**
|
|
323
|
-
* <p>The name of the custom language model you want to use when processing your
|
|
324
|
-
*
|
|
325
|
-
* <p>The language of the specified language model must match the language code
|
|
326
|
-
* in your transcription request. If the languages don't match, the
|
|
327
|
-
* There are no errors or warnings associated with a language
|
|
334
|
+
* <p>The name of the custom language model you want to use when processing your Call
|
|
335
|
+
* Analytics job. Note that custom language model names are case sensitive.</p>
|
|
336
|
+
* <p>The language of the specified custom language model must match the language code that
|
|
337
|
+
* you specify in your transcription request. If the languages don't match, the custom
|
|
338
|
+
* language model isn't applied. There are no errors or warnings associated with a language
|
|
339
|
+
* mismatch.</p>
|
|
328
340
|
*/
|
|
329
341
|
LanguageModelName?: string;
|
|
330
342
|
/**
|
|
331
|
-
* <p>
|
|
332
|
-
* you use <code>ContentRedaction</code>, you must also
|
|
333
|
-
* <code>PiiEntityTypes</code>, <code>RedactionOutput</code>,
|
|
334
|
-
* <code>RedactionType</code>.</p>
|
|
343
|
+
* <p>Makes it possible to redact or flag specified personally identifiable information
|
|
344
|
+
* (PII) in your transcript. If you use <code>ContentRedaction</code>, you must also
|
|
345
|
+
* include the sub-parameters: <code>PiiEntityTypes</code>, <code>RedactionOutput</code>,
|
|
346
|
+
* and <code>RedactionType</code>.</p>
|
|
335
347
|
*/
|
|
336
348
|
ContentRedaction?: ContentRedaction;
|
|
337
349
|
/**
|
|
338
350
|
* <p>You can specify two or more language codes that represent the languages you think may
|
|
339
|
-
* be present in your media
|
|
340
|
-
* languages are present, do not include this parameter.</p>
|
|
351
|
+
* be present in your media. Including more than five is not recommended. If you're unsure
|
|
352
|
+
* what languages are present, do not include this parameter.</p>
|
|
341
353
|
* <p>Including language options can improve the accuracy of language identification.</p>
|
|
342
|
-
* <p>For a list of languages supported with Call Analytics, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported
|
|
354
|
+
* <p>For a list of languages supported with Call Analytics, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported
|
|
355
|
+
* languages</a> table.</p>
|
|
356
|
+
* <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media file
|
|
357
|
+
* must be encoded at a sample rate of 16,000 Hz or higher.</p>
|
|
343
358
|
*/
|
|
344
359
|
LanguageOptions?: (LanguageCode | string)[];
|
|
345
360
|
/**
|
|
346
|
-
* <p>If using automatic language identification
|
|
347
|
-
*
|
|
348
|
-
*
|
|
349
|
-
*
|
|
350
|
-
*
|
|
351
|
-
* <p>
|
|
352
|
-
*
|
|
353
|
-
* include can have an associated custom language model, custom vocabulary, and
|
|
354
|
-
* vocabulary filter. The
|
|
355
|
-
* language models, custom vocabularies, and custom vocabulary
|
|
356
|
-
*
|
|
357
|
-
*
|
|
358
|
-
*
|
|
359
|
-
*
|
|
360
|
-
*
|
|
361
|
-
*
|
|
362
|
-
*
|
|
363
|
-
*
|
|
364
|
-
*
|
|
365
|
-
* <p>If you want to include a custom
|
|
366
|
-
* your request but <b>do not</b> want to
|
|
367
|
-
* language identification, use instead the <code></code>
|
|
368
|
-
*
|
|
369
|
-
*
|
|
361
|
+
* <p>If using automatic language identification in your request and you want to apply a
|
|
362
|
+
* custom language model, a custom vocabulary, or a custom vocabulary filter, include
|
|
363
|
+
* <code>LanguageIdSettings</code> with the relevant sub-parameters
|
|
364
|
+
* (<code>VocabularyName</code>, <code>LanguageModelName</code>, and
|
|
365
|
+
* <code>VocabularyFilterName</code>).</p>
|
|
366
|
+
* <p>
|
|
367
|
+
* <code>LanguageIdSettings</code> supports two to five language codes. Each language
|
|
368
|
+
* code you include can have an associated custom language model, custom vocabulary, and
|
|
369
|
+
* custom vocabulary filter. The language codes that you specify must match the languages
|
|
370
|
+
* of the associated custom language models, custom vocabularies, and custom vocabulary
|
|
371
|
+
* filters.</p>
|
|
372
|
+
* <p>It's recommended that you include <code>LanguageOptions</code> when using
|
|
373
|
+
* <code>LanguageIdSettings</code> to ensure that the correct language dialect is
|
|
374
|
+
* identified. For example, if you specify a custom vocabulary that is in
|
|
375
|
+
* <code>en-US</code> but Amazon Transcribe determines that the language spoken in
|
|
376
|
+
* your media is <code>en-AU</code>, your custom vocabulary <i>is not</i>
|
|
377
|
+
* applied to your transcription. If you include <code>LanguageOptions</code> and include
|
|
378
|
+
* <code>en-US</code> as the only English language dialect, your custom vocabulary
|
|
379
|
+
* <i>is</i> applied to your transcription.</p>
|
|
380
|
+
* <p>If you want to include a custom language model, custom vocabulary, or custom
|
|
381
|
+
* vocabulary filter with your request but <b>do not</b> want to
|
|
382
|
+
* use automatic language identification, use instead the <code></code> parameter with the
|
|
383
|
+
* <code>LanguageModelName</code>, <code>VocabularyName</code>, or
|
|
384
|
+
* <code>VocabularyFilterName</code> sub-parameters.</p>
|
|
385
|
+
* <p>For a list of languages supported with Call Analytics, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages and
|
|
386
|
+
* language-specific features</a>.</p>
|
|
370
387
|
*/
|
|
371
388
|
LanguageIdSettings?: Record<string, LanguageIdSettings>;
|
|
372
389
|
}
|
|
373
390
|
/**
|
|
374
|
-
* <p>Provides you with the Amazon S3 URI you can use to access your
|
|
391
|
+
* <p>Provides you with the Amazon S3 URI you can use to access your
|
|
392
|
+
* transcript.</p>
|
|
375
393
|
*/
|
|
376
394
|
export interface Transcript {
|
|
377
395
|
/**
|
|
378
396
|
* <p>The Amazon S3 location of your transcript. You can use this URI to access or
|
|
379
397
|
* download your transcript.</p>
|
|
380
|
-
* <p>If you included <code>OutputBucketName</code> in your transcription job request, this
|
|
381
|
-
* the URI of that bucket. If you also included <code>OutputKey</code> in your request,
|
|
382
|
-
* output is located in the path you specified in your request.</p>
|
|
398
|
+
* <p>If you included <code>OutputBucketName</code> in your transcription job request, this
|
|
399
|
+
* is the URI of that bucket. If you also included <code>OutputKey</code> in your request,
|
|
400
|
+
* your output is located in the path you specified in your request.</p>
|
|
383
401
|
* <p>If you didn't include <code>OutputBucketName</code> in your transcription job request,
|
|
384
|
-
* your transcript is stored in a service-managed bucket, and
|
|
385
|
-
*
|
|
402
|
+
* your transcript is stored in a service-managed bucket, and
|
|
403
|
+
* <code>TranscriptFileUri</code> provides you with a temporary URI you can use for
|
|
404
|
+
* secure access to your transcript.</p>
|
|
386
405
|
* <note>
|
|
387
406
|
* <p>Temporary URIs for service-managed Amazon S3 buckets are only valid for 15
|
|
388
407
|
* minutes. If you get an <code>AccesDenied</code> error, you can get a new temporary
|
|
389
408
|
* URI by running a <code>GetTranscriptionJob</code> or
|
|
390
|
-
*
|
|
409
|
+
* <code>ListTranscriptionJob</code> request.</p>
|
|
391
410
|
* </note>
|
|
392
411
|
*/
|
|
393
412
|
TranscriptFileUri?: string;
|
|
394
413
|
/**
|
|
395
|
-
* <p>The Amazon S3 location of your redacted transcript. You can use this URI to
|
|
396
|
-
* or download your transcript.</p>
|
|
397
|
-
* <p>If you included <code>OutputBucketName</code> in your transcription job request, this
|
|
398
|
-
* the URI of that bucket. If you also included <code>OutputKey</code> in your request,
|
|
399
|
-
* output is located in the path you specified in your request.</p>
|
|
414
|
+
* <p>The Amazon S3 location of your redacted transcript. You can use this URI to
|
|
415
|
+
* access or download your transcript.</p>
|
|
416
|
+
* <p>If you included <code>OutputBucketName</code> in your transcription job request, this
|
|
417
|
+
* is the URI of that bucket. If you also included <code>OutputKey</code> in your request,
|
|
418
|
+
* your output is located in the path you specified in your request.</p>
|
|
400
419
|
* <p>If you didn't include <code>OutputBucketName</code> in your transcription job request,
|
|
401
420
|
* your transcript is stored in a service-managed bucket, and
|
|
402
|
-
*
|
|
403
|
-
* secure access to your transcript.</p>
|
|
421
|
+
* <code>RedactedTranscriptFileUri</code> provides you with a temporary URI you can use
|
|
422
|
+
* for secure access to your transcript.</p>
|
|
404
423
|
* <note>
|
|
405
424
|
* <p>Temporary URIs for service-managed Amazon S3 buckets are only valid for 15
|
|
406
425
|
* minutes. If you get an <code>AccesDenied</code> error, you can get a new temporary
|
|
407
426
|
* URI by running a <code>GetTranscriptionJob</code> or
|
|
408
|
-
*
|
|
427
|
+
* <code>ListTranscriptionJob</code> request.</p>
|
|
409
428
|
* </note>
|
|
410
429
|
*/
|
|
411
430
|
RedactedTranscriptFileUri?: string;
|
|
412
431
|
}
|
|
413
432
|
/**
|
|
414
433
|
* <p>Provides detailed information about a Call Analytics job.</p>
|
|
415
|
-
* <p>To view the job's status, refer to <code>CallAnalyticsJobStatus</code>. If the status
|
|
416
|
-
* <code>COMPLETED</code>, the job is finished. You can find your completed transcript
|
|
417
|
-
* the URI specified in <code>TranscriptFileUri</code>. If the status is
|
|
418
|
-
*
|
|
419
|
-
*
|
|
420
|
-
*
|
|
421
|
-
*
|
|
422
|
-
*
|
|
434
|
+
* <p>To view the job's status, refer to <code>CallAnalyticsJobStatus</code>. If the status
|
|
435
|
+
* is <code>COMPLETED</code>, the job is finished. You can find your completed transcript
|
|
436
|
+
* at the URI specified in <code>TranscriptFileUri</code>. If the status is
|
|
437
|
+
* <code>FAILED</code>, <code>FailureReason</code> provides details on why your
|
|
438
|
+
* transcription job failed.</p>
|
|
439
|
+
* <p>If you enabled personally identifiable information (PII) redaction, the redacted
|
|
440
|
+
* transcript appears at the location specified in
|
|
441
|
+
* <code>RedactedTranscriptFileUri</code>.</p>
|
|
442
|
+
* <p>If you chose to redact the audio in your media file, you can find your redacted media
|
|
443
|
+
* file at the location specified in the <code>RedactedMediaFileUri</code> field of your
|
|
423
444
|
* response.</p>
|
|
424
445
|
*/
|
|
425
446
|
export interface CallAnalyticsJob {
|
|
@@ -430,26 +451,24 @@ export interface CallAnalyticsJob {
|
|
|
430
451
|
CallAnalyticsJobName?: string;
|
|
431
452
|
/**
|
|
432
453
|
* <p>Provides the status of the specified Call Analytics job.</p>
|
|
433
|
-
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
434
|
-
* at the location specified in <code>TranscriptFileUri</code> (or
|
|
435
|
-
*
|
|
436
|
-
* <code>FAILED</code>, <code>FailureReason</code> provides details on why
|
|
437
|
-
* job failed.</p>
|
|
454
|
+
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
455
|
+
* results at the location specified in <code>TranscriptFileUri</code> (or
|
|
456
|
+
* <code>RedactedTranscriptFileUri</code>, if you requested transcript redaction). If
|
|
457
|
+
* the status is <code>FAILED</code>, <code>FailureReason</code> provides details on why
|
|
458
|
+
* your transcription job failed.</p>
|
|
438
459
|
*/
|
|
439
460
|
CallAnalyticsJobStatus?: CallAnalyticsJobStatus | string;
|
|
440
461
|
/**
|
|
441
|
-
* <p>The language code used to create your Call Analytics job. For a list of supported
|
|
442
|
-
* and their associated language codes, refer to the
|
|
443
|
-
*
|
|
444
|
-
*
|
|
445
|
-
*
|
|
446
|
-
*
|
|
447
|
-
* of language identification, you can include several language codes and Amazon Transcribe
|
|
448
|
-
* chooses the closest match for your transcription.</p>
|
|
462
|
+
* <p>The language code used to create your Call Analytics job. For a list of supported
|
|
463
|
+
* languages and their associated language codes, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a>
|
|
464
|
+
* table.</p>
|
|
465
|
+
* <p>If you don't know the language spoken in your media file, you can omit this field and
|
|
466
|
+
* let Amazon Transcribe automatically identify the language of your media. To improve the
|
|
467
|
+
* accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.</p>
|
|
449
468
|
*/
|
|
450
469
|
LanguageCode?: LanguageCode | string;
|
|
451
470
|
/**
|
|
452
|
-
* <p>The sample rate, in
|
|
471
|
+
* <p>The sample rate, in hertz, of the audio track in your input media file.</p>
|
|
453
472
|
*/
|
|
454
473
|
MediaSampleRateHertz?: number;
|
|
455
474
|
/**
|
|
@@ -457,12 +476,13 @@ export interface CallAnalyticsJob {
|
|
|
457
476
|
*/
|
|
458
477
|
MediaFormat?: MediaFormat | string;
|
|
459
478
|
/**
|
|
460
|
-
* <p>
|
|
461
|
-
* request.</p>
|
|
479
|
+
* <p>Provides the Amazon S3 location of the media file you used in your Call
|
|
480
|
+
* Analytics request.</p>
|
|
462
481
|
*/
|
|
463
482
|
Media?: Media;
|
|
464
483
|
/**
|
|
465
|
-
* <p>Provides you with the Amazon S3 URI you can use to access your
|
|
484
|
+
* <p>Provides you with the Amazon S3 URI you can use to access your
|
|
485
|
+
* transcript.</p>
|
|
466
486
|
*/
|
|
467
487
|
Transcript?: Transcript;
|
|
468
488
|
/**
|
|
@@ -488,43 +508,44 @@ export interface CallAnalyticsJob {
|
|
|
488
508
|
CompletionTime?: Date;
|
|
489
509
|
/**
|
|
490
510
|
* <p>If <code>CallAnalyticsJobStatus</code> is <code>FAILED</code>,
|
|
491
|
-
*
|
|
492
|
-
* failed.</p>
|
|
511
|
+
* <code>FailureReason</code> contains information about why the Call Analytics job
|
|
512
|
+
* request failed.</p>
|
|
493
513
|
* <p>The <code>FailureReason</code> field contains one of the following values:</p>
|
|
494
514
|
* <ul>
|
|
495
515
|
* <li>
|
|
496
516
|
* <p>
|
|
497
517
|
* <code>Unsupported media format</code>.</p>
|
|
498
518
|
* <p>The media format specified in <code>MediaFormat</code> isn't valid. Refer to
|
|
499
|
-
*
|
|
519
|
+
* <b>MediaFormat</b> for a list of supported
|
|
520
|
+
* formats.</p>
|
|
500
521
|
* </li>
|
|
501
522
|
* <li>
|
|
502
523
|
* <p>
|
|
503
524
|
* <code>The media format provided does not match the detected media
|
|
504
|
-
*
|
|
525
|
+
* format</code>.</p>
|
|
505
526
|
* <p>The media format specified in <code>MediaFormat</code> doesn't match the
|
|
506
|
-
* format of the input file. Check the media format of your media file and correct
|
|
507
|
-
* specified value.</p>
|
|
527
|
+
* format of the input file. Check the media format of your media file and correct
|
|
528
|
+
* the specified value.</p>
|
|
508
529
|
* </li>
|
|
509
530
|
* <li>
|
|
510
531
|
* <p>
|
|
511
532
|
* <code>Invalid sample rate for audio file</code>.</p>
|
|
512
533
|
* <p>The sample rate specified in <code>MediaSampleRateHertz</code> isn't valid.
|
|
513
|
-
* The sample rate must be between 8,000 and 48,000
|
|
534
|
+
* The sample rate must be between 8,000 and 48,000 hertz.</p>
|
|
514
535
|
* </li>
|
|
515
536
|
* <li>
|
|
516
537
|
* <p>
|
|
517
538
|
* <code>The sample rate provided does not match the detected sample
|
|
518
539
|
* rate</code>.</p>
|
|
519
|
-
* <p>The sample rate specified in <code>MediaSampleRateHertz</code> doesn't
|
|
520
|
-
*
|
|
521
|
-
*
|
|
540
|
+
* <p>The sample rate specified in <code>MediaSampleRateHertz</code> doesn't match
|
|
541
|
+
* the sample rate detected in your input media file. Check the sample rate of your
|
|
542
|
+
* media file and correct the specified value.</p>
|
|
522
543
|
* </li>
|
|
523
544
|
* <li>
|
|
524
545
|
* <p>
|
|
525
546
|
* <code>Invalid file size: file size too large</code>.</p>
|
|
526
|
-
* <p>The size of your media file is larger than what Amazon Transcribe can
|
|
527
|
-
* For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits">Guidelines and
|
|
547
|
+
* <p>The size of your media file is larger than what Amazon Transcribe can
|
|
548
|
+
* process. For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits">Guidelines and
|
|
528
549
|
* quotas</a>.</p>
|
|
529
550
|
* </li>
|
|
530
551
|
* <li>
|
|
@@ -538,35 +559,25 @@ export interface CallAnalyticsJob {
|
|
|
538
559
|
*/
|
|
539
560
|
FailureReason?: string;
|
|
540
561
|
/**
|
|
541
|
-
* <p>The Amazon Resource Name (ARN)
|
|
542
|
-
* access the Amazon S3 bucket that contains your input files. If the role you specify doesn’t
|
|
543
|
-
* have the appropriate permissions to access the specified Amazon S3 location, your request
|
|
544
|
-
* fails.</p>
|
|
545
|
-
* <p>IAM role ARNs have the format
|
|
546
|
-
* <code>arn:partition:iam::account:role/role-name-with-path</code>. For example:
|
|
547
|
-
* <code>arn:aws:iam::111122223333:role/Admin</code>.</p>
|
|
548
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM ARNs</a>.</p>
|
|
562
|
+
* <p>The Amazon Resource Name (ARN) you included in your request.</p>
|
|
549
563
|
*/
|
|
550
564
|
DataAccessRoleArn?: string;
|
|
551
565
|
/**
|
|
552
|
-
* <p>The confidence score associated with the language identified in your media
|
|
566
|
+
* <p>The confidence score associated with the language identified in your media
|
|
567
|
+
* file.</p>
|
|
553
568
|
* <p>Confidence scores are values between 0 and 1; a larger value indicates a higher
|
|
554
569
|
* probability that the identified language correctly matches the language spoken in your
|
|
555
570
|
* media.</p>
|
|
556
571
|
*/
|
|
557
572
|
IdentifiedLanguageScore?: number;
|
|
558
573
|
/**
|
|
559
|
-
* <p>
|
|
560
|
-
*
|
|
561
|
-
*
|
|
574
|
+
* <p>Provides information on any additional settings that were included in your request.
|
|
575
|
+
* Additional settings include content redaction and language identification
|
|
576
|
+
* settings.</p>
|
|
562
577
|
*/
|
|
563
578
|
Settings?: CallAnalyticsJobSettings;
|
|
564
579
|
/**
|
|
565
|
-
* <p>
|
|
566
|
-
* For example, if your agent is the first participant to speak, you would set
|
|
567
|
-
* <code>ChannelId</code> to <code>0</code> (to indicate the first channel) and
|
|
568
|
-
* <code>ParticipantRole</code> to <code>AGENT</code> (to indicate that it's the agent
|
|
569
|
-
* speaking).</p>
|
|
580
|
+
* <p>Indicates which speaker is on which channel.</p>
|
|
570
581
|
*/
|
|
571
582
|
ChannelDefinitions?: ChannelDefinition[];
|
|
572
583
|
}
|
|
@@ -606,59 +617,65 @@ export interface CallAnalyticsJobSummary {
|
|
|
606
617
|
LanguageCode?: LanguageCode | string;
|
|
607
618
|
/**
|
|
608
619
|
* <p>Provides the status of your Call Analytics job.</p>
|
|
609
|
-
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
610
|
-
* at the location specified in <code>TranscriptFileUri</code> (or
|
|
611
|
-
*
|
|
612
|
-
* <code>FAILED</code>, <code>FailureReason</code> provides details on why
|
|
613
|
-
* job failed.</p>
|
|
620
|
+
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
621
|
+
* results at the location specified in <code>TranscriptFileUri</code> (or
|
|
622
|
+
* <code>RedactedTranscriptFileUri</code>, if you requested transcript redaction). If
|
|
623
|
+
* the status is <code>FAILED</code>, <code>FailureReason</code> provides details on why
|
|
624
|
+
* your transcription job failed.</p>
|
|
614
625
|
*/
|
|
615
626
|
CallAnalyticsJobStatus?: CallAnalyticsJobStatus | string;
|
|
616
627
|
/**
|
|
617
628
|
* <p>If <code>CallAnalyticsJobStatus</code> is <code>FAILED</code>,
|
|
618
|
-
*
|
|
629
|
+
* <code>FailureReason</code> contains information about why the Call Analytics job
|
|
619
630
|
* failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
|
|
620
631
|
*/
|
|
621
632
|
FailureReason?: string;
|
|
622
633
|
}
|
|
634
|
+
export declare enum InputType {
|
|
635
|
+
POST_CALL = "POST_CALL",
|
|
636
|
+
REAL_TIME = "REAL_TIME"
|
|
637
|
+
}
|
|
623
638
|
/**
|
|
624
639
|
* <p>A time range, in percentage, between two points in your media file.</p>
|
|
625
|
-
* <p>You can use <code>StartPercentage</code> and <code>EndPercentage</code> to
|
|
626
|
-
*
|
|
627
|
-
*
|
|
628
|
-
* contained between the 10 percent mark and the 50 percent mark of your media
|
|
629
|
-
*
|
|
630
|
-
*
|
|
631
|
-
* the
|
|
632
|
-
*
|
|
633
|
-
*
|
|
634
|
-
* .</p>
|
|
640
|
+
* <p>You can use <code>StartPercentage</code> and <code>EndPercentage</code> to search a
|
|
641
|
+
* custom segment. For example, setting <code>StartPercentage</code> to 10 and
|
|
642
|
+
* <code>EndPercentage</code> to 50 only searches for your specified criteria in the
|
|
643
|
+
* audio contained between the 10 percent mark and the 50 percent mark of your media
|
|
644
|
+
* file.</p>
|
|
645
|
+
* <p>You can use also <code>First</code> to search from the start of the media file until
|
|
646
|
+
* the time that you specify. Or use <code>Last</code> to search from the time that you
|
|
647
|
+
* specify until the end of the media file. For example, setting <code>First</code> to 10
|
|
648
|
+
* only searches for your specified criteria in the audio contained in the first 10 percent
|
|
649
|
+
* of the media file.</p>
|
|
650
|
+
* <p>If you prefer to use milliseconds instead of percentage, see .</p>
|
|
635
651
|
*/
|
|
636
652
|
export interface RelativeTimeRange {
|
|
637
653
|
/**
|
|
638
654
|
* <p>The time, in percentage, when Amazon Transcribe starts searching for the specified
|
|
639
|
-
* criteria in your media file. If you include <code>StartPercentage</code> in your
|
|
640
|
-
* must also include <code>EndPercentage</code>.</p>
|
|
655
|
+
* criteria in your media file. If you include <code>StartPercentage</code> in your
|
|
656
|
+
* request, you must also include <code>EndPercentage</code>.</p>
|
|
641
657
|
*/
|
|
642
658
|
StartPercentage?: number;
|
|
643
659
|
/**
|
|
644
|
-
* <p>The time, in percentage, when Amazon Transcribe stops searching for the specified
|
|
645
|
-
* in your media file. If you include <code>EndPercentage</code> in your request,
|
|
646
|
-
* include <code>StartPercentage</code>.</p>
|
|
660
|
+
* <p>The time, in percentage, when Amazon Transcribe stops searching for the specified
|
|
661
|
+
* criteria in your media file. If you include <code>EndPercentage</code> in your request,
|
|
662
|
+
* you must also include <code>StartPercentage</code>.</p>
|
|
647
663
|
*/
|
|
648
664
|
EndPercentage?: number;
|
|
649
665
|
/**
|
|
650
|
-
* <p>The time, in percentage, from the start of your media file until the value
|
|
651
|
-
*
|
|
666
|
+
* <p>The time, in percentage, from the start of your media file until the specified value.
|
|
667
|
+
* Amazon Transcribe searches for your specified criteria in this time segment.</p>
|
|
652
668
|
*/
|
|
653
669
|
First?: number;
|
|
654
670
|
/**
|
|
655
|
-
* <p>The time, in percentage, from the value
|
|
656
|
-
*
|
|
671
|
+
* <p>The time, in percentage, from the specified value until the end of your media file.
|
|
672
|
+
* Amazon Transcribe searches for your specified criteria in this time segment.</p>
|
|
657
673
|
*/
|
|
658
674
|
Last?: number;
|
|
659
675
|
}
|
|
660
676
|
/**
|
|
661
|
-
* <p>Flag the presence or absence of interruptions in your Call Analytics transcription
|
|
677
|
+
* <p>Flag the presence or absence of interruptions in your Call Analytics transcription
|
|
678
|
+
* output.</p>
|
|
662
679
|
* <p>Rules using <code>InterruptionFilter</code> are designed to match:</p>
|
|
663
680
|
* <ul>
|
|
664
681
|
* <li>
|
|
@@ -674,41 +691,39 @@ export interface RelativeTimeRange {
|
|
|
674
691
|
* <p>A lack of interruptions</p>
|
|
675
692
|
* </li>
|
|
676
693
|
* </ul>
|
|
677
|
-
*
|
|
678
|
-
*
|
|
694
|
+
* <p>See <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch">Rule criteria for batch
|
|
695
|
+
* categories</a> for usage examples.</p>
|
|
679
696
|
*/
|
|
680
697
|
export interface InterruptionFilter {
|
|
681
698
|
/**
|
|
682
|
-
* <p>Specify the duration of the interruptions in milliseconds. For example, you can flag
|
|
683
|
-
* contains more than
|
|
699
|
+
* <p>Specify the duration of the interruptions in milliseconds. For example, you can flag
|
|
700
|
+
* speech that contains more than 10,000 milliseconds of interruptions.</p>
|
|
684
701
|
*/
|
|
685
702
|
Threshold?: number;
|
|
686
703
|
/**
|
|
687
|
-
* <p>Specify the interrupter you want to flag. Omitting this parameter is equivalent
|
|
688
|
-
* both participants.</p>
|
|
704
|
+
* <p>Specify the interrupter that you want to flag. Omitting this parameter is equivalent
|
|
705
|
+
* to specifying both participants.</p>
|
|
689
706
|
*/
|
|
690
707
|
ParticipantRole?: ParticipantRole | string;
|
|
691
708
|
/**
|
|
692
|
-
* <p>
|
|
693
|
-
* to search for an interruption. See for more
|
|
694
|
-
* detail.</p>
|
|
709
|
+
* <p>Makes it possible to specify a time range (in milliseconds) in your audio, during
|
|
710
|
+
* which you want to search for an interruption. See for more detail.</p>
|
|
695
711
|
*/
|
|
696
712
|
AbsoluteTimeRange?: AbsoluteTimeRange;
|
|
697
713
|
/**
|
|
698
|
-
* <p>
|
|
699
|
-
* want to search for an interruption. See for more
|
|
700
|
-
* detail.</p>
|
|
714
|
+
* <p>Makes it possible to specify a time range (in percentage) in your media file, during
|
|
715
|
+
* which you want to search for an interruption. See for more detail.</p>
|
|
701
716
|
*/
|
|
702
717
|
RelativeTimeRange?: RelativeTimeRange;
|
|
703
718
|
/**
|
|
704
719
|
* <p>Set to <code>TRUE</code> to flag speech that does not contain interruptions. Set to
|
|
705
|
-
*
|
|
720
|
+
* <code>FALSE</code> to flag speech that contains interruptions.</p>
|
|
706
721
|
*/
|
|
707
722
|
Negate?: boolean;
|
|
708
723
|
}
|
|
709
724
|
/**
|
|
710
|
-
* <p>Flag the presence or absence of periods of silence in your Call Analytics
|
|
711
|
-
* output.</p>
|
|
725
|
+
* <p>Flag the presence or absence of periods of silence in your Call Analytics
|
|
726
|
+
* transcription output.</p>
|
|
712
727
|
* <p>Rules using <code>NonTalkTimeFilter</code> are designed to match:</p>
|
|
713
728
|
* <ul>
|
|
714
729
|
* <li>
|
|
@@ -718,25 +733,23 @@ export interface InterruptionFilter {
|
|
|
718
733
|
* <p>The presence of speech at specified periods throughout the call</p>
|
|
719
734
|
* </li>
|
|
720
735
|
* </ul>
|
|
721
|
-
* <p>See <a href="https://docs.aws.amazon.com/transcribe/latest/dg/
|
|
722
|
-
*
|
|
736
|
+
* <p>See <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch">Rule criteria for batch
|
|
737
|
+
* categories</a> for usage examples.</p>
|
|
723
738
|
*/
|
|
724
739
|
export interface NonTalkTimeFilter {
|
|
725
740
|
/**
|
|
726
|
-
* <p>Specify the duration, in milliseconds, of the period of silence you want to flag.
|
|
727
|
-
* example, you can flag a silent period that lasts
|
|
741
|
+
* <p>Specify the duration, in milliseconds, of the period of silence that you want to flag.
|
|
742
|
+
* For example, you can flag a silent period that lasts 30,000 milliseconds.</p>
|
|
728
743
|
*/
|
|
729
744
|
Threshold?: number;
|
|
730
745
|
/**
|
|
731
|
-
* <p>
|
|
732
|
-
* to search for a period of silence. See for more
|
|
733
|
-
* detail.</p>
|
|
746
|
+
* <p>Makes it possible to specify a time range (in milliseconds) in your audio, during
|
|
747
|
+
* which you want to search for a period of silence. See for more detail.</p>
|
|
734
748
|
*/
|
|
735
749
|
AbsoluteTimeRange?: AbsoluteTimeRange;
|
|
736
750
|
/**
|
|
737
|
-
* <p>
|
|
738
|
-
* want to search for a period of silence. See for more
|
|
739
|
-
* detail.</p>
|
|
751
|
+
* <p>Makes it possible to specify a time range (in percentage) in your media file, during
|
|
752
|
+
* which you want to search for a period of silence. See for more detail.</p>
|
|
740
753
|
*/
|
|
741
754
|
RelativeTimeRange?: RelativeTimeRange;
|
|
742
755
|
/**
|
|
@@ -773,34 +786,33 @@ export declare enum SentimentValue {
|
|
|
773
786
|
* or both at specified points in the call</p>
|
|
774
787
|
* </li>
|
|
775
788
|
* </ul>
|
|
776
|
-
* <p>See <a href="https://docs.aws.amazon.com/transcribe/latest/dg/
|
|
777
|
-
*
|
|
789
|
+
* <p>See <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch">Rule criteria for batch
|
|
790
|
+
* categories</a> for usage examples.</p>
|
|
778
791
|
*/
|
|
779
792
|
export interface SentimentFilter {
|
|
780
793
|
/**
|
|
781
|
-
* <p>Specify the sentiments you want to flag.</p>
|
|
794
|
+
* <p>Specify the sentiments that you want to flag.</p>
|
|
782
795
|
*/
|
|
783
796
|
Sentiments: (SentimentValue | string)[] | undefined;
|
|
784
797
|
/**
|
|
785
|
-
* <p>
|
|
786
|
-
* to search for the specified sentiments. See for more
|
|
787
|
-
* detail.</p>
|
|
798
|
+
* <p>Makes it possible to specify a time range (in milliseconds) in your audio, during
|
|
799
|
+
* which you want to search for the specified sentiments. See for more detail.</p>
|
|
788
800
|
*/
|
|
789
801
|
AbsoluteTimeRange?: AbsoluteTimeRange;
|
|
790
802
|
/**
|
|
791
|
-
* <p>
|
|
792
|
-
* want to search for the specified sentiments. See
|
|
793
|
-
* for more detail.</p>
|
|
803
|
+
* <p>Makes it possible to specify a time range (in percentage) in your media file, during
|
|
804
|
+
* which you want to search for the specified sentiments. See for more detail.</p>
|
|
794
805
|
*/
|
|
795
806
|
RelativeTimeRange?: RelativeTimeRange;
|
|
796
807
|
/**
|
|
797
|
-
* <p>Specify the participant you want to flag. Omitting this parameter is equivalent
|
|
798
|
-
* both participants.</p>
|
|
808
|
+
* <p>Specify the participant that you want to flag. Omitting this parameter is equivalent
|
|
809
|
+
* to specifying both participants.</p>
|
|
799
810
|
*/
|
|
800
811
|
ParticipantRole?: ParticipantRole | string;
|
|
801
812
|
/**
|
|
802
|
-
* <p>Set to <code>TRUE</code> to flag the sentiments you didn't include in your
|
|
803
|
-
* <code>FALSE</code> to flag the sentiments you specified in your
|
|
813
|
+
* <p>Set to <code>TRUE</code> to flag the sentiments that you didn't include in your
|
|
814
|
+
* request. Set to <code>FALSE</code> to flag the sentiments that you specified in your
|
|
815
|
+
* request.</p>
|
|
804
816
|
*/
|
|
805
817
|
Negate?: boolean;
|
|
806
818
|
}
|
|
@@ -808,8 +820,8 @@ export declare enum TranscriptFilterType {
|
|
|
808
820
|
EXACT = "EXACT"
|
|
809
821
|
}
|
|
810
822
|
/**
|
|
811
|
-
* <p>Flag the presence or absence of specific words or phrases detected in your Call
|
|
812
|
-
* transcription output.</p>
|
|
823
|
+
* <p>Flag the presence or absence of specific words or phrases detected in your Call
|
|
824
|
+
* Analytics transcription output.</p>
|
|
813
825
|
* <p>Rules using <code>TranscriptFilter</code> are designed to match:</p>
|
|
814
826
|
* <ul>
|
|
815
827
|
* <li>
|
|
@@ -823,63 +835,62 @@ export declare enum TranscriptFilterType {
|
|
|
823
835
|
* <p>Custom words or phrases that occur at a specific time frame</p>
|
|
824
836
|
* </li>
|
|
825
837
|
* </ul>
|
|
826
|
-
* <p>See <a href="https://docs.aws.amazon.com/transcribe/latest/dg/
|
|
827
|
-
*
|
|
838
|
+
* <p>See <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch">Rule criteria for batch
|
|
839
|
+
* categories</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html#tca-rules-stream">Rule criteria for
|
|
840
|
+
* streaming categories</a> for usage examples.</p>
|
|
828
841
|
*/
|
|
829
842
|
export interface TranscriptFilter {
|
|
830
843
|
/**
|
|
831
|
-
* <p>Flag the presence or absence of an exact match to the phrases you specify. For
|
|
832
|
-
* specify the phrase "speak to a manager" as your <code>Targets</code>
|
|
833
|
-
* phrase is flagged.</p>
|
|
834
|
-
* <p>Note that semantic matching is not supported. For example, if your customer says
|
|
835
|
-
* <i>the</i> manager", instead of "speak to <i>a</i>
|
|
844
|
+
* <p>Flag the presence or absence of an exact match to the phrases that you specify. For
|
|
845
|
+
* example, if you specify the phrase "speak to a manager" as your <code>Targets</code>
|
|
846
|
+
* value, only that exact phrase is flagged.</p>
|
|
847
|
+
* <p>Note that semantic matching is not supported. For example, if your customer says
|
|
848
|
+
* "speak to <i>the</i> manager", instead of "speak to <i>a</i>
|
|
836
849
|
* manager", your content is not flagged.</p>
|
|
837
850
|
*/
|
|
838
851
|
TranscriptFilterType: TranscriptFilterType | string | undefined;
|
|
839
852
|
/**
|
|
840
|
-
* <p>
|
|
841
|
-
* search for the specified key words or phrases. See
|
|
842
|
-
* for more detail.</p>
|
|
853
|
+
* <p>Makes it possible to specify a time range (in milliseconds) in your audio, during
|
|
854
|
+
* which you want to search for the specified key words or phrases. See for more detail.</p>
|
|
843
855
|
*/
|
|
844
856
|
AbsoluteTimeRange?: AbsoluteTimeRange;
|
|
845
857
|
/**
|
|
846
|
-
* <p>
|
|
847
|
-
* want to search for the specified key words or phrases. See
|
|
848
|
-
* for more detail.</p>
|
|
858
|
+
* <p>Makes it possible to specify a time range (in percentage) in your media file, during
|
|
859
|
+
* which you want to search for the specified key words or phrases. See for more detail.</p>
|
|
849
860
|
*/
|
|
850
861
|
RelativeTimeRange?: RelativeTimeRange;
|
|
851
862
|
/**
|
|
852
|
-
* <p>Specify the participant you want to flag. Omitting this parameter is equivalent
|
|
853
|
-
* both participants.</p>
|
|
863
|
+
* <p>Specify the participant that you want to flag. Omitting this parameter is equivalent
|
|
864
|
+
* to specifying both participants.</p>
|
|
854
865
|
*/
|
|
855
866
|
ParticipantRole?: ParticipantRole | string;
|
|
856
867
|
/**
|
|
857
|
-
* <p>Set to <code>TRUE</code> to flag the absence of the phrase you specified in your
|
|
858
|
-
* Set to <code>FALSE</code> to flag the presence of the phrase you specified
|
|
868
|
+
* <p>Set to <code>TRUE</code> to flag the absence of the phrase that you specified in your
|
|
869
|
+
* request. Set to <code>FALSE</code> to flag the presence of the phrase that you specified
|
|
870
|
+
* in your request.</p>
|
|
859
871
|
*/
|
|
860
872
|
Negate?: boolean;
|
|
861
873
|
/**
|
|
862
|
-
* <p>Specify the phrases you want to flag.</p>
|
|
874
|
+
* <p>Specify the phrases that you want to flag.</p>
|
|
863
875
|
*/
|
|
864
876
|
Targets: string[] | undefined;
|
|
865
877
|
}
|
|
866
878
|
/**
|
|
867
|
-
* <p>A rule is a set of criteria you can specify to flag an attribute in your Call
|
|
868
|
-
* Rules define a Call Analytics category.</p>
|
|
869
|
-
* <p>Rules can include these parameters: ,
|
|
870
|
-
*
|
|
871
|
-
*
|
|
872
|
-
*
|
|
873
|
-
* criteria</a>.</p>
|
|
874
|
-
* <p>To learn more about Call Analytics categories, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html">Creating categories</a>.</p>
|
|
879
|
+
* <p>A rule is a set of criteria that you can specify to flag an attribute in your Call
|
|
880
|
+
* Analytics output. Rules define a Call Analytics category.</p>
|
|
881
|
+
* <p>Rules can include these parameters: , , , and .</p>
|
|
882
|
+
* <p>To learn more about Call Analytics rules and categories, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html">Creating categories for batch
|
|
883
|
+
* transcriptions</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html">Creating categories for
|
|
884
|
+
* streaming transcriptions</a>.</p>
|
|
875
885
|
* <p>To learn more about Call Analytics, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html">Analyzing call center audio with Call
|
|
876
|
-
*
|
|
886
|
+
* Analytics</a>.</p>
|
|
877
887
|
*/
|
|
878
888
|
export declare type Rule = Rule.InterruptionFilterMember | Rule.NonTalkTimeFilterMember | Rule.SentimentFilterMember | Rule.TranscriptFilterMember | Rule.$UnknownMember;
|
|
879
889
|
export declare namespace Rule {
|
|
880
890
|
/**
|
|
881
|
-
* <p>Flag the presence or absence of periods of silence in your Call Analytics
|
|
882
|
-
* output. Refer to for more
|
|
891
|
+
* <p>Flag the presence or absence of periods of silence in your Call Analytics
|
|
892
|
+
* transcription output. Refer to for more
|
|
893
|
+
* detail.</p>
|
|
883
894
|
*/
|
|
884
895
|
interface NonTalkTimeFilterMember {
|
|
885
896
|
NonTalkTimeFilter: NonTalkTimeFilter;
|
|
@@ -889,8 +900,8 @@ export declare namespace Rule {
|
|
|
889
900
|
$unknown?: never;
|
|
890
901
|
}
|
|
891
902
|
/**
|
|
892
|
-
* <p>Flag the presence or absence of interruptions in your Call Analytics transcription
|
|
893
|
-
*
|
|
903
|
+
* <p>Flag the presence or absence of interruptions in your Call Analytics transcription
|
|
904
|
+
* output. Refer to for more detail.</p>
|
|
894
905
|
*/
|
|
895
906
|
interface InterruptionFilterMember {
|
|
896
907
|
NonTalkTimeFilter?: never;
|
|
@@ -900,8 +911,9 @@ export declare namespace Rule {
|
|
|
900
911
|
$unknown?: never;
|
|
901
912
|
}
|
|
902
913
|
/**
|
|
903
|
-
* <p>Flag the presence or absence of specific words or phrases in your Call Analytics
|
|
904
|
-
* output. Refer to for more
|
|
914
|
+
* <p>Flag the presence or absence of specific words or phrases in your Call Analytics
|
|
915
|
+
* transcription output. Refer to for more
|
|
916
|
+
* detail.</p>
|
|
905
917
|
*/
|
|
906
918
|
interface TranscriptFilterMember {
|
|
907
919
|
NonTalkTimeFilter?: never;
|
|
@@ -911,8 +923,9 @@ export declare namespace Rule {
|
|
|
911
923
|
$unknown?: never;
|
|
912
924
|
}
|
|
913
925
|
/**
|
|
914
|
-
* <p>Flag the presence or absence of specific sentiments in your Call Analytics
|
|
915
|
-
* Refer to for more
|
|
926
|
+
* <p>Flag the presence or absence of specific sentiments in your Call Analytics
|
|
927
|
+
* transcription output. Refer to for more
|
|
928
|
+
* detail.</p>
|
|
916
929
|
*/
|
|
917
930
|
interface SentimentFilterMember {
|
|
918
931
|
NonTalkTimeFilter?: never;
|
|
@@ -948,24 +961,30 @@ export interface CategoryProperties {
|
|
|
948
961
|
*/
|
|
949
962
|
CategoryName?: string;
|
|
950
963
|
/**
|
|
951
|
-
* <p>The rules used to define a Call Analytics category. Each category can have between 1
|
|
952
|
-
* rules.</p>
|
|
964
|
+
* <p>The rules used to define a Call Analytics category. Each category can have between 1
|
|
965
|
+
* and 20 rules.</p>
|
|
953
966
|
*/
|
|
954
967
|
Rules?: Rule[];
|
|
955
968
|
/**
|
|
956
969
|
* <p>The date and time the specified Call Analytics category was created.</p>
|
|
957
970
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
958
|
-
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7
|
|
959
|
-
*
|
|
971
|
+
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
972
|
+
* 4, 2022.</p>
|
|
960
973
|
*/
|
|
961
974
|
CreateTime?: Date;
|
|
962
975
|
/**
|
|
963
976
|
* <p>The date and time the specified Call Analytics category was last updated.</p>
|
|
964
977
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
965
|
-
* example, <code>2022-05-05T12:45:32.691000-07:00</code> represents 12:45 PM UTC-7
|
|
966
|
-
*
|
|
978
|
+
* example, <code>2022-05-05T12:45:32.691000-07:00</code> represents 12:45 PM UTC-7 on May
|
|
979
|
+
* 5, 2022.</p>
|
|
967
980
|
*/
|
|
968
981
|
LastUpdateTime?: Date;
|
|
982
|
+
/**
|
|
983
|
+
* <p>The input type associated with the specified category. <code>POST_CALL</code>
|
|
984
|
+
* refers to a category that is applied to batch transcriptions; <code>REAL_TIME</code>
|
|
985
|
+
* refers to a category that is applied to streaming transcriptions.</p>
|
|
986
|
+
*/
|
|
987
|
+
InputType?: InputType | string;
|
|
969
988
|
}
|
|
970
989
|
export declare enum CLMLanguageCode {
|
|
971
990
|
EN_AU = "en-AU",
|
|
@@ -976,7 +995,7 @@ export declare enum CLMLanguageCode {
|
|
|
976
995
|
}
|
|
977
996
|
/**
|
|
978
997
|
* <p>A resource already exists with this name. Resource names must be unique within an
|
|
979
|
-
*
|
|
998
|
+
* Amazon Web Services account.</p>
|
|
980
999
|
*/
|
|
981
1000
|
export declare class ConflictException extends __BaseException {
|
|
982
1001
|
readonly name: "ConflictException";
|
|
@@ -989,24 +1008,38 @@ export declare class ConflictException extends __BaseException {
|
|
|
989
1008
|
}
|
|
990
1009
|
export interface CreateCallAnalyticsCategoryRequest {
|
|
991
1010
|
/**
|
|
992
|
-
* <p>A unique name, chosen by you, for your Call Analytics category. It's helpful to use a
|
|
993
|
-
* naming system that will make sense to you in the future. For example, it's
|
|
994
|
-
* <code>sentiment-positive-last30seconds</code> for a category over a
|
|
995
|
-
* <code>test-category</code>.</p>
|
|
1011
|
+
* <p>A unique name, chosen by you, for your Call Analytics category. It's helpful to use a
|
|
1012
|
+
* detailed naming system that will make sense to you in the future. For example, it's
|
|
1013
|
+
* better to use <code>sentiment-positive-last30seconds</code> for a category over a
|
|
1014
|
+
* generic name like <code>test-category</code>.</p>
|
|
996
1015
|
* <p>Category names are case sensitive.</p>
|
|
997
1016
|
*/
|
|
998
1017
|
CategoryName: string | undefined;
|
|
999
1018
|
/**
|
|
1000
|
-
* <p>Rules define a Call Analytics category. When creating a new
|
|
1001
|
-
*
|
|
1002
|
-
* applied to the attributes of a call. For example, you can choose a sentiment filter that
|
|
1003
|
-
* customer's sentiment was positive during the last 30 seconds of the call.</p>
|
|
1019
|
+
* <p>Rules define a Call Analytics category. When creating a new category, you must create
|
|
1020
|
+
* between 1 and 20 rules for that category. For each rule, you specify a filter you want
|
|
1021
|
+
* applied to the attributes of a call. For example, you can choose a sentiment filter that
|
|
1022
|
+
* detects if a customer's sentiment was positive during the last 30 seconds of the call.</p>
|
|
1004
1023
|
*/
|
|
1005
1024
|
Rules: Rule[] | undefined;
|
|
1025
|
+
/**
|
|
1026
|
+
* <p>Choose whether you want to create a streaming or a batch category for your Call Analytics
|
|
1027
|
+
* transcription.</p>
|
|
1028
|
+
* <p>Specifying <code>POST_CALL</code> assigns your category to batch transcriptions;
|
|
1029
|
+
* categories with this input type cannot be applied to streaming (real-time)
|
|
1030
|
+
* transcriptions.</p>
|
|
1031
|
+
* <p>Specifying <code>REAL_TIME</code> assigns your category to streaming transcriptions;
|
|
1032
|
+
* categories with this input type cannot be applied to batch (post-call)
|
|
1033
|
+
* transcriptions.</p>
|
|
1034
|
+
* <p>If you do not include <code>InputType</code>, your category is created as a batch
|
|
1035
|
+
* category by default.</p>
|
|
1036
|
+
*/
|
|
1037
|
+
InputType?: InputType | string;
|
|
1006
1038
|
}
|
|
1007
1039
|
export interface CreateCallAnalyticsCategoryResponse {
|
|
1008
1040
|
/**
|
|
1009
|
-
* <p>Provides you with the properties of your new category, including its associated
|
|
1041
|
+
* <p>Provides you with the properties of your new category, including its associated
|
|
1042
|
+
* rules.</p>
|
|
1010
1043
|
*/
|
|
1011
1044
|
CategoryProperties?: CategoryProperties;
|
|
1012
1045
|
}
|
|
@@ -1024,8 +1057,8 @@ export declare class InternalFailureException extends __BaseException {
|
|
|
1024
1057
|
constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
|
|
1025
1058
|
}
|
|
1026
1059
|
/**
|
|
1027
|
-
* <p>You've either sent too many requests or your input file is too long. Wait before
|
|
1028
|
-
* your request, or use a smaller file and try your request again.</p>
|
|
1060
|
+
* <p>You've either sent too many requests or your input file is too long. Wait before
|
|
1061
|
+
* retrying your request, or use a smaller file and try your request again.</p>
|
|
1029
1062
|
*/
|
|
1030
1063
|
export declare class LimitExceededException extends __BaseException {
|
|
1031
1064
|
readonly name: "LimitExceededException";
|
|
@@ -1037,24 +1070,24 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
1037
1070
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
1038
1071
|
}
|
|
1039
1072
|
/**
|
|
1040
|
-
* <p>Contains the Amazon S3 location of the training data you want to use to create
|
|
1041
|
-
* custom language model, and permissions to access this location.</p>
|
|
1073
|
+
* <p>Contains the Amazon S3 location of the training data you want to use to create
|
|
1074
|
+
* a new custom language model, and permissions to access this location.</p>
|
|
1042
1075
|
* <p>When using <code>InputDataConfig</code>, you must include these sub-parameters:
|
|
1043
|
-
*
|
|
1044
|
-
*
|
|
1076
|
+
* <code>S3Uri</code> and <code>DataAccessRoleArn</code>. You can optionally include
|
|
1077
|
+
* <code>TuningDataS3Uri</code>.</p>
|
|
1045
1078
|
*/
|
|
1046
1079
|
export interface InputDataConfig {
|
|
1047
1080
|
/**
|
|
1048
|
-
* <p>The Amazon S3 location (URI) of the text files you want to use to train your
|
|
1049
|
-
* language model.</p>
|
|
1081
|
+
* <p>The Amazon S3 location (URI) of the text files you want to use to train your
|
|
1082
|
+
* custom language model.</p>
|
|
1050
1083
|
* <p>Here's an example URI path:
|
|
1051
|
-
*
|
|
1084
|
+
* <code>s3://DOC-EXAMPLE-BUCKET/my-model-training-data/</code>
|
|
1052
1085
|
* </p>
|
|
1053
1086
|
*/
|
|
1054
1087
|
S3Uri: string | undefined;
|
|
1055
1088
|
/**
|
|
1056
|
-
* <p>The Amazon S3 location (URI) of the text files you want to use to tune your
|
|
1057
|
-
* language model.</p>
|
|
1089
|
+
* <p>The Amazon S3 location (URI) of the text files you want to use to tune your
|
|
1090
|
+
* custom language model.</p>
|
|
1058
1091
|
* <p>Here's an example URI path:
|
|
1059
1092
|
* <code>s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/</code>
|
|
1060
1093
|
* </p>
|
|
@@ -1062,83 +1095,88 @@ export interface InputDataConfig {
|
|
|
1062
1095
|
TuningDataS3Uri?: string;
|
|
1063
1096
|
/**
|
|
1064
1097
|
* <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
|
|
1065
|
-
* access the Amazon S3 bucket that contains your input files. If the role you
|
|
1066
|
-
* have the appropriate permissions to access the specified Amazon S3 location, your request
|
|
1067
|
-
* fails.</p>
|
|
1098
|
+
* access the Amazon S3 bucket that contains your input files. If the role that you
|
|
1099
|
+
* specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.</p>
|
|
1068
1100
|
* <p>IAM role ARNs have the format
|
|
1069
|
-
*
|
|
1070
|
-
*
|
|
1071
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
|
|
1101
|
+
* <code>arn:partition:iam::account:role/role-name-with-path</code>. For example:
|
|
1102
|
+
* <code>arn:aws:iam::111122223333:role/Admin</code>.</p>
|
|
1103
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
|
|
1104
|
+
* ARNs</a>.</p>
|
|
1072
1105
|
*/
|
|
1073
1106
|
DataAccessRoleArn: string | undefined;
|
|
1074
1107
|
}
|
|
1075
1108
|
/**
|
|
1076
1109
|
* <p>Adds metadata, in the form of a key:value pair, to the specified resource.</p>
|
|
1077
|
-
* <p>For example, you could add the tag <code>Department:Sales</code> to a
|
|
1078
|
-
*
|
|
1079
|
-
*
|
|
1110
|
+
* <p>For example, you could add the tag <code>Department:Sales</code> to a resource to
|
|
1111
|
+
* indicate that it pertains to your organization's sales department. You can also use tags
|
|
1112
|
+
* for tag-based access control.</p>
|
|
1080
1113
|
* <p>To learn more about tagging, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging resources</a>.</p>
|
|
1081
1114
|
*/
|
|
1082
1115
|
export interface Tag {
|
|
1083
1116
|
/**
|
|
1084
|
-
* <p>The first part of a key:value pair that forms a tag associated with a given resource.
|
|
1085
|
-
* example, in the tag <code>Department:Sales</code>, the key is 'Department'.</p>
|
|
1117
|
+
* <p>The first part of a key:value pair that forms a tag associated with a given resource.
|
|
1118
|
+
* For example, in the tag <code>Department:Sales</code>, the key is 'Department'.</p>
|
|
1086
1119
|
*/
|
|
1087
1120
|
Key: string | undefined;
|
|
1088
1121
|
/**
|
|
1089
1122
|
* <p>The second part of a key:value pair that forms a tag associated with a given resource.
|
|
1090
1123
|
* For example, in the tag <code>Department:Sales</code>, the value is 'Sales'.</p>
|
|
1091
|
-
* <p>Note that you can set the value of a tag to an empty string, but you can't set the
|
|
1092
|
-
* tag to null. Omitting the tag value is the same as using an empty
|
|
1124
|
+
* <p>Note that you can set the value of a tag to an empty string, but you can't set the
|
|
1125
|
+
* value of a tag to null. Omitting the tag value is the same as using an empty
|
|
1126
|
+
* string.</p>
|
|
1093
1127
|
*/
|
|
1094
1128
|
Value: string | undefined;
|
|
1095
1129
|
}
|
|
1096
1130
|
export interface CreateLanguageModelRequest {
|
|
1097
1131
|
/**
|
|
1098
|
-
* <p>The language code that represents the language of your model. Each language
|
|
1099
|
-
* contain terms in only one language, and the language you select for your
|
|
1100
|
-
* language of your training and tuning data.</p>
|
|
1132
|
+
* <p>The language code that represents the language of your model. Each custom language
|
|
1133
|
+
* model must contain terms in only one language, and the language you select for your
|
|
1134
|
+
* custom language model must match the language of your training and tuning data.</p>
|
|
1101
1135
|
* <p>For a list of supported languages and their associated language codes, refer to the
|
|
1102
|
-
*
|
|
1103
|
-
*
|
|
1104
|
-
*
|
|
1105
|
-
*
|
|
1106
|
-
*
|
|
1107
|
-
*
|
|
1136
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table. Note that
|
|
1137
|
+
* US English
|
|
1138
|
+
* (<code>en-US</code>) is the only language supported with Amazon Transcribe
|
|
1139
|
+
* Medical.</p>
|
|
1140
|
+
* <p>A custom language model can only be used to transcribe files in the same language as
|
|
1141
|
+
* the model. For example, if you create a custom language model using US English
|
|
1142
|
+
* (<code>en-US</code>), you can only apply this model to files that contain English
|
|
1143
|
+
* audio.</p>
|
|
1108
1144
|
*/
|
|
1109
1145
|
LanguageCode: CLMLanguageCode | string | undefined;
|
|
1110
1146
|
/**
|
|
1111
|
-
* <p>The Amazon Transcribe standard language model, or base model, used to create your
|
|
1112
|
-
* language model. Amazon Transcribe offers two options for base models: Wideband
|
|
1113
|
-
* Narrowband.</p>
|
|
1147
|
+
* <p>The Amazon Transcribe standard language model, or base model, used to create your
|
|
1148
|
+
* custom language model. Amazon Transcribe offers two options for base models: Wideband
|
|
1149
|
+
* and Narrowband.</p>
|
|
1114
1150
|
* <p>If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose
|
|
1115
|
-
*
|
|
1116
|
-
* <code>NarrowBand</code>.</p>
|
|
1151
|
+
* <code>WideBand</code>. To transcribe audio with a sample rate less than 16,000 Hz,
|
|
1152
|
+
* choose <code>NarrowBand</code>.</p>
|
|
1117
1153
|
*/
|
|
1118
1154
|
BaseModelName: BaseModelName | string | undefined;
|
|
1119
1155
|
/**
|
|
1120
1156
|
* <p>A unique name, chosen by you, for your custom language model.</p>
|
|
1121
1157
|
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
1122
|
-
*
|
|
1123
|
-
* as an existing language model, you get a
|
|
1158
|
+
* Amazon Web Services account. If you try to create a new custom language model with
|
|
1159
|
+
* the same name as an existing custom language model, you get a
|
|
1160
|
+
* <code>ConflictException</code> error.</p>
|
|
1124
1161
|
*/
|
|
1125
1162
|
ModelName: string | undefined;
|
|
1126
1163
|
/**
|
|
1127
|
-
* <p>Contains the Amazon S3 location of the training data you want to use to create
|
|
1128
|
-
* custom language model, and permissions to access this location.</p>
|
|
1164
|
+
* <p>Contains the Amazon S3 location of the training data you want to use to create
|
|
1165
|
+
* a new custom language model, and permissions to access this location.</p>
|
|
1129
1166
|
* <p>When using <code>InputDataConfig</code>, you must include these sub-parameters:
|
|
1130
|
-
*
|
|
1131
|
-
* <code>DataAccessRoleArn</code>, which is the Amazon Resource Name (ARN) of the role
|
|
1132
|
-
* has permission to access your specified Amazon S3 location. You can
|
|
1133
|
-
* <code>TuningDataS3Uri</code>, which is the Amazon S3 location
|
|
1134
|
-
* you specify different Amazon S3 locations for training
|
|
1135
|
-
* must have permissions to access both locations.</p>
|
|
1167
|
+
* <code>S3Uri</code>, which is the Amazon S3 location of your training data,
|
|
1168
|
+
* and <code>DataAccessRoleArn</code>, which is the Amazon Resource Name (ARN) of the role
|
|
1169
|
+
* that has permission to access your specified Amazon S3 location. You can
|
|
1170
|
+
* optionally include <code>TuningDataS3Uri</code>, which is the Amazon S3 location
|
|
1171
|
+
* of your tuning data. If you specify different Amazon S3 locations for training
|
|
1172
|
+
* and tuning data, the ARN you use must have permissions to access both locations.</p>
|
|
1136
1173
|
*/
|
|
1137
1174
|
InputDataConfig: InputDataConfig | undefined;
|
|
1138
1175
|
/**
|
|
1139
|
-
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new custom
|
|
1140
|
-
* model at the time you create this new model.</p>
|
|
1141
|
-
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
1176
|
+
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new custom
|
|
1177
|
+
* language model at the time you create this new model.</p>
|
|
1178
|
+
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
1179
|
+
* resources</a>.</p>
|
|
1142
1180
|
*/
|
|
1143
1181
|
Tags?: Tag[];
|
|
1144
1182
|
}
|
|
@@ -1153,8 +1191,8 @@ export interface CreateLanguageModelResponse {
|
|
|
1153
1191
|
*/
|
|
1154
1192
|
LanguageCode?: CLMLanguageCode | string;
|
|
1155
1193
|
/**
|
|
1156
|
-
* <p>The Amazon Transcribe standard language model, or base model, you specified when
|
|
1157
|
-
* your custom language model.</p>
|
|
1194
|
+
* <p>The Amazon Transcribe standard language model, or base model, you specified when
|
|
1195
|
+
* creating your custom language model.</p>
|
|
1158
1196
|
*/
|
|
1159
1197
|
BaseModelName?: BaseModelName | string;
|
|
1160
1198
|
/**
|
|
@@ -1164,12 +1202,12 @@ export interface CreateLanguageModelResponse {
|
|
|
1164
1202
|
/**
|
|
1165
1203
|
* <p>Lists your data access role ARN (Amazon Resource Name) and the Amazon S3
|
|
1166
1204
|
* locations you provided for your training (<code>S3Uri</code>) and tuning
|
|
1167
|
-
*
|
|
1205
|
+
* (<code>TuningDataS3Uri</code>) data.</p>
|
|
1168
1206
|
*/
|
|
1169
1207
|
InputDataConfig?: InputDataConfig;
|
|
1170
1208
|
/**
|
|
1171
1209
|
* <p>The status of your custom language model. When the status displays as
|
|
1172
|
-
*
|
|
1210
|
+
* <code>COMPLETED</code>, your model is ready to use.</p>
|
|
1173
1211
|
*/
|
|
1174
1212
|
ModelStatus?: ModelStatus | string;
|
|
1175
1213
|
}
|
|
@@ -1177,29 +1215,30 @@ export interface CreateMedicalVocabularyRequest {
|
|
|
1177
1215
|
/**
|
|
1178
1216
|
* <p>A unique name, chosen by you, for your new custom medical vocabulary.</p>
|
|
1179
1217
|
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
1180
|
-
*
|
|
1181
|
-
* as an existing medical vocabulary, you get a
|
|
1218
|
+
* Amazon Web Services account. If you try to create a new custom medical vocabulary
|
|
1219
|
+
* with the same name as an existing custom medical vocabulary, you get a
|
|
1220
|
+
* <code>ConflictException</code> error.</p>
|
|
1182
1221
|
*/
|
|
1183
1222
|
VocabularyName: string | undefined;
|
|
1184
1223
|
/**
|
|
1185
1224
|
* <p>The language code that represents the language of the entries in your custom
|
|
1186
|
-
* vocabulary. US English (<code>en-US</code>) is the only language supported with
|
|
1187
|
-
* Amazon Transcribe Medical.</p>
|
|
1225
|
+
* vocabulary. US English (<code>en-US</code>) is the only language supported with Amazon Transcribe Medical.</p>
|
|
1188
1226
|
*/
|
|
1189
1227
|
LanguageCode: LanguageCode | string | undefined;
|
|
1190
1228
|
/**
|
|
1191
|
-
* <p>The Amazon S3 location (URI) of the text file that contains your custom
|
|
1192
|
-
* vocabulary. The URI must be in the same Amazon Web Services Region as the
|
|
1193
|
-
* calling.</p>
|
|
1229
|
+
* <p>The Amazon S3 location (URI) of the text file that contains your custom
|
|
1230
|
+
* medical vocabulary. The URI must be in the same Amazon Web Services Region as the
|
|
1231
|
+
* resource you're calling.</p>
|
|
1194
1232
|
* <p>Here's an example URI path:
|
|
1195
1233
|
* <code>s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt</code>
|
|
1196
1234
|
* </p>
|
|
1197
1235
|
*/
|
|
1198
1236
|
VocabularyFileUri: string | undefined;
|
|
1199
1237
|
/**
|
|
1200
|
-
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new
|
|
1201
|
-
* vocabulary at the time you create this new vocabulary.</p>
|
|
1202
|
-
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
1238
|
+
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new custom
|
|
1239
|
+
* medical vocabulary at the time you create this new custom vocabulary.</p>
|
|
1240
|
+
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
1241
|
+
* resources</a>.</p>
|
|
1203
1242
|
*/
|
|
1204
1243
|
Tags?: Tag[];
|
|
1205
1244
|
}
|
|
@@ -1214,27 +1253,28 @@ export interface CreateMedicalVocabularyResponse {
|
|
|
1214
1253
|
*/
|
|
1215
1254
|
VocabularyName?: string;
|
|
1216
1255
|
/**
|
|
1217
|
-
* <p>The language code you selected for your medical vocabulary. US English
|
|
1218
|
-
*
|
|
1256
|
+
* <p>The language code you selected for your custom medical vocabulary. US English
|
|
1257
|
+
* (<code>en-US</code>) is the only language supported with Amazon Transcribe
|
|
1258
|
+
* Medical.</p>
|
|
1219
1259
|
*/
|
|
1220
1260
|
LanguageCode?: LanguageCode | string;
|
|
1221
1261
|
/**
|
|
1222
1262
|
* <p>The processing state of your custom medical vocabulary. If the state is
|
|
1223
|
-
*
|
|
1224
|
-
*
|
|
1263
|
+
* <code>READY</code>, you can use the custom vocabulary in a
|
|
1264
|
+
* <code>StartMedicalTranscriptionJob</code> request.</p>
|
|
1225
1265
|
*/
|
|
1226
1266
|
VocabularyState?: VocabularyState | string;
|
|
1227
1267
|
/**
|
|
1228
1268
|
* <p>The date and time you created your custom medical vocabulary.</p>
|
|
1229
1269
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1230
|
-
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7
|
|
1231
|
-
*
|
|
1270
|
+
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
1271
|
+
* 4, 2022.</p>
|
|
1232
1272
|
*/
|
|
1233
1273
|
LastModifiedTime?: Date;
|
|
1234
1274
|
/**
|
|
1235
|
-
* <p>If <code>VocabularyState</code> is <code>FAILED</code>,
|
|
1236
|
-
*
|
|
1237
|
-
*
|
|
1275
|
+
* <p>If <code>VocabularyState</code> is <code>FAILED</code>, <code>FailureReason</code>
|
|
1276
|
+
* contains information about why the medical transcription job request failed. See also:
|
|
1277
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
|
|
1238
1278
|
*/
|
|
1239
1279
|
FailureReason?: string;
|
|
1240
1280
|
}
|
|
@@ -1242,49 +1282,52 @@ export interface CreateVocabularyRequest {
|
|
|
1242
1282
|
/**
|
|
1243
1283
|
* <p>A unique name, chosen by you, for your new custom vocabulary.</p>
|
|
1244
1284
|
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
1245
|
-
*
|
|
1246
|
-
* existing vocabulary, you get a <code>ConflictException</code>
|
|
1285
|
+
* Amazon Web Services account. If you try to create a new custom vocabulary with the
|
|
1286
|
+
* same name as an existing custom vocabulary, you get a <code>ConflictException</code>
|
|
1287
|
+
* error.</p>
|
|
1247
1288
|
*/
|
|
1248
1289
|
VocabularyName: string | undefined;
|
|
1249
1290
|
/**
|
|
1250
1291
|
* <p>The language code that represents the language of the entries in your custom
|
|
1251
|
-
* vocabulary. Each vocabulary must contain terms in only one language.</p>
|
|
1292
|
+
* vocabulary. Each custom vocabulary must contain terms in only one language.</p>
|
|
1252
1293
|
* <p>A custom vocabulary can only be used to transcribe files in the same language as the
|
|
1253
|
-
* vocabulary. For example, if you create a vocabulary using US English
|
|
1254
|
-
*
|
|
1294
|
+
* custom vocabulary. For example, if you create a custom vocabulary using US English
|
|
1295
|
+
* (<code>en-US</code>), you can only apply this custom vocabulary to files that
|
|
1296
|
+
* contain English audio.</p>
|
|
1255
1297
|
* <p>For a list of supported languages and their associated language codes, refer to the
|
|
1256
|
-
*
|
|
1257
|
-
* languages</a> table.</p>
|
|
1298
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
|
|
1258
1299
|
*/
|
|
1259
1300
|
LanguageCode: LanguageCode | string | undefined;
|
|
1260
1301
|
/**
|
|
1261
|
-
* <p>Use this parameter if you want to create your vocabulary by including all
|
|
1262
|
-
* comma-separated values, within your request. The other option for
|
|
1263
|
-
* save your entries in a text file and upload them
|
|
1264
|
-
* the location of your file using the
|
|
1302
|
+
* <p>Use this parameter if you want to create your custom vocabulary by including all
|
|
1303
|
+
* desired terms, as comma-separated values, within your request. The other option for
|
|
1304
|
+
* creating your custom vocabulary is to save your entries in a text file and upload them
|
|
1305
|
+
* to an Amazon S3 bucket, then specify the location of your file using the
|
|
1306
|
+
* <code>VocabularyFileUri</code> parameter.</p>
|
|
1265
1307
|
* <p>Note that if you include <code>Phrases</code> in your request, you cannot use
|
|
1266
|
-
*
|
|
1267
|
-
* <p>Each language has a character set that contains all allowed characters for that
|
|
1268
|
-
* language. If you use unsupported characters, your vocabulary filter
|
|
1269
|
-
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for
|
|
1270
|
-
*
|
|
1308
|
+
* <code>VocabularyFileUri</code>; you must choose one or the other.</p>
|
|
1309
|
+
* <p>Each language has a character set that contains all allowed characters for that
|
|
1310
|
+
* specific language. If you use unsupported characters, your custom vocabulary filter
|
|
1311
|
+
* request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
|
|
1312
|
+
* Vocabularies</a> to get the character set for your language.</p>
|
|
1271
1313
|
*/
|
|
1272
1314
|
Phrases?: string[];
|
|
1273
1315
|
/**
|
|
1274
|
-
* <p>The Amazon S3 location of the text file that contains your custom vocabulary.
|
|
1275
|
-
* URI must be located in the same Amazon Web Services Region as the resource you're
|
|
1316
|
+
* <p>The Amazon S3 location of the text file that contains your custom vocabulary.
|
|
1317
|
+
* The URI must be located in the same Amazon Web Services Region as the resource you're
|
|
1276
1318
|
* calling.</p>
|
|
1277
1319
|
* <p>Here's an example URI path:
|
|
1278
1320
|
* <code>s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt</code>
|
|
1279
1321
|
* </p>
|
|
1280
|
-
* <p>Note that if you include <code>VocabularyFileUri</code> in your request, you
|
|
1281
|
-
*
|
|
1322
|
+
* <p>Note that if you include <code>VocabularyFileUri</code> in your request, you cannot
|
|
1323
|
+
* use the <code>Phrases</code> flag; you must choose one or the other.</p>
|
|
1282
1324
|
*/
|
|
1283
1325
|
VocabularyFileUri?: string;
|
|
1284
1326
|
/**
|
|
1285
1327
|
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new custom
|
|
1286
|
-
* vocabulary at the time you create this new vocabulary.</p>
|
|
1287
|
-
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
1328
|
+
* vocabulary at the time you create this new custom vocabulary.</p>
|
|
1329
|
+
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
1330
|
+
* resources</a>.</p>
|
|
1288
1331
|
*/
|
|
1289
1332
|
Tags?: Tag[];
|
|
1290
1333
|
}
|
|
@@ -1298,21 +1341,22 @@ export interface CreateVocabularyResponse {
|
|
|
1298
1341
|
*/
|
|
1299
1342
|
LanguageCode?: LanguageCode | string;
|
|
1300
1343
|
/**
|
|
1301
|
-
* <p>The processing state of your custom vocabulary. If the state is <code>READY</code>,
|
|
1302
|
-
* can use the vocabulary in a <code>StartTranscriptionJob</code>
|
|
1344
|
+
* <p>The processing state of your custom vocabulary. If the state is <code>READY</code>,
|
|
1345
|
+
* you can use the custom vocabulary in a <code>StartTranscriptionJob</code>
|
|
1346
|
+
* request.</p>
|
|
1303
1347
|
*/
|
|
1304
1348
|
VocabularyState?: VocabularyState | string;
|
|
1305
1349
|
/**
|
|
1306
1350
|
* <p>The date and time you created your custom vocabulary.</p>
|
|
1307
1351
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1308
|
-
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7
|
|
1309
|
-
*
|
|
1352
|
+
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
1353
|
+
* 4, 2022.</p>
|
|
1310
1354
|
*/
|
|
1311
1355
|
LastModifiedTime?: Date;
|
|
1312
1356
|
/**
|
|
1313
|
-
* <p>If <code>VocabularyState</code> is <code>FAILED</code>,
|
|
1314
|
-
*
|
|
1315
|
-
*
|
|
1357
|
+
* <p>If <code>VocabularyState</code> is <code>FAILED</code>, <code>FailureReason</code>
|
|
1358
|
+
* contains information about why the custom vocabulary request failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common
|
|
1359
|
+
* Errors</a>.</p>
|
|
1316
1360
|
*/
|
|
1317
1361
|
FailureReason?: string;
|
|
1318
1362
|
}
|
|
@@ -1320,41 +1364,42 @@ export interface CreateVocabularyFilterRequest {
|
|
|
1320
1364
|
/**
|
|
1321
1365
|
* <p>A unique name, chosen by you, for your new custom vocabulary filter.</p>
|
|
1322
1366
|
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
1323
|
-
*
|
|
1324
|
-
* as an existing vocabulary filter, you get a
|
|
1367
|
+
* Amazon Web Services account. If you try to create a new custom vocabulary filter with
|
|
1368
|
+
* the same name as an existing custom vocabulary filter, you get a
|
|
1369
|
+
* <code>ConflictException</code> error.</p>
|
|
1325
1370
|
*/
|
|
1326
1371
|
VocabularyFilterName: string | undefined;
|
|
1327
1372
|
/**
|
|
1328
1373
|
* <p>The language code that represents the language of the entries in your vocabulary
|
|
1329
|
-
* filter. Each vocabulary filter must contain terms in only one language.</p>
|
|
1330
|
-
* <p>A vocabulary filter can only be used to transcribe files in the same language
|
|
1331
|
-
* filter. For example, if you create a vocabulary filter using US English
|
|
1332
|
-
*
|
|
1374
|
+
* filter. Each custom vocabulary filter must contain terms in only one language.</p>
|
|
1375
|
+
* <p>A custom vocabulary filter can only be used to transcribe files in the same language
|
|
1376
|
+
* as the filter. For example, if you create a custom vocabulary filter using US English
|
|
1377
|
+
* (<code>en-US</code>), you can only apply this filter to files that contain English
|
|
1378
|
+
* audio.</p>
|
|
1333
1379
|
* <p>For a list of supported languages and their associated language codes, refer to the
|
|
1334
|
-
*
|
|
1335
|
-
* languages</a> table.</p>
|
|
1380
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
|
|
1336
1381
|
*/
|
|
1337
1382
|
LanguageCode: LanguageCode | string | undefined;
|
|
1338
1383
|
/**
|
|
1339
|
-
* <p>Use this parameter if you want to create your vocabulary filter by including
|
|
1340
|
-
* as comma-separated values, within your request. The other option for
|
|
1341
|
-
* filter is to save your entries in a text file and upload them
|
|
1342
|
-
* specify the location of your file using the
|
|
1343
|
-
*
|
|
1384
|
+
* <p>Use this parameter if you want to create your custom vocabulary filter by including
|
|
1385
|
+
* all desired terms, as comma-separated values, within your request. The other option for
|
|
1386
|
+
* creating your vocabulary filter is to save your entries in a text file and upload them
|
|
1387
|
+
* to an Amazon S3 bucket, then specify the location of your file using the
|
|
1388
|
+
* <code>VocabularyFilterFileUri</code> parameter.</p>
|
|
1344
1389
|
* <p>Note that if you include <code>Words</code> in your request, you cannot use
|
|
1345
|
-
*
|
|
1346
|
-
* <p>Each language has a character set that contains all allowed characters for that
|
|
1347
|
-
* language. If you use unsupported characters, your vocabulary filter
|
|
1348
|
-
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for
|
|
1349
|
-
*
|
|
1390
|
+
* <code>VocabularyFilterFileUri</code>; you must choose one or the other.</p>
|
|
1391
|
+
* <p>Each language has a character set that contains all allowed characters for that
|
|
1392
|
+
* specific language. If you use unsupported characters, your custom vocabulary filter
|
|
1393
|
+
* request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
|
|
1394
|
+
* Vocabularies</a> to get the character set for your language.</p>
|
|
1350
1395
|
*/
|
|
1351
1396
|
Words?: string[];
|
|
1352
1397
|
/**
|
|
1353
|
-
* <p>The Amazon S3 location of the text file that contains your custom vocabulary
|
|
1354
|
-
* terms. The URI must be located in the same Amazon Web Services Region as the
|
|
1355
|
-
* calling.</p>
|
|
1398
|
+
* <p>The Amazon S3 location of the text file that contains your custom vocabulary
|
|
1399
|
+
* filter terms. The URI must be located in the same Amazon Web Services Region as the
|
|
1400
|
+
* resource you're calling.</p>
|
|
1356
1401
|
* <p>Here's an example URI path:
|
|
1357
|
-
*
|
|
1402
|
+
* <code>s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt</code>
|
|
1358
1403
|
* </p>
|
|
1359
1404
|
* <p>Note that if you include <code>VocabularyFilterFileUri</code> in your request, you
|
|
1360
1405
|
* cannot use <code>Words</code>; you must choose one or the other.</p>
|
|
@@ -1362,8 +1407,9 @@ export interface CreateVocabularyFilterRequest {
|
|
|
1362
1407
|
VocabularyFilterFileUri?: string;
|
|
1363
1408
|
/**
|
|
1364
1409
|
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new custom
|
|
1365
|
-
* vocabulary filter at the time you create this new filter.</p>
|
|
1366
|
-
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
1410
|
+
* vocabulary filter at the time you create this new vocabulary filter.</p>
|
|
1411
|
+
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
1412
|
+
* resources</a>.</p>
|
|
1367
1413
|
*/
|
|
1368
1414
|
Tags?: Tag[];
|
|
1369
1415
|
}
|
|
@@ -1373,29 +1419,29 @@ export interface CreateVocabularyFilterResponse {
|
|
|
1373
1419
|
*/
|
|
1374
1420
|
VocabularyFilterName?: string;
|
|
1375
1421
|
/**
|
|
1376
|
-
* <p>The language code you selected for your vocabulary filter.</p>
|
|
1422
|
+
* <p>The language code you selected for your custom vocabulary filter.</p>
|
|
1377
1423
|
*/
|
|
1378
1424
|
LanguageCode?: LanguageCode | string;
|
|
1379
1425
|
/**
|
|
1380
|
-
* <p>The date and time you created your vocabulary filter.</p>
|
|
1426
|
+
* <p>The date and time you created your custom vocabulary filter.</p>
|
|
1381
1427
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1382
|
-
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7
|
|
1383
|
-
*
|
|
1428
|
+
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
1429
|
+
* 4, 2022.</p>
|
|
1384
1430
|
*/
|
|
1385
1431
|
LastModifiedTime?: Date;
|
|
1386
1432
|
}
|
|
1387
1433
|
export interface DeleteCallAnalyticsCategoryRequest {
|
|
1388
1434
|
/**
|
|
1389
|
-
* <p>The name of the Call Analytics category you want to delete. Category names are
|
|
1390
|
-
*
|
|
1435
|
+
* <p>The name of the Call Analytics category you want to delete. Category names are case
|
|
1436
|
+
* sensitive.</p>
|
|
1391
1437
|
*/
|
|
1392
1438
|
CategoryName: string | undefined;
|
|
1393
1439
|
}
|
|
1394
1440
|
export interface DeleteCallAnalyticsCategoryResponse {
|
|
1395
1441
|
}
|
|
1396
1442
|
/**
|
|
1397
|
-
* <p>We can't find the requested resource. Check that the specified name is correct and try
|
|
1398
|
-
* request again.</p>
|
|
1443
|
+
* <p>We can't find the requested resource. Check that the specified name is correct and try
|
|
1444
|
+
* your request again.</p>
|
|
1399
1445
|
*/
|
|
1400
1446
|
export declare class NotFoundException extends __BaseException {
|
|
1401
1447
|
readonly name: "NotFoundException";
|
|
@@ -1408,7 +1454,8 @@ export declare class NotFoundException extends __BaseException {
|
|
|
1408
1454
|
}
|
|
1409
1455
|
export interface DeleteCallAnalyticsJobRequest {
|
|
1410
1456
|
/**
|
|
1411
|
-
* <p>The name of the Call Analytics job you want to delete. Job names are case
|
|
1457
|
+
* <p>The name of the Call Analytics job you want to delete. Job names are case
|
|
1458
|
+
* sensitive.</p>
|
|
1412
1459
|
*/
|
|
1413
1460
|
CallAnalyticsJobName: string | undefined;
|
|
1414
1461
|
}
|
|
@@ -1416,8 +1463,8 @@ export interface DeleteCallAnalyticsJobResponse {
|
|
|
1416
1463
|
}
|
|
1417
1464
|
export interface DeleteLanguageModelRequest {
|
|
1418
1465
|
/**
|
|
1419
|
-
* <p>The name of the custom language model you want to delete. Model names are
|
|
1420
|
-
*
|
|
1466
|
+
* <p>The name of the custom language model you want to delete. Model names are case
|
|
1467
|
+
* sensitive.</p>
|
|
1421
1468
|
*/
|
|
1422
1469
|
ModelName: string | undefined;
|
|
1423
1470
|
}
|
|
@@ -1430,115 +1477,118 @@ export interface DeleteMedicalTranscriptionJobRequest {
|
|
|
1430
1477
|
}
|
|
1431
1478
|
export interface DeleteMedicalVocabularyRequest {
|
|
1432
1479
|
/**
|
|
1433
|
-
* <p>The name of the custom medical vocabulary you want to delete.
|
|
1434
|
-
* case sensitive.</p>
|
|
1480
|
+
* <p>The name of the custom medical vocabulary you want to delete. Custom medical
|
|
1481
|
+
* vocabulary names are case sensitive.</p>
|
|
1435
1482
|
*/
|
|
1436
1483
|
VocabularyName: string | undefined;
|
|
1437
1484
|
}
|
|
1438
1485
|
export interface DeleteTranscriptionJobRequest {
|
|
1439
1486
|
/**
|
|
1440
|
-
* <p>The name of the transcription job you want to delete. Job names are case
|
|
1487
|
+
* <p>The name of the transcription job you want to delete. Job names are case
|
|
1488
|
+
* sensitive.</p>
|
|
1441
1489
|
*/
|
|
1442
1490
|
TranscriptionJobName: string | undefined;
|
|
1443
1491
|
}
|
|
1444
1492
|
export interface DeleteVocabularyRequest {
|
|
1445
1493
|
/**
|
|
1446
|
-
* <p>The name of the custom vocabulary you want to delete.
|
|
1447
|
-
*
|
|
1494
|
+
* <p>The name of the custom vocabulary you want to delete. Custom vocabulary names are case
|
|
1495
|
+
* sensitive.</p>
|
|
1448
1496
|
*/
|
|
1449
1497
|
VocabularyName: string | undefined;
|
|
1450
1498
|
}
|
|
1451
1499
|
export interface DeleteVocabularyFilterRequest {
|
|
1452
1500
|
/**
|
|
1453
|
-
* <p>The name of the custom vocabulary filter you want to delete.
|
|
1454
|
-
* are case sensitive.</p>
|
|
1501
|
+
* <p>The name of the custom vocabulary filter you want to delete. Custom vocabulary filter
|
|
1502
|
+
* names are case sensitive.</p>
|
|
1455
1503
|
*/
|
|
1456
1504
|
VocabularyFilterName: string | undefined;
|
|
1457
1505
|
}
|
|
1458
1506
|
export interface DescribeLanguageModelRequest {
|
|
1459
1507
|
/**
|
|
1460
|
-
* <p>The name of the custom language model you want information about. Model names are
|
|
1461
|
-
*
|
|
1508
|
+
* <p>The name of the custom language model you want information about. Model names are case
|
|
1509
|
+
* sensitive.</p>
|
|
1462
1510
|
*/
|
|
1463
1511
|
ModelName: string | undefined;
|
|
1464
1512
|
}
|
|
1465
1513
|
/**
|
|
1466
|
-
* <p>Provides
|
|
1467
|
-
*
|
|
1468
|
-
*
|
|
1469
|
-
*
|
|
1514
|
+
* <p>Provides
|
|
1515
|
+
* information about a custom language model, including the base model name, when the model
|
|
1516
|
+
* was created, the location of the files used to train the model, when the model was last
|
|
1517
|
+
* modified, the name you chose for the model, its language, its processing state, and if
|
|
1518
|
+
* there is an upgrade available for the base model.</p>
|
|
1470
1519
|
*/
|
|
1471
1520
|
export interface LanguageModel {
|
|
1472
1521
|
/**
|
|
1473
1522
|
* <p>A unique name, chosen by you, for your custom language model.</p>
|
|
1474
1523
|
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
1475
|
-
*
|
|
1524
|
+
* Amazon Web Services account.</p>
|
|
1476
1525
|
*/
|
|
1477
1526
|
ModelName?: string;
|
|
1478
1527
|
/**
|
|
1479
1528
|
* <p>The date and time the specified custom language model was created.</p>
|
|
1480
1529
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1481
|
-
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7
|
|
1482
|
-
*
|
|
1530
|
+
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
1531
|
+
* 4, 2022.</p>
|
|
1483
1532
|
*/
|
|
1484
1533
|
CreateTime?: Date;
|
|
1485
1534
|
/**
|
|
1486
|
-
* <p>The date and time the specified language model was last modified.</p>
|
|
1535
|
+
* <p>The date and time the specified custom language model was last modified.</p>
|
|
1487
1536
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1488
|
-
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7
|
|
1489
|
-
*
|
|
1537
|
+
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
1538
|
+
* 4, 2022.</p>
|
|
1490
1539
|
*/
|
|
1491
1540
|
LastModifiedTime?: Date;
|
|
1492
1541
|
/**
|
|
1493
|
-
* <p>The language code used to create your custom language model. Each language
|
|
1494
|
-
* contain terms in only one language, and the language you select for your
|
|
1495
|
-
* the language of your training and tuning data.</p>
|
|
1542
|
+
* <p>The language code used to create your custom language model. Each custom language
|
|
1543
|
+
* model must contain terms in only one language, and the language you select for your
|
|
1544
|
+
* custom language model must match the language of your training and tuning data.</p>
|
|
1496
1545
|
* <p>For a list of supported languages and their associated language codes, refer to the
|
|
1497
|
-
*
|
|
1498
|
-
*
|
|
1499
|
-
* supported with Amazon Transcribe Medical.</p>
|
|
1546
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table. Note that U.S. English (<code>en-US</code>) is
|
|
1547
|
+
* the only language supported with Amazon Transcribe Medical.</p>
|
|
1500
1548
|
*/
|
|
1501
1549
|
LanguageCode?: CLMLanguageCode | string;
|
|
1502
1550
|
/**
|
|
1503
|
-
* <p>The Amazon Transcribe standard language model, or base model, used to create your
|
|
1504
|
-
* language model.</p>
|
|
1551
|
+
* <p>The Amazon Transcribe standard language model, or base model, used to create your
|
|
1552
|
+
* custom language model.</p>
|
|
1505
1553
|
*/
|
|
1506
1554
|
BaseModelName?: BaseModelName | string;
|
|
1507
1555
|
/**
|
|
1508
1556
|
* <p>The status of the specified custom language model. When the status displays as
|
|
1509
|
-
*
|
|
1557
|
+
* <code>COMPLETED</code> the model is ready for use.</p>
|
|
1510
1558
|
*/
|
|
1511
1559
|
ModelStatus?: ModelStatus | string;
|
|
1512
1560
|
/**
|
|
1513
|
-
* <p>Shows if a more current base model is available for use with the specified custom
|
|
1561
|
+
* <p>Shows if a more current base model is available for use with the specified custom
|
|
1562
|
+
* language model.</p>
|
|
1563
|
+
* <p>If <code>false</code>, your custom language model is using the most up-to-date base
|
|
1514
1564
|
* model.</p>
|
|
1515
|
-
* <p>If <code>false</code>, your language model is using the most up-to-date base model.</p>
|
|
1516
1565
|
* <p>If <code>true</code>, there is a newer base model available than the one your language
|
|
1517
1566
|
* model is using.</p>
|
|
1518
|
-
* <p>Note that to update a base model, you must recreate the custom language model using
|
|
1519
|
-
* new base model. Base model upgrades for existing custom language models are not
|
|
1567
|
+
* <p>Note that to update a base model, you must recreate the custom language model using
|
|
1568
|
+
* the new base model. Base model upgrades for existing custom language models are not
|
|
1520
1569
|
* supported.</p>
|
|
1521
1570
|
*/
|
|
1522
1571
|
UpgradeAvailability?: boolean;
|
|
1523
1572
|
/**
|
|
1524
1573
|
* <p>If <code>ModelStatus</code> is <code>FAILED</code>, <code>FailureReason</code>
|
|
1525
1574
|
* contains information about why the custom language model request failed. See also:
|
|
1526
|
-
*
|
|
1575
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
|
|
1527
1576
|
*/
|
|
1528
1577
|
FailureReason?: string;
|
|
1529
1578
|
/**
|
|
1530
|
-
* <p>The Amazon S3 location of the input files used to train and tune your custom
|
|
1531
|
-
* model, in addition to the data access role ARN (Amazon Resource Name) that has
|
|
1532
|
-
* access these data.</p>
|
|
1579
|
+
* <p>The Amazon S3 location of the input files used to train and tune your custom
|
|
1580
|
+
* language model, in addition to the data access role ARN (Amazon Resource Name) that has
|
|
1581
|
+
* permissions to access these data.</p>
|
|
1533
1582
|
*/
|
|
1534
1583
|
InputDataConfig?: InputDataConfig;
|
|
1535
1584
|
}
|
|
1536
1585
|
export interface DescribeLanguageModelResponse {
|
|
1537
1586
|
/**
|
|
1538
|
-
* <p>Provides information about the specified custom language
|
|
1587
|
+
* <p>Provides information about the specified custom language
|
|
1588
|
+
* model.</p>
|
|
1539
1589
|
* <p>This parameter also shows if the base language model you used to create your custom
|
|
1540
|
-
* language model has been updated. If Amazon Transcribe has updated the base model, you
|
|
1541
|
-
* create a new custom language model using the updated base model.</p>
|
|
1590
|
+
* language model has been updated. If Amazon Transcribe has updated the base model, you
|
|
1591
|
+
* can create a new custom language model using the updated base model.</p>
|
|
1542
1592
|
* <p>If you tried to create a new custom language model and the request wasn't successful,
|
|
1543
1593
|
* you can use this <code>DescribeLanguageModel</code> to help identify the reason for this
|
|
1544
1594
|
* failure.</p>
|
|
@@ -1555,7 +1605,7 @@ export interface GetCallAnalyticsCategoryRequest {
|
|
|
1555
1605
|
export interface GetCallAnalyticsCategoryResponse {
|
|
1556
1606
|
/**
|
|
1557
1607
|
* <p>Provides you with the properties of the Call Analytics category you specified in your
|
|
1558
|
-
*
|
|
1608
|
+
* <code>GetCallAnalyticsCategory</code> request.</p>
|
|
1559
1609
|
*/
|
|
1560
1610
|
CategoryProperties?: CategoryProperties;
|
|
1561
1611
|
}
|
|
@@ -1568,15 +1618,15 @@ export interface GetCallAnalyticsJobRequest {
|
|
|
1568
1618
|
}
|
|
1569
1619
|
export interface GetCallAnalyticsJobResponse {
|
|
1570
1620
|
/**
|
|
1571
|
-
* <p>Provides detailed information about the specified Call Analytics job, including job
|
|
1572
|
-
* and, if applicable, failure reason.</p>
|
|
1621
|
+
* <p>Provides detailed information about the specified Call Analytics job, including job
|
|
1622
|
+
* status and, if applicable, failure reason.</p>
|
|
1573
1623
|
*/
|
|
1574
1624
|
CallAnalyticsJob?: CallAnalyticsJob;
|
|
1575
1625
|
}
|
|
1576
1626
|
export interface GetMedicalTranscriptionJobRequest {
|
|
1577
1627
|
/**
|
|
1578
|
-
* <p>The name of the medical transcription job you want information about. Job names are
|
|
1579
|
-
* sensitive.</p>
|
|
1628
|
+
* <p>The name of the medical transcription job you want information about. Job names are
|
|
1629
|
+
* case sensitive.</p>
|
|
1580
1630
|
*/
|
|
1581
1631
|
MedicalTranscriptionJobName: string | undefined;
|
|
1582
1632
|
}
|
|
@@ -1584,69 +1634,74 @@ export declare enum MedicalContentIdentificationType {
|
|
|
1584
1634
|
PHI = "PHI"
|
|
1585
1635
|
}
|
|
1586
1636
|
/**
|
|
1587
|
-
* <p>Allows additional optional settings in your
|
|
1588
|
-
*
|
|
1589
|
-
*
|
|
1637
|
+
* <p>Allows additional optional settings in your request, including channel
|
|
1638
|
+
* identification, alternative transcriptions, and speaker partitioning. You can use that to
|
|
1639
|
+
* apply custom vocabularies to your medical transcription job.</p>
|
|
1590
1640
|
*/
|
|
1591
1641
|
export interface MedicalTranscriptionSetting {
|
|
1592
1642
|
/**
|
|
1593
|
-
* <p>Enables speaker
|
|
1594
|
-
* labels the speech from individual speakers in your media file.</p>
|
|
1643
|
+
* <p>Enables speaker partitioning (diarization) in your transcription output. Speaker
|
|
1644
|
+
* partitioning labels the speech from individual speakers in your media file.</p>
|
|
1595
1645
|
* <p>If you enable <code>ShowSpeakerLabels</code> in your request, you must also include
|
|
1596
|
-
*
|
|
1597
|
-
* <p>You can't include
|
|
1598
|
-
*
|
|
1646
|
+
* <code>MaxSpeakerLabels</code>.</p>
|
|
1647
|
+
* <p>You can't include <code>ShowSpeakerLabels</code> and
|
|
1648
|
+
* <code>ChannelIdentification</code> in the same request. Including both parameters
|
|
1599
1649
|
* returns a <code>BadRequestException</code>.</p>
|
|
1600
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">
|
|
1650
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers
|
|
1651
|
+
* (diarization)</a>.</p>
|
|
1601
1652
|
*/
|
|
1602
1653
|
ShowSpeakerLabels?: boolean;
|
|
1603
1654
|
/**
|
|
1604
|
-
* <p>Specify the maximum number of speakers you want to
|
|
1605
|
-
* <p>Note that if your media contains more speakers than the specified number, multiple
|
|
1606
|
-
*
|
|
1655
|
+
* <p>Specify the maximum number of speakers you want to partition in your media.</p>
|
|
1656
|
+
* <p>Note that if your media contains more speakers than the specified number, multiple
|
|
1657
|
+
* speakers are treated as a single speaker.</p>
|
|
1607
1658
|
* <p>If you specify the <code>MaxSpeakerLabels</code> field, you must set the
|
|
1608
|
-
*
|
|
1659
|
+
* <code>ShowSpeakerLabels</code> field to true.</p>
|
|
1609
1660
|
*/
|
|
1610
1661
|
MaxSpeakerLabels?: number;
|
|
1611
1662
|
/**
|
|
1612
1663
|
* <p>Enables channel identification in multi-channel audio.</p>
|
|
1613
|
-
* <p>Channel identification transcribes the audio on each channel independently, then
|
|
1614
|
-
* output for each channel into one transcript.</p>
|
|
1615
|
-
* <p>If you have multi-channel audio and do not enable channel identification, your audio
|
|
1616
|
-
* transcribed in a continuous manner and your transcript does not separate the speech
|
|
1664
|
+
* <p>Channel identification transcribes the audio on each channel independently, then
|
|
1665
|
+
* appends the output for each channel into one transcript.</p>
|
|
1666
|
+
* <p>If you have multi-channel audio and do not enable channel identification, your audio
|
|
1667
|
+
* is transcribed in a continuous manner and your transcript does not separate the speech
|
|
1668
|
+
* by channel.</p>
|
|
1617
1669
|
* <p>You can't include both <code>ShowSpeakerLabels</code> and
|
|
1618
|
-
*
|
|
1670
|
+
* <code>ChannelIdentification</code> in the same request. Including both parameters
|
|
1619
1671
|
* returns a <code>BadRequestException</code>.</p>
|
|
1620
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel
|
|
1672
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel
|
|
1673
|
+
* audio</a>.</p>
|
|
1621
1674
|
*/
|
|
1622
1675
|
ChannelIdentification?: boolean;
|
|
1623
1676
|
/**
|
|
1624
1677
|
* <p>To include alternative transcriptions within your transcription output, include
|
|
1625
|
-
*
|
|
1678
|
+
* <code>ShowAlternatives</code> in your transcription request.</p>
|
|
1626
1679
|
* <p>If you include <code>ShowAlternatives</code>, you must also include
|
|
1627
|
-
*
|
|
1628
|
-
* you want Amazon Transcribe Medical to generate.</p>
|
|
1629
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative
|
|
1680
|
+
* <code>MaxAlternatives</code>, which is the maximum number of alternative
|
|
1681
|
+
* transcriptions you want Amazon Transcribe Medical to generate.</p>
|
|
1682
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative
|
|
1683
|
+
* transcriptions</a>.</p>
|
|
1630
1684
|
*/
|
|
1631
1685
|
ShowAlternatives?: boolean;
|
|
1632
1686
|
/**
|
|
1633
1687
|
* <p>Indicate the maximum number of alternative transcriptions you want Amazon Transcribe
|
|
1634
1688
|
* Medical to include in your transcript.</p>
|
|
1635
|
-
* <p>If you select a number greater than the number of alternative transcriptions generated
|
|
1636
|
-
* Amazon Transcribe Medical, only the actual number of alternative transcriptions are
|
|
1689
|
+
* <p>If you select a number greater than the number of alternative transcriptions generated
|
|
1690
|
+
* by Amazon Transcribe Medical, only the actual number of alternative transcriptions are
|
|
1637
1691
|
* included.</p>
|
|
1638
1692
|
* <p>If you include <code>MaxAlternatives</code> in your request, you must also include
|
|
1639
|
-
*
|
|
1640
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative
|
|
1693
|
+
* <code>ShowAlternatives</code> with a value of <code>true</code>.</p>
|
|
1694
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative
|
|
1695
|
+
* transcriptions</a>.</p>
|
|
1641
1696
|
*/
|
|
1642
1697
|
MaxAlternatives?: number;
|
|
1643
1698
|
/**
|
|
1644
1699
|
* <p>The name of the custom vocabulary you want to use when processing your medical
|
|
1645
|
-
* transcription job.
|
|
1646
|
-
* <p>The language of the specified vocabulary must match the language code you
|
|
1647
|
-
* your transcription request. If the languages don't match, the
|
|
1648
|
-
* are no errors or warnings associated with a language
|
|
1649
|
-
* (<code>en-US</code>) is the only valid language for Amazon Transcribe Medical.</p>
|
|
1700
|
+
* transcription job. Custom vocabulary names are case sensitive.</p>
|
|
1701
|
+
* <p>The language of the specified custom vocabulary must match the language code that you
|
|
1702
|
+
* specify in your transcription request. If the languages don't match, the custom
|
|
1703
|
+
* vocabulary isn't applied. There are no errors or warnings associated with a language
|
|
1704
|
+
* mismatch. US English (<code>en-US</code>) is the only valid language for Amazon Transcribe Medical.</p>
|
|
1650
1705
|
*/
|
|
1651
1706
|
VocabularyName?: string;
|
|
1652
1707
|
}
|
|
@@ -1654,24 +1709,15 @@ export declare enum Specialty {
|
|
|
1654
1709
|
PRIMARYCARE = "PRIMARYCARE"
|
|
1655
1710
|
}
|
|
1656
1711
|
/**
|
|
1657
|
-
* <p>Provides you with the Amazon S3 URI you can use to access your
|
|
1712
|
+
* <p>Provides you with the Amazon S3 URI you can use to access your
|
|
1713
|
+
* transcript.</p>
|
|
1658
1714
|
*/
|
|
1659
1715
|
export interface MedicalTranscript {
|
|
1660
1716
|
/**
|
|
1661
1717
|
* <p>The Amazon S3 location of your transcript. You can use this URI to access or
|
|
1662
1718
|
* download your transcript.</p>
|
|
1663
|
-
* <p>
|
|
1664
|
-
*
|
|
1665
|
-
* output is located in the path you specified in your request.</p>
|
|
1666
|
-
* <p>If you didn't include <code>OutputBucketName</code> in your transcription job request,
|
|
1667
|
-
* your transcript is stored in a service-managed bucket, and <code>TranscriptFileUri</code>
|
|
1668
|
-
* provides you with a temporary URI you can use for secure access to your transcript.</p>
|
|
1669
|
-
* <note>
|
|
1670
|
-
* <p>Temporary URIs for service-managed Amazon S3 buckets are only valid for 15
|
|
1671
|
-
* minutes. If you get an <code>AccesDenied</code> error, you can get a new temporary
|
|
1672
|
-
* URI by running a <code>GetTranscriptionJob</code> or
|
|
1673
|
-
* <code>ListTranscriptionJob</code> request.</p>
|
|
1674
|
-
* </note>
|
|
1719
|
+
* <p>Note that this is the Amazon S3 location you specified in your request using the
|
|
1720
|
+
* <code>OutputBucketName</code> parameter.</p>
|
|
1675
1721
|
*/
|
|
1676
1722
|
TranscriptFileUri?: string;
|
|
1677
1723
|
}
|
|
@@ -1688,32 +1734,34 @@ export declare enum Type {
|
|
|
1688
1734
|
/**
|
|
1689
1735
|
* <p>Provides detailed information about a medical transcription job.</p>
|
|
1690
1736
|
* <p>To view the status of the specified medical transcription job, check the
|
|
1691
|
-
*
|
|
1692
|
-
* job is finished and you can find the results at the location specified in
|
|
1693
|
-
*
|
|
1694
|
-
*
|
|
1737
|
+
* <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>,
|
|
1738
|
+
* the job is finished and you can find the results at the location specified in
|
|
1739
|
+
* <code>TranscriptFileUri</code>. If the status is <code>FAILED</code>,
|
|
1740
|
+
* <code>FailureReason</code> provides details on why your transcription job
|
|
1741
|
+
* failed.</p>
|
|
1695
1742
|
*/
|
|
1696
1743
|
export interface MedicalTranscriptionJob {
|
|
1697
1744
|
/**
|
|
1698
|
-
* <p>The name of the medical transcription job. Job names are case sensitive and must be
|
|
1699
|
-
* within an Amazon Web Services account.</p>
|
|
1745
|
+
* <p>The name of the medical transcription job. Job names are case sensitive and must be
|
|
1746
|
+
* unique within an Amazon Web Services account.</p>
|
|
1700
1747
|
*/
|
|
1701
1748
|
MedicalTranscriptionJobName?: string;
|
|
1702
1749
|
/**
|
|
1703
1750
|
* <p>Provides the status of the specified medical transcription job.</p>
|
|
1704
|
-
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
1705
|
-
* at the location specified in <code>TranscriptFileUri</code>. If the status is
|
|
1706
|
-
*
|
|
1707
|
-
* job failed.</p>
|
|
1751
|
+
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
1752
|
+
* results at the location specified in <code>TranscriptFileUri</code>. If the status is
|
|
1753
|
+
* <code>FAILED</code>, <code>FailureReason</code> provides details on why your
|
|
1754
|
+
* transcription job failed.</p>
|
|
1708
1755
|
*/
|
|
1709
1756
|
TranscriptionJobStatus?: TranscriptionJobStatus | string;
|
|
1710
1757
|
/**
|
|
1711
1758
|
* <p>The language code used to create your medical transcription job. US English
|
|
1712
|
-
*
|
|
1759
|
+
* (<code>en-US</code>) is the only supported language for medical
|
|
1760
|
+
* transcriptions.</p>
|
|
1713
1761
|
*/
|
|
1714
1762
|
LanguageCode?: LanguageCode | string;
|
|
1715
1763
|
/**
|
|
1716
|
-
* <p>The sample rate, in
|
|
1764
|
+
* <p>The sample rate, in hertz, of the audio track in your input media file.</p>
|
|
1717
1765
|
*/
|
|
1718
1766
|
MediaSampleRateHertz?: number;
|
|
1719
1767
|
/**
|
|
@@ -1723,10 +1771,13 @@ export interface MedicalTranscriptionJob {
|
|
|
1723
1771
|
/**
|
|
1724
1772
|
* <p>Describes the Amazon S3 location of the media file you want to use in your
|
|
1725
1773
|
* request.</p>
|
|
1774
|
+
* <p>For information on supported media formats, refer to the <a href="https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat">MediaFormat</a> parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
|
|
1775
|
+
* in the Amazon S3 Developer Guide.</p>
|
|
1726
1776
|
*/
|
|
1727
1777
|
Media?: Media;
|
|
1728
1778
|
/**
|
|
1729
|
-
* <p>Provides you with the Amazon S3 URI you can use to access your
|
|
1779
|
+
* <p>Provides you with the Amazon S3 URI you can use to access your
|
|
1780
|
+
* transcript.</p>
|
|
1730
1781
|
*/
|
|
1731
1782
|
Transcript?: MedicalTranscript;
|
|
1732
1783
|
/**
|
|
@@ -1752,43 +1803,44 @@ export interface MedicalTranscriptionJob {
|
|
|
1752
1803
|
CompletionTime?: Date;
|
|
1753
1804
|
/**
|
|
1754
1805
|
* <p>If <code>TranscriptionJobStatus</code> is <code>FAILED</code>,
|
|
1755
|
-
*
|
|
1756
|
-
* failed.</p>
|
|
1806
|
+
* <code>FailureReason</code> contains information about why the transcription job
|
|
1807
|
+
* request failed.</p>
|
|
1757
1808
|
* <p>The <code>FailureReason</code> field contains one of the following values:</p>
|
|
1758
1809
|
* <ul>
|
|
1759
1810
|
* <li>
|
|
1760
1811
|
* <p>
|
|
1761
1812
|
* <code>Unsupported media format</code>.</p>
|
|
1762
1813
|
* <p>The media format specified in <code>MediaFormat</code> isn't valid. Refer to
|
|
1763
|
-
*
|
|
1814
|
+
* <b>MediaFormat</b> for a list of supported
|
|
1815
|
+
* formats.</p>
|
|
1764
1816
|
* </li>
|
|
1765
1817
|
* <li>
|
|
1766
1818
|
* <p>
|
|
1767
1819
|
* <code>The media format provided does not match the detected media
|
|
1768
|
-
*
|
|
1820
|
+
* format</code>.</p>
|
|
1769
1821
|
* <p>The media format specified in <code>MediaFormat</code> doesn't match the
|
|
1770
|
-
* format of the input file. Check the media format of your media file and correct
|
|
1771
|
-
* specified value.</p>
|
|
1822
|
+
* format of the input file. Check the media format of your media file and correct
|
|
1823
|
+
* the specified value.</p>
|
|
1772
1824
|
* </li>
|
|
1773
1825
|
* <li>
|
|
1774
1826
|
* <p>
|
|
1775
1827
|
* <code>Invalid sample rate for audio file</code>.</p>
|
|
1776
1828
|
* <p>The sample rate specified in <code>MediaSampleRateHertz</code> isn't valid.
|
|
1777
|
-
* The sample rate must be between 16,000 and 48,000
|
|
1829
|
+
* The sample rate must be between 16,000 and 48,000 hertz.</p>
|
|
1778
1830
|
* </li>
|
|
1779
1831
|
* <li>
|
|
1780
1832
|
* <p>
|
|
1781
1833
|
* <code>The sample rate provided does not match the detected sample
|
|
1782
1834
|
* rate</code>.</p>
|
|
1783
|
-
* <p>The sample rate specified in <code>MediaSampleRateHertz</code> doesn't
|
|
1784
|
-
*
|
|
1785
|
-
*
|
|
1835
|
+
* <p>The sample rate specified in <code>MediaSampleRateHertz</code> doesn't match
|
|
1836
|
+
* the sample rate detected in your input media file. Check the sample rate of your
|
|
1837
|
+
* media file and correct the specified value.</p>
|
|
1786
1838
|
* </li>
|
|
1787
1839
|
* <li>
|
|
1788
1840
|
* <p>
|
|
1789
1841
|
* <code>Invalid file size: file size too large</code>.</p>
|
|
1790
|
-
* <p>The size of your media file is larger than what Amazon Transcribe can
|
|
1791
|
-
* For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits">Guidelines and
|
|
1842
|
+
* <p>The size of your media file is larger than what Amazon Transcribe can
|
|
1843
|
+
* process. For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits">Guidelines and
|
|
1792
1844
|
* quotas</a>.</p>
|
|
1793
1845
|
* </li>
|
|
1794
1846
|
* <li>
|
|
@@ -1802,15 +1854,14 @@ export interface MedicalTranscriptionJob {
|
|
|
1802
1854
|
*/
|
|
1803
1855
|
FailureReason?: string;
|
|
1804
1856
|
/**
|
|
1805
|
-
* <p>
|
|
1806
|
-
*
|
|
1807
|
-
*
|
|
1857
|
+
* <p>Provides information on any additional settings that were included in your request.
|
|
1858
|
+
* Additional settings include channel identification, alternative transcriptions, speaker
|
|
1859
|
+
* partitioning, custom vocabularies, and custom vocabulary filters.</p>
|
|
1808
1860
|
*/
|
|
1809
1861
|
Settings?: MedicalTranscriptionSetting;
|
|
1810
1862
|
/**
|
|
1811
|
-
* <p>
|
|
1812
|
-
*
|
|
1813
|
-
* information (PHI) in a transcription</a>.</p>
|
|
1863
|
+
* <p>Indicates whether content identification was enabled for your transcription
|
|
1864
|
+
* request.</p>
|
|
1814
1865
|
*/
|
|
1815
1866
|
ContentIdentificationType?: MedicalContentIdentificationType | string;
|
|
1816
1867
|
/**
|
|
@@ -1818,8 +1869,8 @@ export interface MedicalTranscriptionJob {
|
|
|
1818
1869
|
*/
|
|
1819
1870
|
Specialty?: Specialty | string;
|
|
1820
1871
|
/**
|
|
1821
|
-
* <p>Indicates whether the input media is a dictation or a conversation, as specified in
|
|
1822
|
-
* <code>StartMedicalTranscriptionJob</code> request.</p>
|
|
1872
|
+
* <p>Indicates whether the input media is a dictation or a conversation, as specified in
|
|
1873
|
+
* the <code>StartMedicalTranscriptionJob</code> request.</p>
|
|
1823
1874
|
*/
|
|
1824
1875
|
Type?: Type | string;
|
|
1825
1876
|
/**
|
|
@@ -1830,15 +1881,15 @@ export interface MedicalTranscriptionJob {
|
|
|
1830
1881
|
}
|
|
1831
1882
|
export interface GetMedicalTranscriptionJobResponse {
|
|
1832
1883
|
/**
|
|
1833
|
-
* <p>Provides detailed information about the specified medical transcription job, including
|
|
1834
|
-
* status and, if applicable, failure reason.</p>
|
|
1884
|
+
* <p>Provides detailed information about the specified medical transcription job, including
|
|
1885
|
+
* job status and, if applicable, failure reason.</p>
|
|
1835
1886
|
*/
|
|
1836
1887
|
MedicalTranscriptionJob?: MedicalTranscriptionJob;
|
|
1837
1888
|
}
|
|
1838
1889
|
export interface GetMedicalVocabularyRequest {
|
|
1839
1890
|
/**
|
|
1840
|
-
* <p>The name of the custom medical vocabulary you want information about.
|
|
1841
|
-
* are case sensitive.</p>
|
|
1891
|
+
* <p>The name of the custom medical vocabulary you want information about. Custom medical
|
|
1892
|
+
* vocabulary names are case sensitive.</p>
|
|
1842
1893
|
*/
|
|
1843
1894
|
VocabularyName: string | undefined;
|
|
1844
1895
|
}
|
|
@@ -1848,32 +1899,33 @@ export interface GetMedicalVocabularyResponse {
|
|
|
1848
1899
|
*/
|
|
1849
1900
|
VocabularyName?: string;
|
|
1850
1901
|
/**
|
|
1851
|
-
* <p>The language code you selected for your medical vocabulary. US English
|
|
1852
|
-
*
|
|
1902
|
+
* <p>The language code you selected for your custom medical vocabulary. US English
|
|
1903
|
+
* (<code>en-US</code>) is the only language supported with Amazon Transcribe
|
|
1904
|
+
* Medical.</p>
|
|
1853
1905
|
*/
|
|
1854
1906
|
LanguageCode?: LanguageCode | string;
|
|
1855
1907
|
/**
|
|
1856
1908
|
* <p>The processing state of your custom medical vocabulary. If the state is
|
|
1857
|
-
*
|
|
1858
|
-
*
|
|
1909
|
+
* <code>READY</code>, you can use the custom vocabulary in a
|
|
1910
|
+
* <code>StartMedicalTranscriptionJob</code> request.</p>
|
|
1859
1911
|
*/
|
|
1860
1912
|
VocabularyState?: VocabularyState | string;
|
|
1861
1913
|
/**
|
|
1862
1914
|
* <p>The date and time the specified custom medical vocabulary was last modified.</p>
|
|
1863
1915
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1864
|
-
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7
|
|
1865
|
-
*
|
|
1916
|
+
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
1917
|
+
* 4, 2022.</p>
|
|
1866
1918
|
*/
|
|
1867
1919
|
LastModifiedTime?: Date;
|
|
1868
1920
|
/**
|
|
1869
|
-
* <p>If <code>VocabularyState</code> is <code>FAILED</code>,
|
|
1870
|
-
*
|
|
1871
|
-
*
|
|
1921
|
+
* <p>If <code>VocabularyState</code> is <code>FAILED</code>, <code>FailureReason</code>
|
|
1922
|
+
* contains information about why the custom medical vocabulary request failed. See also:
|
|
1923
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
|
|
1872
1924
|
*/
|
|
1873
1925
|
FailureReason?: string;
|
|
1874
1926
|
/**
|
|
1875
|
-
* <p>The S3 location where the specified medical vocabulary is stored; use this URI
|
|
1876
|
-
* download the vocabulary.</p>
|
|
1927
|
+
* <p>The S3 location where the specified custom medical vocabulary is stored; use this URI
|
|
1928
|
+
* to view or download the custom vocabulary.</p>
|
|
1877
1929
|
*/
|
|
1878
1930
|
DownloadUri?: string;
|
|
1879
1931
|
}
|
|
@@ -1885,45 +1937,45 @@ export interface GetTranscriptionJobRequest {
|
|
|
1885
1937
|
TranscriptionJobName: string | undefined;
|
|
1886
1938
|
}
|
|
1887
1939
|
/**
|
|
1888
|
-
* <p>
|
|
1889
|
-
* <code>JobExecutionSettings</code> modification you can choose is enabling job
|
|
1890
|
-
* the <code>AllowDeferredExecution</code> sub-parameter.</p>
|
|
1891
|
-
* <p>If you include <code>JobExecutionSettings</code> in your request, you must also
|
|
1892
|
-
* the sub-parameters: <code>AllowDeferredExecution</code> and
|
|
1893
|
-
*
|
|
1940
|
+
* <p>Makes it possible to control how your transcription job is processed. Currently, the
|
|
1941
|
+
* only <code>JobExecutionSettings</code> modification you can choose is enabling job
|
|
1942
|
+
* queueing using the <code>AllowDeferredExecution</code> sub-parameter.</p>
|
|
1943
|
+
* <p>If you include <code>JobExecutionSettings</code> in your request, you must also
|
|
1944
|
+
* include the sub-parameters: <code>AllowDeferredExecution</code> and
|
|
1945
|
+
* <code>DataAccessRoleArn</code>.</p>
|
|
1894
1946
|
*/
|
|
1895
1947
|
export interface JobExecutionSettings {
|
|
1896
1948
|
/**
|
|
1897
|
-
* <p>
|
|
1898
|
-
* <code>AllowDeferredExecution</code> is set to <code>true</code>,
|
|
1899
|
-
* placed in a queue until the number of jobs falls below
|
|
1900
|
-
* <code>AllowDeferredExecution</code> is set to
|
|
1901
|
-
*
|
|
1902
|
-
* error.</p>
|
|
1949
|
+
* <p>Makes it possible to enable job queuing when your concurrent request limit is
|
|
1950
|
+
* exceeded. When <code>AllowDeferredExecution</code> is set to <code>true</code>,
|
|
1951
|
+
* transcription job requests are placed in a queue until the number of jobs falls below
|
|
1952
|
+
* the concurrent request limit. If <code>AllowDeferredExecution</code> is set to
|
|
1953
|
+
* <code>false</code> and the number of transcription job requests exceed the
|
|
1954
|
+
* concurrent request limit, you get a <code>LimitExceededException</code> error.</p>
|
|
1903
1955
|
* <p>Note that job queuing is enabled by default for Call Analytics jobs.</p>
|
|
1904
|
-
* <p>If you include <code>AllowDeferredExecution</code> in your request, you must also
|
|
1905
|
-
* <code>DataAccessRoleArn</code>.</p>
|
|
1956
|
+
* <p>If you include <code>AllowDeferredExecution</code> in your request, you must also
|
|
1957
|
+
* include <code>DataAccessRoleArn</code>.</p>
|
|
1906
1958
|
*/
|
|
1907
1959
|
AllowDeferredExecution?: boolean;
|
|
1908
1960
|
/**
|
|
1909
1961
|
* <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
|
|
1910
|
-
* access the Amazon S3 bucket that contains your input files. If the role you
|
|
1911
|
-
* have the appropriate permissions to access the specified Amazon S3
|
|
1912
|
-
* fails.</p>
|
|
1962
|
+
* access the Amazon S3 bucket that contains your input files. If the role that you
|
|
1963
|
+
* specify doesn’t have the appropriate permissions to access the specified Amazon S3
|
|
1964
|
+
* location, your request fails.</p>
|
|
1913
1965
|
* <p>IAM role ARNs have the format
|
|
1914
|
-
*
|
|
1915
|
-
*
|
|
1916
|
-
*
|
|
1917
|
-
* <p>Note that if you include <code>DataAccessRoleArn</code> in your request, you must also
|
|
1918
|
-
* <code>AllowDeferredExecution</code>.</p>
|
|
1966
|
+
* <code>arn:partition:iam::account:role/role-name-with-path</code>. For example:
|
|
1967
|
+
* <code>arn:aws:iam::111122223333:role/Admin</code>. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
|
|
1968
|
+
* ARNs</a>.</p>
|
|
1969
|
+
* <p>Note that if you include <code>DataAccessRoleArn</code> in your request, you must also
|
|
1970
|
+
* include <code>AllowDeferredExecution</code>.</p>
|
|
1919
1971
|
*/
|
|
1920
1972
|
DataAccessRoleArn?: string;
|
|
1921
1973
|
}
|
|
1922
1974
|
/**
|
|
1923
1975
|
* <p>Provides information on the speech contained in a discreet utterance when
|
|
1924
|
-
* multi-language identification is enabled in your request. This utterance represents a
|
|
1925
|
-
* of speech consisting of one language, preceded or followed by a block of speech in
|
|
1926
|
-
* language.</p>
|
|
1976
|
+
* multi-language identification is enabled in your request. This utterance represents a
|
|
1977
|
+
* block of speech consisting of one language, preceded or followed by a block of speech in
|
|
1978
|
+
* a different language.</p>
|
|
1927
1979
|
*/
|
|
1928
1980
|
export interface LanguageCodeItem {
|
|
1929
1981
|
/**
|
|
@@ -1931,7 +1983,8 @@ export interface LanguageCodeItem {
|
|
|
1931
1983
|
*/
|
|
1932
1984
|
LanguageCode?: LanguageCode | string;
|
|
1933
1985
|
/**
|
|
1934
|
-
* <p>Provides the total time, in seconds, each identified language is spoken in your
|
|
1986
|
+
* <p>Provides the total time, in seconds, each identified language is spoken in your
|
|
1987
|
+
* media.</p>
|
|
1935
1988
|
*/
|
|
1936
1989
|
DurationInSeconds?: number;
|
|
1937
1990
|
}
|
|
@@ -1940,92 +1993,98 @@ export interface LanguageCodeItem {
|
|
|
1940
1993
|
* transcription job.</p>
|
|
1941
1994
|
* <p>Only use <code>ModelSettings</code> with the <code>LanguageModelName</code>
|
|
1942
1995
|
* sub-parameter if you're <b>not</b> using automatic language
|
|
1943
|
-
* identification (<code></code>).
|
|
1944
|
-
*
|
|
1945
|
-
*
|
|
1996
|
+
* identification (<code></code>). If using
|
|
1997
|
+
* <code>LanguageIdSettings</code> in your request, this parameter contains a
|
|
1998
|
+
* <code>LanguageModelName</code> sub-parameter.</p>
|
|
1946
1999
|
*/
|
|
1947
2000
|
export interface ModelSettings {
|
|
1948
2001
|
/**
|
|
1949
2002
|
* <p>The name of the custom language model you want to use when processing your
|
|
1950
|
-
* transcription job. Note that language model names are case sensitive.</p>
|
|
1951
|
-
* <p>The language of the specified language model must match the language code
|
|
1952
|
-
* in your transcription request. If the languages don't match, the
|
|
1953
|
-
* There are no errors or warnings associated with a language
|
|
2003
|
+
* transcription job. Note that custom language model names are case sensitive.</p>
|
|
2004
|
+
* <p>The language of the specified custom language model must match the language code that
|
|
2005
|
+
* you specify in your transcription request. If the languages don't match, the custom
|
|
2006
|
+
* language model isn't applied. There are no errors or warnings associated with a language
|
|
2007
|
+
* mismatch.</p>
|
|
1954
2008
|
*/
|
|
1955
2009
|
LanguageModelName?: string;
|
|
1956
2010
|
}
|
|
1957
2011
|
/**
|
|
1958
|
-
* <p>Allows additional optional settings in your
|
|
1959
|
-
*
|
|
1960
|
-
*
|
|
2012
|
+
* <p>Allows additional optional settings in your request, including channel identification, alternative transcriptions, and speaker
|
|
2013
|
+
* partitioning. You can use that to apply custom vocabularies to your transcription
|
|
2014
|
+
* job.</p>
|
|
1961
2015
|
*/
|
|
1962
2016
|
export interface Settings {
|
|
1963
2017
|
/**
|
|
1964
|
-
* <p>The name of the custom vocabulary you want to use in your transcription job request.
|
|
1965
|
-
* name is case sensitive, cannot contain spaces, and must be unique within an
|
|
1966
|
-
* Amazon Web Services account.</p>
|
|
2018
|
+
* <p>The name of the custom vocabulary you want to use in your transcription job request.
|
|
2019
|
+
* This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.</p>
|
|
1967
2020
|
*/
|
|
1968
2021
|
VocabularyName?: string;
|
|
1969
2022
|
/**
|
|
1970
|
-
* <p>Enables speaker
|
|
1971
|
-
* labels the speech from individual speakers in your media file.</p>
|
|
2023
|
+
* <p>Enables speaker partitioning (diarization) in your transcription output. Speaker
|
|
2024
|
+
* partitioning labels the speech from individual speakers in your media file.</p>
|
|
1972
2025
|
* <p>If you enable <code>ShowSpeakerLabels</code> in your request, you must also include
|
|
1973
|
-
*
|
|
2026
|
+
* <code>MaxSpeakerLabels</code>.</p>
|
|
1974
2027
|
* <p>You can't include both <code>ShowSpeakerLabels</code> and
|
|
1975
|
-
*
|
|
2028
|
+
* <code>ChannelIdentification</code> in the same request. Including both parameters
|
|
1976
2029
|
* returns a <code>BadRequestException</code>.</p>
|
|
1977
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">
|
|
2030
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers
|
|
2031
|
+
* (diarization)</a>.</p>
|
|
1978
2032
|
*/
|
|
1979
2033
|
ShowSpeakerLabels?: boolean;
|
|
1980
2034
|
/**
|
|
1981
|
-
* <p>Specify the maximum number of speakers you want to
|
|
1982
|
-
* <p>Note that if your media contains more speakers than the specified number, multiple
|
|
1983
|
-
*
|
|
2035
|
+
* <p>Specify the maximum number of speakers you want to partition in your media.</p>
|
|
2036
|
+
* <p>Note that if your media contains more speakers than the specified number, multiple
|
|
2037
|
+
* speakers are treated as a single speaker.</p>
|
|
1984
2038
|
* <p>If you specify the <code>MaxSpeakerLabels</code> field, you must set the
|
|
1985
|
-
*
|
|
2039
|
+
* <code>ShowSpeakerLabels</code> field to true.</p>
|
|
1986
2040
|
*/
|
|
1987
2041
|
MaxSpeakerLabels?: number;
|
|
1988
2042
|
/**
|
|
1989
2043
|
* <p>Enables channel identification in multi-channel audio.</p>
|
|
1990
|
-
* <p>Channel identification transcribes the audio on each channel independently, then
|
|
1991
|
-
* output for each channel into one transcript.</p>
|
|
2044
|
+
* <p>Channel identification transcribes the audio on each channel independently, then
|
|
2045
|
+
* appends the output for each channel into one transcript.</p>
|
|
1992
2046
|
* <p>You can't include both <code>ShowSpeakerLabels</code> and
|
|
1993
|
-
*
|
|
2047
|
+
* <code>ChannelIdentification</code> in the same request. Including both parameters
|
|
1994
2048
|
* returns a <code>BadRequestException</code>.</p>
|
|
1995
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel
|
|
2049
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel
|
|
2050
|
+
* audio</a>.</p>
|
|
1996
2051
|
*/
|
|
1997
2052
|
ChannelIdentification?: boolean;
|
|
1998
2053
|
/**
|
|
1999
2054
|
* <p>To include alternative transcriptions within your transcription output, include
|
|
2000
|
-
*
|
|
2001
|
-
* <p>If you have multi-channel audio and do not enable channel identification, your audio
|
|
2002
|
-
* transcribed in a continuous manner and your transcript does not separate the speech
|
|
2055
|
+
* <code>ShowAlternatives</code> in your transcription request.</p>
|
|
2056
|
+
* <p>If you have multi-channel audio and do not enable channel identification, your audio
|
|
2057
|
+
* is transcribed in a continuous manner and your transcript does not separate the speech
|
|
2058
|
+
* by channel.</p>
|
|
2003
2059
|
* <p>If you include <code>ShowAlternatives</code>, you must also include
|
|
2004
|
-
*
|
|
2005
|
-
* you want Amazon Transcribe to generate.</p>
|
|
2006
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative
|
|
2060
|
+
* <code>MaxAlternatives</code>, which is the maximum number of alternative
|
|
2061
|
+
* transcriptions you want Amazon Transcribe to generate.</p>
|
|
2062
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative
|
|
2063
|
+
* transcriptions</a>.</p>
|
|
2007
2064
|
*/
|
|
2008
2065
|
ShowAlternatives?: boolean;
|
|
2009
2066
|
/**
|
|
2010
2067
|
* <p>Indicate the maximum number of alternative transcriptions you want Amazon Transcribe
|
|
2011
2068
|
* to include in your transcript.</p>
|
|
2012
|
-
* <p>If you select a number greater than the number of alternative transcriptions generated
|
|
2013
|
-
* Amazon Transcribe, only the actual number of alternative transcriptions are
|
|
2069
|
+
* <p>If you select a number greater than the number of alternative transcriptions generated
|
|
2070
|
+
* by Amazon Transcribe, only the actual number of alternative transcriptions are
|
|
2071
|
+
* included.</p>
|
|
2014
2072
|
* <p>If you include <code>MaxAlternatives</code> in your request, you must also include
|
|
2015
|
-
*
|
|
2016
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative
|
|
2073
|
+
* <code>ShowAlternatives</code> with a value of <code>true</code>.</p>
|
|
2074
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative
|
|
2075
|
+
* transcriptions</a>.</p>
|
|
2017
2076
|
*/
|
|
2018
2077
|
MaxAlternatives?: number;
|
|
2019
2078
|
/**
|
|
2020
|
-
* <p>The name of the custom vocabulary filter you want to use in your transcription job
|
|
2021
|
-
* This name is case sensitive, cannot contain spaces, and must be unique within
|
|
2022
|
-
* Amazon Web Services account.</p>
|
|
2079
|
+
* <p>The name of the custom vocabulary filter you want to use in your transcription job
|
|
2080
|
+
* request. This name is case sensitive, cannot contain spaces, and must be unique within
|
|
2081
|
+
* an Amazon Web Services account.</p>
|
|
2023
2082
|
* <p>Note that if you include <code>VocabularyFilterName</code> in your request, you must
|
|
2024
2083
|
* also include <code>VocabularyFilterMethod</code>.</p>
|
|
2025
2084
|
*/
|
|
2026
2085
|
VocabularyFilterName?: string;
|
|
2027
2086
|
/**
|
|
2028
|
-
* <p>Specify how you want your vocabulary filter applied to your transcript.</p>
|
|
2087
|
+
* <p>Specify how you want your custom vocabulary filter applied to your transcript.</p>
|
|
2029
2088
|
* <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
|
|
2030
2089
|
* <p>To delete words, choose <code>remove</code>.</p>
|
|
2031
2090
|
* <p>To flag words without changing them, choose <code>tag</code>.</p>
|
|
@@ -2038,12 +2097,12 @@ export declare enum SubtitleFormat {
|
|
|
2038
2097
|
}
|
|
2039
2098
|
/**
|
|
2040
2099
|
* <p>Provides information about your subtitle file, including format, start index, and
|
|
2041
|
-
*
|
|
2100
|
+
* Amazon S3 location.</p>
|
|
2042
2101
|
*/
|
|
2043
2102
|
export interface SubtitlesOutput {
|
|
2044
2103
|
/**
|
|
2045
2104
|
* <p>Provides the format of your subtitle files. If your request included both WebVTT
|
|
2046
|
-
*
|
|
2105
|
+
* (<code>vtt</code>) and SubRip (<code>srt</code>) formats, both formats are
|
|
2047
2106
|
* shown.</p>
|
|
2048
2107
|
*/
|
|
2049
2108
|
Formats?: (SubtitleFormat | string)[];
|
|
@@ -2052,17 +2111,18 @@ export interface SubtitlesOutput {
|
|
|
2052
2111
|
* download your subtitle file. Your subtitle file is stored in the same location as your
|
|
2053
2112
|
* transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are
|
|
2054
2113
|
* provided.</p>
|
|
2055
|
-
* <p>If you included <code>OutputBucketName</code> in your transcription job request, this
|
|
2056
|
-
* the URI of that bucket. If you also included <code>OutputKey</code> in your request,
|
|
2057
|
-
* output is located in the path you specified in your request.</p>
|
|
2114
|
+
* <p>If you included <code>OutputBucketName</code> in your transcription job request, this
|
|
2115
|
+
* is the URI of that bucket. If you also included <code>OutputKey</code> in your request,
|
|
2116
|
+
* your output is located in the path you specified in your request.</p>
|
|
2058
2117
|
* <p>If you didn't include <code>OutputBucketName</code> in your transcription job request,
|
|
2059
|
-
* your subtitle file is stored in a service-managed bucket, and
|
|
2060
|
-
*
|
|
2118
|
+
* your subtitle file is stored in a service-managed bucket, and
|
|
2119
|
+
* <code>TranscriptFileUri</code> provides you with a temporary URI you can use for
|
|
2120
|
+
* secure access to your subtitle file.</p>
|
|
2061
2121
|
* <note>
|
|
2062
2122
|
* <p>Temporary URIs for service-managed Amazon S3 buckets are only valid for 15
|
|
2063
2123
|
* minutes. If you get an <code>AccesDenied</code> error, you can get a new temporary
|
|
2064
2124
|
* URI by running a <code>GetTranscriptionJob</code> or
|
|
2065
|
-
*
|
|
2125
|
+
* <code>ListTranscriptionJob</code> request.</p>
|
|
2066
2126
|
* </note>
|
|
2067
2127
|
*/
|
|
2068
2128
|
SubtitleFileUris?: string[];
|
|
@@ -2075,12 +2135,13 @@ export interface SubtitlesOutput {
|
|
|
2075
2135
|
/**
|
|
2076
2136
|
* <p>Provides detailed information about a transcription job.</p>
|
|
2077
2137
|
* <p>To view the status of the specified transcription job, check the
|
|
2078
|
-
*
|
|
2079
|
-
* job is finished and you can find the results at the location specified in
|
|
2080
|
-
*
|
|
2081
|
-
*
|
|
2082
|
-
*
|
|
2083
|
-
*
|
|
2138
|
+
* <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>,
|
|
2139
|
+
* the job is finished and you can find the results at the location specified in
|
|
2140
|
+
* <code>TranscriptFileUri</code>. If the status is <code>FAILED</code>,
|
|
2141
|
+
* <code>FailureReason</code> provides details on why your transcription job
|
|
2142
|
+
* failed.</p>
|
|
2143
|
+
* <p>If you enabled content redaction, the redacted transcript can be found at the location
|
|
2144
|
+
* specified in <code>RedactedTranscriptFileUri</code>.</p>
|
|
2084
2145
|
*/
|
|
2085
2146
|
export interface TranscriptionJob {
|
|
2086
2147
|
/**
|
|
@@ -2090,25 +2151,21 @@ export interface TranscriptionJob {
|
|
|
2090
2151
|
TranscriptionJobName?: string;
|
|
2091
2152
|
/**
|
|
2092
2153
|
* <p>Provides the status of the specified transcription job.</p>
|
|
2093
|
-
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
2094
|
-
* at the location specified in <code>TranscriptFileUri</code> (or
|
|
2095
|
-
*
|
|
2096
|
-
* <code>FAILED</code>, <code>FailureReason</code> provides details on why
|
|
2097
|
-
* job failed.</p>
|
|
2154
|
+
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
2155
|
+
* results at the location specified in <code>TranscriptFileUri</code> (or
|
|
2156
|
+
* <code>RedactedTranscriptFileUri</code>, if you requested transcript redaction). If
|
|
2157
|
+
* the status is <code>FAILED</code>, <code>FailureReason</code> provides details on why
|
|
2158
|
+
* your transcription job failed.</p>
|
|
2098
2159
|
*/
|
|
2099
2160
|
TranscriptionJobStatus?: TranscriptionJobStatus | string;
|
|
2100
2161
|
/**
|
|
2101
|
-
* <p>The language code used to create your transcription job.
|
|
2102
|
-
*
|
|
2103
|
-
*
|
|
2104
|
-
* <p>Note that you must include one of <code>LanguageCode</code>,
|
|
2105
|
-
* <code>IdentifyLanguage</code>, or <code>IdentifyMultipleLanguages</code> in your
|
|
2106
|
-
* request. If you include more than one of these parameters, your transcription job
|
|
2107
|
-
* fails.</p>
|
|
2162
|
+
* <p>The language code used to create your transcription job. This parameter is used with
|
|
2163
|
+
* single-language identification. For multi-language identification requests, refer to the
|
|
2164
|
+
* plural version of this parameter, <code>LanguageCodes</code>.</p>
|
|
2108
2165
|
*/
|
|
2109
2166
|
LanguageCode?: LanguageCode | string;
|
|
2110
2167
|
/**
|
|
2111
|
-
* <p>The sample rate, in
|
|
2168
|
+
* <p>The sample rate, in hertz, of the audio track in your input media file.</p>
|
|
2112
2169
|
*/
|
|
2113
2170
|
MediaSampleRateHertz?: number;
|
|
2114
2171
|
/**
|
|
@@ -2116,12 +2173,13 @@ export interface TranscriptionJob {
|
|
|
2116
2173
|
*/
|
|
2117
2174
|
MediaFormat?: MediaFormat | string;
|
|
2118
2175
|
/**
|
|
2119
|
-
* <p>
|
|
2176
|
+
* <p>Provides the Amazon S3 location of the media file you used in your
|
|
2120
2177
|
* request.</p>
|
|
2121
2178
|
*/
|
|
2122
2179
|
Media?: Media;
|
|
2123
2180
|
/**
|
|
2124
|
-
* <p>Provides you with the Amazon S3 URI you can use to access your
|
|
2181
|
+
* <p>Provides you with the Amazon S3 URI you can use to access your
|
|
2182
|
+
* transcript.</p>
|
|
2125
2183
|
*/
|
|
2126
2184
|
Transcript?: Transcript;
|
|
2127
2185
|
/**
|
|
@@ -2147,43 +2205,44 @@ export interface TranscriptionJob {
|
|
|
2147
2205
|
CompletionTime?: Date;
|
|
2148
2206
|
/**
|
|
2149
2207
|
* <p>If <code>TranscriptionJobStatus</code> is <code>FAILED</code>,
|
|
2150
|
-
*
|
|
2151
|
-
* failed.</p>
|
|
2208
|
+
* <code>FailureReason</code> contains information about why the transcription job
|
|
2209
|
+
* request failed.</p>
|
|
2152
2210
|
* <p>The <code>FailureReason</code> field contains one of the following values:</p>
|
|
2153
2211
|
* <ul>
|
|
2154
2212
|
* <li>
|
|
2155
2213
|
* <p>
|
|
2156
2214
|
* <code>Unsupported media format</code>.</p>
|
|
2157
2215
|
* <p>The media format specified in <code>MediaFormat</code> isn't valid. Refer to
|
|
2158
|
-
*
|
|
2216
|
+
* <b>MediaFormat</b> for a list of supported
|
|
2217
|
+
* formats.</p>
|
|
2159
2218
|
* </li>
|
|
2160
2219
|
* <li>
|
|
2161
2220
|
* <p>
|
|
2162
2221
|
* <code>The media format provided does not match the detected media
|
|
2163
|
-
*
|
|
2222
|
+
* format</code>.</p>
|
|
2164
2223
|
* <p>The media format specified in <code>MediaFormat</code> doesn't match the
|
|
2165
|
-
* format of the input file. Check the media format of your media file and correct
|
|
2166
|
-
* specified value.</p>
|
|
2224
|
+
* format of the input file. Check the media format of your media file and correct
|
|
2225
|
+
* the specified value.</p>
|
|
2167
2226
|
* </li>
|
|
2168
2227
|
* <li>
|
|
2169
2228
|
* <p>
|
|
2170
2229
|
* <code>Invalid sample rate for audio file</code>.</p>
|
|
2171
2230
|
* <p>The sample rate specified in <code>MediaSampleRateHertz</code> isn't valid.
|
|
2172
|
-
* The sample rate must be between 8,000 and 48,000
|
|
2231
|
+
* The sample rate must be between 8,000 and 48,000 hertz.</p>
|
|
2173
2232
|
* </li>
|
|
2174
2233
|
* <li>
|
|
2175
2234
|
* <p>
|
|
2176
2235
|
* <code>The sample rate provided does not match the detected sample
|
|
2177
2236
|
* rate</code>.</p>
|
|
2178
|
-
* <p>The sample rate specified in <code>MediaSampleRateHertz</code> doesn't
|
|
2179
|
-
*
|
|
2180
|
-
*
|
|
2237
|
+
* <p>The sample rate specified in <code>MediaSampleRateHertz</code> doesn't match
|
|
2238
|
+
* the sample rate detected in your input media file. Check the sample rate of your
|
|
2239
|
+
* media file and correct the specified value.</p>
|
|
2181
2240
|
* </li>
|
|
2182
2241
|
* <li>
|
|
2183
2242
|
* <p>
|
|
2184
2243
|
* <code>Invalid file size: file size too large</code>.</p>
|
|
2185
|
-
* <p>The size of your media file is larger than what Amazon Transcribe can
|
|
2186
|
-
* For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits">Guidelines and
|
|
2244
|
+
* <p>The size of your media file is larger than what Amazon Transcribe can
|
|
2245
|
+
* process. For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits">Guidelines and
|
|
2187
2246
|
* quotas</a>.</p>
|
|
2188
2247
|
* </li>
|
|
2189
2248
|
* <li>
|
|
@@ -2197,34 +2256,22 @@ export interface TranscriptionJob {
|
|
|
2197
2256
|
*/
|
|
2198
2257
|
FailureReason?: string;
|
|
2199
2258
|
/**
|
|
2200
|
-
* <p>
|
|
2201
|
-
*
|
|
2202
|
-
*
|
|
2203
|
-
* <p>If you want to include a custom vocabulary or a custom vocabulary filter (or both) with
|
|
2204
|
-
* your request but <b>do not</b> want to use automatic
|
|
2205
|
-
* language identification, use <code>Settings</code> with the <code>VocabularyName</code>
|
|
2206
|
-
* or <code>VocabularyFilterName</code> (or both) sub-parameter.</p>
|
|
2207
|
-
* <p>If you're using automatic language identification with your request and want to include a
|
|
2208
|
-
* custom language model, a custom vocabulary, or a custom vocabulary filter, do not use the
|
|
2209
|
-
* <code>Settings</code> parameter; use instead the
|
|
2210
|
-
* <code></code>
|
|
2211
|
-
* parameter with the <code>LanguageModelName</code>, <code>VocabularyName</code>
|
|
2212
|
-
* or <code>VocabularyFilterName</code> sub-parameters.</p>
|
|
2259
|
+
* <p>Provides information on any additional settings that were included in your request.
|
|
2260
|
+
* Additional settings include channel identification, alternative transcriptions, speaker
|
|
2261
|
+
* partitioning, custom vocabularies, and custom vocabulary filters.</p>
|
|
2213
2262
|
*/
|
|
2214
2263
|
Settings?: Settings;
|
|
2215
2264
|
/**
|
|
2216
|
-
* <p>
|
|
2217
|
-
* <code>ModelSettings</code> in your request, you must include the
|
|
2218
|
-
* <code>LanguageModelName</code> sub-parameter.</p>
|
|
2265
|
+
* <p>Provides information on the custom language model you included in your request.</p>
|
|
2219
2266
|
*/
|
|
2220
2267
|
ModelSettings?: ModelSettings;
|
|
2221
2268
|
/**
|
|
2222
|
-
* <p>Provides information about how your transcription job
|
|
2223
|
-
* if your request
|
|
2269
|
+
* <p>Provides information about how your transcription job was processed. This parameter
|
|
2270
|
+
* shows if your request was queued and what data access role was used.</p>
|
|
2224
2271
|
*/
|
|
2225
2272
|
JobExecutionSettings?: JobExecutionSettings;
|
|
2226
2273
|
/**
|
|
2227
|
-
* <p>
|
|
2274
|
+
* <p>Indicates whether redaction was enabled in your transcript.</p>
|
|
2228
2275
|
*/
|
|
2229
2276
|
ContentRedaction?: ContentRedaction;
|
|
2230
2277
|
/**
|
|
@@ -2234,22 +2281,16 @@ export interface TranscriptionJob {
|
|
|
2234
2281
|
IdentifyLanguage?: boolean;
|
|
2235
2282
|
/**
|
|
2236
2283
|
* <p>Indicates whether automatic multi-language identification was enabled
|
|
2237
|
-
*
|
|
2284
|
+
* (<code>TRUE</code>) for the specified transcription job.</p>
|
|
2238
2285
|
*/
|
|
2239
2286
|
IdentifyMultipleLanguages?: boolean;
|
|
2240
2287
|
/**
|
|
2241
|
-
* <p>
|
|
2242
|
-
* be present in your media; including more than five is not recommended. If you're unsure what
|
|
2243
|
-
* languages are present, do not include this parameter.</p>
|
|
2244
|
-
* <p>If you include <code>LanguageOptions</code> in your request, you must also include
|
|
2245
|
-
* <code>IdentifyLanguage</code>.</p>
|
|
2246
|
-
* <p>For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a>.</p>
|
|
2247
|
-
* <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media file
|
|
2248
|
-
* must be encoded at a sample rate of 16,000 Hz or higher.</p>
|
|
2288
|
+
* <p>Provides the language codes you specified in your request.</p>
|
|
2249
2289
|
*/
|
|
2250
2290
|
LanguageOptions?: (LanguageCode | string)[];
|
|
2251
2291
|
/**
|
|
2252
|
-
* <p>The confidence score associated with the language identified in your media
|
|
2292
|
+
* <p>The confidence score associated with the language identified in your media
|
|
2293
|
+
* file.</p>
|
|
2253
2294
|
* <p>Confidence scores are values between 0 and 1; a larger value indicates a higher
|
|
2254
2295
|
* probability that the identified language correctly matches the language spoken in your
|
|
2255
2296
|
* media.</p>
|
|
@@ -2257,62 +2298,36 @@ export interface TranscriptionJob {
|
|
|
2257
2298
|
IdentifiedLanguageScore?: number;
|
|
2258
2299
|
/**
|
|
2259
2300
|
* <p>The language codes used to create your transcription job. This parameter is used with
|
|
2260
|
-
* multi-language identification. For single-language identification requests, refer to the
|
|
2261
|
-
* version of this parameter, <code>LanguageCode</code>.</p>
|
|
2262
|
-
* <p>For a list of supported languages and their associated language codes, refer to the
|
|
2263
|
-
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a>
|
|
2264
|
-
* table.</p>
|
|
2301
|
+
* multi-language identification. For single-language identification requests, refer to the
|
|
2302
|
+
* singular version of this parameter, <code>LanguageCode</code>.</p>
|
|
2265
2303
|
*/
|
|
2266
2304
|
LanguageCodes?: LanguageCodeItem[];
|
|
2267
2305
|
/**
|
|
2268
|
-
* <p>
|
|
2269
|
-
*
|
|
2270
|
-
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging resources</a>.</p>
|
|
2306
|
+
* <p>The tags, each in the form of a key:value pair, assigned to the specified
|
|
2307
|
+
* transcription job.</p>
|
|
2271
2308
|
*/
|
|
2272
2309
|
Tags?: Tag[];
|
|
2273
2310
|
/**
|
|
2274
|
-
* <p>
|
|
2311
|
+
* <p>Indicates whether subtitles were generated with your transcription.</p>
|
|
2275
2312
|
*/
|
|
2276
2313
|
Subtitles?: SubtitlesOutput;
|
|
2277
2314
|
/**
|
|
2278
|
-
* <p>
|
|
2279
|
-
*
|
|
2280
|
-
* filter, include <code>LanguageIdSettings</code> with the relevant sub-parameters
|
|
2281
|
-
* (<code>VocabularyName</code>, <code>LanguageModelName</code>, and
|
|
2282
|
-
* <code>VocabularyFilterName</code>).</p>
|
|
2283
|
-
* <p>You can specify two or more language codes that represent the languages you think may be
|
|
2284
|
-
* present in your media; including more than five is not recommended. Each language code you
|
|
2285
|
-
* include can have an associated custom language model, custom vocabulary, and custom
|
|
2286
|
-
* vocabulary filter. The languages you specify must match the languages of the specified custom
|
|
2287
|
-
* language models, custom vocabularies, and custom vocabulary filters.</p>
|
|
2288
|
-
* <p>To include language options using <code>IdentifyLanguage</code>
|
|
2289
|
-
* <b>without</b> including a custom language model, a custom
|
|
2290
|
-
* vocabulary, or a custom vocabulary filter, use <code>LanguageOptions</code> instead of
|
|
2291
|
-
* <code>LanguageIdSettings</code>. Including language options can improve the accuracy of
|
|
2292
|
-
* automatic language identification.</p>
|
|
2293
|
-
* <p>If you want to include a custom language model with your request but
|
|
2294
|
-
* <b>do not</b> want to use automatic language identification,
|
|
2295
|
-
* use instead the <code></code> parameter with the
|
|
2296
|
-
* <code>LanguageModelName</code> sub-parameter.</p>
|
|
2297
|
-
* <p>If you want to include a custom vocabulary or a custom vocabulary filter (or both) with
|
|
2298
|
-
* your request but <b>do not</b> want to use automatic
|
|
2299
|
-
* language identification, use instead the <code></code>
|
|
2300
|
-
* parameter with the <code>VocabularyName</code> or
|
|
2301
|
-
* <code>VocabularyFilterName</code> (or both) sub-parameter.</p>
|
|
2315
|
+
* <p>Provides the name and language of all custom language models, custom vocabularies, and
|
|
2316
|
+
* custom vocabulary filters that you included in your request.</p>
|
|
2302
2317
|
*/
|
|
2303
2318
|
LanguageIdSettings?: Record<string, LanguageIdSettings>;
|
|
2304
2319
|
}
|
|
2305
2320
|
export interface GetTranscriptionJobResponse {
|
|
2306
2321
|
/**
|
|
2307
|
-
* <p>Provides detailed information about the specified transcription job, including job
|
|
2308
|
-
* and, if applicable, failure reason.</p>
|
|
2322
|
+
* <p>Provides detailed information about the specified transcription job, including job
|
|
2323
|
+
* status and, if applicable, failure reason.</p>
|
|
2309
2324
|
*/
|
|
2310
2325
|
TranscriptionJob?: TranscriptionJob;
|
|
2311
2326
|
}
|
|
2312
2327
|
export interface GetVocabularyRequest {
|
|
2313
2328
|
/**
|
|
2314
|
-
* <p>The name of the custom vocabulary you want information about.
|
|
2315
|
-
* case sensitive.</p>
|
|
2329
|
+
* <p>The name of the custom vocabulary you want information about. Custom vocabulary names
|
|
2330
|
+
* are case sensitive.</p>
|
|
2316
2331
|
*/
|
|
2317
2332
|
VocabularyName: string | undefined;
|
|
2318
2333
|
}
|
|
@@ -2326,33 +2341,34 @@ export interface GetVocabularyResponse {
|
|
|
2326
2341
|
*/
|
|
2327
2342
|
LanguageCode?: LanguageCode | string;
|
|
2328
2343
|
/**
|
|
2329
|
-
* <p>The processing state of your custom vocabulary. If the state is <code>READY</code>,
|
|
2330
|
-
* can use the vocabulary in a <code>StartTranscriptionJob</code>
|
|
2344
|
+
* <p>The processing state of your custom vocabulary. If the state is <code>READY</code>,
|
|
2345
|
+
* you can use the custom vocabulary in a <code>StartTranscriptionJob</code>
|
|
2346
|
+
* request.</p>
|
|
2331
2347
|
*/
|
|
2332
2348
|
VocabularyState?: VocabularyState | string;
|
|
2333
2349
|
/**
|
|
2334
|
-
* <p>The date and time the specified vocabulary was last modified.</p>
|
|
2350
|
+
* <p>The date and time the specified custom vocabulary was last modified.</p>
|
|
2335
2351
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2336
|
-
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7
|
|
2337
|
-
*
|
|
2352
|
+
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
2353
|
+
* 4, 2022.</p>
|
|
2338
2354
|
*/
|
|
2339
2355
|
LastModifiedTime?: Date;
|
|
2340
2356
|
/**
|
|
2341
|
-
* <p>If <code>VocabularyState</code> is <code>FAILED</code>,
|
|
2342
|
-
*
|
|
2343
|
-
*
|
|
2357
|
+
* <p>If <code>VocabularyState</code> is <code>FAILED</code>, <code>FailureReason</code>
|
|
2358
|
+
* contains information about why the custom vocabulary request failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common
|
|
2359
|
+
* Errors</a>.</p>
|
|
2344
2360
|
*/
|
|
2345
2361
|
FailureReason?: string;
|
|
2346
2362
|
/**
|
|
2347
|
-
* <p>The S3 location where the vocabulary is stored; use this URI to view or
|
|
2348
|
-
* vocabulary.</p>
|
|
2363
|
+
* <p>The S3 location where the custom vocabulary is stored; use this URI to view or
|
|
2364
|
+
* download the custom vocabulary.</p>
|
|
2349
2365
|
*/
|
|
2350
2366
|
DownloadUri?: string;
|
|
2351
2367
|
}
|
|
2352
2368
|
export interface GetVocabularyFilterRequest {
|
|
2353
2369
|
/**
|
|
2354
|
-
* <p>The name of the custom vocabulary filter you want information about.
|
|
2355
|
-
* names are case sensitive.</p>
|
|
2370
|
+
* <p>The name of the custom vocabulary filter you want information about. Custom vocabulary
|
|
2371
|
+
* filter names are case sensitive.</p>
|
|
2356
2372
|
*/
|
|
2357
2373
|
VocabularyFilterName: string | undefined;
|
|
2358
2374
|
}
|
|
@@ -2362,77 +2378,77 @@ export interface GetVocabularyFilterResponse {
|
|
|
2362
2378
|
*/
|
|
2363
2379
|
VocabularyFilterName?: string;
|
|
2364
2380
|
/**
|
|
2365
|
-
* <p>The language code you selected for your vocabulary filter.</p>
|
|
2381
|
+
* <p>The language code you selected for your custom vocabulary filter.</p>
|
|
2366
2382
|
*/
|
|
2367
2383
|
LanguageCode?: LanguageCode | string;
|
|
2368
2384
|
/**
|
|
2369
|
-
* <p>The date and time the specified vocabulary filter was last modified.</p>
|
|
2385
|
+
* <p>The date and time the specified custom vocabulary filter was last modified.</p>
|
|
2370
2386
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2371
|
-
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7
|
|
2372
|
-
*
|
|
2387
|
+
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
2388
|
+
* 4, 2022.</p>
|
|
2373
2389
|
*/
|
|
2374
2390
|
LastModifiedTime?: Date;
|
|
2375
2391
|
/**
|
|
2376
|
-
* <p>The Amazon S3 location where the vocabulary filter is stored; use this
|
|
2377
|
-
* download the vocabulary filter.</p>
|
|
2392
|
+
* <p>The Amazon S3 location where the custom vocabulary filter is stored; use this
|
|
2393
|
+
* URI to view or download the custom vocabulary filter.</p>
|
|
2378
2394
|
*/
|
|
2379
2395
|
DownloadUri?: string;
|
|
2380
2396
|
}
|
|
2381
2397
|
export interface ListCallAnalyticsCategoriesRequest {
|
|
2382
2398
|
/**
|
|
2383
2399
|
* <p>If your <code>ListCallAnalyticsCategories</code> request returns more results than can
|
|
2384
|
-
* be displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
2385
|
-
* To get the next page of results, copy this string and repeat your request,
|
|
2386
|
-
* <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2387
|
-
* results.</p>
|
|
2400
|
+
* be displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
2401
|
+
* string. To get the next page of results, copy this string and repeat your request,
|
|
2402
|
+
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2403
|
+
* to view all your results.</p>
|
|
2388
2404
|
*/
|
|
2389
2405
|
NextToken?: string;
|
|
2390
2406
|
/**
|
|
2391
|
-
* <p>The maximum number of Call Analytics categories to return in each page of results. If
|
|
2392
|
-
* are fewer results than the value you specify, only the actual results are
|
|
2393
|
-
* specify a value, a default of 5 is used.</p>
|
|
2407
|
+
* <p>The maximum number of Call Analytics categories to return in each page of results. If
|
|
2408
|
+
* there are fewer results than the value that you specify, only the actual results are
|
|
2409
|
+
* returned. If you don't specify a value, a default of 5 is used.</p>
|
|
2394
2410
|
*/
|
|
2395
2411
|
MaxResults?: number;
|
|
2396
2412
|
}
|
|
2397
2413
|
export interface ListCallAnalyticsCategoriesResponse {
|
|
2398
2414
|
/**
|
|
2399
|
-
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
2400
|
-
* are displayed. To view the next set of results, copy the string associated with
|
|
2401
|
-
* <code>NextToken</code> parameter in your results output, then run your request again
|
|
2402
|
-
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2403
|
-
* view all your results.</p>
|
|
2415
|
+
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
2416
|
+
* results are displayed. To view the next set of results, copy the string associated with
|
|
2417
|
+
* the <code>NextToken</code> parameter in your results output, then run your request again
|
|
2418
|
+
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2419
|
+
* to view all your results.</p>
|
|
2404
2420
|
*/
|
|
2405
2421
|
NextToken?: string;
|
|
2406
2422
|
/**
|
|
2407
|
-
* <p>Provides detailed information about your Call Analytics categories, including all the
|
|
2408
|
-
* associated with each category.</p>
|
|
2423
|
+
* <p>Provides detailed information about your Call Analytics categories, including all the
|
|
2424
|
+
* rules associated with each category.</p>
|
|
2409
2425
|
*/
|
|
2410
2426
|
Categories?: CategoryProperties[];
|
|
2411
2427
|
}
|
|
2412
2428
|
export interface ListCallAnalyticsJobsRequest {
|
|
2413
2429
|
/**
|
|
2414
|
-
* <p>Returns only Call Analytics jobs with the specified status. Jobs are ordered by
|
|
2415
|
-
* date, with the newest job first. If you don't include <code>Status</code>, all
|
|
2416
|
-
* jobs are returned.</p>
|
|
2430
|
+
* <p>Returns only Call Analytics jobs with the specified status. Jobs are ordered by
|
|
2431
|
+
* creation date, with the newest job first. If you don't include <code>Status</code>, all
|
|
2432
|
+
* Call Analytics jobs are returned.</p>
|
|
2417
2433
|
*/
|
|
2418
2434
|
Status?: CallAnalyticsJobStatus | string;
|
|
2419
2435
|
/**
|
|
2420
|
-
* <p>Returns only the Call Analytics jobs that contain the specified string. The search is
|
|
2421
|
-
* case sensitive.</p>
|
|
2436
|
+
* <p>Returns only the Call Analytics jobs that contain the specified string. The search is
|
|
2437
|
+
* not case sensitive.</p>
|
|
2422
2438
|
*/
|
|
2423
2439
|
JobNameContains?: string;
|
|
2424
2440
|
/**
|
|
2425
2441
|
* <p>If your <code>ListCallAnalyticsJobs</code> request returns more results than can be
|
|
2426
|
-
* displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
2427
|
-
* get the next page of results, copy this string and repeat your request,
|
|
2428
|
-
* <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2429
|
-
* results.</p>
|
|
2442
|
+
* displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
2443
|
+
* string. To get the next page of results, copy this string and repeat your request,
|
|
2444
|
+
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2445
|
+
* to view all your results.</p>
|
|
2430
2446
|
*/
|
|
2431
2447
|
NextToken?: string;
|
|
2432
2448
|
/**
|
|
2433
|
-
* <p>The maximum number of Call Analytics jobs to return in each page of results. If there
|
|
2434
|
-
* fewer results than the value you specify, only the actual results are returned.
|
|
2435
|
-
* specify a value, a default of 5 is used.</p>
|
|
2449
|
+
* <p>The maximum number of Call Analytics jobs to return in each page of results. If there
|
|
2450
|
+
* are fewer results than the value that you specify, only the actual results are returned.
|
|
2451
|
+
* If you don't specify a value, a default of 5 is used.</p>
|
|
2436
2452
|
*/
|
|
2437
2453
|
MaxResults?: number;
|
|
2438
2454
|
}
|
|
@@ -2443,11 +2459,11 @@ export interface ListCallAnalyticsJobsResponse {
|
|
|
2443
2459
|
*/
|
|
2444
2460
|
Status?: CallAnalyticsJobStatus | string;
|
|
2445
2461
|
/**
|
|
2446
|
-
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
2447
|
-
* are displayed. To view the next set of results, copy the string associated with
|
|
2448
|
-
* <code>NextToken</code> parameter in your results output, then run your request again
|
|
2449
|
-
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2450
|
-
* view all your results.</p>
|
|
2462
|
+
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
2463
|
+
* results are displayed. To view the next set of results, copy the string associated with
|
|
2464
|
+
* the <code>NextToken</code> parameter in your results output, then run your request again
|
|
2465
|
+
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2466
|
+
* to view all your results.</p>
|
|
2451
2467
|
*/
|
|
2452
2468
|
NextToken?: string;
|
|
2453
2469
|
/**
|
|
@@ -2457,9 +2473,9 @@ export interface ListCallAnalyticsJobsResponse {
|
|
|
2457
2473
|
}
|
|
2458
2474
|
export interface ListLanguageModelsRequest {
|
|
2459
2475
|
/**
|
|
2460
|
-
* <p>Returns only custom language models with the specified status. Language
|
|
2461
|
-
*
|
|
2462
|
-
*
|
|
2476
|
+
* <p>Returns only custom language models with the specified status. Language models are
|
|
2477
|
+
* ordered by creation date, with the newest model first. If you don't include
|
|
2478
|
+
* <code>StatusEquals</code>, all custom language models are returned.</p>
|
|
2463
2479
|
*/
|
|
2464
2480
|
StatusEquals?: ModelStatus | string;
|
|
2465
2481
|
/**
|
|
@@ -2469,31 +2485,31 @@ export interface ListLanguageModelsRequest {
|
|
|
2469
2485
|
NameContains?: string;
|
|
2470
2486
|
/**
|
|
2471
2487
|
* <p>If your <code>ListLanguageModels</code> request returns more results than can be
|
|
2472
|
-
* displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
2473
|
-
* get the next page of results, copy this string and repeat your request,
|
|
2474
|
-
* <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2475
|
-
* results.</p>
|
|
2488
|
+
* displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
2489
|
+
* string. To get the next page of results, copy this string and repeat your request,
|
|
2490
|
+
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2491
|
+
* to view all your results.</p>
|
|
2476
2492
|
*/
|
|
2477
2493
|
NextToken?: string;
|
|
2478
2494
|
/**
|
|
2479
|
-
* <p>The maximum number of custom language models to return in each page of results. If
|
|
2480
|
-
* are fewer results than the value you specify, only the actual results are
|
|
2481
|
-
* specify a value, a default of 5 is used.</p>
|
|
2495
|
+
* <p>The maximum number of custom language models to return in each page of results. If
|
|
2496
|
+
* there are fewer results than the value that you specify, only the actual results are
|
|
2497
|
+
* returned. If you don't specify a value, a default of 5 is used.</p>
|
|
2482
2498
|
*/
|
|
2483
2499
|
MaxResults?: number;
|
|
2484
2500
|
}
|
|
2485
2501
|
export interface ListLanguageModelsResponse {
|
|
2486
2502
|
/**
|
|
2487
|
-
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
2488
|
-
* are displayed. To view the next set of results, copy the string associated with
|
|
2489
|
-
* <code>NextToken</code> parameter in your results output, then run your request again
|
|
2490
|
-
* including <code>NextToken</code> with the value of the copied string.
|
|
2491
|
-
* view all your results.</p>
|
|
2503
|
+
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
2504
|
+
* results are displayed. To view the next set of results, copy the string associated with
|
|
2505
|
+
* the <code>NextToken</code> parameter in your results output, then run your request again
|
|
2506
|
+
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2507
|
+
* to view all your results.</p>
|
|
2492
2508
|
*/
|
|
2493
2509
|
NextToken?: string;
|
|
2494
2510
|
/**
|
|
2495
|
-
* <p>Provides information about the custom language models that match the criteria
|
|
2496
|
-
* in your request.</p>
|
|
2511
|
+
* <p>Provides information about the custom language models that match the criteria
|
|
2512
|
+
* specified in your request.</p>
|
|
2497
2513
|
*/
|
|
2498
2514
|
Models?: LanguageModel[];
|
|
2499
2515
|
}
|
|
@@ -2505,22 +2521,22 @@ export interface ListMedicalTranscriptionJobsRequest {
|
|
|
2505
2521
|
*/
|
|
2506
2522
|
Status?: TranscriptionJobStatus | string;
|
|
2507
2523
|
/**
|
|
2508
|
-
* <p>Returns only the medical transcription jobs that contain the specified string. The
|
|
2509
|
-
* is not case sensitive.</p>
|
|
2524
|
+
* <p>Returns only the medical transcription jobs that contain the specified string. The
|
|
2525
|
+
* search is not case sensitive.</p>
|
|
2510
2526
|
*/
|
|
2511
2527
|
JobNameContains?: string;
|
|
2512
2528
|
/**
|
|
2513
|
-
* <p>If your <code>ListMedicalTranscriptionJobs</code> request returns more results than
|
|
2514
|
-
* be displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
2515
|
-
* To get the next page of results, copy this string and repeat your request,
|
|
2516
|
-
* <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2517
|
-
* results.</p>
|
|
2529
|
+
* <p>If your <code>ListMedicalTranscriptionJobs</code> request returns more results than
|
|
2530
|
+
* can be displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
2531
|
+
* string. To get the next page of results, copy this string and repeat your request,
|
|
2532
|
+
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2533
|
+
* to view all your results.</p>
|
|
2518
2534
|
*/
|
|
2519
2535
|
NextToken?: string;
|
|
2520
2536
|
/**
|
|
2521
|
-
* <p>The maximum number of medical transcription jobs to return in each page of results. If
|
|
2522
|
-
* are fewer results than the value you specify, only the actual results are
|
|
2523
|
-
* specify a value, a default of 5 is used.</p>
|
|
2537
|
+
* <p>The maximum number of medical transcription jobs to return in each page of results. If
|
|
2538
|
+
* there are fewer results than the value that you specify, only the actual results are
|
|
2539
|
+
* returned. If you don't specify a value, a default of 5 is used.</p>
|
|
2524
2540
|
*/
|
|
2525
2541
|
MaxResults?: number;
|
|
2526
2542
|
}
|
|
@@ -2533,8 +2549,8 @@ export declare enum OutputLocationType {
|
|
|
2533
2549
|
*/
|
|
2534
2550
|
export interface MedicalTranscriptionJobSummary {
|
|
2535
2551
|
/**
|
|
2536
|
-
* <p>The name of the medical transcription job. Job names are case sensitive and must be
|
|
2537
|
-
* within an Amazon Web Services account.</p>
|
|
2552
|
+
* <p>The name of the medical transcription job. Job names are case sensitive and must be
|
|
2553
|
+
* unique within an Amazon Web Services account.</p>
|
|
2538
2554
|
*/
|
|
2539
2555
|
MedicalTranscriptionJobName?: string;
|
|
2540
2556
|
/**
|
|
@@ -2560,33 +2576,32 @@ export interface MedicalTranscriptionJobSummary {
|
|
|
2560
2576
|
CompletionTime?: Date;
|
|
2561
2577
|
/**
|
|
2562
2578
|
* <p>The language code used to create your medical transcription. US English
|
|
2563
|
-
*
|
|
2579
|
+
* (<code>en-US</code>) is the only supported language for medical
|
|
2580
|
+
* transcriptions.</p>
|
|
2564
2581
|
*/
|
|
2565
2582
|
LanguageCode?: LanguageCode | string;
|
|
2566
2583
|
/**
|
|
2567
2584
|
* <p>Provides the status of your medical transcription job.</p>
|
|
2568
|
-
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
2569
|
-
* at the location specified in <code>TranscriptFileUri</code>. If the status is
|
|
2570
|
-
*
|
|
2571
|
-
* job failed.</p>
|
|
2585
|
+
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
2586
|
+
* results at the location specified in <code>TranscriptFileUri</code>. If the status is
|
|
2587
|
+
* <code>FAILED</code>, <code>FailureReason</code> provides details on why your
|
|
2588
|
+
* transcription job failed.</p>
|
|
2572
2589
|
*/
|
|
2573
2590
|
TranscriptionJobStatus?: TranscriptionJobStatus | string;
|
|
2574
2591
|
/**
|
|
2575
2592
|
* <p>If <code>TranscriptionJobStatus</code> is <code>FAILED</code>,
|
|
2576
|
-
*
|
|
2593
|
+
* <code>FailureReason</code> contains information about why the transcription job
|
|
2577
2594
|
* failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
|
|
2578
2595
|
*/
|
|
2579
2596
|
FailureReason?: string;
|
|
2580
2597
|
/**
|
|
2581
2598
|
* <p>Indicates where the specified medical transcription output is stored.</p>
|
|
2582
2599
|
* <p>If the value is <code>CUSTOMER_BUCKET</code>, the location is the Amazon S3
|
|
2583
|
-
* bucket you specified using the <code>OutputBucketName</code> parameter in your
|
|
2584
|
-
*
|
|
2585
|
-
*
|
|
2586
|
-
*
|
|
2587
|
-
*
|
|
2588
|
-
* Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use
|
|
2589
|
-
* the URI shown in the <code>TranscriptFileUri</code> field.</p>
|
|
2600
|
+
* bucket you specified using the <code>OutputBucketName</code> parameter in your request. If you also included
|
|
2601
|
+
* <code>OutputKey</code> in your request, your output is located in the path you
|
|
2602
|
+
* specified in your request.</p>
|
|
2603
|
+
* <p>If the value is <code>SERVICE_BUCKET</code>, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the
|
|
2604
|
+
* URI shown in the <code>TranscriptFileUri</code> field.</p>
|
|
2590
2605
|
*/
|
|
2591
2606
|
OutputLocationType?: OutputLocationType | string;
|
|
2592
2607
|
/**
|
|
@@ -2594,29 +2609,28 @@ export interface MedicalTranscriptionJobSummary {
|
|
|
2594
2609
|
*/
|
|
2595
2610
|
Specialty?: Specialty | string;
|
|
2596
2611
|
/**
|
|
2597
|
-
* <p>Labels all personal health information (PHI) identified in your transcript. For more
|
|
2598
|
-
* see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html">Identifying personal health
|
|
2599
|
-
* information (PHI) in a transcription</a>.</p>
|
|
2612
|
+
* <p>Labels all personal health information (PHI) identified in your transcript. For more
|
|
2613
|
+
* information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html">Identifying personal health information (PHI) in a transcription</a>.</p>
|
|
2600
2614
|
*/
|
|
2601
2615
|
ContentIdentificationType?: MedicalContentIdentificationType | string;
|
|
2602
2616
|
/**
|
|
2603
|
-
* <p>Indicates whether the input media is a dictation or a conversation, as specified in
|
|
2604
|
-
* <code>StartMedicalTranscriptionJob</code> request.</p>
|
|
2617
|
+
* <p>Indicates whether the input media is a dictation or a conversation, as specified in
|
|
2618
|
+
* the <code>StartMedicalTranscriptionJob</code> request.</p>
|
|
2605
2619
|
*/
|
|
2606
2620
|
Type?: Type | string;
|
|
2607
2621
|
}
|
|
2608
2622
|
export interface ListMedicalTranscriptionJobsResponse {
|
|
2609
2623
|
/**
|
|
2610
|
-
* <p>Lists all medical transcription jobs that have the status specified in your request.
|
|
2611
|
-
* ordered by creation date, with the newest job first.</p>
|
|
2624
|
+
* <p>Lists all medical transcription jobs that have the status specified in your request.
|
|
2625
|
+
* Jobs are ordered by creation date, with the newest job first.</p>
|
|
2612
2626
|
*/
|
|
2613
2627
|
Status?: TranscriptionJobStatus | string;
|
|
2614
2628
|
/**
|
|
2615
|
-
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
2616
|
-
* are displayed. To view the next set of results, copy the string associated with
|
|
2617
|
-
* <code>NextToken</code> parameter in your results output, then run your request again
|
|
2618
|
-
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2619
|
-
* view all your results.</p>
|
|
2629
|
+
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
2630
|
+
* results are displayed. To view the next set of results, copy the string associated with
|
|
2631
|
+
* the <code>NextToken</code> parameter in your results output, then run your request again
|
|
2632
|
+
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2633
|
+
* to view all your results.</p>
|
|
2620
2634
|
*/
|
|
2621
2635
|
NextToken?: string;
|
|
2622
2636
|
/**
|
|
@@ -2627,33 +2641,33 @@ export interface ListMedicalTranscriptionJobsResponse {
|
|
|
2627
2641
|
export interface ListMedicalVocabulariesRequest {
|
|
2628
2642
|
/**
|
|
2629
2643
|
* <p>If your <code>ListMedicalVocabularies</code> request returns more results than can be
|
|
2630
|
-
* displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
2631
|
-
* get the next page of results, copy this string and repeat your request,
|
|
2632
|
-
* <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2633
|
-
* results.</p>
|
|
2644
|
+
* displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
2645
|
+
* string. To get the next page of results, copy this string and repeat your request,
|
|
2646
|
+
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2647
|
+
* to view all your results.</p>
|
|
2634
2648
|
*/
|
|
2635
2649
|
NextToken?: string;
|
|
2636
2650
|
/**
|
|
2637
|
-
* <p>The maximum number of custom medical vocabularies to return in each page of results.
|
|
2638
|
-
* there are fewer results than the value you specify, only the actual results are
|
|
2639
|
-
* don't specify a value, a default of 5 is used.</p>
|
|
2651
|
+
* <p>The maximum number of custom medical vocabularies to return in each page of results.
|
|
2652
|
+
* If there are fewer results than the value that you specify, only the actual results are
|
|
2653
|
+
* returned. If you don't specify a value, a default of 5 is used.</p>
|
|
2640
2654
|
*/
|
|
2641
2655
|
MaxResults?: number;
|
|
2642
2656
|
/**
|
|
2643
|
-
* <p>Returns only custom medical vocabularies with the specified state.
|
|
2644
|
-
* ordered by creation date, with the newest vocabulary first. If you don't include
|
|
2645
|
-
*
|
|
2657
|
+
* <p>Returns only custom medical vocabularies with the specified state. Custom vocabularies
|
|
2658
|
+
* are ordered by creation date, with the newest vocabulary first. If you don't include
|
|
2659
|
+
* <code>StateEquals</code>, all custom medical vocabularies are returned.</p>
|
|
2646
2660
|
*/
|
|
2647
2661
|
StateEquals?: VocabularyState | string;
|
|
2648
2662
|
/**
|
|
2649
|
-
* <p>Returns only the custom medical vocabularies that contain the specified string. The
|
|
2650
|
-
* is not case sensitive.</p>
|
|
2663
|
+
* <p>Returns only the custom medical vocabularies that contain the specified string. The
|
|
2664
|
+
* search is not case sensitive.</p>
|
|
2651
2665
|
*/
|
|
2652
2666
|
NameContains?: string;
|
|
2653
2667
|
}
|
|
2654
2668
|
/**
|
|
2655
|
-
* <p>Provides information about a custom vocabulary, including the language of the
|
|
2656
|
-
* when it was last modified, its name, and the processing state.</p>
|
|
2669
|
+
* <p>Provides information about a custom vocabulary, including the language of the custom
|
|
2670
|
+
* vocabulary, when it was last modified, its name, and the processing state.</p>
|
|
2657
2671
|
*/
|
|
2658
2672
|
export interface VocabularyInfo {
|
|
2659
2673
|
/**
|
|
@@ -2662,56 +2676,60 @@ export interface VocabularyInfo {
|
|
|
2662
2676
|
*/
|
|
2663
2677
|
VocabularyName?: string;
|
|
2664
2678
|
/**
|
|
2665
|
-
* <p>The language code used to create your custom vocabulary. Each vocabulary must
|
|
2666
|
-
* terms in only one language.</p>
|
|
2679
|
+
* <p>The language code used to create your custom vocabulary. Each custom vocabulary must
|
|
2680
|
+
* contain terms in only one language.</p>
|
|
2667
2681
|
* <p>A custom vocabulary can only be used to transcribe files in the same language as the
|
|
2668
|
-
* vocabulary. For example, if you create a vocabulary using US English
|
|
2669
|
-
*
|
|
2682
|
+
* custom vocabulary. For example, if you create a custom vocabulary using US English
|
|
2683
|
+
* (<code>en-US</code>), you can only apply this custom vocabulary to files that
|
|
2684
|
+
* contain English audio.</p>
|
|
2670
2685
|
*/
|
|
2671
2686
|
LanguageCode?: LanguageCode | string;
|
|
2672
2687
|
/**
|
|
2673
|
-
* <p>The date and time the specified vocabulary was last modified.</p>
|
|
2688
|
+
* <p>The date and time the specified custom vocabulary was last modified.</p>
|
|
2674
2689
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2675
|
-
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7
|
|
2676
|
-
*
|
|
2690
|
+
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
2691
|
+
* 4, 2022.</p>
|
|
2677
2692
|
*/
|
|
2678
2693
|
LastModifiedTime?: Date;
|
|
2679
2694
|
/**
|
|
2680
|
-
* <p>The processing state of your custom vocabulary. If the state is <code>READY</code>,
|
|
2681
|
-
* can use the vocabulary in a <code>StartTranscriptionJob</code>
|
|
2695
|
+
* <p>The processing state of your custom vocabulary. If the state is <code>READY</code>,
|
|
2696
|
+
* you can use the custom vocabulary in a <code>StartTranscriptionJob</code>
|
|
2697
|
+
* request.</p>
|
|
2682
2698
|
*/
|
|
2683
2699
|
VocabularyState?: VocabularyState | string;
|
|
2684
2700
|
}
|
|
2685
2701
|
export interface ListMedicalVocabulariesResponse {
|
|
2686
2702
|
/**
|
|
2687
2703
|
* <p>Lists all custom medical vocabularies that have the status specified in your request.
|
|
2688
|
-
*
|
|
2704
|
+
* Custom vocabularies are ordered by creation date, with the newest vocabulary
|
|
2705
|
+
* first.</p>
|
|
2689
2706
|
*/
|
|
2690
2707
|
Status?: VocabularyState | string;
|
|
2691
2708
|
/**
|
|
2692
|
-
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
2693
|
-
* are displayed. To view the next set of results, copy the string associated with
|
|
2694
|
-
* <code>NextToken</code> parameter in your results output, then run your request again
|
|
2695
|
-
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2696
|
-
* view all your results.</p>
|
|
2709
|
+
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
2710
|
+
* results are displayed. To view the next set of results, copy the string associated with
|
|
2711
|
+
* the <code>NextToken</code> parameter in your results output, then run your request again
|
|
2712
|
+
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2713
|
+
* to view all your results.</p>
|
|
2697
2714
|
*/
|
|
2698
2715
|
NextToken?: string;
|
|
2699
2716
|
/**
|
|
2700
|
-
* <p>Provides information about the custom medical vocabularies that match the criteria
|
|
2701
|
-
* in your request.</p>
|
|
2717
|
+
* <p>Provides information about the custom medical vocabularies that match the criteria
|
|
2718
|
+
* specified in your request.</p>
|
|
2702
2719
|
*/
|
|
2703
2720
|
Vocabularies?: VocabularyInfo[];
|
|
2704
2721
|
}
|
|
2705
2722
|
export interface ListTagsForResourceRequest {
|
|
2706
2723
|
/**
|
|
2707
|
-
* <p>Returns a list of all tags associated with the specified Amazon Resource Name (ARN).
|
|
2708
|
-
* have the format
|
|
2724
|
+
* <p>Returns a list of all tags associated with the specified Amazon Resource Name (ARN).
|
|
2725
|
+
* ARNs have the format
|
|
2726
|
+
* <code>arn:partition:service:region:account-id:resource-type/resource-id</code>.</p>
|
|
2709
2727
|
* <p>For example,
|
|
2710
|
-
*
|
|
2728
|
+
* <code>arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name</code>.</p>
|
|
2711
2729
|
* <p>Valid values for <code>resource-type</code> are: <code>transcription-job</code>,
|
|
2712
|
-
*
|
|
2713
|
-
*
|
|
2714
|
-
*
|
|
2730
|
+
* <code>medical-transcription-job</code>, <code>vocabulary</code>,
|
|
2731
|
+
* <code>medical-vocabulary</code>, <code>vocabulary-filter</code>, and
|
|
2732
|
+
* <code>language-model</code>.</p>
|
|
2715
2733
|
*/
|
|
2716
2734
|
ResourceArn: string | undefined;
|
|
2717
2735
|
}
|
|
@@ -2728,28 +2746,28 @@ export interface ListTagsForResourceResponse {
|
|
|
2728
2746
|
}
|
|
2729
2747
|
export interface ListTranscriptionJobsRequest {
|
|
2730
2748
|
/**
|
|
2731
|
-
* <p>Returns only transcription jobs with the specified status. Jobs are ordered by
|
|
2732
|
-
* date, with the newest job first. If you don't include <code>Status</code>, all
|
|
2733
|
-
* jobs are returned.</p>
|
|
2749
|
+
* <p>Returns only transcription jobs with the specified status. Jobs are ordered by
|
|
2750
|
+
* creation date, with the newest job first. If you don't include <code>Status</code>, all
|
|
2751
|
+
* transcription jobs are returned.</p>
|
|
2734
2752
|
*/
|
|
2735
2753
|
Status?: TranscriptionJobStatus | string;
|
|
2736
2754
|
/**
|
|
2737
|
-
* <p>Returns only the transcription jobs that contain the specified string. The search is
|
|
2738
|
-
* case sensitive.</p>
|
|
2755
|
+
* <p>Returns only the transcription jobs that contain the specified string. The search is
|
|
2756
|
+
* not case sensitive.</p>
|
|
2739
2757
|
*/
|
|
2740
2758
|
JobNameContains?: string;
|
|
2741
2759
|
/**
|
|
2742
2760
|
* <p>If your <code>ListTranscriptionJobs</code> request returns more results than can be
|
|
2743
|
-
* displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
2744
|
-
* get the next page of results, copy this string and repeat your request,
|
|
2745
|
-
* <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2746
|
-
* results.</p>
|
|
2761
|
+
* displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
2762
|
+
* string. To get the next page of results, copy this string and repeat your request,
|
|
2763
|
+
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2764
|
+
* to view all your results.</p>
|
|
2747
2765
|
*/
|
|
2748
2766
|
NextToken?: string;
|
|
2749
2767
|
/**
|
|
2750
|
-
* <p>The maximum number of transcription jobs to return in each page of results. If there
|
|
2751
|
-
* fewer results than the value you specify, only the actual results are returned.
|
|
2752
|
-
* specify a value, a default of 5 is used.</p>
|
|
2768
|
+
* <p>The maximum number of transcription jobs to return in each page of results. If there
|
|
2769
|
+
* are fewer results than the value that you specify, only the actual results are returned.
|
|
2770
|
+
* If you don't specify a value, a default of 5 is used.</p>
|
|
2753
2771
|
*/
|
|
2754
2772
|
MaxResults?: number;
|
|
2755
2773
|
}
|
|
@@ -2789,30 +2807,28 @@ export interface TranscriptionJobSummary {
|
|
|
2789
2807
|
LanguageCode?: LanguageCode | string;
|
|
2790
2808
|
/**
|
|
2791
2809
|
* <p>Provides the status of your transcription job.</p>
|
|
2792
|
-
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
2793
|
-
* at the location specified in <code>TranscriptFileUri</code> (or
|
|
2794
|
-
*
|
|
2795
|
-
* <code>FAILED</code>, <code>FailureReason</code> provides details on why
|
|
2796
|
-
* job failed.</p>
|
|
2810
|
+
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
2811
|
+
* results at the location specified in <code>TranscriptFileUri</code> (or
|
|
2812
|
+
* <code>RedactedTranscriptFileUri</code>, if you requested transcript redaction). If
|
|
2813
|
+
* the status is <code>FAILED</code>, <code>FailureReason</code> provides details on why
|
|
2814
|
+
* your transcription job failed.</p>
|
|
2797
2815
|
*/
|
|
2798
2816
|
TranscriptionJobStatus?: TranscriptionJobStatus | string;
|
|
2799
2817
|
/**
|
|
2800
2818
|
* <p>If <code>TranscriptionJobStatus</code> is <code>FAILED</code>,
|
|
2801
|
-
*
|
|
2819
|
+
* <code>FailureReason</code> contains information about why the transcription job
|
|
2802
2820
|
* failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
|
|
2803
2821
|
*/
|
|
2804
2822
|
FailureReason?: string;
|
|
2805
2823
|
/**
|
|
2806
2824
|
* <p>Indicates where the specified transcription output is stored.</p>
|
|
2807
2825
|
* <p>If the value is <code>CUSTOMER_BUCKET</code>, the location is the Amazon S3
|
|
2808
|
-
* bucket you specified using the <code>OutputBucketName</code> parameter in your
|
|
2809
|
-
*
|
|
2810
|
-
*
|
|
2811
|
-
*
|
|
2812
|
-
*
|
|
2813
|
-
*
|
|
2814
|
-
* the URI shown in the <code>TranscriptFileUri</code> or <code>RedactedTranscriptFileUri</code>
|
|
2815
|
-
* field.</p>
|
|
2826
|
+
* bucket you specified using the <code>OutputBucketName</code> parameter in your request. If you also included
|
|
2827
|
+
* <code>OutputKey</code> in your request, your output is located in the path you
|
|
2828
|
+
* specified in your request.</p>
|
|
2829
|
+
* <p>If the value is <code>SERVICE_BUCKET</code>, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the
|
|
2830
|
+
* URI shown in the <code>TranscriptFileUri</code> or
|
|
2831
|
+
* <code>RedactedTranscriptFileUri</code> field.</p>
|
|
2816
2832
|
*/
|
|
2817
2833
|
OutputLocationType?: OutputLocationType | string;
|
|
2818
2834
|
/**
|
|
@@ -2824,9 +2840,9 @@ export interface TranscriptionJobSummary {
|
|
|
2824
2840
|
* transcription job.</p>
|
|
2825
2841
|
* <p>Only use <code>ModelSettings</code> with the <code>LanguageModelName</code>
|
|
2826
2842
|
* sub-parameter if you're <b>not</b> using automatic language
|
|
2827
|
-
* identification (<code></code>).
|
|
2828
|
-
*
|
|
2829
|
-
*
|
|
2843
|
+
* identification (<code></code>). If using
|
|
2844
|
+
* <code>LanguageIdSettings</code> in your request, this parameter contains a
|
|
2845
|
+
* <code>LanguageModelName</code> sub-parameter.</p>
|
|
2830
2846
|
*/
|
|
2831
2847
|
ModelSettings?: ModelSettings;
|
|
2832
2848
|
/**
|
|
@@ -2836,11 +2852,12 @@ export interface TranscriptionJobSummary {
|
|
|
2836
2852
|
IdentifyLanguage?: boolean;
|
|
2837
2853
|
/**
|
|
2838
2854
|
* <p>Indicates whether automatic multi-language identification was enabled
|
|
2839
|
-
*
|
|
2855
|
+
* (<code>TRUE</code>) for the specified transcription job.</p>
|
|
2840
2856
|
*/
|
|
2841
2857
|
IdentifyMultipleLanguages?: boolean;
|
|
2842
2858
|
/**
|
|
2843
|
-
* <p>The confidence score associated with the language identified in your media
|
|
2859
|
+
* <p>The confidence score associated with the language identified in your media
|
|
2860
|
+
* file.</p>
|
|
2844
2861
|
* <p>Confidence scores are values between 0 and 1; a larger value indicates a higher
|
|
2845
2862
|
* probability that the identified language correctly matches the language spoken in your
|
|
2846
2863
|
* media.</p>
|
|
@@ -2848,8 +2865,8 @@ export interface TranscriptionJobSummary {
|
|
|
2848
2865
|
IdentifiedLanguageScore?: number;
|
|
2849
2866
|
/**
|
|
2850
2867
|
* <p>The language codes used to create your transcription job. This parameter is used with
|
|
2851
|
-
* multi-language identification. For single-language identification, the singular version
|
|
2852
|
-
* parameter, <code>LanguageCode</code>, is present.</p>
|
|
2868
|
+
* multi-language identification. For single-language identification, the singular version
|
|
2869
|
+
* of this parameter, <code>LanguageCode</code>, is present.</p>
|
|
2853
2870
|
*/
|
|
2854
2871
|
LanguageCodes?: LanguageCodeItem[];
|
|
2855
2872
|
}
|
|
@@ -2860,11 +2877,11 @@ export interface ListTranscriptionJobsResponse {
|
|
|
2860
2877
|
*/
|
|
2861
2878
|
Status?: TranscriptionJobStatus | string;
|
|
2862
2879
|
/**
|
|
2863
|
-
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
2864
|
-
* are displayed. To view the next set of results, copy the string associated with
|
|
2865
|
-
* <code>NextToken</code> parameter in your results output, then run your request again
|
|
2866
|
-
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2867
|
-
* view all your results.</p>
|
|
2880
|
+
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
2881
|
+
* results are displayed. To view the next set of results, copy the string associated with
|
|
2882
|
+
* the <code>NextToken</code> parameter in your results output, then run your request again
|
|
2883
|
+
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2884
|
+
* to view all your results.</p>
|
|
2868
2885
|
*/
|
|
2869
2886
|
NextToken?: string;
|
|
2870
2887
|
/**
|
|
@@ -2874,114 +2891,113 @@ export interface ListTranscriptionJobsResponse {
|
|
|
2874
2891
|
}
|
|
2875
2892
|
export interface ListVocabulariesRequest {
|
|
2876
2893
|
/**
|
|
2877
|
-
* <p>If your <code>ListVocabularies</code> request returns more results than can be
|
|
2878
|
-
* <code>NextToken</code> is displayed in the response with an associated
|
|
2879
|
-
* next page of results, copy this string and repeat your request,
|
|
2880
|
-
* <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2881
|
-
* results.</p>
|
|
2894
|
+
* <p>If your <code>ListVocabularies</code> request returns more results than can be
|
|
2895
|
+
* displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
2896
|
+
* string. To get the next page of results, copy this string and repeat your request,
|
|
2897
|
+
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2898
|
+
* to view all your results.</p>
|
|
2882
2899
|
*/
|
|
2883
2900
|
NextToken?: string;
|
|
2884
2901
|
/**
|
|
2885
2902
|
* <p>The maximum number of custom vocabularies to return in each page of results. If there
|
|
2886
|
-
* are fewer results than the value you specify, only the actual results are returned.
|
|
2887
|
-
* don't specify a value, a default of 5 is used.</p>
|
|
2903
|
+
* are fewer results than the value that you specify, only the actual results are returned.
|
|
2904
|
+
* If you don't specify a value, a default of 5 is used.</p>
|
|
2888
2905
|
*/
|
|
2889
2906
|
MaxResults?: number;
|
|
2890
2907
|
/**
|
|
2891
2908
|
* <p>Returns only custom vocabularies with the specified state. Vocabularies are ordered by
|
|
2892
2909
|
* creation date, with the newest vocabulary first. If you don't include
|
|
2893
|
-
*
|
|
2910
|
+
* <code>StateEquals</code>, all custom medical vocabularies are returned.</p>
|
|
2894
2911
|
*/
|
|
2895
2912
|
StateEquals?: VocabularyState | string;
|
|
2896
2913
|
/**
|
|
2897
|
-
* <p>Returns only the custom vocabularies that contain the specified string. The search is
|
|
2898
|
-
* case sensitive.</p>
|
|
2914
|
+
* <p>Returns only the custom vocabularies that contain the specified string. The search is
|
|
2915
|
+
* not case sensitive.</p>
|
|
2899
2916
|
*/
|
|
2900
2917
|
NameContains?: string;
|
|
2901
2918
|
}
|
|
2902
2919
|
export interface ListVocabulariesResponse {
|
|
2903
2920
|
/**
|
|
2904
|
-
* <p>Lists all custom vocabularies that have the status specified in your request.
|
|
2905
|
-
* are ordered by creation date, with the newest vocabulary first.</p>
|
|
2921
|
+
* <p>Lists all custom vocabularies that have the status specified in your request.
|
|
2922
|
+
* Vocabularies are ordered by creation date, with the newest vocabulary first.</p>
|
|
2906
2923
|
*/
|
|
2907
2924
|
Status?: VocabularyState | string;
|
|
2908
2925
|
/**
|
|
2909
|
-
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
2910
|
-
* are displayed. To view the next set of results, copy the string associated with
|
|
2911
|
-
* <code>NextToken</code> parameter in your results output, then run your request again
|
|
2912
|
-
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2913
|
-
* view all your results.</p>
|
|
2926
|
+
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
2927
|
+
* results are displayed. To view the next set of results, copy the string associated with
|
|
2928
|
+
* the <code>NextToken</code> parameter in your results output, then run your request again
|
|
2929
|
+
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2930
|
+
* to view all your results.</p>
|
|
2914
2931
|
*/
|
|
2915
2932
|
NextToken?: string;
|
|
2916
2933
|
/**
|
|
2917
|
-
* <p>Provides information about the custom vocabularies that match the criteria specified
|
|
2918
|
-
* request.</p>
|
|
2934
|
+
* <p>Provides information about the custom vocabularies that match the criteria specified
|
|
2935
|
+
* in your request.</p>
|
|
2919
2936
|
*/
|
|
2920
2937
|
Vocabularies?: VocabularyInfo[];
|
|
2921
2938
|
}
|
|
2922
2939
|
export interface ListVocabularyFiltersRequest {
|
|
2923
2940
|
/**
|
|
2924
|
-
* <p>If your <code>ListVocabularyFilters</code> request returns more results than can
|
|
2925
|
-
*
|
|
2926
|
-
* To get the next page of results, copy this string and repeat your request,
|
|
2927
|
-
* <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2928
|
-
* results.</p>
|
|
2941
|
+
* <p>If your <code>ListVocabularyFilters</code> request returns more results than can be
|
|
2942
|
+
* displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
2943
|
+
* string. To get the next page of results, copy this string and repeat your request,
|
|
2944
|
+
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2945
|
+
* to view all your results.</p>
|
|
2929
2946
|
*/
|
|
2930
2947
|
NextToken?: string;
|
|
2931
2948
|
/**
|
|
2932
2949
|
* <p>The maximum number of custom vocabulary filters to return in each page of results. If
|
|
2933
|
-
* there are fewer results than the value you specify, only the actual results are
|
|
2934
|
-
* don't specify a value, a default of 5 is used.</p>
|
|
2950
|
+
* there are fewer results than the value that you specify, only the actual results are
|
|
2951
|
+
* returned. If you don't specify a value, a default of 5 is used.</p>
|
|
2935
2952
|
*/
|
|
2936
2953
|
MaxResults?: number;
|
|
2937
2954
|
/**
|
|
2938
|
-
* <p>Returns only the custom vocabulary filters that contain the specified string. The
|
|
2939
|
-
* is not case sensitive.</p>
|
|
2955
|
+
* <p>Returns only the custom vocabulary filters that contain the specified string. The
|
|
2956
|
+
* search is not case sensitive.</p>
|
|
2940
2957
|
*/
|
|
2941
2958
|
NameContains?: string;
|
|
2942
2959
|
}
|
|
2943
2960
|
/**
|
|
2944
|
-
* <p>Provides information about a vocabulary filter, including the language of the
|
|
2945
|
-
* was last modified, and its name.</p>
|
|
2961
|
+
* <p>Provides information about a custom vocabulary filter, including the language of the
|
|
2962
|
+
* filter, when it was last modified, and its name.</p>
|
|
2946
2963
|
*/
|
|
2947
2964
|
export interface VocabularyFilterInfo {
|
|
2948
2965
|
/**
|
|
2949
2966
|
* <p>A unique name, chosen by you, for your custom vocabulary filter. This name is case
|
|
2950
|
-
* sensitive, cannot contain spaces, and must be unique within an
|
|
2951
|
-
* Amazon Web Services account.</p>
|
|
2967
|
+
* sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.</p>
|
|
2952
2968
|
*/
|
|
2953
2969
|
VocabularyFilterName?: string;
|
|
2954
2970
|
/**
|
|
2955
2971
|
* <p>The language code that represents the language of the entries in your vocabulary
|
|
2956
|
-
* filter. Each vocabulary filter must contain terms in only one language.</p>
|
|
2957
|
-
* <p>A vocabulary filter can only be used to transcribe files in the same language
|
|
2958
|
-
* filter. For example, if you create a vocabulary filter using US English
|
|
2959
|
-
*
|
|
2972
|
+
* filter. Each custom vocabulary filter must contain terms in only one language.</p>
|
|
2973
|
+
* <p>A custom vocabulary filter can only be used to transcribe files in the same language
|
|
2974
|
+
* as the filter. For example, if you create a custom vocabulary filter using US English
|
|
2975
|
+
* (<code>en-US</code>), you can only apply this filter to files that contain English
|
|
2976
|
+
* audio.</p>
|
|
2960
2977
|
* <p>For a list of supported languages and their associated language codes, refer to the
|
|
2961
|
-
*
|
|
2962
|
-
* languages</a> table.</p>
|
|
2978
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
|
|
2963
2979
|
*/
|
|
2964
2980
|
LanguageCode?: LanguageCode | string;
|
|
2965
2981
|
/**
|
|
2966
|
-
* <p>The date and time the specified vocabulary filter was last modified.</p>
|
|
2982
|
+
* <p>The date and time the specified custom vocabulary filter was last modified.</p>
|
|
2967
2983
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2968
|
-
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7
|
|
2969
|
-
*
|
|
2984
|
+
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
2985
|
+
* 4, 2022.</p>
|
|
2970
2986
|
*/
|
|
2971
2987
|
LastModifiedTime?: Date;
|
|
2972
2988
|
}
|
|
2973
2989
|
export interface ListVocabularyFiltersResponse {
|
|
2974
2990
|
/**
|
|
2975
|
-
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
2976
|
-
* are displayed. To view the next set of results, copy the string associated with
|
|
2977
|
-
* <code>NextToken</code> parameter in your results output, then run your request again
|
|
2978
|
-
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2979
|
-
* view all your results.</p>
|
|
2991
|
+
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
2992
|
+
* results are displayed. To view the next set of results, copy the string associated with
|
|
2993
|
+
* the <code>NextToken</code> parameter in your results output, then run your request again
|
|
2994
|
+
* including <code>NextToken</code> with the value of the copied string. Repeat as needed
|
|
2995
|
+
* to view all your results.</p>
|
|
2980
2996
|
*/
|
|
2981
2997
|
NextToken?: string;
|
|
2982
2998
|
/**
|
|
2983
|
-
* <p>Provides information about the custom vocabulary filters that match the criteria
|
|
2984
|
-
* in your request.</p>
|
|
2999
|
+
* <p>Provides information about the custom vocabulary filters that match the criteria
|
|
3000
|
+
* specified in your request.</p>
|
|
2985
3001
|
*/
|
|
2986
3002
|
VocabularyFilters?: VocabularyFilterInfo[];
|
|
2987
3003
|
}
|
|
@@ -2989,13 +3005,13 @@ export interface StartCallAnalyticsJobRequest {
|
|
|
2989
3005
|
/**
|
|
2990
3006
|
* <p>A unique name, chosen by you, for your Call Analytics job.</p>
|
|
2991
3007
|
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
2992
|
-
*
|
|
3008
|
+
* Amazon Web Services account. If you try to create a new job with the same name as an
|
|
2993
3009
|
* existing job, you get a <code>ConflictException</code> error.</p>
|
|
2994
3010
|
*/
|
|
2995
3011
|
CallAnalyticsJobName: string | undefined;
|
|
2996
3012
|
/**
|
|
2997
3013
|
* <p>Describes the Amazon S3 location of the media file you want to use in your
|
|
2998
|
-
* request.</p>
|
|
3014
|
+
* Call Analytics request.</p>
|
|
2999
3015
|
*/
|
|
3000
3016
|
Media: Media | undefined;
|
|
3001
3017
|
/**
|
|
@@ -3014,10 +3030,9 @@ export interface StartCallAnalyticsJobRequest {
|
|
|
3014
3030
|
* </ol>
|
|
3015
3031
|
* <p>Unless you specify a file name (option 3), the name of your output file has a default
|
|
3016
3032
|
* value that matches the name you specified for your transcription job using the
|
|
3017
|
-
*
|
|
3033
|
+
* <code>CallAnalyticsJobName</code> parameter.</p>
|
|
3018
3034
|
* <p>You can specify a KMS key to encrypt your output using the
|
|
3019
|
-
*
|
|
3020
|
-
* KMS key, Amazon Transcribe uses the default Amazon S3 key for
|
|
3035
|
+
* <code>OutputEncryptionKMSKeyId</code> parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for
|
|
3021
3036
|
* server-side encryption.</p>
|
|
3022
3037
|
* <p>If you don't specify <code>OutputLocation</code>, your transcript is placed in a
|
|
3023
3038
|
* service-managed Amazon S3 bucket and you are provided with a URI to access your
|
|
@@ -3025,105 +3040,107 @@ export interface StartCallAnalyticsJobRequest {
|
|
|
3025
3040
|
*/
|
|
3026
3041
|
OutputLocation?: string;
|
|
3027
3042
|
/**
|
|
3028
|
-
* <p>The KMS key you want to use to encrypt your Call Analytics
|
|
3043
|
+
* <p>The KMS key you want to use to encrypt your Call Analytics
|
|
3044
|
+
* output.</p>
|
|
3029
3045
|
* <p>If using a key located in the <b>current</b>
|
|
3030
|
-
* Amazon Web Services account, you can specify your KMS key in one of
|
|
3031
|
-
*
|
|
3046
|
+
* Amazon Web Services account, you can specify your KMS key in one of four
|
|
3047
|
+
* ways:</p>
|
|
3032
3048
|
* <ol>
|
|
3033
3049
|
* <li>
|
|
3034
3050
|
* <p>Use the KMS key ID itself. For example,
|
|
3035
|
-
*
|
|
3051
|
+
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
3036
3052
|
* </li>
|
|
3037
3053
|
* <li>
|
|
3038
3054
|
* <p>Use an alias for the KMS key ID. For example,
|
|
3039
|
-
*
|
|
3055
|
+
* <code>alias/ExampleAlias</code>.</p>
|
|
3040
3056
|
* </li>
|
|
3041
3057
|
* <li>
|
|
3042
3058
|
* <p>Use the Amazon Resource Name (ARN) for the KMS key ID. For
|
|
3043
3059
|
* example,
|
|
3044
|
-
*
|
|
3060
|
+
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
3045
3061
|
* </li>
|
|
3046
3062
|
* <li>
|
|
3047
3063
|
* <p>Use the ARN for the KMS key alias. For example,
|
|
3048
|
-
*
|
|
3064
|
+
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
|
|
3049
3065
|
* </li>
|
|
3050
3066
|
* </ol>
|
|
3051
3067
|
* <p>If using a key located in a <b>different</b>
|
|
3052
|
-
* Amazon Web Services account than the current Amazon Web Services account, you can
|
|
3053
|
-
*
|
|
3068
|
+
* Amazon Web Services account than the current Amazon Web Services account, you can specify
|
|
3069
|
+
* your KMS key in one of two ways:</p>
|
|
3054
3070
|
* <ol>
|
|
3055
3071
|
* <li>
|
|
3056
3072
|
* <p>Use the ARN for the KMS key ID. For example,
|
|
3057
|
-
*
|
|
3073
|
+
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
3058
3074
|
* </li>
|
|
3059
3075
|
* <li>
|
|
3060
3076
|
* <p>Use the ARN for the KMS key alias. For example,
|
|
3061
|
-
*
|
|
3077
|
+
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
|
|
3062
3078
|
* </li>
|
|
3063
3079
|
* </ol>
|
|
3064
3080
|
* <p>If you don't specify an encryption key, your output is encrypted with the default
|
|
3065
|
-
*
|
|
3081
|
+
* Amazon S3 key (SSE-S3).</p>
|
|
3066
3082
|
* <p>If you specify a KMS key to encrypt your output, you must also specify
|
|
3067
3083
|
* an output location using the <code>OutputLocation</code> parameter.</p>
|
|
3068
|
-
* <p>Note that the user making the
|
|
3069
|
-
*
|
|
3084
|
+
* <p>Note that the user making the request must
|
|
3085
|
+
* have permission to use the specified KMS key.</p>
|
|
3070
3086
|
*/
|
|
3071
3087
|
OutputEncryptionKMSKeyId?: string;
|
|
3072
3088
|
/**
|
|
3073
3089
|
* <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
|
|
3074
|
-
* access the Amazon S3 bucket that contains your input files. If the role you
|
|
3075
|
-
* have the appropriate permissions to access the specified Amazon S3 location, your request
|
|
3076
|
-
* fails.</p>
|
|
3090
|
+
* access the Amazon S3 bucket that contains your input files. If the role that you
|
|
3091
|
+
* specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.</p>
|
|
3077
3092
|
* <p>IAM role ARNs have the format
|
|
3078
|
-
*
|
|
3079
|
-
*
|
|
3080
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
|
|
3093
|
+
* <code>arn:partition:iam::account:role/role-name-with-path</code>. For example:
|
|
3094
|
+
* <code>arn:aws:iam::111122223333:role/Admin</code>.</p>
|
|
3095
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
|
|
3096
|
+
* ARNs</a>.</p>
|
|
3081
3097
|
*/
|
|
3082
3098
|
DataAccessRoleArn?: string;
|
|
3083
3099
|
/**
|
|
3084
|
-
* <p>Specify additional optional settings in your
|
|
3085
|
-
*
|
|
3086
|
-
* filters, and custom vocabularies to your Call Analytics job.</p>
|
|
3100
|
+
* <p>Specify additional optional settings in your request, including content redaction; allows you to apply custom language models,
|
|
3101
|
+
* vocabulary filters, and custom vocabularies to your Call Analytics job.</p>
|
|
3087
3102
|
*/
|
|
3088
3103
|
Settings?: CallAnalyticsJobSettings;
|
|
3089
3104
|
/**
|
|
3090
|
-
* <p>
|
|
3091
|
-
* first participant to speak, you would set <code>ChannelId</code> to
|
|
3092
|
-
*
|
|
3093
|
-
*
|
|
3105
|
+
* <p>Makes it possible to specify which speaker is on which channel. For example, if your
|
|
3106
|
+
* agent is the first participant to speak, you would set <code>ChannelId</code> to
|
|
3107
|
+
* <code>0</code> (to indicate the first channel) and <code>ParticipantRole</code> to
|
|
3108
|
+
* <code>AGENT</code> (to indicate that it's the agent speaking).</p>
|
|
3094
3109
|
*/
|
|
3095
3110
|
ChannelDefinitions?: ChannelDefinition[];
|
|
3096
3111
|
}
|
|
3097
3112
|
export interface StartCallAnalyticsJobResponse {
|
|
3098
3113
|
/**
|
|
3099
|
-
* <p>Provides detailed information about the current Call Analytics job, including job
|
|
3100
|
-
* and, if applicable, failure reason.</p>
|
|
3114
|
+
* <p>Provides detailed information about the current Call Analytics job, including job
|
|
3115
|
+
* status and, if applicable, failure reason.</p>
|
|
3101
3116
|
*/
|
|
3102
3117
|
CallAnalyticsJob?: CallAnalyticsJob;
|
|
3103
3118
|
}
|
|
3104
3119
|
export interface StartMedicalTranscriptionJobRequest {
|
|
3105
3120
|
/**
|
|
3106
|
-
* <p>A unique name, chosen by you, for your medical transcription job. The name you
|
|
3107
|
-
* also used as the default name of your transcription output file. If you want
|
|
3108
|
-
* name for your transcription output, use the
|
|
3121
|
+
* <p>A unique name, chosen by you, for your medical transcription job. The name that you
|
|
3122
|
+
* specify is also used as the default name of your transcription output file. If you want
|
|
3123
|
+
* to specify a different name for your transcription output, use the
|
|
3124
|
+
* <code>OutputKey</code> parameter.</p>
|
|
3109
3125
|
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
3110
|
-
*
|
|
3126
|
+
* Amazon Web Services account. If you try to create a new job with the same name as an
|
|
3111
3127
|
* existing job, you get a <code>ConflictException</code> error.</p>
|
|
3112
3128
|
*/
|
|
3113
3129
|
MedicalTranscriptionJobName: string | undefined;
|
|
3114
3130
|
/**
|
|
3115
|
-
* <p>The language code that represents the language spoken in the input media file. US
|
|
3116
|
-
* (<code>en-US</code>) is the only valid value for medical transcription jobs. Any
|
|
3117
|
-
* you enter for language code results in a <code>BadRequestException</code>
|
|
3131
|
+
* <p>The language code that represents the language spoken in the input media file. US
|
|
3132
|
+
* English (<code>en-US</code>) is the only valid value for medical transcription jobs. Any
|
|
3133
|
+
* other value you enter for language code results in a <code>BadRequestException</code>
|
|
3134
|
+
* error.</p>
|
|
3118
3135
|
*/
|
|
3119
3136
|
LanguageCode: LanguageCode | string | undefined;
|
|
3120
3137
|
/**
|
|
3121
|
-
* <p>The sample rate, in
|
|
3122
|
-
* <p>If you don't specify the media sample rate, Amazon Transcribe Medical determines it
|
|
3123
|
-
* you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe
|
|
3124
|
-
*
|
|
3125
|
-
*
|
|
3126
|
-
*
|
|
3138
|
+
* <p>The sample rate, in hertz, of the audio track in your input media file.</p>
|
|
3139
|
+
* <p>If you don't specify the media sample rate, Amazon Transcribe Medical determines it
|
|
3140
|
+
* for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the value that you specify and the
|
|
3141
|
+
* value detected, your job fails. Therefore, in most cases, it's advised to omit
|
|
3142
|
+
* <code>MediaSampleRateHertz</code> and let Amazon Transcribe Medical determine the
|
|
3143
|
+
* sample rate.</p>
|
|
3127
3144
|
*/
|
|
3128
3145
|
MediaSampleRateHertz?: number;
|
|
3129
3146
|
/**
|
|
@@ -3133,164 +3150,165 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
3133
3150
|
/**
|
|
3134
3151
|
* <p>Describes the Amazon S3 location of the media file you want to use in your
|
|
3135
3152
|
* request.</p>
|
|
3153
|
+
* <p>For information on supported media formats, refer to the <a href="https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat">MediaFormat</a> parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
|
|
3154
|
+
* in the Amazon S3 Developer Guide.</p>
|
|
3136
3155
|
*/
|
|
3137
3156
|
Media: Media | undefined;
|
|
3138
3157
|
/**
|
|
3139
3158
|
* <p>The name of the Amazon S3 bucket where you want your medical transcription
|
|
3140
|
-
* output stored. Do not include the <code>S3://</code> prefix of the specified
|
|
3159
|
+
* output stored. Do not include the <code>S3://</code> prefix of the specified
|
|
3160
|
+
* bucket.</p>
|
|
3141
3161
|
* <p>If you want your output to go to a sub-folder of this bucket, specify it using the
|
|
3142
|
-
*
|
|
3162
|
+
* <code>OutputKey</code> parameter; <code>OutputBucketName</code> only accepts the
|
|
3143
3163
|
* name of a bucket.</p>
|
|
3144
3164
|
* <p>For example, if you want your output stored in <code>S3://DOC-EXAMPLE-BUCKET</code>,
|
|
3145
|
-
* set <code>OutputBucketName</code> to <code>DOC-EXAMPLE-BUCKET</code>. However, if
|
|
3146
|
-
*
|
|
3147
|
-
*
|
|
3148
|
-
*
|
|
3165
|
+
* set <code>OutputBucketName</code> to <code>DOC-EXAMPLE-BUCKET</code>. However, if you
|
|
3166
|
+
* want your output stored in <code>S3://DOC-EXAMPLE-BUCKET/test-files/</code>, set
|
|
3167
|
+
* <code>OutputBucketName</code> to <code>DOC-EXAMPLE-BUCKET</code> and
|
|
3168
|
+
* <code>OutputKey</code> to <code>test-files/</code>.</p>
|
|
3149
3169
|
* <p>Note that Amazon Transcribe must have permission to use the specified location. You
|
|
3150
|
-
* can change Amazon S3 permissions using the <a href="https://console.aws.amazon.com/s3">Amazon Web Services Management Console</a>. See also <a href="https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user">Permissions
|
|
3151
|
-
* Required for IAM User Roles</a>.</p>
|
|
3152
|
-
* <p>If you don't specify <code>OutputBucketName</code>, your transcript is placed in a
|
|
3153
|
-
* service-managed Amazon S3 bucket and you are provided with a URI to access your
|
|
3154
|
-
* transcript.</p>
|
|
3170
|
+
* can change Amazon S3 permissions using the <a href="https://console.aws.amazon.com/s3">Amazon Web Services Management Console</a>. See also <a href="https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user">Permissions Required for IAM User Roles</a>.</p>
|
|
3155
3171
|
*/
|
|
3156
3172
|
OutputBucketName: string | undefined;
|
|
3157
3173
|
/**
|
|
3158
|
-
* <p>Use in combination with <code>OutputBucketName</code> to specify the output location
|
|
3159
|
-
* your transcript and, optionally, a unique name for your output file. The default name
|
|
3160
|
-
* transcription output is the same as the name you specified for your medical
|
|
3161
|
-
* (<code>MedicalTranscriptionJobName</code>).</p>
|
|
3174
|
+
* <p>Use in combination with <code>OutputBucketName</code> to specify the output location
|
|
3175
|
+
* of your transcript and, optionally, a unique name for your output file. The default name
|
|
3176
|
+
* for your transcription output is the same as the name you specified for your medical
|
|
3177
|
+
* transcription job (<code>MedicalTranscriptionJobName</code>).</p>
|
|
3162
3178
|
* <p>Here are some examples of how you can use <code>OutputKey</code>:</p>
|
|
3163
3179
|
* <ul>
|
|
3164
3180
|
* <li>
|
|
3165
|
-
* <p>If you specify 'DOC-EXAMPLE-BUCKET' as the <code>OutputBucketName</code>
|
|
3166
|
-
*
|
|
3181
|
+
* <p>If you specify 'DOC-EXAMPLE-BUCKET' as the <code>OutputBucketName</code> and
|
|
3182
|
+
* 'my-transcript.json' as the <code>OutputKey</code>, your transcription output
|
|
3167
3183
|
* path is <code>s3://DOC-EXAMPLE-BUCKET/my-transcript.json</code>.</p>
|
|
3168
3184
|
* </li>
|
|
3169
3185
|
* <li>
|
|
3170
|
-
* <p>If you specify 'my-first-transcription' as the
|
|
3171
|
-
*
|
|
3172
|
-
*
|
|
3173
|
-
*
|
|
3186
|
+
* <p>If you specify 'my-first-transcription' as the
|
|
3187
|
+
* <code>MedicalTranscriptionJobName</code>, 'DOC-EXAMPLE-BUCKET' as the
|
|
3188
|
+
* <code>OutputBucketName</code>, and 'my-transcript' as the
|
|
3189
|
+
* <code>OutputKey</code>, your transcription output path is
|
|
3190
|
+
* <code>s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json</code>.</p>
|
|
3174
3191
|
* </li>
|
|
3175
3192
|
* <li>
|
|
3176
|
-
* <p>If you specify 'DOC-EXAMPLE-BUCKET' as the <code>OutputBucketName</code>
|
|
3177
|
-
*
|
|
3178
|
-
* path is
|
|
3193
|
+
* <p>If you specify 'DOC-EXAMPLE-BUCKET' as the <code>OutputBucketName</code> and
|
|
3194
|
+
* 'test-files/my-transcript.json' as the <code>OutputKey</code>, your
|
|
3195
|
+
* transcription output path is
|
|
3196
|
+
* <code>s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json</code>.</p>
|
|
3179
3197
|
* </li>
|
|
3180
3198
|
* <li>
|
|
3181
|
-
* <p>If you specify 'my-first-transcription' as the
|
|
3182
|
-
*
|
|
3183
|
-
*
|
|
3184
|
-
*
|
|
3199
|
+
* <p>If you specify 'my-first-transcription' as the
|
|
3200
|
+
* <code>MedicalTranscriptionJobName</code>, 'DOC-EXAMPLE-BUCKET' as the
|
|
3201
|
+
* <code>OutputBucketName</code>, and 'test-files/my-transcript' as the
|
|
3202
|
+
* <code>OutputKey</code>, your transcription output path is
|
|
3203
|
+
* <code>s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json</code>.</p>
|
|
3185
3204
|
* </li>
|
|
3186
3205
|
* </ul>
|
|
3187
|
-
* <p>If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist,
|
|
3188
|
-
* created for you.</p>
|
|
3206
|
+
* <p>If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist,
|
|
3207
|
+
* one is created for you.</p>
|
|
3189
3208
|
*/
|
|
3190
3209
|
OutputKey?: string;
|
|
3191
3210
|
/**
|
|
3192
3211
|
* <p>The KMS key you want to use to encrypt your medical transcription
|
|
3193
3212
|
* output.</p>
|
|
3194
3213
|
* <p>If using a key located in the <b>current</b>
|
|
3195
|
-
* Amazon Web Services account, you can specify your KMS key in one of
|
|
3196
|
-
*
|
|
3214
|
+
* Amazon Web Services account, you can specify your KMS key in one of four
|
|
3215
|
+
* ways:</p>
|
|
3197
3216
|
* <ol>
|
|
3198
3217
|
* <li>
|
|
3199
3218
|
* <p>Use the KMS key ID itself. For example,
|
|
3200
|
-
*
|
|
3219
|
+
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
3201
3220
|
* </li>
|
|
3202
3221
|
* <li>
|
|
3203
3222
|
* <p>Use an alias for the KMS key ID. For example,
|
|
3204
|
-
*
|
|
3223
|
+
* <code>alias/ExampleAlias</code>.</p>
|
|
3205
3224
|
* </li>
|
|
3206
3225
|
* <li>
|
|
3207
3226
|
* <p>Use the Amazon Resource Name (ARN) for the KMS key ID. For
|
|
3208
|
-
* example,
|
|
3227
|
+
* example,
|
|
3228
|
+
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
3209
3229
|
* </li>
|
|
3210
3230
|
* <li>
|
|
3211
3231
|
* <p>Use the ARN for the KMS key alias. For example,
|
|
3212
|
-
*
|
|
3232
|
+
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
|
|
3213
3233
|
* </li>
|
|
3214
3234
|
* </ol>
|
|
3215
3235
|
* <p>If using a key located in a <b>different</b>
|
|
3216
|
-
* Amazon Web Services account than the current Amazon Web Services account, you can
|
|
3217
|
-
*
|
|
3236
|
+
* Amazon Web Services account than the current Amazon Web Services account, you can specify
|
|
3237
|
+
* your KMS key in one of two ways:</p>
|
|
3218
3238
|
* <ol>
|
|
3219
3239
|
* <li>
|
|
3220
|
-
* <p>Use the ARN for the KMS key ID. For example,
|
|
3240
|
+
* <p>Use the ARN for the KMS key ID. For example,
|
|
3241
|
+
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
3221
3242
|
* </li>
|
|
3222
3243
|
* <li>
|
|
3223
3244
|
* <p>Use the ARN for the KMS key alias. For example,
|
|
3224
|
-
*
|
|
3245
|
+
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
|
|
3225
3246
|
* </li>
|
|
3226
3247
|
* </ol>
|
|
3227
3248
|
* <p>If you don't specify an encryption key, your output is encrypted with the default
|
|
3228
|
-
*
|
|
3249
|
+
* Amazon S3 key (SSE-S3).</p>
|
|
3229
3250
|
* <p>If you specify a KMS key to encrypt your output, you must also specify
|
|
3230
3251
|
* an output location using the <code>OutputLocation</code> parameter.</p>
|
|
3231
|
-
* <p>Note that the user making the
|
|
3232
|
-
*
|
|
3252
|
+
* <p>Note that the user making the request must
|
|
3253
|
+
* have permission to use the specified KMS key.</p>
|
|
3233
3254
|
*/
|
|
3234
3255
|
OutputEncryptionKMSKeyId?: string;
|
|
3235
3256
|
/**
|
|
3236
|
-
* <p>A map of plain text, non-secret key:value pairs, known as encryption context pairs,
|
|
3237
|
-
* provide an added layer of security for your data. For more information, see
|
|
3238
|
-
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context">KMS
|
|
3239
|
-
* encryption context</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html">Asymmetric keys in
|
|
3240
|
-
* KMS</a>.</p>
|
|
3257
|
+
* <p>A map of plain text, non-secret key:value pairs, known as encryption context pairs,
|
|
3258
|
+
* that provide an added layer of security for your data. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context">KMS encryption context</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html">Asymmetric keys in KMS</a>.</p>
|
|
3241
3259
|
*/
|
|
3242
3260
|
KMSEncryptionContext?: Record<string, string>;
|
|
3243
3261
|
/**
|
|
3244
|
-
* <p>Specify additional optional settings in your
|
|
3245
|
-
*
|
|
3246
|
-
*
|
|
3262
|
+
* <p>Specify additional optional settings in your request, including channel
|
|
3263
|
+
* identification, alternative transcriptions, and speaker partitioning. You can use that to
|
|
3264
|
+
* apply custom vocabularies to your transcription job.</p>
|
|
3247
3265
|
*/
|
|
3248
3266
|
Settings?: MedicalTranscriptionSetting;
|
|
3249
3267
|
/**
|
|
3250
|
-
* <p>Labels all personal health information (PHI) identified in your transcript. For more
|
|
3251
|
-
* see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html">Identifying personal health
|
|
3252
|
-
* information (PHI) in a transcription</a>.</p>
|
|
3268
|
+
* <p>Labels all personal health information (PHI) identified in your transcript. For more
|
|
3269
|
+
* information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html">Identifying personal health information (PHI) in a transcription</a>.</p>
|
|
3253
3270
|
*/
|
|
3254
3271
|
ContentIdentificationType?: MedicalContentIdentificationType | string;
|
|
3255
3272
|
/**
|
|
3256
3273
|
* <p>Specify the predominant medical specialty represented in your media. For batch
|
|
3257
|
-
* transcriptions, <code>PRIMARYCARE</code> is the only valid value. If you require
|
|
3258
|
-
* specialties, refer to .</p>
|
|
3274
|
+
* transcriptions, <code>PRIMARYCARE</code> is the only valid value. If you require
|
|
3275
|
+
* additional specialties, refer to .</p>
|
|
3259
3276
|
*/
|
|
3260
3277
|
Specialty: Specialty | string | undefined;
|
|
3261
3278
|
/**
|
|
3262
3279
|
* <p>Specify whether your input media contains only one person (<code>DICTATION</code>) or
|
|
3263
3280
|
* contains a conversation between two people (<code>CONVERSATION</code>).</p>
|
|
3264
|
-
* <p>For example, <code>DICTATION</code> could be used for a medical professional wanting
|
|
3265
|
-
* transcribe voice memos; <code>CONVERSATION</code> could be used for transcribing the
|
|
3281
|
+
* <p>For example, <code>DICTATION</code> could be used for a medical professional wanting
|
|
3282
|
+
* to transcribe voice memos; <code>CONVERSATION</code> could be used for transcribing the
|
|
3266
3283
|
* doctor-patient dialogue during the patient's office visit.</p>
|
|
3267
3284
|
*/
|
|
3268
3285
|
Type: Type | string | undefined;
|
|
3269
3286
|
/**
|
|
3270
3287
|
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new medical
|
|
3271
3288
|
* transcription job at the time you start this new job.</p>
|
|
3272
|
-
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
3289
|
+
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
3290
|
+
* resources</a>.</p>
|
|
3273
3291
|
*/
|
|
3274
3292
|
Tags?: Tag[];
|
|
3275
3293
|
}
|
|
3276
3294
|
export interface StartMedicalTranscriptionJobResponse {
|
|
3277
3295
|
/**
|
|
3278
|
-
* <p>Provides detailed information about the current medical transcription job, including
|
|
3279
|
-
* status and, if applicable, failure reason.</p>
|
|
3296
|
+
* <p>Provides detailed information about the current medical transcription job, including
|
|
3297
|
+
* job status and, if applicable, failure reason.</p>
|
|
3280
3298
|
*/
|
|
3281
3299
|
MedicalTranscriptionJob?: MedicalTranscriptionJob;
|
|
3282
3300
|
}
|
|
3283
3301
|
/**
|
|
3284
3302
|
* <p>Generate subtitles for your media file with your transcription request.</p>
|
|
3285
|
-
* <p>You can choose a start index of 0 or 1, and you can specify either WebVTT or SubRip
|
|
3286
|
-
* both) as your output format.</p>
|
|
3303
|
+
* <p>You can choose a start index of 0 or 1, and you can specify either WebVTT or SubRip
|
|
3304
|
+
* (or both) as your output format.</p>
|
|
3287
3305
|
* <p>Note that your subtitle files are placed in the same location as your transcription
|
|
3288
3306
|
* output.</p>
|
|
3289
3307
|
*/
|
|
3290
3308
|
export interface Subtitles {
|
|
3291
3309
|
/**
|
|
3292
3310
|
* <p>Specify the output format for your subtitle file; if you select both WebVTT
|
|
3293
|
-
*
|
|
3311
|
+
* (<code>vtt</code>) and SubRip (<code>srt</code>) formats, two output files are
|
|
3294
3312
|
* generated.</p>
|
|
3295
3313
|
*/
|
|
3296
3314
|
Formats?: (SubtitleFormat | string)[];
|
|
@@ -3305,39 +3323,38 @@ export interface Subtitles {
|
|
|
3305
3323
|
}
|
|
3306
3324
|
export interface StartTranscriptionJobRequest {
|
|
3307
3325
|
/**
|
|
3308
|
-
* <p>A unique name, chosen by you, for your transcription job. The name you specify is
|
|
3309
|
-
* also used as the default name of your transcription output file. If you want to specify
|
|
3310
|
-
* name for your transcription output, use the <code>OutputKey</code>
|
|
3326
|
+
* <p>A unique name, chosen by you, for your transcription job. The name that you specify is
|
|
3327
|
+
* also used as the default name of your transcription output file. If you want to specify
|
|
3328
|
+
* a different name for your transcription output, use the <code>OutputKey</code>
|
|
3329
|
+
* parameter.</p>
|
|
3311
3330
|
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
3312
|
-
*
|
|
3331
|
+
* Amazon Web Services account. If you try to create a new job with the same name as an
|
|
3313
3332
|
* existing job, you get a <code>ConflictException</code> error.</p>
|
|
3314
3333
|
*/
|
|
3315
3334
|
TranscriptionJobName: string | undefined;
|
|
3316
3335
|
/**
|
|
3317
3336
|
* <p>The language code that represents the language spoken in the input media file.</p>
|
|
3318
3337
|
* <p>If you're unsure of the language spoken in your media file, consider using
|
|
3319
|
-
*
|
|
3338
|
+
* <code>IdentifyLanguage</code> or <code>IdentifyMultipleLanguages</code> to enable
|
|
3320
3339
|
* automatic language identification.</p>
|
|
3321
3340
|
* <p>Note that you must include one of <code>LanguageCode</code>,
|
|
3322
|
-
*
|
|
3341
|
+
* <code>IdentifyLanguage</code>, or <code>IdentifyMultipleLanguages</code> in your
|
|
3323
3342
|
* request. If you include more than one of these parameters, your transcription job
|
|
3324
3343
|
* fails.</p>
|
|
3325
3344
|
* <p>For a list of supported languages and their associated language codes, refer to the
|
|
3326
|
-
*
|
|
3327
|
-
* languages</a> table.</p>
|
|
3345
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
|
|
3328
3346
|
* <note>
|
|
3329
|
-
* <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media
|
|
3330
|
-
*
|
|
3347
|
+
* <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media
|
|
3348
|
+
* file must be encoded at a sample rate of 16,000 Hz or higher.</p>
|
|
3331
3349
|
* </note>
|
|
3332
3350
|
*/
|
|
3333
3351
|
LanguageCode?: LanguageCode | string;
|
|
3334
3352
|
/**
|
|
3335
|
-
* <p>The sample rate, in
|
|
3336
|
-
* <p>If you don't specify the media sample rate, Amazon Transcribe determines it for you.
|
|
3337
|
-
* specify the sample rate, it must match the rate detected by Amazon Transcribe
|
|
3338
|
-
* mismatch between the value you specify and the value detected, your
|
|
3339
|
-
* cases,
|
|
3340
|
-
* determine the sample rate.</p>
|
|
3353
|
+
* <p>The sample rate, in hertz, of the audio track in your input media file.</p>
|
|
3354
|
+
* <p>If you don't specify the media sample rate, Amazon Transcribe determines it for you.
|
|
3355
|
+
* If you specify the sample rate, it must match the rate detected by Amazon Transcribe.
|
|
3356
|
+
* If there's a mismatch between the value that you specify and the value detected, your
|
|
3357
|
+
* job fails. In most cases, you can omit <code>MediaSampleRateHertz</code> and let Amazon Transcribe determine the sample rate.</p>
|
|
3341
3358
|
*/
|
|
3342
3359
|
MediaSampleRateHertz?: number;
|
|
3343
3360
|
/**
|
|
@@ -3353,251 +3370,267 @@ export interface StartTranscriptionJobRequest {
|
|
|
3353
3370
|
* <p>The name of the Amazon S3 bucket where you want your transcription output
|
|
3354
3371
|
* stored. Do not include the <code>S3://</code> prefix of the specified bucket.</p>
|
|
3355
3372
|
* <p>If you want your output to go to a sub-folder of this bucket, specify it using the
|
|
3356
|
-
*
|
|
3373
|
+
* <code>OutputKey</code> parameter; <code>OutputBucketName</code> only accepts the
|
|
3357
3374
|
* name of a bucket.</p>
|
|
3358
3375
|
* <p>For example, if you want your output stored in <code>S3://DOC-EXAMPLE-BUCKET</code>,
|
|
3359
|
-
* set <code>OutputBucketName</code> to <code>DOC-EXAMPLE-BUCKET</code>. However, if
|
|
3360
|
-
*
|
|
3361
|
-
*
|
|
3362
|
-
*
|
|
3376
|
+
* set <code>OutputBucketName</code> to <code>DOC-EXAMPLE-BUCKET</code>. However, if you
|
|
3377
|
+
* want your output stored in <code>S3://DOC-EXAMPLE-BUCKET/test-files/</code>, set
|
|
3378
|
+
* <code>OutputBucketName</code> to <code>DOC-EXAMPLE-BUCKET</code> and
|
|
3379
|
+
* <code>OutputKey</code> to <code>test-files/</code>.</p>
|
|
3363
3380
|
* <p>Note that Amazon Transcribe must have permission to use the specified location. You
|
|
3364
|
-
* can change Amazon S3 permissions using the <a href="https://console.aws.amazon.com/s3">Amazon Web Services Management Console</a>. See also <a href="https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user">Permissions
|
|
3365
|
-
* Required for IAM User Roles</a>.</p>
|
|
3381
|
+
* can change Amazon S3 permissions using the <a href="https://console.aws.amazon.com/s3">Amazon Web Services Management Console</a>. See also <a href="https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user">Permissions Required for IAM User Roles</a>.</p>
|
|
3366
3382
|
* <p>If you don't specify <code>OutputBucketName</code>, your transcript is placed in a
|
|
3367
3383
|
* service-managed Amazon S3 bucket and you are provided with a URI to access your
|
|
3368
3384
|
* transcript.</p>
|
|
3369
3385
|
*/
|
|
3370
3386
|
OutputBucketName?: string;
|
|
3371
3387
|
/**
|
|
3372
|
-
* <p>Use in combination with <code>OutputBucketName</code> to specify the output location
|
|
3373
|
-
* your transcript and, optionally, a unique name for your output file. The default name
|
|
3374
|
-
* transcription output is the same as the name you specified for your
|
|
3375
|
-
* (<code>TranscriptionJobName</code>).</p>
|
|
3388
|
+
* <p>Use in combination with <code>OutputBucketName</code> to specify the output location
|
|
3389
|
+
* of your transcript and, optionally, a unique name for your output file. The default name
|
|
3390
|
+
* for your transcription output is the same as the name you specified for your
|
|
3391
|
+
* transcription job (<code>TranscriptionJobName</code>).</p>
|
|
3376
3392
|
* <p>Here are some examples of how you can use <code>OutputKey</code>:</p>
|
|
3377
3393
|
* <ul>
|
|
3378
3394
|
* <li>
|
|
3379
|
-
* <p>If you specify 'DOC-EXAMPLE-BUCKET' as the <code>OutputBucketName</code>
|
|
3380
|
-
*
|
|
3395
|
+
* <p>If you specify 'DOC-EXAMPLE-BUCKET' as the <code>OutputBucketName</code> and
|
|
3396
|
+
* 'my-transcript.json' as the <code>OutputKey</code>, your transcription output
|
|
3381
3397
|
* path is <code>s3://DOC-EXAMPLE-BUCKET/my-transcript.json</code>.</p>
|
|
3382
3398
|
* </li>
|
|
3383
3399
|
* <li>
|
|
3384
|
-
* <p>If you specify 'my-first-transcription' as the
|
|
3385
|
-
*
|
|
3386
|
-
*
|
|
3387
|
-
*
|
|
3400
|
+
* <p>If you specify 'my-first-transcription' as the
|
|
3401
|
+
* <code>TranscriptionJobName</code>, 'DOC-EXAMPLE-BUCKET' as the
|
|
3402
|
+
* <code>OutputBucketName</code>, and 'my-transcript' as the
|
|
3403
|
+
* <code>OutputKey</code>, your transcription output path is
|
|
3404
|
+
* <code>s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json</code>.</p>
|
|
3388
3405
|
* </li>
|
|
3389
3406
|
* <li>
|
|
3390
|
-
* <p>If you specify 'DOC-EXAMPLE-BUCKET' as the <code>OutputBucketName</code>
|
|
3391
|
-
*
|
|
3392
|
-
* output path is
|
|
3393
|
-
*
|
|
3407
|
+
* <p>If you specify 'DOC-EXAMPLE-BUCKET' as the <code>OutputBucketName</code> and
|
|
3408
|
+
* 'test-files/my-transcript.json' as the <code>OutputKey</code>, your
|
|
3409
|
+
* transcription output path is
|
|
3410
|
+
* <code>s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json</code>.</p>
|
|
3394
3411
|
* </li>
|
|
3395
3412
|
* <li>
|
|
3396
|
-
* <p>If you specify 'my-first-transcription' as the
|
|
3397
|
-
*
|
|
3398
|
-
*
|
|
3399
|
-
*
|
|
3400
|
-
*
|
|
3413
|
+
* <p>If you specify 'my-first-transcription' as the
|
|
3414
|
+
* <code>TranscriptionJobName</code>, 'DOC-EXAMPLE-BUCKET' as the
|
|
3415
|
+
* <code>OutputBucketName</code>, and 'test-files/my-transcript' as the
|
|
3416
|
+
* <code>OutputKey</code>, your transcription output path is
|
|
3417
|
+
* <code>s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json</code>.</p>
|
|
3401
3418
|
* </li>
|
|
3402
3419
|
* </ul>
|
|
3403
|
-
* <p>If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist,
|
|
3404
|
-
* created for you.</p>
|
|
3420
|
+
* <p>If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist,
|
|
3421
|
+
* one is created for you.</p>
|
|
3405
3422
|
*/
|
|
3406
3423
|
OutputKey?: string;
|
|
3407
3424
|
/**
|
|
3408
|
-
* <p>The KMS key you want to use to encrypt your transcription
|
|
3425
|
+
* <p>The KMS key you want to use to encrypt your transcription
|
|
3426
|
+
* output.</p>
|
|
3409
3427
|
* <p>If using a key located in the <b>current</b>
|
|
3410
|
-
* Amazon Web Services account, you can specify your KMS key in one of
|
|
3411
|
-
*
|
|
3428
|
+
* Amazon Web Services account, you can specify your KMS key in one of four
|
|
3429
|
+
* ways:</p>
|
|
3412
3430
|
* <ol>
|
|
3413
3431
|
* <li>
|
|
3414
3432
|
* <p>Use the KMS key ID itself. For example,
|
|
3415
|
-
*
|
|
3433
|
+
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
3416
3434
|
* </li>
|
|
3417
3435
|
* <li>
|
|
3418
3436
|
* <p>Use an alias for the KMS key ID. For example,
|
|
3419
|
-
*
|
|
3437
|
+
* <code>alias/ExampleAlias</code>.</p>
|
|
3420
3438
|
* </li>
|
|
3421
3439
|
* <li>
|
|
3422
3440
|
* <p>Use the Amazon Resource Name (ARN) for the KMS key ID. For
|
|
3423
|
-
* example,
|
|
3441
|
+
* example,
|
|
3442
|
+
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
3424
3443
|
* </li>
|
|
3425
3444
|
* <li>
|
|
3426
3445
|
* <p>Use the ARN for the KMS key alias. For example,
|
|
3427
|
-
*
|
|
3446
|
+
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
|
|
3428
3447
|
* </li>
|
|
3429
3448
|
* </ol>
|
|
3430
3449
|
* <p>If using a key located in a <b>different</b>
|
|
3431
|
-
* Amazon Web Services account than the current Amazon Web Services account, you can
|
|
3432
|
-
*
|
|
3450
|
+
* Amazon Web Services account than the current Amazon Web Services account, you can specify
|
|
3451
|
+
* your KMS key in one of two ways:</p>
|
|
3433
3452
|
* <ol>
|
|
3434
3453
|
* <li>
|
|
3435
|
-
* <p>Use the ARN for the KMS key ID. For example,
|
|
3454
|
+
* <p>Use the ARN for the KMS key ID. For example,
|
|
3455
|
+
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
3436
3456
|
* </li>
|
|
3437
3457
|
* <li>
|
|
3438
3458
|
* <p>Use the ARN for the KMS key alias. For example,
|
|
3439
|
-
*
|
|
3459
|
+
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
|
|
3440
3460
|
* </li>
|
|
3441
3461
|
* </ol>
|
|
3442
3462
|
* <p>If you don't specify an encryption key, your output is encrypted with the default
|
|
3443
|
-
*
|
|
3463
|
+
* Amazon S3 key (SSE-S3).</p>
|
|
3444
3464
|
* <p>If you specify a KMS key to encrypt your output, you must also specify
|
|
3445
3465
|
* an output location using the <code>OutputLocation</code> parameter.</p>
|
|
3446
|
-
* <p>Note that the user making the
|
|
3447
|
-
*
|
|
3466
|
+
* <p>Note that the user making the request must
|
|
3467
|
+
* have permission to use the specified KMS key.</p>
|
|
3448
3468
|
*/
|
|
3449
3469
|
OutputEncryptionKMSKeyId?: string;
|
|
3450
3470
|
/**
|
|
3451
|
-
* <p>A map of plain text, non-secret key:value pairs, known as encryption context pairs,
|
|
3452
|
-
* provide an added layer of security for your data. For more information, see
|
|
3453
|
-
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context">KMS
|
|
3454
|
-
* encryption context</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html">Asymmetric keys in
|
|
3455
|
-
* KMS</a>.</p>
|
|
3471
|
+
* <p>A map of plain text, non-secret key:value pairs, known as encryption context pairs,
|
|
3472
|
+
* that provide an added layer of security for your data. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context">KMS encryption context</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html">Asymmetric keys in KMS</a>.</p>
|
|
3456
3473
|
*/
|
|
3457
3474
|
KMSEncryptionContext?: Record<string, string>;
|
|
3458
3475
|
/**
|
|
3459
|
-
* <p>Specify additional optional settings in your
|
|
3460
|
-
*
|
|
3461
|
-
*
|
|
3462
|
-
*
|
|
3463
|
-
* your request but <b>do not</b> want to use automatic
|
|
3476
|
+
* <p>Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker
|
|
3477
|
+
* partitioning. You can use that to apply custom vocabularies and vocabulary filters.</p>
|
|
3478
|
+
* <p>If you want to include a custom vocabulary or a custom vocabulary filter (or both)
|
|
3479
|
+
* with your request but <b>do not</b> want to use automatic
|
|
3464
3480
|
* language identification, use <code>Settings</code> with the <code>VocabularyName</code>
|
|
3465
3481
|
* or <code>VocabularyFilterName</code> (or both) sub-parameter.</p>
|
|
3466
|
-
* <p>If you're using automatic language identification with your request and want to
|
|
3467
|
-
* custom language model, a custom vocabulary, or a custom vocabulary filter, use
|
|
3468
|
-
* <code></code> parameter with the
|
|
3469
|
-
*
|
|
3470
|
-
*
|
|
3482
|
+
* <p>If you're using automatic language identification with your request and want to
|
|
3483
|
+
* include a custom language model, a custom vocabulary, or a custom vocabulary filter, use
|
|
3484
|
+
* instead the <code></code> parameter with the
|
|
3485
|
+
* <code>LanguageModelName</code>, <code>VocabularyName</code> or
|
|
3486
|
+
* <code>VocabularyFilterName</code> sub-parameters.</p>
|
|
3471
3487
|
*/
|
|
3472
3488
|
Settings?: Settings;
|
|
3473
3489
|
/**
|
|
3474
|
-
* <p>Specify the custom language model you want to include with your transcription job. If
|
|
3475
|
-
* include <code>ModelSettings</code> in your request, you must include the
|
|
3476
|
-
*
|
|
3490
|
+
* <p>Specify the custom language model you want to include with your transcription job. If
|
|
3491
|
+
* you include <code>ModelSettings</code> in your request, you must include the
|
|
3492
|
+
* <code>LanguageModelName</code> sub-parameter.</p>
|
|
3477
3493
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language
|
|
3478
|
-
*
|
|
3494
|
+
* models</a>.</p>
|
|
3479
3495
|
*/
|
|
3480
3496
|
ModelSettings?: ModelSettings;
|
|
3481
3497
|
/**
|
|
3482
|
-
* <p>
|
|
3483
|
-
* <code>JobExecutionSettings</code> modification you can choose is enabling job
|
|
3484
|
-
* the <code>AllowDeferredExecution</code> sub-parameter.</p>
|
|
3485
|
-
* <p>If you include <code>JobExecutionSettings</code> in your request, you must also
|
|
3486
|
-
* the sub-parameters: <code>AllowDeferredExecution</code> and
|
|
3487
|
-
*
|
|
3498
|
+
* <p>Makes it possible to control how your transcription job is processed. Currently, the
|
|
3499
|
+
* only <code>JobExecutionSettings</code> modification you can choose is enabling job
|
|
3500
|
+
* queueing using the <code>AllowDeferredExecution</code> sub-parameter.</p>
|
|
3501
|
+
* <p>If you include <code>JobExecutionSettings</code> in your request, you must also
|
|
3502
|
+
* include the sub-parameters: <code>AllowDeferredExecution</code> and
|
|
3503
|
+
* <code>DataAccessRoleArn</code>.</p>
|
|
3488
3504
|
*/
|
|
3489
3505
|
JobExecutionSettings?: JobExecutionSettings;
|
|
3490
3506
|
/**
|
|
3491
|
-
* <p>
|
|
3492
|
-
* you use <code>ContentRedaction</code>, you must also
|
|
3493
|
-
* <code>PiiEntityTypes</code>, <code>RedactionOutput</code>,
|
|
3494
|
-
* <code>RedactionType</code>.</p>
|
|
3507
|
+
* <p>Makes it possible to redact or flag specified personally identifiable information
|
|
3508
|
+
* (PII) in your transcript. If you use <code>ContentRedaction</code>, you must also
|
|
3509
|
+
* include the sub-parameters: <code>PiiEntityTypes</code>, <code>RedactionOutput</code>,
|
|
3510
|
+
* and <code>RedactionType</code>.</p>
|
|
3495
3511
|
*/
|
|
3496
3512
|
ContentRedaction?: ContentRedaction;
|
|
3497
3513
|
/**
|
|
3498
|
-
* <p>Enables automatic language identification in your transcription job request
|
|
3514
|
+
* <p>Enables automatic language identification in your transcription job request. Use this
|
|
3515
|
+
* parameter if your media file contains only one language. If your media contains multiple
|
|
3516
|
+
* languages, use <code>IdentifyMultipleLanguages</code> instead.</p>
|
|
3499
3517
|
* <p>If you include <code>IdentifyLanguage</code>, you can optionally include a list of
|
|
3500
3518
|
* language codes, using <code>LanguageOptions</code>, that you think may be present in
|
|
3501
|
-
* your media file. Including
|
|
3519
|
+
* your media file. Including <code>LanguageOptions</code> restricts
|
|
3520
|
+
* <code>IdentifyLanguage</code> to only the language options that you specify, which
|
|
3521
|
+
* can improve transcription accuracy.</p>
|
|
3502
3522
|
* <p>If you want to apply a custom language model, a custom vocabulary, or a custom
|
|
3503
3523
|
* vocabulary filter to your automatic language identification request, include
|
|
3504
|
-
*
|
|
3505
|
-
*
|
|
3506
|
-
*
|
|
3524
|
+
* <code>LanguageIdSettings</code> with the relevant sub-parameters
|
|
3525
|
+
* (<code>VocabularyName</code>, <code>LanguageModelName</code>, and
|
|
3526
|
+
* <code>VocabularyFilterName</code>). If you include <code>LanguageIdSettings</code>,
|
|
3527
|
+
* also include <code>LanguageOptions</code>.</p>
|
|
3507
3528
|
* <p>Note that you must include one of <code>LanguageCode</code>,
|
|
3508
|
-
*
|
|
3529
|
+
* <code>IdentifyLanguage</code>, or <code>IdentifyMultipleLanguages</code> in your
|
|
3509
3530
|
* request. If you include more than one of these parameters, your transcription job
|
|
3510
3531
|
* fails.</p>
|
|
3511
3532
|
*/
|
|
3512
3533
|
IdentifyLanguage?: boolean;
|
|
3513
3534
|
/**
|
|
3514
|
-
* <p>Enables automatic multi-language identification in your transcription job request. Use
|
|
3515
|
-
* parameter if your media file contains more than one language
|
|
3516
|
-
*
|
|
3517
|
-
*
|
|
3518
|
-
*
|
|
3519
|
-
*
|
|
3520
|
-
*
|
|
3521
|
-
*
|
|
3522
|
-
*
|
|
3535
|
+
* <p>Enables automatic multi-language identification in your transcription job request. Use
|
|
3536
|
+
* this parameter if your media file contains more than one language. If your media
|
|
3537
|
+
* contains only one language, use <code>IdentifyLanguage</code> instead.</p>
|
|
3538
|
+
* <p>If you include <code>IdentifyMultipleLanguages</code>, you can optionally include a
|
|
3539
|
+
* list of language codes, using <code>LanguageOptions</code>, that you think may be
|
|
3540
|
+
* present in your media file. Including <code>LanguageOptions</code> restricts
|
|
3541
|
+
* <code>IdentifyLanguage</code> to only the language options that you specify, which
|
|
3542
|
+
* can improve transcription accuracy.</p>
|
|
3543
|
+
* <p>If you want to apply a custom vocabulary or a custom vocabulary filter to your
|
|
3544
|
+
* automatic language identification request, include <code>LanguageIdSettings</code> with
|
|
3545
|
+
* the relevant sub-parameters (<code>VocabularyName</code> and
|
|
3546
|
+
* <code>VocabularyFilterName</code>). If you include <code>LanguageIdSettings</code>,
|
|
3547
|
+
* also include <code>LanguageOptions</code>.</p>
|
|
3523
3548
|
* <p>Note that you must include one of <code>LanguageCode</code>,
|
|
3524
|
-
*
|
|
3525
|
-
* request. If you include more than one of these parameters, your transcription job
|
|
3549
|
+
* <code>IdentifyLanguage</code>, or <code>IdentifyMultipleLanguages</code> in your
|
|
3550
|
+
* request. If you include more than one of these parameters, your transcription job
|
|
3551
|
+
* fails.</p>
|
|
3526
3552
|
*/
|
|
3527
3553
|
IdentifyMultipleLanguages?: boolean;
|
|
3528
3554
|
/**
|
|
3529
3555
|
* <p>You can specify two or more language codes that represent the languages you think may
|
|
3530
|
-
* be present in your media
|
|
3531
|
-
* languages are present, do not include this parameter.</p>
|
|
3556
|
+
* be present in your media. Including more than five is not recommended. If you're unsure
|
|
3557
|
+
* what languages are present, do not include this parameter.</p>
|
|
3532
3558
|
* <p>If you include <code>LanguageOptions</code> in your request, you must also include
|
|
3533
|
-
*
|
|
3534
|
-
* <p>For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported
|
|
3559
|
+
* <code>IdentifyLanguage</code>.</p>
|
|
3560
|
+
* <p>For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported
|
|
3561
|
+
* languages</a>.</p>
|
|
3535
3562
|
* <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media file
|
|
3536
3563
|
* must be encoded at a sample rate of 16,000 Hz or higher.</p>
|
|
3537
3564
|
*/
|
|
3538
3565
|
LanguageOptions?: (LanguageCode | string)[];
|
|
3539
3566
|
/**
|
|
3540
|
-
* <p>Produces subtitle files for your input media. You can specify WebVTT (*.vtt) and
|
|
3541
|
-
* (*.srt) formats.</p>
|
|
3567
|
+
* <p>Produces subtitle files for your input media. You can specify WebVTT (*.vtt) and
|
|
3568
|
+
* SubRip (*.srt) formats.</p>
|
|
3542
3569
|
*/
|
|
3543
3570
|
Subtitles?: Subtitles;
|
|
3544
3571
|
/**
|
|
3545
|
-
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new
|
|
3546
|
-
* job at the time you start this new job.</p>
|
|
3547
|
-
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
3572
|
+
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new
|
|
3573
|
+
* transcription job at the time you start this new job.</p>
|
|
3574
|
+
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
3575
|
+
* resources</a>.</p>
|
|
3548
3576
|
*/
|
|
3549
3577
|
Tags?: Tag[];
|
|
3550
3578
|
/**
|
|
3551
|
-
* <p>If using automatic language identification
|
|
3552
|
-
*
|
|
3553
|
-
*
|
|
3554
|
-
*
|
|
3555
|
-
*
|
|
3556
|
-
*
|
|
3557
|
-
*
|
|
3558
|
-
*
|
|
3559
|
-
*
|
|
3560
|
-
*
|
|
3561
|
-
*
|
|
3562
|
-
*
|
|
3563
|
-
*
|
|
3564
|
-
*
|
|
3565
|
-
*
|
|
3566
|
-
*
|
|
3567
|
-
*
|
|
3568
|
-
*
|
|
3569
|
-
* <code>
|
|
3570
|
-
*
|
|
3571
|
-
*
|
|
3572
|
-
*
|
|
3573
|
-
*
|
|
3574
|
-
*
|
|
3579
|
+
* <p>If using automatic language identification in your request and you want to apply a
|
|
3580
|
+
* custom language model, a custom vocabulary, or a custom vocabulary filter, include
|
|
3581
|
+
* <code>LanguageIdSettings</code> with the relevant sub-parameters
|
|
3582
|
+
* (<code>VocabularyName</code>, <code>LanguageModelName</code>, and
|
|
3583
|
+
* <code>VocabularyFilterName</code>). Note that multi-language identification
|
|
3584
|
+
* (<code>IdentifyMultipleLanguages</code>) doesn't support custom language
|
|
3585
|
+
* models.</p>
|
|
3586
|
+
* <p>
|
|
3587
|
+
* <code>LanguageIdSettings</code> supports two to five language codes. Each language
|
|
3588
|
+
* code you include can have an associated custom language model, custom vocabulary, and
|
|
3589
|
+
* custom vocabulary filter. The language codes that you specify must match the languages
|
|
3590
|
+
* of the associated custom language models, custom vocabularies, and custom vocabulary
|
|
3591
|
+
* filters.</p>
|
|
3592
|
+
* <p>It's recommended that you include <code>LanguageOptions</code> when using
|
|
3593
|
+
* <code>LanguageIdSettings</code> to ensure that the correct language dialect is
|
|
3594
|
+
* identified. For example, if you specify a custom vocabulary that is in
|
|
3595
|
+
* <code>en-US</code> but Amazon Transcribe determines that the language spoken in
|
|
3596
|
+
* your media is <code>en-AU</code>, your custom vocabulary <i>is not</i>
|
|
3597
|
+
* applied to your transcription. If you include <code>LanguageOptions</code> and include
|
|
3598
|
+
* <code>en-US</code> as the only English language dialect, your custom vocabulary
|
|
3599
|
+
* <i>is</i> applied to your transcription.</p>
|
|
3600
|
+
* <p>If you want to include a custom language model with your request but <b>do not</b> want to use automatic language identification, use
|
|
3601
|
+
* instead the <code></code> parameter with the
|
|
3602
|
+
* <code>LanguageModelName</code> sub-parameter. If you want to include a custom
|
|
3603
|
+
* vocabulary or a custom vocabulary filter (or both) with your request but <b>do not</b> want to use automatic language identification, use
|
|
3604
|
+
* instead the <code></code> parameter with the
|
|
3605
|
+
* <code>VocabularyName</code> or <code>VocabularyFilterName</code> (or both)
|
|
3606
|
+
* sub-parameter.</p>
|
|
3575
3607
|
*/
|
|
3576
3608
|
LanguageIdSettings?: Record<string, LanguageIdSettings>;
|
|
3577
3609
|
}
|
|
3578
3610
|
export interface StartTranscriptionJobResponse {
|
|
3579
3611
|
/**
|
|
3580
|
-
* <p>Provides detailed information about the current transcription job, including job
|
|
3581
|
-
* and, if applicable, failure reason.</p>
|
|
3612
|
+
* <p>Provides detailed information about the current transcription job, including job
|
|
3613
|
+
* status and, if applicable, failure reason.</p>
|
|
3582
3614
|
*/
|
|
3583
3615
|
TranscriptionJob?: TranscriptionJob;
|
|
3584
3616
|
}
|
|
3585
3617
|
export interface TagResourceRequest {
|
|
3586
3618
|
/**
|
|
3587
3619
|
* <p>The Amazon Resource Name (ARN) of the resource you want to tag. ARNs have the format
|
|
3588
|
-
*
|
|
3620
|
+
* <code>arn:partition:service:region:account-id:resource-type/resource-id</code>.</p>
|
|
3589
3621
|
* <p>For example,
|
|
3590
|
-
*
|
|
3622
|
+
* <code>arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name</code>.</p>
|
|
3591
3623
|
* <p>Valid values for <code>resource-type</code> are: <code>transcription-job</code>,
|
|
3592
|
-
*
|
|
3593
|
-
*
|
|
3594
|
-
*
|
|
3624
|
+
* <code>medical-transcription-job</code>, <code>vocabulary</code>,
|
|
3625
|
+
* <code>medical-vocabulary</code>, <code>vocabulary-filter</code>, and
|
|
3626
|
+
* <code>language-model</code>.</p>
|
|
3595
3627
|
*/
|
|
3596
3628
|
ResourceArn: string | undefined;
|
|
3597
3629
|
/**
|
|
3598
3630
|
* <p>Adds one or more custom tags, each in the form of a key:value pair, to the specified
|
|
3599
3631
|
* resource.</p>
|
|
3600
|
-
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
3632
|
+
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
3633
|
+
* resources</a>.</p>
|
|
3601
3634
|
*/
|
|
3602
3635
|
Tags: Tag[] | undefined;
|
|
3603
3636
|
}
|
|
@@ -3607,13 +3640,13 @@ export interface UntagResourceRequest {
|
|
|
3607
3640
|
/**
|
|
3608
3641
|
* <p>The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove
|
|
3609
3642
|
* tags from. ARNs have the format
|
|
3610
|
-
*
|
|
3643
|
+
* <code>arn:partition:service:region:account-id:resource-type/resource-id</code>.</p>
|
|
3611
3644
|
* <p>For example,
|
|
3612
|
-
*
|
|
3645
|
+
* <code>arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name</code>.</p>
|
|
3613
3646
|
* <p>Valid values for <code>resource-type</code> are: <code>transcription-job</code>,
|
|
3614
|
-
*
|
|
3615
|
-
*
|
|
3616
|
-
*
|
|
3647
|
+
* <code>medical-transcription-job</code>, <code>vocabulary</code>,
|
|
3648
|
+
* <code>medical-vocabulary</code>, <code>vocabulary-filter</code>, and
|
|
3649
|
+
* <code>language-model</code>.</p>
|
|
3617
3650
|
*/
|
|
3618
3651
|
ResourceArn: string | undefined;
|
|
3619
3652
|
/**
|
|
@@ -3630,34 +3663,41 @@ export interface UpdateCallAnalyticsCategoryRequest {
|
|
|
3630
3663
|
*/
|
|
3631
3664
|
CategoryName: string | undefined;
|
|
3632
3665
|
/**
|
|
3633
|
-
* <p>The rules used for the updated Call Analytics category. The rules you provide in this
|
|
3634
|
-
* replace the ones that are currently being used in the specified category.</p>
|
|
3666
|
+
* <p>The rules used for the updated Call Analytics category. The rules you provide in this
|
|
3667
|
+
* field replace the ones that are currently being used in the specified category.</p>
|
|
3635
3668
|
*/
|
|
3636
3669
|
Rules: Rule[] | undefined;
|
|
3670
|
+
/**
|
|
3671
|
+
* <p>Choose whether you want to update a streaming or a batch Call Analytics category. The
|
|
3672
|
+
* input type you specify must match the input type specified when the category was created. For
|
|
3673
|
+
* example, if you created a category with the <code>POST_CALL</code> input type, you must
|
|
3674
|
+
* use <code>POST_CALL</code> as the input type when updating this category.</p>
|
|
3675
|
+
*/
|
|
3676
|
+
InputType?: InputType | string;
|
|
3637
3677
|
}
|
|
3638
3678
|
export interface UpdateCallAnalyticsCategoryResponse {
|
|
3639
3679
|
/**
|
|
3640
3680
|
* <p>Provides you with the properties of the Call Analytics category you specified in your
|
|
3641
|
-
*
|
|
3681
|
+
* <code>UpdateCallAnalyticsCategory</code> request.</p>
|
|
3642
3682
|
*/
|
|
3643
3683
|
CategoryProperties?: CategoryProperties;
|
|
3644
3684
|
}
|
|
3645
3685
|
export interface UpdateMedicalVocabularyRequest {
|
|
3646
3686
|
/**
|
|
3647
|
-
* <p>The name of the custom medical vocabulary you want to update.
|
|
3648
|
-
* case sensitive.</p>
|
|
3687
|
+
* <p>The name of the custom medical vocabulary you want to update. Custom medical
|
|
3688
|
+
* vocabulary names are case sensitive.</p>
|
|
3649
3689
|
*/
|
|
3650
3690
|
VocabularyName: string | undefined;
|
|
3651
3691
|
/**
|
|
3652
3692
|
* <p>The language code that represents the language of the entries in the custom vocabulary
|
|
3653
3693
|
* you want to update. US English (<code>en-US</code>) is the only language supported with
|
|
3654
|
-
*
|
|
3694
|
+
* Amazon Transcribe Medical.</p>
|
|
3655
3695
|
*/
|
|
3656
3696
|
LanguageCode: LanguageCode | string | undefined;
|
|
3657
3697
|
/**
|
|
3658
3698
|
* <p>The Amazon S3 location of the text file that contains your custom medical
|
|
3659
|
-
* vocabulary. The URI must be located in the same Amazon Web Services Region as the
|
|
3660
|
-
* you're calling.</p>
|
|
3699
|
+
* vocabulary. The URI must be located in the same Amazon Web Services Region as the
|
|
3700
|
+
* resource you're calling.</p>
|
|
3661
3701
|
* <p>Here's an example URI path:
|
|
3662
3702
|
* <code>s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt</code>
|
|
3663
3703
|
* </p>
|
|
@@ -3670,63 +3710,66 @@ export interface UpdateMedicalVocabularyResponse {
|
|
|
3670
3710
|
*/
|
|
3671
3711
|
VocabularyName?: string;
|
|
3672
3712
|
/**
|
|
3673
|
-
* <p>The language code you selected for your medical vocabulary. US English
|
|
3674
|
-
*
|
|
3713
|
+
* <p>The language code you selected for your custom medical vocabulary. US English
|
|
3714
|
+
* (<code>en-US</code>) is the only language supported with Amazon Transcribe
|
|
3715
|
+
* Medical.</p>
|
|
3675
3716
|
*/
|
|
3676
3717
|
LanguageCode?: LanguageCode | string;
|
|
3677
3718
|
/**
|
|
3678
3719
|
* <p>The date and time the specified custom medical vocabulary was last updated.</p>
|
|
3679
3720
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
3680
|
-
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7
|
|
3681
|
-
*
|
|
3721
|
+
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
3722
|
+
* 4, 2022.</p>
|
|
3682
3723
|
*/
|
|
3683
3724
|
LastModifiedTime?: Date;
|
|
3684
3725
|
/**
|
|
3685
3726
|
* <p>The processing state of your custom medical vocabulary. If the state is
|
|
3686
|
-
*
|
|
3687
|
-
*
|
|
3727
|
+
* <code>READY</code>, you can use the custom vocabulary in a
|
|
3728
|
+
* <code>StartMedicalTranscriptionJob</code> request.</p>
|
|
3688
3729
|
*/
|
|
3689
3730
|
VocabularyState?: VocabularyState | string;
|
|
3690
3731
|
}
|
|
3691
3732
|
export interface UpdateVocabularyRequest {
|
|
3692
3733
|
/**
|
|
3693
|
-
* <p>The name of the custom vocabulary you want to update.
|
|
3694
|
-
*
|
|
3734
|
+
* <p>The name of the custom vocabulary you want to update. Custom vocabulary names are case
|
|
3735
|
+
* sensitive.</p>
|
|
3695
3736
|
*/
|
|
3696
3737
|
VocabularyName: string | undefined;
|
|
3697
3738
|
/**
|
|
3698
3739
|
* <p>The language code that represents the language of the entries in the custom vocabulary
|
|
3699
|
-
* you want to update. Each vocabulary must contain terms in only one
|
|
3740
|
+
* you want to update. Each custom vocabulary must contain terms in only one
|
|
3741
|
+
* language.</p>
|
|
3700
3742
|
* <p>A custom vocabulary can only be used to transcribe files in the same language as the
|
|
3701
|
-
* vocabulary. For example, if you create a vocabulary using US English
|
|
3702
|
-
*
|
|
3743
|
+
* custom vocabulary. For example, if you create a custom vocabulary using US English
|
|
3744
|
+
* (<code>en-US</code>), you can only apply this custom vocabulary to files that
|
|
3745
|
+
* contain English audio.</p>
|
|
3703
3746
|
* <p>For a list of supported languages and their associated language codes, refer to the
|
|
3704
|
-
*
|
|
3705
|
-
* languages</a> table.</p>
|
|
3747
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
|
|
3706
3748
|
*/
|
|
3707
3749
|
LanguageCode: LanguageCode | string | undefined;
|
|
3708
3750
|
/**
|
|
3709
|
-
* <p>Use this parameter if you want to update your vocabulary by including all
|
|
3710
|
-
* comma-separated values, within your request. The other option for
|
|
3711
|
-
* save your entries in a text file and upload them
|
|
3712
|
-
* the location of your file using the
|
|
3751
|
+
* <p>Use this parameter if you want to update your custom vocabulary by including all
|
|
3752
|
+
* desired terms, as comma-separated values, within your request. The other option for
|
|
3753
|
+
* updating your custom vocabulary is to save your entries in a text file and upload them
|
|
3754
|
+
* to an Amazon S3 bucket, then specify the location of your file using the
|
|
3755
|
+
* <code>VocabularyFileUri</code> parameter.</p>
|
|
3713
3756
|
* <p>Note that if you include <code>Phrases</code> in your request, you cannot use
|
|
3714
|
-
*
|
|
3715
|
-
* <p>Each language has a character set that contains all allowed characters for that
|
|
3716
|
-
* language. If you use unsupported characters, your vocabulary filter
|
|
3717
|
-
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for
|
|
3718
|
-
*
|
|
3757
|
+
* <code>VocabularyFileUri</code>; you must choose one or the other.</p>
|
|
3758
|
+
* <p>Each language has a character set that contains all allowed characters for that
|
|
3759
|
+
* specific language. If you use unsupported characters, your custom vocabulary filter
|
|
3760
|
+
* request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
|
|
3761
|
+
* Vocabularies</a> to get the character set for your language.</p>
|
|
3719
3762
|
*/
|
|
3720
3763
|
Phrases?: string[];
|
|
3721
3764
|
/**
|
|
3722
|
-
* <p>The Amazon S3 location of the text file that contains your custom vocabulary.
|
|
3723
|
-
* URI must be located in the same Amazon Web Services Region as the resource you're
|
|
3765
|
+
* <p>The Amazon S3 location of the text file that contains your custom vocabulary.
|
|
3766
|
+
* The URI must be located in the same Amazon Web Services Region as the resource you're
|
|
3724
3767
|
* calling.</p>
|
|
3725
3768
|
* <p>Here's an example URI path:
|
|
3726
3769
|
* <code>s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt</code>
|
|
3727
3770
|
* </p>
|
|
3728
|
-
* <p>Note that if you include <code>VocabularyFileUri</code> in your request, you
|
|
3729
|
-
*
|
|
3771
|
+
* <p>Note that if you include <code>VocabularyFileUri</code> in your request, you cannot
|
|
3772
|
+
* use the <code>Phrases</code> flag; you must choose one or the other.</p>
|
|
3730
3773
|
*/
|
|
3731
3774
|
VocabularyFileUri?: string;
|
|
3732
3775
|
}
|
|
@@ -3740,44 +3783,45 @@ export interface UpdateVocabularyResponse {
|
|
|
3740
3783
|
*/
|
|
3741
3784
|
LanguageCode?: LanguageCode | string;
|
|
3742
3785
|
/**
|
|
3743
|
-
* <p>The date and time the specified vocabulary was last updated.</p>
|
|
3786
|
+
* <p>The date and time the specified custom vocabulary was last updated.</p>
|
|
3744
3787
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
3745
|
-
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7
|
|
3746
|
-
*
|
|
3788
|
+
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
3789
|
+
* 4, 2022.</p>
|
|
3747
3790
|
*/
|
|
3748
3791
|
LastModifiedTime?: Date;
|
|
3749
3792
|
/**
|
|
3750
|
-
* <p>The processing state of your custom vocabulary. If the state is <code>READY</code>,
|
|
3751
|
-
* can use the vocabulary in a <code>StartTranscriptionJob</code>
|
|
3793
|
+
* <p>The processing state of your custom vocabulary. If the state is <code>READY</code>,
|
|
3794
|
+
* you can use the custom vocabulary in a <code>StartTranscriptionJob</code>
|
|
3795
|
+
* request.</p>
|
|
3752
3796
|
*/
|
|
3753
3797
|
VocabularyState?: VocabularyState | string;
|
|
3754
3798
|
}
|
|
3755
3799
|
export interface UpdateVocabularyFilterRequest {
|
|
3756
3800
|
/**
|
|
3757
|
-
* <p>The name of the custom vocabulary filter you want to update.
|
|
3758
|
-
* are case sensitive.</p>
|
|
3801
|
+
* <p>The name of the custom vocabulary filter you want to update. Custom vocabulary filter
|
|
3802
|
+
* names are case sensitive.</p>
|
|
3759
3803
|
*/
|
|
3760
3804
|
VocabularyFilterName: string | undefined;
|
|
3761
3805
|
/**
|
|
3762
|
-
* <p>Use this parameter if you want to update your vocabulary filter by including
|
|
3763
|
-
* as comma-separated values, within your request. The other option for
|
|
3764
|
-
* filter is to save your entries in a text file and upload them
|
|
3765
|
-
* specify the location of your file using the
|
|
3766
|
-
*
|
|
3806
|
+
* <p>Use this parameter if you want to update your custom vocabulary filter by including
|
|
3807
|
+
* all desired terms, as comma-separated values, within your request. The other option for
|
|
3808
|
+
* updating your vocabulary filter is to save your entries in a text file and upload them
|
|
3809
|
+
* to an Amazon S3 bucket, then specify the location of your file using the
|
|
3810
|
+
* <code>VocabularyFilterFileUri</code> parameter.</p>
|
|
3767
3811
|
* <p>Note that if you include <code>Words</code> in your request, you cannot use
|
|
3768
|
-
*
|
|
3769
|
-
* <p>Each language has a character set that contains all allowed characters for that
|
|
3770
|
-
* language. If you use unsupported characters, your vocabulary filter
|
|
3771
|
-
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for
|
|
3772
|
-
*
|
|
3812
|
+
* <code>VocabularyFilterFileUri</code>; you must choose one or the other.</p>
|
|
3813
|
+
* <p>Each language has a character set that contains all allowed characters for that
|
|
3814
|
+
* specific language. If you use unsupported characters, your custom vocabulary filter
|
|
3815
|
+
* request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
|
|
3816
|
+
* Vocabularies</a> to get the character set for your language.</p>
|
|
3773
3817
|
*/
|
|
3774
3818
|
Words?: string[];
|
|
3775
3819
|
/**
|
|
3776
|
-
* <p>The Amazon S3 location of the text file that contains your custom vocabulary
|
|
3777
|
-
* terms. The URI must be located in the same Amazon Web Services Region as the
|
|
3778
|
-
* calling.</p>
|
|
3820
|
+
* <p>The Amazon S3 location of the text file that contains your custom vocabulary
|
|
3821
|
+
* filter terms. The URI must be located in the same Amazon Web Services Region as the
|
|
3822
|
+
* resource you're calling.</p>
|
|
3779
3823
|
* <p>Here's an example URI path:
|
|
3780
|
-
*
|
|
3824
|
+
* <code>s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt</code>
|
|
3781
3825
|
* </p>
|
|
3782
3826
|
* <p>Note that if you include <code>VocabularyFilterFileUri</code> in your request, you
|
|
3783
3827
|
* cannot use <code>Words</code>; you must choose one or the other.</p>
|
|
@@ -3790,14 +3834,14 @@ export interface UpdateVocabularyFilterResponse {
|
|
|
3790
3834
|
*/
|
|
3791
3835
|
VocabularyFilterName?: string;
|
|
3792
3836
|
/**
|
|
3793
|
-
* <p>The language code you selected for your vocabulary filter.</p>
|
|
3837
|
+
* <p>The language code you selected for your custom vocabulary filter.</p>
|
|
3794
3838
|
*/
|
|
3795
3839
|
LanguageCode?: LanguageCode | string;
|
|
3796
3840
|
/**
|
|
3797
|
-
* <p>The date and time the specified vocabulary filter was last updated.</p>
|
|
3841
|
+
* <p>The date and time the specified custom vocabulary filter was last updated.</p>
|
|
3798
3842
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
3799
|
-
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7
|
|
3800
|
-
*
|
|
3843
|
+
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
3844
|
+
* 4, 2022.</p>
|
|
3801
3845
|
*/
|
|
3802
3846
|
LastModifiedTime?: Date;
|
|
3803
3847
|
}
|