@aws-sdk/client-transcribe-streaming 3.296.0 → 3.297.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.
@@ -4,6 +4,7 @@ import { StartMedicalStreamTranscriptionCommandInput, StartMedicalStreamTranscri
4
4
  import { StartStreamTranscriptionCommandInput, StartStreamTranscriptionCommandOutput } from "./commands/StartStreamTranscriptionCommand";
5
5
  import { TranscribeStreamingClient } from "./TranscribeStreamingClient";
6
6
  /**
7
+ * @public
7
8
  * <p>Amazon Transcribe streaming offers three main types of real-time transcription:
8
9
  * <b>Standard</b>, <b>Medical</b>, and
9
10
  * <b>Call Analytics</b>.</p>
@@ -30,6 +31,7 @@ import { TranscribeStreamingClient } from "./TranscribeStreamingClient";
30
31
  */
31
32
  export declare class TranscribeStreaming extends TranscribeStreamingClient {
32
33
  /**
34
+ * @public
33
35
  * <p>Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to
34
36
  * Amazon Transcribe and the transcription results are streamed to your application. Use this operation
35
37
  * for <a href="https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html">Call Analytics</a> transcriptions.</p>
@@ -57,6 +59,7 @@ export declare class TranscribeStreaming extends TranscribeStreamingClient {
57
59
  startCallAnalyticsStreamTranscription(args: StartCallAnalyticsStreamTranscriptionCommandInput, cb: (err: any, data?: StartCallAnalyticsStreamTranscriptionCommandOutput) => void): void;
58
60
  startCallAnalyticsStreamTranscription(args: StartCallAnalyticsStreamTranscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCallAnalyticsStreamTranscriptionCommandOutput) => void): void;
59
61
  /**
62
+ * @public
60
63
  * <p>Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to
61
64
  * Amazon Transcribe Medical and the transcription results are streamed to your
62
65
  * application.</p>
@@ -86,6 +89,7 @@ export declare class TranscribeStreaming extends TranscribeStreamingClient {
86
89
  startMedicalStreamTranscription(args: StartMedicalStreamTranscriptionCommandInput, cb: (err: any, data?: StartMedicalStreamTranscriptionCommandOutput) => void): void;
87
90
  startMedicalStreamTranscription(args: StartMedicalStreamTranscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMedicalStreamTranscriptionCommandOutput) => void): void;
88
91
  /**
92
+ * @public
89
93
  * <p>Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to
90
94
  * Amazon Transcribe and the transcription results are streamed to your application.</p>
91
95
  * <p>The following parameters are required:</p>
@@ -14,15 +14,24 @@ import { StartCallAnalyticsStreamTranscriptionCommandInput, StartCallAnalyticsSt
14
14
  import { StartMedicalStreamTranscriptionCommandInput, StartMedicalStreamTranscriptionCommandOutput } from "./commands/StartMedicalStreamTranscriptionCommand";
15
15
  import { StartStreamTranscriptionCommandInput, StartStreamTranscriptionCommandOutput } from "./commands/StartStreamTranscriptionCommand";
16
16
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
17
+ /**
18
+ * @public
19
+ */
17
20
  export type ServiceInputTypes = StartCallAnalyticsStreamTranscriptionCommandInput | StartMedicalStreamTranscriptionCommandInput | StartStreamTranscriptionCommandInput;
21
+ /**
22
+ * @public
23
+ */
18
24
  export type ServiceOutputTypes = StartCallAnalyticsStreamTranscriptionCommandOutput | StartMedicalStreamTranscriptionCommandOutput | StartStreamTranscriptionCommandOutput;
25
+ /**
26
+ * @public
27
+ */
19
28
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
20
29
  /**
21
30
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
22
31
  */
23
32
  requestHandler?: __HttpHandler;
24
33
  /**
25
- * A constructor for a class implementing the {@link __Checksum} interface
34
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
26
35
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
27
36
  * @internal
28
37
  */
@@ -121,23 +130,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
121
130
  */
122
131
  eventStreamSerdeProvider?: __EventStreamSerdeProvider;
123
132
  /**
124
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
133
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
125
134
  */
126
135
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
127
136
  }
137
+ /**
138
+ * @public
139
+ */
128
140
  type TranscribeStreamingClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & EventStreamInputConfig & WebSocketInputConfig & UserAgentInputConfig & EventStreamSerdeInputConfig & ClientInputEndpointParameters;
129
141
  /**
130
- * The configuration interface of TranscribeStreamingClient class constructor that set the region, credentials and other options.
142
+ * @public
143
+ *
144
+ * The configuration interface of TranscribeStreamingClient class constructor that set the region, credentials and other options.
131
145
  */
132
146
  export interface TranscribeStreamingClientConfig extends TranscribeStreamingClientConfigType {
133
147
  }
148
+ /**
149
+ * @public
150
+ */
134
151
  type TranscribeStreamingClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & EventStreamResolvedConfig & WebSocketResolvedConfig & UserAgentResolvedConfig & EventStreamSerdeResolvedConfig & ClientResolvedEndpointParameters;
135
152
  /**
136
- * The resolved configuration interface of TranscribeStreamingClient class. This is resolved and normalized from the {@link TranscribeStreamingClientConfig | constructor configuration interface}.
153
+ * @public
154
+ *
155
+ * The resolved configuration interface of TranscribeStreamingClient class. This is resolved and normalized from the {@link TranscribeStreamingClientConfig | constructor configuration interface}.
137
156
  */
138
157
  export interface TranscribeStreamingClientResolvedConfig extends TranscribeStreamingClientResolvedConfigType {
139
158
  }
140
159
  /**
160
+ * @public
141
161
  * <p>Amazon Transcribe streaming offers three main types of real-time transcription:
142
162
  * <b>Standard</b>, <b>Medical</b>, and
143
163
  * <b>Call Analytics</b>.</p>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { StartCallAnalyticsStreamTranscriptionRequest, StartCallAnalyticsStreamTranscriptionResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TranscribeStreamingClientResolvedConfig } from "../TranscribeStreamingClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartCallAnalyticsStreamTranscriptionCommand}.
8
10
  */
9
11
  export interface StartCallAnalyticsStreamTranscriptionCommandInput extends StartCallAnalyticsStreamTranscriptionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartCallAnalyticsStreamTranscriptionCommand}.
13
17
  */
14
18
  export interface StartCallAnalyticsStreamTranscriptionCommandOutput extends StartCallAnalyticsStreamTranscriptionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to
18
23
  * Amazon Transcribe and the transcription results are streamed to your application. Use this operation
19
24
  * for <a href="https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html">Call Analytics</a> transcriptions.</p>
@@ -46,6 +51,8 @@ export interface StartCallAnalyticsStreamTranscriptionCommandOutput extends Star
46
51
  * const response = await client.send(command);
47
52
  * ```
48
53
  *
54
+ * @param StartCallAnalyticsStreamTranscriptionCommandInput - {@link StartCallAnalyticsStreamTranscriptionCommandInput}
55
+ * @returns {@link StartCallAnalyticsStreamTranscriptionCommandOutput}
49
56
  * @see {@link StartCallAnalyticsStreamTranscriptionCommandInput} for command's `input` shape.
50
57
  * @see {@link StartCallAnalyticsStreamTranscriptionCommandOutput} for command's `response` shape.
51
58
  * @see {@link TranscribeStreamingClientResolvedConfig | config} for TranscribeStreamingClient's `config` shape.
@@ -75,11 +82,20 @@ export interface StartCallAnalyticsStreamTranscriptionCommandOutput extends Star
75
82
  export declare class StartCallAnalyticsStreamTranscriptionCommand extends $Command<StartCallAnalyticsStreamTranscriptionCommandInput, StartCallAnalyticsStreamTranscriptionCommandOutput, TranscribeStreamingClientResolvedConfig> {
76
83
  readonly input: StartCallAnalyticsStreamTranscriptionCommandInput;
77
84
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
85
+ /**
86
+ * @public
87
+ */
78
88
  constructor(input: StartCallAnalyticsStreamTranscriptionCommandInput);
79
89
  /**
80
90
  * @internal
81
91
  */
82
92
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TranscribeStreamingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartCallAnalyticsStreamTranscriptionCommandInput, StartCallAnalyticsStreamTranscriptionCommandOutput>;
93
+ /**
94
+ * @internal
95
+ */
83
96
  private serialize;
97
+ /**
98
+ * @internal
99
+ */
84
100
  private deserialize;
85
101
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { StartMedicalStreamTranscriptionRequest, StartMedicalStreamTranscriptionResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TranscribeStreamingClientResolvedConfig } from "../TranscribeStreamingClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartMedicalStreamTranscriptionCommand}.
8
10
  */
9
11
  export interface StartMedicalStreamTranscriptionCommandInput extends StartMedicalStreamTranscriptionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartMedicalStreamTranscriptionCommand}.
13
17
  */
14
18
  export interface StartMedicalStreamTranscriptionCommandOutput extends StartMedicalStreamTranscriptionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to
18
23
  * Amazon Transcribe Medical and the transcription results are streamed to your
19
24
  * application.</p>
@@ -48,6 +53,8 @@ export interface StartMedicalStreamTranscriptionCommandOutput extends StartMedic
48
53
  * const response = await client.send(command);
49
54
  * ```
50
55
  *
56
+ * @param StartMedicalStreamTranscriptionCommandInput - {@link StartMedicalStreamTranscriptionCommandInput}
57
+ * @returns {@link StartMedicalStreamTranscriptionCommandOutput}
51
58
  * @see {@link StartMedicalStreamTranscriptionCommandInput} for command's `input` shape.
52
59
  * @see {@link StartMedicalStreamTranscriptionCommandOutput} for command's `response` shape.
53
60
  * @see {@link TranscribeStreamingClientResolvedConfig | config} for TranscribeStreamingClient's `config` shape.
@@ -77,11 +84,20 @@ export interface StartMedicalStreamTranscriptionCommandOutput extends StartMedic
77
84
  export declare class StartMedicalStreamTranscriptionCommand extends $Command<StartMedicalStreamTranscriptionCommandInput, StartMedicalStreamTranscriptionCommandOutput, TranscribeStreamingClientResolvedConfig> {
78
85
  readonly input: StartMedicalStreamTranscriptionCommandInput;
79
86
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
87
+ /**
88
+ * @public
89
+ */
80
90
  constructor(input: StartMedicalStreamTranscriptionCommandInput);
81
91
  /**
82
92
  * @internal
83
93
  */
84
94
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TranscribeStreamingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartMedicalStreamTranscriptionCommandInput, StartMedicalStreamTranscriptionCommandOutput>;
95
+ /**
96
+ * @internal
97
+ */
85
98
  private serialize;
99
+ /**
100
+ * @internal
101
+ */
86
102
  private deserialize;
87
103
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { StartStreamTranscriptionRequest, StartStreamTranscriptionResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TranscribeStreamingClientResolvedConfig } from "../TranscribeStreamingClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartStreamTranscriptionCommand}.
8
10
  */
9
11
  export interface StartStreamTranscriptionCommandInput extends StartStreamTranscriptionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartStreamTranscriptionCommand}.
13
17
  */
14
18
  export interface StartStreamTranscriptionCommandOutput extends StartStreamTranscriptionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to
18
23
  * Amazon Transcribe and the transcription results are streamed to your application.</p>
19
24
  * <p>The following parameters are required:</p>
@@ -45,6 +50,8 @@ export interface StartStreamTranscriptionCommandOutput extends StartStreamTransc
45
50
  * const response = await client.send(command);
46
51
  * ```
47
52
  *
53
+ * @param StartStreamTranscriptionCommandInput - {@link StartStreamTranscriptionCommandInput}
54
+ * @returns {@link StartStreamTranscriptionCommandOutput}
48
55
  * @see {@link StartStreamTranscriptionCommandInput} for command's `input` shape.
49
56
  * @see {@link StartStreamTranscriptionCommandOutput} for command's `response` shape.
50
57
  * @see {@link TranscribeStreamingClientResolvedConfig | config} for TranscribeStreamingClient's `config` shape.
@@ -74,11 +81,20 @@ export interface StartStreamTranscriptionCommandOutput extends StartStreamTransc
74
81
  export declare class StartStreamTranscriptionCommand extends $Command<StartStreamTranscriptionCommandInput, StartStreamTranscriptionCommandOutput, TranscribeStreamingClientResolvedConfig> {
75
82
  readonly input: StartStreamTranscriptionCommandInput;
76
83
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
84
+ /**
85
+ * @public
86
+ */
77
87
  constructor(input: StartStreamTranscriptionCommandInput);
78
88
  /**
79
89
  * @internal
80
90
  */
81
91
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TranscribeStreamingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartStreamTranscriptionCommandInput, StartStreamTranscriptionCommandOutput>;
92
+ /**
93
+ * @internal
94
+ */
82
95
  private serialize;
96
+ /**
97
+ * @internal
98
+ */
83
99
  private deserialize;
84
100
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from TranscribeStreaming service.
4
6
  */
5
7
  export declare class TranscribeStreamingServiceException extends __ServiceException {
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { TranscribeStreamingServiceException as __BaseException } from "./TranscribeStreamingServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>Contains entities identified as personally identifiable information (PII) in your
5
6
  * transcription output, along with various associated attributes. Examples include category,
6
7
  * confidence score, type, stability score, and start and end times.</p>
@@ -35,11 +36,15 @@ export interface Entity {
35
36
  */
36
37
  Confidence?: number;
37
38
  }
39
+ /**
40
+ * @public
41
+ */
38
42
  export declare enum ItemType {
39
43
  PRONUNCIATION = "pronunciation",
40
44
  PUNCTUATION = "punctuation"
41
45
  }
42
46
  /**
47
+ * @public
43
48
  * <p>A word, phrase, or punctuation mark in your transcription output, along with various associated
44
49
  * attributes, such as confidence score, type, and start and end times.</p>
45
50
  */
@@ -85,6 +90,7 @@ export interface Item {
85
90
  Stable?: boolean;
86
91
  }
87
92
  /**
93
+ * @public
88
94
  * <p>A list of possible alternative transcriptions for the input audio. Each alternative may contain
89
95
  * one or more of <code>Items</code>, <code>Entities</code>, or <code>Transcript</code>.</p>
90
96
  */
@@ -104,6 +110,7 @@ export interface Alternative {
104
110
  Entities?: Entity[];
105
111
  }
106
112
  /**
113
+ * @public
107
114
  * <p>A wrapper for your audio chunks. Your audio stream consists of one or more audio
108
115
  * events, which consist of one or more audio chunks.</p>
109
116
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html">Event stream encoding</a>.</p>
@@ -115,11 +122,15 @@ export interface AudioEvent {
115
122
  */
116
123
  AudioChunk?: Uint8Array;
117
124
  }
125
+ /**
126
+ * @public
127
+ */
118
128
  export declare enum ParticipantRole {
119
129
  AGENT = "AGENT",
120
130
  CUSTOMER = "CUSTOMER"
121
131
  }
122
132
  /**
133
+ * @public
123
134
  * <p>Makes it possible to specify which speaker is on which audio channel. For example, if your
124
135
  * agent is the first participant to speak, you would set <code>ChannelId</code> to
125
136
  * <code>0</code> (to indicate the first channel) and <code>ParticipantRole</code> to
@@ -136,11 +147,15 @@ export interface ChannelDefinition {
136
147
  */
137
148
  ParticipantRole: ParticipantRole | string | undefined;
138
149
  }
150
+ /**
151
+ * @public
152
+ */
139
153
  export declare enum ContentRedactionOutput {
140
154
  REDACTED = "redacted",
141
155
  REDACTED_AND_UNREDACTED = "redacted_and_unredacted"
142
156
  }
143
157
  /**
158
+ * @public
144
159
  * <p>Allows you to specify additional settings for your streaming Call Analytics
145
160
  * post-call request, including output locations for your redacted and unredacted
146
161
  * transcript, which IAM role to use, and, optionally, which encryption key to
@@ -230,6 +245,7 @@ export interface PostCallAnalyticsSettings {
230
245
  OutputEncryptionKMSKeyId?: string;
231
246
  }
232
247
  /**
248
+ * @public
233
249
  * <p>Allows you to set audio channel definitions and post-call analytics settings.</p>
234
250
  */
235
251
  export interface ConfigurationEvent {
@@ -244,11 +260,15 @@ export interface ConfigurationEvent {
244
260
  PostCallAnalyticsSettings?: PostCallAnalyticsSettings;
245
261
  }
246
262
  /**
263
+ * @public
247
264
  * <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket
248
265
  * data frames.</p>
249
266
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
250
267
  */
251
268
  export type AudioStream = AudioStream.AudioEventMember | AudioStream.ConfigurationEventMember | AudioStream.$UnknownMember;
269
+ /**
270
+ * @public
271
+ */
252
272
  export declare namespace AudioStream {
253
273
  /**
254
274
  * <p>A blob of audio from your application. Your audio stream consists of one or more audio
@@ -281,6 +301,7 @@ export declare namespace AudioStream {
281
301
  const visit: <T>(value: AudioStream, visitor: Visitor<T>) => T;
282
302
  }
283
303
  /**
304
+ * @public
284
305
  * <p>One or more arguments to the <code>StartStreamTranscription</code>,
285
306
  * <code>StartMedicalStreamTranscription</code>, or <code>StartCallAnalyticsStreamTranscription</code>
286
307
  * operation was not valid. For example, <code>MediaEncoding</code> or <code>LanguageCode</code>
@@ -296,6 +317,7 @@ export declare class BadRequestException extends __BaseException {
296
317
  constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
297
318
  }
298
319
  /**
320
+ * @public
299
321
  * <p>Contains entities identified as personally identifiable information (PII) in your
300
322
  * transcription output, along with various associated attributes. Examples include category,
301
323
  * confidence score, content, type, and start and end times.</p>
@@ -331,6 +353,7 @@ export interface CallAnalyticsEntity {
331
353
  Confidence?: number;
332
354
  }
333
355
  /**
356
+ * @public
334
357
  * <p>A word, phrase, or punctuation mark in your Call Analytics transcription output, along with various
335
358
  * associated attributes, such as confidence score, type, and start and end times.</p>
336
359
  */
@@ -370,6 +393,9 @@ export interface CallAnalyticsItem {
370
393
  */
371
394
  Stable?: boolean;
372
395
  }
396
+ /**
397
+ * @public
398
+ */
373
399
  export declare enum CallAnalyticsLanguageCode {
374
400
  DE_DE = "de-DE",
375
401
  EN_AU = "en-AU",
@@ -382,6 +408,7 @@ export declare enum CallAnalyticsLanguageCode {
382
408
  PT_BR = "pt-BR"
383
409
  }
384
410
  /**
411
+ * @public
385
412
  * <p>Contains the timestamp range (start time through end time) of a matched category.</p>
386
413
  */
387
414
  export interface TimestampRange {
@@ -397,6 +424,7 @@ export interface TimestampRange {
397
424
  EndOffsetMillis?: number;
398
425
  }
399
426
  /**
427
+ * @public
400
428
  * <p>Contains the timestamps of matched categories.</p>
401
429
  */
402
430
  export interface PointsOfInterest {
@@ -406,6 +434,7 @@ export interface PointsOfInterest {
406
434
  TimestampRanges?: TimestampRange[];
407
435
  }
408
436
  /**
437
+ * @public
409
438
  * <p>Provides information on any <code>TranscriptFilterType</code> categories that matched your
410
439
  * transcription output. Matches are identified for each segment upon completion of that segment.</p>
411
440
  */
@@ -420,6 +449,7 @@ export interface CategoryEvent {
420
449
  MatchedDetails?: Record<string, PointsOfInterest>;
421
450
  }
422
451
  /**
452
+ * @public
423
453
  * <p>A new stream started with the same session ID. The current stream has been terminated.</p>
424
454
  */
425
455
  export declare class ConflictException extends __BaseException {
@@ -432,6 +462,7 @@ export declare class ConflictException extends __BaseException {
432
462
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
433
463
  }
434
464
  /**
465
+ * @public
435
466
  * <p>A problem occurred while processing the audio. Amazon Transcribe terminated
436
467
  * processing.</p>
437
468
  */
@@ -445,6 +476,7 @@ export declare class InternalFailureException extends __BaseException {
445
476
  constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
446
477
  }
447
478
  /**
479
+ * @public
448
480
  * <p>Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length
449
481
  * limit. Break your audio stream into smaller chunks and try your request again.</p>
450
482
  */
@@ -458,6 +490,7 @@ export declare class LimitExceededException extends __BaseException {
458
490
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
459
491
  }
460
492
  /**
493
+ * @public
461
494
  * <p>The service is currently unavailable. Try your request later.</p>
462
495
  */
463
496
  export declare class ServiceUnavailableException extends __BaseException {
@@ -470,6 +503,7 @@ export declare class ServiceUnavailableException extends __BaseException {
470
503
  constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
471
504
  }
472
505
  /**
506
+ * @public
473
507
  * <p>Provides the location, using character count, in your transcript where a match is identified. For example,
474
508
  * the location of an issue or a category match within a segment.</p>
475
509
  */
@@ -486,6 +520,7 @@ export interface CharacterOffsets {
486
520
  End?: number;
487
521
  }
488
522
  /**
523
+ * @public
489
524
  * <p>Lists the issues that were identified in your audio segment.</p>
490
525
  */
491
526
  export interface IssueDetected {
@@ -494,6 +529,9 @@ export interface IssueDetected {
494
529
  */
495
530
  CharacterOffsets?: CharacterOffsets;
496
531
  }
532
+ /**
533
+ * @public
534
+ */
497
535
  export declare enum Sentiment {
498
536
  MIXED = "MIXED",
499
537
  NEGATIVE = "NEGATIVE",
@@ -501,6 +539,7 @@ export declare enum Sentiment {
501
539
  POSITIVE = "POSITIVE"
502
540
  }
503
541
  /**
542
+ * @public
504
543
  * <p>Contains set of transcription results from one or more audio segments, along with additional
505
544
  * information about the parameters included in your request. For example, channel definitions, partial result
506
545
  * stabilization, sentiment, and issue detection.</p>
@@ -554,10 +593,14 @@ export interface UtteranceEvent {
554
593
  IssuesDetected?: IssueDetected[];
555
594
  }
556
595
  /**
596
+ * @public
557
597
  * <p>Contains detailed information about your Call Analytics streaming session. These details are
558
598
  * provided in the <code>UtteranceEvent</code> and <code>CategoryEvent</code> objects.</p>
559
599
  */
560
600
  export type CallAnalyticsTranscriptResultStream = CallAnalyticsTranscriptResultStream.BadRequestExceptionMember | CallAnalyticsTranscriptResultStream.CategoryEventMember | CallAnalyticsTranscriptResultStream.ConflictExceptionMember | CallAnalyticsTranscriptResultStream.InternalFailureExceptionMember | CallAnalyticsTranscriptResultStream.LimitExceededExceptionMember | CallAnalyticsTranscriptResultStream.ServiceUnavailableExceptionMember | CallAnalyticsTranscriptResultStream.UtteranceEventMember | CallAnalyticsTranscriptResultStream.$UnknownMember;
601
+ /**
602
+ * @public
603
+ */
561
604
  export declare namespace CallAnalyticsTranscriptResultStream {
562
605
  /**
563
606
  * <p>Contains set of transcription results from one or more audio segments, along with additional
@@ -680,12 +723,21 @@ export declare namespace CallAnalyticsTranscriptResultStream {
680
723
  }
681
724
  const visit: <T>(value: CallAnalyticsTranscriptResultStream, visitor: Visitor<T>) => T;
682
725
  }
726
+ /**
727
+ * @public
728
+ */
683
729
  export declare enum ContentIdentificationType {
684
730
  PII = "PII"
685
731
  }
732
+ /**
733
+ * @public
734
+ */
686
735
  export declare enum ContentRedactionType {
687
736
  PII = "PII"
688
737
  }
738
+ /**
739
+ * @public
740
+ */
689
741
  export declare enum LanguageCode {
690
742
  DE_DE = "de-DE",
691
743
  EN_AU = "en-AU",
@@ -703,6 +755,7 @@ export declare enum LanguageCode {
703
755
  ZH_CN = "zh-CN"
704
756
  }
705
757
  /**
758
+ * @public
706
759
  * <p>The language code that represents the language identified in your audio, including the associated
707
760
  * confidence score. If you enabled channel identification in your request and each channel contained a
708
761
  * different language, you will have more than one <code>LanguageWithScore</code> result.</p>
@@ -718,12 +771,16 @@ export interface LanguageWithScore {
718
771
  */
719
772
  Score?: number;
720
773
  }
774
+ /**
775
+ * @public
776
+ */
721
777
  export declare enum MediaEncoding {
722
778
  FLAC = "flac",
723
779
  OGG_OPUS = "ogg-opus",
724
780
  PCM = "pcm"
725
781
  }
726
782
  /**
783
+ * @public
727
784
  * <p>Contains entities identified as personal health information (PHI) in your
728
785
  * transcription output, along with various associated attributes. Examples include
729
786
  * category, confidence score, type, stability score, and start and end times.</p>
@@ -754,6 +811,7 @@ export interface MedicalEntity {
754
811
  Confidence?: number;
755
812
  }
756
813
  /**
814
+ * @public
757
815
  * <p>A word, phrase, or punctuation mark in your transcription output, along with various
758
816
  * associated attributes, such as confidence score, type, and start and end times.</p>
759
817
  */
@@ -789,6 +847,7 @@ export interface MedicalItem {
789
847
  Speaker?: string;
790
848
  }
791
849
  /**
850
+ * @public
792
851
  * <p>A list of possible alternative transcriptions for the input audio. Each alternative may
793
852
  * contain one or more of <code>Items</code>, <code>Entities</code>, or
794
853
  * <code>Transcript</code>.</p>
@@ -808,10 +867,14 @@ export interface MedicalAlternative {
808
867
  */
809
868
  Entities?: MedicalEntity[];
810
869
  }
870
+ /**
871
+ * @public
872
+ */
811
873
  export declare enum MedicalContentIdentificationType {
812
874
  PHI = "PHI"
813
875
  }
814
876
  /**
877
+ * @public
815
878
  * <p>The <code>Result</code> associated with a
816
879
  * <code></code>.</p>
817
880
  * <p>Contains a set of transcription results from one or more audio segments, along with
@@ -850,6 +913,7 @@ export interface MedicalResult {
850
913
  ChannelId?: string;
851
914
  }
852
915
  /**
916
+ * @public
853
917
  * <p>The <code>MedicalTranscript</code> associated with a
854
918
  * <code></code>.</p>
855
919
  * <p>
@@ -867,6 +931,7 @@ export interface MedicalTranscript {
867
931
  Results?: MedicalResult[];
868
932
  }
869
933
  /**
934
+ * @public
870
935
  * <p>The <code>MedicalTranscriptEvent</code> associated with a
871
936
  * <code>MedicalTranscriptResultStream</code>.</p>
872
937
  * <p>Contains a set of transcription results from one or more audio segments, along with additional
@@ -882,9 +947,13 @@ export interface MedicalTranscriptEvent {
882
947
  Transcript?: MedicalTranscript;
883
948
  }
884
949
  /**
950
+ * @public
885
951
  * <p>Contains detailed information about your streaming session.</p>
886
952
  */
887
953
  export type MedicalTranscriptResultStream = MedicalTranscriptResultStream.BadRequestExceptionMember | MedicalTranscriptResultStream.ConflictExceptionMember | MedicalTranscriptResultStream.InternalFailureExceptionMember | MedicalTranscriptResultStream.LimitExceededExceptionMember | MedicalTranscriptResultStream.ServiceUnavailableExceptionMember | MedicalTranscriptResultStream.TranscriptEventMember | MedicalTranscriptResultStream.$UnknownMember;
954
+ /**
955
+ * @public
956
+ */
888
957
  export declare namespace MedicalTranscriptResultStream {
889
958
  /**
890
959
  * <p>The <code>MedicalTranscriptEvent</code> associated with a
@@ -988,12 +1057,16 @@ export declare namespace MedicalTranscriptResultStream {
988
1057
  }
989
1058
  const visit: <T>(value: MedicalTranscriptResultStream, visitor: Visitor<T>) => T;
990
1059
  }
1060
+ /**
1061
+ * @public
1062
+ */
991
1063
  export declare enum PartialResultsStability {
992
1064
  HIGH = "high",
993
1065
  LOW = "low",
994
1066
  MEDIUM = "medium"
995
1067
  }
996
1068
  /**
1069
+ * @public
997
1070
  * <p>The <code>Result</code> associated with a
998
1071
  * <code></code>.</p>
999
1072
  * <p>Contains a set of transcription results from one or more audio segments, along with additional
@@ -1040,6 +1113,9 @@ export interface Result {
1040
1113
  */
1041
1114
  LanguageIdentification?: LanguageWithScore[];
1042
1115
  }
1116
+ /**
1117
+ * @public
1118
+ */
1043
1119
  export declare enum Specialty {
1044
1120
  CARDIOLOGY = "CARDIOLOGY",
1045
1121
  NEUROLOGY = "NEUROLOGY",
@@ -1048,11 +1124,17 @@ export declare enum Specialty {
1048
1124
  RADIOLOGY = "RADIOLOGY",
1049
1125
  UROLOGY = "UROLOGY"
1050
1126
  }
1127
+ /**
1128
+ * @public
1129
+ */
1051
1130
  export declare enum VocabularyFilterMethod {
1052
1131
  MASK = "mask",
1053
1132
  REMOVE = "remove",
1054
1133
  TAG = "tag"
1055
1134
  }
1135
+ /**
1136
+ * @public
1137
+ */
1056
1138
  export interface StartCallAnalyticsStreamTranscriptionRequest {
1057
1139
  /**
1058
1140
  * <p>Specify the language code that represents the language spoken in your audio.</p>
@@ -1183,6 +1265,9 @@ export interface StartCallAnalyticsStreamTranscriptionRequest {
1183
1265
  */
1184
1266
  PiiEntityTypes?: string;
1185
1267
  }
1268
+ /**
1269
+ * @public
1270
+ */
1186
1271
  export interface StartCallAnalyticsStreamTranscriptionResponse {
1187
1272
  /**
1188
1273
  * <p>Provides the identifier for your Call Analytics streaming request.</p>
@@ -1247,10 +1332,16 @@ export interface StartCallAnalyticsStreamTranscriptionResponse {
1247
1332
  */
1248
1333
  PiiEntityTypes?: string;
1249
1334
  }
1335
+ /**
1336
+ * @public
1337
+ */
1250
1338
  export declare enum Type {
1251
1339
  CONVERSATION = "CONVERSATION",
1252
1340
  DICTATION = "DICTATION"
1253
1341
  }
1342
+ /**
1343
+ * @public
1344
+ */
1254
1345
  export interface StartMedicalStreamTranscriptionRequest {
1255
1346
  /**
1256
1347
  * <p>Specify the language code that represents the language spoken in your audio.</p>
@@ -1339,6 +1430,9 @@ export interface StartMedicalStreamTranscriptionRequest {
1339
1430
  */
1340
1431
  ContentIdentificationType?: MedicalContentIdentificationType | string;
1341
1432
  }
1433
+ /**
1434
+ * @public
1435
+ */
1342
1436
  export interface StartMedicalStreamTranscriptionResponse {
1343
1437
  /**
1344
1438
  * <p>Provides the identifier for your streaming request.</p>
@@ -1394,6 +1488,9 @@ export interface StartMedicalStreamTranscriptionResponse {
1394
1488
  */
1395
1489
  ContentIdentificationType?: MedicalContentIdentificationType | string;
1396
1490
  }
1491
+ /**
1492
+ * @public
1493
+ */
1397
1494
  export interface StartStreamTranscriptionRequest {
1398
1495
  /**
1399
1496
  * <p>Specify the language code that represents the language spoken in your audio.</p>
@@ -1627,6 +1724,7 @@ export interface StartStreamTranscriptionRequest {
1627
1724
  VocabularyFilterNames?: string;
1628
1725
  }
1629
1726
  /**
1727
+ * @public
1630
1728
  * <p>The <code>Transcript</code> associated with a
1631
1729
  * <code></code>.</p>
1632
1730
  * <p>
@@ -1644,6 +1742,7 @@ export interface Transcript {
1644
1742
  Results?: Result[];
1645
1743
  }
1646
1744
  /**
1745
+ * @public
1647
1746
  * <p>The <code>TranscriptEvent</code> associated with a
1648
1747
  * <code>TranscriptResultStream</code>.</p>
1649
1748
  * <p>Contains a set of transcription results from one or more audio segments, along with additional
@@ -1659,9 +1758,13 @@ export interface TranscriptEvent {
1659
1758
  Transcript?: Transcript;
1660
1759
  }
1661
1760
  /**
1761
+ * @public
1662
1762
  * <p>Contains detailed information about your streaming session.</p>
1663
1763
  */
1664
1764
  export type TranscriptResultStream = TranscriptResultStream.BadRequestExceptionMember | TranscriptResultStream.ConflictExceptionMember | TranscriptResultStream.InternalFailureExceptionMember | TranscriptResultStream.LimitExceededExceptionMember | TranscriptResultStream.ServiceUnavailableExceptionMember | TranscriptResultStream.TranscriptEventMember | TranscriptResultStream.$UnknownMember;
1765
+ /**
1766
+ * @public
1767
+ */
1665
1768
  export declare namespace TranscriptResultStream {
1666
1769
  /**
1667
1770
  * <p>Contains <code>Transcript</code>, which contains <code>Results</code>. The
@@ -1762,6 +1865,9 @@ export declare namespace TranscriptResultStream {
1762
1865
  }
1763
1866
  const visit: <T>(value: TranscriptResultStream, visitor: Visitor<T>) => T;
1764
1867
  }
1868
+ /**
1869
+ * @public
1870
+ */
1765
1871
  export interface StartStreamTranscriptionResponse {
1766
1872
  /**
1767
1873
  * <p>Provides the identifier for your streaming request.</p>
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-transcribe-streaming",
3
3
  "description": "AWS SDK for JavaScript Transcribe Streaming Client for Node.js, Browser and React Native",
4
- "version": "3.296.0",
4
+ "version": "3.297.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.296.0",
24
+ "@aws-sdk/client-sts": "3.297.0",
25
25
  "@aws-sdk/config-resolver": "3.296.0",
26
- "@aws-sdk/credential-provider-node": "3.296.0",
26
+ "@aws-sdk/credential-provider-node": "3.297.0",
27
27
  "@aws-sdk/eventstream-handler-node": "3.296.0",
28
28
  "@aws-sdk/eventstream-serde-browser": "3.296.0",
29
29
  "@aws-sdk/eventstream-serde-config-resolver": "3.296.0",