UNPKG

11.4 kBJSONView Raw
1{
2 "version": "2.0",
3 "metadata": {
4 "apiVersion": "2016-11-28",
5 "endpointPrefix": "runtime.lex",
6 "jsonVersion": "1.1",
7 "protocol": "rest-json",
8 "serviceFullName": "Amazon Lex Runtime Service",
9 "serviceId": "Lex Runtime Service",
10 "signatureVersion": "v4",
11 "signingName": "lex",
12 "uid": "runtime.lex-2016-11-28"
13 },
14 "operations": {
15 "DeleteSession": {
16 "http": {
17 "method": "DELETE",
18 "requestUri": "/bot/{botName}/alias/{botAlias}/user/{userId}/session"
19 },
20 "input": {
21 "type": "structure",
22 "required": [
23 "botName",
24 "botAlias",
25 "userId"
26 ],
27 "members": {
28 "botName": {
29 "location": "uri",
30 "locationName": "botName"
31 },
32 "botAlias": {
33 "location": "uri",
34 "locationName": "botAlias"
35 },
36 "userId": {
37 "location": "uri",
38 "locationName": "userId"
39 }
40 }
41 },
42 "output": {
43 "type": "structure",
44 "members": {
45 "botName": {},
46 "botAlias": {},
47 "userId": {},
48 "sessionId": {}
49 }
50 }
51 },
52 "GetSession": {
53 "http": {
54 "method": "GET",
55 "requestUri": "/bot/{botName}/alias/{botAlias}/user/{userId}/session/"
56 },
57 "input": {
58 "type": "structure",
59 "required": [
60 "botName",
61 "botAlias",
62 "userId"
63 ],
64 "members": {
65 "botName": {
66 "location": "uri",
67 "locationName": "botName"
68 },
69 "botAlias": {
70 "location": "uri",
71 "locationName": "botAlias"
72 },
73 "userId": {
74 "location": "uri",
75 "locationName": "userId"
76 },
77 "checkpointLabelFilter": {
78 "location": "querystring",
79 "locationName": "checkpointLabelFilter"
80 }
81 }
82 },
83 "output": {
84 "type": "structure",
85 "members": {
86 "recentIntentSummaryView": {
87 "shape": "Sa"
88 },
89 "sessionAttributes": {
90 "shape": "Sd"
91 },
92 "sessionId": {},
93 "dialogAction": {
94 "shape": "Sh"
95 }
96 }
97 }
98 },
99 "PostContent": {
100 "http": {
101 "requestUri": "/bot/{botName}/alias/{botAlias}/user/{userId}/content"
102 },
103 "input": {
104 "type": "structure",
105 "required": [
106 "botName",
107 "botAlias",
108 "userId",
109 "contentType",
110 "inputStream"
111 ],
112 "members": {
113 "botName": {
114 "location": "uri",
115 "locationName": "botName"
116 },
117 "botAlias": {
118 "location": "uri",
119 "locationName": "botAlias"
120 },
121 "userId": {
122 "location": "uri",
123 "locationName": "userId"
124 },
125 "sessionAttributes": {
126 "shape": "Sl",
127 "jsonvalue": true,
128 "location": "header",
129 "locationName": "x-amz-lex-session-attributes"
130 },
131 "requestAttributes": {
132 "shape": "Sl",
133 "jsonvalue": true,
134 "location": "header",
135 "locationName": "x-amz-lex-request-attributes"
136 },
137 "contentType": {
138 "location": "header",
139 "locationName": "Content-Type"
140 },
141 "accept": {
142 "location": "header",
143 "locationName": "Accept"
144 },
145 "inputStream": {
146 "shape": "So"
147 }
148 },
149 "payload": "inputStream"
150 },
151 "output": {
152 "type": "structure",
153 "members": {
154 "contentType": {
155 "location": "header",
156 "locationName": "Content-Type"
157 },
158 "intentName": {
159 "location": "header",
160 "locationName": "x-amz-lex-intent-name"
161 },
162 "slots": {
163 "jsonvalue": true,
164 "location": "header",
165 "locationName": "x-amz-lex-slots"
166 },
167 "sessionAttributes": {
168 "jsonvalue": true,
169 "location": "header",
170 "locationName": "x-amz-lex-session-attributes"
171 },
172 "sentimentResponse": {
173 "location": "header",
174 "locationName": "x-amz-lex-sentiment"
175 },
176 "message": {
177 "shape": "Si",
178 "location": "header",
179 "locationName": "x-amz-lex-message"
180 },
181 "messageFormat": {
182 "location": "header",
183 "locationName": "x-amz-lex-message-format"
184 },
185 "dialogState": {
186 "location": "header",
187 "locationName": "x-amz-lex-dialog-state"
188 },
189 "slotToElicit": {
190 "location": "header",
191 "locationName": "x-amz-lex-slot-to-elicit"
192 },
193 "inputTranscript": {
194 "location": "header",
195 "locationName": "x-amz-lex-input-transcript"
196 },
197 "audioStream": {
198 "shape": "So"
199 },
200 "sessionId": {
201 "location": "header",
202 "locationName": "x-amz-lex-session-id"
203 }
204 },
205 "payload": "audioStream"
206 },
207 "authtype": "v4-unsigned-body"
208 },
209 "PostText": {
210 "http": {
211 "requestUri": "/bot/{botName}/alias/{botAlias}/user/{userId}/text"
212 },
213 "input": {
214 "type": "structure",
215 "required": [
216 "botName",
217 "botAlias",
218 "userId",
219 "inputText"
220 ],
221 "members": {
222 "botName": {
223 "location": "uri",
224 "locationName": "botName"
225 },
226 "botAlias": {
227 "location": "uri",
228 "locationName": "botAlias"
229 },
230 "userId": {
231 "location": "uri",
232 "locationName": "userId"
233 },
234 "sessionAttributes": {
235 "shape": "Sd"
236 },
237 "requestAttributes": {
238 "shape": "Sd"
239 },
240 "inputText": {
241 "shape": "Si"
242 }
243 }
244 },
245 "output": {
246 "type": "structure",
247 "members": {
248 "intentName": {},
249 "slots": {
250 "shape": "Sd"
251 },
252 "sessionAttributes": {
253 "shape": "Sd"
254 },
255 "message": {
256 "shape": "Si"
257 },
258 "sentimentResponse": {
259 "type": "structure",
260 "members": {
261 "sentimentLabel": {},
262 "sentimentScore": {}
263 }
264 },
265 "messageFormat": {},
266 "dialogState": {},
267 "slotToElicit": {},
268 "responseCard": {
269 "type": "structure",
270 "members": {
271 "version": {},
272 "contentType": {},
273 "genericAttachments": {
274 "type": "list",
275 "member": {
276 "type": "structure",
277 "members": {
278 "title": {},
279 "subTitle": {},
280 "attachmentLinkUrl": {},
281 "imageUrl": {},
282 "buttons": {
283 "type": "list",
284 "member": {
285 "type": "structure",
286 "required": [
287 "text",
288 "value"
289 ],
290 "members": {
291 "text": {},
292 "value": {}
293 }
294 }
295 }
296 }
297 }
298 }
299 }
300 },
301 "sessionId": {}
302 }
303 }
304 },
305 "PutSession": {
306 "http": {
307 "requestUri": "/bot/{botName}/alias/{botAlias}/user/{userId}/session"
308 },
309 "input": {
310 "type": "structure",
311 "required": [
312 "botName",
313 "botAlias",
314 "userId"
315 ],
316 "members": {
317 "botName": {
318 "location": "uri",
319 "locationName": "botName"
320 },
321 "botAlias": {
322 "location": "uri",
323 "locationName": "botAlias"
324 },
325 "userId": {
326 "location": "uri",
327 "locationName": "userId"
328 },
329 "sessionAttributes": {
330 "shape": "Sd"
331 },
332 "dialogAction": {
333 "shape": "Sh"
334 },
335 "recentIntentSummaryView": {
336 "shape": "Sa"
337 },
338 "accept": {
339 "location": "header",
340 "locationName": "Accept"
341 }
342 }
343 },
344 "output": {
345 "type": "structure",
346 "members": {
347 "contentType": {
348 "location": "header",
349 "locationName": "Content-Type"
350 },
351 "intentName": {
352 "location": "header",
353 "locationName": "x-amz-lex-intent-name"
354 },
355 "slots": {
356 "jsonvalue": true,
357 "location": "header",
358 "locationName": "x-amz-lex-slots"
359 },
360 "sessionAttributes": {
361 "jsonvalue": true,
362 "location": "header",
363 "locationName": "x-amz-lex-session-attributes"
364 },
365 "message": {
366 "shape": "Si",
367 "location": "header",
368 "locationName": "x-amz-lex-message"
369 },
370 "messageFormat": {
371 "location": "header",
372 "locationName": "x-amz-lex-message-format"
373 },
374 "dialogState": {
375 "location": "header",
376 "locationName": "x-amz-lex-dialog-state"
377 },
378 "slotToElicit": {
379 "location": "header",
380 "locationName": "x-amz-lex-slot-to-elicit"
381 },
382 "audioStream": {
383 "shape": "So"
384 },
385 "sessionId": {
386 "location": "header",
387 "locationName": "x-amz-lex-session-id"
388 }
389 },
390 "payload": "audioStream"
391 }
392 }
393 },
394 "shapes": {
395 "Sa": {
396 "type": "list",
397 "member": {
398 "type": "structure",
399 "required": [
400 "dialogActionType"
401 ],
402 "members": {
403 "intentName": {},
404 "checkpointLabel": {},
405 "slots": {
406 "shape": "Sd"
407 },
408 "confirmationStatus": {},
409 "dialogActionType": {},
410 "fulfillmentState": {},
411 "slotToElicit": {}
412 }
413 }
414 },
415 "Sd": {
416 "type": "map",
417 "key": {},
418 "value": {},
419 "sensitive": true
420 },
421 "Sh": {
422 "type": "structure",
423 "required": [
424 "type"
425 ],
426 "members": {
427 "type": {},
428 "intentName": {},
429 "slots": {
430 "shape": "Sd"
431 },
432 "slotToElicit": {},
433 "fulfillmentState": {},
434 "message": {
435 "shape": "Si"
436 },
437 "messageFormat": {}
438 }
439 },
440 "Si": {
441 "type": "string",
442 "sensitive": true
443 },
444 "Sl": {
445 "type": "string",
446 "sensitive": true
447 },
448 "So": {
449 "type": "blob",
450 "streaming": true
451 }
452 }
453}
\No newline at end of file