@aws-sdk/client-transcribe-streaming 3.534.0 → 3.535.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/TranscribeStreaming.d.ts +1 -1
- package/dist-types/TranscribeStreamingClient.d.ts +1 -1
- package/dist-types/commands/StartCallAnalyticsStreamTranscriptionCommand.d.ts +2 -1
- package/dist-types/commands/StartMedicalStreamTranscriptionCommand.d.ts +2 -1
- package/dist-types/commands/StartStreamTranscriptionCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +247 -247
- package/dist-types/ts3.4/commands/StartCallAnalyticsStreamTranscriptionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartMedicalStreamTranscriptionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartStreamTranscriptionCommand.d.ts +9 -0
- package/package.json +47 -47
|
@@ -1,44 +1,44 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { TranscribeStreamingServiceException as __BaseException } from "./TranscribeStreamingServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>Contains entities identified as personally identifiable information (PII) in your
|
|
6
5
|
* transcription output, along with various associated attributes. Examples include category,
|
|
7
6
|
* confidence score, type, stability score, and start and end times.</p>
|
|
7
|
+
* @public
|
|
8
8
|
*/
|
|
9
9
|
export interface Entity {
|
|
10
10
|
/**
|
|
11
|
-
* @public
|
|
12
11
|
* <p>The start time, in milliseconds, of the utterance that was identified as PII.</p>
|
|
12
|
+
* @public
|
|
13
13
|
*/
|
|
14
14
|
StartTime?: number;
|
|
15
15
|
/**
|
|
16
|
-
* @public
|
|
17
16
|
* <p>The end time, in milliseconds, of the utterance that was identified as PII.</p>
|
|
17
|
+
* @public
|
|
18
18
|
*/
|
|
19
19
|
EndTime?: number;
|
|
20
20
|
/**
|
|
21
|
-
* @public
|
|
22
21
|
* <p>The category of information identified. The only category is <code>PII</code>.</p>
|
|
22
|
+
* @public
|
|
23
23
|
*/
|
|
24
24
|
Category?: string;
|
|
25
25
|
/**
|
|
26
|
-
* @public
|
|
27
26
|
* <p>The type of PII identified. For example, <code>NAME</code> or
|
|
28
27
|
* <code>CREDIT_DEBIT_NUMBER</code>.</p>
|
|
28
|
+
* @public
|
|
29
29
|
*/
|
|
30
30
|
Type?: string;
|
|
31
31
|
/**
|
|
32
|
-
* @public
|
|
33
32
|
* <p>The word or words identified as PII.</p>
|
|
33
|
+
* @public
|
|
34
34
|
*/
|
|
35
35
|
Content?: string;
|
|
36
36
|
/**
|
|
37
|
-
* @public
|
|
38
37
|
* <p>The confidence score associated with the identified PII entity in your audio.</p>
|
|
39
38
|
* <p>Confidence scores are values between 0 and 1. A larger value indicates a higher
|
|
40
39
|
* probability that the identified entity correctly matches the entity spoken in your
|
|
41
40
|
* media.</p>
|
|
41
|
+
* @public
|
|
42
42
|
*/
|
|
43
43
|
Confidence?: number;
|
|
44
44
|
}
|
|
@@ -55,93 +55,93 @@ export declare const ItemType: {
|
|
|
55
55
|
*/
|
|
56
56
|
export type ItemType = (typeof ItemType)[keyof typeof ItemType];
|
|
57
57
|
/**
|
|
58
|
-
* @public
|
|
59
58
|
* <p>A word, phrase, or punctuation mark in your transcription output, along with various associated
|
|
60
59
|
* attributes, such as confidence score, type, and start and end times.</p>
|
|
60
|
+
* @public
|
|
61
61
|
*/
|
|
62
62
|
export interface Item {
|
|
63
63
|
/**
|
|
64
|
-
* @public
|
|
65
64
|
* <p>The start time, in milliseconds, of the transcribed item.</p>
|
|
65
|
+
* @public
|
|
66
66
|
*/
|
|
67
67
|
StartTime?: number;
|
|
68
68
|
/**
|
|
69
|
-
* @public
|
|
70
69
|
* <p>The end time, in milliseconds, of the transcribed item.</p>
|
|
70
|
+
* @public
|
|
71
71
|
*/
|
|
72
72
|
EndTime?: number;
|
|
73
73
|
/**
|
|
74
|
-
* @public
|
|
75
74
|
* <p>The type of item identified. Options are: <code>PRONUNCIATION</code> (spoken words) and
|
|
76
75
|
* <code>PUNCTUATION</code>.</p>
|
|
76
|
+
* @public
|
|
77
77
|
*/
|
|
78
78
|
Type?: ItemType;
|
|
79
79
|
/**
|
|
80
|
-
* @public
|
|
81
80
|
* <p>The word or punctuation that was transcribed.</p>
|
|
81
|
+
* @public
|
|
82
82
|
*/
|
|
83
83
|
Content?: string;
|
|
84
84
|
/**
|
|
85
|
-
* @public
|
|
86
85
|
* <p>Indicates whether the specified item matches a word in the vocabulary filter included in
|
|
87
86
|
* your request. If <code>true</code>, there is a vocabulary filter match.</p>
|
|
87
|
+
* @public
|
|
88
88
|
*/
|
|
89
89
|
VocabularyFilterMatch?: boolean;
|
|
90
90
|
/**
|
|
91
|
-
* @public
|
|
92
91
|
* <p>If speaker partitioning is enabled, <code>Speaker</code> labels the speaker of the
|
|
93
92
|
* specified item.</p>
|
|
93
|
+
* @public
|
|
94
94
|
*/
|
|
95
95
|
Speaker?: string;
|
|
96
96
|
/**
|
|
97
|
-
* @public
|
|
98
97
|
* <p>The confidence score associated with a word or phrase in your transcript.</p>
|
|
99
98
|
* <p>Confidence scores are values between 0 and 1. A larger value indicates a higher
|
|
100
99
|
* probability that the identified item correctly matches the item spoken in your media.</p>
|
|
100
|
+
* @public
|
|
101
101
|
*/
|
|
102
102
|
Confidence?: number;
|
|
103
103
|
/**
|
|
104
|
-
* @public
|
|
105
104
|
* <p>If partial result stabilization is enabled, <code>Stable</code> indicates whether the specified
|
|
106
105
|
* item is stable (<code>true</code>) or if it may change when the segment is complete
|
|
107
106
|
* (<code>false</code>).</p>
|
|
107
|
+
* @public
|
|
108
108
|
*/
|
|
109
109
|
Stable?: boolean;
|
|
110
110
|
}
|
|
111
111
|
/**
|
|
112
|
-
* @public
|
|
113
112
|
* <p>A list of possible alternative transcriptions for the input audio. Each alternative may contain
|
|
114
113
|
* one or more of <code>Items</code>, <code>Entities</code>, or <code>Transcript</code>.</p>
|
|
114
|
+
* @public
|
|
115
115
|
*/
|
|
116
116
|
export interface Alternative {
|
|
117
117
|
/**
|
|
118
|
-
* @public
|
|
119
118
|
* <p>Contains transcribed text.</p>
|
|
119
|
+
* @public
|
|
120
120
|
*/
|
|
121
121
|
Transcript?: string;
|
|
122
122
|
/**
|
|
123
|
-
* @public
|
|
124
123
|
* <p>Contains words, phrases, or punctuation marks in your transcription output.</p>
|
|
124
|
+
* @public
|
|
125
125
|
*/
|
|
126
126
|
Items?: Item[];
|
|
127
127
|
/**
|
|
128
|
-
* @public
|
|
129
128
|
* <p>Contains entities identified as personally identifiable information (PII) in your transcription
|
|
130
129
|
* output.</p>
|
|
130
|
+
* @public
|
|
131
131
|
*/
|
|
132
132
|
Entities?: Entity[];
|
|
133
133
|
}
|
|
134
134
|
/**
|
|
135
|
-
* @public
|
|
136
135
|
* <p>A wrapper for your audio chunks. Your audio stream consists of one or more audio
|
|
137
136
|
* events, which consist of one or more audio chunks.</p>
|
|
138
137
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html">Event stream encoding</a>.</p>
|
|
138
|
+
* @public
|
|
139
139
|
*/
|
|
140
140
|
export interface AudioEvent {
|
|
141
141
|
/**
|
|
142
|
-
* @public
|
|
143
142
|
* <p>An audio blob that contains the next part of the audio that you want to transcribe. The
|
|
144
143
|
* maximum audio chunk size is 32 KB.</p>
|
|
144
|
+
* @public
|
|
145
145
|
*/
|
|
146
146
|
AudioChunk?: Uint8Array;
|
|
147
147
|
}
|
|
@@ -158,22 +158,22 @@ export declare const ParticipantRole: {
|
|
|
158
158
|
*/
|
|
159
159
|
export type ParticipantRole = (typeof ParticipantRole)[keyof typeof ParticipantRole];
|
|
160
160
|
/**
|
|
161
|
-
* @public
|
|
162
161
|
* <p>Makes it possible to specify which speaker is on which audio channel. For example, if your
|
|
163
162
|
* agent is the first participant to speak, you would set <code>ChannelId</code> to
|
|
164
163
|
* <code>0</code> (to indicate the first channel) and <code>ParticipantRole</code> to
|
|
165
164
|
* <code>AGENT</code> (to indicate that it's the agent speaking).</p>
|
|
165
|
+
* @public
|
|
166
166
|
*/
|
|
167
167
|
export interface ChannelDefinition {
|
|
168
168
|
/**
|
|
169
|
-
* @public
|
|
170
169
|
* <p>Specify the audio channel you want to define.</p>
|
|
170
|
+
* @public
|
|
171
171
|
*/
|
|
172
172
|
ChannelId: number | undefined;
|
|
173
173
|
/**
|
|
174
|
-
* @public
|
|
175
174
|
* <p>Specify the speaker you want to define. Omitting this parameter is equivalent to
|
|
176
175
|
* specifying both participants.</p>
|
|
176
|
+
* @public
|
|
177
177
|
*/
|
|
178
178
|
ParticipantRole: ParticipantRole | undefined;
|
|
179
179
|
}
|
|
@@ -190,7 +190,6 @@ export declare const ContentRedactionOutput: {
|
|
|
190
190
|
*/
|
|
191
191
|
export type ContentRedactionOutput = (typeof ContentRedactionOutput)[keyof typeof ContentRedactionOutput];
|
|
192
192
|
/**
|
|
193
|
-
* @public
|
|
194
193
|
* <p>Allows you to specify additional settings for your streaming Call Analytics
|
|
195
194
|
* post-call request, including output locations for your redacted and unredacted
|
|
196
195
|
* transcript, which IAM role to use, and, optionally, which encryption key to
|
|
@@ -198,10 +197,10 @@ export type ContentRedactionOutput = (typeof ContentRedactionOutput)[keyof typeo
|
|
|
198
197
|
* <p>
|
|
199
198
|
* <code>ContentRedactionOutput</code>, <code>DataAccessRoleArn</code>, and
|
|
200
199
|
* <code>OutputLocation</code> are required fields.</p>
|
|
200
|
+
* @public
|
|
201
201
|
*/
|
|
202
202
|
export interface PostCallAnalyticsSettings {
|
|
203
203
|
/**
|
|
204
|
-
* @public
|
|
205
204
|
* <p>The Amazon S3 location where you want your Call Analytics post-call
|
|
206
205
|
* transcription output stored. You can use any of the following formats to specify the output
|
|
207
206
|
* location:</p>
|
|
@@ -216,10 +215,10 @@ export interface PostCallAnalyticsSettings {
|
|
|
216
215
|
* <p>s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json</p>
|
|
217
216
|
* </li>
|
|
218
217
|
* </ol>
|
|
218
|
+
* @public
|
|
219
219
|
*/
|
|
220
220
|
OutputLocation: string | undefined;
|
|
221
221
|
/**
|
|
222
|
-
* @public
|
|
223
222
|
* <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
|
|
224
223
|
* access the Amazon S3 bucket that contains your input files. If the role that you
|
|
225
224
|
* specify doesn’t have the appropriate permissions to access the specified Amazon S3
|
|
@@ -228,19 +227,19 @@ export interface PostCallAnalyticsSettings {
|
|
|
228
227
|
* <code>arn:partition:iam::account:role/role-name-with-path</code>. For example:
|
|
229
228
|
* <code>arn:aws:iam::111122223333:role/Admin</code>. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
|
|
230
229
|
* ARNs</a>.</p>
|
|
230
|
+
* @public
|
|
231
231
|
*/
|
|
232
232
|
DataAccessRoleArn: string | undefined;
|
|
233
233
|
/**
|
|
234
|
-
* @public
|
|
235
234
|
* <p>Specify whether you want only a redacted transcript or both a redacted and an unredacted
|
|
236
235
|
* transcript. If you choose redacted and unredacted, two JSON files are generated and stored in the
|
|
237
236
|
* Amazon S3 output location you specify.</p>
|
|
238
237
|
* <p>Note that to include <code>ContentRedactionOutput</code> in your request, you must
|
|
239
238
|
* enable content redaction (<code>ContentRedactionType</code>).</p>
|
|
239
|
+
* @public
|
|
240
240
|
*/
|
|
241
241
|
ContentRedactionOutput?: ContentRedactionOutput;
|
|
242
242
|
/**
|
|
243
|
-
* @public
|
|
244
243
|
* <p>The KMS key you want to use to encrypt your Call Analytics post-call
|
|
245
244
|
* output.</p>
|
|
246
245
|
* <p>If using a key located in the <b>current</b>
|
|
@@ -280,31 +279,32 @@ export interface PostCallAnalyticsSettings {
|
|
|
280
279
|
* </ol>
|
|
281
280
|
* <p>Note that the user making the request must
|
|
282
281
|
* have permission to use the specified KMS key.</p>
|
|
282
|
+
* @public
|
|
283
283
|
*/
|
|
284
284
|
OutputEncryptionKMSKeyId?: string;
|
|
285
285
|
}
|
|
286
286
|
/**
|
|
287
|
-
* @public
|
|
288
287
|
* <p>Allows you to set audio channel definitions and post-call analytics settings.</p>
|
|
288
|
+
* @public
|
|
289
289
|
*/
|
|
290
290
|
export interface ConfigurationEvent {
|
|
291
291
|
/**
|
|
292
|
-
* @public
|
|
293
292
|
* <p>Indicates which speaker is on which audio channel.</p>
|
|
293
|
+
* @public
|
|
294
294
|
*/
|
|
295
295
|
ChannelDefinitions?: ChannelDefinition[];
|
|
296
296
|
/**
|
|
297
|
-
* @public
|
|
298
297
|
* <p>Provides additional optional settings for your Call Analytics post-call request, including
|
|
299
298
|
* encryption and output locations for your redacted and unredacted transcript.</p>
|
|
299
|
+
* @public
|
|
300
300
|
*/
|
|
301
301
|
PostCallAnalyticsSettings?: PostCallAnalyticsSettings;
|
|
302
302
|
}
|
|
303
303
|
/**
|
|
304
|
-
* @public
|
|
305
304
|
* <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket
|
|
306
305
|
* data frames.</p>
|
|
307
306
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
|
|
307
|
+
* @public
|
|
308
308
|
*/
|
|
309
309
|
export type AudioStream = AudioStream.AudioEventMember | AudioStream.ConfigurationEventMember | AudioStream.$UnknownMember;
|
|
310
310
|
/**
|
|
@@ -312,10 +312,10 @@ export type AudioStream = AudioStream.AudioEventMember | AudioStream.Configurati
|
|
|
312
312
|
*/
|
|
313
313
|
export declare namespace AudioStream {
|
|
314
314
|
/**
|
|
315
|
-
* @public
|
|
316
315
|
* <p>A blob of audio from your application. Your audio stream consists of one or more audio
|
|
317
316
|
* events.</p>
|
|
318
317
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html">Event stream encoding</a>.</p>
|
|
318
|
+
* @public
|
|
319
319
|
*/
|
|
320
320
|
interface AudioEventMember {
|
|
321
321
|
AudioEvent: AudioEvent;
|
|
@@ -323,8 +323,8 @@ export declare namespace AudioStream {
|
|
|
323
323
|
$unknown?: never;
|
|
324
324
|
}
|
|
325
325
|
/**
|
|
326
|
-
* @public
|
|
327
326
|
* <p>Contains audio channel definitions and post-call analytics settings.</p>
|
|
327
|
+
* @public
|
|
328
328
|
*/
|
|
329
329
|
interface ConfigurationEventMember {
|
|
330
330
|
AudioEvent?: never;
|
|
@@ -347,11 +347,11 @@ export declare namespace AudioStream {
|
|
|
347
347
|
const visit: <T>(value: AudioStream, visitor: Visitor<T>) => T;
|
|
348
348
|
}
|
|
349
349
|
/**
|
|
350
|
-
* @public
|
|
351
350
|
* <p>One or more arguments to the <code>StartStreamTranscription</code>,
|
|
352
351
|
* <code>StartMedicalStreamTranscription</code>, or <code>StartCallAnalyticsStreamTranscription</code>
|
|
353
352
|
* operation was not valid. For example, <code>MediaEncoding</code> or <code>LanguageCode</code>
|
|
354
353
|
* used not valid values. Check the specified parameters and try your request again.</p>
|
|
354
|
+
* @public
|
|
355
355
|
*/
|
|
356
356
|
export declare class BadRequestException extends __BaseException {
|
|
357
357
|
readonly name: "BadRequestException";
|
|
@@ -363,92 +363,92 @@ export declare class BadRequestException extends __BaseException {
|
|
|
363
363
|
constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
|
|
364
364
|
}
|
|
365
365
|
/**
|
|
366
|
-
* @public
|
|
367
366
|
* <p>Contains entities identified as personally identifiable information (PII) in your
|
|
368
367
|
* transcription output, along with various associated attributes. Examples include category,
|
|
369
368
|
* confidence score, content, type, and start and end times.</p>
|
|
369
|
+
* @public
|
|
370
370
|
*/
|
|
371
371
|
export interface CallAnalyticsEntity {
|
|
372
372
|
/**
|
|
373
|
-
* @public
|
|
374
373
|
* <p>The time, in milliseconds, from the beginning of the audio stream to the start of the identified entity.</p>
|
|
374
|
+
* @public
|
|
375
375
|
*/
|
|
376
376
|
BeginOffsetMillis?: number;
|
|
377
377
|
/**
|
|
378
|
-
* @public
|
|
379
378
|
* <p>The time, in milliseconds, from the beginning of the audio stream to the end of the identified entity.</p>
|
|
379
|
+
* @public
|
|
380
380
|
*/
|
|
381
381
|
EndOffsetMillis?: number;
|
|
382
382
|
/**
|
|
383
|
-
* @public
|
|
384
383
|
* <p>The category of information identified. For example, <code>PII</code>.</p>
|
|
384
|
+
* @public
|
|
385
385
|
*/
|
|
386
386
|
Category?: string;
|
|
387
387
|
/**
|
|
388
|
-
* @public
|
|
389
388
|
* <p>The type of PII identified. For example, <code>NAME</code> or
|
|
390
389
|
* <code>CREDIT_DEBIT_NUMBER</code>.</p>
|
|
390
|
+
* @public
|
|
391
391
|
*/
|
|
392
392
|
Type?: string;
|
|
393
393
|
/**
|
|
394
|
-
* @public
|
|
395
394
|
* <p>The word or words that represent the identified entity.</p>
|
|
395
|
+
* @public
|
|
396
396
|
*/
|
|
397
397
|
Content?: string;
|
|
398
398
|
/**
|
|
399
|
-
* @public
|
|
400
399
|
* <p>The confidence score associated with the identification of an entity in your transcript.</p>
|
|
401
400
|
* <p>Confidence scores are values between 0 and 1. A larger value indicates a higher
|
|
402
401
|
* probability that the identified entity correctly matches the entity spoken in your
|
|
403
402
|
* media.</p>
|
|
403
|
+
* @public
|
|
404
404
|
*/
|
|
405
405
|
Confidence?: number;
|
|
406
406
|
}
|
|
407
407
|
/**
|
|
408
|
-
* @public
|
|
409
408
|
* <p>A word, phrase, or punctuation mark in your Call Analytics transcription output, along with various
|
|
410
409
|
* associated attributes, such as confidence score, type, and start and end times.</p>
|
|
410
|
+
* @public
|
|
411
411
|
*/
|
|
412
412
|
export interface CallAnalyticsItem {
|
|
413
413
|
/**
|
|
414
|
-
* @public
|
|
415
414
|
* <p>The time, in milliseconds, from the beginning of the audio stream to the start of the identified item.</p>
|
|
415
|
+
* @public
|
|
416
416
|
*/
|
|
417
417
|
BeginOffsetMillis?: number;
|
|
418
418
|
/**
|
|
419
|
-
* @public
|
|
420
419
|
* <p>The time, in milliseconds, from the beginning of the audio stream to the end of the identified item.</p>
|
|
420
|
+
* @public
|
|
421
421
|
*/
|
|
422
422
|
EndOffsetMillis?: number;
|
|
423
423
|
/**
|
|
424
|
-
* @public
|
|
425
424
|
* <p>The type of item identified. Options are: <code>PRONUNCIATION</code> (spoken words) and
|
|
426
425
|
* <code>PUNCTUATION</code>.</p>
|
|
426
|
+
* @public
|
|
427
427
|
*/
|
|
428
428
|
Type?: ItemType;
|
|
429
429
|
/**
|
|
430
|
-
* @public
|
|
431
430
|
* <p>The word or punctuation that was transcribed.</p>
|
|
431
|
+
* @public
|
|
432
432
|
*/
|
|
433
433
|
Content?: string;
|
|
434
434
|
/**
|
|
435
|
-
* @public
|
|
436
435
|
* <p>The confidence score associated with a word or phrase in your transcript.</p>
|
|
437
436
|
* <p>Confidence scores are values between 0 and 1. A larger value indicates a higher
|
|
438
437
|
* probability that the identified item correctly matches the item spoken in your media.</p>
|
|
438
|
+
* @public
|
|
439
439
|
*/
|
|
440
440
|
Confidence?: number;
|
|
441
441
|
/**
|
|
442
|
-
* @public
|
|
443
442
|
* <p>Indicates whether the specified item matches a word in the vocabulary filter included in
|
|
444
443
|
* your Call Analytics request. If <code>true</code>, there is a vocabulary filter match.</p>
|
|
444
|
+
* @public
|
|
445
445
|
*/
|
|
446
446
|
VocabularyFilterMatch?: boolean;
|
|
447
447
|
/**
|
|
448
|
-
* @public
|
|
449
448
|
* <p>If partial result stabilization is enabled, <code>Stable</code> indicates whether the specified
|
|
450
449
|
* item is stable (<code>true</code>) or if it may change when the segment is complete
|
|
451
450
|
* (<code>false</code>).</p>
|
|
451
|
+
* @public
|
|
452
452
|
*/
|
|
453
453
|
Stable?: boolean;
|
|
454
454
|
}
|
|
@@ -472,54 +472,54 @@ export declare const CallAnalyticsLanguageCode: {
|
|
|
472
472
|
*/
|
|
473
473
|
export type CallAnalyticsLanguageCode = (typeof CallAnalyticsLanguageCode)[keyof typeof CallAnalyticsLanguageCode];
|
|
474
474
|
/**
|
|
475
|
-
* @public
|
|
476
475
|
* <p>Contains the timestamp range (start time through end time) of a matched category.</p>
|
|
476
|
+
* @public
|
|
477
477
|
*/
|
|
478
478
|
export interface TimestampRange {
|
|
479
479
|
/**
|
|
480
|
-
* @public
|
|
481
480
|
* <p>The time, in milliseconds, from the beginning of the audio stream to the start of the category
|
|
482
481
|
* match.</p>
|
|
482
|
+
* @public
|
|
483
483
|
*/
|
|
484
484
|
BeginOffsetMillis?: number;
|
|
485
485
|
/**
|
|
486
|
-
* @public
|
|
487
486
|
* <p>The time, in milliseconds, from the beginning of the audio stream to the end of the category
|
|
488
487
|
* match.</p>
|
|
488
|
+
* @public
|
|
489
489
|
*/
|
|
490
490
|
EndOffsetMillis?: number;
|
|
491
491
|
}
|
|
492
492
|
/**
|
|
493
|
-
* @public
|
|
494
493
|
* <p>Contains the timestamps of matched categories.</p>
|
|
494
|
+
* @public
|
|
495
495
|
*/
|
|
496
496
|
export interface PointsOfInterest {
|
|
497
497
|
/**
|
|
498
|
-
* @public
|
|
499
498
|
* <p>Contains the timestamp ranges (start time through end time) of matched categories and rules.</p>
|
|
499
|
+
* @public
|
|
500
500
|
*/
|
|
501
501
|
TimestampRanges?: TimestampRange[];
|
|
502
502
|
}
|
|
503
503
|
/**
|
|
504
|
-
* @public
|
|
505
504
|
* <p>Provides information on any <code>TranscriptFilterType</code> categories that matched your
|
|
506
505
|
* transcription output. Matches are identified for each segment upon completion of that segment.</p>
|
|
506
|
+
* @public
|
|
507
507
|
*/
|
|
508
508
|
export interface CategoryEvent {
|
|
509
509
|
/**
|
|
510
|
-
* @public
|
|
511
510
|
* <p>Lists the categories that were matched in your audio segment.</p>
|
|
511
|
+
* @public
|
|
512
512
|
*/
|
|
513
513
|
MatchedCategories?: string[];
|
|
514
514
|
/**
|
|
515
|
-
* @public
|
|
516
515
|
* <p>Contains information about the matched categories, including category names and timestamps.</p>
|
|
516
|
+
* @public
|
|
517
517
|
*/
|
|
518
518
|
MatchedDetails?: Record<string, PointsOfInterest>;
|
|
519
519
|
}
|
|
520
520
|
/**
|
|
521
|
-
* @public
|
|
522
521
|
* <p>A new stream started with the same session ID. The current stream has been terminated.</p>
|
|
522
|
+
* @public
|
|
523
523
|
*/
|
|
524
524
|
export declare class ConflictException extends __BaseException {
|
|
525
525
|
readonly name: "ConflictException";
|
|
@@ -531,9 +531,9 @@ export declare class ConflictException extends __BaseException {
|
|
|
531
531
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
532
532
|
}
|
|
533
533
|
/**
|
|
534
|
-
* @public
|
|
535
534
|
* <p>A problem occurred while processing the audio. Amazon Transcribe terminated
|
|
536
535
|
* processing.</p>
|
|
536
|
+
* @public
|
|
537
537
|
*/
|
|
538
538
|
export declare class InternalFailureException extends __BaseException {
|
|
539
539
|
readonly name: "InternalFailureException";
|
|
@@ -545,9 +545,9 @@ export declare class InternalFailureException extends __BaseException {
|
|
|
545
545
|
constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
|
|
546
546
|
}
|
|
547
547
|
/**
|
|
548
|
-
* @public
|
|
549
548
|
* <p>Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length
|
|
550
549
|
* limit. Break your audio stream into smaller chunks and try your request again.</p>
|
|
550
|
+
* @public
|
|
551
551
|
*/
|
|
552
552
|
export declare class LimitExceededException extends __BaseException {
|
|
553
553
|
readonly name: "LimitExceededException";
|
|
@@ -559,8 +559,8 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
559
559
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
560
560
|
}
|
|
561
561
|
/**
|
|
562
|
-
* @public
|
|
563
562
|
* <p>The service is currently unavailable. Try your request later.</p>
|
|
563
|
+
* @public
|
|
564
564
|
*/
|
|
565
565
|
export declare class ServiceUnavailableException extends __BaseException {
|
|
566
566
|
readonly name: "ServiceUnavailableException";
|
|
@@ -572,32 +572,32 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
572
572
|
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
573
573
|
}
|
|
574
574
|
/**
|
|
575
|
-
* @public
|
|
576
575
|
* <p>Provides the location, using character count, in your transcript where a match is identified. For example,
|
|
577
576
|
* the location of an issue or a category match within a segment.</p>
|
|
577
|
+
* @public
|
|
578
578
|
*/
|
|
579
579
|
export interface CharacterOffsets {
|
|
580
580
|
/**
|
|
581
|
-
* @public
|
|
582
581
|
* <p>Provides the character count of the first character where a match is identified. For example, the first
|
|
583
582
|
* character associated with an issue or a category match in a segment transcript.</p>
|
|
583
|
+
* @public
|
|
584
584
|
*/
|
|
585
585
|
Begin?: number;
|
|
586
586
|
/**
|
|
587
|
-
* @public
|
|
588
587
|
* <p>Provides the character count of the last character where a match is identified. For example, the last
|
|
589
588
|
* character associated with an issue or a category match in a segment transcript.</p>
|
|
589
|
+
* @public
|
|
590
590
|
*/
|
|
591
591
|
End?: number;
|
|
592
592
|
}
|
|
593
593
|
/**
|
|
594
|
-
* @public
|
|
595
594
|
* <p>Lists the issues that were identified in your audio segment.</p>
|
|
595
|
+
* @public
|
|
596
596
|
*/
|
|
597
597
|
export interface IssueDetected {
|
|
598
598
|
/**
|
|
599
|
-
* @public
|
|
600
599
|
* <p>Provides the timestamps that identify when in an audio segment the specified issue occurs.</p>
|
|
600
|
+
* @public
|
|
601
601
|
*/
|
|
602
602
|
CharacterOffsets?: CharacterOffsets;
|
|
603
603
|
}
|
|
@@ -616,73 +616,73 @@ export declare const Sentiment: {
|
|
|
616
616
|
*/
|
|
617
617
|
export type Sentiment = (typeof Sentiment)[keyof typeof Sentiment];
|
|
618
618
|
/**
|
|
619
|
-
* @public
|
|
620
619
|
* <p>Contains set of transcription results from one or more audio segments, along with additional
|
|
621
620
|
* information about the parameters included in your request. For example, channel definitions, partial result
|
|
622
621
|
* stabilization, sentiment, and issue detection.</p>
|
|
622
|
+
* @public
|
|
623
623
|
*/
|
|
624
624
|
export interface UtteranceEvent {
|
|
625
625
|
/**
|
|
626
|
-
* @public
|
|
627
626
|
* <p>The unique identifier that is associated with the specified <code>UtteranceEvent</code>.</p>
|
|
627
|
+
* @public
|
|
628
628
|
*/
|
|
629
629
|
UtteranceId?: string;
|
|
630
630
|
/**
|
|
631
|
-
* @public
|
|
632
631
|
* <p>Indicates whether the segment in the <code>UtteranceEvent</code> is complete
|
|
633
632
|
* (<code>FALSE</code>) or partial (<code>TRUE</code>).</p>
|
|
633
|
+
* @public
|
|
634
634
|
*/
|
|
635
635
|
IsPartial?: boolean;
|
|
636
636
|
/**
|
|
637
|
-
* @public
|
|
638
637
|
* <p>Provides the role of the speaker for each audio channel, either <code>CUSTOMER</code> or
|
|
639
638
|
* <code>AGENT</code>.</p>
|
|
639
|
+
* @public
|
|
640
640
|
*/
|
|
641
641
|
ParticipantRole?: ParticipantRole;
|
|
642
642
|
/**
|
|
643
|
-
* @public
|
|
644
643
|
* <p>The time, in milliseconds, from the beginning of the audio stream to the start of the
|
|
645
644
|
* <code>UtteranceEvent</code>.</p>
|
|
645
|
+
* @public
|
|
646
646
|
*/
|
|
647
647
|
BeginOffsetMillis?: number;
|
|
648
648
|
/**
|
|
649
|
-
* @public
|
|
650
649
|
* <p>The time, in milliseconds, from the beginning of the audio stream to the start of the
|
|
651
650
|
* <code>UtteranceEvent</code>.</p>
|
|
651
|
+
* @public
|
|
652
652
|
*/
|
|
653
653
|
EndOffsetMillis?: number;
|
|
654
654
|
/**
|
|
655
|
-
* @public
|
|
656
655
|
* <p>Contains transcribed text.</p>
|
|
656
|
+
* @public
|
|
657
657
|
*/
|
|
658
658
|
Transcript?: string;
|
|
659
659
|
/**
|
|
660
|
-
* @public
|
|
661
660
|
* <p>Contains words, phrases, or punctuation marks that are associated with the specified
|
|
662
661
|
* <code>UtteranceEvent</code>.</p>
|
|
662
|
+
* @public
|
|
663
663
|
*/
|
|
664
664
|
Items?: CallAnalyticsItem[];
|
|
665
665
|
/**
|
|
666
|
-
* @public
|
|
667
666
|
* <p>Contains entities identified as personally identifiable information (PII) in your transcription
|
|
668
667
|
* output.</p>
|
|
668
|
+
* @public
|
|
669
669
|
*/
|
|
670
670
|
Entities?: CallAnalyticsEntity[];
|
|
671
671
|
/**
|
|
672
|
-
* @public
|
|
673
672
|
* <p>Provides the sentiment that was detected in the specified segment.</p>
|
|
673
|
+
* @public
|
|
674
674
|
*/
|
|
675
675
|
Sentiment?: Sentiment;
|
|
676
676
|
/**
|
|
677
|
-
* @public
|
|
678
677
|
* <p>Provides the issue that was detected in the specified segment.</p>
|
|
678
|
+
* @public
|
|
679
679
|
*/
|
|
680
680
|
IssuesDetected?: IssueDetected[];
|
|
681
681
|
}
|
|
682
682
|
/**
|
|
683
|
-
* @public
|
|
684
683
|
* <p>Contains detailed information about your Call Analytics streaming session. These details are
|
|
685
684
|
* provided in the <code>UtteranceEvent</code> and <code>CategoryEvent</code> objects.</p>
|
|
685
|
+
* @public
|
|
686
686
|
*/
|
|
687
687
|
export type CallAnalyticsTranscriptResultStream = CallAnalyticsTranscriptResultStream.BadRequestExceptionMember | CallAnalyticsTranscriptResultStream.CategoryEventMember | CallAnalyticsTranscriptResultStream.ConflictExceptionMember | CallAnalyticsTranscriptResultStream.InternalFailureExceptionMember | CallAnalyticsTranscriptResultStream.LimitExceededExceptionMember | CallAnalyticsTranscriptResultStream.ServiceUnavailableExceptionMember | CallAnalyticsTranscriptResultStream.UtteranceEventMember | CallAnalyticsTranscriptResultStream.$UnknownMember;
|
|
688
688
|
/**
|
|
@@ -690,10 +690,10 @@ export type CallAnalyticsTranscriptResultStream = CallAnalyticsTranscriptResultS
|
|
|
690
690
|
*/
|
|
691
691
|
export declare namespace CallAnalyticsTranscriptResultStream {
|
|
692
692
|
/**
|
|
693
|
-
* @public
|
|
694
693
|
* <p>Contains set of transcription results from one or more audio segments, along with additional
|
|
695
694
|
* information per your request parameters. This can include information relating to channel definitions,
|
|
696
695
|
* partial result stabilization, sentiment, issue detection, and other transcription-related data.</p>
|
|
696
|
+
* @public
|
|
697
697
|
*/
|
|
698
698
|
interface UtteranceEventMember {
|
|
699
699
|
UtteranceEvent: UtteranceEvent;
|
|
@@ -706,9 +706,9 @@ export declare namespace CallAnalyticsTranscriptResultStream {
|
|
|
706
706
|
$unknown?: never;
|
|
707
707
|
}
|
|
708
708
|
/**
|
|
709
|
-
* @public
|
|
710
709
|
* <p>Provides information on matched categories that were used to generate real-time supervisor
|
|
711
710
|
* alerts.</p>
|
|
711
|
+
* @public
|
|
712
712
|
*/
|
|
713
713
|
interface CategoryEventMember {
|
|
714
714
|
UtteranceEvent?: never;
|
|
@@ -721,11 +721,11 @@ export declare namespace CallAnalyticsTranscriptResultStream {
|
|
|
721
721
|
$unknown?: never;
|
|
722
722
|
}
|
|
723
723
|
/**
|
|
724
|
-
* @public
|
|
725
724
|
* <p>One or more arguments to the <code>StartStreamTranscription</code>,
|
|
726
725
|
* <code>StartMedicalStreamTranscription</code>, or <code>StartCallAnalyticsStreamTranscription</code>
|
|
727
726
|
* operation was not valid. For example, <code>MediaEncoding</code> or <code>LanguageCode</code>
|
|
728
727
|
* used not valid values. Check the specified parameters and try your request again.</p>
|
|
728
|
+
* @public
|
|
729
729
|
*/
|
|
730
730
|
interface BadRequestExceptionMember {
|
|
731
731
|
UtteranceEvent?: never;
|
|
@@ -738,9 +738,9 @@ export declare namespace CallAnalyticsTranscriptResultStream {
|
|
|
738
738
|
$unknown?: never;
|
|
739
739
|
}
|
|
740
740
|
/**
|
|
741
|
-
* @public
|
|
742
741
|
* <p>Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length
|
|
743
742
|
* limit. Break your audio stream into smaller chunks and try your request again.</p>
|
|
743
|
+
* @public
|
|
744
744
|
*/
|
|
745
745
|
interface LimitExceededExceptionMember {
|
|
746
746
|
UtteranceEvent?: never;
|
|
@@ -753,9 +753,9 @@ export declare namespace CallAnalyticsTranscriptResultStream {
|
|
|
753
753
|
$unknown?: never;
|
|
754
754
|
}
|
|
755
755
|
/**
|
|
756
|
-
* @public
|
|
757
756
|
* <p>A problem occurred while processing the audio. Amazon Transcribe terminated
|
|
758
757
|
* processing.</p>
|
|
758
|
+
* @public
|
|
759
759
|
*/
|
|
760
760
|
interface InternalFailureExceptionMember {
|
|
761
761
|
UtteranceEvent?: never;
|
|
@@ -768,8 +768,8 @@ export declare namespace CallAnalyticsTranscriptResultStream {
|
|
|
768
768
|
$unknown?: never;
|
|
769
769
|
}
|
|
770
770
|
/**
|
|
771
|
-
* @public
|
|
772
771
|
* <p>A new stream started with the same session ID. The current stream has been terminated.</p>
|
|
772
|
+
* @public
|
|
773
773
|
*/
|
|
774
774
|
interface ConflictExceptionMember {
|
|
775
775
|
UtteranceEvent?: never;
|
|
@@ -782,8 +782,8 @@ export declare namespace CallAnalyticsTranscriptResultStream {
|
|
|
782
782
|
$unknown?: never;
|
|
783
783
|
}
|
|
784
784
|
/**
|
|
785
|
-
* @public
|
|
786
785
|
* <p>The service is currently unavailable. Try your request later.</p>
|
|
786
|
+
* @public
|
|
787
787
|
*/
|
|
788
788
|
interface ServiceUnavailableExceptionMember {
|
|
789
789
|
UtteranceEvent?: never;
|
|
@@ -867,21 +867,21 @@ export declare const LanguageCode: {
|
|
|
867
867
|
*/
|
|
868
868
|
export type LanguageCode = (typeof LanguageCode)[keyof typeof LanguageCode];
|
|
869
869
|
/**
|
|
870
|
-
* @public
|
|
871
870
|
* <p>The language code that represents the language identified in your audio, including the associated
|
|
872
871
|
* confidence score. If you enabled channel identification in your request and each channel contained a
|
|
873
872
|
* different language, you will have more than one <code>LanguageWithScore</code> result.</p>
|
|
873
|
+
* @public
|
|
874
874
|
*/
|
|
875
875
|
export interface LanguageWithScore {
|
|
876
876
|
/**
|
|
877
|
-
* @public
|
|
878
877
|
* <p>The language code of the identified language.</p>
|
|
878
|
+
* @public
|
|
879
879
|
*/
|
|
880
880
|
LanguageCode?: LanguageCode;
|
|
881
881
|
/**
|
|
882
|
-
* @public
|
|
883
882
|
* <p>The confidence score associated with the identified language code. Confidence scores are values
|
|
884
883
|
* between zero and one; larger values indicate a higher confidence in the identified language.</p>
|
|
884
|
+
* @public
|
|
885
885
|
*/
|
|
886
886
|
Score?: number;
|
|
887
887
|
}
|
|
@@ -899,104 +899,104 @@ export declare const MediaEncoding: {
|
|
|
899
899
|
*/
|
|
900
900
|
export type MediaEncoding = (typeof MediaEncoding)[keyof typeof MediaEncoding];
|
|
901
901
|
/**
|
|
902
|
-
* @public
|
|
903
902
|
* <p>Contains entities identified as personal health information (PHI) in your
|
|
904
903
|
* transcription output, along with various associated attributes. Examples include
|
|
905
904
|
* category, confidence score, type, stability score, and start and end times.</p>
|
|
905
|
+
* @public
|
|
906
906
|
*/
|
|
907
907
|
export interface MedicalEntity {
|
|
908
908
|
/**
|
|
909
|
-
* @public
|
|
910
909
|
* <p>The start time, in milliseconds, of the utterance that was identified as PHI.</p>
|
|
910
|
+
* @public
|
|
911
911
|
*/
|
|
912
912
|
StartTime?: number;
|
|
913
913
|
/**
|
|
914
|
-
* @public
|
|
915
914
|
* <p>The end time, in milliseconds, of the utterance that was identified as PHI.</p>
|
|
915
|
+
* @public
|
|
916
916
|
*/
|
|
917
917
|
EndTime?: number;
|
|
918
918
|
/**
|
|
919
|
-
* @public
|
|
920
919
|
* <p>The category of information identified. The only category is <code>PHI</code>.</p>
|
|
920
|
+
* @public
|
|
921
921
|
*/
|
|
922
922
|
Category?: string;
|
|
923
923
|
/**
|
|
924
|
-
* @public
|
|
925
924
|
* <p>The word or words identified as PHI.</p>
|
|
925
|
+
* @public
|
|
926
926
|
*/
|
|
927
927
|
Content?: string;
|
|
928
928
|
/**
|
|
929
|
-
* @public
|
|
930
929
|
* <p>The confidence score associated with the identified PHI entity in your audio.</p>
|
|
931
930
|
* <p>Confidence scores are values between 0 and 1. A larger value indicates a higher
|
|
932
931
|
* probability that the identified entity correctly matches the entity spoken in your
|
|
933
932
|
* media.</p>
|
|
933
|
+
* @public
|
|
934
934
|
*/
|
|
935
935
|
Confidence?: number;
|
|
936
936
|
}
|
|
937
937
|
/**
|
|
938
|
-
* @public
|
|
939
938
|
* <p>A word, phrase, or punctuation mark in your transcription output, along with various
|
|
940
939
|
* associated attributes, such as confidence score, type, and start and end times.</p>
|
|
940
|
+
* @public
|
|
941
941
|
*/
|
|
942
942
|
export interface MedicalItem {
|
|
943
943
|
/**
|
|
944
|
-
* @public
|
|
945
944
|
* <p>The start time, in milliseconds, of the transcribed item.</p>
|
|
945
|
+
* @public
|
|
946
946
|
*/
|
|
947
947
|
StartTime?: number;
|
|
948
948
|
/**
|
|
949
|
-
* @public
|
|
950
949
|
* <p>The end time, in milliseconds, of the transcribed item.</p>
|
|
950
|
+
* @public
|
|
951
951
|
*/
|
|
952
952
|
EndTime?: number;
|
|
953
953
|
/**
|
|
954
|
-
* @public
|
|
955
954
|
* <p>The type of item identified. Options are: <code>PRONUNCIATION</code> (spoken
|
|
956
955
|
* words) and <code>PUNCTUATION</code>.</p>
|
|
956
|
+
* @public
|
|
957
957
|
*/
|
|
958
958
|
Type?: ItemType;
|
|
959
959
|
/**
|
|
960
|
-
* @public
|
|
961
960
|
* <p>The word or punctuation that was transcribed.</p>
|
|
961
|
+
* @public
|
|
962
962
|
*/
|
|
963
963
|
Content?: string;
|
|
964
964
|
/**
|
|
965
|
-
* @public
|
|
966
965
|
* <p>The confidence score associated with a word or phrase in your transcript.</p>
|
|
967
966
|
* <p>Confidence scores are values between 0 and 1. A larger value indicates a higher
|
|
968
967
|
* probability that the identified item correctly matches the item spoken in your
|
|
969
968
|
* media.</p>
|
|
969
|
+
* @public
|
|
970
970
|
*/
|
|
971
971
|
Confidence?: number;
|
|
972
972
|
/**
|
|
973
|
-
* @public
|
|
974
973
|
* <p>If speaker partitioning is enabled, <code>Speaker</code> labels the speaker of the
|
|
975
974
|
* specified item.</p>
|
|
975
|
+
* @public
|
|
976
976
|
*/
|
|
977
977
|
Speaker?: string;
|
|
978
978
|
}
|
|
979
979
|
/**
|
|
980
|
-
* @public
|
|
981
980
|
* <p>A list of possible alternative transcriptions for the input audio. Each alternative may
|
|
982
981
|
* contain one or more of <code>Items</code>, <code>Entities</code>, or
|
|
983
982
|
* <code>Transcript</code>.</p>
|
|
983
|
+
* @public
|
|
984
984
|
*/
|
|
985
985
|
export interface MedicalAlternative {
|
|
986
986
|
/**
|
|
987
|
-
* @public
|
|
988
987
|
* <p>Contains transcribed text.</p>
|
|
988
|
+
* @public
|
|
989
989
|
*/
|
|
990
990
|
Transcript?: string;
|
|
991
991
|
/**
|
|
992
|
-
* @public
|
|
993
992
|
* <p>Contains words, phrases, or punctuation marks in your transcription output.</p>
|
|
993
|
+
* @public
|
|
994
994
|
*/
|
|
995
995
|
Items?: MedicalItem[];
|
|
996
996
|
/**
|
|
997
|
-
* @public
|
|
998
997
|
* <p>Contains entities identified as personal health information (PHI) in your transcription
|
|
999
998
|
* output.</p>
|
|
999
|
+
* @public
|
|
1000
1000
|
*/
|
|
1001
1001
|
Entities?: MedicalEntity[];
|
|
1002
1002
|
}
|
|
@@ -1012,89 +1012,89 @@ export declare const MedicalContentIdentificationType: {
|
|
|
1012
1012
|
*/
|
|
1013
1013
|
export type MedicalContentIdentificationType = (typeof MedicalContentIdentificationType)[keyof typeof MedicalContentIdentificationType];
|
|
1014
1014
|
/**
|
|
1015
|
-
* @public
|
|
1016
1015
|
* <p>The <code>Result</code> associated with a
|
|
1017
1016
|
* <code></code>.</p>
|
|
1018
1017
|
* <p>Contains a set of transcription results from one or more audio segments, along with
|
|
1019
1018
|
* additional information per your request parameters. This can include information relating to
|
|
1020
1019
|
* alternative transcriptions, channel identification, partial result stabilization, language
|
|
1021
1020
|
* identification, and other transcription-related data.</p>
|
|
1021
|
+
* @public
|
|
1022
1022
|
*/
|
|
1023
1023
|
export interface MedicalResult {
|
|
1024
1024
|
/**
|
|
1025
|
-
* @public
|
|
1026
1025
|
* <p>Provides a unique identifier for the <code>Result</code>.</p>
|
|
1026
|
+
* @public
|
|
1027
1027
|
*/
|
|
1028
1028
|
ResultId?: string;
|
|
1029
1029
|
/**
|
|
1030
|
-
* @public
|
|
1031
1030
|
* <p>The start time, in milliseconds, of the <code>Result</code>.</p>
|
|
1031
|
+
* @public
|
|
1032
1032
|
*/
|
|
1033
1033
|
StartTime?: number;
|
|
1034
1034
|
/**
|
|
1035
|
-
* @public
|
|
1036
1035
|
* <p>The end time, in milliseconds, of the <code>Result</code>.</p>
|
|
1036
|
+
* @public
|
|
1037
1037
|
*/
|
|
1038
1038
|
EndTime?: number;
|
|
1039
1039
|
/**
|
|
1040
|
-
* @public
|
|
1041
1040
|
* <p>Indicates if the segment is complete.</p>
|
|
1042
1041
|
* <p>If <code>IsPartial</code> is <code>true</code>, the segment is not complete. If
|
|
1043
1042
|
* <code>IsPartial</code> is <code>false</code>, the segment is complete.</p>
|
|
1043
|
+
* @public
|
|
1044
1044
|
*/
|
|
1045
1045
|
IsPartial?: boolean;
|
|
1046
1046
|
/**
|
|
1047
|
-
* @public
|
|
1048
1047
|
* <p>A list of possible alternative transcriptions for the input audio. Each alternative may
|
|
1049
1048
|
* contain one or more of <code>Items</code>, <code>Entities</code>, or
|
|
1050
1049
|
* <code>Transcript</code>.</p>
|
|
1050
|
+
* @public
|
|
1051
1051
|
*/
|
|
1052
1052
|
Alternatives?: MedicalAlternative[];
|
|
1053
1053
|
/**
|
|
1054
|
-
* @public
|
|
1055
1054
|
* <p>Indicates the channel identified for the <code>Result</code>.</p>
|
|
1055
|
+
* @public
|
|
1056
1056
|
*/
|
|
1057
1057
|
ChannelId?: string;
|
|
1058
1058
|
}
|
|
1059
1059
|
/**
|
|
1060
|
-
* @public
|
|
1061
1060
|
* <p>The <code>MedicalTranscript</code> associated with a
|
|
1062
1061
|
* <code></code>.</p>
|
|
1063
1062
|
* <p>
|
|
1064
1063
|
* <code>MedicalTranscript</code> contains <code>Results</code>, which contains a set of
|
|
1065
1064
|
* transcription results from one or more audio segments, along with additional information per your
|
|
1066
1065
|
* request parameters.</p>
|
|
1066
|
+
* @public
|
|
1067
1067
|
*/
|
|
1068
1068
|
export interface MedicalTranscript {
|
|
1069
1069
|
/**
|
|
1070
|
-
* @public
|
|
1071
1070
|
* <p>Contains a set of transcription results from one or more audio segments, along with
|
|
1072
1071
|
* additional information per your request parameters. This can include information relating to
|
|
1073
1072
|
* alternative transcriptions, channel identification, partial result stabilization, language
|
|
1074
1073
|
* identification, and other transcription-related data.</p>
|
|
1074
|
+
* @public
|
|
1075
1075
|
*/
|
|
1076
1076
|
Results?: MedicalResult[];
|
|
1077
1077
|
}
|
|
1078
1078
|
/**
|
|
1079
|
-
* @public
|
|
1080
1079
|
* <p>The <code>MedicalTranscriptEvent</code> associated with a
|
|
1081
1080
|
* <code>MedicalTranscriptResultStream</code>.</p>
|
|
1082
1081
|
* <p>Contains a set of transcription results from one or more audio segments, along with additional
|
|
1083
1082
|
* information per your request parameters.</p>
|
|
1083
|
+
* @public
|
|
1084
1084
|
*/
|
|
1085
1085
|
export interface MedicalTranscriptEvent {
|
|
1086
1086
|
/**
|
|
1087
|
-
* @public
|
|
1088
1087
|
* <p>Contains <code>Results</code>, which contains a set of transcription results from one or
|
|
1089
1088
|
* more audio segments, along with additional information per your request parameters. This can
|
|
1090
1089
|
* include information relating to alternative transcriptions, channel identification, partial result
|
|
1091
1090
|
* stabilization, language identification, and other transcription-related data.</p>
|
|
1091
|
+
* @public
|
|
1092
1092
|
*/
|
|
1093
1093
|
Transcript?: MedicalTranscript;
|
|
1094
1094
|
}
|
|
1095
1095
|
/**
|
|
1096
|
-
* @public
|
|
1097
1096
|
* <p>Contains detailed information about your streaming session.</p>
|
|
1097
|
+
* @public
|
|
1098
1098
|
*/
|
|
1099
1099
|
export type MedicalTranscriptResultStream = MedicalTranscriptResultStream.BadRequestExceptionMember | MedicalTranscriptResultStream.ConflictExceptionMember | MedicalTranscriptResultStream.InternalFailureExceptionMember | MedicalTranscriptResultStream.LimitExceededExceptionMember | MedicalTranscriptResultStream.ServiceUnavailableExceptionMember | MedicalTranscriptResultStream.TranscriptEventMember | MedicalTranscriptResultStream.$UnknownMember;
|
|
1100
1100
|
/**
|
|
@@ -1102,13 +1102,13 @@ export type MedicalTranscriptResultStream = MedicalTranscriptResultStream.BadReq
|
|
|
1102
1102
|
*/
|
|
1103
1103
|
export declare namespace MedicalTranscriptResultStream {
|
|
1104
1104
|
/**
|
|
1105
|
-
* @public
|
|
1106
1105
|
* <p>The <code>MedicalTranscriptEvent</code> associated with a
|
|
1107
1106
|
* <code>MedicalTranscriptResultStream</code>.</p>
|
|
1108
1107
|
* <p>Contains a set of transcription results from one or more audio segments, along with
|
|
1109
1108
|
* additional information per your request parameters. This can include information relating to
|
|
1110
1109
|
* alternative transcriptions, channel identification, partial result stabilization, language
|
|
1111
1110
|
* identification, and other transcription-related data.</p>
|
|
1111
|
+
* @public
|
|
1112
1112
|
*/
|
|
1113
1113
|
interface TranscriptEventMember {
|
|
1114
1114
|
TranscriptEvent: MedicalTranscriptEvent;
|
|
@@ -1120,11 +1120,11 @@ export declare namespace MedicalTranscriptResultStream {
|
|
|
1120
1120
|
$unknown?: never;
|
|
1121
1121
|
}
|
|
1122
1122
|
/**
|
|
1123
|
-
* @public
|
|
1124
1123
|
* <p>One or more arguments to the <code>StartStreamTranscription</code>,
|
|
1125
1124
|
* <code>StartMedicalStreamTranscription</code>, or <code>StartCallAnalyticsStreamTranscription</code>
|
|
1126
1125
|
* operation was not valid. For example, <code>MediaEncoding</code> or <code>LanguageCode</code>
|
|
1127
1126
|
* used not valid values. Check the specified parameters and try your request again.</p>
|
|
1127
|
+
* @public
|
|
1128
1128
|
*/
|
|
1129
1129
|
interface BadRequestExceptionMember {
|
|
1130
1130
|
TranscriptEvent?: never;
|
|
@@ -1136,9 +1136,9 @@ export declare namespace MedicalTranscriptResultStream {
|
|
|
1136
1136
|
$unknown?: never;
|
|
1137
1137
|
}
|
|
1138
1138
|
/**
|
|
1139
|
-
* @public
|
|
1140
1139
|
* <p>Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length
|
|
1141
1140
|
* limit. Break your audio stream into smaller chunks and try your request again.</p>
|
|
1141
|
+
* @public
|
|
1142
1142
|
*/
|
|
1143
1143
|
interface LimitExceededExceptionMember {
|
|
1144
1144
|
TranscriptEvent?: never;
|
|
@@ -1150,9 +1150,9 @@ export declare namespace MedicalTranscriptResultStream {
|
|
|
1150
1150
|
$unknown?: never;
|
|
1151
1151
|
}
|
|
1152
1152
|
/**
|
|
1153
|
-
* @public
|
|
1154
1153
|
* <p>A problem occurred while processing the audio. Amazon Transcribe terminated
|
|
1155
1154
|
* processing.</p>
|
|
1155
|
+
* @public
|
|
1156
1156
|
*/
|
|
1157
1157
|
interface InternalFailureExceptionMember {
|
|
1158
1158
|
TranscriptEvent?: never;
|
|
@@ -1164,8 +1164,8 @@ export declare namespace MedicalTranscriptResultStream {
|
|
|
1164
1164
|
$unknown?: never;
|
|
1165
1165
|
}
|
|
1166
1166
|
/**
|
|
1167
|
-
* @public
|
|
1168
1167
|
* <p>A new stream started with the same session ID. The current stream has been terminated.</p>
|
|
1168
|
+
* @public
|
|
1169
1169
|
*/
|
|
1170
1170
|
interface ConflictExceptionMember {
|
|
1171
1171
|
TranscriptEvent?: never;
|
|
@@ -1177,8 +1177,8 @@ export declare namespace MedicalTranscriptResultStream {
|
|
|
1177
1177
|
$unknown?: never;
|
|
1178
1178
|
}
|
|
1179
1179
|
/**
|
|
1180
|
-
* @public
|
|
1181
1180
|
* <p>The service is currently unavailable. Try your request later.</p>
|
|
1181
|
+
* @public
|
|
1182
1182
|
*/
|
|
1183
1183
|
interface ServiceUnavailableExceptionMember {
|
|
1184
1184
|
TranscriptEvent?: never;
|
|
@@ -1226,58 +1226,58 @@ export declare const PartialResultsStability: {
|
|
|
1226
1226
|
*/
|
|
1227
1227
|
export type PartialResultsStability = (typeof PartialResultsStability)[keyof typeof PartialResultsStability];
|
|
1228
1228
|
/**
|
|
1229
|
-
* @public
|
|
1230
1229
|
* <p>The <code>Result</code> associated with a
|
|
1231
1230
|
* <code></code>.</p>
|
|
1232
1231
|
* <p>Contains a set of transcription results from one or more audio segments, along with additional
|
|
1233
1232
|
* information per your request parameters. This can include information relating to alternative
|
|
1234
1233
|
* transcriptions, channel identification, partial result stabilization, language identification, and other
|
|
1235
1234
|
* transcription-related data.</p>
|
|
1235
|
+
* @public
|
|
1236
1236
|
*/
|
|
1237
1237
|
export interface Result {
|
|
1238
1238
|
/**
|
|
1239
|
-
* @public
|
|
1240
1239
|
* <p>Provides a unique identifier for the <code>Result</code>.</p>
|
|
1240
|
+
* @public
|
|
1241
1241
|
*/
|
|
1242
1242
|
ResultId?: string;
|
|
1243
1243
|
/**
|
|
1244
|
-
* @public
|
|
1245
1244
|
* <p>The start time, in milliseconds, of the <code>Result</code>.</p>
|
|
1245
|
+
* @public
|
|
1246
1246
|
*/
|
|
1247
1247
|
StartTime?: number;
|
|
1248
1248
|
/**
|
|
1249
|
-
* @public
|
|
1250
1249
|
* <p>The end time, in milliseconds, of the <code>Result</code>.</p>
|
|
1250
|
+
* @public
|
|
1251
1251
|
*/
|
|
1252
1252
|
EndTime?: number;
|
|
1253
1253
|
/**
|
|
1254
|
-
* @public
|
|
1255
1254
|
* <p>Indicates if the segment is complete.</p>
|
|
1256
1255
|
* <p>If <code>IsPartial</code> is <code>true</code>, the segment is not complete. If
|
|
1257
1256
|
* <code>IsPartial</code> is <code>false</code>, the segment is complete.</p>
|
|
1257
|
+
* @public
|
|
1258
1258
|
*/
|
|
1259
1259
|
IsPartial?: boolean;
|
|
1260
1260
|
/**
|
|
1261
|
-
* @public
|
|
1262
1261
|
* <p>A list of possible alternative transcriptions for the input audio. Each alternative may contain
|
|
1263
1262
|
* one or more of <code>Items</code>, <code>Entities</code>, or <code>Transcript</code>.</p>
|
|
1263
|
+
* @public
|
|
1264
1264
|
*/
|
|
1265
1265
|
Alternatives?: Alternative[];
|
|
1266
1266
|
/**
|
|
1267
|
-
* @public
|
|
1268
1267
|
* <p>Indicates which audio channel is associated with the <code>Result</code>.</p>
|
|
1268
|
+
* @public
|
|
1269
1269
|
*/
|
|
1270
1270
|
ChannelId?: string;
|
|
1271
1271
|
/**
|
|
1272
|
-
* @public
|
|
1273
1272
|
* <p>The language code that represents the language spoken in your audio stream.</p>
|
|
1273
|
+
* @public
|
|
1274
1274
|
*/
|
|
1275
1275
|
LanguageCode?: LanguageCode;
|
|
1276
1276
|
/**
|
|
1277
|
-
* @public
|
|
1278
1277
|
* <p>The language code of the dominant language identified in your stream.</p>
|
|
1279
1278
|
* <p>If you enabled channel identification and each channel of your audio contains a different language,
|
|
1280
1279
|
* you may have more than one result.</p>
|
|
1280
|
+
* @public
|
|
1281
1281
|
*/
|
|
1282
1282
|
LanguageIdentification?: LanguageWithScore[];
|
|
1283
1283
|
}
|
|
@@ -1315,24 +1315,23 @@ export type VocabularyFilterMethod = (typeof VocabularyFilterMethod)[keyof typeo
|
|
|
1315
1315
|
*/
|
|
1316
1316
|
export interface StartCallAnalyticsStreamTranscriptionRequest {
|
|
1317
1317
|
/**
|
|
1318
|
-
* @public
|
|
1319
1318
|
* <p>Specify the language code that represents the language spoken in your audio.</p>
|
|
1320
1319
|
* <p>If you're unsure of the language spoken in your audio, consider using
|
|
1321
1320
|
* <code>IdentifyLanguage</code> to enable automatic language identification.</p>
|
|
1322
1321
|
* <p>For a list of languages supported with streaming Call Analytics, refer to the
|
|
1323
1322
|
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported
|
|
1324
1323
|
* languages</a> table.</p>
|
|
1324
|
+
* @public
|
|
1325
1325
|
*/
|
|
1326
1326
|
LanguageCode: CallAnalyticsLanguageCode | undefined;
|
|
1327
1327
|
/**
|
|
1328
|
-
* @public
|
|
1329
1328
|
* <p>The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio,
|
|
1330
1329
|
* is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz.
|
|
1331
1330
|
* Note that the sample rate you specify must match that of your audio.</p>
|
|
1331
|
+
* @public
|
|
1332
1332
|
*/
|
|
1333
1333
|
MediaSampleRateHertz: number | undefined;
|
|
1334
1334
|
/**
|
|
1335
|
-
* @public
|
|
1336
1335
|
* <p>Specify the encoding of your input audio. Supported formats are:</p>
|
|
1337
1336
|
* <ul>
|
|
1338
1337
|
* <li>
|
|
@@ -1346,79 +1345,79 @@ export interface StartCallAnalyticsStreamTranscriptionRequest {
|
|
|
1346
1345
|
* </li>
|
|
1347
1346
|
* </ul>
|
|
1348
1347
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a>.</p>
|
|
1348
|
+
* @public
|
|
1349
1349
|
*/
|
|
1350
1350
|
MediaEncoding: MediaEncoding | undefined;
|
|
1351
1351
|
/**
|
|
1352
|
-
* @public
|
|
1353
1352
|
* <p>Specify the name of the custom vocabulary that you want to use when processing your
|
|
1354
1353
|
* transcription. Note that vocabulary names are case sensitive.</p>
|
|
1355
1354
|
* <p>If the language of the specified custom vocabulary doesn't match the language identified in
|
|
1356
1355
|
* your media, the custom vocabulary is not applied to your transcription.</p>
|
|
1357
1356
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
|
|
1357
|
+
* @public
|
|
1358
1358
|
*/
|
|
1359
1359
|
VocabularyName?: string;
|
|
1360
1360
|
/**
|
|
1361
|
-
* @public
|
|
1362
1361
|
* <p>Specify a name for your Call Analytics transcription session. If you don't include this parameter
|
|
1363
1362
|
* in your request, Amazon Transcribe generates an ID and returns it in the response.</p>
|
|
1364
1363
|
* <p>You can use a session ID to retry a streaming session.</p>
|
|
1364
|
+
* @public
|
|
1365
1365
|
*/
|
|
1366
1366
|
SessionId?: string;
|
|
1367
1367
|
/**
|
|
1368
|
-
* @public
|
|
1369
1368
|
* <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket
|
|
1370
1369
|
* data frames.</p>
|
|
1371
1370
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
|
|
1371
|
+
* @public
|
|
1372
1372
|
*/
|
|
1373
1373
|
AudioStream: AsyncIterable<AudioStream> | undefined;
|
|
1374
1374
|
/**
|
|
1375
|
-
* @public
|
|
1376
1375
|
* <p>Specify the name of the custom vocabulary filter that you want to use when processing your
|
|
1377
1376
|
* transcription. Note that vocabulary filter names are case sensitive.</p>
|
|
1378
1377
|
* <p>If the language of the specified custom vocabulary filter doesn't match the language identified in
|
|
1379
1378
|
* your media, the vocabulary filter is not applied to your transcription.</p>
|
|
1380
1379
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html">Using vocabulary filtering with unwanted
|
|
1381
1380
|
* words</a>.</p>
|
|
1381
|
+
* @public
|
|
1382
1382
|
*/
|
|
1383
1383
|
VocabularyFilterName?: string;
|
|
1384
1384
|
/**
|
|
1385
|
-
* @public
|
|
1386
1385
|
* <p>Specify how you want your vocabulary filter applied to your transcript.</p>
|
|
1387
1386
|
* <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
|
|
1388
1387
|
* <p>To delete words, choose <code>remove</code>.</p>
|
|
1389
1388
|
* <p>To flag words without changing them, choose <code>tag</code>.</p>
|
|
1389
|
+
* @public
|
|
1390
1390
|
*/
|
|
1391
1391
|
VocabularyFilterMethod?: VocabularyFilterMethod;
|
|
1392
1392
|
/**
|
|
1393
|
-
* @public
|
|
1394
1393
|
* <p>Specify the name of the custom language model that you want to use when processing your
|
|
1395
1394
|
* transcription. Note that language model names are case sensitive.</p>
|
|
1396
1395
|
* <p>The language of the specified language model must match the language code you specify
|
|
1397
1396
|
* in your transcription request. If the languages don't match, the custom language model isn't applied.
|
|
1398
1397
|
* There are no errors or warnings associated with a language mismatch.</p>
|
|
1399
1398
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language models</a>.</p>
|
|
1399
|
+
* @public
|
|
1400
1400
|
*/
|
|
1401
1401
|
LanguageModelName?: string;
|
|
1402
1402
|
/**
|
|
1403
|
-
* @public
|
|
1404
1403
|
* <p>Enables partial result stabilization for your transcription. Partial result stabilization can reduce
|
|
1405
1404
|
* latency in your output, but may impact accuracy. For more information, see
|
|
1406
1405
|
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization">Partial-result
|
|
1407
1406
|
* stabilization</a>.</p>
|
|
1407
|
+
* @public
|
|
1408
1408
|
*/
|
|
1409
1409
|
EnablePartialResultsStabilization?: boolean;
|
|
1410
1410
|
/**
|
|
1411
|
-
* @public
|
|
1412
1411
|
* <p>Specify the level of stability to use when you enable partial results stabilization
|
|
1413
1412
|
* (<code>EnablePartialResultsStabilization</code>).</p>
|
|
1414
1413
|
* <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly
|
|
1415
1414
|
* lower accuracy.</p>
|
|
1416
1415
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization">Partial-result
|
|
1417
1416
|
* stabilization</a>.</p>
|
|
1417
|
+
* @public
|
|
1418
1418
|
*/
|
|
1419
1419
|
PartialResultsStability?: PartialResultsStability;
|
|
1420
1420
|
/**
|
|
1421
|
-
* @public
|
|
1422
1421
|
* <p>Labels all personally identifiable information (PII) identified in your transcript.</p>
|
|
1423
1422
|
* <p>Content identification is performed at the segment level; PII specified in
|
|
1424
1423
|
* <code>PiiEntityTypes</code> is flagged upon complete transcription of an audio segment.</p>
|
|
@@ -1427,10 +1426,10 @@ export interface StartCallAnalyticsStreamTranscriptionRequest {
|
|
|
1427
1426
|
* <code>BadRequestException</code>.</p>
|
|
1428
1427
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html">Redacting or identifying personally identifiable
|
|
1429
1428
|
* information</a>.</p>
|
|
1429
|
+
* @public
|
|
1430
1430
|
*/
|
|
1431
1431
|
ContentIdentificationType?: ContentIdentificationType;
|
|
1432
1432
|
/**
|
|
1433
|
-
* @public
|
|
1434
1433
|
* <p>Redacts all personally identifiable information (PII) identified in your transcript.</p>
|
|
1435
1434
|
* <p>Content redaction is performed at the segment level; PII specified in
|
|
1436
1435
|
* <code>PiiEntityTypes</code> is redacted upon complete transcription of an audio segment.</p>
|
|
@@ -1439,10 +1438,10 @@ export interface StartCallAnalyticsStreamTranscriptionRequest {
|
|
|
1439
1438
|
* <code>BadRequestException</code>.</p>
|
|
1440
1439
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html">Redacting or identifying personally identifiable
|
|
1441
1440
|
* information</a>.</p>
|
|
1441
|
+
* @public
|
|
1442
1442
|
*/
|
|
1443
1443
|
ContentRedactionType?: ContentRedactionType;
|
|
1444
1444
|
/**
|
|
1445
|
-
* @public
|
|
1446
1445
|
* <p>Specify which types of personally identifiable information (PII) you want to redact in your
|
|
1447
1446
|
* transcript. You can include as many types as you'd like, or you can select
|
|
1448
1447
|
* <code>ALL</code>.</p>
|
|
@@ -1454,6 +1453,7 @@ export interface StartCallAnalyticsStreamTranscriptionRequest {
|
|
|
1454
1453
|
* <code>CREDIT_DEBIT_EXPIRY</code>, <code>PIN</code>, <code>EMAIL</code>,
|
|
1455
1454
|
* <code>ADDRESS</code>, <code>NAME</code>, <code>PHONE</code>,
|
|
1456
1455
|
* <code>SSN</code>, or <code>ALL</code>.</p>
|
|
1456
|
+
* @public
|
|
1457
1457
|
*/
|
|
1458
1458
|
PiiEntityTypes?: string;
|
|
1459
1459
|
}
|
|
@@ -1462,80 +1462,80 @@ export interface StartCallAnalyticsStreamTranscriptionRequest {
|
|
|
1462
1462
|
*/
|
|
1463
1463
|
export interface StartCallAnalyticsStreamTranscriptionResponse {
|
|
1464
1464
|
/**
|
|
1465
|
-
* @public
|
|
1466
1465
|
* <p>Provides the identifier for your Call Analytics streaming request.</p>
|
|
1466
|
+
* @public
|
|
1467
1467
|
*/
|
|
1468
1468
|
RequestId?: string;
|
|
1469
1469
|
/**
|
|
1470
|
-
* @public
|
|
1471
1470
|
* <p>Provides the language code that you specified in your Call Analytics request.</p>
|
|
1471
|
+
* @public
|
|
1472
1472
|
*/
|
|
1473
1473
|
LanguageCode?: CallAnalyticsLanguageCode;
|
|
1474
1474
|
/**
|
|
1475
|
-
* @public
|
|
1476
1475
|
* <p>Provides the sample rate that you specified in your Call Analytics request.</p>
|
|
1476
|
+
* @public
|
|
1477
1477
|
*/
|
|
1478
1478
|
MediaSampleRateHertz?: number;
|
|
1479
1479
|
/**
|
|
1480
|
-
* @public
|
|
1481
1480
|
* <p>Provides the media encoding you specified in your Call Analytics request.</p>
|
|
1481
|
+
* @public
|
|
1482
1482
|
*/
|
|
1483
1483
|
MediaEncoding?: MediaEncoding;
|
|
1484
1484
|
/**
|
|
1485
|
-
* @public
|
|
1486
1485
|
* <p>Provides the name of the custom vocabulary that you specified in your Call Analytics request.</p>
|
|
1486
|
+
* @public
|
|
1487
1487
|
*/
|
|
1488
1488
|
VocabularyName?: string;
|
|
1489
1489
|
/**
|
|
1490
|
-
* @public
|
|
1491
1490
|
* <p>Provides the identifier for your Call Analytics transcription session.</p>
|
|
1491
|
+
* @public
|
|
1492
1492
|
*/
|
|
1493
1493
|
SessionId?: string;
|
|
1494
1494
|
/**
|
|
1495
|
-
* @public
|
|
1496
1495
|
* <p>Provides detailed information about your Call Analytics streaming session.</p>
|
|
1496
|
+
* @public
|
|
1497
1497
|
*/
|
|
1498
1498
|
CallAnalyticsTranscriptResultStream?: AsyncIterable<CallAnalyticsTranscriptResultStream>;
|
|
1499
1499
|
/**
|
|
1500
|
-
* @public
|
|
1501
1500
|
* <p>Provides the name of the custom vocabulary filter that you specified in your Call Analytics
|
|
1502
1501
|
* request.</p>
|
|
1502
|
+
* @public
|
|
1503
1503
|
*/
|
|
1504
1504
|
VocabularyFilterName?: string;
|
|
1505
1505
|
/**
|
|
1506
|
-
* @public
|
|
1507
1506
|
* <p>Provides the vocabulary filtering method used in your Call Analytics transcription.</p>
|
|
1507
|
+
* @public
|
|
1508
1508
|
*/
|
|
1509
1509
|
VocabularyFilterMethod?: VocabularyFilterMethod;
|
|
1510
1510
|
/**
|
|
1511
|
-
* @public
|
|
1512
1511
|
* <p>Provides the name of the custom language model that you specified in your Call Analytics
|
|
1513
1512
|
* request.</p>
|
|
1513
|
+
* @public
|
|
1514
1514
|
*/
|
|
1515
1515
|
LanguageModelName?: string;
|
|
1516
1516
|
/**
|
|
1517
|
-
* @public
|
|
1518
1517
|
* <p>Shows whether partial results stabilization was enabled for your Call Analytics transcription.</p>
|
|
1518
|
+
* @public
|
|
1519
1519
|
*/
|
|
1520
1520
|
EnablePartialResultsStabilization?: boolean;
|
|
1521
1521
|
/**
|
|
1522
|
-
* @public
|
|
1523
1522
|
* <p>Provides the stabilization level used for your transcription.</p>
|
|
1523
|
+
* @public
|
|
1524
1524
|
*/
|
|
1525
1525
|
PartialResultsStability?: PartialResultsStability;
|
|
1526
1526
|
/**
|
|
1527
|
-
* @public
|
|
1528
1527
|
* <p>Shows whether content identification was enabled for your Call Analytics transcription.</p>
|
|
1528
|
+
* @public
|
|
1529
1529
|
*/
|
|
1530
1530
|
ContentIdentificationType?: ContentIdentificationType;
|
|
1531
1531
|
/**
|
|
1532
|
-
* @public
|
|
1533
1532
|
* <p>Shows whether content redaction was enabled for your Call Analytics transcription.</p>
|
|
1533
|
+
* @public
|
|
1534
1534
|
*/
|
|
1535
1535
|
ContentRedactionType?: ContentRedactionType;
|
|
1536
1536
|
/**
|
|
1537
|
-
* @public
|
|
1538
1537
|
* <p>Lists the PII entity types you specified in your Call Analytics request.</p>
|
|
1538
|
+
* @public
|
|
1539
1539
|
*/
|
|
1540
1540
|
PiiEntityTypes?: string;
|
|
1541
1541
|
}
|
|
@@ -1556,22 +1556,21 @@ export type Type = (typeof Type)[keyof typeof Type];
|
|
|
1556
1556
|
*/
|
|
1557
1557
|
export interface StartMedicalStreamTranscriptionRequest {
|
|
1558
1558
|
/**
|
|
1559
|
-
* @public
|
|
1560
1559
|
* <p>Specify the language code that represents the language spoken in your audio.</p>
|
|
1561
1560
|
* <important>
|
|
1562
1561
|
* <p>Amazon Transcribe Medical only supports US English (<code>en-US</code>).</p>
|
|
1563
1562
|
* </important>
|
|
1563
|
+
* @public
|
|
1564
1564
|
*/
|
|
1565
1565
|
LanguageCode: LanguageCode | undefined;
|
|
1566
1566
|
/**
|
|
1567
|
-
* @public
|
|
1568
1567
|
* <p>The sample rate of the input audio (in hertz). Amazon Transcribe Medical supports a
|
|
1569
1568
|
* range from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that
|
|
1570
1569
|
* of your audio.</p>
|
|
1570
|
+
* @public
|
|
1571
1571
|
*/
|
|
1572
1572
|
MediaSampleRateHertz: number | undefined;
|
|
1573
1573
|
/**
|
|
1574
|
-
* @public
|
|
1575
1574
|
* <p>Specify the encoding used for the input audio. Supported formats are:</p>
|
|
1576
1575
|
* <ul>
|
|
1577
1576
|
* <li>
|
|
@@ -1586,71 +1585,72 @@ export interface StartMedicalStreamTranscriptionRequest {
|
|
|
1586
1585
|
* </li>
|
|
1587
1586
|
* </ul>
|
|
1588
1587
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a>.</p>
|
|
1588
|
+
* @public
|
|
1589
1589
|
*/
|
|
1590
1590
|
MediaEncoding: MediaEncoding | undefined;
|
|
1591
1591
|
/**
|
|
1592
|
-
* @public
|
|
1593
1592
|
* <p>Specify the name of the custom vocabulary that you want to use when processing your
|
|
1594
1593
|
* transcription. Note that vocabulary names are case sensitive.</p>
|
|
1594
|
+
* @public
|
|
1595
1595
|
*/
|
|
1596
1596
|
VocabularyName?: string;
|
|
1597
1597
|
/**
|
|
1598
|
-
* @public
|
|
1599
1598
|
* <p>Specify the medical specialty contained in your audio.</p>
|
|
1599
|
+
* @public
|
|
1600
1600
|
*/
|
|
1601
1601
|
Specialty: Specialty | undefined;
|
|
1602
1602
|
/**
|
|
1603
|
-
* @public
|
|
1604
1603
|
* <p>Specify the type of input audio. For example, choose <code>DICTATION</code> for a
|
|
1605
1604
|
* provider dictating patient notes and <code>CONVERSATION</code> for a dialogue between a
|
|
1606
1605
|
* patient and a medical professional.</p>
|
|
1606
|
+
* @public
|
|
1607
1607
|
*/
|
|
1608
1608
|
Type: Type | undefined;
|
|
1609
1609
|
/**
|
|
1610
|
-
* @public
|
|
1611
1610
|
* <p>Enables speaker partitioning (diarization) in your transcription output. Speaker
|
|
1612
1611
|
* partitioning labels the speech from individual speakers in your media file.</p>
|
|
1613
1612
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers (diarization)</a>.</p>
|
|
1613
|
+
* @public
|
|
1614
1614
|
*/
|
|
1615
1615
|
ShowSpeakerLabel?: boolean;
|
|
1616
1616
|
/**
|
|
1617
|
-
* @public
|
|
1618
1617
|
* <p>Specify a name for your transcription session. If you don't include this parameter in
|
|
1619
1618
|
* your request, Amazon Transcribe Medical generates an ID and returns it in the
|
|
1620
1619
|
* response.</p>
|
|
1621
1620
|
* <p>You can use a session ID to retry a streaming session.</p>
|
|
1621
|
+
* @public
|
|
1622
1622
|
*/
|
|
1623
1623
|
SessionId?: string;
|
|
1624
1624
|
/**
|
|
1625
|
-
* @public
|
|
1626
1625
|
* <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket
|
|
1627
1626
|
* data frames.</p>
|
|
1628
1627
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
|
|
1628
|
+
* @public
|
|
1629
1629
|
*/
|
|
1630
1630
|
AudioStream: AsyncIterable<AudioStream> | undefined;
|
|
1631
1631
|
/**
|
|
1632
|
-
* @public
|
|
1633
1632
|
* <p>Enables channel identification in multi-channel audio.</p>
|
|
1634
1633
|
* <p>Channel identification transcribes the audio on each channel independently, then appends
|
|
1635
1634
|
* the output for each channel into one transcript.</p>
|
|
1636
1635
|
* <p>If you have multi-channel audio and do not enable channel identification, your audio is
|
|
1637
1636
|
* transcribed in a continuous manner and your transcript is not separated by channel.</p>
|
|
1638
1637
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel audio</a>.</p>
|
|
1638
|
+
* @public
|
|
1639
1639
|
*/
|
|
1640
1640
|
EnableChannelIdentification?: boolean;
|
|
1641
1641
|
/**
|
|
1642
|
-
* @public
|
|
1643
1642
|
* <p>Specify the number of channels in your audio stream. Up to two channels are
|
|
1644
1643
|
* supported.</p>
|
|
1644
|
+
* @public
|
|
1645
1645
|
*/
|
|
1646
1646
|
NumberOfChannels?: number;
|
|
1647
1647
|
/**
|
|
1648
|
-
* @public
|
|
1649
1648
|
* <p>Labels all personal health information (PHI) identified in your transcript.</p>
|
|
1650
1649
|
* <p>Content identification is performed at the segment level; PHI is flagged upon complete
|
|
1651
1650
|
* transcription of an audio segment.</p>
|
|
1652
1651
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html">Identifying personal health information (PHI) in a
|
|
1653
1652
|
* transcription</a>.</p>
|
|
1653
|
+
* @public
|
|
1654
1654
|
*/
|
|
1655
1655
|
ContentIdentificationType?: MedicalContentIdentificationType;
|
|
1656
1656
|
}
|
|
@@ -1659,69 +1659,69 @@ export interface StartMedicalStreamTranscriptionRequest {
|
|
|
1659
1659
|
*/
|
|
1660
1660
|
export interface StartMedicalStreamTranscriptionResponse {
|
|
1661
1661
|
/**
|
|
1662
|
-
* @public
|
|
1663
1662
|
* <p>Provides the identifier for your streaming request.</p>
|
|
1663
|
+
* @public
|
|
1664
1664
|
*/
|
|
1665
1665
|
RequestId?: string;
|
|
1666
1666
|
/**
|
|
1667
|
-
* @public
|
|
1668
1667
|
* <p>Provides the language code that you specified in your request. This must be
|
|
1669
1668
|
* <code>en-US</code>.</p>
|
|
1669
|
+
* @public
|
|
1670
1670
|
*/
|
|
1671
1671
|
LanguageCode?: LanguageCode;
|
|
1672
1672
|
/**
|
|
1673
|
-
* @public
|
|
1674
1673
|
* <p>Provides the sample rate that you specified in your request.</p>
|
|
1674
|
+
* @public
|
|
1675
1675
|
*/
|
|
1676
1676
|
MediaSampleRateHertz?: number;
|
|
1677
1677
|
/**
|
|
1678
|
-
* @public
|
|
1679
1678
|
* <p>Provides the media encoding you specified in your request.</p>
|
|
1679
|
+
* @public
|
|
1680
1680
|
*/
|
|
1681
1681
|
MediaEncoding?: MediaEncoding;
|
|
1682
1682
|
/**
|
|
1683
|
-
* @public
|
|
1684
1683
|
* <p>Provides the name of the custom vocabulary that you specified in your request.</p>
|
|
1684
|
+
* @public
|
|
1685
1685
|
*/
|
|
1686
1686
|
VocabularyName?: string;
|
|
1687
1687
|
/**
|
|
1688
|
-
* @public
|
|
1689
1688
|
* <p>Provides the medical specialty that you specified in your request.</p>
|
|
1689
|
+
* @public
|
|
1690
1690
|
*/
|
|
1691
1691
|
Specialty?: Specialty;
|
|
1692
1692
|
/**
|
|
1693
|
-
* @public
|
|
1694
1693
|
* <p>Provides the type of audio you specified in your request.</p>
|
|
1694
|
+
* @public
|
|
1695
1695
|
*/
|
|
1696
1696
|
Type?: Type;
|
|
1697
1697
|
/**
|
|
1698
|
-
* @public
|
|
1699
1698
|
* <p>Shows whether speaker partitioning was enabled for your transcription.</p>
|
|
1699
|
+
* @public
|
|
1700
1700
|
*/
|
|
1701
1701
|
ShowSpeakerLabel?: boolean;
|
|
1702
1702
|
/**
|
|
1703
|
-
* @public
|
|
1704
1703
|
* <p>Provides the identifier for your transcription session.</p>
|
|
1704
|
+
* @public
|
|
1705
1705
|
*/
|
|
1706
1706
|
SessionId?: string;
|
|
1707
1707
|
/**
|
|
1708
|
-
* @public
|
|
1709
1708
|
* <p>Provides detailed information about your streaming session.</p>
|
|
1709
|
+
* @public
|
|
1710
1710
|
*/
|
|
1711
1711
|
TranscriptResultStream?: AsyncIterable<MedicalTranscriptResultStream>;
|
|
1712
1712
|
/**
|
|
1713
|
-
* @public
|
|
1714
1713
|
* <p>Shows whether channel identification was enabled for your transcription.</p>
|
|
1714
|
+
* @public
|
|
1715
1715
|
*/
|
|
1716
1716
|
EnableChannelIdentification?: boolean;
|
|
1717
1717
|
/**
|
|
1718
|
-
* @public
|
|
1719
1718
|
* <p>Provides the number of channels that you specified in your request.</p>
|
|
1719
|
+
* @public
|
|
1720
1720
|
*/
|
|
1721
1721
|
NumberOfChannels?: number;
|
|
1722
1722
|
/**
|
|
1723
|
-
* @public
|
|
1724
1723
|
* <p>Shows whether content identification was enabled for your transcription.</p>
|
|
1724
|
+
* @public
|
|
1725
1725
|
*/
|
|
1726
1726
|
ContentIdentificationType?: MedicalContentIdentificationType;
|
|
1727
1727
|
}
|
|
@@ -1730,24 +1730,23 @@ export interface StartMedicalStreamTranscriptionResponse {
|
|
|
1730
1730
|
*/
|
|
1731
1731
|
export interface StartStreamTranscriptionRequest {
|
|
1732
1732
|
/**
|
|
1733
|
-
* @public
|
|
1734
1733
|
* <p>Specify the language code that represents the language spoken in your audio.</p>
|
|
1735
1734
|
* <p>If you're unsure of the language spoken in your audio, consider using
|
|
1736
1735
|
* <code>IdentifyLanguage</code> to enable automatic language identification.</p>
|
|
1737
1736
|
* <p>For a list of languages supported with Amazon Transcribe streaming, refer to the
|
|
1738
1737
|
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported
|
|
1739
1738
|
* languages</a> table.</p>
|
|
1739
|
+
* @public
|
|
1740
1740
|
*/
|
|
1741
1741
|
LanguageCode?: LanguageCode;
|
|
1742
1742
|
/**
|
|
1743
|
-
* @public
|
|
1744
1743
|
* <p>The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio,
|
|
1745
1744
|
* is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz.
|
|
1746
1745
|
* Note that the sample rate you specify must match that of your audio.</p>
|
|
1746
|
+
* @public
|
|
1747
1747
|
*/
|
|
1748
1748
|
MediaSampleRateHertz: number | undefined;
|
|
1749
1749
|
/**
|
|
1750
|
-
* @public
|
|
1751
1750
|
* <p>Specify the encoding of your input audio. Supported formats are:</p>
|
|
1752
1751
|
* <ul>
|
|
1753
1752
|
* <li>
|
|
@@ -1761,10 +1760,10 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1761
1760
|
* </li>
|
|
1762
1761
|
* </ul>
|
|
1763
1762
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a>.</p>
|
|
1763
|
+
* @public
|
|
1764
1764
|
*/
|
|
1765
1765
|
MediaEncoding: MediaEncoding | undefined;
|
|
1766
1766
|
/**
|
|
1767
|
-
* @public
|
|
1768
1767
|
* <p>Specify the name of the custom vocabulary that you want to use when processing your
|
|
1769
1768
|
* transcription. Note that vocabulary names are case sensitive.</p>
|
|
1770
1769
|
* <p>If the language of the specified custom vocabulary doesn't match the language identified in
|
|
@@ -1776,24 +1775,24 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1776
1775
|
* the <code>VocabularyNames</code> parameter instead.</p>
|
|
1777
1776
|
* </important>
|
|
1778
1777
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
|
|
1778
|
+
* @public
|
|
1779
1779
|
*/
|
|
1780
1780
|
VocabularyName?: string;
|
|
1781
1781
|
/**
|
|
1782
|
-
* @public
|
|
1783
1782
|
* <p>Specify a name for your transcription session. If you don't include this parameter in your request,
|
|
1784
1783
|
* Amazon Transcribe generates an ID and returns it in the response.</p>
|
|
1785
1784
|
* <p>You can use a session ID to retry a streaming session.</p>
|
|
1785
|
+
* @public
|
|
1786
1786
|
*/
|
|
1787
1787
|
SessionId?: string;
|
|
1788
1788
|
/**
|
|
1789
|
-
* @public
|
|
1790
1789
|
* <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket
|
|
1791
1790
|
* data frames.</p>
|
|
1792
1791
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
|
|
1792
|
+
* @public
|
|
1793
1793
|
*/
|
|
1794
1794
|
AudioStream: AsyncIterable<AudioStream> | undefined;
|
|
1795
1795
|
/**
|
|
1796
|
-
* @public
|
|
1797
1796
|
* <p>Specify the name of the custom vocabulary filter that you want to use when processing your
|
|
1798
1797
|
* transcription. Note that vocabulary filter names are case sensitive.</p>
|
|
1799
1798
|
* <p>If the language of the specified custom vocabulary filter doesn't match the language identified in
|
|
@@ -1806,59 +1805,59 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1806
1805
|
* </important>
|
|
1807
1806
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html">Using vocabulary filtering with unwanted
|
|
1808
1807
|
* words</a>.</p>
|
|
1808
|
+
* @public
|
|
1809
1809
|
*/
|
|
1810
1810
|
VocabularyFilterName?: string;
|
|
1811
1811
|
/**
|
|
1812
|
-
* @public
|
|
1813
1812
|
* <p>Specify how you want your vocabulary filter applied to your transcript.</p>
|
|
1814
1813
|
* <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
|
|
1815
1814
|
* <p>To delete words, choose <code>remove</code>.</p>
|
|
1816
1815
|
* <p>To flag words without changing them, choose <code>tag</code>.</p>
|
|
1816
|
+
* @public
|
|
1817
1817
|
*/
|
|
1818
1818
|
VocabularyFilterMethod?: VocabularyFilterMethod;
|
|
1819
1819
|
/**
|
|
1820
|
-
* @public
|
|
1821
1820
|
* <p>Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning
|
|
1822
1821
|
* labels the speech from individual speakers in your media file.</p>
|
|
1823
1822
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers (diarization)</a>.</p>
|
|
1823
|
+
* @public
|
|
1824
1824
|
*/
|
|
1825
1825
|
ShowSpeakerLabel?: boolean;
|
|
1826
1826
|
/**
|
|
1827
|
-
* @public
|
|
1828
1827
|
* <p>Enables channel identification in multi-channel audio.</p>
|
|
1829
1828
|
* <p>Channel identification transcribes the audio on each channel independently, then appends the
|
|
1830
1829
|
* output for each channel into one transcript.</p>
|
|
1831
1830
|
* <p>If you have multi-channel audio and do not enable channel identification, your audio is
|
|
1832
1831
|
* transcribed in a continuous manner and your transcript is not separated by channel.</p>
|
|
1833
1832
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel audio</a>.</p>
|
|
1833
|
+
* @public
|
|
1834
1834
|
*/
|
|
1835
1835
|
EnableChannelIdentification?: boolean;
|
|
1836
1836
|
/**
|
|
1837
|
-
* @public
|
|
1838
1837
|
* <p>Specify the number of channels in your audio stream. Up to two channels are
|
|
1839
1838
|
* supported.</p>
|
|
1839
|
+
* @public
|
|
1840
1840
|
*/
|
|
1841
1841
|
NumberOfChannels?: number;
|
|
1842
1842
|
/**
|
|
1843
|
-
* @public
|
|
1844
1843
|
* <p>Enables partial result stabilization for your transcription. Partial result stabilization can reduce
|
|
1845
1844
|
* latency in your output, but may impact accuracy. For more information, see
|
|
1846
1845
|
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization">Partial-result
|
|
1847
1846
|
* stabilization</a>.</p>
|
|
1847
|
+
* @public
|
|
1848
1848
|
*/
|
|
1849
1849
|
EnablePartialResultsStabilization?: boolean;
|
|
1850
1850
|
/**
|
|
1851
|
-
* @public
|
|
1852
1851
|
* <p>Specify the level of stability to use when you enable partial results stabilization
|
|
1853
1852
|
* (<code>EnablePartialResultsStabilization</code>).</p>
|
|
1854
1853
|
* <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly
|
|
1855
1854
|
* lower accuracy.</p>
|
|
1856
1855
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization">Partial-result
|
|
1857
1856
|
* stabilization</a>.</p>
|
|
1857
|
+
* @public
|
|
1858
1858
|
*/
|
|
1859
1859
|
PartialResultsStability?: PartialResultsStability;
|
|
1860
1860
|
/**
|
|
1861
|
-
* @public
|
|
1862
1861
|
* <p>Labels all personally identifiable information (PII) identified in your transcript.</p>
|
|
1863
1862
|
* <p>Content identification is performed at the segment level; PII specified in
|
|
1864
1863
|
* <code>PiiEntityTypes</code> is flagged upon complete transcription of an audio segment.</p>
|
|
@@ -1867,10 +1866,10 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1867
1866
|
* <code>BadRequestException</code>.</p>
|
|
1868
1867
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html">Redacting or identifying personally identifiable
|
|
1869
1868
|
* information</a>.</p>
|
|
1869
|
+
* @public
|
|
1870
1870
|
*/
|
|
1871
1871
|
ContentIdentificationType?: ContentIdentificationType;
|
|
1872
1872
|
/**
|
|
1873
|
-
* @public
|
|
1874
1873
|
* <p>Redacts all personally identifiable information (PII) identified in your transcript.</p>
|
|
1875
1874
|
* <p>Content redaction is performed at the segment level; PII specified in
|
|
1876
1875
|
* <code>PiiEntityTypes</code> is redacted upon complete transcription of an audio segment.</p>
|
|
@@ -1879,10 +1878,10 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1879
1878
|
* <code>BadRequestException</code>.</p>
|
|
1880
1879
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html">Redacting or identifying personally identifiable
|
|
1881
1880
|
* information</a>.</p>
|
|
1881
|
+
* @public
|
|
1882
1882
|
*/
|
|
1883
1883
|
ContentRedactionType?: ContentRedactionType;
|
|
1884
1884
|
/**
|
|
1885
|
-
* @public
|
|
1886
1885
|
* <p>Specify which types of personally identifiable information (PII) you want to redact in your
|
|
1887
1886
|
* transcript. You can include as many types as you'd like, or you can select
|
|
1888
1887
|
* <code>ALL</code>.</p>
|
|
@@ -1894,20 +1893,20 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1894
1893
|
* <code>CREDIT_DEBIT_EXPIRY</code>, <code>PIN</code>, <code>EMAIL</code>,
|
|
1895
1894
|
* <code>ADDRESS</code>, <code>NAME</code>, <code>PHONE</code>,
|
|
1896
1895
|
* <code>SSN</code>, or <code>ALL</code>.</p>
|
|
1896
|
+
* @public
|
|
1897
1897
|
*/
|
|
1898
1898
|
PiiEntityTypes?: string;
|
|
1899
1899
|
/**
|
|
1900
|
-
* @public
|
|
1901
1900
|
* <p>Specify the name of the custom language model that you want to use when processing your
|
|
1902
1901
|
* transcription. Note that language model names are case sensitive.</p>
|
|
1903
1902
|
* <p>The language of the specified language model must match the language code you specify
|
|
1904
1903
|
* in your transcription request. If the languages don't match, the custom language model isn't applied.
|
|
1905
1904
|
* There are no errors or warnings associated with a language mismatch.</p>
|
|
1906
1905
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language models</a>.</p>
|
|
1906
|
+
* @public
|
|
1907
1907
|
*/
|
|
1908
1908
|
LanguageModelName?: string;
|
|
1909
1909
|
/**
|
|
1910
|
-
* @public
|
|
1911
1910
|
* <p>Enables automatic language identification for your transcription.</p>
|
|
1912
1911
|
* <p>If you include <code>IdentifyLanguage</code>, you can optionally include a list of
|
|
1913
1912
|
* language codes, using <code>LanguageOptions</code>, that you think may be present in
|
|
@@ -1923,10 +1922,10 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1923
1922
|
* fails.</p>
|
|
1924
1923
|
* <p>Streaming language identification can't be combined with custom language models or
|
|
1925
1924
|
* redaction.</p>
|
|
1925
|
+
* @public
|
|
1926
1926
|
*/
|
|
1927
1927
|
IdentifyLanguage?: boolean;
|
|
1928
1928
|
/**
|
|
1929
|
-
* @public
|
|
1930
1929
|
* <p>Specify two or more language codes that represent the languages you think may be present
|
|
1931
1930
|
* in your media; including more than five is not recommended. If you're unsure what languages are present, do
|
|
1932
1931
|
* not include this parameter.</p>
|
|
@@ -1940,26 +1939,26 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1940
1939
|
* <p>You can only include one language dialect per language per stream. For example, you
|
|
1941
1940
|
* cannot include <code>en-US</code> and <code>en-AU</code> in the same request.</p>
|
|
1942
1941
|
* </important>
|
|
1942
|
+
* @public
|
|
1943
1943
|
*/
|
|
1944
1944
|
LanguageOptions?: string;
|
|
1945
1945
|
/**
|
|
1946
|
-
* @public
|
|
1947
1946
|
* <p>Specify a preferred language from the subset of languages codes you specified in
|
|
1948
1947
|
* <code>LanguageOptions</code>.</p>
|
|
1949
1948
|
* <p>You can only use this parameter if you've included <code>IdentifyLanguage</code> and
|
|
1950
1949
|
* <code>LanguageOptions</code> in your request.</p>
|
|
1950
|
+
* @public
|
|
1951
1951
|
*/
|
|
1952
1952
|
PreferredLanguage?: LanguageCode;
|
|
1953
1953
|
/**
|
|
1954
|
-
* @public
|
|
1955
1954
|
* <p>Enables automatic multi-language identification in your transcription job request. Use this parameter if your stream contains more than one language. If your stream contains only one language, use IdentifyLanguage instead.</p>
|
|
1956
1955
|
* <p>If you include <code>IdentifyMultipleLanguages</code>, you can optionally include a list of language codes, using <code>LanguageOptions</code>, that you think may be present in your stream. Including <code>LanguageOptions</code> restricts <code>IdentifyMultipleLanguages</code> to only the language options that you specify, which can improve transcription accuracy.</p>
|
|
1957
1956
|
* <p>If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic multiple language identification request, include <code>VocabularyNames</code> or <code>VocabularyFilterNames</code>.</p>
|
|
1958
1957
|
* <p>Note that you must include one of <code>LanguageCode</code>, <code>IdentifyLanguage</code>, or <code>IdentifyMultipleLanguages</code> in your request. If you include more than one of these parameters, your transcription job fails.</p>
|
|
1958
|
+
* @public
|
|
1959
1959
|
*/
|
|
1960
1960
|
IdentifyMultipleLanguages?: boolean;
|
|
1961
1961
|
/**
|
|
1962
|
-
* @public
|
|
1963
1962
|
* <p>Specify the names of the custom vocabularies that you want to use when processing your
|
|
1964
1963
|
* transcription. Note that vocabulary names are case sensitive.</p>
|
|
1965
1964
|
* <p>If none of the languages of the specified custom vocabularies match the language identified in
|
|
@@ -1971,10 +1970,10 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1971
1970
|
* with your transcription, use the <code>VocabularyName</code> parameter instead.</p>
|
|
1972
1971
|
* </important>
|
|
1973
1972
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
|
|
1973
|
+
* @public
|
|
1974
1974
|
*/
|
|
1975
1975
|
VocabularyNames?: string;
|
|
1976
1976
|
/**
|
|
1977
|
-
* @public
|
|
1978
1977
|
* <p>Specify the names of the custom vocabulary filters that you want to use when processing
|
|
1979
1978
|
* your transcription. Note that vocabulary filter names are case sensitive.</p>
|
|
1980
1979
|
* <p>If none of the languages of the specified custom vocabulary filters match the language identified
|
|
@@ -1987,48 +1986,49 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1987
1986
|
* </important>
|
|
1988
1987
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html">Using vocabulary filtering with unwanted
|
|
1989
1988
|
* words</a>.</p>
|
|
1989
|
+
* @public
|
|
1990
1990
|
*/
|
|
1991
1991
|
VocabularyFilterNames?: string;
|
|
1992
1992
|
}
|
|
1993
1993
|
/**
|
|
1994
|
-
* @public
|
|
1995
1994
|
* <p>The <code>Transcript</code> associated with a
|
|
1996
1995
|
* <code></code>.</p>
|
|
1997
1996
|
* <p>
|
|
1998
1997
|
* <code>Transcript</code> contains <code>Results</code>, which contains a set of transcription
|
|
1999
1998
|
* results from one or more audio segments, along with additional information per your request
|
|
2000
1999
|
* parameters.</p>
|
|
2000
|
+
* @public
|
|
2001
2001
|
*/
|
|
2002
2002
|
export interface Transcript {
|
|
2003
2003
|
/**
|
|
2004
|
-
* @public
|
|
2005
2004
|
* <p>Contains a set of transcription results from one or more audio segments, along with additional
|
|
2006
2005
|
* information per your request parameters. This can include information relating to alternative
|
|
2007
2006
|
* transcriptions, channel identification, partial result stabilization, language identification, and other
|
|
2008
2007
|
* transcription-related data.</p>
|
|
2008
|
+
* @public
|
|
2009
2009
|
*/
|
|
2010
2010
|
Results?: Result[];
|
|
2011
2011
|
}
|
|
2012
2012
|
/**
|
|
2013
|
-
* @public
|
|
2014
2013
|
* <p>The <code>TranscriptEvent</code> associated with a
|
|
2015
2014
|
* <code>TranscriptResultStream</code>.</p>
|
|
2016
2015
|
* <p>Contains a set of transcription results from one or more audio segments, along with additional
|
|
2017
2016
|
* information per your request parameters.</p>
|
|
2017
|
+
* @public
|
|
2018
2018
|
*/
|
|
2019
2019
|
export interface TranscriptEvent {
|
|
2020
2020
|
/**
|
|
2021
|
-
* @public
|
|
2022
2021
|
* <p>Contains <code>Results</code>, which contains a set of transcription results from one or
|
|
2023
2022
|
* more audio segments, along with additional information per your request parameters. This can
|
|
2024
2023
|
* include information relating to alternative transcriptions, channel identification, partial
|
|
2025
2024
|
* result stabilization, language identification, and other transcription-related data.</p>
|
|
2025
|
+
* @public
|
|
2026
2026
|
*/
|
|
2027
2027
|
Transcript?: Transcript;
|
|
2028
2028
|
}
|
|
2029
2029
|
/**
|
|
2030
|
-
* @public
|
|
2031
2030
|
* <p>Contains detailed information about your streaming session.</p>
|
|
2031
|
+
* @public
|
|
2032
2032
|
*/
|
|
2033
2033
|
export type TranscriptResultStream = TranscriptResultStream.BadRequestExceptionMember | TranscriptResultStream.ConflictExceptionMember | TranscriptResultStream.InternalFailureExceptionMember | TranscriptResultStream.LimitExceededExceptionMember | TranscriptResultStream.ServiceUnavailableExceptionMember | TranscriptResultStream.TranscriptEventMember | TranscriptResultStream.$UnknownMember;
|
|
2034
2034
|
/**
|
|
@@ -2036,11 +2036,11 @@ export type TranscriptResultStream = TranscriptResultStream.BadRequestExceptionM
|
|
|
2036
2036
|
*/
|
|
2037
2037
|
export declare namespace TranscriptResultStream {
|
|
2038
2038
|
/**
|
|
2039
|
-
* @public
|
|
2040
2039
|
* <p>Contains <code>Transcript</code>, which contains <code>Results</code>. The
|
|
2041
2040
|
* <code></code> object contains a set of transcription
|
|
2042
2041
|
* results from one or more audio segments, along with additional information per your request
|
|
2043
2042
|
* parameters.</p>
|
|
2043
|
+
* @public
|
|
2044
2044
|
*/
|
|
2045
2045
|
interface TranscriptEventMember {
|
|
2046
2046
|
TranscriptEvent: TranscriptEvent;
|
|
@@ -2052,9 +2052,9 @@ export declare namespace TranscriptResultStream {
|
|
|
2052
2052
|
$unknown?: never;
|
|
2053
2053
|
}
|
|
2054
2054
|
/**
|
|
2055
|
-
* @public
|
|
2056
2055
|
* <p>A client error occurred when the stream was created. Check the parameters of the request
|
|
2057
2056
|
* and try your request again.</p>
|
|
2057
|
+
* @public
|
|
2058
2058
|
*/
|
|
2059
2059
|
interface BadRequestExceptionMember {
|
|
2060
2060
|
TranscriptEvent?: never;
|
|
@@ -2066,9 +2066,9 @@ export declare namespace TranscriptResultStream {
|
|
|
2066
2066
|
$unknown?: never;
|
|
2067
2067
|
}
|
|
2068
2068
|
/**
|
|
2069
|
-
* @public
|
|
2070
2069
|
* <p>Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length
|
|
2071
2070
|
* limit. Break your audio stream into smaller chunks and try your request again.</p>
|
|
2071
|
+
* @public
|
|
2072
2072
|
*/
|
|
2073
2073
|
interface LimitExceededExceptionMember {
|
|
2074
2074
|
TranscriptEvent?: never;
|
|
@@ -2080,9 +2080,9 @@ export declare namespace TranscriptResultStream {
|
|
|
2080
2080
|
$unknown?: never;
|
|
2081
2081
|
}
|
|
2082
2082
|
/**
|
|
2083
|
-
* @public
|
|
2084
2083
|
* <p>A problem occurred while processing the audio. Amazon Transcribe terminated
|
|
2085
2084
|
* processing.</p>
|
|
2085
|
+
* @public
|
|
2086
2086
|
*/
|
|
2087
2087
|
interface InternalFailureExceptionMember {
|
|
2088
2088
|
TranscriptEvent?: never;
|
|
@@ -2094,9 +2094,9 @@ export declare namespace TranscriptResultStream {
|
|
|
2094
2094
|
$unknown?: never;
|
|
2095
2095
|
}
|
|
2096
2096
|
/**
|
|
2097
|
-
* @public
|
|
2098
2097
|
* <p>A new stream started with the same session ID. The current stream has been
|
|
2099
2098
|
* terminated.</p>
|
|
2099
|
+
* @public
|
|
2100
2100
|
*/
|
|
2101
2101
|
interface ConflictExceptionMember {
|
|
2102
2102
|
TranscriptEvent?: never;
|
|
@@ -2108,8 +2108,8 @@ export declare namespace TranscriptResultStream {
|
|
|
2108
2108
|
$unknown?: never;
|
|
2109
2109
|
}
|
|
2110
2110
|
/**
|
|
2111
|
-
* @public
|
|
2112
2111
|
* <p>The service is currently unavailable. Try your request later.</p>
|
|
2112
|
+
* @public
|
|
2113
2113
|
*/
|
|
2114
2114
|
interface ServiceUnavailableExceptionMember {
|
|
2115
2115
|
TranscriptEvent?: never;
|
|
@@ -2148,126 +2148,126 @@ export declare namespace TranscriptResultStream {
|
|
|
2148
2148
|
*/
|
|
2149
2149
|
export interface StartStreamTranscriptionResponse {
|
|
2150
2150
|
/**
|
|
2151
|
-
* @public
|
|
2152
2151
|
* <p>Provides the identifier for your streaming request.</p>
|
|
2152
|
+
* @public
|
|
2153
2153
|
*/
|
|
2154
2154
|
RequestId?: string;
|
|
2155
2155
|
/**
|
|
2156
|
-
* @public
|
|
2157
2156
|
* <p>Provides the language code that you specified in your request.</p>
|
|
2157
|
+
* @public
|
|
2158
2158
|
*/
|
|
2159
2159
|
LanguageCode?: LanguageCode;
|
|
2160
2160
|
/**
|
|
2161
|
-
* @public
|
|
2162
2161
|
* <p>Provides the sample rate that you specified in your request.</p>
|
|
2162
|
+
* @public
|
|
2163
2163
|
*/
|
|
2164
2164
|
MediaSampleRateHertz?: number;
|
|
2165
2165
|
/**
|
|
2166
|
-
* @public
|
|
2167
2166
|
* <p>Provides the media encoding you specified in your request.</p>
|
|
2167
|
+
* @public
|
|
2168
2168
|
*/
|
|
2169
2169
|
MediaEncoding?: MediaEncoding;
|
|
2170
2170
|
/**
|
|
2171
|
-
* @public
|
|
2172
2171
|
* <p>Provides the name of the custom vocabulary that you specified in your request.</p>
|
|
2172
|
+
* @public
|
|
2173
2173
|
*/
|
|
2174
2174
|
VocabularyName?: string;
|
|
2175
2175
|
/**
|
|
2176
|
-
* @public
|
|
2177
2176
|
* <p>Provides the identifier for your transcription session.</p>
|
|
2177
|
+
* @public
|
|
2178
2178
|
*/
|
|
2179
2179
|
SessionId?: string;
|
|
2180
2180
|
/**
|
|
2181
|
-
* @public
|
|
2182
2181
|
* <p>Provides detailed information about your streaming session.</p>
|
|
2182
|
+
* @public
|
|
2183
2183
|
*/
|
|
2184
2184
|
TranscriptResultStream?: AsyncIterable<TranscriptResultStream>;
|
|
2185
2185
|
/**
|
|
2186
|
-
* @public
|
|
2187
2186
|
* <p>Provides the name of the custom vocabulary filter that you specified in your
|
|
2188
2187
|
* request.</p>
|
|
2188
|
+
* @public
|
|
2189
2189
|
*/
|
|
2190
2190
|
VocabularyFilterName?: string;
|
|
2191
2191
|
/**
|
|
2192
|
-
* @public
|
|
2193
2192
|
* <p>Provides the vocabulary filtering method used in your transcription.</p>
|
|
2193
|
+
* @public
|
|
2194
2194
|
*/
|
|
2195
2195
|
VocabularyFilterMethod?: VocabularyFilterMethod;
|
|
2196
2196
|
/**
|
|
2197
|
-
* @public
|
|
2198
2197
|
* <p>Shows whether speaker partitioning was enabled for your transcription.</p>
|
|
2198
|
+
* @public
|
|
2199
2199
|
*/
|
|
2200
2200
|
ShowSpeakerLabel?: boolean;
|
|
2201
2201
|
/**
|
|
2202
|
-
* @public
|
|
2203
2202
|
* <p>Shows whether channel identification was enabled for your transcription.</p>
|
|
2203
|
+
* @public
|
|
2204
2204
|
*/
|
|
2205
2205
|
EnableChannelIdentification?: boolean;
|
|
2206
2206
|
/**
|
|
2207
|
-
* @public
|
|
2208
2207
|
* <p>Provides the number of channels that you specified in your request.</p>
|
|
2208
|
+
* @public
|
|
2209
2209
|
*/
|
|
2210
2210
|
NumberOfChannels?: number;
|
|
2211
2211
|
/**
|
|
2212
|
-
* @public
|
|
2213
2212
|
* <p>Shows whether partial results stabilization was enabled for your transcription.</p>
|
|
2213
|
+
* @public
|
|
2214
2214
|
*/
|
|
2215
2215
|
EnablePartialResultsStabilization?: boolean;
|
|
2216
2216
|
/**
|
|
2217
|
-
* @public
|
|
2218
2217
|
* <p>Provides the stabilization level used for your transcription.</p>
|
|
2218
|
+
* @public
|
|
2219
2219
|
*/
|
|
2220
2220
|
PartialResultsStability?: PartialResultsStability;
|
|
2221
2221
|
/**
|
|
2222
|
-
* @public
|
|
2223
2222
|
* <p>Shows whether content identification was enabled for your transcription.</p>
|
|
2223
|
+
* @public
|
|
2224
2224
|
*/
|
|
2225
2225
|
ContentIdentificationType?: ContentIdentificationType;
|
|
2226
2226
|
/**
|
|
2227
|
-
* @public
|
|
2228
2227
|
* <p>Shows whether content redaction was enabled for your transcription.</p>
|
|
2228
|
+
* @public
|
|
2229
2229
|
*/
|
|
2230
2230
|
ContentRedactionType?: ContentRedactionType;
|
|
2231
2231
|
/**
|
|
2232
|
-
* @public
|
|
2233
2232
|
* <p>Lists the PII entity types you specified in your request.</p>
|
|
2233
|
+
* @public
|
|
2234
2234
|
*/
|
|
2235
2235
|
PiiEntityTypes?: string;
|
|
2236
2236
|
/**
|
|
2237
|
-
* @public
|
|
2238
2237
|
* <p>Provides the name of the custom language model that you specified in your request.</p>
|
|
2238
|
+
* @public
|
|
2239
2239
|
*/
|
|
2240
2240
|
LanguageModelName?: string;
|
|
2241
2241
|
/**
|
|
2242
|
-
* @public
|
|
2243
2242
|
* <p>Shows whether automatic language identification was enabled for your
|
|
2244
2243
|
* transcription.</p>
|
|
2244
|
+
* @public
|
|
2245
2245
|
*/
|
|
2246
2246
|
IdentifyLanguage?: boolean;
|
|
2247
2247
|
/**
|
|
2248
|
-
* @public
|
|
2249
2248
|
* <p>Provides the language codes that you specified in your request.</p>
|
|
2249
|
+
* @public
|
|
2250
2250
|
*/
|
|
2251
2251
|
LanguageOptions?: string;
|
|
2252
2252
|
/**
|
|
2253
|
-
* @public
|
|
2254
2253
|
* <p>Provides the preferred language that you specified in your request.</p>
|
|
2254
|
+
* @public
|
|
2255
2255
|
*/
|
|
2256
2256
|
PreferredLanguage?: LanguageCode;
|
|
2257
2257
|
/**
|
|
2258
|
-
* @public
|
|
2259
2258
|
* <p>Shows whether automatic multi-language identification was enabled for your transcription.</p>
|
|
2259
|
+
* @public
|
|
2260
2260
|
*/
|
|
2261
2261
|
IdentifyMultipleLanguages?: boolean;
|
|
2262
2262
|
/**
|
|
2263
|
-
* @public
|
|
2264
2263
|
* <p>Provides the names of the custom vocabularies that you specified in your request.</p>
|
|
2264
|
+
* @public
|
|
2265
2265
|
*/
|
|
2266
2266
|
VocabularyNames?: string;
|
|
2267
2267
|
/**
|
|
2268
|
-
* @public
|
|
2269
2268
|
* <p>Provides the names of the custom vocabulary filters that you specified in your
|
|
2270
2269
|
* request.</p>
|
|
2270
|
+
* @public
|
|
2271
2271
|
*/
|
|
2272
2272
|
VocabularyFilterNames?: string;
|
|
2273
2273
|
}
|