@aws-sdk/client-lex-runtime-v2 3.296.0 → 3.298.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,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 {