@aws-sdk/client-transcribe-streaming 3.215.0 → 3.218.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.
Files changed (27) hide show
  1. package/dist-cjs/TranscribeStreaming.js +15 -0
  2. package/dist-cjs/commands/StartCallAnalyticsStreamTranscriptionCommand.js +48 -0
  3. package/dist-cjs/commands/index.js +1 -0
  4. package/dist-cjs/endpoint/ruleset.js +4 -4
  5. package/dist-cjs/models/models_0.js +168 -41
  6. package/dist-cjs/protocols/Aws_restJson1.js +336 -1
  7. package/dist-es/TranscribeStreaming.js +15 -0
  8. package/dist-es/commands/StartCallAnalyticsStreamTranscriptionCommand.js +44 -0
  9. package/dist-es/commands/index.js +1 -0
  10. package/dist-es/endpoint/ruleset.js +4 -4
  11. package/dist-es/models/models_0.js +151 -39
  12. package/dist-es/protocols/Aws_restJson1.js +334 -1
  13. package/dist-types/TranscribeStreaming.d.ts +65 -9
  14. package/dist-types/TranscribeStreamingClient.d.ts +12 -4
  15. package/dist-types/commands/StartCallAnalyticsStreamTranscriptionCommand.d.ts +58 -0
  16. package/dist-types/commands/StartMedicalStreamTranscriptionCommand.d.ts +18 -0
  17. package/dist-types/commands/StartStreamTranscriptionCommand.d.ts +10 -7
  18. package/dist-types/commands/index.d.ts +1 -0
  19. package/dist-types/models/models_0.d.ts +776 -53
  20. package/dist-types/protocols/Aws_restJson1.d.ts +3 -0
  21. package/dist-types/ts3.4/TranscribeStreaming.d.ts +23 -0
  22. package/dist-types/ts3.4/TranscribeStreamingClient.d.ts +6 -0
  23. package/dist-types/ts3.4/commands/StartCallAnalyticsStreamTranscriptionCommand.d.ts +41 -0
  24. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  25. package/dist-types/ts3.4/models/models_0.d.ts +302 -27
  26. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
  27. package/package.json +4 -4
@@ -1,10 +1,12 @@
1
1
  import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
2
+ import { StartCallAnalyticsStreamTranscriptionCommandInput, StartCallAnalyticsStreamTranscriptionCommandOutput } from "./commands/StartCallAnalyticsStreamTranscriptionCommand";
2
3
  import { StartMedicalStreamTranscriptionCommandInput, StartMedicalStreamTranscriptionCommandOutput } from "./commands/StartMedicalStreamTranscriptionCommand";
3
4
  import { StartStreamTranscriptionCommandInput, StartStreamTranscriptionCommandOutput } from "./commands/StartStreamTranscriptionCommand";
4
5
  import { TranscribeStreamingClient } from "./TranscribeStreamingClient";
5
6
  /**
6
- * <p>Amazon Transcribe streaming offers two types of real-time transcription:
7
- * <b>Standard</b> and <b>Medical</b>.</p>
7
+ * <p>Amazon Transcribe streaming offers three main types of real-time transcription:
8
+ * <b>Standard</b>, <b>Medical</b>, and
9
+ * <b>Call Analytics</b>.</p>
8
10
  * <ul>
9
11
  * <li>
10
12
  * <p>
@@ -18,13 +20,64 @@ import { TranscribeStreamingClient } from "./TranscribeStreamingClient";
18
20
  * dialogue in real time, so doctors can focus on their patient instead of taking notes. Refer to
19
21
  * for details.</p>
20
22
  * </li>
23
+ * <li>
24
+ * <p>
25
+ * <b>Call Analytics transcriptions</b> are designed for use with call
26
+ * center audio on two different channels; if you're looking for insight into customer service calls, use this
27
+ * option. Refer to for details.</p>
28
+ * </li>
21
29
  * </ul>
22
30
  */
23
31
  export declare class TranscribeStreaming extends TranscribeStreamingClient {
32
+ /**
33
+ * <p>Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to
34
+ * Amazon Transcribe and the transcription results are streamed to your application. Use this operation
35
+ * for <a href="https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html">Call Analytics</a> transcriptions.</p>
36
+ * <p>The following parameters are required:</p>
37
+ * <ul>
38
+ * <li>
39
+ * <p>
40
+ * <code>language-code</code>
41
+ * </p>
42
+ * </li>
43
+ * <li>
44
+ * <p>
45
+ * <code>media-encoding</code>
46
+ * </p>
47
+ * </li>
48
+ * <li>
49
+ * <p>
50
+ * <code>sample-rate</code>
51
+ * </p>
52
+ * </li>
53
+ * </ul>
54
+ * <p>For more information on streaming with Amazon Transcribe, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
55
+ */
56
+ startCallAnalyticsStreamTranscription(args: StartCallAnalyticsStreamTranscriptionCommandInput, options?: __HttpHandlerOptions): Promise<StartCallAnalyticsStreamTranscriptionCommandOutput>;
57
+ startCallAnalyticsStreamTranscription(args: StartCallAnalyticsStreamTranscriptionCommandInput, cb: (err: any, data?: StartCallAnalyticsStreamTranscriptionCommandOutput) => void): void;
58
+ startCallAnalyticsStreamTranscription(args: StartCallAnalyticsStreamTranscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCallAnalyticsStreamTranscriptionCommandOutput) => void): void;
24
59
  /**
25
60
  * <p>Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to
26
61
  * Amazon Transcribe Medical and the transcription results are streamed to your
27
62
  * application.</p>
63
+ * <p>The following parameters are required:</p>
64
+ * <ul>
65
+ * <li>
66
+ * <p>
67
+ * <code>language-code</code>
68
+ * </p>
69
+ * </li>
70
+ * <li>
71
+ * <p>
72
+ * <code>media-encoding</code>
73
+ * </p>
74
+ * </li>
75
+ * <li>
76
+ * <p>
77
+ * <code>sample-rate</code>
78
+ * </p>
79
+ * </li>
80
+ * </ul>
28
81
  * <p>For more information on streaming with Amazon Transcribe Medical, see
29
82
  * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing
30
83
  * streaming audio</a>.</p>
@@ -35,19 +88,22 @@ export declare class TranscribeStreaming extends TranscribeStreamingClient {
35
88
  /**
36
89
  * <p>Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to
37
90
  * Amazon Transcribe and the transcription results are streamed to your application.</p>
38
- * <p>The following are encoded as headers:</p>
91
+ * <p>The following parameters are required:</p>
39
92
  * <ul>
40
93
  * <li>
41
- * <p>language-code</p>
42
- * </li>
43
- * <li>
44
- * <p>media-encoding</p>
94
+ * <p>
95
+ * <code>language-code</code> or <code>identify-language</code>
96
+ * </p>
45
97
  * </li>
46
98
  * <li>
47
- * <p>sample-rate</p>
99
+ * <p>
100
+ * <code>media-encoding</code>
101
+ * </p>
48
102
  * </li>
49
103
  * <li>
50
- * <p>session-id</p>
104
+ * <p>
105
+ * <code>sample-rate</code>
106
+ * </p>
51
107
  * </li>
52
108
  * </ul>
53
109
  * <p>For more information on streaming with Amazon Transcribe, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
@@ -10,11 +10,12 @@ import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middlewa
10
10
  import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
11
11
  import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
12
12
  import { BodyLengthCalculator as __BodyLengthCalculator, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, EventStreamPayloadHandlerProvider as __EventStreamPayloadHandlerProvider, EventStreamSerdeProvider as __EventStreamSerdeProvider, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
13
+ import { StartCallAnalyticsStreamTranscriptionCommandInput, StartCallAnalyticsStreamTranscriptionCommandOutput } from "./commands/StartCallAnalyticsStreamTranscriptionCommand";
13
14
  import { StartMedicalStreamTranscriptionCommandInput, StartMedicalStreamTranscriptionCommandOutput } from "./commands/StartMedicalStreamTranscriptionCommand";
14
15
  import { StartStreamTranscriptionCommandInput, StartStreamTranscriptionCommandOutput } from "./commands/StartStreamTranscriptionCommand";
15
16
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
16
- export declare type ServiceInputTypes = StartMedicalStreamTranscriptionCommandInput | StartStreamTranscriptionCommandInput;
17
- export declare type ServiceOutputTypes = StartMedicalStreamTranscriptionCommandOutput | StartStreamTranscriptionCommandOutput;
17
+ export declare type ServiceInputTypes = StartCallAnalyticsStreamTranscriptionCommandInput | StartMedicalStreamTranscriptionCommandInput | StartStreamTranscriptionCommandInput;
18
+ export declare type ServiceOutputTypes = StartCallAnalyticsStreamTranscriptionCommandOutput | StartMedicalStreamTranscriptionCommandOutput | StartStreamTranscriptionCommandOutput;
18
19
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
19
20
  /**
20
21
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
@@ -137,8 +138,9 @@ declare type TranscribeStreamingClientResolvedConfigType = __SmithyResolvedConfi
137
138
  export interface TranscribeStreamingClientResolvedConfig extends TranscribeStreamingClientResolvedConfigType {
138
139
  }
139
140
  /**
140
- * <p>Amazon Transcribe streaming offers two types of real-time transcription:
141
- * <b>Standard</b> and <b>Medical</b>.</p>
141
+ * <p>Amazon Transcribe streaming offers three main types of real-time transcription:
142
+ * <b>Standard</b>, <b>Medical</b>, and
143
+ * <b>Call Analytics</b>.</p>
142
144
  * <ul>
143
145
  * <li>
144
146
  * <p>
@@ -152,6 +154,12 @@ export interface TranscribeStreamingClientResolvedConfig extends TranscribeStrea
152
154
  * dialogue in real time, so doctors can focus on their patient instead of taking notes. Refer to
153
155
  * for details.</p>
154
156
  * </li>
157
+ * <li>
158
+ * <p>
159
+ * <b>Call Analytics transcriptions</b> are designed for use with call
160
+ * center audio on two different channels; if you're looking for insight into customer service calls, use this
161
+ * option. Refer to for details.</p>
162
+ * </li>
155
163
  * </ul>
156
164
  */
157
165
  export declare class TranscribeStreamingClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, TranscribeStreamingClientResolvedConfig> {
@@ -0,0 +1,58 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { StartCallAnalyticsStreamTranscriptionRequest, StartCallAnalyticsStreamTranscriptionResponse } from "../models/models_0";
5
+ import { ServiceInputTypes, ServiceOutputTypes, TranscribeStreamingClientResolvedConfig } from "../TranscribeStreamingClient";
6
+ export interface StartCallAnalyticsStreamTranscriptionCommandInput extends StartCallAnalyticsStreamTranscriptionRequest {
7
+ }
8
+ export interface StartCallAnalyticsStreamTranscriptionCommandOutput extends StartCallAnalyticsStreamTranscriptionResponse, __MetadataBearer {
9
+ }
10
+ /**
11
+ * <p>Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to
12
+ * Amazon Transcribe and the transcription results are streamed to your application. Use this operation
13
+ * for <a href="https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html">Call Analytics</a> transcriptions.</p>
14
+ * <p>The following parameters are required:</p>
15
+ * <ul>
16
+ * <li>
17
+ * <p>
18
+ * <code>language-code</code>
19
+ * </p>
20
+ * </li>
21
+ * <li>
22
+ * <p>
23
+ * <code>media-encoding</code>
24
+ * </p>
25
+ * </li>
26
+ * <li>
27
+ * <p>
28
+ * <code>sample-rate</code>
29
+ * </p>
30
+ * </li>
31
+ * </ul>
32
+ * <p>For more information on streaming with Amazon Transcribe, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { TranscribeStreamingClient, StartCallAnalyticsStreamTranscriptionCommand } from "@aws-sdk/client-transcribe-streaming"; // ES Modules import
37
+ * // const { TranscribeStreamingClient, StartCallAnalyticsStreamTranscriptionCommand } = require("@aws-sdk/client-transcribe-streaming"); // CommonJS import
38
+ * const client = new TranscribeStreamingClient(config);
39
+ * const command = new StartCallAnalyticsStreamTranscriptionCommand(input);
40
+ * const response = await client.send(command);
41
+ * ```
42
+ *
43
+ * @see {@link StartCallAnalyticsStreamTranscriptionCommandInput} for command's `input` shape.
44
+ * @see {@link StartCallAnalyticsStreamTranscriptionCommandOutput} for command's `response` shape.
45
+ * @see {@link TranscribeStreamingClientResolvedConfig | config} for TranscribeStreamingClient's `config` shape.
46
+ *
47
+ */
48
+ export declare class StartCallAnalyticsStreamTranscriptionCommand extends $Command<StartCallAnalyticsStreamTranscriptionCommandInput, StartCallAnalyticsStreamTranscriptionCommandOutput, TranscribeStreamingClientResolvedConfig> {
49
+ readonly input: StartCallAnalyticsStreamTranscriptionCommandInput;
50
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
51
+ constructor(input: StartCallAnalyticsStreamTranscriptionCommandInput);
52
+ /**
53
+ * @internal
54
+ */
55
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TranscribeStreamingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartCallAnalyticsStreamTranscriptionCommandInput, StartCallAnalyticsStreamTranscriptionCommandOutput>;
56
+ private serialize;
57
+ private deserialize;
58
+ }
@@ -11,6 +11,24 @@ export interface StartMedicalStreamTranscriptionCommandOutput extends StartMedic
11
11
  * <p>Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to
12
12
  * Amazon Transcribe Medical and the transcription results are streamed to your
13
13
  * application.</p>
14
+ * <p>The following parameters are required:</p>
15
+ * <ul>
16
+ * <li>
17
+ * <p>
18
+ * <code>language-code</code>
19
+ * </p>
20
+ * </li>
21
+ * <li>
22
+ * <p>
23
+ * <code>media-encoding</code>
24
+ * </p>
25
+ * </li>
26
+ * <li>
27
+ * <p>
28
+ * <code>sample-rate</code>
29
+ * </p>
30
+ * </li>
31
+ * </ul>
14
32
  * <p>For more information on streaming with Amazon Transcribe Medical, see
15
33
  * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing
16
34
  * streaming audio</a>.</p>
@@ -10,19 +10,22 @@ export interface StartStreamTranscriptionCommandOutput extends StartStreamTransc
10
10
  /**
11
11
  * <p>Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to
12
12
  * Amazon Transcribe and the transcription results are streamed to your application.</p>
13
- * <p>The following are encoded as headers:</p>
13
+ * <p>The following parameters are required:</p>
14
14
  * <ul>
15
15
  * <li>
16
- * <p>language-code</p>
16
+ * <p>
17
+ * <code>language-code</code> or <code>identify-language</code>
18
+ * </p>
17
19
  * </li>
18
20
  * <li>
19
- * <p>media-encoding</p>
21
+ * <p>
22
+ * <code>media-encoding</code>
23
+ * </p>
20
24
  * </li>
21
25
  * <li>
22
- * <p>sample-rate</p>
23
- * </li>
24
- * <li>
25
- * <p>session-id</p>
26
+ * <p>
27
+ * <code>sample-rate</code>
28
+ * </p>
26
29
  * </li>
27
30
  * </ul>
28
31
  * <p>For more information on streaming with Amazon Transcribe, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
@@ -1,2 +1,3 @@
1
+ export * from "./StartCallAnalyticsStreamTranscriptionCommand";
1
2
  export * from "./StartMedicalStreamTranscriptionCommand";
2
3
  export * from "./StartStreamTranscriptionCommand";