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