@aws-sdk/client-lex-runtime-v2 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.
- package/dist-types/LexRuntimeV2.d.ts +7 -0
- package/dist-types/LexRuntimeV2Client.d.ts +24 -4
- package/dist-types/commands/DeleteSessionCommand.d.ts +16 -0
- package/dist-types/commands/GetSessionCommand.d.ts +16 -0
- package/dist-types/commands/PutSessionCommand.d.ts +16 -0
- package/dist-types/commands/RecognizeTextCommand.d.ts +16 -0
- package/dist-types/commands/RecognizeUtteranceCommand.d.ts +17 -2
- package/dist-types/commands/StartConversationCommand.d.ts +16 -0
- package/dist-types/models/LexRuntimeV2ServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +113 -0
- package/dist-types/ts3.4/commands/RecognizeUtteranceCommand.d.ts +1 -2
- package/package.json +3 -3
|
@@ -7,10 +7,12 @@ import { RecognizeUtteranceCommandInput, RecognizeUtteranceCommandOutput } from
|
|
|
7
7
|
import { StartConversationCommandInput, StartConversationCommandOutput } from "./commands/StartConversationCommand";
|
|
8
8
|
import { LexRuntimeV2Client } from "./LexRuntimeV2Client";
|
|
9
9
|
/**
|
|
10
|
+
* @public
|
|
10
11
|
* <p>This section contains documentation for the Amazon Lex V2 Runtime V2 API operations.</p>
|
|
11
12
|
*/
|
|
12
13
|
export declare class LexRuntimeV2 extends LexRuntimeV2Client {
|
|
13
14
|
/**
|
|
15
|
+
* @public
|
|
14
16
|
* <p>Removes session information for a specified bot, alias, and user ID. </p>
|
|
15
17
|
* <p>You can use this operation to restart a conversation with a bot.
|
|
16
18
|
* When you remove a session, the entire history of the session is removed
|
|
@@ -30,6 +32,7 @@ export declare class LexRuntimeV2 extends LexRuntimeV2Client {
|
|
|
30
32
|
deleteSession(args: DeleteSessionCommandInput, cb: (err: any, data?: DeleteSessionCommandOutput) => void): void;
|
|
31
33
|
deleteSession(args: DeleteSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSessionCommandOutput) => void): void;
|
|
32
34
|
/**
|
|
35
|
+
* @public
|
|
33
36
|
* <p>Returns session information for a specified bot, alias, and
|
|
34
37
|
* user.</p>
|
|
35
38
|
* <p>For example, you can use this operation to retrieve session
|
|
@@ -44,6 +47,7 @@ export declare class LexRuntimeV2 extends LexRuntimeV2Client {
|
|
|
44
47
|
getSession(args: GetSessionCommandInput, cb: (err: any, data?: GetSessionCommandOutput) => void): void;
|
|
45
48
|
getSession(args: GetSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSessionCommandOutput) => void): void;
|
|
46
49
|
/**
|
|
50
|
+
* @public
|
|
47
51
|
* <p>Creates a new session or modifies an existing session with an Amazon Lex V2
|
|
48
52
|
* bot. Use this operation to enable your application to set the state of
|
|
49
53
|
* the bot.</p>
|
|
@@ -52,6 +56,7 @@ export declare class LexRuntimeV2 extends LexRuntimeV2Client {
|
|
|
52
56
|
putSession(args: PutSessionCommandInput, cb: (err: any, data?: PutSessionCommandOutput) => void): void;
|
|
53
57
|
putSession(args: PutSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSessionCommandOutput) => void): void;
|
|
54
58
|
/**
|
|
59
|
+
* @public
|
|
55
60
|
* <p>Sends user input to Amazon Lex V2. Client applications use this API to send
|
|
56
61
|
* requests to Amazon Lex V2 at runtime. Amazon Lex V2 then interprets the user input
|
|
57
62
|
* using the machine learning model that it build for the bot.</p>
|
|
@@ -88,6 +93,7 @@ export declare class LexRuntimeV2 extends LexRuntimeV2Client {
|
|
|
88
93
|
recognizeText(args: RecognizeTextCommandInput, cb: (err: any, data?: RecognizeTextCommandOutput) => void): void;
|
|
89
94
|
recognizeText(args: RecognizeTextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RecognizeTextCommandOutput) => void): void;
|
|
90
95
|
/**
|
|
96
|
+
* @public
|
|
91
97
|
* <p>Sends user input to Amazon Lex V2. You can send text or speech. Clients use
|
|
92
98
|
* this API to send text and audio requests to Amazon Lex V2 at runtime. Amazon Lex V2
|
|
93
99
|
* interprets the user input using the machine learning model built for
|
|
@@ -156,6 +162,7 @@ export declare class LexRuntimeV2 extends LexRuntimeV2Client {
|
|
|
156
162
|
recognizeUtterance(args: RecognizeUtteranceCommandInput, cb: (err: any, data?: RecognizeUtteranceCommandOutput) => void): void;
|
|
157
163
|
recognizeUtterance(args: RecognizeUtteranceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RecognizeUtteranceCommandOutput) => void): void;
|
|
158
164
|
/**
|
|
165
|
+
* @public
|
|
159
166
|
* <p>Starts an HTTP/2 bidirectional event stream that enables you to send
|
|
160
167
|
* audio, text, or DTMF input in real time. After your application starts
|
|
161
168
|
* a conversation, users send input to Amazon Lex V2 as a stream of events. Amazon Lex V2
|
|
@@ -16,15 +16,24 @@ import { RecognizeTextCommandInput, RecognizeTextCommandOutput } from "./command
|
|
|
16
16
|
import { RecognizeUtteranceCommandInput, RecognizeUtteranceCommandOutput } from "./commands/RecognizeUtteranceCommand";
|
|
17
17
|
import { StartConversationCommandInput, StartConversationCommandOutput } from "./commands/StartConversationCommand";
|
|
18
18
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
19
|
+
/**
|
|
20
|
+
* @public
|
|
21
|
+
*/
|
|
19
22
|
export type ServiceInputTypes = DeleteSessionCommandInput | GetSessionCommandInput | PutSessionCommandInput | RecognizeTextCommandInput | RecognizeUtteranceCommandInput | StartConversationCommandInput;
|
|
23
|
+
/**
|
|
24
|
+
* @public
|
|
25
|
+
*/
|
|
20
26
|
export type ServiceOutputTypes = DeleteSessionCommandOutput | GetSessionCommandOutput | PutSessionCommandOutput | RecognizeTextCommandOutput | RecognizeUtteranceCommandOutput | StartConversationCommandOutput;
|
|
27
|
+
/**
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
21
30
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
22
31
|
/**
|
|
23
32
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
24
33
|
*/
|
|
25
34
|
requestHandler?: __HttpHandler;
|
|
26
35
|
/**
|
|
27
|
-
* A constructor for a class implementing the {@link
|
|
36
|
+
* A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
|
|
28
37
|
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
|
|
29
38
|
* @internal
|
|
30
39
|
*/
|
|
@@ -123,7 +132,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
123
132
|
*/
|
|
124
133
|
eventStreamSerdeProvider?: __EventStreamSerdeProvider;
|
|
125
134
|
/**
|
|
126
|
-
* The {@link
|
|
135
|
+
* The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
|
|
127
136
|
*/
|
|
128
137
|
defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
|
|
129
138
|
/**
|
|
@@ -132,19 +141,30 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
132
141
|
*/
|
|
133
142
|
sdkStreamMixin?: __SdkStreamMixinInjector;
|
|
134
143
|
}
|
|
144
|
+
/**
|
|
145
|
+
* @public
|
|
146
|
+
*/
|
|
135
147
|
type LexRuntimeV2ClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & EventStreamInputConfig & UserAgentInputConfig & EventStreamSerdeInputConfig & ClientInputEndpointParameters;
|
|
136
148
|
/**
|
|
137
|
-
*
|
|
149
|
+
* @public
|
|
150
|
+
*
|
|
151
|
+
* The configuration interface of LexRuntimeV2Client class constructor that set the region, credentials and other options.
|
|
138
152
|
*/
|
|
139
153
|
export interface LexRuntimeV2ClientConfig extends LexRuntimeV2ClientConfigType {
|
|
140
154
|
}
|
|
155
|
+
/**
|
|
156
|
+
* @public
|
|
157
|
+
*/
|
|
141
158
|
type LexRuntimeV2ClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & EventStreamResolvedConfig & UserAgentResolvedConfig & EventStreamSerdeResolvedConfig & ClientResolvedEndpointParameters;
|
|
142
159
|
/**
|
|
143
|
-
*
|
|
160
|
+
* @public
|
|
161
|
+
*
|
|
162
|
+
* The resolved configuration interface of LexRuntimeV2Client class. This is resolved and normalized from the {@link LexRuntimeV2ClientConfig | constructor configuration interface}.
|
|
144
163
|
*/
|
|
145
164
|
export interface LexRuntimeV2ClientResolvedConfig extends LexRuntimeV2ClientResolvedConfigType {
|
|
146
165
|
}
|
|
147
166
|
/**
|
|
167
|
+
* @public
|
|
148
168
|
* <p>This section contains documentation for the Amazon Lex V2 Runtime V2 API operations.</p>
|
|
149
169
|
*/
|
|
150
170
|
export declare class LexRuntimeV2Client extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, LexRuntimeV2ClientResolvedConfig> {
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { LexRuntimeV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LexRuntimeV2Client";
|
|
5
5
|
import { DeleteSessionRequest, DeleteSessionResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link DeleteSessionCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface DeleteSessionCommandInput extends DeleteSessionRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link DeleteSessionCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface DeleteSessionCommandOutput extends DeleteSessionResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Removes session information for a specified bot, alias, and user ID. </p>
|
|
18
23
|
* <p>You can use this operation to restart a conversation with a bot.
|
|
19
24
|
* When you remove a session, the entire history of the session is removed
|
|
@@ -38,6 +43,8 @@ export interface DeleteSessionCommandOutput extends DeleteSessionResponse, __Met
|
|
|
38
43
|
* const response = await client.send(command);
|
|
39
44
|
* ```
|
|
40
45
|
*
|
|
46
|
+
* @param DeleteSessionCommandInput - {@link DeleteSessionCommandInput}
|
|
47
|
+
* @returns {@link DeleteSessionCommandOutput}
|
|
41
48
|
* @see {@link DeleteSessionCommandInput} for command's `input` shape.
|
|
42
49
|
* @see {@link DeleteSessionCommandOutput} for command's `response` shape.
|
|
43
50
|
* @see {@link LexRuntimeV2ClientResolvedConfig | config} for LexRuntimeV2Client's `config` shape.
|
|
@@ -65,11 +72,20 @@ export interface DeleteSessionCommandOutput extends DeleteSessionResponse, __Met
|
|
|
65
72
|
export declare class DeleteSessionCommand extends $Command<DeleteSessionCommandInput, DeleteSessionCommandOutput, LexRuntimeV2ClientResolvedConfig> {
|
|
66
73
|
readonly input: DeleteSessionCommandInput;
|
|
67
74
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
75
|
+
/**
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
68
78
|
constructor(input: DeleteSessionCommandInput);
|
|
69
79
|
/**
|
|
70
80
|
* @internal
|
|
71
81
|
*/
|
|
72
82
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LexRuntimeV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteSessionCommandInput, DeleteSessionCommandOutput>;
|
|
83
|
+
/**
|
|
84
|
+
* @internal
|
|
85
|
+
*/
|
|
73
86
|
private serialize;
|
|
87
|
+
/**
|
|
88
|
+
* @internal
|
|
89
|
+
*/
|
|
74
90
|
private deserialize;
|
|
75
91
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { LexRuntimeV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LexRuntimeV2Client";
|
|
5
5
|
import { GetSessionRequest, GetSessionResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link GetSessionCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface GetSessionCommandInput extends GetSessionRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link GetSessionCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface GetSessionCommandOutput extends GetSessionResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Returns session information for a specified bot, alias, and
|
|
18
23
|
* user.</p>
|
|
19
24
|
* <p>For example, you can use this operation to retrieve session
|
|
@@ -33,6 +38,8 @@ export interface GetSessionCommandOutput extends GetSessionResponse, __MetadataB
|
|
|
33
38
|
* const response = await client.send(command);
|
|
34
39
|
* ```
|
|
35
40
|
*
|
|
41
|
+
* @param GetSessionCommandInput - {@link GetSessionCommandInput}
|
|
42
|
+
* @returns {@link GetSessionCommandOutput}
|
|
36
43
|
* @see {@link GetSessionCommandInput} for command's `input` shape.
|
|
37
44
|
* @see {@link GetSessionCommandOutput} for command's `response` shape.
|
|
38
45
|
* @see {@link LexRuntimeV2ClientResolvedConfig | config} for LexRuntimeV2Client's `config` shape.
|
|
@@ -57,11 +64,20 @@ export interface GetSessionCommandOutput extends GetSessionResponse, __MetadataB
|
|
|
57
64
|
export declare class GetSessionCommand extends $Command<GetSessionCommandInput, GetSessionCommandOutput, LexRuntimeV2ClientResolvedConfig> {
|
|
58
65
|
readonly input: GetSessionCommandInput;
|
|
59
66
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
67
|
+
/**
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
60
70
|
constructor(input: GetSessionCommandInput);
|
|
61
71
|
/**
|
|
62
72
|
* @internal
|
|
63
73
|
*/
|
|
64
74
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LexRuntimeV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSessionCommandInput, GetSessionCommandOutput>;
|
|
75
|
+
/**
|
|
76
|
+
* @internal
|
|
77
|
+
*/
|
|
65
78
|
private serialize;
|
|
79
|
+
/**
|
|
80
|
+
* @internal
|
|
81
|
+
*/
|
|
66
82
|
private deserialize;
|
|
67
83
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { LexRuntimeV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LexRuntimeV2Client";
|
|
5
5
|
import { PutSessionRequest, PutSessionResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link PutSessionCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface PutSessionCommandInput extends PutSessionRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link PutSessionCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface PutSessionCommandOutput extends __WithSdkStreamMixin<PutSessionResponse, "audioStream">, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Creates a new session or modifies an existing session with an Amazon Lex V2
|
|
18
23
|
* bot. Use this operation to enable your application to set the state of
|
|
19
24
|
* the bot.</p>
|
|
@@ -27,6 +32,8 @@ export interface PutSessionCommandOutput extends __WithSdkStreamMixin<PutSession
|
|
|
27
32
|
* const response = await client.send(command);
|
|
28
33
|
* ```
|
|
29
34
|
*
|
|
35
|
+
* @param PutSessionCommandInput - {@link PutSessionCommandInput}
|
|
36
|
+
* @returns {@link PutSessionCommandOutput}
|
|
30
37
|
* @see {@link PutSessionCommandInput} for command's `input` shape.
|
|
31
38
|
* @see {@link PutSessionCommandOutput} for command's `response` shape.
|
|
32
39
|
* @see {@link LexRuntimeV2ClientResolvedConfig | config} for LexRuntimeV2Client's `config` shape.
|
|
@@ -60,11 +67,20 @@ export interface PutSessionCommandOutput extends __WithSdkStreamMixin<PutSession
|
|
|
60
67
|
export declare class PutSessionCommand extends $Command<PutSessionCommandInput, PutSessionCommandOutput, LexRuntimeV2ClientResolvedConfig> {
|
|
61
68
|
readonly input: PutSessionCommandInput;
|
|
62
69
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
70
|
+
/**
|
|
71
|
+
* @public
|
|
72
|
+
*/
|
|
63
73
|
constructor(input: PutSessionCommandInput);
|
|
64
74
|
/**
|
|
65
75
|
* @internal
|
|
66
76
|
*/
|
|
67
77
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LexRuntimeV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutSessionCommandInput, PutSessionCommandOutput>;
|
|
78
|
+
/**
|
|
79
|
+
* @internal
|
|
80
|
+
*/
|
|
68
81
|
private serialize;
|
|
82
|
+
/**
|
|
83
|
+
* @internal
|
|
84
|
+
*/
|
|
69
85
|
private deserialize;
|
|
70
86
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { LexRuntimeV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LexRuntimeV2Client";
|
|
5
5
|
import { RecognizeTextRequest, RecognizeTextResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link RecognizeTextCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface RecognizeTextCommandInput extends RecognizeTextRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link RecognizeTextCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface RecognizeTextCommandOutput extends RecognizeTextResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Sends user input to Amazon Lex V2. Client applications use this API to send
|
|
18
23
|
* requests to Amazon Lex V2 at runtime. Amazon Lex V2 then interprets the user input
|
|
19
24
|
* using the machine learning model that it build for the bot.</p>
|
|
@@ -55,6 +60,8 @@ export interface RecognizeTextCommandOutput extends RecognizeTextResponse, __Met
|
|
|
55
60
|
* const response = await client.send(command);
|
|
56
61
|
* ```
|
|
57
62
|
*
|
|
63
|
+
* @param RecognizeTextCommandInput - {@link RecognizeTextCommandInput}
|
|
64
|
+
* @returns {@link RecognizeTextCommandOutput}
|
|
58
65
|
* @see {@link RecognizeTextCommandInput} for command's `input` shape.
|
|
59
66
|
* @see {@link RecognizeTextCommandOutput} for command's `response` shape.
|
|
60
67
|
* @see {@link LexRuntimeV2ClientResolvedConfig | config} for LexRuntimeV2Client's `config` shape.
|
|
@@ -88,11 +95,20 @@ export interface RecognizeTextCommandOutput extends RecognizeTextResponse, __Met
|
|
|
88
95
|
export declare class RecognizeTextCommand extends $Command<RecognizeTextCommandInput, RecognizeTextCommandOutput, LexRuntimeV2ClientResolvedConfig> {
|
|
89
96
|
readonly input: RecognizeTextCommandInput;
|
|
90
97
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
98
|
+
/**
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
91
101
|
constructor(input: RecognizeTextCommandInput);
|
|
92
102
|
/**
|
|
93
103
|
* @internal
|
|
94
104
|
*/
|
|
95
105
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LexRuntimeV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RecognizeTextCommandInput, RecognizeTextCommandOutput>;
|
|
106
|
+
/**
|
|
107
|
+
* @internal
|
|
108
|
+
*/
|
|
96
109
|
private serialize;
|
|
110
|
+
/**
|
|
111
|
+
* @internal
|
|
112
|
+
*/
|
|
97
113
|
private deserialize;
|
|
98
114
|
}
|
|
@@ -5,9 +5,11 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
5
5
|
import { LexRuntimeV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LexRuntimeV2Client";
|
|
6
6
|
import { RecognizeUtteranceRequest, RecognizeUtteranceResponse } from "../models/models_0";
|
|
7
7
|
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
8
10
|
* The input for {@link RecognizeUtteranceCommand}.
|
|
9
11
|
*/
|
|
10
|
-
type RecognizeUtteranceCommandInputType = Omit<RecognizeUtteranceRequest, "inputStream"> & {
|
|
12
|
+
export type RecognizeUtteranceCommandInputType = Omit<RecognizeUtteranceRequest, "inputStream"> & {
|
|
11
13
|
/**
|
|
12
14
|
* For *`RecognizeUtteranceRequest["inputStream"]`*, see {@link RecognizeUtteranceRequest.inputStream}.
|
|
13
15
|
*/
|
|
@@ -19,11 +21,14 @@ type RecognizeUtteranceCommandInputType = Omit<RecognizeUtteranceRequest, "input
|
|
|
19
21
|
export interface RecognizeUtteranceCommandInput extends RecognizeUtteranceCommandInputType {
|
|
20
22
|
}
|
|
21
23
|
/**
|
|
24
|
+
* @public
|
|
25
|
+
*
|
|
22
26
|
* The output of {@link RecognizeUtteranceCommand}.
|
|
23
27
|
*/
|
|
24
28
|
export interface RecognizeUtteranceCommandOutput extends __WithSdkStreamMixin<RecognizeUtteranceResponse, "audioStream">, __MetadataBearer {
|
|
25
29
|
}
|
|
26
30
|
/**
|
|
31
|
+
* @public
|
|
27
32
|
* <p>Sends user input to Amazon Lex V2. You can send text or speech. Clients use
|
|
28
33
|
* this API to send text and audio requests to Amazon Lex V2 at runtime. Amazon Lex V2
|
|
29
34
|
* interprets the user input using the machine learning model built for
|
|
@@ -97,6 +102,8 @@ export interface RecognizeUtteranceCommandOutput extends __WithSdkStreamMixin<Re
|
|
|
97
102
|
* const response = await client.send(command);
|
|
98
103
|
* ```
|
|
99
104
|
*
|
|
105
|
+
* @param RecognizeUtteranceCommandInput - {@link RecognizeUtteranceCommandInput}
|
|
106
|
+
* @returns {@link RecognizeUtteranceCommandOutput}
|
|
100
107
|
* @see {@link RecognizeUtteranceCommandInput} for command's `input` shape.
|
|
101
108
|
* @see {@link RecognizeUtteranceCommandOutput} for command's `response` shape.
|
|
102
109
|
* @see {@link LexRuntimeV2ClientResolvedConfig | config} for LexRuntimeV2Client's `config` shape.
|
|
@@ -130,12 +137,20 @@ export interface RecognizeUtteranceCommandOutput extends __WithSdkStreamMixin<Re
|
|
|
130
137
|
export declare class RecognizeUtteranceCommand extends $Command<RecognizeUtteranceCommandInput, RecognizeUtteranceCommandOutput, LexRuntimeV2ClientResolvedConfig> {
|
|
131
138
|
readonly input: RecognizeUtteranceCommandInput;
|
|
132
139
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
140
|
+
/**
|
|
141
|
+
* @public
|
|
142
|
+
*/
|
|
133
143
|
constructor(input: RecognizeUtteranceCommandInput);
|
|
134
144
|
/**
|
|
135
145
|
* @internal
|
|
136
146
|
*/
|
|
137
147
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LexRuntimeV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RecognizeUtteranceCommandInput, RecognizeUtteranceCommandOutput>;
|
|
148
|
+
/**
|
|
149
|
+
* @internal
|
|
150
|
+
*/
|
|
138
151
|
private serialize;
|
|
152
|
+
/**
|
|
153
|
+
* @internal
|
|
154
|
+
*/
|
|
139
155
|
private deserialize;
|
|
140
156
|
}
|
|
141
|
-
export {};
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { LexRuntimeV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LexRuntimeV2Client";
|
|
5
5
|
import { StartConversationRequest, StartConversationResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link StartConversationCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface StartConversationCommandInput extends StartConversationRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link StartConversationCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface StartConversationCommandOutput extends StartConversationResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Starts an HTTP/2 bidirectional event stream that enables you to send
|
|
18
23
|
* audio, text, or DTMF input in real time. After your application starts
|
|
19
24
|
* a conversation, users send input to Amazon Lex V2 as a stream of events. Amazon Lex V2
|
|
@@ -84,6 +89,8 @@ export interface StartConversationCommandOutput extends StartConversationRespons
|
|
|
84
89
|
* const response = await client.send(command);
|
|
85
90
|
* ```
|
|
86
91
|
*
|
|
92
|
+
* @param StartConversationCommandInput - {@link StartConversationCommandInput}
|
|
93
|
+
* @returns {@link StartConversationCommandOutput}
|
|
87
94
|
* @see {@link StartConversationCommandInput} for command's `input` shape.
|
|
88
95
|
* @see {@link StartConversationCommandOutput} for command's `response` shape.
|
|
89
96
|
* @see {@link LexRuntimeV2ClientResolvedConfig | config} for LexRuntimeV2Client's `config` shape.
|
|
@@ -105,11 +112,20 @@ export interface StartConversationCommandOutput extends StartConversationRespons
|
|
|
105
112
|
export declare class StartConversationCommand extends $Command<StartConversationCommandInput, StartConversationCommandOutput, LexRuntimeV2ClientResolvedConfig> {
|
|
106
113
|
readonly input: StartConversationCommandInput;
|
|
107
114
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
115
|
+
/**
|
|
116
|
+
* @public
|
|
117
|
+
*/
|
|
108
118
|
constructor(input: StartConversationCommandInput);
|
|
109
119
|
/**
|
|
110
120
|
* @internal
|
|
111
121
|
*/
|
|
112
122
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: LexRuntimeV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartConversationCommandInput, StartConversationCommandOutput>;
|
|
123
|
+
/**
|
|
124
|
+
* @internal
|
|
125
|
+
*/
|
|
113
126
|
private serialize;
|
|
127
|
+
/**
|
|
128
|
+
* @internal
|
|
129
|
+
*/
|
|
114
130
|
private deserialize;
|
|
115
131
|
}
|
|
@@ -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 LexRuntimeV2 service.
|
|
4
6
|
*/
|
|
5
7
|
export declare class LexRuntimeV2ServiceException extends __ServiceException {
|
|
@@ -3,6 +3,7 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-cl
|
|
|
3
3
|
import { Readable } from "stream";
|
|
4
4
|
import { LexRuntimeV2ServiceException as __BaseException } from "./LexRuntimeV2ServiceException";
|
|
5
5
|
/**
|
|
6
|
+
* @public
|
|
6
7
|
* <p></p>
|
|
7
8
|
*/
|
|
8
9
|
export declare class AccessDeniedException extends __BaseException {
|
|
@@ -14,6 +15,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
14
15
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
15
16
|
}
|
|
16
17
|
/**
|
|
18
|
+
* @public
|
|
17
19
|
* <p>The time that a context is active. You can specify the time to live
|
|
18
20
|
* in seconds or in conversation turns.</p>
|
|
19
21
|
*/
|
|
@@ -30,6 +32,7 @@ export interface ActiveContextTimeToLive {
|
|
|
30
32
|
turnsToLive: number | undefined;
|
|
31
33
|
}
|
|
32
34
|
/**
|
|
35
|
+
* @public
|
|
33
36
|
* <p>Contains information about the contexts that a user is using in a
|
|
34
37
|
* session. You can configure Amazon Lex V2 to set a context when an intent is
|
|
35
38
|
* fulfilled, or you can set a context using the , , or operations.</p>
|
|
@@ -61,6 +64,7 @@ export interface ActiveContext {
|
|
|
61
64
|
contextAttributes: Record<string, string> | undefined;
|
|
62
65
|
}
|
|
63
66
|
/**
|
|
67
|
+
* @public
|
|
64
68
|
* <p>Represents a chunk of audio sent from the client application to
|
|
65
69
|
* Amazon Lex V2. The audio is all or part of an utterance from the user.</p>
|
|
66
70
|
* <p>Amazon Lex V2 accumulates audio chunks until it recognizes a natural pause
|
|
@@ -93,6 +97,7 @@ export interface AudioInputEvent {
|
|
|
93
97
|
clientTimestampMillis?: number;
|
|
94
98
|
}
|
|
95
99
|
/**
|
|
100
|
+
* @public
|
|
96
101
|
* <p>An event sent from Amazon Lex V2 to your client application containing audio
|
|
97
102
|
* to play to the user. </p>
|
|
98
103
|
*/
|
|
@@ -116,6 +121,7 @@ export interface AudioResponseEvent {
|
|
|
116
121
|
eventId?: string;
|
|
117
122
|
}
|
|
118
123
|
/**
|
|
124
|
+
* @public
|
|
119
125
|
* <p></p>
|
|
120
126
|
*/
|
|
121
127
|
export declare class ConflictException extends __BaseException {
|
|
@@ -126,6 +132,9 @@ export declare class ConflictException extends __BaseException {
|
|
|
126
132
|
*/
|
|
127
133
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
128
134
|
}
|
|
135
|
+
/**
|
|
136
|
+
* @public
|
|
137
|
+
*/
|
|
129
138
|
export interface DeleteSessionRequest {
|
|
130
139
|
/**
|
|
131
140
|
* <p>The identifier of the bot that contains the session data.</p>
|
|
@@ -145,6 +154,9 @@ export interface DeleteSessionRequest {
|
|
|
145
154
|
*/
|
|
146
155
|
sessionId: string | undefined;
|
|
147
156
|
}
|
|
157
|
+
/**
|
|
158
|
+
* @public
|
|
159
|
+
*/
|
|
148
160
|
export interface DeleteSessionResponse {
|
|
149
161
|
/**
|
|
150
162
|
* <p>The identifier of the bot that contained the session data.</p>
|
|
@@ -165,6 +177,7 @@ export interface DeleteSessionResponse {
|
|
|
165
177
|
sessionId?: string;
|
|
166
178
|
}
|
|
167
179
|
/**
|
|
180
|
+
* @public
|
|
168
181
|
* <p></p>
|
|
169
182
|
*/
|
|
170
183
|
export declare class InternalServerException extends __BaseException {
|
|
@@ -176,6 +189,7 @@ export declare class InternalServerException extends __BaseException {
|
|
|
176
189
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
177
190
|
}
|
|
178
191
|
/**
|
|
192
|
+
* @public
|
|
179
193
|
* <p></p>
|
|
180
194
|
*/
|
|
181
195
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
@@ -187,6 +201,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
187
201
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
188
202
|
}
|
|
189
203
|
/**
|
|
204
|
+
* @public
|
|
190
205
|
* <p></p>
|
|
191
206
|
*/
|
|
192
207
|
export declare class ThrottlingException extends __BaseException {
|
|
@@ -198,6 +213,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
198
213
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
199
214
|
}
|
|
200
215
|
/**
|
|
216
|
+
* @public
|
|
201
217
|
* <p></p>
|
|
202
218
|
*/
|
|
203
219
|
export declare class ValidationException extends __BaseException {
|
|
@@ -208,6 +224,9 @@ export declare class ValidationException extends __BaseException {
|
|
|
208
224
|
*/
|
|
209
225
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
210
226
|
}
|
|
227
|
+
/**
|
|
228
|
+
* @public
|
|
229
|
+
*/
|
|
211
230
|
export interface GetSessionRequest {
|
|
212
231
|
/**
|
|
213
232
|
* <p>The identifier of the bot that contains the session data.</p>
|
|
@@ -227,17 +246,24 @@ export interface GetSessionRequest {
|
|
|
227
246
|
*/
|
|
228
247
|
sessionId: string | undefined;
|
|
229
248
|
}
|
|
249
|
+
/**
|
|
250
|
+
* @public
|
|
251
|
+
*/
|
|
230
252
|
export declare enum ConfirmationState {
|
|
231
253
|
CONFIRMED = "Confirmed",
|
|
232
254
|
DENIED = "Denied",
|
|
233
255
|
NONE = "None"
|
|
234
256
|
}
|
|
257
|
+
/**
|
|
258
|
+
* @public
|
|
259
|
+
*/
|
|
235
260
|
export declare enum Shape {
|
|
236
261
|
COMPOSITE = "Composite",
|
|
237
262
|
LIST = "List",
|
|
238
263
|
SCALAR = "Scalar"
|
|
239
264
|
}
|
|
240
265
|
/**
|
|
266
|
+
* @public
|
|
241
267
|
* <p>The value of a slot.</p>
|
|
242
268
|
*/
|
|
243
269
|
export interface Value {
|
|
@@ -259,6 +285,9 @@ export interface Value {
|
|
|
259
285
|
*/
|
|
260
286
|
resolvedValues?: string[];
|
|
261
287
|
}
|
|
288
|
+
/**
|
|
289
|
+
* @public
|
|
290
|
+
*/
|
|
262
291
|
export declare enum IntentState {
|
|
263
292
|
FAILED = "Failed",
|
|
264
293
|
FULFILLED = "Fulfilled",
|
|
@@ -268,6 +297,7 @@ export declare enum IntentState {
|
|
|
268
297
|
WAITING = "Waiting"
|
|
269
298
|
}
|
|
270
299
|
/**
|
|
300
|
+
* @public
|
|
271
301
|
* <p>Provides a score that indicates the confidence that Amazon Lex V2 has that
|
|
272
302
|
* an intent is the one that satisfies the user's intent.</p>
|
|
273
303
|
*/
|
|
@@ -279,6 +309,9 @@ export interface ConfidenceScore {
|
|
|
279
309
|
*/
|
|
280
310
|
score?: number;
|
|
281
311
|
}
|
|
312
|
+
/**
|
|
313
|
+
* @public
|
|
314
|
+
*/
|
|
282
315
|
export declare enum SentimentType {
|
|
283
316
|
MIXED = "MIXED",
|
|
284
317
|
NEGATIVE = "NEGATIVE",
|
|
@@ -286,6 +319,7 @@ export declare enum SentimentType {
|
|
|
286
319
|
POSITIVE = "POSITIVE"
|
|
287
320
|
}
|
|
288
321
|
/**
|
|
322
|
+
* @public
|
|
289
323
|
* <p>The individual sentiment responses for the utterance.</p>
|
|
290
324
|
*/
|
|
291
325
|
export interface SentimentScore {
|
|
@@ -311,6 +345,7 @@ export interface SentimentScore {
|
|
|
311
345
|
mixed?: number;
|
|
312
346
|
}
|
|
313
347
|
/**
|
|
348
|
+
* @public
|
|
314
349
|
* <p>Provides information about the sentiment expressed in a user's
|
|
315
350
|
* response in a conversation. Sentiments are determined using Amazon
|
|
316
351
|
* Comprehend. Sentiments are only returned if they are enabled for the
|
|
@@ -331,6 +366,9 @@ export interface SentimentResponse {
|
|
|
331
366
|
*/
|
|
332
367
|
sentimentScore?: SentimentScore;
|
|
333
368
|
}
|
|
369
|
+
/**
|
|
370
|
+
* @public
|
|
371
|
+
*/
|
|
334
372
|
export declare enum MessageContentType {
|
|
335
373
|
CUSTOM_PAYLOAD = "CustomPayload",
|
|
336
374
|
IMAGE_RESPONSE_CARD = "ImageResponseCard",
|
|
@@ -338,6 +376,7 @@ export declare enum MessageContentType {
|
|
|
338
376
|
SSML = "SSML"
|
|
339
377
|
}
|
|
340
378
|
/**
|
|
379
|
+
* @public
|
|
341
380
|
* <p>A button that appears on a response card show to the user.</p>
|
|
342
381
|
*/
|
|
343
382
|
export interface Button {
|
|
@@ -351,6 +390,7 @@ export interface Button {
|
|
|
351
390
|
value: string | undefined;
|
|
352
391
|
}
|
|
353
392
|
/**
|
|
393
|
+
* @public
|
|
354
394
|
* <p>A card that is shown to the user by a messaging platform. You define
|
|
355
395
|
* the contents of the card, the card is displayed by the platform. </p>
|
|
356
396
|
* <p>When you use a response card, the response from the user is
|
|
@@ -382,6 +422,7 @@ export interface ImageResponseCard {
|
|
|
382
422
|
buttons?: Button[];
|
|
383
423
|
}
|
|
384
424
|
/**
|
|
425
|
+
* @public
|
|
385
426
|
* <p>Container for text that is returned to the customer..</p>
|
|
386
427
|
*/
|
|
387
428
|
export interface Message {
|
|
@@ -401,11 +442,17 @@ export interface Message {
|
|
|
401
442
|
*/
|
|
402
443
|
imageResponseCard?: ImageResponseCard;
|
|
403
444
|
}
|
|
445
|
+
/**
|
|
446
|
+
* @public
|
|
447
|
+
*/
|
|
404
448
|
export declare enum StyleType {
|
|
405
449
|
DEFAULT = "Default",
|
|
406
450
|
SPELL_BY_LETTER = "SpellByLetter",
|
|
407
451
|
SPELL_BY_WORD = "SpellByWord"
|
|
408
452
|
}
|
|
453
|
+
/**
|
|
454
|
+
* @public
|
|
455
|
+
*/
|
|
409
456
|
export declare enum DialogActionType {
|
|
410
457
|
CLOSE = "Close",
|
|
411
458
|
CONFIRM_INTENT = "ConfirmIntent",
|
|
@@ -415,6 +462,7 @@ export declare enum DialogActionType {
|
|
|
415
462
|
NONE = "None"
|
|
416
463
|
}
|
|
417
464
|
/**
|
|
465
|
+
* @public
|
|
418
466
|
* <p>Provides the phrase that Amazon Lex V2 should look for in the user's input
|
|
419
467
|
* to the bot.</p>
|
|
420
468
|
*/
|
|
@@ -426,6 +474,7 @@ export interface RuntimeHintValue {
|
|
|
426
474
|
phrase: string | undefined;
|
|
427
475
|
}
|
|
428
476
|
/**
|
|
477
|
+
* @public
|
|
429
478
|
* <p></p>
|
|
430
479
|
*/
|
|
431
480
|
export declare class BadGatewayException extends __BaseException {
|
|
@@ -437,6 +486,7 @@ export declare class BadGatewayException extends __BaseException {
|
|
|
437
486
|
constructor(opts: __ExceptionOptionType<BadGatewayException, __BaseException>);
|
|
438
487
|
}
|
|
439
488
|
/**
|
|
489
|
+
* @public
|
|
440
490
|
* <p></p>
|
|
441
491
|
*/
|
|
442
492
|
export declare class DependencyFailedException extends __BaseException {
|
|
@@ -447,6 +497,9 @@ export declare class DependencyFailedException extends __BaseException {
|
|
|
447
497
|
*/
|
|
448
498
|
constructor(opts: __ExceptionOptionType<DependencyFailedException, __BaseException>);
|
|
449
499
|
}
|
|
500
|
+
/**
|
|
501
|
+
* @public
|
|
502
|
+
*/
|
|
450
503
|
export interface PutSessionResponse {
|
|
451
504
|
/**
|
|
452
505
|
* <p>The type of response. Same as the type specified in the
|
|
@@ -483,6 +536,7 @@ export interface PutSessionResponse {
|
|
|
483
536
|
audioStream?: Readable | ReadableStream | Blob;
|
|
484
537
|
}
|
|
485
538
|
/**
|
|
539
|
+
* @public
|
|
486
540
|
* <p>The bot member that processes the request.</p>
|
|
487
541
|
*/
|
|
488
542
|
export interface RecognizedBotMember {
|
|
@@ -495,6 +549,9 @@ export interface RecognizedBotMember {
|
|
|
495
549
|
*/
|
|
496
550
|
botName?: string;
|
|
497
551
|
}
|
|
552
|
+
/**
|
|
553
|
+
* @public
|
|
554
|
+
*/
|
|
498
555
|
export interface RecognizeUtteranceRequest {
|
|
499
556
|
/**
|
|
500
557
|
* <p>The identifier of the bot that should receive the request.</p>
|
|
@@ -621,6 +678,9 @@ export interface RecognizeUtteranceRequest {
|
|
|
621
678
|
*/
|
|
622
679
|
inputStream?: Readable | ReadableStream | Blob;
|
|
623
680
|
}
|
|
681
|
+
/**
|
|
682
|
+
* @public
|
|
683
|
+
*/
|
|
624
684
|
export interface RecognizeUtteranceResponse {
|
|
625
685
|
/**
|
|
626
686
|
* <p>Indicates whether the input mode to the operation was text or
|
|
@@ -709,11 +769,15 @@ export interface RecognizeUtteranceResponse {
|
|
|
709
769
|
*/
|
|
710
770
|
recognizedBotMember?: string;
|
|
711
771
|
}
|
|
772
|
+
/**
|
|
773
|
+
* @public
|
|
774
|
+
*/
|
|
712
775
|
export declare enum ConversationMode {
|
|
713
776
|
AUDIO = "AUDIO",
|
|
714
777
|
TEXT = "TEXT"
|
|
715
778
|
}
|
|
716
779
|
/**
|
|
780
|
+
* @public
|
|
717
781
|
* <p>A notification from the client that it is disconnecting from Amazon Lex V2.
|
|
718
782
|
* Sending a <code>DisconnectionEvent</code> event is optional, but can
|
|
719
783
|
* help identify a conversation in logs.</p>
|
|
@@ -731,6 +795,7 @@ export interface DisconnectionEvent {
|
|
|
731
795
|
clientTimestampMillis?: number;
|
|
732
796
|
}
|
|
733
797
|
/**
|
|
798
|
+
* @public
|
|
734
799
|
* <p>A DTMF character sent from the client application. DTMF characters
|
|
735
800
|
* are typically sent from a phone keypad to represent numbers. For
|
|
736
801
|
* example, you can have Amazon Lex V2 process a credit card number input from a
|
|
@@ -754,6 +819,7 @@ export interface DTMFInputEvent {
|
|
|
754
819
|
clientTimestampMillis?: number;
|
|
755
820
|
}
|
|
756
821
|
/**
|
|
822
|
+
* @public
|
|
757
823
|
* <p>Event sent from the client application to Amazon Lex V2 to indicate that
|
|
758
824
|
* playback of audio is complete and that Amazon Lex V2 should start processing
|
|
759
825
|
* the user's input.</p>
|
|
@@ -771,6 +837,7 @@ export interface PlaybackCompletionEvent {
|
|
|
771
837
|
clientTimestampMillis?: number;
|
|
772
838
|
}
|
|
773
839
|
/**
|
|
840
|
+
* @public
|
|
774
841
|
* <p>The event sent from your client application to Amazon Lex V2 with text input
|
|
775
842
|
* from the user.</p>
|
|
776
843
|
*/
|
|
@@ -792,6 +859,7 @@ export interface TextInputEvent {
|
|
|
792
859
|
clientTimestampMillis?: number;
|
|
793
860
|
}
|
|
794
861
|
/**
|
|
862
|
+
* @public
|
|
795
863
|
* <p>Event that Amazon Lex V2 sends to indicate that the stream is still open
|
|
796
864
|
* between the client application and Amazon Lex V2 </p>
|
|
797
865
|
*/
|
|
@@ -804,17 +872,24 @@ export interface HeartbeatEvent {
|
|
|
804
872
|
*/
|
|
805
873
|
eventId?: string;
|
|
806
874
|
}
|
|
875
|
+
/**
|
|
876
|
+
* @public
|
|
877
|
+
*/
|
|
807
878
|
export declare enum InputMode {
|
|
808
879
|
DTMF = "DTMF",
|
|
809
880
|
SPEECH = "Speech",
|
|
810
881
|
TEXT = "Text"
|
|
811
882
|
}
|
|
883
|
+
/**
|
|
884
|
+
* @public
|
|
885
|
+
*/
|
|
812
886
|
export declare enum PlaybackInterruptionReason {
|
|
813
887
|
DTMF_START_DETECTED = "DTMF_START_DETECTED",
|
|
814
888
|
TEXT_DETECTED = "TEXT_DETECTED",
|
|
815
889
|
VOICE_START_DETECTED = "VOICE_START_DETECTED"
|
|
816
890
|
}
|
|
817
891
|
/**
|
|
892
|
+
* @public
|
|
818
893
|
* <p>Event sent from Amazon Lex V2 to indicate to the client application should
|
|
819
894
|
* stop playback of audio. For example, if the client is playing a prompt
|
|
820
895
|
* that asks for the user's telephone number, the user might start to say
|
|
@@ -841,6 +916,7 @@ export interface PlaybackInterruptionEvent {
|
|
|
841
916
|
eventId?: string;
|
|
842
917
|
}
|
|
843
918
|
/**
|
|
919
|
+
* @public
|
|
844
920
|
* <p>The event sent from Amazon Lex V2 to your application with text to present
|
|
845
921
|
* to the user.</p>
|
|
846
922
|
*/
|
|
@@ -860,6 +936,7 @@ export interface TextResponseEvent {
|
|
|
860
936
|
eventId?: string;
|
|
861
937
|
}
|
|
862
938
|
/**
|
|
939
|
+
* @public
|
|
863
940
|
* <p>Event sent from Amazon Lex V2 to your client application that contains a
|
|
864
941
|
* transcript of voice audio. </p>
|
|
865
942
|
*/
|
|
@@ -877,6 +954,7 @@ export interface TranscriptEvent {
|
|
|
877
954
|
eventId?: string;
|
|
878
955
|
}
|
|
879
956
|
/**
|
|
957
|
+
* @public
|
|
880
958
|
* <p>The specific constituent sub slot of the composite slot to elicit in dialog action.</p>
|
|
881
959
|
*/
|
|
882
960
|
export interface ElicitSubSlot {
|
|
@@ -890,6 +968,7 @@ export interface ElicitSubSlot {
|
|
|
890
968
|
subSlotToElicit?: ElicitSubSlot;
|
|
891
969
|
}
|
|
892
970
|
/**
|
|
971
|
+
* @public
|
|
893
972
|
* <p>The next action that Amazon Lex V2 should take.</p>
|
|
894
973
|
*/
|
|
895
974
|
export interface DialogAction {
|
|
@@ -955,6 +1034,7 @@ export interface DialogAction {
|
|
|
955
1034
|
subSlotToElicit?: ElicitSubSlot;
|
|
956
1035
|
}
|
|
957
1036
|
/**
|
|
1037
|
+
* @public
|
|
958
1038
|
* <p>Provides an array of phrases that should be given preference when
|
|
959
1039
|
* resolving values for a slot.</p>
|
|
960
1040
|
*/
|
|
@@ -974,6 +1054,7 @@ export interface RuntimeHintDetails {
|
|
|
974
1054
|
subSlotHints?: Record<string, RuntimeHintDetails>;
|
|
975
1055
|
}
|
|
976
1056
|
/**
|
|
1057
|
+
* @public
|
|
977
1058
|
* <p>You can provide Amazon Lex V2 with hints to the phrases that a customer is
|
|
978
1059
|
* likely to use for a slot. When a slot with hints is resolved, the
|
|
979
1060
|
* phrases in the runtime hints are preferred in the resolution. You can
|
|
@@ -997,6 +1078,7 @@ export interface RuntimeHints {
|
|
|
997
1078
|
slotHints?: Record<string, Record<string, RuntimeHintDetails>>;
|
|
998
1079
|
}
|
|
999
1080
|
/**
|
|
1081
|
+
* @public
|
|
1000
1082
|
* <p>A value that Amazon Lex V2 uses to fulfill an intent. </p>
|
|
1001
1083
|
*/
|
|
1002
1084
|
export interface Slot {
|
|
@@ -1023,6 +1105,7 @@ export interface Slot {
|
|
|
1023
1105
|
subSlots?: Record<string, Slot>;
|
|
1024
1106
|
}
|
|
1025
1107
|
/**
|
|
1108
|
+
* @public
|
|
1026
1109
|
* <p>The current intent that Amazon Lex V2 is attempting to fulfill.</p>
|
|
1027
1110
|
*/
|
|
1028
1111
|
export interface Intent {
|
|
@@ -1047,6 +1130,7 @@ export interface Intent {
|
|
|
1047
1130
|
confirmationState?: ConfirmationState | string;
|
|
1048
1131
|
}
|
|
1049
1132
|
/**
|
|
1133
|
+
* @public
|
|
1050
1134
|
* <p>An intent that Amazon Lex V2 determined might satisfy the user's utterance.
|
|
1051
1135
|
* The intents are ordered by the confidence score. </p>
|
|
1052
1136
|
*/
|
|
@@ -1074,6 +1158,7 @@ export interface Interpretation {
|
|
|
1074
1158
|
intent?: Intent;
|
|
1075
1159
|
}
|
|
1076
1160
|
/**
|
|
1161
|
+
* @public
|
|
1077
1162
|
* <p>The state of the user's session with Amazon Lex V2.</p>
|
|
1078
1163
|
*/
|
|
1079
1164
|
export interface SessionState {
|
|
@@ -1109,6 +1194,7 @@ export interface SessionState {
|
|
|
1109
1194
|
runtimeHints?: RuntimeHints;
|
|
1110
1195
|
}
|
|
1111
1196
|
/**
|
|
1197
|
+
* @public
|
|
1112
1198
|
* <p>The initial event sent from the application to Amazon Lex V2 to configure
|
|
1113
1199
|
* the conversation, including session and request attributes and the
|
|
1114
1200
|
* response content type.</p>
|
|
@@ -1201,6 +1287,9 @@ export interface ConfigurationEvent {
|
|
|
1201
1287
|
*/
|
|
1202
1288
|
clientTimestampMillis?: number;
|
|
1203
1289
|
}
|
|
1290
|
+
/**
|
|
1291
|
+
* @public
|
|
1292
|
+
*/
|
|
1204
1293
|
export interface PutSessionRequest {
|
|
1205
1294
|
/**
|
|
1206
1295
|
* <p>The identifier of the bot that receives the session data.</p>
|
|
@@ -1251,6 +1340,9 @@ export interface PutSessionRequest {
|
|
|
1251
1340
|
*/
|
|
1252
1341
|
responseContentType?: string;
|
|
1253
1342
|
}
|
|
1343
|
+
/**
|
|
1344
|
+
* @public
|
|
1345
|
+
*/
|
|
1254
1346
|
export interface RecognizeTextRequest {
|
|
1255
1347
|
/**
|
|
1256
1348
|
* <p>The identifier of the bot that processes the request.</p>
|
|
@@ -1288,10 +1380,14 @@ export interface RecognizeTextRequest {
|
|
|
1288
1380
|
requestAttributes?: Record<string, string>;
|
|
1289
1381
|
}
|
|
1290
1382
|
/**
|
|
1383
|
+
* @public
|
|
1291
1384
|
* <p>Represents a stream of events between your application and
|
|
1292
1385
|
* Amazon Lex V2.</p>
|
|
1293
1386
|
*/
|
|
1294
1387
|
export type StartConversationRequestEventStream = StartConversationRequestEventStream.AudioInputEventMember | StartConversationRequestEventStream.ConfigurationEventMember | StartConversationRequestEventStream.DTMFInputEventMember | StartConversationRequestEventStream.DisconnectionEventMember | StartConversationRequestEventStream.PlaybackCompletionEventMember | StartConversationRequestEventStream.TextInputEventMember | StartConversationRequestEventStream.$UnknownMember;
|
|
1388
|
+
/**
|
|
1389
|
+
* @public
|
|
1390
|
+
*/
|
|
1295
1391
|
export declare namespace StartConversationRequestEventStream {
|
|
1296
1392
|
/**
|
|
1297
1393
|
* <p>Configuration information sent from your client application to
|
|
@@ -1408,6 +1504,9 @@ export declare namespace StartConversationRequestEventStream {
|
|
|
1408
1504
|
}
|
|
1409
1505
|
const visit: <T>(value: StartConversationRequestEventStream, visitor: Visitor<T>) => T;
|
|
1410
1506
|
}
|
|
1507
|
+
/**
|
|
1508
|
+
* @public
|
|
1509
|
+
*/
|
|
1411
1510
|
export interface StartConversationRequest {
|
|
1412
1511
|
/**
|
|
1413
1512
|
* <p>The identifier of the bot to process the request.</p>
|
|
@@ -1440,6 +1539,9 @@ export interface StartConversationRequest {
|
|
|
1440
1539
|
*/
|
|
1441
1540
|
requestEventStream: AsyncIterable<StartConversationRequestEventStream> | undefined;
|
|
1442
1541
|
}
|
|
1542
|
+
/**
|
|
1543
|
+
* @public
|
|
1544
|
+
*/
|
|
1443
1545
|
export interface GetSessionResponse {
|
|
1444
1546
|
/**
|
|
1445
1547
|
* <p>The identifier of the returned session.</p>
|
|
@@ -1470,6 +1572,7 @@ export interface GetSessionResponse {
|
|
|
1470
1572
|
sessionState?: SessionState;
|
|
1471
1573
|
}
|
|
1472
1574
|
/**
|
|
1575
|
+
* @public
|
|
1473
1576
|
* <p>Contains the current state of the conversation between the client
|
|
1474
1577
|
* application and Amazon Lex V2.</p>
|
|
1475
1578
|
*/
|
|
@@ -1512,6 +1615,9 @@ export interface IntentResultEvent {
|
|
|
1512
1615
|
*/
|
|
1513
1616
|
recognizedBotMember?: RecognizedBotMember;
|
|
1514
1617
|
}
|
|
1618
|
+
/**
|
|
1619
|
+
* @public
|
|
1620
|
+
*/
|
|
1515
1621
|
export interface RecognizeTextResponse {
|
|
1516
1622
|
/**
|
|
1517
1623
|
* <p>A list of messages last sent to the user. The messages are ordered
|
|
@@ -1549,10 +1655,14 @@ export interface RecognizeTextResponse {
|
|
|
1549
1655
|
recognizedBotMember?: RecognizedBotMember;
|
|
1550
1656
|
}
|
|
1551
1657
|
/**
|
|
1658
|
+
* @public
|
|
1552
1659
|
* <p>Represents a stream of events between Amazon Lex V2 and your
|
|
1553
1660
|
* application.</p>
|
|
1554
1661
|
*/
|
|
1555
1662
|
export type StartConversationResponseEventStream = StartConversationResponseEventStream.AccessDeniedExceptionMember | StartConversationResponseEventStream.AudioResponseEventMember | StartConversationResponseEventStream.BadGatewayExceptionMember | StartConversationResponseEventStream.ConflictExceptionMember | StartConversationResponseEventStream.DependencyFailedExceptionMember | StartConversationResponseEventStream.HeartbeatEventMember | StartConversationResponseEventStream.IntentResultEventMember | StartConversationResponseEventStream.InternalServerExceptionMember | StartConversationResponseEventStream.PlaybackInterruptionEventMember | StartConversationResponseEventStream.ResourceNotFoundExceptionMember | StartConversationResponseEventStream.TextResponseEventMember | StartConversationResponseEventStream.ThrottlingExceptionMember | StartConversationResponseEventStream.TranscriptEventMember | StartConversationResponseEventStream.ValidationExceptionMember | StartConversationResponseEventStream.$UnknownMember;
|
|
1663
|
+
/**
|
|
1664
|
+
* @public
|
|
1665
|
+
*/
|
|
1556
1666
|
export declare namespace StartConversationResponseEventStream {
|
|
1557
1667
|
/**
|
|
1558
1668
|
* <p>Event sent from Amazon Lex V2 to indicate to the client application should
|
|
@@ -1889,6 +1999,9 @@ export declare namespace StartConversationResponseEventStream {
|
|
|
1889
1999
|
}
|
|
1890
2000
|
const visit: <T>(value: StartConversationResponseEventStream, visitor: Visitor<T>) => T;
|
|
1891
2001
|
}
|
|
2002
|
+
/**
|
|
2003
|
+
* @public
|
|
2004
|
+
*/
|
|
1892
2005
|
export interface StartConversationResponse {
|
|
1893
2006
|
/**
|
|
1894
2007
|
* <p>Represents the stream of events from Amazon Lex V2 to your application. The
|
|
@@ -16,7 +16,7 @@ import {
|
|
|
16
16
|
RecognizeUtteranceRequest,
|
|
17
17
|
RecognizeUtteranceResponse,
|
|
18
18
|
} from "../models/models_0";
|
|
19
|
-
type RecognizeUtteranceCommandInputType = Pick<
|
|
19
|
+
export type RecognizeUtteranceCommandInputType = Pick<
|
|
20
20
|
RecognizeUtteranceRequest,
|
|
21
21
|
Exclude<keyof RecognizeUtteranceRequest, "inputStream">
|
|
22
22
|
> & {
|
|
@@ -47,4 +47,3 @@ export declare class RecognizeUtteranceCommand extends $Command<
|
|
|
47
47
|
private serialize;
|
|
48
48
|
private deserialize;
|
|
49
49
|
}
|
|
50
|
-
export {};
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-lex-runtime-v2",
|
|
3
3
|
"description": "AWS SDK for JavaScript Lex Runtime V2 Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
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",
|
|
@@ -20,9 +20,9 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
23
|
-
"@aws-sdk/client-sts": "3.
|
|
23
|
+
"@aws-sdk/client-sts": "3.297.0",
|
|
24
24
|
"@aws-sdk/config-resolver": "3.296.0",
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.297.0",
|
|
26
26
|
"@aws-sdk/eventstream-handler-node": "3.296.0",
|
|
27
27
|
"@aws-sdk/eventstream-serde-browser": "3.296.0",
|
|
28
28
|
"@aws-sdk/eventstream-serde-config-resolver": "3.296.0",
|