@aws-sdk/client-transcribe-streaming 3.216.0 → 3.222.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/TranscribeStreaming.js +15 -0
- package/dist-cjs/commands/StartCallAnalyticsStreamTranscriptionCommand.js +48 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/endpoint/ruleset.js +4 -4
- package/dist-cjs/models/models_0.js +168 -41
- package/dist-cjs/protocols/Aws_restJson1.js +336 -1
- package/dist-es/TranscribeStreaming.js +15 -0
- package/dist-es/commands/StartCallAnalyticsStreamTranscriptionCommand.js +44 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/endpoint/ruleset.js +4 -4
- package/dist-es/models/models_0.js +151 -39
- package/dist-es/protocols/Aws_restJson1.js +334 -1
- package/dist-types/TranscribeStreaming.d.ts +65 -9
- package/dist-types/TranscribeStreamingClient.d.ts +12 -4
- package/dist-types/commands/StartCallAnalyticsStreamTranscriptionCommand.d.ts +58 -0
- package/dist-types/commands/StartMedicalStreamTranscriptionCommand.d.ts +18 -0
- package/dist-types/commands/StartStreamTranscriptionCommand.d.ts +10 -7
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +776 -53
- package/dist-types/protocols/Aws_restJson1.d.ts +3 -0
- package/dist-types/ts3.4/TranscribeStreaming.d.ts +23 -0
- package/dist-types/ts3.4/TranscribeStreamingClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/StartCallAnalyticsStreamTranscriptionCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +302 -27
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +35 -34
|
@@ -115,12 +115,140 @@ export interface AudioEvent {
|
|
|
115
115
|
*/
|
|
116
116
|
AudioChunk?: Uint8Array;
|
|
117
117
|
}
|
|
118
|
+
export declare enum ParticipantRole {
|
|
119
|
+
AGENT = "AGENT",
|
|
120
|
+
CUSTOMER = "CUSTOMER"
|
|
121
|
+
}
|
|
122
|
+
/**
|
|
123
|
+
* <p>Makes it possible to specify which speaker is on which audio channel. For example, if your
|
|
124
|
+
* agent is the first participant to speak, you would set <code>ChannelId</code> to
|
|
125
|
+
* <code>0</code> (to indicate the first channel) and <code>ParticipantRole</code> to
|
|
126
|
+
* <code>AGENT</code> (to indicate that it's the agent speaking).</p>
|
|
127
|
+
*/
|
|
128
|
+
export interface ChannelDefinition {
|
|
129
|
+
/**
|
|
130
|
+
* <p>Specify the audio channel you want to define.</p>
|
|
131
|
+
*/
|
|
132
|
+
ChannelId: number | undefined;
|
|
133
|
+
/**
|
|
134
|
+
* <p>Specify the speaker you want to define. Omitting this parameter is equivalent to
|
|
135
|
+
* specifying both participants.</p>
|
|
136
|
+
*/
|
|
137
|
+
ParticipantRole: ParticipantRole | string | undefined;
|
|
138
|
+
}
|
|
139
|
+
export declare enum ContentRedactionOutput {
|
|
140
|
+
REDACTED = "redacted",
|
|
141
|
+
REDACTED_AND_UNREDACTED = "redacted_and_unredacted"
|
|
142
|
+
}
|
|
143
|
+
/**
|
|
144
|
+
* <p>Allows you to specify additional settings for your streaming Call Analytics
|
|
145
|
+
* post-call request, including output locations for your redacted and unredacted
|
|
146
|
+
* transcript, which IAM role to use, and, optionally, which encryption key to
|
|
147
|
+
* use.</p>
|
|
148
|
+
* <p>
|
|
149
|
+
* <code>ContentRedactionOutput</code>, <code>DataAccessRoleArn</code>, and
|
|
150
|
+
* <code>OutputLocation</code> are required fields.</p>
|
|
151
|
+
*/
|
|
152
|
+
export interface PostCallAnalyticsSettings {
|
|
153
|
+
/**
|
|
154
|
+
* <p>The Amazon S3 location where you want your Call Analytics post-call
|
|
155
|
+
* transcription output stored. You can use any of the following formats to specify the output
|
|
156
|
+
* location:</p>
|
|
157
|
+
* <ol>
|
|
158
|
+
* <li>
|
|
159
|
+
* <p>s3://DOC-EXAMPLE-BUCKET</p>
|
|
160
|
+
* </li>
|
|
161
|
+
* <li>
|
|
162
|
+
* <p>s3://DOC-EXAMPLE-BUCKET/my-output-folder/</p>
|
|
163
|
+
* </li>
|
|
164
|
+
* <li>
|
|
165
|
+
* <p>s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json</p>
|
|
166
|
+
* </li>
|
|
167
|
+
* </ol>
|
|
168
|
+
*/
|
|
169
|
+
OutputLocation: string | undefined;
|
|
170
|
+
/**
|
|
171
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
|
|
172
|
+
* access the Amazon S3 bucket that contains your input files. If the role that you
|
|
173
|
+
* specify doesn’t have the appropriate permissions to access the specified Amazon S3
|
|
174
|
+
* location, your request fails.</p>
|
|
175
|
+
* <p>IAM role ARNs have the format
|
|
176
|
+
* <code>arn:partition:iam::account:role/role-name-with-path</code>. For example:
|
|
177
|
+
* <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
|
|
178
|
+
* ARNs</a>.</p>
|
|
179
|
+
*/
|
|
180
|
+
DataAccessRoleArn: string | undefined;
|
|
181
|
+
/**
|
|
182
|
+
* <p>Specify whether you want only a redacted transcript or both a redacted and an unredacted
|
|
183
|
+
* transcript. If you choose redacted and unredacted, two JSON files are generated and stored in the
|
|
184
|
+
* Amazon S3 output location you specify.</p>
|
|
185
|
+
* <p>Note that to include <code>ContentRedactionOutput</code> in your request, you must
|
|
186
|
+
* enable content redaction (<code>ContentRedactionType</code>).</p>
|
|
187
|
+
*/
|
|
188
|
+
ContentRedactionOutput?: ContentRedactionOutput | string;
|
|
189
|
+
/**
|
|
190
|
+
* <p>The KMS key you want to use to encrypt your Call Analytics post-call
|
|
191
|
+
* output.</p>
|
|
192
|
+
* <p>If using a key located in the <b>current</b>
|
|
193
|
+
* Amazon Web Services account, you can specify your KMS key in one of four
|
|
194
|
+
* ways:</p>
|
|
195
|
+
* <ol>
|
|
196
|
+
* <li>
|
|
197
|
+
* <p>Use the KMS key ID itself. For example,
|
|
198
|
+
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
199
|
+
* </li>
|
|
200
|
+
* <li>
|
|
201
|
+
* <p>Use an alias for the KMS key ID. For example,
|
|
202
|
+
* <code>alias/ExampleAlias</code>.</p>
|
|
203
|
+
* </li>
|
|
204
|
+
* <li>
|
|
205
|
+
* <p>Use the Amazon Resource Name (ARN) for the KMS key ID. For
|
|
206
|
+
* example,
|
|
207
|
+
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
208
|
+
* </li>
|
|
209
|
+
* <li>
|
|
210
|
+
* <p>Use the ARN for the KMS key alias. For example,
|
|
211
|
+
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
|
|
212
|
+
* </li>
|
|
213
|
+
* </ol>
|
|
214
|
+
* <p>If using a key located in a <b>different</b>
|
|
215
|
+
* Amazon Web Services account than the current Amazon Web Services account, you can specify
|
|
216
|
+
* your KMS key in one of two ways:</p>
|
|
217
|
+
* <ol>
|
|
218
|
+
* <li>
|
|
219
|
+
* <p>Use the ARN for the KMS key ID. For example,
|
|
220
|
+
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
221
|
+
* </li>
|
|
222
|
+
* <li>
|
|
223
|
+
* <p>Use the ARN for the KMS key alias. For example,
|
|
224
|
+
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
|
|
225
|
+
* </li>
|
|
226
|
+
* </ol>
|
|
227
|
+
* <p>Note that the user making the request must
|
|
228
|
+
* have permission to use the specified KMS key.</p>
|
|
229
|
+
*/
|
|
230
|
+
OutputEncryptionKMSKeyId?: string;
|
|
231
|
+
}
|
|
232
|
+
/**
|
|
233
|
+
* <p>Allows you to set audio channel definitions and post-call analytics settings.</p>
|
|
234
|
+
*/
|
|
235
|
+
export interface ConfigurationEvent {
|
|
236
|
+
/**
|
|
237
|
+
* <p>Indicates which speaker is on which audio channel.</p>
|
|
238
|
+
*/
|
|
239
|
+
ChannelDefinitions?: ChannelDefinition[];
|
|
240
|
+
/**
|
|
241
|
+
* <p>Provides additional optional settings for your Call Analytics post-call request, including
|
|
242
|
+
* encryption and output locations for your redacted and unredacted transcript.</p>
|
|
243
|
+
*/
|
|
244
|
+
PostCallAnalyticsSettings?: PostCallAnalyticsSettings;
|
|
245
|
+
}
|
|
118
246
|
/**
|
|
119
247
|
* <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket
|
|
120
248
|
* data frames.</p>
|
|
121
249
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
|
|
122
250
|
*/
|
|
123
|
-
export declare type AudioStream = AudioStream.AudioEventMember | AudioStream.$UnknownMember;
|
|
251
|
+
export declare type AudioStream = AudioStream.AudioEventMember | AudioStream.ConfigurationEventMember | AudioStream.$UnknownMember;
|
|
124
252
|
export declare namespace AudioStream {
|
|
125
253
|
/**
|
|
126
254
|
* <p>A blob of audio from your application. Your audio stream consists of one or more audio
|
|
@@ -129,23 +257,34 @@ export declare namespace AudioStream {
|
|
|
129
257
|
*/
|
|
130
258
|
interface AudioEventMember {
|
|
131
259
|
AudioEvent: AudioEvent;
|
|
260
|
+
ConfigurationEvent?: never;
|
|
261
|
+
$unknown?: never;
|
|
262
|
+
}
|
|
263
|
+
/**
|
|
264
|
+
* <p>Contains audio channel definitions and post-call analytics settings.</p>
|
|
265
|
+
*/
|
|
266
|
+
interface ConfigurationEventMember {
|
|
267
|
+
AudioEvent?: never;
|
|
268
|
+
ConfigurationEvent: ConfigurationEvent;
|
|
132
269
|
$unknown?: never;
|
|
133
270
|
}
|
|
134
271
|
interface $UnknownMember {
|
|
135
272
|
AudioEvent?: never;
|
|
273
|
+
ConfigurationEvent?: never;
|
|
136
274
|
$unknown: [string, any];
|
|
137
275
|
}
|
|
138
276
|
interface Visitor<T> {
|
|
139
277
|
AudioEvent: (value: AudioEvent) => T;
|
|
278
|
+
ConfigurationEvent: (value: ConfigurationEvent) => T;
|
|
140
279
|
_: (name: string, value: any) => T;
|
|
141
280
|
}
|
|
142
281
|
const visit: <T>(value: AudioStream, visitor: Visitor<T>) => T;
|
|
143
282
|
}
|
|
144
283
|
/**
|
|
145
|
-
* <p>One or more arguments to the <code>StartStreamTranscription</code
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
* specified parameters and try your request again.</p>
|
|
284
|
+
* <p>One or more arguments to the <code>StartStreamTranscription</code>,
|
|
285
|
+
* <code>StartMedicalStreamTranscription</code>, or <code>StartCallAnalyticsStreamTranscription</code>
|
|
286
|
+
* operation was not valid. For example, <code>MediaEncoding</code> or <code>LanguageCode</code>
|
|
287
|
+
* used not valid values. Check the specified parameters and try your request again.</p>
|
|
149
288
|
*/
|
|
150
289
|
export declare class BadRequestException extends __BaseException {
|
|
151
290
|
readonly name: "BadRequestException";
|
|
@@ -156,6 +295,130 @@ export declare class BadRequestException extends __BaseException {
|
|
|
156
295
|
*/
|
|
157
296
|
constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
|
|
158
297
|
}
|
|
298
|
+
/**
|
|
299
|
+
* <p>Contains entities identified as personally identifiable information (PII) in your
|
|
300
|
+
* transcription output, along with various associated attributes. Examples include category,
|
|
301
|
+
* confidence score, content, type, and start and end times.</p>
|
|
302
|
+
*/
|
|
303
|
+
export interface CallAnalyticsEntity {
|
|
304
|
+
/**
|
|
305
|
+
* <p>The time, in milliseconds, from the beginning of the audio stream to the start of the identified entity.</p>
|
|
306
|
+
*/
|
|
307
|
+
BeginOffsetMillis?: number;
|
|
308
|
+
/**
|
|
309
|
+
* <p>The time, in milliseconds, from the beginning of the audio stream to the end of the identified entity.</p>
|
|
310
|
+
*/
|
|
311
|
+
EndOffsetMillis?: number;
|
|
312
|
+
/**
|
|
313
|
+
* <p>The category of information identified. For example, <code>PII</code>.</p>
|
|
314
|
+
*/
|
|
315
|
+
Category?: string;
|
|
316
|
+
/**
|
|
317
|
+
* <p>The type of PII identified. For example, <code>NAME</code> or
|
|
318
|
+
* <code>CREDIT_DEBIT_NUMBER</code>.</p>
|
|
319
|
+
*/
|
|
320
|
+
Type?: string;
|
|
321
|
+
/**
|
|
322
|
+
* <p>The word or words that represent the identified entity.</p>
|
|
323
|
+
*/
|
|
324
|
+
Content?: string;
|
|
325
|
+
/**
|
|
326
|
+
* <p>The confidence score associated with the identification of an entity in your transcript.</p>
|
|
327
|
+
* <p>Confidence scores are values between 0 and 1. A larger value indicates a higher
|
|
328
|
+
* probability that the identified entity correctly matches the entity spoken in your
|
|
329
|
+
* media.</p>
|
|
330
|
+
*/
|
|
331
|
+
Confidence?: number;
|
|
332
|
+
}
|
|
333
|
+
/**
|
|
334
|
+
* <p>A word, phrase, or punctuation mark in your Call Analytics transcription output, along with various
|
|
335
|
+
* associated attributes, such as confidence score, type, and start and end times.</p>
|
|
336
|
+
*/
|
|
337
|
+
export interface CallAnalyticsItem {
|
|
338
|
+
/**
|
|
339
|
+
* <p>The time, in milliseconds, from the beginning of the audio stream to the start of the identified item.</p>
|
|
340
|
+
*/
|
|
341
|
+
BeginOffsetMillis?: number;
|
|
342
|
+
/**
|
|
343
|
+
* <p>The time, in milliseconds, from the beginning of the audio stream to the end of the identified item.</p>
|
|
344
|
+
*/
|
|
345
|
+
EndOffsetMillis?: number;
|
|
346
|
+
/**
|
|
347
|
+
* <p>The type of item identified. Options are: <code>PRONUNCIATION</code> (spoken words) and
|
|
348
|
+
* <code>PUNCTUATION</code>.</p>
|
|
349
|
+
*/
|
|
350
|
+
Type?: ItemType | string;
|
|
351
|
+
/**
|
|
352
|
+
* <p>The word or punctuation that was transcribed.</p>
|
|
353
|
+
*/
|
|
354
|
+
Content?: string;
|
|
355
|
+
/**
|
|
356
|
+
* <p>The confidence score associated with a word or phrase in your transcript.</p>
|
|
357
|
+
* <p>Confidence scores are values between 0 and 1. A larger value indicates a higher
|
|
358
|
+
* probability that the identified item correctly matches the item spoken in your media.</p>
|
|
359
|
+
*/
|
|
360
|
+
Confidence?: number;
|
|
361
|
+
/**
|
|
362
|
+
* <p>Indicates whether the specified item matches a word in the vocabulary filter included in
|
|
363
|
+
* your Call Analytics request. If <code>true</code>, there is a vocabulary filter match.</p>
|
|
364
|
+
*/
|
|
365
|
+
VocabularyFilterMatch?: boolean;
|
|
366
|
+
/**
|
|
367
|
+
* <p>If partial result stabilization is enabled, <code>Stable</code> indicates whether the specified
|
|
368
|
+
* item is stable (<code>true</code>) or if it may change when the segment is complete
|
|
369
|
+
* (<code>false</code>).</p>
|
|
370
|
+
*/
|
|
371
|
+
Stable?: boolean;
|
|
372
|
+
}
|
|
373
|
+
export declare enum CallAnalyticsLanguageCode {
|
|
374
|
+
DE_DE = "de-DE",
|
|
375
|
+
EN_AU = "en-AU",
|
|
376
|
+
EN_GB = "en-GB",
|
|
377
|
+
EN_US = "en-US",
|
|
378
|
+
ES_US = "es-US",
|
|
379
|
+
FR_CA = "fr-CA",
|
|
380
|
+
FR_FR = "fr-FR",
|
|
381
|
+
IT_IT = "it-IT",
|
|
382
|
+
PT_BR = "pt-BR"
|
|
383
|
+
}
|
|
384
|
+
/**
|
|
385
|
+
* <p>Contains the timestamp range (start time through end time) of a matched category.</p>
|
|
386
|
+
*/
|
|
387
|
+
export interface TimestampRange {
|
|
388
|
+
/**
|
|
389
|
+
* <p>The time, in milliseconds, from the beginning of the audio stream to the start of the category
|
|
390
|
+
* match.</p>
|
|
391
|
+
*/
|
|
392
|
+
BeginOffsetMillis?: number;
|
|
393
|
+
/**
|
|
394
|
+
* <p>The time, in milliseconds, from the beginning of the audio stream to the end of the category
|
|
395
|
+
* match.</p>
|
|
396
|
+
*/
|
|
397
|
+
EndOffsetMillis?: number;
|
|
398
|
+
}
|
|
399
|
+
/**
|
|
400
|
+
* <p>Contains the timestamps of matched categories.</p>
|
|
401
|
+
*/
|
|
402
|
+
export interface PointsOfInterest {
|
|
403
|
+
/**
|
|
404
|
+
* <p>Contains the timestamp ranges (start time through end time) of matched categories and rules.</p>
|
|
405
|
+
*/
|
|
406
|
+
TimestampRanges?: TimestampRange[];
|
|
407
|
+
}
|
|
408
|
+
/**
|
|
409
|
+
* <p>Provides information on any <code>TranscriptFilterType</code> categories that matched your
|
|
410
|
+
* transcription output. Matches are identified for each segment upon completion of that segment.</p>
|
|
411
|
+
*/
|
|
412
|
+
export interface CategoryEvent {
|
|
413
|
+
/**
|
|
414
|
+
* <p>Lists the categories that were matched in your audio segment.</p>
|
|
415
|
+
*/
|
|
416
|
+
MatchedCategories?: string[];
|
|
417
|
+
/**
|
|
418
|
+
* <p>Contains information about the matched categories, including category names and timestamps.</p>
|
|
419
|
+
*/
|
|
420
|
+
MatchedDetails?: Record<string, PointsOfInterest>;
|
|
421
|
+
}
|
|
159
422
|
/**
|
|
160
423
|
* <p>A new stream started with the same session ID. The current stream has been terminated.</p>
|
|
161
424
|
*/
|
|
@@ -168,12 +431,6 @@ export declare class ConflictException extends __BaseException {
|
|
|
168
431
|
*/
|
|
169
432
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
170
433
|
}
|
|
171
|
-
export declare enum ContentIdentificationType {
|
|
172
|
-
PII = "PII"
|
|
173
|
-
}
|
|
174
|
-
export declare enum ContentRedactionType {
|
|
175
|
-
PII = "PII"
|
|
176
|
-
}
|
|
177
434
|
/**
|
|
178
435
|
* <p>A problem occurred while processing the audio. Amazon Transcribe terminated
|
|
179
436
|
* processing.</p>
|
|
@@ -187,6 +444,248 @@ export declare class InternalFailureException extends __BaseException {
|
|
|
187
444
|
*/
|
|
188
445
|
constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
|
|
189
446
|
}
|
|
447
|
+
/**
|
|
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>
|
|
450
|
+
*/
|
|
451
|
+
export declare class LimitExceededException extends __BaseException {
|
|
452
|
+
readonly name: "LimitExceededException";
|
|
453
|
+
readonly $fault: "client";
|
|
454
|
+
Message?: string;
|
|
455
|
+
/**
|
|
456
|
+
* @internal
|
|
457
|
+
*/
|
|
458
|
+
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
459
|
+
}
|
|
460
|
+
/**
|
|
461
|
+
* <p>The service is currently unavailable. Try your request later.</p>
|
|
462
|
+
*/
|
|
463
|
+
export declare class ServiceUnavailableException extends __BaseException {
|
|
464
|
+
readonly name: "ServiceUnavailableException";
|
|
465
|
+
readonly $fault: "server";
|
|
466
|
+
Message?: string;
|
|
467
|
+
/**
|
|
468
|
+
* @internal
|
|
469
|
+
*/
|
|
470
|
+
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
471
|
+
}
|
|
472
|
+
/**
|
|
473
|
+
* <p>Provides the location, using character count, in your transcript where a match is identified. For example,
|
|
474
|
+
* the location of an issue or a category match within a segment.</p>
|
|
475
|
+
*/
|
|
476
|
+
export interface CharacterOffsets {
|
|
477
|
+
/**
|
|
478
|
+
* <p>Provides the character count of the first character where a match is identified. For example, the first
|
|
479
|
+
* character associated with an issue or a category match in a segment transcript.</p>
|
|
480
|
+
*/
|
|
481
|
+
Begin?: number;
|
|
482
|
+
/**
|
|
483
|
+
* <p>Provides the character count of the last character where a match is identified. For example, the last
|
|
484
|
+
* character associated with an issue or a category match in a segment transcript.</p>
|
|
485
|
+
*/
|
|
486
|
+
End?: number;
|
|
487
|
+
}
|
|
488
|
+
/**
|
|
489
|
+
* <p>Lists the issues that were identified in your audio segment.</p>
|
|
490
|
+
*/
|
|
491
|
+
export interface IssueDetected {
|
|
492
|
+
/**
|
|
493
|
+
* <p>Provides the timestamps that identify when in an audio segment the specified issue occurs.</p>
|
|
494
|
+
*/
|
|
495
|
+
CharacterOffsets?: CharacterOffsets;
|
|
496
|
+
}
|
|
497
|
+
export declare enum Sentiment {
|
|
498
|
+
MIXED = "MIXED",
|
|
499
|
+
NEGATIVE = "NEGATIVE",
|
|
500
|
+
NEUTRAL = "NEUTRAL",
|
|
501
|
+
POSITIVE = "POSITIVE"
|
|
502
|
+
}
|
|
503
|
+
/**
|
|
504
|
+
* <p>Contains set of transcription results from one or more audio segments, along with additional
|
|
505
|
+
* information about the parameters included in your request. For example, channel definitions, partial result
|
|
506
|
+
* stabilization, sentiment, and issue detection.</p>
|
|
507
|
+
*/
|
|
508
|
+
export interface UtteranceEvent {
|
|
509
|
+
/**
|
|
510
|
+
* <p>The unique identifier that is associated with the specified <code>UtteranceEvent</code>.</p>
|
|
511
|
+
*/
|
|
512
|
+
UtteranceId?: string;
|
|
513
|
+
/**
|
|
514
|
+
* <p>Indicates whether the segment in the <code>UtteranceEvent</code> is complete
|
|
515
|
+
* (<code>FALSE</code>) or partial (<code>TRUE</code>).</p>
|
|
516
|
+
*/
|
|
517
|
+
IsPartial?: boolean;
|
|
518
|
+
/**
|
|
519
|
+
* <p>Provides the role of the speaker for each audio channel, either <code>CUSTOMER</code> or
|
|
520
|
+
* <code>AGENT</code>.</p>
|
|
521
|
+
*/
|
|
522
|
+
ParticipantRole?: ParticipantRole | string;
|
|
523
|
+
/**
|
|
524
|
+
* <p>The time, in milliseconds, from the beginning of the audio stream to the start of the
|
|
525
|
+
* <code>UtteranceEvent</code>.</p>
|
|
526
|
+
*/
|
|
527
|
+
BeginOffsetMillis?: number;
|
|
528
|
+
/**
|
|
529
|
+
* <p>The time, in milliseconds, from the beginning of the audio stream to the start of the
|
|
530
|
+
* <code>UtteranceEvent</code>.</p>
|
|
531
|
+
*/
|
|
532
|
+
EndOffsetMillis?: number;
|
|
533
|
+
/**
|
|
534
|
+
* <p>Contains transcribed text.</p>
|
|
535
|
+
*/
|
|
536
|
+
Transcript?: string;
|
|
537
|
+
/**
|
|
538
|
+
* <p>Contains words, phrases, or punctuation marks that are associated with the specified
|
|
539
|
+
* <code>UtteranceEvent</code>.</p>
|
|
540
|
+
*/
|
|
541
|
+
Items?: CallAnalyticsItem[];
|
|
542
|
+
/**
|
|
543
|
+
* <p>Contains entities identified as personally identifiable information (PII) in your transcription
|
|
544
|
+
* output.</p>
|
|
545
|
+
*/
|
|
546
|
+
Entities?: CallAnalyticsEntity[];
|
|
547
|
+
/**
|
|
548
|
+
* <p>Provides the sentiment that was detected in the specified segment.</p>
|
|
549
|
+
*/
|
|
550
|
+
Sentiment?: Sentiment | string;
|
|
551
|
+
/**
|
|
552
|
+
* <p>Provides the issue that was detected in the specified segment.</p>
|
|
553
|
+
*/
|
|
554
|
+
IssuesDetected?: IssueDetected[];
|
|
555
|
+
}
|
|
556
|
+
/**
|
|
557
|
+
* <p>Contains detailed information about your Call Analytics streaming session. These details are
|
|
558
|
+
* provided in the <code>UtteranceEvent</code> and <code>CategoryEvent</code> objects.</p>
|
|
559
|
+
*/
|
|
560
|
+
export declare type CallAnalyticsTranscriptResultStream = CallAnalyticsTranscriptResultStream.BadRequestExceptionMember | CallAnalyticsTranscriptResultStream.CategoryEventMember | CallAnalyticsTranscriptResultStream.ConflictExceptionMember | CallAnalyticsTranscriptResultStream.InternalFailureExceptionMember | CallAnalyticsTranscriptResultStream.LimitExceededExceptionMember | CallAnalyticsTranscriptResultStream.ServiceUnavailableExceptionMember | CallAnalyticsTranscriptResultStream.UtteranceEventMember | CallAnalyticsTranscriptResultStream.$UnknownMember;
|
|
561
|
+
export declare namespace CallAnalyticsTranscriptResultStream {
|
|
562
|
+
/**
|
|
563
|
+
* <p>Contains set of transcription results from one or more audio segments, along with additional
|
|
564
|
+
* information per your request parameters. This can include information relating to channel definitions,
|
|
565
|
+
* partial result stabilization, sentiment, issue detection, and other transcription-related data.</p>
|
|
566
|
+
*/
|
|
567
|
+
interface UtteranceEventMember {
|
|
568
|
+
UtteranceEvent: UtteranceEvent;
|
|
569
|
+
CategoryEvent?: never;
|
|
570
|
+
BadRequestException?: never;
|
|
571
|
+
LimitExceededException?: never;
|
|
572
|
+
InternalFailureException?: never;
|
|
573
|
+
ConflictException?: never;
|
|
574
|
+
ServiceUnavailableException?: never;
|
|
575
|
+
$unknown?: never;
|
|
576
|
+
}
|
|
577
|
+
/**
|
|
578
|
+
* <p>Provides information on matched categories that were used to generate real-time supervisor
|
|
579
|
+
* alerts.</p>
|
|
580
|
+
*/
|
|
581
|
+
interface CategoryEventMember {
|
|
582
|
+
UtteranceEvent?: never;
|
|
583
|
+
CategoryEvent: CategoryEvent;
|
|
584
|
+
BadRequestException?: never;
|
|
585
|
+
LimitExceededException?: never;
|
|
586
|
+
InternalFailureException?: never;
|
|
587
|
+
ConflictException?: never;
|
|
588
|
+
ServiceUnavailableException?: never;
|
|
589
|
+
$unknown?: never;
|
|
590
|
+
}
|
|
591
|
+
/**
|
|
592
|
+
* <p>One or more arguments to the <code>StartStreamTranscription</code>,
|
|
593
|
+
* <code>StartMedicalStreamTranscription</code>, or <code>StartCallAnalyticsStreamTranscription</code>
|
|
594
|
+
* operation was not valid. For example, <code>MediaEncoding</code> or <code>LanguageCode</code>
|
|
595
|
+
* used not valid values. Check the specified parameters and try your request again.</p>
|
|
596
|
+
*/
|
|
597
|
+
interface BadRequestExceptionMember {
|
|
598
|
+
UtteranceEvent?: never;
|
|
599
|
+
CategoryEvent?: never;
|
|
600
|
+
BadRequestException: BadRequestException;
|
|
601
|
+
LimitExceededException?: never;
|
|
602
|
+
InternalFailureException?: never;
|
|
603
|
+
ConflictException?: never;
|
|
604
|
+
ServiceUnavailableException?: never;
|
|
605
|
+
$unknown?: never;
|
|
606
|
+
}
|
|
607
|
+
/**
|
|
608
|
+
* <p>Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length
|
|
609
|
+
* limit. Break your audio stream into smaller chunks and try your request again.</p>
|
|
610
|
+
*/
|
|
611
|
+
interface LimitExceededExceptionMember {
|
|
612
|
+
UtteranceEvent?: never;
|
|
613
|
+
CategoryEvent?: never;
|
|
614
|
+
BadRequestException?: never;
|
|
615
|
+
LimitExceededException: LimitExceededException;
|
|
616
|
+
InternalFailureException?: never;
|
|
617
|
+
ConflictException?: never;
|
|
618
|
+
ServiceUnavailableException?: never;
|
|
619
|
+
$unknown?: never;
|
|
620
|
+
}
|
|
621
|
+
/**
|
|
622
|
+
* <p>A problem occurred while processing the audio. Amazon Transcribe terminated
|
|
623
|
+
* processing.</p>
|
|
624
|
+
*/
|
|
625
|
+
interface InternalFailureExceptionMember {
|
|
626
|
+
UtteranceEvent?: never;
|
|
627
|
+
CategoryEvent?: never;
|
|
628
|
+
BadRequestException?: never;
|
|
629
|
+
LimitExceededException?: never;
|
|
630
|
+
InternalFailureException: InternalFailureException;
|
|
631
|
+
ConflictException?: never;
|
|
632
|
+
ServiceUnavailableException?: never;
|
|
633
|
+
$unknown?: never;
|
|
634
|
+
}
|
|
635
|
+
/**
|
|
636
|
+
* <p>A new stream started with the same session ID. The current stream has been terminated.</p>
|
|
637
|
+
*/
|
|
638
|
+
interface ConflictExceptionMember {
|
|
639
|
+
UtteranceEvent?: never;
|
|
640
|
+
CategoryEvent?: never;
|
|
641
|
+
BadRequestException?: never;
|
|
642
|
+
LimitExceededException?: never;
|
|
643
|
+
InternalFailureException?: never;
|
|
644
|
+
ConflictException: ConflictException;
|
|
645
|
+
ServiceUnavailableException?: never;
|
|
646
|
+
$unknown?: never;
|
|
647
|
+
}
|
|
648
|
+
/**
|
|
649
|
+
* <p>The service is currently unavailable. Try your request later.</p>
|
|
650
|
+
*/
|
|
651
|
+
interface ServiceUnavailableExceptionMember {
|
|
652
|
+
UtteranceEvent?: never;
|
|
653
|
+
CategoryEvent?: never;
|
|
654
|
+
BadRequestException?: never;
|
|
655
|
+
LimitExceededException?: never;
|
|
656
|
+
InternalFailureException?: never;
|
|
657
|
+
ConflictException?: never;
|
|
658
|
+
ServiceUnavailableException: ServiceUnavailableException;
|
|
659
|
+
$unknown?: never;
|
|
660
|
+
}
|
|
661
|
+
interface $UnknownMember {
|
|
662
|
+
UtteranceEvent?: never;
|
|
663
|
+
CategoryEvent?: never;
|
|
664
|
+
BadRequestException?: never;
|
|
665
|
+
LimitExceededException?: never;
|
|
666
|
+
InternalFailureException?: never;
|
|
667
|
+
ConflictException?: never;
|
|
668
|
+
ServiceUnavailableException?: never;
|
|
669
|
+
$unknown: [string, any];
|
|
670
|
+
}
|
|
671
|
+
interface Visitor<T> {
|
|
672
|
+
UtteranceEvent: (value: UtteranceEvent) => T;
|
|
673
|
+
CategoryEvent: (value: CategoryEvent) => T;
|
|
674
|
+
BadRequestException: (value: BadRequestException) => T;
|
|
675
|
+
LimitExceededException: (value: LimitExceededException) => T;
|
|
676
|
+
InternalFailureException: (value: InternalFailureException) => T;
|
|
677
|
+
ConflictException: (value: ConflictException) => T;
|
|
678
|
+
ServiceUnavailableException: (value: ServiceUnavailableException) => T;
|
|
679
|
+
_: (name: string, value: any) => T;
|
|
680
|
+
}
|
|
681
|
+
const visit: <T>(value: CallAnalyticsTranscriptResultStream, visitor: Visitor<T>) => T;
|
|
682
|
+
}
|
|
683
|
+
export declare enum ContentIdentificationType {
|
|
684
|
+
PII = "PII"
|
|
685
|
+
}
|
|
686
|
+
export declare enum ContentRedactionType {
|
|
687
|
+
PII = "PII"
|
|
688
|
+
}
|
|
190
689
|
export declare enum LanguageCode {
|
|
191
690
|
DE_DE = "de-DE",
|
|
192
691
|
EN_AU = "en-AU",
|
|
@@ -219,19 +718,6 @@ export interface LanguageWithScore {
|
|
|
219
718
|
*/
|
|
220
719
|
Score?: number;
|
|
221
720
|
}
|
|
222
|
-
/**
|
|
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>
|
|
225
|
-
*/
|
|
226
|
-
export declare class LimitExceededException extends __BaseException {
|
|
227
|
-
readonly name: "LimitExceededException";
|
|
228
|
-
readonly $fault: "client";
|
|
229
|
-
Message?: string;
|
|
230
|
-
/**
|
|
231
|
-
* @internal
|
|
232
|
-
*/
|
|
233
|
-
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
234
|
-
}
|
|
235
721
|
export declare enum MediaEncoding {
|
|
236
722
|
FLAC = "flac",
|
|
237
723
|
OGG_OPUS = "ogg-opus",
|
|
@@ -395,18 +881,6 @@ export interface MedicalTranscriptEvent {
|
|
|
395
881
|
*/
|
|
396
882
|
Transcript?: MedicalTranscript;
|
|
397
883
|
}
|
|
398
|
-
/**
|
|
399
|
-
* <p>The service is currently unavailable. Try your request later.</p>
|
|
400
|
-
*/
|
|
401
|
-
export declare class ServiceUnavailableException extends __BaseException {
|
|
402
|
-
readonly name: "ServiceUnavailableException";
|
|
403
|
-
readonly $fault: "server";
|
|
404
|
-
Message?: string;
|
|
405
|
-
/**
|
|
406
|
-
* @internal
|
|
407
|
-
*/
|
|
408
|
-
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
409
|
-
}
|
|
410
884
|
/**
|
|
411
885
|
* <p>Contains detailed information about your streaming session.</p>
|
|
412
886
|
*/
|
|
@@ -430,10 +904,10 @@ export declare namespace MedicalTranscriptResultStream {
|
|
|
430
904
|
$unknown?: never;
|
|
431
905
|
}
|
|
432
906
|
/**
|
|
433
|
-
* <p>One or more arguments to the <code>StartStreamTranscription</code
|
|
434
|
-
*
|
|
435
|
-
*
|
|
436
|
-
* specified parameters and try your request again.</p>
|
|
907
|
+
* <p>One or more arguments to the <code>StartStreamTranscription</code>,
|
|
908
|
+
* <code>StartMedicalStreamTranscription</code>, or <code>StartCallAnalyticsStreamTranscription</code>
|
|
909
|
+
* operation was not valid. For example, <code>MediaEncoding</code> or <code>LanguageCode</code>
|
|
910
|
+
* used not valid values. Check the specified parameters and try your request again.</p>
|
|
437
911
|
*/
|
|
438
912
|
interface BadRequestExceptionMember {
|
|
439
913
|
TranscriptEvent?: never;
|
|
@@ -552,7 +1026,7 @@ export interface Result {
|
|
|
552
1026
|
*/
|
|
553
1027
|
Alternatives?: Alternative[];
|
|
554
1028
|
/**
|
|
555
|
-
* <p>Indicates
|
|
1029
|
+
* <p>Indicates which audio channel is associated with the <code>Result</code>.</p>
|
|
556
1030
|
*/
|
|
557
1031
|
ChannelId?: string;
|
|
558
1032
|
/**
|
|
@@ -574,6 +1048,205 @@ export declare enum Specialty {
|
|
|
574
1048
|
RADIOLOGY = "RADIOLOGY",
|
|
575
1049
|
UROLOGY = "UROLOGY"
|
|
576
1050
|
}
|
|
1051
|
+
export declare enum VocabularyFilterMethod {
|
|
1052
|
+
MASK = "mask",
|
|
1053
|
+
REMOVE = "remove",
|
|
1054
|
+
TAG = "tag"
|
|
1055
|
+
}
|
|
1056
|
+
export interface StartCallAnalyticsStreamTranscriptionRequest {
|
|
1057
|
+
/**
|
|
1058
|
+
* <p>Specify the language code that represents the language spoken in your audio.</p>
|
|
1059
|
+
* <p>If you're unsure of the language spoken in your audio, consider using
|
|
1060
|
+
* <code>IdentifyLanguage</code> to enable automatic language identification.</p>
|
|
1061
|
+
* <p>For a list of languages supported with streaming Call Analytics, refer to the
|
|
1062
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported
|
|
1063
|
+
* languages</a> table.</p>
|
|
1064
|
+
*/
|
|
1065
|
+
LanguageCode: CallAnalyticsLanguageCode | string | undefined;
|
|
1066
|
+
/**
|
|
1067
|
+
* <p>The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio,
|
|
1068
|
+
* is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz.
|
|
1069
|
+
* Note that the sample rate you specify must match that of your audio.</p>
|
|
1070
|
+
*/
|
|
1071
|
+
MediaSampleRateHertz: number | undefined;
|
|
1072
|
+
/**
|
|
1073
|
+
* <p>Specify the encoding of your input audio. Supported formats are:</p>
|
|
1074
|
+
* <ul>
|
|
1075
|
+
* <li>
|
|
1076
|
+
* <p>FLAC</p>
|
|
1077
|
+
* </li>
|
|
1078
|
+
* <li>
|
|
1079
|
+
* <p>OPUS-encoded audio in an Ogg container</p>
|
|
1080
|
+
* </li>
|
|
1081
|
+
* <li>
|
|
1082
|
+
* <p>PCM (only signed 16-bit little-endian audio formats, which does not include WAV)</p>
|
|
1083
|
+
* </li>
|
|
1084
|
+
* </ul>
|
|
1085
|
+
* <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>
|
|
1086
|
+
*/
|
|
1087
|
+
MediaEncoding: MediaEncoding | string | undefined;
|
|
1088
|
+
/**
|
|
1089
|
+
* <p>Specify the name of the custom vocabulary that you want to use when processing your
|
|
1090
|
+
* transcription. Note that vocabulary names are case sensitive.</p>
|
|
1091
|
+
* <p>If the language of the specified custom vocabulary doesn't match the language identified in
|
|
1092
|
+
* your media, the custom vocabulary is not applied to your transcription.</p>
|
|
1093
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
|
|
1094
|
+
*/
|
|
1095
|
+
VocabularyName?: string;
|
|
1096
|
+
/**
|
|
1097
|
+
* <p>Specify a name for your Call Analytics transcription session. If you don't include this parameter
|
|
1098
|
+
* in your request, Amazon Transcribe generates an ID and returns it in the response.</p>
|
|
1099
|
+
* <p>You can use a session ID to retry a streaming session.</p>
|
|
1100
|
+
*/
|
|
1101
|
+
SessionId?: string;
|
|
1102
|
+
/**
|
|
1103
|
+
* <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket
|
|
1104
|
+
* data frames.</p>
|
|
1105
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
|
|
1106
|
+
*/
|
|
1107
|
+
AudioStream: AsyncIterable<AudioStream> | undefined;
|
|
1108
|
+
/**
|
|
1109
|
+
* <p>Specify the name of the custom vocabulary filter that you want to use when processing your
|
|
1110
|
+
* transcription. Note that vocabulary filter names are case sensitive.</p>
|
|
1111
|
+
* <p>If the language of the specified custom vocabulary filter doesn't match the language identified in
|
|
1112
|
+
* your media, the vocabulary filter is not applied to your transcription.</p>
|
|
1113
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html">Using vocabulary filtering with unwanted
|
|
1114
|
+
* words</a>.</p>
|
|
1115
|
+
*/
|
|
1116
|
+
VocabularyFilterName?: string;
|
|
1117
|
+
/**
|
|
1118
|
+
* <p>Specify how you want your vocabulary filter applied to your transcript.</p>
|
|
1119
|
+
* <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
|
|
1120
|
+
* <p>To delete words, choose <code>remove</code>.</p>
|
|
1121
|
+
* <p>To flag words without changing them, choose <code>tag</code>.</p>
|
|
1122
|
+
*/
|
|
1123
|
+
VocabularyFilterMethod?: VocabularyFilterMethod | string;
|
|
1124
|
+
/**
|
|
1125
|
+
* <p>Specify the name of the custom language model that you want to use when processing your
|
|
1126
|
+
* transcription. Note that language model names are case sensitive.</p>
|
|
1127
|
+
* <p>The language of the specified language model must match the language code you specify
|
|
1128
|
+
* in your transcription request. If the languages don't match, the custom language model isn't applied.
|
|
1129
|
+
* There are no errors or warnings associated with a language mismatch.</p>
|
|
1130
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language models</a>.</p>
|
|
1131
|
+
*/
|
|
1132
|
+
LanguageModelName?: string;
|
|
1133
|
+
/**
|
|
1134
|
+
* <p>Enables partial result stabilization for your transcription. Partial result stabilization can reduce
|
|
1135
|
+
* latency in your output, but may impact accuracy. For more information, see
|
|
1136
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization">Partial-result
|
|
1137
|
+
* stabilization</a>.</p>
|
|
1138
|
+
*/
|
|
1139
|
+
EnablePartialResultsStabilization?: boolean;
|
|
1140
|
+
/**
|
|
1141
|
+
* <p>Specify the level of stability to use when you enable partial results stabilization
|
|
1142
|
+
* (<code>EnablePartialResultsStabilization</code>).</p>
|
|
1143
|
+
* <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly
|
|
1144
|
+
* lower accuracy.</p>
|
|
1145
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization">Partial-result
|
|
1146
|
+
* stabilization</a>.</p>
|
|
1147
|
+
*/
|
|
1148
|
+
PartialResultsStability?: PartialResultsStability | string;
|
|
1149
|
+
/**
|
|
1150
|
+
* <p>Labels all personally identifiable information (PII) identified in your transcript.</p>
|
|
1151
|
+
* <p>Content identification is performed at the segment level; PII specified in
|
|
1152
|
+
* <code>PiiEntityTypes</code> is flagged upon complete transcription of an audio segment.</p>
|
|
1153
|
+
* <p>You can’t set <code>ContentIdentificationType</code> and <code>ContentRedactionType</code>
|
|
1154
|
+
* in the same request. If you set both, your request returns a
|
|
1155
|
+
* <code>BadRequestException</code>.</p>
|
|
1156
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html">Redacting or identifying personally identifiable
|
|
1157
|
+
* information</a>.</p>
|
|
1158
|
+
*/
|
|
1159
|
+
ContentIdentificationType?: ContentIdentificationType | string;
|
|
1160
|
+
/**
|
|
1161
|
+
* <p>Redacts all personally identifiable information (PII) identified in your transcript.</p>
|
|
1162
|
+
* <p>Content redaction is performed at the segment level; PII specified in
|
|
1163
|
+
* <code>PiiEntityTypes</code> is redacted upon complete transcription of an audio segment.</p>
|
|
1164
|
+
* <p>You can’t set <code>ContentRedactionType</code> and <code>ContentIdentificationType</code>
|
|
1165
|
+
* in the same request. If you set both, your request returns a
|
|
1166
|
+
* <code>BadRequestException</code>.</p>
|
|
1167
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html">Redacting or identifying personally identifiable
|
|
1168
|
+
* information</a>.</p>
|
|
1169
|
+
*/
|
|
1170
|
+
ContentRedactionType?: ContentRedactionType | string;
|
|
1171
|
+
/**
|
|
1172
|
+
* <p>Specify which types of personally identifiable information (PII) you want to redact in your
|
|
1173
|
+
* transcript. You can include as many types as you'd like, or you can select
|
|
1174
|
+
* <code>ALL</code>.</p>
|
|
1175
|
+
* <p>To include <code>PiiEntityTypes</code> in your Call Analytics request, you must also include
|
|
1176
|
+
* either <code>ContentIdentificationType</code> or <code>ContentRedactionType</code>.</p>
|
|
1177
|
+
* <p>Values must be comma-separated and can include:
|
|
1178
|
+
* <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING</code>,
|
|
1179
|
+
* <code>CREDIT_DEBIT_NUMBER</code>, <code>CREDIT_DEBIT_CVV</code>,
|
|
1180
|
+
* <code>CREDIT_DEBIT_EXPIRY</code>, <code>PIN</code>, <code>EMAIL</code>,
|
|
1181
|
+
* <code>ADDRESS</code>, <code>NAME</code>, <code>PHONE</code>,
|
|
1182
|
+
* <code>SSN</code>, or <code>ALL</code>.</p>
|
|
1183
|
+
*/
|
|
1184
|
+
PiiEntityTypes?: string;
|
|
1185
|
+
}
|
|
1186
|
+
export interface StartCallAnalyticsStreamTranscriptionResponse {
|
|
1187
|
+
/**
|
|
1188
|
+
* <p>Provides the identifier for your Call Analytics streaming request.</p>
|
|
1189
|
+
*/
|
|
1190
|
+
RequestId?: string;
|
|
1191
|
+
/**
|
|
1192
|
+
* <p>Provides the language code that you specified in your Call Analytics request.</p>
|
|
1193
|
+
*/
|
|
1194
|
+
LanguageCode?: CallAnalyticsLanguageCode | string;
|
|
1195
|
+
/**
|
|
1196
|
+
* <p>Provides the sample rate that you specified in your Call Analytics request.</p>
|
|
1197
|
+
*/
|
|
1198
|
+
MediaSampleRateHertz?: number;
|
|
1199
|
+
/**
|
|
1200
|
+
* <p>Provides the media encoding you specified in your Call Analytics request.</p>
|
|
1201
|
+
*/
|
|
1202
|
+
MediaEncoding?: MediaEncoding | string;
|
|
1203
|
+
/**
|
|
1204
|
+
* <p>Provides the name of the custom vocabulary that you specified in your Call Analytics request.</p>
|
|
1205
|
+
*/
|
|
1206
|
+
VocabularyName?: string;
|
|
1207
|
+
/**
|
|
1208
|
+
* <p>Provides the identifier for your Call Analytics transcription session.</p>
|
|
1209
|
+
*/
|
|
1210
|
+
SessionId?: string;
|
|
1211
|
+
/**
|
|
1212
|
+
* <p>Provides detailed information about your Call Analytics streaming session.</p>
|
|
1213
|
+
*/
|
|
1214
|
+
CallAnalyticsTranscriptResultStream?: AsyncIterable<CallAnalyticsTranscriptResultStream>;
|
|
1215
|
+
/**
|
|
1216
|
+
* <p>Provides the name of the custom vocabulary filter that you specified in your Call Analytics
|
|
1217
|
+
* request.</p>
|
|
1218
|
+
*/
|
|
1219
|
+
VocabularyFilterName?: string;
|
|
1220
|
+
/**
|
|
1221
|
+
* <p>Provides the vocabulary filtering method used in your Call Analytics transcription.</p>
|
|
1222
|
+
*/
|
|
1223
|
+
VocabularyFilterMethod?: VocabularyFilterMethod | string;
|
|
1224
|
+
/**
|
|
1225
|
+
* <p>Provides the name of the custom language model that you specified in your Call Analytics
|
|
1226
|
+
* request.</p>
|
|
1227
|
+
*/
|
|
1228
|
+
LanguageModelName?: string;
|
|
1229
|
+
/**
|
|
1230
|
+
* <p>Shows whether partial results stabilization was enabled for your Call Analytics transcription.</p>
|
|
1231
|
+
*/
|
|
1232
|
+
EnablePartialResultsStabilization?: boolean;
|
|
1233
|
+
/**
|
|
1234
|
+
* <p>Provides the stabilization level used for your transcription.</p>
|
|
1235
|
+
*/
|
|
1236
|
+
PartialResultsStability?: PartialResultsStability | string;
|
|
1237
|
+
/**
|
|
1238
|
+
* <p>Shows whether content identification was enabled for your Call Analytics transcription.</p>
|
|
1239
|
+
*/
|
|
1240
|
+
ContentIdentificationType?: ContentIdentificationType | string;
|
|
1241
|
+
/**
|
|
1242
|
+
* <p>Shows whether content redaction was enabled for your Call Analytics transcription.</p>
|
|
1243
|
+
*/
|
|
1244
|
+
ContentRedactionType?: ContentRedactionType | string;
|
|
1245
|
+
/**
|
|
1246
|
+
* <p>Lists the PII entity types you specified in your Call Analytics request.</p>
|
|
1247
|
+
*/
|
|
1248
|
+
PiiEntityTypes?: string;
|
|
1249
|
+
}
|
|
577
1250
|
export declare enum Type {
|
|
578
1251
|
CONVERSATION = "CONVERSATION",
|
|
579
1252
|
DICTATION = "DICTATION"
|
|
@@ -721,11 +1394,6 @@ export interface StartMedicalStreamTranscriptionResponse {
|
|
|
721
1394
|
*/
|
|
722
1395
|
ContentIdentificationType?: MedicalContentIdentificationType | string;
|
|
723
1396
|
}
|
|
724
|
-
export declare enum VocabularyFilterMethod {
|
|
725
|
-
MASK = "mask",
|
|
726
|
-
REMOVE = "remove",
|
|
727
|
-
TAG = "tag"
|
|
728
|
-
}
|
|
729
1397
|
export interface StartStreamTranscriptionRequest {
|
|
730
1398
|
/**
|
|
731
1399
|
* <p>Specify the language code that represents the language spoken in your audio.</p>
|
|
@@ -743,7 +1411,7 @@ export interface StartStreamTranscriptionRequest {
|
|
|
743
1411
|
*/
|
|
744
1412
|
MediaSampleRateHertz: number | undefined;
|
|
745
1413
|
/**
|
|
746
|
-
* <p>Specify the encoding
|
|
1414
|
+
* <p>Specify the encoding of your input audio. Supported formats are:</p>
|
|
747
1415
|
* <ul>
|
|
748
1416
|
* <li>
|
|
749
1417
|
* <p>FLAC</p>
|
|
@@ -762,7 +1430,7 @@ export interface StartStreamTranscriptionRequest {
|
|
|
762
1430
|
* <p>Specify the name of the custom vocabulary that you want to use when processing your
|
|
763
1431
|
* transcription. Note that vocabulary names are case sensitive.</p>
|
|
764
1432
|
* <p>If the language of the specified custom vocabulary doesn't match the language identified in
|
|
765
|
-
* your media, your
|
|
1433
|
+
* your media, the custom vocabulary is not applied to your transcription.</p>
|
|
766
1434
|
* <important>
|
|
767
1435
|
* <p>This parameter is <b>not</b> intended for use with the
|
|
768
1436
|
* <code>IdentifyLanguage</code> parameter. If you're including <code>IdentifyLanguage</code>
|
|
@@ -788,7 +1456,7 @@ export interface StartStreamTranscriptionRequest {
|
|
|
788
1456
|
* <p>Specify the name of the custom vocabulary filter that you want to use when processing your
|
|
789
1457
|
* transcription. Note that vocabulary filter names are case sensitive.</p>
|
|
790
1458
|
* <p>If the language of the specified custom vocabulary filter doesn't match the language identified in
|
|
791
|
-
* your media, your
|
|
1459
|
+
* your media, the vocabulary filter is not applied to your transcription.</p>
|
|
792
1460
|
* <important>
|
|
793
1461
|
* <p>This parameter is <b>not</b> intended for use with the
|
|
794
1462
|
* <code>IdentifyLanguage</code> parameter. If you're including <code>IdentifyLanguage</code>
|
|
@@ -882,10 +1550,9 @@ export interface StartStreamTranscriptionRequest {
|
|
|
882
1550
|
* <p>Specify the name of the custom language model that you want to use when processing your
|
|
883
1551
|
* transcription. Note that language model names are case sensitive.</p>
|
|
884
1552
|
* <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.
|
|
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>
|
|
1553
|
+
* in your transcription request. If the languages don't match, the custom language model isn't applied.
|
|
1554
|
+
* There are no errors or warnings associated with a language mismatch.</p>
|
|
1555
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language models</a>.</p>
|
|
889
1556
|
*/
|
|
890
1557
|
LanguageModelName?: string;
|
|
891
1558
|
/**
|
|
@@ -1208,10 +1875,58 @@ export declare const AlternativeFilterSensitiveLog: (obj: Alternative) => any;
|
|
|
1208
1875
|
* @internal
|
|
1209
1876
|
*/
|
|
1210
1877
|
export declare const AudioEventFilterSensitiveLog: (obj: AudioEvent) => any;
|
|
1878
|
+
/**
|
|
1879
|
+
* @internal
|
|
1880
|
+
*/
|
|
1881
|
+
export declare const ChannelDefinitionFilterSensitiveLog: (obj: ChannelDefinition) => any;
|
|
1882
|
+
/**
|
|
1883
|
+
* @internal
|
|
1884
|
+
*/
|
|
1885
|
+
export declare const PostCallAnalyticsSettingsFilterSensitiveLog: (obj: PostCallAnalyticsSettings) => any;
|
|
1886
|
+
/**
|
|
1887
|
+
* @internal
|
|
1888
|
+
*/
|
|
1889
|
+
export declare const ConfigurationEventFilterSensitiveLog: (obj: ConfigurationEvent) => any;
|
|
1211
1890
|
/**
|
|
1212
1891
|
* @internal
|
|
1213
1892
|
*/
|
|
1214
1893
|
export declare const AudioStreamFilterSensitiveLog: (obj: AudioStream) => any;
|
|
1894
|
+
/**
|
|
1895
|
+
* @internal
|
|
1896
|
+
*/
|
|
1897
|
+
export declare const CallAnalyticsEntityFilterSensitiveLog: (obj: CallAnalyticsEntity) => any;
|
|
1898
|
+
/**
|
|
1899
|
+
* @internal
|
|
1900
|
+
*/
|
|
1901
|
+
export declare const CallAnalyticsItemFilterSensitiveLog: (obj: CallAnalyticsItem) => any;
|
|
1902
|
+
/**
|
|
1903
|
+
* @internal
|
|
1904
|
+
*/
|
|
1905
|
+
export declare const TimestampRangeFilterSensitiveLog: (obj: TimestampRange) => any;
|
|
1906
|
+
/**
|
|
1907
|
+
* @internal
|
|
1908
|
+
*/
|
|
1909
|
+
export declare const PointsOfInterestFilterSensitiveLog: (obj: PointsOfInterest) => any;
|
|
1910
|
+
/**
|
|
1911
|
+
* @internal
|
|
1912
|
+
*/
|
|
1913
|
+
export declare const CategoryEventFilterSensitiveLog: (obj: CategoryEvent) => any;
|
|
1914
|
+
/**
|
|
1915
|
+
* @internal
|
|
1916
|
+
*/
|
|
1917
|
+
export declare const CharacterOffsetsFilterSensitiveLog: (obj: CharacterOffsets) => any;
|
|
1918
|
+
/**
|
|
1919
|
+
* @internal
|
|
1920
|
+
*/
|
|
1921
|
+
export declare const IssueDetectedFilterSensitiveLog: (obj: IssueDetected) => any;
|
|
1922
|
+
/**
|
|
1923
|
+
* @internal
|
|
1924
|
+
*/
|
|
1925
|
+
export declare const UtteranceEventFilterSensitiveLog: (obj: UtteranceEvent) => any;
|
|
1926
|
+
/**
|
|
1927
|
+
* @internal
|
|
1928
|
+
*/
|
|
1929
|
+
export declare const CallAnalyticsTranscriptResultStreamFilterSensitiveLog: (obj: CallAnalyticsTranscriptResultStream) => any;
|
|
1215
1930
|
/**
|
|
1216
1931
|
* @internal
|
|
1217
1932
|
*/
|
|
@@ -1248,6 +1963,14 @@ export declare const MedicalTranscriptResultStreamFilterSensitiveLog: (obj: Medi
|
|
|
1248
1963
|
* @internal
|
|
1249
1964
|
*/
|
|
1250
1965
|
export declare const ResultFilterSensitiveLog: (obj: Result) => any;
|
|
1966
|
+
/**
|
|
1967
|
+
* @internal
|
|
1968
|
+
*/
|
|
1969
|
+
export declare const StartCallAnalyticsStreamTranscriptionRequestFilterSensitiveLog: (obj: StartCallAnalyticsStreamTranscriptionRequest) => any;
|
|
1970
|
+
/**
|
|
1971
|
+
* @internal
|
|
1972
|
+
*/
|
|
1973
|
+
export declare const StartCallAnalyticsStreamTranscriptionResponseFilterSensitiveLog: (obj: StartCallAnalyticsStreamTranscriptionResponse) => any;
|
|
1251
1974
|
/**
|
|
1252
1975
|
* @internal
|
|
1253
1976
|
*/
|