runtime.lex-2016-11-28.min.json 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587
  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. "activeContexts": {
  97. "shape": "Sk"
  98. }
  99. }
  100. }
  101. },
  102. "PostContent": {
  103. "http": {
  104. "requestUri": "/bot/{botName}/alias/{botAlias}/user/{userId}/content"
  105. },
  106. "input": {
  107. "type": "structure",
  108. "required": [
  109. "botName",
  110. "botAlias",
  111. "userId",
  112. "contentType",
  113. "inputStream"
  114. ],
  115. "members": {
  116. "botName": {
  117. "location": "uri",
  118. "locationName": "botName"
  119. },
  120. "botAlias": {
  121. "location": "uri",
  122. "locationName": "botAlias"
  123. },
  124. "userId": {
  125. "location": "uri",
  126. "locationName": "userId"
  127. },
  128. "sessionAttributes": {
  129. "shape": "St",
  130. "jsonvalue": true,
  131. "location": "header",
  132. "locationName": "x-amz-lex-session-attributes"
  133. },
  134. "requestAttributes": {
  135. "shape": "St",
  136. "jsonvalue": true,
  137. "location": "header",
  138. "locationName": "x-amz-lex-request-attributes"
  139. },
  140. "contentType": {
  141. "location": "header",
  142. "locationName": "Content-Type"
  143. },
  144. "accept": {
  145. "location": "header",
  146. "locationName": "Accept"
  147. },
  148. "inputStream": {
  149. "shape": "Sw"
  150. },
  151. "activeContexts": {
  152. "shape": "Sx",
  153. "jsonvalue": true,
  154. "location": "header",
  155. "locationName": "x-amz-lex-active-contexts"
  156. }
  157. },
  158. "payload": "inputStream"
  159. },
  160. "output": {
  161. "type": "structure",
  162. "members": {
  163. "contentType": {
  164. "location": "header",
  165. "locationName": "Content-Type"
  166. },
  167. "intentName": {
  168. "location": "header",
  169. "locationName": "x-amz-lex-intent-name"
  170. },
  171. "nluIntentConfidence": {
  172. "jsonvalue": true,
  173. "location": "header",
  174. "locationName": "x-amz-lex-nlu-intent-confidence"
  175. },
  176. "alternativeIntents": {
  177. "jsonvalue": true,
  178. "location": "header",
  179. "locationName": "x-amz-lex-alternative-intents"
  180. },
  181. "slots": {
  182. "jsonvalue": true,
  183. "location": "header",
  184. "locationName": "x-amz-lex-slots"
  185. },
  186. "sessionAttributes": {
  187. "jsonvalue": true,
  188. "location": "header",
  189. "locationName": "x-amz-lex-session-attributes"
  190. },
  191. "sentimentResponse": {
  192. "location": "header",
  193. "locationName": "x-amz-lex-sentiment"
  194. },
  195. "message": {
  196. "shape": "Si",
  197. "deprecated": true,
  198. "deprecatedMessage": "The message field is deprecated, use the encodedMessage field instead. The message field is available only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR and it-IT locales.",
  199. "location": "header",
  200. "locationName": "x-amz-lex-message"
  201. },
  202. "encodedMessage": {
  203. "shape": "Sz",
  204. "location": "header",
  205. "locationName": "x-amz-lex-encoded-message"
  206. },
  207. "messageFormat": {
  208. "location": "header",
  209. "locationName": "x-amz-lex-message-format"
  210. },
  211. "dialogState": {
  212. "location": "header",
  213. "locationName": "x-amz-lex-dialog-state"
  214. },
  215. "slotToElicit": {
  216. "location": "header",
  217. "locationName": "x-amz-lex-slot-to-elicit"
  218. },
  219. "inputTranscript": {
  220. "deprecated": true,
  221. "deprecatedMessage": "The inputTranscript field is deprecated, use the encodedInputTranscript field instead. The inputTranscript field is available only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR and it-IT locales.",
  222. "location": "header",
  223. "locationName": "x-amz-lex-input-transcript"
  224. },
  225. "encodedInputTranscript": {
  226. "location": "header",
  227. "locationName": "x-amz-lex-encoded-input-transcript",
  228. "type": "string",
  229. "sensitive": true
  230. },
  231. "audioStream": {
  232. "shape": "Sw"
  233. },
  234. "botVersion": {
  235. "location": "header",
  236. "locationName": "x-amz-lex-bot-version"
  237. },
  238. "sessionId": {
  239. "location": "header",
  240. "locationName": "x-amz-lex-session-id"
  241. },
  242. "activeContexts": {
  243. "shape": "Sx",
  244. "jsonvalue": true,
  245. "location": "header",
  246. "locationName": "x-amz-lex-active-contexts"
  247. }
  248. },
  249. "payload": "audioStream"
  250. },
  251. "authtype": "v4-unsigned-body"
  252. },
  253. "PostText": {
  254. "http": {
  255. "requestUri": "/bot/{botName}/alias/{botAlias}/user/{userId}/text"
  256. },
  257. "input": {
  258. "type": "structure",
  259. "required": [
  260. "botName",
  261. "botAlias",
  262. "userId",
  263. "inputText"
  264. ],
  265. "members": {
  266. "botName": {
  267. "location": "uri",
  268. "locationName": "botName"
  269. },
  270. "botAlias": {
  271. "location": "uri",
  272. "locationName": "botAlias"
  273. },
  274. "userId": {
  275. "location": "uri",
  276. "locationName": "userId"
  277. },
  278. "sessionAttributes": {
  279. "shape": "Sd"
  280. },
  281. "requestAttributes": {
  282. "shape": "Sd"
  283. },
  284. "inputText": {
  285. "shape": "Si"
  286. },
  287. "activeContexts": {
  288. "shape": "Sk"
  289. }
  290. }
  291. },
  292. "output": {
  293. "type": "structure",
  294. "members": {
  295. "intentName": {},
  296. "nluIntentConfidence": {
  297. "shape": "S15"
  298. },
  299. "alternativeIntents": {
  300. "type": "list",
  301. "member": {
  302. "type": "structure",
  303. "members": {
  304. "intentName": {},
  305. "nluIntentConfidence": {
  306. "shape": "S15"
  307. },
  308. "slots": {
  309. "shape": "Sd"
  310. }
  311. }
  312. }
  313. },
  314. "slots": {
  315. "shape": "Sd"
  316. },
  317. "sessionAttributes": {
  318. "shape": "Sd"
  319. },
  320. "message": {
  321. "shape": "Si"
  322. },
  323. "sentimentResponse": {
  324. "type": "structure",
  325. "members": {
  326. "sentimentLabel": {},
  327. "sentimentScore": {}
  328. }
  329. },
  330. "messageFormat": {},
  331. "dialogState": {},
  332. "slotToElicit": {},
  333. "responseCard": {
  334. "type": "structure",
  335. "members": {
  336. "version": {},
  337. "contentType": {},
  338. "genericAttachments": {
  339. "type": "list",
  340. "member": {
  341. "type": "structure",
  342. "members": {
  343. "title": {},
  344. "subTitle": {},
  345. "attachmentLinkUrl": {},
  346. "imageUrl": {},
  347. "buttons": {
  348. "type": "list",
  349. "member": {
  350. "type": "structure",
  351. "required": [
  352. "text",
  353. "value"
  354. ],
  355. "members": {
  356. "text": {},
  357. "value": {}
  358. }
  359. }
  360. }
  361. }
  362. }
  363. }
  364. }
  365. },
  366. "sessionId": {},
  367. "botVersion": {},
  368. "activeContexts": {
  369. "shape": "Sk"
  370. }
  371. }
  372. }
  373. },
  374. "PutSession": {
  375. "http": {
  376. "requestUri": "/bot/{botName}/alias/{botAlias}/user/{userId}/session"
  377. },
  378. "input": {
  379. "type": "structure",
  380. "required": [
  381. "botName",
  382. "botAlias",
  383. "userId"
  384. ],
  385. "members": {
  386. "botName": {
  387. "location": "uri",
  388. "locationName": "botName"
  389. },
  390. "botAlias": {
  391. "location": "uri",
  392. "locationName": "botAlias"
  393. },
  394. "userId": {
  395. "location": "uri",
  396. "locationName": "userId"
  397. },
  398. "sessionAttributes": {
  399. "shape": "Sd"
  400. },
  401. "dialogAction": {
  402. "shape": "Sh"
  403. },
  404. "recentIntentSummaryView": {
  405. "shape": "Sa"
  406. },
  407. "accept": {
  408. "location": "header",
  409. "locationName": "Accept"
  410. },
  411. "activeContexts": {
  412. "shape": "Sk"
  413. }
  414. }
  415. },
  416. "output": {
  417. "type": "structure",
  418. "members": {
  419. "contentType": {
  420. "location": "header",
  421. "locationName": "Content-Type"
  422. },
  423. "intentName": {
  424. "location": "header",
  425. "locationName": "x-amz-lex-intent-name"
  426. },
  427. "slots": {
  428. "jsonvalue": true,
  429. "location": "header",
  430. "locationName": "x-amz-lex-slots"
  431. },
  432. "sessionAttributes": {
  433. "jsonvalue": true,
  434. "location": "header",
  435. "locationName": "x-amz-lex-session-attributes"
  436. },
  437. "message": {
  438. "shape": "Si",
  439. "deprecated": true,
  440. "deprecatedMessage": "The message field is deprecated, use the encodedMessage field instead. The message field is available only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR and it-IT locales.",
  441. "location": "header",
  442. "locationName": "x-amz-lex-message"
  443. },
  444. "encodedMessage": {
  445. "shape": "Sz",
  446. "location": "header",
  447. "locationName": "x-amz-lex-encoded-message"
  448. },
  449. "messageFormat": {
  450. "location": "header",
  451. "locationName": "x-amz-lex-message-format"
  452. },
  453. "dialogState": {
  454. "location": "header",
  455. "locationName": "x-amz-lex-dialog-state"
  456. },
  457. "slotToElicit": {
  458. "location": "header",
  459. "locationName": "x-amz-lex-slot-to-elicit"
  460. },
  461. "audioStream": {
  462. "shape": "Sw"
  463. },
  464. "sessionId": {
  465. "location": "header",
  466. "locationName": "x-amz-lex-session-id"
  467. },
  468. "activeContexts": {
  469. "shape": "Sx",
  470. "jsonvalue": true,
  471. "location": "header",
  472. "locationName": "x-amz-lex-active-contexts"
  473. }
  474. },
  475. "payload": "audioStream"
  476. }
  477. }
  478. },
  479. "shapes": {
  480. "Sa": {
  481. "type": "list",
  482. "member": {
  483. "type": "structure",
  484. "required": [
  485. "dialogActionType"
  486. ],
  487. "members": {
  488. "intentName": {},
  489. "checkpointLabel": {},
  490. "slots": {
  491. "shape": "Sd"
  492. },
  493. "confirmationStatus": {},
  494. "dialogActionType": {},
  495. "fulfillmentState": {},
  496. "slotToElicit": {}
  497. }
  498. }
  499. },
  500. "Sd": {
  501. "type": "map",
  502. "key": {},
  503. "value": {},
  504. "sensitive": true
  505. },
  506. "Sh": {
  507. "type": "structure",
  508. "required": [
  509. "type"
  510. ],
  511. "members": {
  512. "type": {},
  513. "intentName": {},
  514. "slots": {
  515. "shape": "Sd"
  516. },
  517. "slotToElicit": {},
  518. "fulfillmentState": {},
  519. "message": {
  520. "shape": "Si"
  521. },
  522. "messageFormat": {}
  523. }
  524. },
  525. "Si": {
  526. "type": "string",
  527. "sensitive": true
  528. },
  529. "Sk": {
  530. "type": "list",
  531. "member": {
  532. "type": "structure",
  533. "required": [
  534. "name",
  535. "timeToLive",
  536. "parameters"
  537. ],
  538. "members": {
  539. "name": {},
  540. "timeToLive": {
  541. "type": "structure",
  542. "members": {
  543. "timeToLiveInSeconds": {
  544. "type": "integer"
  545. },
  546. "turnsToLive": {
  547. "type": "integer"
  548. }
  549. }
  550. },
  551. "parameters": {
  552. "type": "map",
  553. "key": {},
  554. "value": {
  555. "shape": "Si"
  556. }
  557. }
  558. }
  559. },
  560. "sensitive": true
  561. },
  562. "St": {
  563. "type": "string",
  564. "sensitive": true
  565. },
  566. "Sw": {
  567. "type": "blob",
  568. "streaming": true
  569. },
  570. "Sx": {
  571. "type": "string",
  572. "sensitive": true
  573. },
  574. "Sz": {
  575. "type": "string",
  576. "sensitive": true
  577. },
  578. "S15": {
  579. "type": "structure",
  580. "members": {
  581. "score": {
  582. "type": "double"
  583. }
  584. }
  585. }
  586. }
  587. }