kendra-ranking-2022-10-19.min.json 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286
  1. {
  2. "version": "2.0",
  3. "metadata": {
  4. "apiVersion": "2022-10-19",
  5. "endpointPrefix": "kendra-ranking",
  6. "jsonVersion": "1.0",
  7. "protocol": "json",
  8. "serviceAbbreviation": "Kendra Ranking",
  9. "serviceFullName": "Amazon Kendra Intelligent Ranking",
  10. "serviceId": "Kendra Ranking",
  11. "signatureVersion": "v4",
  12. "signingName": "kendra-ranking",
  13. "targetPrefix": "AWSKendraRerankingFrontendService",
  14. "uid": "kendra-ranking-2022-10-19"
  15. },
  16. "operations": {
  17. "CreateRescoreExecutionPlan": {
  18. "input": {
  19. "type": "structure",
  20. "required": [
  21. "Name"
  22. ],
  23. "members": {
  24. "Name": {},
  25. "Description": {},
  26. "CapacityUnits": {
  27. "shape": "S4"
  28. },
  29. "Tags": {
  30. "shape": "S6"
  31. },
  32. "ClientToken": {
  33. "idempotencyToken": true
  34. }
  35. }
  36. },
  37. "output": {
  38. "type": "structure",
  39. "required": [
  40. "Id",
  41. "Arn"
  42. ],
  43. "members": {
  44. "Id": {},
  45. "Arn": {}
  46. }
  47. }
  48. },
  49. "DeleteRescoreExecutionPlan": {
  50. "input": {
  51. "type": "structure",
  52. "required": [
  53. "Id"
  54. ],
  55. "members": {
  56. "Id": {}
  57. }
  58. }
  59. },
  60. "DescribeRescoreExecutionPlan": {
  61. "input": {
  62. "type": "structure",
  63. "required": [
  64. "Id"
  65. ],
  66. "members": {
  67. "Id": {}
  68. }
  69. },
  70. "output": {
  71. "type": "structure",
  72. "members": {
  73. "Id": {},
  74. "Arn": {},
  75. "Name": {},
  76. "Description": {},
  77. "CapacityUnits": {
  78. "shape": "S4"
  79. },
  80. "CreatedAt": {
  81. "type": "timestamp"
  82. },
  83. "UpdatedAt": {
  84. "type": "timestamp"
  85. },
  86. "Status": {},
  87. "ErrorMessage": {}
  88. }
  89. }
  90. },
  91. "ListRescoreExecutionPlans": {
  92. "input": {
  93. "type": "structure",
  94. "members": {
  95. "NextToken": {},
  96. "MaxResults": {
  97. "type": "integer"
  98. }
  99. }
  100. },
  101. "output": {
  102. "type": "structure",
  103. "members": {
  104. "SummaryItems": {
  105. "type": "list",
  106. "member": {
  107. "type": "structure",
  108. "members": {
  109. "Name": {},
  110. "Id": {},
  111. "CreatedAt": {
  112. "type": "timestamp"
  113. },
  114. "UpdatedAt": {
  115. "type": "timestamp"
  116. },
  117. "Status": {}
  118. }
  119. }
  120. },
  121. "NextToken": {}
  122. }
  123. }
  124. },
  125. "ListTagsForResource": {
  126. "input": {
  127. "type": "structure",
  128. "required": [
  129. "ResourceARN"
  130. ],
  131. "members": {
  132. "ResourceARN": {}
  133. }
  134. },
  135. "output": {
  136. "type": "structure",
  137. "members": {
  138. "Tags": {
  139. "shape": "S6"
  140. }
  141. }
  142. }
  143. },
  144. "Rescore": {
  145. "input": {
  146. "type": "structure",
  147. "required": [
  148. "RescoreExecutionPlanId",
  149. "SearchQuery",
  150. "Documents"
  151. ],
  152. "members": {
  153. "RescoreExecutionPlanId": {},
  154. "SearchQuery": {},
  155. "Documents": {
  156. "type": "list",
  157. "member": {
  158. "type": "structure",
  159. "required": [
  160. "Id",
  161. "OriginalScore"
  162. ],
  163. "members": {
  164. "Id": {},
  165. "GroupId": {},
  166. "Title": {},
  167. "Body": {},
  168. "TokenizedTitle": {
  169. "type": "list",
  170. "member": {}
  171. },
  172. "TokenizedBody": {
  173. "type": "list",
  174. "member": {}
  175. },
  176. "OriginalScore": {
  177. "type": "float"
  178. }
  179. }
  180. }
  181. }
  182. }
  183. },
  184. "output": {
  185. "type": "structure",
  186. "members": {
  187. "RescoreId": {},
  188. "ResultItems": {
  189. "type": "list",
  190. "member": {
  191. "type": "structure",
  192. "members": {
  193. "DocumentId": {},
  194. "Score": {
  195. "type": "float"
  196. }
  197. }
  198. }
  199. }
  200. }
  201. }
  202. },
  203. "TagResource": {
  204. "input": {
  205. "type": "structure",
  206. "required": [
  207. "ResourceARN",
  208. "Tags"
  209. ],
  210. "members": {
  211. "ResourceARN": {},
  212. "Tags": {
  213. "shape": "S6"
  214. }
  215. }
  216. },
  217. "output": {
  218. "type": "structure",
  219. "members": {}
  220. }
  221. },
  222. "UntagResource": {
  223. "input": {
  224. "type": "structure",
  225. "required": [
  226. "ResourceARN",
  227. "TagKeys"
  228. ],
  229. "members": {
  230. "ResourceARN": {},
  231. "TagKeys": {
  232. "type": "list",
  233. "member": {}
  234. }
  235. }
  236. },
  237. "output": {
  238. "type": "structure",
  239. "members": {}
  240. }
  241. },
  242. "UpdateRescoreExecutionPlan": {
  243. "input": {
  244. "type": "structure",
  245. "required": [
  246. "Id"
  247. ],
  248. "members": {
  249. "Id": {},
  250. "Name": {},
  251. "Description": {},
  252. "CapacityUnits": {
  253. "shape": "S4"
  254. }
  255. }
  256. }
  257. }
  258. },
  259. "shapes": {
  260. "S4": {
  261. "type": "structure",
  262. "required": [
  263. "RescoreCapacityUnits"
  264. ],
  265. "members": {
  266. "RescoreCapacityUnits": {
  267. "type": "integer"
  268. }
  269. }
  270. },
  271. "S6": {
  272. "type": "list",
  273. "member": {
  274. "type": "structure",
  275. "required": [
  276. "Key",
  277. "Value"
  278. ],
  279. "members": {
  280. "Key": {},
  281. "Value": {}
  282. }
  283. }
  284. }
  285. }
  286. }