runtime.lex.v2-2020-08-07.min.json 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618
  1. {
  2. "version": "2.0",
  3. "metadata": {
  4. "apiVersion": "2020-08-07",
  5. "endpointPrefix": "runtime-v2-lex",
  6. "jsonVersion": "1.1",
  7. "protocol": "rest-json",
  8. "protocolSettings": {
  9. "h2": "eventstream"
  10. },
  11. "serviceAbbreviation": "Lex Runtime V2",
  12. "serviceFullName": "Amazon Lex Runtime V2",
  13. "serviceId": "Lex Runtime V2",
  14. "signatureVersion": "v4",
  15. "signingName": "lex",
  16. "uid": "runtime.lex.v2-2020-08-07"
  17. },
  18. "operations": {
  19. "DeleteSession": {
  20. "http": {
  21. "method": "DELETE",
  22. "requestUri": "/bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}"
  23. },
  24. "input": {
  25. "type": "structure",
  26. "required": [
  27. "botId",
  28. "botAliasId",
  29. "sessionId",
  30. "localeId"
  31. ],
  32. "members": {
  33. "botId": {
  34. "location": "uri",
  35. "locationName": "botId"
  36. },
  37. "botAliasId": {
  38. "location": "uri",
  39. "locationName": "botAliasId"
  40. },
  41. "localeId": {
  42. "location": "uri",
  43. "locationName": "localeId"
  44. },
  45. "sessionId": {
  46. "location": "uri",
  47. "locationName": "sessionId"
  48. }
  49. }
  50. },
  51. "output": {
  52. "type": "structure",
  53. "members": {
  54. "botId": {},
  55. "botAliasId": {},
  56. "localeId": {},
  57. "sessionId": {}
  58. }
  59. }
  60. },
  61. "GetSession": {
  62. "http": {
  63. "method": "GET",
  64. "requestUri": "/bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}"
  65. },
  66. "input": {
  67. "type": "structure",
  68. "required": [
  69. "botId",
  70. "botAliasId",
  71. "localeId",
  72. "sessionId"
  73. ],
  74. "members": {
  75. "botId": {
  76. "location": "uri",
  77. "locationName": "botId"
  78. },
  79. "botAliasId": {
  80. "location": "uri",
  81. "locationName": "botAliasId"
  82. },
  83. "localeId": {
  84. "location": "uri",
  85. "locationName": "localeId"
  86. },
  87. "sessionId": {
  88. "location": "uri",
  89. "locationName": "sessionId"
  90. }
  91. }
  92. },
  93. "output": {
  94. "type": "structure",
  95. "members": {
  96. "sessionId": {},
  97. "messages": {
  98. "shape": "Sa"
  99. },
  100. "interpretations": {
  101. "shape": "Sl"
  102. },
  103. "sessionState": {
  104. "shape": "S12"
  105. }
  106. }
  107. }
  108. },
  109. "PutSession": {
  110. "http": {
  111. "requestUri": "/bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}"
  112. },
  113. "input": {
  114. "type": "structure",
  115. "required": [
  116. "botId",
  117. "botAliasId",
  118. "localeId",
  119. "sessionState",
  120. "sessionId"
  121. ],
  122. "members": {
  123. "botId": {
  124. "location": "uri",
  125. "locationName": "botId"
  126. },
  127. "botAliasId": {
  128. "location": "uri",
  129. "locationName": "botAliasId"
  130. },
  131. "localeId": {
  132. "location": "uri",
  133. "locationName": "localeId"
  134. },
  135. "sessionId": {
  136. "location": "uri",
  137. "locationName": "sessionId"
  138. },
  139. "messages": {
  140. "shape": "Sa"
  141. },
  142. "sessionState": {
  143. "shape": "S12"
  144. },
  145. "requestAttributes": {
  146. "shape": "S1f"
  147. },
  148. "responseContentType": {
  149. "location": "header",
  150. "locationName": "ResponseContentType"
  151. }
  152. }
  153. },
  154. "output": {
  155. "type": "structure",
  156. "members": {
  157. "contentType": {
  158. "location": "header",
  159. "locationName": "Content-Type"
  160. },
  161. "messages": {
  162. "location": "header",
  163. "locationName": "x-amz-lex-messages"
  164. },
  165. "sessionState": {
  166. "location": "header",
  167. "locationName": "x-amz-lex-session-state"
  168. },
  169. "requestAttributes": {
  170. "location": "header",
  171. "locationName": "x-amz-lex-request-attributes"
  172. },
  173. "sessionId": {
  174. "location": "header",
  175. "locationName": "x-amz-lex-session-id"
  176. },
  177. "audioStream": {
  178. "shape": "S1r"
  179. }
  180. },
  181. "payload": "audioStream"
  182. }
  183. },
  184. "RecognizeText": {
  185. "http": {
  186. "requestUri": "/bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}/text"
  187. },
  188. "input": {
  189. "type": "structure",
  190. "required": [
  191. "botId",
  192. "botAliasId",
  193. "localeId",
  194. "text",
  195. "sessionId"
  196. ],
  197. "members": {
  198. "botId": {
  199. "location": "uri",
  200. "locationName": "botId"
  201. },
  202. "botAliasId": {
  203. "location": "uri",
  204. "locationName": "botAliasId"
  205. },
  206. "localeId": {
  207. "location": "uri",
  208. "locationName": "localeId"
  209. },
  210. "sessionId": {
  211. "location": "uri",
  212. "locationName": "sessionId"
  213. },
  214. "text": {
  215. "shape": "Sc"
  216. },
  217. "sessionState": {
  218. "shape": "S12"
  219. },
  220. "requestAttributes": {
  221. "shape": "S1f"
  222. }
  223. }
  224. },
  225. "output": {
  226. "type": "structure",
  227. "members": {
  228. "messages": {
  229. "shape": "Sa"
  230. },
  231. "sessionState": {
  232. "shape": "S12"
  233. },
  234. "interpretations": {
  235. "shape": "Sl"
  236. },
  237. "requestAttributes": {
  238. "shape": "S1f"
  239. },
  240. "sessionId": {},
  241. "recognizedBotMember": {
  242. "type": "structure",
  243. "required": [
  244. "botId"
  245. ],
  246. "members": {
  247. "botId": {},
  248. "botName": {}
  249. }
  250. }
  251. }
  252. }
  253. },
  254. "RecognizeUtterance": {
  255. "http": {
  256. "requestUri": "/bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}/utterance"
  257. },
  258. "input": {
  259. "type": "structure",
  260. "required": [
  261. "botId",
  262. "botAliasId",
  263. "localeId",
  264. "requestContentType",
  265. "sessionId"
  266. ],
  267. "members": {
  268. "botId": {
  269. "location": "uri",
  270. "locationName": "botId"
  271. },
  272. "botAliasId": {
  273. "location": "uri",
  274. "locationName": "botAliasId"
  275. },
  276. "localeId": {
  277. "location": "uri",
  278. "locationName": "localeId"
  279. },
  280. "sessionId": {
  281. "location": "uri",
  282. "locationName": "sessionId"
  283. },
  284. "sessionState": {
  285. "shape": "S1w",
  286. "location": "header",
  287. "locationName": "x-amz-lex-session-state"
  288. },
  289. "requestAttributes": {
  290. "shape": "S1w",
  291. "location": "header",
  292. "locationName": "x-amz-lex-request-attributes"
  293. },
  294. "requestContentType": {
  295. "location": "header",
  296. "locationName": "Content-Type"
  297. },
  298. "responseContentType": {
  299. "location": "header",
  300. "locationName": "Response-Content-Type"
  301. },
  302. "inputStream": {
  303. "shape": "S1r"
  304. }
  305. },
  306. "payload": "inputStream"
  307. },
  308. "output": {
  309. "type": "structure",
  310. "members": {
  311. "inputMode": {
  312. "location": "header",
  313. "locationName": "x-amz-lex-input-mode"
  314. },
  315. "contentType": {
  316. "location": "header",
  317. "locationName": "Content-Type"
  318. },
  319. "messages": {
  320. "location": "header",
  321. "locationName": "x-amz-lex-messages"
  322. },
  323. "interpretations": {
  324. "location": "header",
  325. "locationName": "x-amz-lex-interpretations"
  326. },
  327. "sessionState": {
  328. "location": "header",
  329. "locationName": "x-amz-lex-session-state"
  330. },
  331. "requestAttributes": {
  332. "location": "header",
  333. "locationName": "x-amz-lex-request-attributes"
  334. },
  335. "sessionId": {
  336. "location": "header",
  337. "locationName": "x-amz-lex-session-id"
  338. },
  339. "inputTranscript": {
  340. "location": "header",
  341. "locationName": "x-amz-lex-input-transcript"
  342. },
  343. "audioStream": {
  344. "shape": "S1r"
  345. },
  346. "recognizedBotMember": {
  347. "location": "header",
  348. "locationName": "x-amz-lex-recognized-bot-member"
  349. }
  350. },
  351. "payload": "audioStream"
  352. },
  353. "authtype": "v4-unsigned-body"
  354. }
  355. },
  356. "shapes": {
  357. "Sa": {
  358. "type": "list",
  359. "member": {
  360. "type": "structure",
  361. "required": [
  362. "contentType"
  363. ],
  364. "members": {
  365. "content": {
  366. "shape": "Sc"
  367. },
  368. "contentType": {},
  369. "imageResponseCard": {
  370. "type": "structure",
  371. "required": [
  372. "title"
  373. ],
  374. "members": {
  375. "title": {},
  376. "subtitle": {},
  377. "imageUrl": {},
  378. "buttons": {
  379. "type": "list",
  380. "member": {
  381. "type": "structure",
  382. "required": [
  383. "text",
  384. "value"
  385. ],
  386. "members": {
  387. "text": {},
  388. "value": {}
  389. }
  390. }
  391. }
  392. }
  393. }
  394. }
  395. }
  396. },
  397. "Sc": {
  398. "type": "string",
  399. "sensitive": true
  400. },
  401. "Sl": {
  402. "type": "list",
  403. "member": {
  404. "type": "structure",
  405. "members": {
  406. "nluConfidence": {
  407. "type": "structure",
  408. "members": {
  409. "score": {
  410. "type": "double"
  411. }
  412. }
  413. },
  414. "sentimentResponse": {
  415. "type": "structure",
  416. "members": {
  417. "sentiment": {},
  418. "sentimentScore": {
  419. "type": "structure",
  420. "members": {
  421. "positive": {
  422. "type": "double"
  423. },
  424. "negative": {
  425. "type": "double"
  426. },
  427. "neutral": {
  428. "type": "double"
  429. },
  430. "mixed": {
  431. "type": "double"
  432. }
  433. }
  434. }
  435. }
  436. },
  437. "intent": {
  438. "shape": "Ss"
  439. },
  440. "interpretationSource": {}
  441. }
  442. }
  443. },
  444. "Ss": {
  445. "type": "structure",
  446. "required": [
  447. "name"
  448. ],
  449. "members": {
  450. "name": {},
  451. "slots": {
  452. "shape": "St"
  453. },
  454. "state": {},
  455. "confirmationState": {}
  456. }
  457. },
  458. "St": {
  459. "type": "map",
  460. "key": {},
  461. "value": {
  462. "shape": "Su"
  463. }
  464. },
  465. "Su": {
  466. "type": "structure",
  467. "members": {
  468. "value": {
  469. "type": "structure",
  470. "required": [
  471. "interpretedValue"
  472. ],
  473. "members": {
  474. "originalValue": {},
  475. "interpretedValue": {},
  476. "resolvedValues": {
  477. "type": "list",
  478. "member": {}
  479. }
  480. }
  481. },
  482. "shape": {},
  483. "values": {
  484. "type": "list",
  485. "member": {
  486. "shape": "Su"
  487. }
  488. },
  489. "subSlots": {
  490. "shape": "St"
  491. }
  492. }
  493. },
  494. "S12": {
  495. "type": "structure",
  496. "members": {
  497. "dialogAction": {
  498. "type": "structure",
  499. "required": [
  500. "type"
  501. ],
  502. "members": {
  503. "type": {},
  504. "slotToElicit": {},
  505. "slotElicitationStyle": {},
  506. "subSlotToElicit": {
  507. "shape": "S16"
  508. }
  509. }
  510. },
  511. "intent": {
  512. "shape": "Ss"
  513. },
  514. "activeContexts": {
  515. "type": "list",
  516. "member": {
  517. "type": "structure",
  518. "required": [
  519. "name",
  520. "timeToLive",
  521. "contextAttributes"
  522. ],
  523. "members": {
  524. "name": {},
  525. "timeToLive": {
  526. "type": "structure",
  527. "required": [
  528. "timeToLiveInSeconds",
  529. "turnsToLive"
  530. ],
  531. "members": {
  532. "timeToLiveInSeconds": {
  533. "type": "integer"
  534. },
  535. "turnsToLive": {
  536. "type": "integer"
  537. }
  538. }
  539. },
  540. "contextAttributes": {
  541. "type": "map",
  542. "key": {},
  543. "value": {
  544. "shape": "Sc"
  545. }
  546. }
  547. }
  548. }
  549. },
  550. "sessionAttributes": {
  551. "shape": "S1f"
  552. },
  553. "originatingRequestId": {},
  554. "runtimeHints": {
  555. "type": "structure",
  556. "members": {
  557. "slotHints": {
  558. "type": "map",
  559. "key": {},
  560. "value": {
  561. "shape": "S1k"
  562. }
  563. }
  564. }
  565. }
  566. }
  567. },
  568. "S16": {
  569. "type": "structure",
  570. "required": [
  571. "name"
  572. ],
  573. "members": {
  574. "name": {},
  575. "subSlotToElicit": {
  576. "shape": "S16"
  577. }
  578. }
  579. },
  580. "S1f": {
  581. "type": "map",
  582. "key": {},
  583. "value": {}
  584. },
  585. "S1k": {
  586. "type": "map",
  587. "key": {},
  588. "value": {
  589. "type": "structure",
  590. "members": {
  591. "runtimeHintValues": {
  592. "type": "list",
  593. "member": {
  594. "type": "structure",
  595. "required": [
  596. "phrase"
  597. ],
  598. "members": {
  599. "phrase": {}
  600. }
  601. }
  602. },
  603. "subSlotHints": {
  604. "shape": "S1k"
  605. }
  606. }
  607. }
  608. },
  609. "S1r": {
  610. "type": "blob",
  611. "streaming": true
  612. },
  613. "S1w": {
  614. "type": "string",
  615. "sensitive": true
  616. }
  617. }
  618. }