@aws-sdk/client-transcribe-streaming 3.202.0 → 3.207.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-cjs/models/models_0.js +2 -0
- package/dist-cjs/runtimeConfig.browser.js +0 -3
- package/dist-cjs/runtimeConfig.js +0 -3
- package/dist-cjs/runtimeConfig.shared.js +3 -0
- package/dist-es/models/models_0.js +2 -0
- package/dist-es/runtimeConfig.browser.js +0 -3
- package/dist-es/runtimeConfig.js +0 -3
- package/dist-es/runtimeConfig.shared.js +3 -0
- package/dist-types/TranscribeStreaming.d.ts +30 -11
- package/dist-types/TranscribeStreamingClient.d.ts +16 -1
- package/dist-types/commands/StartMedicalStreamTranscriptionCommand.d.ts +6 -2
- package/dist-types/commands/StartStreamTranscriptionCommand.d.ts +8 -8
- package/dist-types/models/models_0.d.ts +439 -325
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +2 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -0
- package/package.json +5 -4
- package/CHANGELOG.md +0 -4256
|
@@ -1,31 +1,37 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { TranscribeStreamingServiceException as __BaseException } from "./TranscribeStreamingServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* <p>
|
|
4
|
+
* <p>Contains entities identified as personally identifiable information (PII) in your
|
|
5
|
+
* transcription output, along with various associated attributes. Examples include category,
|
|
6
|
+
* confidence score, type, stability score, and start and end times.</p>
|
|
5
7
|
*/
|
|
6
8
|
export interface Entity {
|
|
7
9
|
/**
|
|
8
|
-
* <p>The start time of
|
|
10
|
+
* <p>The start time, in milliseconds, of the utterance that was identified as PII.</p>
|
|
9
11
|
*/
|
|
10
12
|
StartTime?: number;
|
|
11
13
|
/**
|
|
12
|
-
* <p>The end time of
|
|
14
|
+
* <p>The end time, in milliseconds, of the utterance that was identified as PII.</p>
|
|
13
15
|
*/
|
|
14
16
|
EndTime?: number;
|
|
15
17
|
/**
|
|
16
|
-
* <p>The category of information identified
|
|
18
|
+
* <p>The category of information identified. The only category is <code>PII</code>.</p>
|
|
17
19
|
*/
|
|
18
20
|
Category?: string;
|
|
19
21
|
/**
|
|
20
|
-
* <p>The type of PII identified
|
|
22
|
+
* <p>The type of PII identified. For example, <code>NAME</code> or
|
|
23
|
+
* <code>CREDIT_DEBIT_NUMBER</code>.</p>
|
|
21
24
|
*/
|
|
22
25
|
Type?: string;
|
|
23
26
|
/**
|
|
24
|
-
* <p>The
|
|
27
|
+
* <p>The word or words identified as PII.</p>
|
|
25
28
|
*/
|
|
26
29
|
Content?: string;
|
|
27
30
|
/**
|
|
28
|
-
* <p>
|
|
31
|
+
* <p>The confidence score associated with the identified PII entity in your audio.</p>
|
|
32
|
+
* <p>Confidence scores are values between 0 and 1. A larger value indicates a higher
|
|
33
|
+
* probability that the identified entity correctly matches the entity spoken in your
|
|
34
|
+
* media.</p>
|
|
29
35
|
*/
|
|
30
36
|
Confidence?: number;
|
|
31
37
|
}
|
|
@@ -34,74 +40,73 @@ export declare enum ItemType {
|
|
|
34
40
|
PUNCTUATION = "punctuation"
|
|
35
41
|
}
|
|
36
42
|
/**
|
|
37
|
-
* <p>A word, phrase, or punctuation mark
|
|
43
|
+
* <p>A word, phrase, or punctuation mark in your transcription output, along with various associated
|
|
44
|
+
* attributes, such as confidence score, type, and start and end times.</p>
|
|
38
45
|
*/
|
|
39
46
|
export interface Item {
|
|
40
47
|
/**
|
|
41
|
-
* <p>The
|
|
42
|
-
* resulted in the item.</p>
|
|
48
|
+
* <p>The start time, in milliseconds, of the transcribed item.</p>
|
|
43
49
|
*/
|
|
44
50
|
StartTime?: number;
|
|
45
51
|
/**
|
|
46
|
-
* <p>The
|
|
47
|
-
* the item.</p>
|
|
52
|
+
* <p>The end time, in milliseconds, of the transcribed item.</p>
|
|
48
53
|
*/
|
|
49
54
|
EndTime?: number;
|
|
50
55
|
/**
|
|
51
|
-
* <p>The type of
|
|
52
|
-
*
|
|
53
|
-
* was interpreted as a pause in the input audio.</p>
|
|
56
|
+
* <p>The type of item identified. Options are: <code>PRONUNCIATION</code> (spoken words) and
|
|
57
|
+
* <code>PUNCTUATION</code>.</p>
|
|
54
58
|
*/
|
|
55
59
|
Type?: ItemType | string;
|
|
56
60
|
/**
|
|
57
|
-
* <p>The word or punctuation that was
|
|
61
|
+
* <p>The word or punctuation that was transcribed.</p>
|
|
58
62
|
*/
|
|
59
63
|
Content?: string;
|
|
60
64
|
/**
|
|
61
|
-
* <p>Indicates whether
|
|
62
|
-
*
|
|
63
|
-
* vocabulary filter.</p>
|
|
65
|
+
* <p>Indicates whether the specified item matches a word in the vocabulary filter included in
|
|
66
|
+
* your request. If <code>true</code>, there is a vocabulary filter match.</p>
|
|
64
67
|
*/
|
|
65
68
|
VocabularyFilterMatch?: boolean;
|
|
66
69
|
/**
|
|
67
|
-
* <p>If speaker
|
|
68
|
-
*
|
|
70
|
+
* <p>If speaker partitioning is enabled, <code>Speaker</code> labels the speaker of the
|
|
71
|
+
* specified item.</p>
|
|
69
72
|
*/
|
|
70
73
|
Speaker?: string;
|
|
71
74
|
/**
|
|
72
|
-
* <p>
|
|
73
|
-
*
|
|
75
|
+
* <p>The confidence score associated with a word or phrase in your transcript.</p>
|
|
76
|
+
* <p>Confidence scores are values between 0 and 1. A larger value indicates a higher
|
|
77
|
+
* probability that the identified item correctly matches the item spoken in your media.</p>
|
|
74
78
|
*/
|
|
75
79
|
Confidence?: number;
|
|
76
80
|
/**
|
|
77
|
-
* <p>If partial result stabilization
|
|
78
|
-
*
|
|
81
|
+
* <p>If partial result stabilization is enabled, <code>Stable</code> indicates whether the specified
|
|
82
|
+
* item is stable (<code>true</code>) or if it may change when the segment is complete
|
|
83
|
+
* (<code>false</code>).</p>
|
|
79
84
|
*/
|
|
80
85
|
Stable?: boolean;
|
|
81
86
|
}
|
|
82
87
|
/**
|
|
83
|
-
* <p>A list of possible transcriptions for the audio
|
|
88
|
+
* <p>A list of possible alternative transcriptions for the input audio. Each alternative may contain
|
|
89
|
+
* one or more of <code>Items</code>, <code>Entities</code>, or <code>Transcript</code>.</p>
|
|
84
90
|
*/
|
|
85
91
|
export interface Alternative {
|
|
86
92
|
/**
|
|
87
|
-
* <p>
|
|
93
|
+
* <p>Contains transcribed text.</p>
|
|
88
94
|
*/
|
|
89
95
|
Transcript?: string;
|
|
90
96
|
/**
|
|
91
|
-
* <p>
|
|
97
|
+
* <p>Contains words, phrases, or punctuation marks in your transcription output.</p>
|
|
92
98
|
*/
|
|
93
99
|
Items?: Item[];
|
|
94
100
|
/**
|
|
95
|
-
* <p>Contains
|
|
101
|
+
* <p>Contains entities identified as personally identifiable information (PII) in your transcription
|
|
102
|
+
* output.</p>
|
|
96
103
|
*/
|
|
97
104
|
Entities?: Entity[];
|
|
98
105
|
}
|
|
99
106
|
/**
|
|
100
|
-
* <p>
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
* on audio encoding formats in Amazon Transcribe Medical, see
|
|
104
|
-
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/input-med.html">Speech input</a>.</p>
|
|
107
|
+
* <p>A wrapper for your audio chunks. Your audio stream consists of one or more audio
|
|
108
|
+
* events, which consist of one or more audio chunks.</p>
|
|
109
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html">Event stream encoding</a>.</p>
|
|
105
110
|
*/
|
|
106
111
|
export interface AudioEvent {
|
|
107
112
|
/**
|
|
@@ -111,17 +116,16 @@ export interface AudioEvent {
|
|
|
111
116
|
AudioChunk?: Uint8Array;
|
|
112
117
|
}
|
|
113
118
|
/**
|
|
114
|
-
* <p>
|
|
119
|
+
* <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket
|
|
120
|
+
* data frames.</p>
|
|
121
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
|
|
115
122
|
*/
|
|
116
123
|
export declare type AudioStream = AudioStream.AudioEventMember | AudioStream.$UnknownMember;
|
|
117
124
|
export declare namespace AudioStream {
|
|
118
125
|
/**
|
|
119
|
-
* <p>A blob of audio from your application.
|
|
126
|
+
* <p>A blob of audio from your application. Your audio stream consists of one or more audio
|
|
120
127
|
* events.</p>
|
|
121
|
-
* <p>For information
|
|
122
|
-
* information on audio encoding formats in Amazon Transcribe Medical, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/input-med.html">Speech input</a>.</p>
|
|
123
|
-
* <p>For more information on stream encoding in Amazon Transcribe, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html">Event stream encoding</a>. For
|
|
124
|
-
* information on stream encoding in Amazon Transcribe Medical, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/event-stream-med.html">Event stream encoding</a>.</p>
|
|
128
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html">Event stream encoding</a>.</p>
|
|
125
129
|
*/
|
|
126
130
|
interface AudioEventMember {
|
|
127
131
|
AudioEvent: AudioEvent;
|
|
@@ -139,9 +143,9 @@ export declare namespace AudioStream {
|
|
|
139
143
|
}
|
|
140
144
|
/**
|
|
141
145
|
* <p>One or more arguments to the <code>StartStreamTranscription</code> or
|
|
142
|
-
* <code>StartMedicalStreamTranscription</code> operation was
|
|
143
|
-
* <code>MediaEncoding</code>
|
|
144
|
-
*
|
|
146
|
+
* <code>StartMedicalStreamTranscription</code> operation was not valid. For example,
|
|
147
|
+
* <code>MediaEncoding</code> or <code>LanguageCode</code> used not valid values. Check the
|
|
148
|
+
* specified parameters and try your request again.</p>
|
|
145
149
|
*/
|
|
146
150
|
export declare class BadRequestException extends __BaseException {
|
|
147
151
|
readonly name: "BadRequestException";
|
|
@@ -153,8 +157,7 @@ export declare class BadRequestException extends __BaseException {
|
|
|
153
157
|
constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
|
|
154
158
|
}
|
|
155
159
|
/**
|
|
156
|
-
* <p>A new stream started with the same session ID. The current stream has been
|
|
157
|
-
* terminated.</p>
|
|
160
|
+
* <p>A new stream started with the same session ID. The current stream has been terminated.</p>
|
|
158
161
|
*/
|
|
159
162
|
export declare class ConflictException extends __BaseException {
|
|
160
163
|
readonly name: "ConflictException";
|
|
@@ -172,8 +175,8 @@ export declare enum ContentRedactionType {
|
|
|
172
175
|
PII = "PII"
|
|
173
176
|
}
|
|
174
177
|
/**
|
|
175
|
-
* <p>A problem occurred while processing the audio. Amazon Transcribe
|
|
176
|
-
*
|
|
178
|
+
* <p>A problem occurred while processing the audio. Amazon Transcribe terminated
|
|
179
|
+
* processing.</p>
|
|
177
180
|
*/
|
|
178
181
|
export declare class InternalFailureException extends __BaseException {
|
|
179
182
|
readonly name: "InternalFailureException";
|
|
@@ -192,34 +195,33 @@ export declare enum LanguageCode {
|
|
|
192
195
|
ES_US = "es-US",
|
|
193
196
|
FR_CA = "fr-CA",
|
|
194
197
|
FR_FR = "fr-FR",
|
|
198
|
+
HI_IN = "hi-IN",
|
|
195
199
|
IT_IT = "it-IT",
|
|
196
200
|
JA_JP = "ja-JP",
|
|
197
201
|
KO_KR = "ko-KR",
|
|
198
202
|
PT_BR = "pt-BR",
|
|
203
|
+
TH_TH = "th-TH",
|
|
199
204
|
ZH_CN = "zh-CN"
|
|
200
205
|
}
|
|
201
206
|
/**
|
|
202
|
-
* <p>The language
|
|
203
|
-
*
|
|
204
|
-
*
|
|
207
|
+
* <p>The language code that represents the language identified in your audio, including the associated
|
|
208
|
+
* confidence score. If you enabled channel identification in your request and each channel contained a
|
|
209
|
+
* different language, you will have more than one <code>LanguageWithScore</code> result.</p>
|
|
205
210
|
*/
|
|
206
211
|
export interface LanguageWithScore {
|
|
207
212
|
/**
|
|
208
|
-
* <p>The language code of the
|
|
213
|
+
* <p>The language code of the identified language.</p>
|
|
209
214
|
*/
|
|
210
215
|
LanguageCode?: LanguageCode | string;
|
|
211
216
|
/**
|
|
212
|
-
* <p>The confidence score
|
|
213
|
-
* between zero and one; larger values indicate a higher confidence in the identified language
|
|
214
|
-
* </p>
|
|
217
|
+
* <p>The confidence score associated with the identified language code. Confidence scores are values
|
|
218
|
+
* between zero and one; larger values indicate a higher confidence in the identified language.</p>
|
|
215
219
|
*/
|
|
216
220
|
Score?: number;
|
|
217
221
|
}
|
|
218
222
|
/**
|
|
219
|
-
* <p>
|
|
220
|
-
*
|
|
221
|
-
* has finished processing, or break your audio stream into smaller chunks and try your request
|
|
222
|
-
* again.</p>
|
|
223
|
+
* <p>Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length
|
|
224
|
+
* limit. Break your audio stream into smaller chunks and try your request again.</p>
|
|
223
225
|
*/
|
|
224
226
|
export declare class LimitExceededException extends __BaseException {
|
|
225
227
|
readonly name: "LimitExceededException";
|
|
@@ -236,88 +238,87 @@ export declare enum MediaEncoding {
|
|
|
236
238
|
PCM = "pcm"
|
|
237
239
|
}
|
|
238
240
|
/**
|
|
239
|
-
* <p>
|
|
241
|
+
* <p>Contains entities identified as personal health information (PHI) in your
|
|
242
|
+
* transcription output, along with various associated attributes. Examples include
|
|
243
|
+
* category, confidence score, type, stability score, and start and end times.</p>
|
|
240
244
|
*/
|
|
241
245
|
export interface MedicalEntity {
|
|
242
246
|
/**
|
|
243
|
-
* <p>The start time of the
|
|
247
|
+
* <p>The start time, in milliseconds, of the utterance that was identified as PHI.</p>
|
|
244
248
|
*/
|
|
245
249
|
StartTime?: number;
|
|
246
250
|
/**
|
|
247
|
-
* <p>The end time of the
|
|
251
|
+
* <p>The end time, in milliseconds, of the utterance that was identified as PHI.</p>
|
|
248
252
|
*/
|
|
249
253
|
EndTime?: number;
|
|
250
254
|
/**
|
|
251
|
-
* <p>The
|
|
255
|
+
* <p>The category of information identified. The only category is <code>PHI</code>.</p>
|
|
252
256
|
*/
|
|
253
257
|
Category?: string;
|
|
254
258
|
/**
|
|
255
|
-
* <p>The word or words
|
|
256
|
-
* medical entity.</p>
|
|
259
|
+
* <p>The word or words identified as PHI.</p>
|
|
257
260
|
*/
|
|
258
261
|
Content?: string;
|
|
259
262
|
/**
|
|
260
|
-
* <p>
|
|
261
|
-
*
|
|
262
|
-
*
|
|
263
|
+
* <p>The confidence score associated with the identified PHI entity in your audio.</p>
|
|
264
|
+
* <p>Confidence scores are values between 0 and 1. A larger value indicates a higher
|
|
265
|
+
* probability that the identified entity correctly matches the entity spoken in your
|
|
266
|
+
* media.</p>
|
|
263
267
|
*/
|
|
264
268
|
Confidence?: number;
|
|
265
269
|
}
|
|
266
270
|
/**
|
|
267
|
-
* <p>A word, phrase, or punctuation mark
|
|
271
|
+
* <p>A word, phrase, or punctuation mark in your transcription output, along with various
|
|
272
|
+
* associated attributes, such as confidence score, type, and start and end times.</p>
|
|
268
273
|
*/
|
|
269
274
|
export interface MedicalItem {
|
|
270
275
|
/**
|
|
271
|
-
* <p>The
|
|
272
|
-
* item.</p>
|
|
276
|
+
* <p>The start time, in milliseconds, of the transcribed item.</p>
|
|
273
277
|
*/
|
|
274
278
|
StartTime?: number;
|
|
275
279
|
/**
|
|
276
|
-
* <p>The
|
|
277
|
-
* item.</p>
|
|
280
|
+
* <p>The end time, in milliseconds, of the transcribed item.</p>
|
|
278
281
|
*/
|
|
279
282
|
EndTime?: number;
|
|
280
283
|
/**
|
|
281
|
-
* <p>The type of
|
|
282
|
-
*
|
|
283
|
-
* was interpreted as a pause in the input audio, such as a period to indicate the end of a
|
|
284
|
-
* sentence.</p>
|
|
284
|
+
* <p>The type of item identified. Options are: <code>PRONUNCIATION</code> (spoken
|
|
285
|
+
* words) and <code>PUNCTUATION</code>.</p>
|
|
285
286
|
*/
|
|
286
287
|
Type?: ItemType | string;
|
|
287
288
|
/**
|
|
288
|
-
* <p>The word or punctuation
|
|
289
|
+
* <p>The word or punctuation that was transcribed.</p>
|
|
289
290
|
*/
|
|
290
291
|
Content?: string;
|
|
291
292
|
/**
|
|
292
|
-
* <p>
|
|
293
|
-
*
|
|
293
|
+
* <p>The confidence score associated with a word or phrase in your transcript.</p>
|
|
294
|
+
* <p>Confidence scores are values between 0 and 1. A larger value indicates a higher
|
|
295
|
+
* probability that the identified item correctly matches the item spoken in your
|
|
296
|
+
* media.</p>
|
|
294
297
|
*/
|
|
295
298
|
Confidence?: number;
|
|
296
299
|
/**
|
|
297
|
-
* <p>If speaker
|
|
298
|
-
*
|
|
299
|
-
* <code>Speaker</code> in the stream is either a <code>0</code> or a <code>1</code>,
|
|
300
|
-
* that indicates that Amazon Transcribe Medical has identified two speakers in the stream. The value of
|
|
301
|
-
* <code>0</code> corresponds to one speaker and the value of <code>1</code>
|
|
302
|
-
* corresponds to the other speaker.</p>
|
|
300
|
+
* <p>If speaker partitioning is enabled, <code>Speaker</code> labels the speaker of the
|
|
301
|
+
* specified item.</p>
|
|
303
302
|
*/
|
|
304
303
|
Speaker?: string;
|
|
305
304
|
}
|
|
306
305
|
/**
|
|
307
|
-
* <p>A list of possible transcriptions for the audio
|
|
306
|
+
* <p>A list of possible alternative transcriptions for the input audio. Each alternative may
|
|
307
|
+
* contain one or more of <code>Items</code>, <code>Entities</code>, or
|
|
308
|
+
* <code>Transcript</code>.</p>
|
|
308
309
|
*/
|
|
309
310
|
export interface MedicalAlternative {
|
|
310
311
|
/**
|
|
311
|
-
* <p>
|
|
312
|
+
* <p>Contains transcribed text.</p>
|
|
312
313
|
*/
|
|
313
314
|
Transcript?: string;
|
|
314
315
|
/**
|
|
315
|
-
* <p>
|
|
316
|
-
* more interpretations of the input audio.</p>
|
|
316
|
+
* <p>Contains words, phrases, or punctuation marks in your transcription output.</p>
|
|
317
317
|
*/
|
|
318
318
|
Items?: MedicalItem[];
|
|
319
319
|
/**
|
|
320
|
-
* <p>Contains
|
|
320
|
+
* <p>Contains entities identified as personal health information (PHI) in your transcription
|
|
321
|
+
* output.</p>
|
|
321
322
|
*/
|
|
322
323
|
Entities?: MedicalEntity[];
|
|
323
324
|
}
|
|
@@ -325,69 +326,77 @@ export declare enum MedicalContentIdentificationType {
|
|
|
325
326
|
PHI = "PHI"
|
|
326
327
|
}
|
|
327
328
|
/**
|
|
328
|
-
* <p>The
|
|
329
|
+
* <p>The <code>Result</code> associated with a
|
|
330
|
+
* <code></code>.</p>
|
|
331
|
+
* <p>Contains a set of transcription results from one or more audio segments, along with
|
|
332
|
+
* additional information per your request parameters. This can include information relating to
|
|
333
|
+
* alternative transcriptions, channel identification, partial result stabilization, language
|
|
334
|
+
* identification, and other transcription-related data.</p>
|
|
329
335
|
*/
|
|
330
336
|
export interface MedicalResult {
|
|
331
337
|
/**
|
|
332
|
-
* <p>
|
|
338
|
+
* <p>Provides a unique identifier for the <code>Result</code>.</p>
|
|
333
339
|
*/
|
|
334
340
|
ResultId?: string;
|
|
335
341
|
/**
|
|
336
|
-
* <p>The time, in
|
|
337
|
-
* result.</p>
|
|
342
|
+
* <p>The start time, in milliseconds, of the <code>Result</code>.</p>
|
|
338
343
|
*/
|
|
339
344
|
StartTime?: number;
|
|
340
345
|
/**
|
|
341
|
-
* <p>The time, in
|
|
342
|
-
* result.</p>
|
|
346
|
+
* <p>The end time, in milliseconds, of the <code>Result</code>.</p>
|
|
343
347
|
*/
|
|
344
348
|
EndTime?: number;
|
|
345
349
|
/**
|
|
346
|
-
* <p>
|
|
347
|
-
*
|
|
348
|
-
*
|
|
349
|
-
* additional transcription data to send. The <code>IsPartial</code> field is
|
|
350
|
-
* <code>false</code> to indicate that this is the last transcription result for the
|
|
351
|
-
* segment.</p>
|
|
350
|
+
* <p>Indicates if the segment is complete.</p>
|
|
351
|
+
* <p>If <code>IsPartial</code> is <code>true</code>, the segment is not complete. If
|
|
352
|
+
* <code>IsPartial</code> is <code>false</code>, the segment is complete.</p>
|
|
352
353
|
*/
|
|
353
354
|
IsPartial?: boolean;
|
|
354
355
|
/**
|
|
355
|
-
* <p>A list of possible transcriptions
|
|
356
|
-
* one <code>
|
|
356
|
+
* <p>A list of possible alternative transcriptions for the input audio. Each alternative may
|
|
357
|
+
* contain one or more of <code>Items</code>, <code>Entities</code>, or
|
|
358
|
+
* <code>Transcript</code>.</p>
|
|
357
359
|
*/
|
|
358
360
|
Alternatives?: MedicalAlternative[];
|
|
359
361
|
/**
|
|
360
|
-
* <p>
|
|
361
|
-
* channel separately.</p>
|
|
362
|
-
* <p>You can use <code>ChannelId</code> to retrieve the transcription results for a single
|
|
363
|
-
* channel in your audio stream.</p>
|
|
362
|
+
* <p>Indicates the channel identified for the <code>Result</code>.</p>
|
|
364
363
|
*/
|
|
365
364
|
ChannelId?: string;
|
|
366
365
|
}
|
|
367
366
|
/**
|
|
368
|
-
* <p>The
|
|
367
|
+
* <p>The <code>MedicalTranscript</code> associated with a
|
|
368
|
+
* <code></code>.</p>
|
|
369
|
+
* <p>
|
|
370
|
+
* <code>MedicalTranscript</code> contains <code>Results</code>, which contains a set of
|
|
371
|
+
* transcription results from one or more audio segments, along with additional information per your
|
|
372
|
+
* request parameters.</p>
|
|
369
373
|
*/
|
|
370
374
|
export interface MedicalTranscript {
|
|
371
375
|
/**
|
|
372
|
-
* <p>
|
|
373
|
-
*
|
|
374
|
-
*
|
|
376
|
+
* <p>Contains a set of transcription results from one or more audio segments, along with
|
|
377
|
+
* additional information per your request parameters. This can include information relating to
|
|
378
|
+
* alternative transcriptions, channel identification, partial result stabilization, language
|
|
379
|
+
* identification, and other transcription-related data.</p>
|
|
375
380
|
*/
|
|
376
381
|
Results?: MedicalResult[];
|
|
377
382
|
}
|
|
378
383
|
/**
|
|
379
|
-
* <p>
|
|
380
|
-
*
|
|
384
|
+
* <p>The <code>MedicalTranscriptEvent</code> associated with a
|
|
385
|
+
* <code>MedicalTranscriptResultStream</code>.</p>
|
|
386
|
+
* <p>Contains a set of transcription results from one or more audio segments, along with additional
|
|
387
|
+
* information per your request parameters.</p>
|
|
381
388
|
*/
|
|
382
389
|
export interface MedicalTranscriptEvent {
|
|
383
390
|
/**
|
|
384
|
-
* <p>
|
|
385
|
-
*
|
|
391
|
+
* <p>Contains <code>Results</code>, which contains a set of transcription results from one or
|
|
392
|
+
* more audio segments, along with additional information per your request parameters. This can
|
|
393
|
+
* include information relating to alternative transcriptions, channel identification, partial result
|
|
394
|
+
* stabilization, language identification, and other transcription-related data.</p>
|
|
386
395
|
*/
|
|
387
396
|
Transcript?: MedicalTranscript;
|
|
388
397
|
}
|
|
389
398
|
/**
|
|
390
|
-
* <p>
|
|
399
|
+
* <p>The service is currently unavailable. Try your request later.</p>
|
|
391
400
|
*/
|
|
392
401
|
export declare class ServiceUnavailableException extends __BaseException {
|
|
393
402
|
readonly name: "ServiceUnavailableException";
|
|
@@ -399,15 +408,17 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
399
408
|
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
400
409
|
}
|
|
401
410
|
/**
|
|
402
|
-
* <p>
|
|
411
|
+
* <p>Contains detailed information about your streaming session.</p>
|
|
403
412
|
*/
|
|
404
413
|
export declare type MedicalTranscriptResultStream = MedicalTranscriptResultStream.BadRequestExceptionMember | MedicalTranscriptResultStream.ConflictExceptionMember | MedicalTranscriptResultStream.InternalFailureExceptionMember | MedicalTranscriptResultStream.LimitExceededExceptionMember | MedicalTranscriptResultStream.ServiceUnavailableExceptionMember | MedicalTranscriptResultStream.TranscriptEventMember | MedicalTranscriptResultStream.$UnknownMember;
|
|
405
414
|
export declare namespace MedicalTranscriptResultStream {
|
|
406
415
|
/**
|
|
407
|
-
* <p>
|
|
408
|
-
*
|
|
409
|
-
*
|
|
410
|
-
*
|
|
416
|
+
* <p>The <code>MedicalTranscriptEvent</code> associated with a
|
|
417
|
+
* <code>MedicalTranscriptResultStream</code>.</p>
|
|
418
|
+
* <p>Contains a set of transcription results from one or more audio segments, along with
|
|
419
|
+
* additional information per your request parameters. This can include information relating to
|
|
420
|
+
* alternative transcriptions, channel identification, partial result stabilization, language
|
|
421
|
+
* identification, and other transcription-related data.</p>
|
|
411
422
|
*/
|
|
412
423
|
interface TranscriptEventMember {
|
|
413
424
|
TranscriptEvent: MedicalTranscriptEvent;
|
|
@@ -420,9 +431,9 @@ export declare namespace MedicalTranscriptResultStream {
|
|
|
420
431
|
}
|
|
421
432
|
/**
|
|
422
433
|
* <p>One or more arguments to the <code>StartStreamTranscription</code> or
|
|
423
|
-
* <code>StartMedicalStreamTranscription</code> operation was
|
|
424
|
-
* <code>MediaEncoding</code>
|
|
425
|
-
*
|
|
434
|
+
* <code>StartMedicalStreamTranscription</code> operation was not valid. For example,
|
|
435
|
+
* <code>MediaEncoding</code> or <code>LanguageCode</code> used not valid values. Check the
|
|
436
|
+
* specified parameters and try your request again.</p>
|
|
426
437
|
*/
|
|
427
438
|
interface BadRequestExceptionMember {
|
|
428
439
|
TranscriptEvent?: never;
|
|
@@ -434,10 +445,8 @@ export declare namespace MedicalTranscriptResultStream {
|
|
|
434
445
|
$unknown?: never;
|
|
435
446
|
}
|
|
436
447
|
/**
|
|
437
|
-
* <p>
|
|
438
|
-
*
|
|
439
|
-
* has finished processing, or break your audio stream into smaller chunks and try your request
|
|
440
|
-
* again.</p>
|
|
448
|
+
* <p>Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length
|
|
449
|
+
* limit. Break your audio stream into smaller chunks and try your request again.</p>
|
|
441
450
|
*/
|
|
442
451
|
interface LimitExceededExceptionMember {
|
|
443
452
|
TranscriptEvent?: never;
|
|
@@ -449,8 +458,8 @@ export declare namespace MedicalTranscriptResultStream {
|
|
|
449
458
|
$unknown?: never;
|
|
450
459
|
}
|
|
451
460
|
/**
|
|
452
|
-
* <p>A problem occurred while processing the audio. Amazon Transcribe
|
|
453
|
-
*
|
|
461
|
+
* <p>A problem occurred while processing the audio. Amazon Transcribe terminated
|
|
462
|
+
* processing.</p>
|
|
454
463
|
*/
|
|
455
464
|
interface InternalFailureExceptionMember {
|
|
456
465
|
TranscriptEvent?: never;
|
|
@@ -462,8 +471,7 @@ export declare namespace MedicalTranscriptResultStream {
|
|
|
462
471
|
$unknown?: never;
|
|
463
472
|
}
|
|
464
473
|
/**
|
|
465
|
-
* <p>A new stream started with the same session ID. The current stream has been
|
|
466
|
-
* terminated.</p>
|
|
474
|
+
* <p>A new stream started with the same session ID. The current stream has been terminated.</p>
|
|
467
475
|
*/
|
|
468
476
|
interface ConflictExceptionMember {
|
|
469
477
|
TranscriptEvent?: never;
|
|
@@ -475,7 +483,7 @@ export declare namespace MedicalTranscriptResultStream {
|
|
|
475
483
|
$unknown?: never;
|
|
476
484
|
}
|
|
477
485
|
/**
|
|
478
|
-
* <p>
|
|
486
|
+
* <p>The service is currently unavailable. Try your request later.</p>
|
|
479
487
|
*/
|
|
480
488
|
interface ServiceUnavailableExceptionMember {
|
|
481
489
|
TranscriptEvent?: never;
|
|
@@ -512,49 +520,49 @@ export declare enum PartialResultsStability {
|
|
|
512
520
|
MEDIUM = "medium"
|
|
513
521
|
}
|
|
514
522
|
/**
|
|
515
|
-
* <p>The
|
|
523
|
+
* <p>The <code>Result</code> associated with a
|
|
524
|
+
* <code></code>.</p>
|
|
525
|
+
* <p>Contains a set of transcription results from one or more audio segments, along with additional
|
|
526
|
+
* information per your request parameters. This can include information relating to alternative
|
|
527
|
+
* transcriptions, channel identification, partial result stabilization, language identification, and other
|
|
528
|
+
* transcription-related data.</p>
|
|
516
529
|
*/
|
|
517
530
|
export interface Result {
|
|
518
531
|
/**
|
|
519
|
-
* <p>
|
|
532
|
+
* <p>Provides a unique identifier for the <code>Result</code>.</p>
|
|
520
533
|
*/
|
|
521
534
|
ResultId?: string;
|
|
522
535
|
/**
|
|
523
|
-
* <p>The
|
|
524
|
-
* result.</p>
|
|
536
|
+
* <p>The start time, in milliseconds, of the <code>Result</code>.</p>
|
|
525
537
|
*/
|
|
526
538
|
StartTime?: number;
|
|
527
539
|
/**
|
|
528
|
-
* <p>The
|
|
529
|
-
* result.</p>
|
|
540
|
+
* <p>The end time, in milliseconds, of the <code>Result</code>.</p>
|
|
530
541
|
*/
|
|
531
542
|
EndTime?: number;
|
|
532
543
|
/**
|
|
533
|
-
* <p>
|
|
534
|
-
*
|
|
535
|
-
*
|
|
536
|
-
* additional transcription data to send, <code>false</code> to indicate that this is the last
|
|
537
|
-
* transcription result for the segment.</p>
|
|
544
|
+
* <p>Indicates if the segment is complete.</p>
|
|
545
|
+
* <p>If <code>IsPartial</code> is <code>true</code>, the segment is not complete. If
|
|
546
|
+
* <code>IsPartial</code> is <code>false</code>, the segment is complete.</p>
|
|
538
547
|
*/
|
|
539
548
|
IsPartial?: boolean;
|
|
540
549
|
/**
|
|
541
|
-
* <p>A list of possible transcriptions for the audio. Each alternative
|
|
542
|
-
* <code>
|
|
550
|
+
* <p>A list of possible alternative transcriptions for the input audio. Each alternative may contain
|
|
551
|
+
* one or more of <code>Items</code>, <code>Entities</code>, or <code>Transcript</code>.</p>
|
|
543
552
|
*/
|
|
544
553
|
Alternatives?: Alternative[];
|
|
545
554
|
/**
|
|
546
|
-
* <p>
|
|
547
|
-
* channel separately.</p>
|
|
548
|
-
* <p>You can use <code>ChannelId</code> to retrieve the transcription results for a single
|
|
549
|
-
* channel in your audio stream.</p>
|
|
555
|
+
* <p>Indicates the channel identified for the <code>Result</code>.</p>
|
|
550
556
|
*/
|
|
551
557
|
ChannelId?: string;
|
|
552
558
|
/**
|
|
553
|
-
* <p>The language code
|
|
559
|
+
* <p>The language code that represents the language spoken in your audio stream.</p>
|
|
554
560
|
*/
|
|
555
561
|
LanguageCode?: LanguageCode | string;
|
|
556
562
|
/**
|
|
557
|
-
* <p>The language code of the dominant language identified in your
|
|
563
|
+
* <p>The language code of the dominant language identified in your stream.</p>
|
|
564
|
+
* <p>If you enabled channel identification and each channel of your audio contains a different language,
|
|
565
|
+
* you may have more than one result.</p>
|
|
558
566
|
*/
|
|
559
567
|
LanguageIdentification?: LanguageWithScore[];
|
|
560
568
|
}
|
|
@@ -572,123 +580,144 @@ export declare enum Type {
|
|
|
572
580
|
}
|
|
573
581
|
export interface StartMedicalStreamTranscriptionRequest {
|
|
574
582
|
/**
|
|
575
|
-
* <p>
|
|
576
|
-
*
|
|
583
|
+
* <p>Specify the language code that represents the language spoken in your audio.</p>
|
|
584
|
+
* <important>
|
|
585
|
+
* <p>Amazon Transcribe Medical only supports US English (<code>en-US</code>).</p>
|
|
586
|
+
* </important>
|
|
577
587
|
*/
|
|
578
588
|
LanguageCode: LanguageCode | string | undefined;
|
|
579
589
|
/**
|
|
580
|
-
* <p>The sample rate of the input audio (in
|
|
581
|
-
* 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that
|
|
582
|
-
* audio.</p>
|
|
590
|
+
* <p>The sample rate of the input audio (in hertz). Amazon Transcribe Medical supports a
|
|
591
|
+
* range from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that
|
|
592
|
+
* of your audio.</p>
|
|
583
593
|
*/
|
|
584
594
|
MediaSampleRateHertz: number | undefined;
|
|
585
595
|
/**
|
|
586
|
-
* <p>
|
|
596
|
+
* <p>Specify the encoding used for the input audio. Supported formats are:</p>
|
|
597
|
+
* <ul>
|
|
598
|
+
* <li>
|
|
599
|
+
* <p>FLAC</p>
|
|
600
|
+
* </li>
|
|
601
|
+
* <li>
|
|
602
|
+
* <p>OPUS-encoded audio in an Ogg container</p>
|
|
603
|
+
* </li>
|
|
604
|
+
* <li>
|
|
605
|
+
* <p>PCM (only signed 16-bit little-endian audio formats, which does not include
|
|
606
|
+
* WAV)</p>
|
|
607
|
+
* </li>
|
|
608
|
+
* </ul>
|
|
609
|
+
* <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>
|
|
587
610
|
*/
|
|
588
611
|
MediaEncoding: MediaEncoding | string | undefined;
|
|
589
612
|
/**
|
|
590
|
-
* <p>
|
|
591
|
-
*
|
|
613
|
+
* <p>Specify the name of the custom vocabulary that you want to use when processing your
|
|
614
|
+
* transcription. Note that vocabulary names are case sensitive.</p>
|
|
592
615
|
*/
|
|
593
616
|
VocabularyName?: string;
|
|
594
617
|
/**
|
|
595
|
-
* <p>
|
|
618
|
+
* <p>Specify the medical specialty contained in your audio.</p>
|
|
596
619
|
*/
|
|
597
620
|
Specialty: Specialty | string | undefined;
|
|
598
621
|
/**
|
|
599
|
-
* <p>
|
|
600
|
-
* patient notes
|
|
601
|
-
*
|
|
622
|
+
* <p>Specify the type of input audio. For example, choose <code>DICTATION</code> for a
|
|
623
|
+
* provider dictating patient notes and <code>CONVERSATION</code> for a dialogue between a
|
|
624
|
+
* patient and a medical professional.</p>
|
|
602
625
|
*/
|
|
603
626
|
Type: Type | string | undefined;
|
|
604
627
|
/**
|
|
605
|
-
* <p>
|
|
606
|
-
*
|
|
628
|
+
* <p>Enables speaker partitioning (diarization) in your transcription output. Speaker
|
|
629
|
+
* partitioning labels the speech from individual speakers in your media file.</p>
|
|
630
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers (diarization)</a>.</p>
|
|
607
631
|
*/
|
|
608
632
|
ShowSpeakerLabel?: boolean;
|
|
609
633
|
/**
|
|
610
|
-
* <p>
|
|
611
|
-
*
|
|
634
|
+
* <p>Specify a name for your transcription session. If you don't include this parameter in
|
|
635
|
+
* your request, Amazon Transcribe Medical generates an ID and returns it in the
|
|
636
|
+
* response.</p>
|
|
637
|
+
* <p>You can use a session ID to retry a streaming session.</p>
|
|
612
638
|
*/
|
|
613
639
|
SessionId?: string;
|
|
614
640
|
/**
|
|
615
|
-
* <p>
|
|
641
|
+
* <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket
|
|
642
|
+
* data frames.</p>
|
|
643
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
|
|
616
644
|
*/
|
|
617
645
|
AudioStream: AsyncIterable<AudioStream> | undefined;
|
|
618
646
|
/**
|
|
619
|
-
* <p>
|
|
620
|
-
*
|
|
621
|
-
*
|
|
622
|
-
*
|
|
623
|
-
*
|
|
624
|
-
*
|
|
625
|
-
* request returns a <code>BadRequestException</code>.</p>
|
|
647
|
+
* <p>Enables channel identification in multi-channel audio.</p>
|
|
648
|
+
* <p>Channel identification transcribes the audio on each channel independently, then appends
|
|
649
|
+
* the output for each channel into one transcript.</p>
|
|
650
|
+
* <p>If you have multi-channel audio and do not enable channel identification, your audio is
|
|
651
|
+
* transcribed in a continuous manner and your transcript is not separated by channel.</p>
|
|
652
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel audio</a>.</p>
|
|
626
653
|
*/
|
|
627
654
|
EnableChannelIdentification?: boolean;
|
|
628
655
|
/**
|
|
629
|
-
* <p>
|
|
656
|
+
* <p>Specify the number of channels in your audio stream. Up to two channels are
|
|
657
|
+
* supported.</p>
|
|
630
658
|
*/
|
|
631
659
|
NumberOfChannels?: number;
|
|
632
660
|
/**
|
|
633
|
-
* <p>
|
|
634
|
-
*
|
|
661
|
+
* <p>Labels all personal health information (PHI) identified in your transcript.</p>
|
|
662
|
+
* <p>Content identification is performed at the segment level; PHI is flagged upon complete
|
|
663
|
+
* transcription of an audio segment.</p>
|
|
664
|
+
* <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
|
|
665
|
+
* transcription</a>.</p>
|
|
635
666
|
*/
|
|
636
667
|
ContentIdentificationType?: MedicalContentIdentificationType | string;
|
|
637
668
|
}
|
|
638
669
|
export interface StartMedicalStreamTranscriptionResponse {
|
|
639
670
|
/**
|
|
640
|
-
* <p>
|
|
671
|
+
* <p>Provides the identifier for your streaming request.</p>
|
|
641
672
|
*/
|
|
642
673
|
RequestId?: string;
|
|
643
674
|
/**
|
|
644
|
-
* <p>
|
|
645
|
-
*
|
|
675
|
+
* <p>Provides the language code that you specified in your request. This must be
|
|
676
|
+
* <code>en-US</code>.</p>
|
|
646
677
|
*/
|
|
647
678
|
LanguageCode?: LanguageCode | string;
|
|
648
679
|
/**
|
|
649
|
-
* <p>
|
|
680
|
+
* <p>Provides the sample rate that you specified in your request.</p>
|
|
650
681
|
*/
|
|
651
682
|
MediaSampleRateHertz?: number;
|
|
652
683
|
/**
|
|
653
|
-
* <p>
|
|
684
|
+
* <p>Provides the media encoding you specified in your request.</p>
|
|
654
685
|
*/
|
|
655
686
|
MediaEncoding?: MediaEncoding | string;
|
|
656
687
|
/**
|
|
657
|
-
* <p>
|
|
688
|
+
* <p>Provides the name of the custom vocabulary that you specified in your request.</p>
|
|
658
689
|
*/
|
|
659
690
|
VocabularyName?: string;
|
|
660
691
|
/**
|
|
661
|
-
* <p>
|
|
692
|
+
* <p>Provides the medical specialty that you specified in your request.</p>
|
|
662
693
|
*/
|
|
663
694
|
Specialty?: Specialty | string;
|
|
664
695
|
/**
|
|
665
|
-
* <p>
|
|
696
|
+
* <p>Provides the type of audio you specified in your request.</p>
|
|
666
697
|
*/
|
|
667
698
|
Type?: Type | string;
|
|
668
699
|
/**
|
|
669
|
-
* <p>Shows whether speaker
|
|
700
|
+
* <p>Shows whether speaker partitioning was enabled for your transcription.</p>
|
|
670
701
|
*/
|
|
671
702
|
ShowSpeakerLabel?: boolean;
|
|
672
703
|
/**
|
|
673
|
-
* <p>
|
|
674
|
-
* ID, Amazon Transcribe generates one for you and returns it in the response.</p>
|
|
704
|
+
* <p>Provides the identifier for your transcription session.</p>
|
|
675
705
|
*/
|
|
676
706
|
SessionId?: string;
|
|
677
707
|
/**
|
|
678
|
-
* <p>
|
|
708
|
+
* <p>Provides detailed information about your streaming session.</p>
|
|
679
709
|
*/
|
|
680
710
|
TranscriptResultStream?: AsyncIterable<MedicalTranscriptResultStream>;
|
|
681
711
|
/**
|
|
682
|
-
* <p>Shows whether channel identification
|
|
712
|
+
* <p>Shows whether channel identification was enabled for your transcription.</p>
|
|
683
713
|
*/
|
|
684
714
|
EnableChannelIdentification?: boolean;
|
|
685
715
|
/**
|
|
686
|
-
* <p>
|
|
716
|
+
* <p>Provides the number of channels that you specified in your request.</p>
|
|
687
717
|
*/
|
|
688
718
|
NumberOfChannels?: number;
|
|
689
719
|
/**
|
|
690
|
-
* <p>
|
|
691
|
-
* identify personal health information.</p>
|
|
720
|
+
* <p>Shows whether content identification was enabled for your transcription.</p>
|
|
692
721
|
*/
|
|
693
722
|
ContentIdentificationType?: MedicalContentIdentificationType | string;
|
|
694
723
|
}
|
|
@@ -699,196 +728,279 @@ export declare enum VocabularyFilterMethod {
|
|
|
699
728
|
}
|
|
700
729
|
export interface StartStreamTranscriptionRequest {
|
|
701
730
|
/**
|
|
702
|
-
* <p>
|
|
731
|
+
* <p>Specify the language code that represents the language spoken in your audio.</p>
|
|
732
|
+
* <p>If you're unsure of the language spoken in your audio, consider using
|
|
733
|
+
* <code>IdentifyLanguage</code> to enable automatic language identification.</p>
|
|
734
|
+
* <p>For a list of languages supported with Amazon Transcribe streaming, refer to the
|
|
735
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported
|
|
736
|
+
* languages</a> table.</p>
|
|
703
737
|
*/
|
|
704
738
|
LanguageCode?: LanguageCode | string;
|
|
705
739
|
/**
|
|
706
|
-
* <p>The sample rate of the input audio (in
|
|
707
|
-
*
|
|
708
|
-
*
|
|
740
|
+
* <p>The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio,
|
|
741
|
+
* is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz.
|
|
742
|
+
* Note that the sample rate you specify must match that of your audio.</p>
|
|
709
743
|
*/
|
|
710
744
|
MediaSampleRateHertz: number | undefined;
|
|
711
745
|
/**
|
|
712
|
-
* <p>
|
|
746
|
+
* <p>Specify the encoding used for the input audio. Supported formats are:</p>
|
|
747
|
+
* <ul>
|
|
748
|
+
* <li>
|
|
749
|
+
* <p>FLAC</p>
|
|
750
|
+
* </li>
|
|
751
|
+
* <li>
|
|
752
|
+
* <p>OPUS-encoded audio in an Ogg container</p>
|
|
753
|
+
* </li>
|
|
754
|
+
* <li>
|
|
755
|
+
* <p>PCM (only signed 16-bit little-endian audio formats, which does not include WAV)</p>
|
|
756
|
+
* </li>
|
|
757
|
+
* </ul>
|
|
758
|
+
* <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>
|
|
713
759
|
*/
|
|
714
760
|
MediaEncoding: MediaEncoding | string | undefined;
|
|
715
761
|
/**
|
|
716
|
-
* <p>
|
|
717
|
-
*
|
|
718
|
-
*
|
|
719
|
-
*
|
|
720
|
-
*
|
|
762
|
+
* <p>Specify the name of the custom vocabulary that you want to use when processing your
|
|
763
|
+
* transcription. Note that vocabulary names are case sensitive.</p>
|
|
764
|
+
* <p>If the language of the specified custom vocabulary doesn't match the language identified in
|
|
765
|
+
* your media, your job fails.</p>
|
|
766
|
+
* <important>
|
|
767
|
+
* <p>This parameter is <b>not</b> intended for use with the
|
|
768
|
+
* <code>IdentifyLanguage</code> parameter. If you're including <code>IdentifyLanguage</code>
|
|
769
|
+
* in your request and want to use one or more custom vocabularies with your transcription, use
|
|
770
|
+
* the <code>VocabularyNames</code> parameter instead.</p>
|
|
771
|
+
* </important>
|
|
772
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
|
|
721
773
|
*/
|
|
722
774
|
VocabularyName?: string;
|
|
723
775
|
/**
|
|
724
|
-
* <p>
|
|
725
|
-
*
|
|
726
|
-
*
|
|
776
|
+
* <p>Specify a name for your transcription session. If you don't include this parameter in your request,
|
|
777
|
+
* Amazon Transcribe generates an ID and returns it in the response.</p>
|
|
778
|
+
* <p>You can use a session ID to retry a streaming session.</p>
|
|
727
779
|
*/
|
|
728
780
|
SessionId?: string;
|
|
729
781
|
/**
|
|
730
|
-
* <p>
|
|
731
|
-
*
|
|
782
|
+
* <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket
|
|
783
|
+
* data frames.</p>
|
|
784
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
|
|
732
785
|
*/
|
|
733
786
|
AudioStream: AsyncIterable<AudioStream> | undefined;
|
|
734
787
|
/**
|
|
735
|
-
* <p>
|
|
736
|
-
*
|
|
737
|
-
*
|
|
738
|
-
*
|
|
739
|
-
*
|
|
788
|
+
* <p>Specify the name of the custom vocabulary filter that you want to use when processing your
|
|
789
|
+
* transcription. Note that vocabulary filter names are case sensitive.</p>
|
|
790
|
+
* <p>If the language of the specified custom vocabulary filter doesn't match the language identified in
|
|
791
|
+
* your media, your job fails.</p>
|
|
792
|
+
* <important>
|
|
793
|
+
* <p>This parameter is <b>not</b> intended for use with the
|
|
794
|
+
* <code>IdentifyLanguage</code> parameter. If you're including <code>IdentifyLanguage</code>
|
|
795
|
+
* in your request and want to use one or more vocabulary filters with your transcription, use
|
|
796
|
+
* the <code>VocabularyFilterNames</code> parameter instead.</p>
|
|
797
|
+
* </important>
|
|
798
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html">Using vocabulary filtering with unwanted
|
|
799
|
+
* words</a>.</p>
|
|
740
800
|
*/
|
|
741
801
|
VocabularyFilterName?: string;
|
|
742
802
|
/**
|
|
743
|
-
* <p>
|
|
744
|
-
*
|
|
745
|
-
*
|
|
746
|
-
*
|
|
747
|
-
* them. The tag appears as <code>VocabularyFilterMatch</code> equal to
|
|
748
|
-
* <code>True</code>.</p>
|
|
803
|
+
* <p>Specify how you want your vocabulary filter applied to your transcript.</p>
|
|
804
|
+
* <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
|
|
805
|
+
* <p>To delete words, choose <code>remove</code>.</p>
|
|
806
|
+
* <p>To flag words without changing them, choose <code>tag</code>.</p>
|
|
749
807
|
*/
|
|
750
808
|
VocabularyFilterMethod?: VocabularyFilterMethod | string;
|
|
751
809
|
/**
|
|
752
|
-
* <p>
|
|
810
|
+
* <p>Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning
|
|
811
|
+
* labels the speech from individual speakers in your media file.</p>
|
|
812
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers (diarization)</a>.</p>
|
|
753
813
|
*/
|
|
754
814
|
ShowSpeakerLabel?: boolean;
|
|
755
815
|
/**
|
|
756
|
-
* <p>
|
|
757
|
-
*
|
|
758
|
-
*
|
|
759
|
-
*
|
|
816
|
+
* <p>Enables channel identification in multi-channel audio.</p>
|
|
817
|
+
* <p>Channel identification transcribes the audio on each channel independently, then appends the
|
|
818
|
+
* output for each channel into one transcript.</p>
|
|
819
|
+
* <p>If you have multi-channel audio and do not enable channel identification, your audio is
|
|
820
|
+
* transcribed in a continuous manner and your transcript is not separated by channel.</p>
|
|
821
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel audio</a>.</p>
|
|
760
822
|
*/
|
|
761
823
|
EnableChannelIdentification?: boolean;
|
|
762
824
|
/**
|
|
763
|
-
* <p>
|
|
825
|
+
* <p>Specify the number of channels in your audio stream. Up to two channels are
|
|
826
|
+
* supported.</p>
|
|
764
827
|
*/
|
|
765
828
|
NumberOfChannels?: number;
|
|
766
829
|
/**
|
|
767
|
-
* <p>
|
|
768
|
-
*
|
|
769
|
-
* a
|
|
770
|
-
*
|
|
830
|
+
* <p>Enables partial result stabilization for your transcription. Partial result stabilization can reduce
|
|
831
|
+
* latency in your output, but may impact accuracy. For more information, see
|
|
832
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization">Partial-result
|
|
833
|
+
* stabilization</a>.</p>
|
|
771
834
|
*/
|
|
772
835
|
EnablePartialResultsStabilization?: boolean;
|
|
773
836
|
/**
|
|
774
|
-
* <p>
|
|
775
|
-
*
|
|
776
|
-
*
|
|
837
|
+
* <p>Specify the level of stability to use when you enable partial results stabilization
|
|
838
|
+
* (<code>EnablePartialResultsStabilization</code>).</p>
|
|
839
|
+
* <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly
|
|
840
|
+
* lower accuracy.</p>
|
|
841
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization">Partial-result
|
|
842
|
+
* stabilization</a>.</p>
|
|
777
843
|
*/
|
|
778
844
|
PartialResultsStability?: PartialResultsStability | string;
|
|
779
845
|
/**
|
|
780
|
-
* <p>
|
|
781
|
-
*
|
|
782
|
-
*
|
|
783
|
-
* <p>You can’t set
|
|
784
|
-
*
|
|
785
|
-
*
|
|
846
|
+
* <p>Labels all personally identifiable information (PII) identified in your transcript.</p>
|
|
847
|
+
* <p>Content identification is performed at the segment level; PII specified in
|
|
848
|
+
* <code>PiiEntityTypes</code> is flagged upon complete transcription of an audio segment.</p>
|
|
849
|
+
* <p>You can’t set <code>ContentIdentificationType</code> and <code>ContentRedactionType</code>
|
|
850
|
+
* in the same request. If you set both, your request returns a
|
|
851
|
+
* <code>BadRequestException</code>.</p>
|
|
852
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html">Redacting or identifying personally identifiable
|
|
853
|
+
* information</a>.</p>
|
|
786
854
|
*/
|
|
787
855
|
ContentIdentificationType?: ContentIdentificationType | string;
|
|
788
856
|
/**
|
|
789
|
-
* <p>
|
|
790
|
-
*
|
|
791
|
-
*
|
|
792
|
-
* <p>You can’t set
|
|
793
|
-
*
|
|
794
|
-
*
|
|
857
|
+
* <p>Redacts all personally identifiable information (PII) identified in your transcript.</p>
|
|
858
|
+
* <p>Content redaction is performed at the segment level; PII specified in
|
|
859
|
+
* <code>PiiEntityTypes</code> is redacted upon complete transcription of an audio segment.</p>
|
|
860
|
+
* <p>You can’t set <code>ContentRedactionType</code> and <code>ContentIdentificationType</code>
|
|
861
|
+
* in the same request. If you set both, your request returns a
|
|
862
|
+
* <code>BadRequestException</code>.</p>
|
|
863
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html">Redacting or identifying personally identifiable
|
|
864
|
+
* information</a>.</p>
|
|
795
865
|
*/
|
|
796
866
|
ContentRedactionType?: ContentRedactionType | string;
|
|
797
867
|
/**
|
|
798
|
-
* <p>
|
|
799
|
-
* you
|
|
800
|
-
* <code>
|
|
801
|
-
* <p>
|
|
802
|
-
*
|
|
868
|
+
* <p>Specify which types of personally identifiable information (PII) you want to redact in your
|
|
869
|
+
* transcript. You can include as many types as you'd like, or you can select
|
|
870
|
+
* <code>ALL</code>.</p>
|
|
871
|
+
* <p>To include <code>PiiEntityTypes</code> in your request, you must also include either
|
|
872
|
+
* <code>ContentIdentificationType</code> or <code>ContentRedactionType</code>.</p>
|
|
873
|
+
* <p>Values must be comma-separated and can include:
|
|
803
874
|
* <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING</code>,
|
|
804
875
|
* <code>CREDIT_DEBIT_NUMBER</code>, <code>CREDIT_DEBIT_CVV</code>,
|
|
805
876
|
* <code>CREDIT_DEBIT_EXPIRY</code>, <code>PIN</code>, <code>EMAIL</code>,
|
|
806
877
|
* <code>ADDRESS</code>, <code>NAME</code>, <code>PHONE</code>,
|
|
807
|
-
* <code>SSN</code>,
|
|
808
|
-
* <p>
|
|
809
|
-
* <code>PiiEntityTypes</code> is an optional parameter with a default value of
|
|
810
|
-
* <code>ALL</code>.</p>
|
|
878
|
+
* <code>SSN</code>, or <code>ALL</code>.</p>
|
|
811
879
|
*/
|
|
812
880
|
PiiEntityTypes?: string;
|
|
813
881
|
/**
|
|
814
|
-
* <p>
|
|
882
|
+
* <p>Specify the name of the custom language model that you want to use when processing your
|
|
883
|
+
* transcription. Note that language model names are case sensitive.</p>
|
|
884
|
+
* <p>The language of the specified language model must match the language code you specify
|
|
885
|
+
* in your transcription request. If the languages don't match, the language model isn't applied. There
|
|
886
|
+
* are no errors or warnings associated with a language mismatch.</p>
|
|
887
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language
|
|
888
|
+
* models</a>.</p>
|
|
815
889
|
*/
|
|
816
890
|
LanguageModelName?: string;
|
|
817
891
|
/**
|
|
818
|
-
* <p>
|
|
819
|
-
*
|
|
892
|
+
* <p>Enables automatic language identification for your transcription.</p>
|
|
893
|
+
* <p>If you include <code>IdentifyLanguage</code>, you can optionally include a list of
|
|
894
|
+
* language codes, using <code>LanguageOptions</code>, that you think may be present in
|
|
895
|
+
* your audio stream. Including language options can improve transcription accuracy.</p>
|
|
896
|
+
* <p>You can also include a preferred language using <code>PreferredLanguage</code>. Adding a
|
|
897
|
+
* preferred language can help Amazon Transcribe identify the language faster than if you omit this
|
|
898
|
+
* parameter.</p>
|
|
899
|
+
* <p>If you have multi-channel audio that contains different languages on each channel, and you've
|
|
900
|
+
* enabled channel identification, automatic language identification identifies the dominant language on
|
|
901
|
+
* each audio channel.</p>
|
|
902
|
+
* <p>Note that you must include either <code>LanguageCode</code> or
|
|
903
|
+
* <code>IdentifyLanguage</code> in your request. If you include both parameters, your request
|
|
904
|
+
* fails.</p>
|
|
905
|
+
* <p>Streaming language identification can't be combined with custom language models or
|
|
906
|
+
* redaction.</p>
|
|
820
907
|
*/
|
|
821
908
|
IdentifyLanguage?: boolean;
|
|
822
909
|
/**
|
|
823
|
-
* <p>
|
|
824
|
-
*
|
|
825
|
-
*
|
|
826
|
-
*
|
|
827
|
-
*
|
|
828
|
-
*
|
|
829
|
-
*
|
|
910
|
+
* <p>Specify two or more language codes that represent the languages you think may be present
|
|
911
|
+
* in your media; including more than five is not recommended. If you're unsure what languages are present, do
|
|
912
|
+
* not include this parameter.</p>
|
|
913
|
+
* <p>Including language options can improve the accuracy of language identification.</p>
|
|
914
|
+
* <p>If you include <code>LanguageOptions</code> in your request, you must also include
|
|
915
|
+
* <code>IdentifyLanguage</code>.</p>
|
|
916
|
+
* <p>For a list of languages supported with Amazon Transcribe streaming, refer to the
|
|
917
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported
|
|
918
|
+
* languages</a> table.</p>
|
|
919
|
+
* <important>
|
|
920
|
+
* <p>You can only include one language dialect per language per stream. For example, you
|
|
921
|
+
* cannot include <code>en-US</code> and <code>en-AU</code> in the same request.</p>
|
|
922
|
+
* </important>
|
|
830
923
|
*/
|
|
831
924
|
LanguageOptions?: string;
|
|
832
925
|
/**
|
|
833
|
-
* <p>
|
|
834
|
-
* <code>LanguageOptions</code
|
|
835
|
-
*
|
|
836
|
-
*
|
|
837
|
-
* <code>true</code>in your request.</p>
|
|
926
|
+
* <p>Specify a preferred language from the subset of languages codes you specified in
|
|
927
|
+
* <code>LanguageOptions</code>.</p>
|
|
928
|
+
* <p>You can only use this parameter if you've included <code>IdentifyLanguage</code> and
|
|
929
|
+
* <code>LanguageOptions</code> in your request.</p>
|
|
838
930
|
*/
|
|
839
931
|
PreferredLanguage?: LanguageCode | string;
|
|
840
932
|
/**
|
|
841
|
-
* <p>
|
|
842
|
-
*
|
|
843
|
-
*
|
|
844
|
-
*
|
|
845
|
-
*
|
|
846
|
-
*
|
|
847
|
-
*
|
|
933
|
+
* <p>Specify the names of the custom vocabularies that you want to use when processing your
|
|
934
|
+
* transcription. Note that vocabulary names are case sensitive.</p>
|
|
935
|
+
* <p>If none of the languages of the specified custom vocabularies match the language identified in
|
|
936
|
+
* your media, your job fails.</p>
|
|
937
|
+
* <important>
|
|
938
|
+
* <p>This parameter is only intended for use <b>with</b> the
|
|
939
|
+
* <code>IdentifyLanguage</code> parameter. If you're <b>not</b>
|
|
940
|
+
* including <code>IdentifyLanguage</code> in your request and want to use a custom vocabulary
|
|
941
|
+
* with your transcription, use the <code>VocabularyName</code> parameter instead.</p>
|
|
942
|
+
* </important>
|
|
943
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
|
|
848
944
|
*/
|
|
849
945
|
VocabularyNames?: string;
|
|
850
946
|
/**
|
|
851
|
-
* <p>
|
|
852
|
-
*
|
|
853
|
-
*
|
|
854
|
-
*
|
|
855
|
-
*
|
|
856
|
-
*
|
|
857
|
-
*
|
|
947
|
+
* <p>Specify the names of the custom vocabulary filters that you want to use when processing
|
|
948
|
+
* your transcription. Note that vocabulary filter names are case sensitive.</p>
|
|
949
|
+
* <p>If none of the languages of the specified custom vocabulary filters match the language identified
|
|
950
|
+
* in your media, your job fails.</p>
|
|
951
|
+
* <important>
|
|
952
|
+
* <p>This parameter is only intended for use <b>with</b>
|
|
953
|
+
* the <code>IdentifyLanguage</code> parameter. If you're <b>not</b>
|
|
954
|
+
* including <code>IdentifyLanguage</code> in your request and want to use a custom vocabulary filter
|
|
955
|
+
* with your transcription, use the <code>VocabularyFilterName</code> parameter instead.</p>
|
|
956
|
+
* </important>
|
|
957
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html">Using vocabulary filtering with unwanted
|
|
958
|
+
* words</a>.</p>
|
|
858
959
|
*/
|
|
859
960
|
VocabularyFilterNames?: string;
|
|
860
961
|
}
|
|
861
962
|
/**
|
|
862
|
-
* <p>The
|
|
963
|
+
* <p>The <code>Transcript</code> associated with a
|
|
964
|
+
* <code></code>.</p>
|
|
965
|
+
* <p>
|
|
966
|
+
* <code>Transcript</code> contains <code>Results</code>, which contains a set of transcription
|
|
967
|
+
* results from one or more audio segments, along with additional information per your request
|
|
968
|
+
* parameters.</p>
|
|
863
969
|
*/
|
|
864
970
|
export interface Transcript {
|
|
865
971
|
/**
|
|
866
|
-
* <p>
|
|
867
|
-
*
|
|
868
|
-
*
|
|
972
|
+
* <p>Contains a set of transcription results from one or more audio segments, along with additional
|
|
973
|
+
* information per your request parameters. This can include information relating to alternative
|
|
974
|
+
* transcriptions, channel identification, partial result stabilization, language identification, and other
|
|
975
|
+
* transcription-related data.</p>
|
|
869
976
|
*/
|
|
870
977
|
Results?: Result[];
|
|
871
978
|
}
|
|
872
979
|
/**
|
|
873
|
-
* <p>
|
|
874
|
-
*
|
|
980
|
+
* <p>The <code>TranscriptEvent</code> associated with a
|
|
981
|
+
* <code>TranscriptResultStream</code>.</p>
|
|
982
|
+
* <p>Contains a set of transcription results from one or more audio segments, along with additional
|
|
983
|
+
* information per your request parameters.</p>
|
|
875
984
|
*/
|
|
876
985
|
export interface TranscriptEvent {
|
|
877
986
|
/**
|
|
878
|
-
* <p>
|
|
879
|
-
*
|
|
987
|
+
* <p>Contains <code>Results</code>, which contains a set of transcription results from one or
|
|
988
|
+
* more audio segments, along with additional information per your request parameters. This can
|
|
989
|
+
* include information relating to alternative transcriptions, channel identification, partial
|
|
990
|
+
* result stabilization, language identification, and other transcription-related data.</p>
|
|
880
991
|
*/
|
|
881
992
|
Transcript?: Transcript;
|
|
882
993
|
}
|
|
883
994
|
/**
|
|
884
|
-
* <p>
|
|
995
|
+
* <p>Contains detailed information about your streaming session.</p>
|
|
885
996
|
*/
|
|
886
997
|
export declare type TranscriptResultStream = TranscriptResultStream.BadRequestExceptionMember | TranscriptResultStream.ConflictExceptionMember | TranscriptResultStream.InternalFailureExceptionMember | TranscriptResultStream.LimitExceededExceptionMember | TranscriptResultStream.ServiceUnavailableExceptionMember | TranscriptResultStream.TranscriptEventMember | TranscriptResultStream.$UnknownMember;
|
|
887
998
|
export declare namespace TranscriptResultStream {
|
|
888
999
|
/**
|
|
889
|
-
* <p>
|
|
890
|
-
*
|
|
891
|
-
*
|
|
1000
|
+
* <p>Contains <code>Transcript</code>, which contains <code>Results</code>. The
|
|
1001
|
+
* <code></code> object contains a set of transcription
|
|
1002
|
+
* results from one or more audio segments, along with additional information per your request
|
|
1003
|
+
* parameters.</p>
|
|
892
1004
|
*/
|
|
893
1005
|
interface TranscriptEventMember {
|
|
894
1006
|
TranscriptEvent: TranscriptEvent;
|
|
@@ -913,8 +1025,8 @@ export declare namespace TranscriptResultStream {
|
|
|
913
1025
|
$unknown?: never;
|
|
914
1026
|
}
|
|
915
1027
|
/**
|
|
916
|
-
* <p>Your client has exceeded one of the Amazon Transcribe limits
|
|
917
|
-
* Break your audio stream into smaller chunks and try your request again.</p>
|
|
1028
|
+
* <p>Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length
|
|
1029
|
+
* limit. Break your audio stream into smaller chunks and try your request again.</p>
|
|
918
1030
|
*/
|
|
919
1031
|
interface LimitExceededExceptionMember {
|
|
920
1032
|
TranscriptEvent?: never;
|
|
@@ -926,7 +1038,8 @@ export declare namespace TranscriptResultStream {
|
|
|
926
1038
|
$unknown?: never;
|
|
927
1039
|
}
|
|
928
1040
|
/**
|
|
929
|
-
* <p>A problem occurred while processing the audio. Amazon Transcribe terminated
|
|
1041
|
+
* <p>A problem occurred while processing the audio. Amazon Transcribe terminated
|
|
1042
|
+
* processing.</p>
|
|
930
1043
|
*/
|
|
931
1044
|
interface InternalFailureExceptionMember {
|
|
932
1045
|
TranscriptEvent?: never;
|
|
@@ -951,7 +1064,7 @@ export declare namespace TranscriptResultStream {
|
|
|
951
1064
|
$unknown?: never;
|
|
952
1065
|
}
|
|
953
1066
|
/**
|
|
954
|
-
* <p>
|
|
1067
|
+
* <p>The service is currently unavailable. Try your request later.</p>
|
|
955
1068
|
*/
|
|
956
1069
|
interface ServiceUnavailableExceptionMember {
|
|
957
1070
|
TranscriptEvent?: never;
|
|
@@ -984,68 +1097,68 @@ export declare namespace TranscriptResultStream {
|
|
|
984
1097
|
}
|
|
985
1098
|
export interface StartStreamTranscriptionResponse {
|
|
986
1099
|
/**
|
|
987
|
-
* <p>
|
|
1100
|
+
* <p>Provides the identifier for your streaming request.</p>
|
|
988
1101
|
*/
|
|
989
1102
|
RequestId?: string;
|
|
990
1103
|
/**
|
|
991
|
-
* <p>
|
|
1104
|
+
* <p>Provides the language code that you specified in your request.</p>
|
|
992
1105
|
*/
|
|
993
1106
|
LanguageCode?: LanguageCode | string;
|
|
994
1107
|
/**
|
|
995
|
-
* <p>
|
|
1108
|
+
* <p>Provides the sample rate that you specified in your request.</p>
|
|
996
1109
|
*/
|
|
997
1110
|
MediaSampleRateHertz?: number;
|
|
998
1111
|
/**
|
|
999
|
-
* <p>
|
|
1112
|
+
* <p>Provides the media encoding you specified in your request.</p>
|
|
1000
1113
|
*/
|
|
1001
1114
|
MediaEncoding?: MediaEncoding | string;
|
|
1002
1115
|
/**
|
|
1003
|
-
* <p>
|
|
1116
|
+
* <p>Provides the name of the custom vocabulary that you specified in your request.</p>
|
|
1004
1117
|
*/
|
|
1005
1118
|
VocabularyName?: string;
|
|
1006
1119
|
/**
|
|
1007
|
-
* <p>
|
|
1120
|
+
* <p>Provides the identifier for your transcription session.</p>
|
|
1008
1121
|
*/
|
|
1009
1122
|
SessionId?: string;
|
|
1010
1123
|
/**
|
|
1011
|
-
* <p>
|
|
1124
|
+
* <p>Provides detailed information about your streaming session.</p>
|
|
1012
1125
|
*/
|
|
1013
1126
|
TranscriptResultStream?: AsyncIterable<TranscriptResultStream>;
|
|
1014
1127
|
/**
|
|
1015
|
-
* <p>
|
|
1128
|
+
* <p>Provides the name of the custom vocabulary filter that you specified in your
|
|
1129
|
+
* request.</p>
|
|
1016
1130
|
*/
|
|
1017
1131
|
VocabularyFilterName?: string;
|
|
1018
1132
|
/**
|
|
1019
|
-
* <p>
|
|
1133
|
+
* <p>Provides the vocabulary filtering method used in your transcription.</p>
|
|
1020
1134
|
*/
|
|
1021
1135
|
VocabularyFilterMethod?: VocabularyFilterMethod | string;
|
|
1022
1136
|
/**
|
|
1023
|
-
* <p>Shows whether speaker
|
|
1137
|
+
* <p>Shows whether speaker partitioning was enabled for your transcription.</p>
|
|
1024
1138
|
*/
|
|
1025
1139
|
ShowSpeakerLabel?: boolean;
|
|
1026
1140
|
/**
|
|
1027
|
-
* <p>Shows whether
|
|
1141
|
+
* <p>Shows whether channel identification was enabled for your transcription.</p>
|
|
1028
1142
|
*/
|
|
1029
1143
|
EnableChannelIdentification?: boolean;
|
|
1030
1144
|
/**
|
|
1031
|
-
* <p>
|
|
1145
|
+
* <p>Provides the number of channels that you specified in your request.</p>
|
|
1032
1146
|
*/
|
|
1033
1147
|
NumberOfChannels?: number;
|
|
1034
1148
|
/**
|
|
1035
|
-
* <p>Shows whether partial results stabilization was enabled
|
|
1149
|
+
* <p>Shows whether partial results stabilization was enabled for your transcription.</p>
|
|
1036
1150
|
*/
|
|
1037
1151
|
EnablePartialResultsStabilization?: boolean;
|
|
1038
1152
|
/**
|
|
1039
|
-
* <p>
|
|
1040
|
-
* level.</p>
|
|
1153
|
+
* <p>Provides the stabilization level used for your transcription.</p>
|
|
1041
1154
|
*/
|
|
1042
1155
|
PartialResultsStability?: PartialResultsStability | string;
|
|
1043
1156
|
/**
|
|
1044
|
-
* <p>Shows whether content identification was enabled
|
|
1157
|
+
* <p>Shows whether content identification was enabled for your transcription.</p>
|
|
1045
1158
|
*/
|
|
1046
1159
|
ContentIdentificationType?: ContentIdentificationType | string;
|
|
1047
1160
|
/**
|
|
1048
|
-
* <p>Shows whether content redaction was enabled
|
|
1161
|
+
* <p>Shows whether content redaction was enabled for your transcription.</p>
|
|
1049
1162
|
*/
|
|
1050
1163
|
ContentRedactionType?: ContentRedactionType | string;
|
|
1051
1164
|
/**
|
|
@@ -1053,28 +1166,29 @@ export interface StartStreamTranscriptionResponse {
|
|
|
1053
1166
|
*/
|
|
1054
1167
|
PiiEntityTypes?: string;
|
|
1055
1168
|
/**
|
|
1056
|
-
* <p>
|
|
1169
|
+
* <p>Provides the name of the custom language model that you specified in your request.</p>
|
|
1057
1170
|
*/
|
|
1058
1171
|
LanguageModelName?: string;
|
|
1059
1172
|
/**
|
|
1060
|
-
* <p>
|
|
1173
|
+
* <p>Shows whether automatic language identification was enabled for your
|
|
1174
|
+
* transcription.</p>
|
|
1061
1175
|
*/
|
|
1062
1176
|
IdentifyLanguage?: boolean;
|
|
1063
1177
|
/**
|
|
1064
|
-
* <p>
|
|
1065
|
-
* language.</p>
|
|
1178
|
+
* <p>Provides the language codes that you specified in your request.</p>
|
|
1066
1179
|
*/
|
|
1067
1180
|
LanguageOptions?: string;
|
|
1068
1181
|
/**
|
|
1069
|
-
* <p>
|
|
1182
|
+
* <p>Provides the preferred language that you specified in your request.</p>
|
|
1070
1183
|
*/
|
|
1071
1184
|
PreferredLanguage?: LanguageCode | string;
|
|
1072
1185
|
/**
|
|
1073
|
-
* <p>
|
|
1186
|
+
* <p>Provides the names of the custom vocabularies that you specified in your request.</p>
|
|
1074
1187
|
*/
|
|
1075
1188
|
VocabularyNames?: string;
|
|
1076
1189
|
/**
|
|
1077
|
-
* <p>
|
|
1190
|
+
* <p>Provides the names of the custom vocabulary filters that you specified in your
|
|
1191
|
+
* request.</p>
|
|
1078
1192
|
*/
|
|
1079
1193
|
VocabularyFilterNames?: string;
|
|
1080
1194
|
}
|