@orq-ai/node 3.3.0-rc.8 → 3.3.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.
Files changed (578) hide show
  1. package/README.md +39 -1
  2. package/bin/mcp-server.js +4344 -149
  3. package/bin/mcp-server.js.map +78 -30
  4. package/docs/sdks/datasets/README.md +6 -0
  5. package/docs/sdks/files/README.md +8 -2
  6. package/docs/sdks/knowledge/README.md +1279 -0
  7. package/docs/sdks/prompts/README.md +6 -0
  8. package/funcs/filesCreate.d.ts +1 -1
  9. package/funcs/filesCreate.d.ts.map +1 -1
  10. package/funcs/filesCreate.js +13 -15
  11. package/funcs/filesCreate.js.map +1 -1
  12. package/funcs/knowledgeCreate.d.ts +13 -0
  13. package/funcs/knowledgeCreate.d.ts.map +1 -0
  14. package/funcs/knowledgeCreate.js +109 -0
  15. package/funcs/knowledgeCreate.js.map +1 -0
  16. package/funcs/knowledgeCreateChunks.d.ts +13 -0
  17. package/funcs/knowledgeCreateChunks.d.ts.map +1 -0
  18. package/funcs/knowledgeCreateChunks.js +120 -0
  19. package/funcs/knowledgeCreateChunks.js.map +1 -0
  20. package/funcs/knowledgeCreateDatasource.d.ts +13 -0
  21. package/funcs/knowledgeCreateDatasource.d.ts.map +1 -0
  22. package/funcs/knowledgeCreateDatasource.js +115 -0
  23. package/funcs/knowledgeCreateDatasource.js.map +1 -0
  24. package/funcs/knowledgeDelete.d.ts +16 -0
  25. package/funcs/knowledgeDelete.d.ts.map +1 -0
  26. package/funcs/knowledgeDelete.js +118 -0
  27. package/funcs/knowledgeDelete.js.map +1 -0
  28. package/funcs/knowledgeDeleteChunk.d.ts +13 -0
  29. package/funcs/knowledgeDeleteChunk.d.ts.map +1 -0
  30. package/funcs/knowledgeDeleteChunk.js +123 -0
  31. package/funcs/knowledgeDeleteChunk.js.map +1 -0
  32. package/funcs/knowledgeDeleteDatasource.d.ts +16 -0
  33. package/funcs/knowledgeDeleteDatasource.d.ts.map +1 -0
  34. package/funcs/knowledgeDeleteDatasource.js +122 -0
  35. package/funcs/knowledgeDeleteDatasource.js.map +1 -0
  36. package/funcs/knowledgeList.d.ts +16 -0
  37. package/funcs/knowledgeList.d.ts.map +1 -0
  38. package/funcs/knowledgeList.js +117 -0
  39. package/funcs/knowledgeList.js.map +1 -0
  40. package/funcs/knowledgeListChunks.d.ts +13 -0
  41. package/funcs/knowledgeListChunks.d.ts.map +1 -0
  42. package/funcs/knowledgeListChunks.js +126 -0
  43. package/funcs/knowledgeListChunks.js.map +1 -0
  44. package/funcs/knowledgeListDatasources.d.ts +13 -0
  45. package/funcs/knowledgeListDatasources.d.ts.map +1 -0
  46. package/funcs/knowledgeListDatasources.js +122 -0
  47. package/funcs/knowledgeListDatasources.js.map +1 -0
  48. package/funcs/knowledgeRetrieve.d.ts +16 -0
  49. package/funcs/knowledgeRetrieve.d.ts.map +1 -0
  50. package/funcs/knowledgeRetrieve.js +117 -0
  51. package/funcs/knowledgeRetrieve.js.map +1 -0
  52. package/funcs/knowledgeRetrieveChunk.d.ts +13 -0
  53. package/funcs/knowledgeRetrieveChunk.d.ts.map +1 -0
  54. package/funcs/knowledgeRetrieveChunk.js +122 -0
  55. package/funcs/knowledgeRetrieveChunk.js.map +1 -0
  56. package/funcs/knowledgeRetrieveDatasource.d.ts +13 -0
  57. package/funcs/knowledgeRetrieveDatasource.d.ts.map +1 -0
  58. package/funcs/knowledgeRetrieveDatasource.js +118 -0
  59. package/funcs/knowledgeRetrieveDatasource.js.map +1 -0
  60. package/funcs/knowledgeSearch.d.ts +13 -0
  61. package/funcs/knowledgeSearch.d.ts.map +1 -0
  62. package/funcs/knowledgeSearch.js +115 -0
  63. package/funcs/knowledgeSearch.js.map +1 -0
  64. package/funcs/knowledgeUpdate.d.ts +13 -0
  65. package/funcs/knowledgeUpdate.d.ts.map +1 -0
  66. package/funcs/knowledgeUpdate.js +115 -0
  67. package/funcs/knowledgeUpdate.js.map +1 -0
  68. package/funcs/knowledgeUpdateChunk.d.ts +13 -0
  69. package/funcs/knowledgeUpdateChunk.d.ts.map +1 -0
  70. package/funcs/knowledgeUpdateChunk.js +123 -0
  71. package/funcs/knowledgeUpdateChunk.js.map +1 -0
  72. package/funcs/knowledgeUpdateDatasource.d.ts +13 -0
  73. package/funcs/knowledgeUpdateDatasource.d.ts.map +1 -0
  74. package/funcs/knowledgeUpdateDatasource.js +119 -0
  75. package/funcs/knowledgeUpdateDatasource.js.map +1 -0
  76. package/hooks/types.d.ts +1 -1
  77. package/hooks/types.d.ts.map +1 -1
  78. package/jsr.json +1 -1
  79. package/lib/config.d.ts +3 -3
  80. package/lib/config.js +3 -3
  81. package/lib/config.js.map +1 -1
  82. package/mcp-server/mcp-server.js +1 -1
  83. package/mcp-server/mcp-server.js.map +1 -1
  84. package/mcp-server/server.d.ts.map +1 -1
  85. package/mcp-server/server.js +33 -1
  86. package/mcp-server/server.js.map +1 -1
  87. package/mcp-server/tools/filesCreate.d.ts +1 -1
  88. package/mcp-server/tools/filesCreate.js +1 -1
  89. package/mcp-server/tools/filesCreate.js.map +1 -1
  90. package/mcp-server/tools/knowledgeCreate.d.ts +8 -0
  91. package/mcp-server/tools/knowledgeCreate.d.ts.map +1 -0
  92. package/mcp-server/tools/knowledgeCreate.js +62 -0
  93. package/mcp-server/tools/knowledgeCreate.js.map +1 -0
  94. package/mcp-server/tools/knowledgeCreateChunks.d.ts +8 -0
  95. package/mcp-server/tools/knowledgeCreateChunks.d.ts.map +1 -0
  96. package/mcp-server/tools/knowledgeCreateChunks.js +62 -0
  97. package/mcp-server/tools/knowledgeCreateChunks.js.map +1 -0
  98. package/mcp-server/tools/knowledgeCreateDatasource.d.ts +8 -0
  99. package/mcp-server/tools/knowledgeCreateDatasource.d.ts.map +1 -0
  100. package/mcp-server/tools/knowledgeCreateDatasource.js +62 -0
  101. package/mcp-server/tools/knowledgeCreateDatasource.js.map +1 -0
  102. package/mcp-server/tools/knowledgeDelete.d.ts +8 -0
  103. package/mcp-server/tools/knowledgeDelete.d.ts.map +1 -0
  104. package/mcp-server/tools/knowledgeDelete.js +63 -0
  105. package/mcp-server/tools/knowledgeDelete.js.map +1 -0
  106. package/mcp-server/tools/knowledgeDeleteChunk.d.ts +8 -0
  107. package/mcp-server/tools/knowledgeDeleteChunk.d.ts.map +1 -0
  108. package/mcp-server/tools/knowledgeDeleteChunk.js +61 -0
  109. package/mcp-server/tools/knowledgeDeleteChunk.js.map +1 -0
  110. package/mcp-server/tools/knowledgeDeleteDatasource.d.ts +8 -0
  111. package/mcp-server/tools/knowledgeDeleteDatasource.d.ts.map +1 -0
  112. package/mcp-server/tools/knowledgeDeleteDatasource.js +63 -0
  113. package/mcp-server/tools/knowledgeDeleteDatasource.js.map +1 -0
  114. package/mcp-server/tools/knowledgeList.d.ts +8 -0
  115. package/mcp-server/tools/knowledgeList.d.ts.map +1 -0
  116. package/mcp-server/tools/knowledgeList.js +64 -0
  117. package/mcp-server/tools/knowledgeList.js.map +1 -0
  118. package/mcp-server/tools/knowledgeListChunks.d.ts +8 -0
  119. package/mcp-server/tools/knowledgeListChunks.d.ts.map +1 -0
  120. package/mcp-server/tools/knowledgeListChunks.js +62 -0
  121. package/mcp-server/tools/knowledgeListChunks.js.map +1 -0
  122. package/mcp-server/tools/knowledgeListDatasources.d.ts +8 -0
  123. package/mcp-server/tools/knowledgeListDatasources.d.ts.map +1 -0
  124. package/mcp-server/tools/knowledgeListDatasources.js +62 -0
  125. package/mcp-server/tools/knowledgeListDatasources.js.map +1 -0
  126. package/mcp-server/tools/knowledgeRetrieve.d.ts +8 -0
  127. package/mcp-server/tools/knowledgeRetrieve.d.ts.map +1 -0
  128. package/mcp-server/tools/knowledgeRetrieve.js +64 -0
  129. package/mcp-server/tools/knowledgeRetrieve.js.map +1 -0
  130. package/mcp-server/tools/knowledgeRetrieveChunk.d.ts +8 -0
  131. package/mcp-server/tools/knowledgeRetrieveChunk.d.ts.map +1 -0
  132. package/mcp-server/tools/knowledgeRetrieveChunk.js +62 -0
  133. package/mcp-server/tools/knowledgeRetrieveChunk.js.map +1 -0
  134. package/mcp-server/tools/knowledgeRetrieveDatasource.d.ts +8 -0
  135. package/mcp-server/tools/knowledgeRetrieveDatasource.d.ts.map +1 -0
  136. package/mcp-server/tools/knowledgeRetrieveDatasource.js +62 -0
  137. package/mcp-server/tools/knowledgeRetrieveDatasource.js.map +1 -0
  138. package/mcp-server/tools/knowledgeSearch.d.ts +8 -0
  139. package/mcp-server/tools/knowledgeSearch.d.ts.map +1 -0
  140. package/mcp-server/tools/knowledgeSearch.js +62 -0
  141. package/mcp-server/tools/knowledgeSearch.js.map +1 -0
  142. package/mcp-server/tools/knowledgeUpdate.d.ts +8 -0
  143. package/mcp-server/tools/knowledgeUpdate.d.ts.map +1 -0
  144. package/mcp-server/tools/knowledgeUpdate.js +62 -0
  145. package/mcp-server/tools/knowledgeUpdate.js.map +1 -0
  146. package/mcp-server/tools/knowledgeUpdateChunk.d.ts +8 -0
  147. package/mcp-server/tools/knowledgeUpdateChunk.d.ts.map +1 -0
  148. package/mcp-server/tools/knowledgeUpdateChunk.js +62 -0
  149. package/mcp-server/tools/knowledgeUpdateChunk.js.map +1 -0
  150. package/mcp-server/tools/knowledgeUpdateDatasource.d.ts +8 -0
  151. package/mcp-server/tools/knowledgeUpdateDatasource.d.ts.map +1 -0
  152. package/mcp-server/tools/knowledgeUpdateDatasource.js +62 -0
  153. package/mcp-server/tools/knowledgeUpdateDatasource.js.map +1 -0
  154. package/models/operations/bulkcreatedatapoints.js +2 -2
  155. package/models/operations/createchunk.d.ts +320 -0
  156. package/models/operations/createchunk.d.ts.map +1 -0
  157. package/models/operations/createchunk.js +366 -0
  158. package/models/operations/createchunk.js.map +1 -0
  159. package/models/operations/createcontact.js +2 -2
  160. package/models/operations/createdataset.js +2 -2
  161. package/models/operations/createdatasetitem.js +2 -2
  162. package/models/operations/createdatasource.d.ts +421 -0
  163. package/models/operations/createdatasource.d.ts.map +1 -0
  164. package/models/operations/createdatasource.js +458 -0
  165. package/models/operations/createdatasource.js.map +1 -0
  166. package/models/operations/createknowledge.d.ts +349 -0
  167. package/models/operations/createknowledge.d.ts.map +1 -0
  168. package/models/operations/createknowledge.js +363 -0
  169. package/models/operations/createknowledge.js.map +1 -0
  170. package/models/operations/createprompt.d.ts +36 -12
  171. package/models/operations/createprompt.d.ts.map +1 -1
  172. package/models/operations/createprompt.js +12 -4
  173. package/models/operations/createprompt.js.map +1 -1
  174. package/models/operations/deletechunk.d.ts +42 -0
  175. package/models/operations/deletechunk.d.ts.map +1 -0
  176. package/models/operations/deletechunk.js +86 -0
  177. package/models/operations/deletechunk.js.map +1 -0
  178. package/models/operations/deletedatasource.d.ts +37 -0
  179. package/models/operations/deletedatasource.d.ts.map +1 -0
  180. package/models/operations/deletedatasource.js +82 -0
  181. package/models/operations/deletedatasource.js.map +1 -0
  182. package/models/operations/deleteknowledge.d.ts +32 -0
  183. package/models/operations/deleteknowledge.d.ts.map +1 -0
  184. package/models/operations/deleteknowledge.js +78 -0
  185. package/models/operations/deleteknowledge.js.map +1 -0
  186. package/models/operations/fileget.js +2 -2
  187. package/models/operations/filelist.js +2 -2
  188. package/models/operations/fileupload.d.ts +2 -2
  189. package/models/operations/fileupload.d.ts.map +1 -1
  190. package/models/operations/fileupload.js +4 -4
  191. package/models/operations/fileupload.js.map +1 -1
  192. package/models/operations/getallprompts.d.ts +18 -6
  193. package/models/operations/getallprompts.d.ts.map +1 -1
  194. package/models/operations/getallprompts.js +6 -2
  195. package/models/operations/getallprompts.js.map +1 -1
  196. package/models/operations/getonechunk.d.ts +158 -0
  197. package/models/operations/getonechunk.d.ts.map +1 -0
  198. package/models/operations/getonechunk.js +166 -0
  199. package/models/operations/getonechunk.js.map +1 -0
  200. package/models/operations/getoneknowledge.d.ts +219 -0
  201. package/models/operations/getoneknowledge.d.ts.map +1 -0
  202. package/models/operations/getoneknowledge.js +246 -0
  203. package/models/operations/getoneknowledge.js.map +1 -0
  204. package/models/operations/getoneprompt.d.ts +18 -6
  205. package/models/operations/getoneprompt.d.ts.map +1 -1
  206. package/models/operations/getoneprompt.js +6 -2
  207. package/models/operations/getoneprompt.js.map +1 -1
  208. package/models/operations/getpromptversion.d.ts +18 -6
  209. package/models/operations/getpromptversion.d.ts.map +1 -1
  210. package/models/operations/getpromptversion.js +6 -2
  211. package/models/operations/getpromptversion.js.map +1 -1
  212. package/models/operations/index.d.ts +16 -0
  213. package/models/operations/index.d.ts.map +1 -1
  214. package/models/operations/index.js +16 -0
  215. package/models/operations/index.js.map +1 -1
  216. package/models/operations/listchunks.d.ts +253 -0
  217. package/models/operations/listchunks.d.ts.map +1 -0
  218. package/models/operations/listchunks.js +256 -0
  219. package/models/operations/listchunks.js.map +1 -0
  220. package/models/operations/listdatasetdatapoints.js +2 -2
  221. package/models/operations/listdatasets.js +2 -2
  222. package/models/operations/listdatasources.d.ts +245 -0
  223. package/models/operations/listdatasources.d.ts.map +1 -0
  224. package/models/operations/listdatasources.js +262 -0
  225. package/models/operations/listdatasources.js.map +1 -0
  226. package/models/operations/listknowledgebases.d.ts +283 -0
  227. package/models/operations/listknowledgebases.d.ts.map +1 -0
  228. package/models/operations/listknowledgebases.js +309 -0
  229. package/models/operations/listknowledgebases.js.map +1 -0
  230. package/models/operations/listpromptversions.d.ts +18 -6
  231. package/models/operations/listpromptversions.d.ts.map +1 -1
  232. package/models/operations/listpromptversions.js +6 -2
  233. package/models/operations/listpromptversions.js.map +1 -1
  234. package/models/operations/retrievedatapoint.js +2 -2
  235. package/models/operations/retrievedataset.js +2 -2
  236. package/models/operations/retrievedatasource.d.ts +150 -0
  237. package/models/operations/retrievedatasource.d.ts.map +1 -0
  238. package/models/operations/retrievedatasource.js +171 -0
  239. package/models/operations/retrievedatasource.js.map +1 -0
  240. package/models/operations/searchknowledge.d.ts +894 -0
  241. package/models/operations/searchknowledge.d.ts.map +1 -0
  242. package/models/operations/searchknowledge.js +879 -0
  243. package/models/operations/searchknowledge.js.map +1 -0
  244. package/models/operations/updatechunk.d.ts +229 -0
  245. package/models/operations/updatechunk.d.ts.map +1 -0
  246. package/models/operations/updatechunk.js +236 -0
  247. package/models/operations/updatechunk.js.map +1 -0
  248. package/models/operations/updatedatapoint.js +2 -2
  249. package/models/operations/updatedataset.d.ts +15 -2
  250. package/models/operations/updatedataset.d.ts.map +1 -1
  251. package/models/operations/updatedataset.js +10 -4
  252. package/models/operations/updatedataset.js.map +1 -1
  253. package/models/operations/updatedatasource.d.ts +177 -0
  254. package/models/operations/updatedatasource.d.ts.map +1 -0
  255. package/models/operations/updatedatasource.js +210 -0
  256. package/models/operations/updatedatasource.js.map +1 -0
  257. package/models/operations/updateknowledge.d.ts +380 -0
  258. package/models/operations/updateknowledge.d.ts.map +1 -0
  259. package/models/operations/updateknowledge.js +400 -0
  260. package/models/operations/updateknowledge.js.map +1 -0
  261. package/models/operations/updateprompt.d.ts +41 -12
  262. package/models/operations/updateprompt.d.ts.map +1 -1
  263. package/models/operations/updateprompt.js +14 -4
  264. package/models/operations/updateprompt.js.map +1 -1
  265. package/package.json +2 -3
  266. package/packages/orq-rc/FUNCTIONS.md +106 -0
  267. package/packages/orq-rc/README.md +698 -0
  268. package/packages/orq-rc/RUNTIMES.md +48 -0
  269. package/packages/orq-rc/docs/sdks/contacts/README.md +84 -0
  270. package/packages/orq-rc/docs/sdks/datasets/README.md +940 -0
  271. package/packages/orq-rc/docs/sdks/deployments/README.md +316 -0
  272. package/packages/orq-rc/docs/sdks/feedback/README.md +92 -0
  273. package/packages/orq-rc/docs/sdks/files/README.md +311 -0
  274. package/packages/orq-rc/docs/sdks/knowledge/README.md +1279 -0
  275. package/packages/orq-rc/docs/sdks/metrics/README.md +86 -0
  276. package/packages/orq-rc/docs/sdks/orq/README.md +10 -0
  277. package/packages/orq-rc/docs/sdks/prompts/README.md +614 -0
  278. package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +80 -0
  279. package/packages/orq-rc/jsr.json +28 -0
  280. package/packages/orq-rc/package-lock.json +3217 -0
  281. package/packages/orq-rc/package.json +45 -0
  282. package/packages/orq-rc/src/core.ts +13 -0
  283. package/packages/orq-rc/src/funcs/contactsCreate.ts +154 -0
  284. package/packages/orq-rc/src/funcs/datasetsClear.ts +161 -0
  285. package/packages/orq-rc/src/funcs/datasetsCreate.ts +159 -0
  286. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +161 -0
  287. package/packages/orq-rc/src/funcs/datasetsCreateDatapoints.ts +165 -0
  288. package/packages/orq-rc/src/funcs/datasetsDelete.ts +161 -0
  289. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +176 -0
  290. package/packages/orq-rc/src/funcs/datasetsList.ts +161 -0
  291. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +168 -0
  292. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +169 -0
  293. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +175 -0
  294. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +170 -0
  295. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +173 -0
  296. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +162 -0
  297. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +170 -0
  298. package/packages/orq-rc/src/funcs/deploymentsList.ts +170 -0
  299. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +162 -0
  300. package/packages/orq-rc/src/funcs/deploymentsStream.ts +178 -0
  301. package/packages/orq-rc/src/funcs/feedbackCreate.ts +154 -0
  302. package/packages/orq-rc/src/funcs/filesCreate.ts +174 -0
  303. package/packages/orq-rc/src/funcs/filesDelete.ts +158 -0
  304. package/packages/orq-rc/src/funcs/filesGet.ts +160 -0
  305. package/packages/orq-rc/src/funcs/filesList.ts +161 -0
  306. package/packages/orq-rc/src/funcs/knowledgeCreate.ts +152 -0
  307. package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +165 -0
  308. package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +160 -0
  309. package/packages/orq-rc/src/funcs/knowledgeDelete.ts +161 -0
  310. package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +168 -0
  311. package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +167 -0
  312. package/packages/orq-rc/src/funcs/knowledgeList.ts +163 -0
  313. package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +172 -0
  314. package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +168 -0
  315. package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +160 -0
  316. package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +167 -0
  317. package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +163 -0
  318. package/packages/orq-rc/src/funcs/knowledgeSearch.ts +158 -0
  319. package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +158 -0
  320. package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +168 -0
  321. package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +164 -0
  322. package/packages/orq-rc/src/funcs/promptsCreate.ts +154 -0
  323. package/packages/orq-rc/src/funcs/promptsDelete.ts +158 -0
  324. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +175 -0
  325. package/packages/orq-rc/src/funcs/promptsList.ts +161 -0
  326. package/packages/orq-rc/src/funcs/promptsListVersions.ts +167 -0
  327. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +160 -0
  328. package/packages/orq-rc/src/funcs/promptsUpdate.ts +167 -0
  329. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +155 -0
  330. package/packages/orq-rc/src/hooks/global.ts +44 -0
  331. package/packages/orq-rc/src/hooks/hooks.ts +132 -0
  332. package/packages/orq-rc/src/hooks/index.ts +6 -0
  333. package/packages/orq-rc/src/hooks/registration.ts +15 -0
  334. package/packages/orq-rc/src/hooks/types.ts +110 -0
  335. package/packages/orq-rc/src/index.ts +7 -0
  336. package/packages/orq-rc/src/lib/base64.ts +37 -0
  337. package/packages/orq-rc/src/lib/config.ts +70 -0
  338. package/packages/orq-rc/src/lib/dlv.ts +53 -0
  339. package/packages/orq-rc/src/lib/encodings.ts +483 -0
  340. package/packages/orq-rc/src/lib/env.ts +73 -0
  341. package/packages/orq-rc/src/lib/event-streams.ts +264 -0
  342. package/packages/orq-rc/src/lib/files.ts +40 -0
  343. package/packages/orq-rc/src/lib/http.ts +323 -0
  344. package/packages/orq-rc/src/lib/is-plain-object.ts +43 -0
  345. package/packages/orq-rc/src/lib/logger.ts +9 -0
  346. package/packages/orq-rc/src/lib/matchers.ts +325 -0
  347. package/packages/orq-rc/src/lib/primitives.ts +150 -0
  348. package/packages/orq-rc/src/lib/retries.ts +218 -0
  349. package/packages/orq-rc/src/lib/schemas.ts +91 -0
  350. package/packages/orq-rc/src/lib/sdks.ts +395 -0
  351. package/packages/orq-rc/src/lib/security.ts +261 -0
  352. package/packages/orq-rc/src/lib/url.ts +33 -0
  353. package/packages/orq-rc/src/mcp-server/cli/start/command.ts +125 -0
  354. package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +140 -0
  355. package/packages/orq-rc/src/mcp-server/cli.ts +13 -0
  356. package/packages/orq-rc/src/mcp-server/console-logger.ts +71 -0
  357. package/packages/orq-rc/src/mcp-server/extensions.ts +17 -0
  358. package/packages/orq-rc/src/mcp-server/mcp-server.ts +26 -0
  359. package/packages/orq-rc/src/mcp-server/prompts.ts +110 -0
  360. package/packages/orq-rc/src/mcp-server/resources.ts +158 -0
  361. package/packages/orq-rc/src/mcp-server/scopes.ts +7 -0
  362. package/packages/orq-rc/src/mcp-server/server.ts +157 -0
  363. package/packages/orq-rc/src/mcp-server/shared.ts +75 -0
  364. package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +37 -0
  365. package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +35 -0
  366. package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +37 -0
  367. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +37 -0
  368. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoints.ts +37 -0
  369. package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +35 -0
  370. package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +35 -0
  371. package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +37 -0
  372. package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +37 -0
  373. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +37 -0
  374. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +37 -0
  375. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +37 -0
  376. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +35 -0
  377. package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +37 -0
  378. package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +37 -0
  379. package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +37 -0
  380. package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +37 -0
  381. package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +37 -0
  382. package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +37 -0
  383. package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +37 -0
  384. package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +33 -0
  385. package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +37 -0
  386. package/packages/orq-rc/src/mcp-server/tools/filesList.ts +37 -0
  387. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +35 -0
  388. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +35 -0
  389. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +35 -0
  390. package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +35 -0
  391. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +33 -0
  392. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +35 -0
  393. package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +37 -0
  394. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +35 -0
  395. package/packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts +35 -0
  396. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +37 -0
  397. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +35 -0
  398. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +35 -0
  399. package/packages/orq-rc/src/mcp-server/tools/knowledgeSearch.ts +35 -0
  400. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +35 -0
  401. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +35 -0
  402. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +35 -0
  403. package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +35 -0
  404. package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +33 -0
  405. package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +37 -0
  406. package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +37 -0
  407. package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +37 -0
  408. package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +37 -0
  409. package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +35 -0
  410. package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +36 -0
  411. package/packages/orq-rc/src/mcp-server/tools.ts +126 -0
  412. package/packages/orq-rc/src/models/components/deployments.ts +4164 -0
  413. package/packages/orq-rc/src/models/components/index.ts +6 -0
  414. package/packages/orq-rc/src/models/components/security.ts +71 -0
  415. package/packages/orq-rc/src/models/errors/apierror.ts +27 -0
  416. package/packages/orq-rc/src/models/errors/getpromptversion.ts +71 -0
  417. package/packages/orq-rc/src/models/errors/honoapierror.ts +82 -0
  418. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +62 -0
  419. package/packages/orq-rc/src/models/errors/index.ts +10 -0
  420. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +97 -0
  421. package/packages/orq-rc/src/models/errors/updateprompt.ts +71 -0
  422. package/packages/orq-rc/src/models/operations/bulkcreatedatapoints.ts +1816 -0
  423. package/packages/orq-rc/src/models/operations/cleardataset.ts +75 -0
  424. package/packages/orq-rc/src/models/operations/createchunk.ts +680 -0
  425. package/packages/orq-rc/src/models/operations/createcontact.ts +256 -0
  426. package/packages/orq-rc/src/models/operations/createdataset.ts +296 -0
  427. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +1740 -0
  428. package/packages/orq-rc/src/models/operations/createdatasource.ts +852 -0
  429. package/packages/orq-rc/src/models/operations/createfeedback.ts +286 -0
  430. package/packages/orq-rc/src/models/operations/createknowledge.ts +676 -0
  431. package/packages/orq-rc/src/models/operations/createprompt.ts +3743 -0
  432. package/packages/orq-rc/src/models/operations/deletechunk.ts +96 -0
  433. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +81 -0
  434. package/packages/orq-rc/src/models/operations/deletedataset.ts +75 -0
  435. package/packages/orq-rc/src/models/operations/deletedatasource.ts +87 -0
  436. package/packages/orq-rc/src/models/operations/deleteknowledge.ts +78 -0
  437. package/packages/orq-rc/src/models/operations/deleteprompt.ts +69 -0
  438. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +4936 -0
  439. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +6090 -0
  440. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +1199 -0
  441. package/packages/orq-rc/src/models/operations/deployments.ts +2155 -0
  442. package/packages/orq-rc/src/models/operations/deploymentstream.ts +5960 -0
  443. package/packages/orq-rc/src/models/operations/filedelete.ts +78 -0
  444. package/packages/orq-rc/src/models/operations/fileget.ts +223 -0
  445. package/packages/orq-rc/src/models/operations/filelist.ts +337 -0
  446. package/packages/orq-rc/src/models/operations/fileupload.ts +324 -0
  447. package/packages/orq-rc/src/models/operations/getallprompts.ts +2127 -0
  448. package/packages/orq-rc/src/models/operations/getonechunk.ts +265 -0
  449. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +444 -0
  450. package/packages/orq-rc/src/models/operations/getoneprompt.ts +1993 -0
  451. package/packages/orq-rc/src/models/operations/getpromptversion.ts +1991 -0
  452. package/packages/orq-rc/src/models/operations/index.ts +51 -0
  453. package/packages/orq-rc/src/models/operations/listchunks.ts +444 -0
  454. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +1071 -0
  455. package/packages/orq-rc/src/models/operations/listdatasets.ts +406 -0
  456. package/packages/orq-rc/src/models/operations/listdatasources.ts +447 -0
  457. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +568 -0
  458. package/packages/orq-rc/src/models/operations/listpromptversions.ts +2125 -0
  459. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +190 -0
  460. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +924 -0
  461. package/packages/orq-rc/src/models/operations/retrievedataset.ts +288 -0
  462. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +273 -0
  463. package/packages/orq-rc/src/models/operations/searchknowledge.ts +1673 -0
  464. package/packages/orq-rc/src/models/operations/updatechunk.ts +418 -0
  465. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +1729 -0
  466. package/packages/orq-rc/src/models/operations/updatedataset.ts +393 -0
  467. package/packages/orq-rc/src/models/operations/updatedatasource.ts +345 -0
  468. package/packages/orq-rc/src/models/operations/updateknowledge.ts +790 -0
  469. package/packages/orq-rc/src/models/operations/updateprompt.ts +3929 -0
  470. package/packages/orq-rc/src/sdk/contacts.ts +27 -0
  471. package/packages/orq-rc/src/sdk/datasets.ts +222 -0
  472. package/packages/orq-rc/src/sdk/deployments.ts +89 -0
  473. package/packages/orq-rc/src/sdk/feedback.ts +27 -0
  474. package/packages/orq-rc/src/sdk/files.ts +78 -0
  475. package/packages/orq-rc/src/sdk/index.ts +5 -0
  476. package/packages/orq-rc/src/sdk/knowledge.ts +261 -0
  477. package/packages/orq-rc/src/sdk/metrics.ts +27 -0
  478. package/packages/orq-rc/src/sdk/prompts.ts +126 -0
  479. package/packages/orq-rc/src/sdk/remoteconfigs.ts +24 -0
  480. package/packages/orq-rc/src/sdk/sdk.ts +55 -0
  481. package/packages/orq-rc/src/types/async.ts +68 -0
  482. package/packages/orq-rc/src/types/blobs.ts +31 -0
  483. package/packages/orq-rc/src/types/constdatetime.ts +15 -0
  484. package/packages/orq-rc/src/types/enums.ts +16 -0
  485. package/packages/orq-rc/src/types/fp.ts +50 -0
  486. package/packages/orq-rc/src/types/index.ts +11 -0
  487. package/packages/orq-rc/src/types/operations.ts +105 -0
  488. package/packages/orq-rc/src/types/rfcdate.ts +54 -0
  489. package/packages/orq-rc/src/types/streams.ts +21 -0
  490. package/packages/orq-rc/tsconfig.json +41 -0
  491. package/sdk/files.d.ts +1 -1
  492. package/sdk/files.d.ts.map +1 -1
  493. package/sdk/files.js.map +1 -1
  494. package/sdk/knowledge.d.ts +81 -0
  495. package/sdk/knowledge.d.ts.map +1 -0
  496. package/sdk/knowledge.js +136 -0
  497. package/sdk/knowledge.js.map +1 -0
  498. package/sdk/sdk.d.ts +3 -0
  499. package/sdk/sdk.d.ts.map +1 -1
  500. package/sdk/sdk.js +4 -0
  501. package/sdk/sdk.js.map +1 -1
  502. package/src/funcs/filesCreate.ts +18 -21
  503. package/src/funcs/knowledgeCreate.ts +152 -0
  504. package/src/funcs/knowledgeCreateChunks.ts +165 -0
  505. package/src/funcs/knowledgeCreateDatasource.ts +160 -0
  506. package/src/funcs/knowledgeDelete.ts +161 -0
  507. package/src/funcs/knowledgeDeleteChunk.ts +168 -0
  508. package/src/funcs/knowledgeDeleteDatasource.ts +167 -0
  509. package/src/funcs/knowledgeList.ts +163 -0
  510. package/src/funcs/knowledgeListChunks.ts +172 -0
  511. package/src/funcs/knowledgeListDatasources.ts +168 -0
  512. package/src/funcs/knowledgeRetrieve.ts +160 -0
  513. package/src/funcs/knowledgeRetrieveChunk.ts +167 -0
  514. package/src/funcs/knowledgeRetrieveDatasource.ts +163 -0
  515. package/src/funcs/knowledgeSearch.ts +158 -0
  516. package/src/funcs/knowledgeUpdate.ts +158 -0
  517. package/src/funcs/knowledgeUpdateChunk.ts +168 -0
  518. package/src/funcs/knowledgeUpdateDatasource.ts +164 -0
  519. package/src/hooks/types.ts +1 -1
  520. package/src/lib/config.ts +3 -3
  521. package/src/mcp-server/mcp-server.ts +1 -1
  522. package/src/mcp-server/server.ts +33 -1
  523. package/src/mcp-server/tools/filesCreate.ts +1 -1
  524. package/src/mcp-server/tools/knowledgeCreate.ts +35 -0
  525. package/src/mcp-server/tools/knowledgeCreateChunks.ts +35 -0
  526. package/src/mcp-server/tools/knowledgeCreateDatasource.ts +35 -0
  527. package/src/mcp-server/tools/knowledgeDelete.ts +35 -0
  528. package/src/mcp-server/tools/knowledgeDeleteChunk.ts +33 -0
  529. package/src/mcp-server/tools/knowledgeDeleteDatasource.ts +35 -0
  530. package/src/mcp-server/tools/knowledgeList.ts +37 -0
  531. package/src/mcp-server/tools/knowledgeListChunks.ts +35 -0
  532. package/src/mcp-server/tools/knowledgeListDatasources.ts +35 -0
  533. package/src/mcp-server/tools/knowledgeRetrieve.ts +37 -0
  534. package/src/mcp-server/tools/knowledgeRetrieveChunk.ts +35 -0
  535. package/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +35 -0
  536. package/src/mcp-server/tools/knowledgeSearch.ts +35 -0
  537. package/src/mcp-server/tools/knowledgeUpdate.ts +35 -0
  538. package/src/mcp-server/tools/knowledgeUpdateChunk.ts +35 -0
  539. package/src/mcp-server/tools/knowledgeUpdateDatasource.ts +35 -0
  540. package/src/models/operations/bulkcreatedatapoints.ts +2 -2
  541. package/src/models/operations/createchunk.ts +680 -0
  542. package/src/models/operations/createcontact.ts +2 -2
  543. package/src/models/operations/createdataset.ts +2 -2
  544. package/src/models/operations/createdatasetitem.ts +2 -2
  545. package/src/models/operations/createdatasource.ts +852 -0
  546. package/src/models/operations/createknowledge.ts +676 -0
  547. package/src/models/operations/createprompt.ts +12 -4
  548. package/src/models/operations/deletechunk.ts +96 -0
  549. package/src/models/operations/deletedatasource.ts +87 -0
  550. package/src/models/operations/deleteknowledge.ts +78 -0
  551. package/src/models/operations/fileget.ts +2 -2
  552. package/src/models/operations/filelist.ts +2 -2
  553. package/src/models/operations/fileupload.ts +6 -6
  554. package/src/models/operations/getallprompts.ts +6 -2
  555. package/src/models/operations/getonechunk.ts +265 -0
  556. package/src/models/operations/getoneknowledge.ts +444 -0
  557. package/src/models/operations/getoneprompt.ts +6 -2
  558. package/src/models/operations/getpromptversion.ts +6 -2
  559. package/src/models/operations/index.ts +16 -0
  560. package/src/models/operations/listchunks.ts +444 -0
  561. package/src/models/operations/listdatasetdatapoints.ts +2 -2
  562. package/src/models/operations/listdatasets.ts +2 -2
  563. package/src/models/operations/listdatasources.ts +447 -0
  564. package/src/models/operations/listknowledgebases.ts +568 -0
  565. package/src/models/operations/listpromptversions.ts +6 -2
  566. package/src/models/operations/retrievedatapoint.ts +2 -2
  567. package/src/models/operations/retrievedataset.ts +2 -2
  568. package/src/models/operations/retrievedatasource.ts +273 -0
  569. package/src/models/operations/searchknowledge.ts +1673 -0
  570. package/src/models/operations/updatechunk.ts +418 -0
  571. package/src/models/operations/updatedatapoint.ts +2 -2
  572. package/src/models/operations/updatedataset.ts +25 -6
  573. package/src/models/operations/updatedatasource.ts +345 -0
  574. package/src/models/operations/updateknowledge.ts +790 -0
  575. package/src/models/operations/updateprompt.ts +19 -4
  576. package/src/sdk/files.ts +1 -1
  577. package/src/sdk/knowledge.ts +261 -0
  578. package/src/sdk/sdk.ts +6 -0
@@ -0,0 +1,265 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { ClosedEnum } from "../../types/enums.js";
9
+ import { Result as SafeParseResult } from "../../types/fp.js";
10
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+
12
+ export type GetOneChunkRequest = {
13
+ /**
14
+ * The unique identifier of the chunk
15
+ */
16
+ chunkId: string;
17
+ /**
18
+ * The unique identifier of the data source
19
+ */
20
+ datasourceId: string;
21
+ /**
22
+ * The unique identifier of the knowledge base
23
+ */
24
+ knowledgeId: string;
25
+ };
26
+
27
+ /**
28
+ * The status of the chunk
29
+ */
30
+ export const GetOneChunkStatus = {
31
+ Pending: "pending",
32
+ Processing: "processing",
33
+ Completed: "completed",
34
+ Failed: "failed",
35
+ Queued: "queued",
36
+ } as const;
37
+ /**
38
+ * The status of the chunk
39
+ */
40
+ export type GetOneChunkStatus = ClosedEnum<typeof GetOneChunkStatus>;
41
+
42
+ /**
43
+ * Chunk successfully retrieved
44
+ */
45
+ export type GetOneChunkResponseBody = {
46
+ /**
47
+ * The unique identifier of the chunk
48
+ */
49
+ id: string;
50
+ /**
51
+ * The text content of the chunk
52
+ */
53
+ text: string;
54
+ /**
55
+ * Metadata of the chunk. Can include `page_number` or any other key-value pairs. Only values of type string are supported.
56
+ */
57
+ metadata?: { [k: string]: string } | undefined;
58
+ /**
59
+ * Whether the chunk is enabled
60
+ */
61
+ enabled: boolean;
62
+ /**
63
+ * The status of the chunk
64
+ */
65
+ status: GetOneChunkStatus;
66
+ /**
67
+ * The date and time the chunk was created
68
+ */
69
+ created: string;
70
+ /**
71
+ * The date and time the chunk was updated
72
+ */
73
+ updated: string;
74
+ /**
75
+ * The unique identifier of the user who created the chunk
76
+ */
77
+ createdById?: string | undefined;
78
+ /**
79
+ * The unique identifier of the user who updated the chunk
80
+ */
81
+ updateById?: string | undefined;
82
+ };
83
+
84
+ /** @internal */
85
+ export const GetOneChunkRequest$inboundSchema: z.ZodType<
86
+ GetOneChunkRequest,
87
+ z.ZodTypeDef,
88
+ unknown
89
+ > = z.object({
90
+ chunk_id: z.string(),
91
+ datasource_id: z.string(),
92
+ knowledge_id: z.string(),
93
+ }).transform((v) => {
94
+ return remap$(v, {
95
+ "chunk_id": "chunkId",
96
+ "datasource_id": "datasourceId",
97
+ "knowledge_id": "knowledgeId",
98
+ });
99
+ });
100
+
101
+ /** @internal */
102
+ export type GetOneChunkRequest$Outbound = {
103
+ chunk_id: string;
104
+ datasource_id: string;
105
+ knowledge_id: string;
106
+ };
107
+
108
+ /** @internal */
109
+ export const GetOneChunkRequest$outboundSchema: z.ZodType<
110
+ GetOneChunkRequest$Outbound,
111
+ z.ZodTypeDef,
112
+ GetOneChunkRequest
113
+ > = z.object({
114
+ chunkId: z.string(),
115
+ datasourceId: z.string(),
116
+ knowledgeId: z.string(),
117
+ }).transform((v) => {
118
+ return remap$(v, {
119
+ chunkId: "chunk_id",
120
+ datasourceId: "datasource_id",
121
+ knowledgeId: "knowledge_id",
122
+ });
123
+ });
124
+
125
+ /**
126
+ * @internal
127
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
128
+ */
129
+ export namespace GetOneChunkRequest$ {
130
+ /** @deprecated use `GetOneChunkRequest$inboundSchema` instead. */
131
+ export const inboundSchema = GetOneChunkRequest$inboundSchema;
132
+ /** @deprecated use `GetOneChunkRequest$outboundSchema` instead. */
133
+ export const outboundSchema = GetOneChunkRequest$outboundSchema;
134
+ /** @deprecated use `GetOneChunkRequest$Outbound` instead. */
135
+ export type Outbound = GetOneChunkRequest$Outbound;
136
+ }
137
+
138
+ export function getOneChunkRequestToJSON(
139
+ getOneChunkRequest: GetOneChunkRequest,
140
+ ): string {
141
+ return JSON.stringify(
142
+ GetOneChunkRequest$outboundSchema.parse(getOneChunkRequest),
143
+ );
144
+ }
145
+
146
+ export function getOneChunkRequestFromJSON(
147
+ jsonString: string,
148
+ ): SafeParseResult<GetOneChunkRequest, SDKValidationError> {
149
+ return safeParse(
150
+ jsonString,
151
+ (x) => GetOneChunkRequest$inboundSchema.parse(JSON.parse(x)),
152
+ `Failed to parse 'GetOneChunkRequest' from JSON`,
153
+ );
154
+ }
155
+
156
+ /** @internal */
157
+ export const GetOneChunkStatus$inboundSchema: z.ZodNativeEnum<
158
+ typeof GetOneChunkStatus
159
+ > = z.nativeEnum(GetOneChunkStatus);
160
+
161
+ /** @internal */
162
+ export const GetOneChunkStatus$outboundSchema: z.ZodNativeEnum<
163
+ typeof GetOneChunkStatus
164
+ > = GetOneChunkStatus$inboundSchema;
165
+
166
+ /**
167
+ * @internal
168
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
169
+ */
170
+ export namespace GetOneChunkStatus$ {
171
+ /** @deprecated use `GetOneChunkStatus$inboundSchema` instead. */
172
+ export const inboundSchema = GetOneChunkStatus$inboundSchema;
173
+ /** @deprecated use `GetOneChunkStatus$outboundSchema` instead. */
174
+ export const outboundSchema = GetOneChunkStatus$outboundSchema;
175
+ }
176
+
177
+ /** @internal */
178
+ export const GetOneChunkResponseBody$inboundSchema: z.ZodType<
179
+ GetOneChunkResponseBody,
180
+ z.ZodTypeDef,
181
+ unknown
182
+ > = z.object({
183
+ _id: z.string(),
184
+ text: z.string(),
185
+ metadata: z.record(z.string()).optional(),
186
+ enabled: z.boolean(),
187
+ status: GetOneChunkStatus$inboundSchema,
188
+ created: z.string(),
189
+ updated: z.string(),
190
+ created_by_id: z.string().optional(),
191
+ update_by_id: z.string().optional(),
192
+ }).transform((v) => {
193
+ return remap$(v, {
194
+ "_id": "id",
195
+ "created_by_id": "createdById",
196
+ "update_by_id": "updateById",
197
+ });
198
+ });
199
+
200
+ /** @internal */
201
+ export type GetOneChunkResponseBody$Outbound = {
202
+ _id: string;
203
+ text: string;
204
+ metadata?: { [k: string]: string } | undefined;
205
+ enabled: boolean;
206
+ status: string;
207
+ created: string;
208
+ updated: string;
209
+ created_by_id?: string | undefined;
210
+ update_by_id?: string | undefined;
211
+ };
212
+
213
+ /** @internal */
214
+ export const GetOneChunkResponseBody$outboundSchema: z.ZodType<
215
+ GetOneChunkResponseBody$Outbound,
216
+ z.ZodTypeDef,
217
+ GetOneChunkResponseBody
218
+ > = z.object({
219
+ id: z.string(),
220
+ text: z.string(),
221
+ metadata: z.record(z.string()).optional(),
222
+ enabled: z.boolean(),
223
+ status: GetOneChunkStatus$outboundSchema,
224
+ created: z.string(),
225
+ updated: z.string(),
226
+ createdById: z.string().optional(),
227
+ updateById: z.string().optional(),
228
+ }).transform((v) => {
229
+ return remap$(v, {
230
+ id: "_id",
231
+ createdById: "created_by_id",
232
+ updateById: "update_by_id",
233
+ });
234
+ });
235
+
236
+ /**
237
+ * @internal
238
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
239
+ */
240
+ export namespace GetOneChunkResponseBody$ {
241
+ /** @deprecated use `GetOneChunkResponseBody$inboundSchema` instead. */
242
+ export const inboundSchema = GetOneChunkResponseBody$inboundSchema;
243
+ /** @deprecated use `GetOneChunkResponseBody$outboundSchema` instead. */
244
+ export const outboundSchema = GetOneChunkResponseBody$outboundSchema;
245
+ /** @deprecated use `GetOneChunkResponseBody$Outbound` instead. */
246
+ export type Outbound = GetOneChunkResponseBody$Outbound;
247
+ }
248
+
249
+ export function getOneChunkResponseBodyToJSON(
250
+ getOneChunkResponseBody: GetOneChunkResponseBody,
251
+ ): string {
252
+ return JSON.stringify(
253
+ GetOneChunkResponseBody$outboundSchema.parse(getOneChunkResponseBody),
254
+ );
255
+ }
256
+
257
+ export function getOneChunkResponseBodyFromJSON(
258
+ jsonString: string,
259
+ ): SafeParseResult<GetOneChunkResponseBody, SDKValidationError> {
260
+ return safeParse(
261
+ jsonString,
262
+ (x) => GetOneChunkResponseBody$inboundSchema.parse(JSON.parse(x)),
263
+ `Failed to parse 'GetOneChunkResponseBody' from JSON`,
264
+ );
265
+ }
@@ -0,0 +1,444 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { ClosedEnum } from "../../types/enums.js";
9
+ import { Result as SafeParseResult } from "../../types/fp.js";
10
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+
12
+ export type GetOneKnowledgeRequest = {
13
+ /**
14
+ * Unique identifier of the knowledge base
15
+ */
16
+ knowledgeId: string;
17
+ };
18
+
19
+ /**
20
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
21
+ */
22
+ export const GetOneKnowledgeRetrievalType = {
23
+ VectorSearch: "vector_search",
24
+ KeywordSearch: "keyword_search",
25
+ HybridSearch: "hybrid_search",
26
+ } as const;
27
+ /**
28
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
29
+ */
30
+ export type GetOneKnowledgeRetrievalType = ClosedEnum<
31
+ typeof GetOneKnowledgeRetrievalType
32
+ >;
33
+
34
+ /**
35
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
36
+ */
37
+ export type GetOneKnowledgeRerankConfig = {
38
+ /**
39
+ * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
40
+ */
41
+ rerankThreshold?: number | undefined;
42
+ /**
43
+ * The rerank model to use for the knowledge base.
44
+ */
45
+ rerankModel: string;
46
+ };
47
+
48
+ /**
49
+ * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
50
+ */
51
+ export type GetOneKnowledgeRetrievalSettings = {
52
+ /**
53
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
54
+ */
55
+ retrievalType?: GetOneKnowledgeRetrievalType | undefined;
56
+ /**
57
+ * The number of results to return from the search.
58
+ */
59
+ topK?: number | undefined;
60
+ /**
61
+ * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
62
+ */
63
+ threshold?: number | undefined;
64
+ /**
65
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
66
+ */
67
+ rerankConfig?: GetOneKnowledgeRerankConfig | undefined;
68
+ };
69
+
70
+ /**
71
+ * Knowledge Base object
72
+ */
73
+ export type GetOneKnowledgeResponseBody = {
74
+ /**
75
+ * The unique identifier of the knowledge base.
76
+ */
77
+ id: string;
78
+ /**
79
+ * The creation date of the knowledge base.
80
+ */
81
+ created: string;
82
+ /**
83
+ * The description of the knowledge base.
84
+ */
85
+ description?: string | undefined;
86
+ /**
87
+ * The unique key of the knowledge base.
88
+ */
89
+ key: string;
90
+ /**
91
+ * The embeddings model used for the knowledge base.
92
+ */
93
+ model: string;
94
+ /**
95
+ * The path where the entity is stored in the project structure. The first element of the path always represents the project name. Any subsequent path element after the project will be created as a folder in the project if it does not exists.
96
+ */
97
+ path?: string | undefined;
98
+ /**
99
+ * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
100
+ */
101
+ retrievalSettings?: GetOneKnowledgeRetrievalSettings | undefined;
102
+ createdById?: string | null | undefined;
103
+ updatedById?: string | null | undefined;
104
+ /**
105
+ * The last update date of the knowledge base.
106
+ */
107
+ updated: string;
108
+ };
109
+
110
+ /** @internal */
111
+ export const GetOneKnowledgeRequest$inboundSchema: z.ZodType<
112
+ GetOneKnowledgeRequest,
113
+ z.ZodTypeDef,
114
+ unknown
115
+ > = z.object({
116
+ knowledge_id: z.string(),
117
+ }).transform((v) => {
118
+ return remap$(v, {
119
+ "knowledge_id": "knowledgeId",
120
+ });
121
+ });
122
+
123
+ /** @internal */
124
+ export type GetOneKnowledgeRequest$Outbound = {
125
+ knowledge_id: string;
126
+ };
127
+
128
+ /** @internal */
129
+ export const GetOneKnowledgeRequest$outboundSchema: z.ZodType<
130
+ GetOneKnowledgeRequest$Outbound,
131
+ z.ZodTypeDef,
132
+ GetOneKnowledgeRequest
133
+ > = z.object({
134
+ knowledgeId: z.string(),
135
+ }).transform((v) => {
136
+ return remap$(v, {
137
+ knowledgeId: "knowledge_id",
138
+ });
139
+ });
140
+
141
+ /**
142
+ * @internal
143
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
144
+ */
145
+ export namespace GetOneKnowledgeRequest$ {
146
+ /** @deprecated use `GetOneKnowledgeRequest$inboundSchema` instead. */
147
+ export const inboundSchema = GetOneKnowledgeRequest$inboundSchema;
148
+ /** @deprecated use `GetOneKnowledgeRequest$outboundSchema` instead. */
149
+ export const outboundSchema = GetOneKnowledgeRequest$outboundSchema;
150
+ /** @deprecated use `GetOneKnowledgeRequest$Outbound` instead. */
151
+ export type Outbound = GetOneKnowledgeRequest$Outbound;
152
+ }
153
+
154
+ export function getOneKnowledgeRequestToJSON(
155
+ getOneKnowledgeRequest: GetOneKnowledgeRequest,
156
+ ): string {
157
+ return JSON.stringify(
158
+ GetOneKnowledgeRequest$outboundSchema.parse(getOneKnowledgeRequest),
159
+ );
160
+ }
161
+
162
+ export function getOneKnowledgeRequestFromJSON(
163
+ jsonString: string,
164
+ ): SafeParseResult<GetOneKnowledgeRequest, SDKValidationError> {
165
+ return safeParse(
166
+ jsonString,
167
+ (x) => GetOneKnowledgeRequest$inboundSchema.parse(JSON.parse(x)),
168
+ `Failed to parse 'GetOneKnowledgeRequest' from JSON`,
169
+ );
170
+ }
171
+
172
+ /** @internal */
173
+ export const GetOneKnowledgeRetrievalType$inboundSchema: z.ZodNativeEnum<
174
+ typeof GetOneKnowledgeRetrievalType
175
+ > = z.nativeEnum(GetOneKnowledgeRetrievalType);
176
+
177
+ /** @internal */
178
+ export const GetOneKnowledgeRetrievalType$outboundSchema: z.ZodNativeEnum<
179
+ typeof GetOneKnowledgeRetrievalType
180
+ > = GetOneKnowledgeRetrievalType$inboundSchema;
181
+
182
+ /**
183
+ * @internal
184
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
185
+ */
186
+ export namespace GetOneKnowledgeRetrievalType$ {
187
+ /** @deprecated use `GetOneKnowledgeRetrievalType$inboundSchema` instead. */
188
+ export const inboundSchema = GetOneKnowledgeRetrievalType$inboundSchema;
189
+ /** @deprecated use `GetOneKnowledgeRetrievalType$outboundSchema` instead. */
190
+ export const outboundSchema = GetOneKnowledgeRetrievalType$outboundSchema;
191
+ }
192
+
193
+ /** @internal */
194
+ export const GetOneKnowledgeRerankConfig$inboundSchema: z.ZodType<
195
+ GetOneKnowledgeRerankConfig,
196
+ z.ZodTypeDef,
197
+ unknown
198
+ > = z.object({
199
+ rerank_threshold: z.number().default(0.5),
200
+ rerank_model: z.string(),
201
+ }).transform((v) => {
202
+ return remap$(v, {
203
+ "rerank_threshold": "rerankThreshold",
204
+ "rerank_model": "rerankModel",
205
+ });
206
+ });
207
+
208
+ /** @internal */
209
+ export type GetOneKnowledgeRerankConfig$Outbound = {
210
+ rerank_threshold: number;
211
+ rerank_model: string;
212
+ };
213
+
214
+ /** @internal */
215
+ export const GetOneKnowledgeRerankConfig$outboundSchema: z.ZodType<
216
+ GetOneKnowledgeRerankConfig$Outbound,
217
+ z.ZodTypeDef,
218
+ GetOneKnowledgeRerankConfig
219
+ > = z.object({
220
+ rerankThreshold: z.number().default(0.5),
221
+ rerankModel: z.string(),
222
+ }).transform((v) => {
223
+ return remap$(v, {
224
+ rerankThreshold: "rerank_threshold",
225
+ rerankModel: "rerank_model",
226
+ });
227
+ });
228
+
229
+ /**
230
+ * @internal
231
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
232
+ */
233
+ export namespace GetOneKnowledgeRerankConfig$ {
234
+ /** @deprecated use `GetOneKnowledgeRerankConfig$inboundSchema` instead. */
235
+ export const inboundSchema = GetOneKnowledgeRerankConfig$inboundSchema;
236
+ /** @deprecated use `GetOneKnowledgeRerankConfig$outboundSchema` instead. */
237
+ export const outboundSchema = GetOneKnowledgeRerankConfig$outboundSchema;
238
+ /** @deprecated use `GetOneKnowledgeRerankConfig$Outbound` instead. */
239
+ export type Outbound = GetOneKnowledgeRerankConfig$Outbound;
240
+ }
241
+
242
+ export function getOneKnowledgeRerankConfigToJSON(
243
+ getOneKnowledgeRerankConfig: GetOneKnowledgeRerankConfig,
244
+ ): string {
245
+ return JSON.stringify(
246
+ GetOneKnowledgeRerankConfig$outboundSchema.parse(
247
+ getOneKnowledgeRerankConfig,
248
+ ),
249
+ );
250
+ }
251
+
252
+ export function getOneKnowledgeRerankConfigFromJSON(
253
+ jsonString: string,
254
+ ): SafeParseResult<GetOneKnowledgeRerankConfig, SDKValidationError> {
255
+ return safeParse(
256
+ jsonString,
257
+ (x) => GetOneKnowledgeRerankConfig$inboundSchema.parse(JSON.parse(x)),
258
+ `Failed to parse 'GetOneKnowledgeRerankConfig' from JSON`,
259
+ );
260
+ }
261
+
262
+ /** @internal */
263
+ export const GetOneKnowledgeRetrievalSettings$inboundSchema: z.ZodType<
264
+ GetOneKnowledgeRetrievalSettings,
265
+ z.ZodTypeDef,
266
+ unknown
267
+ > = z.object({
268
+ retrieval_type: GetOneKnowledgeRetrievalType$inboundSchema.default(
269
+ "hybrid_search",
270
+ ),
271
+ top_k: z.number().int().default(5),
272
+ threshold: z.number().default(0),
273
+ rerank_config: z.lazy(() => GetOneKnowledgeRerankConfig$inboundSchema)
274
+ .optional(),
275
+ }).transform((v) => {
276
+ return remap$(v, {
277
+ "retrieval_type": "retrievalType",
278
+ "top_k": "topK",
279
+ "rerank_config": "rerankConfig",
280
+ });
281
+ });
282
+
283
+ /** @internal */
284
+ export type GetOneKnowledgeRetrievalSettings$Outbound = {
285
+ retrieval_type: string;
286
+ top_k: number;
287
+ threshold: number;
288
+ rerank_config?: GetOneKnowledgeRerankConfig$Outbound | undefined;
289
+ };
290
+
291
+ /** @internal */
292
+ export const GetOneKnowledgeRetrievalSettings$outboundSchema: z.ZodType<
293
+ GetOneKnowledgeRetrievalSettings$Outbound,
294
+ z.ZodTypeDef,
295
+ GetOneKnowledgeRetrievalSettings
296
+ > = z.object({
297
+ retrievalType: GetOneKnowledgeRetrievalType$outboundSchema.default(
298
+ "hybrid_search",
299
+ ),
300
+ topK: z.number().int().default(5),
301
+ threshold: z.number().default(0),
302
+ rerankConfig: z.lazy(() => GetOneKnowledgeRerankConfig$outboundSchema)
303
+ .optional(),
304
+ }).transform((v) => {
305
+ return remap$(v, {
306
+ retrievalType: "retrieval_type",
307
+ topK: "top_k",
308
+ rerankConfig: "rerank_config",
309
+ });
310
+ });
311
+
312
+ /**
313
+ * @internal
314
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
315
+ */
316
+ export namespace GetOneKnowledgeRetrievalSettings$ {
317
+ /** @deprecated use `GetOneKnowledgeRetrievalSettings$inboundSchema` instead. */
318
+ export const inboundSchema = GetOneKnowledgeRetrievalSettings$inboundSchema;
319
+ /** @deprecated use `GetOneKnowledgeRetrievalSettings$outboundSchema` instead. */
320
+ export const outboundSchema = GetOneKnowledgeRetrievalSettings$outboundSchema;
321
+ /** @deprecated use `GetOneKnowledgeRetrievalSettings$Outbound` instead. */
322
+ export type Outbound = GetOneKnowledgeRetrievalSettings$Outbound;
323
+ }
324
+
325
+ export function getOneKnowledgeRetrievalSettingsToJSON(
326
+ getOneKnowledgeRetrievalSettings: GetOneKnowledgeRetrievalSettings,
327
+ ): string {
328
+ return JSON.stringify(
329
+ GetOneKnowledgeRetrievalSettings$outboundSchema.parse(
330
+ getOneKnowledgeRetrievalSettings,
331
+ ),
332
+ );
333
+ }
334
+
335
+ export function getOneKnowledgeRetrievalSettingsFromJSON(
336
+ jsonString: string,
337
+ ): SafeParseResult<GetOneKnowledgeRetrievalSettings, SDKValidationError> {
338
+ return safeParse(
339
+ jsonString,
340
+ (x) => GetOneKnowledgeRetrievalSettings$inboundSchema.parse(JSON.parse(x)),
341
+ `Failed to parse 'GetOneKnowledgeRetrievalSettings' from JSON`,
342
+ );
343
+ }
344
+
345
+ /** @internal */
346
+ export const GetOneKnowledgeResponseBody$inboundSchema: z.ZodType<
347
+ GetOneKnowledgeResponseBody,
348
+ z.ZodTypeDef,
349
+ unknown
350
+ > = z.object({
351
+ _id: z.string(),
352
+ created: z.string(),
353
+ description: z.string().optional(),
354
+ key: z.string(),
355
+ model: z.string(),
356
+ path: z.string().optional(),
357
+ retrieval_settings: z.lazy(() =>
358
+ GetOneKnowledgeRetrievalSettings$inboundSchema
359
+ ).optional(),
360
+ created_by_id: z.nullable(z.string()).optional(),
361
+ updated_by_id: z.nullable(z.string()).optional(),
362
+ updated: z.string(),
363
+ }).transform((v) => {
364
+ return remap$(v, {
365
+ "_id": "id",
366
+ "retrieval_settings": "retrievalSettings",
367
+ "created_by_id": "createdById",
368
+ "updated_by_id": "updatedById",
369
+ });
370
+ });
371
+
372
+ /** @internal */
373
+ export type GetOneKnowledgeResponseBody$Outbound = {
374
+ _id: string;
375
+ created: string;
376
+ description?: string | undefined;
377
+ key: string;
378
+ model: string;
379
+ path?: string | undefined;
380
+ retrieval_settings?: GetOneKnowledgeRetrievalSettings$Outbound | undefined;
381
+ created_by_id?: string | null | undefined;
382
+ updated_by_id?: string | null | undefined;
383
+ updated: string;
384
+ };
385
+
386
+ /** @internal */
387
+ export const GetOneKnowledgeResponseBody$outboundSchema: z.ZodType<
388
+ GetOneKnowledgeResponseBody$Outbound,
389
+ z.ZodTypeDef,
390
+ GetOneKnowledgeResponseBody
391
+ > = z.object({
392
+ id: z.string(),
393
+ created: z.string(),
394
+ description: z.string().optional(),
395
+ key: z.string(),
396
+ model: z.string(),
397
+ path: z.string().optional(),
398
+ retrievalSettings: z.lazy(() =>
399
+ GetOneKnowledgeRetrievalSettings$outboundSchema
400
+ ).optional(),
401
+ createdById: z.nullable(z.string()).optional(),
402
+ updatedById: z.nullable(z.string()).optional(),
403
+ updated: z.string(),
404
+ }).transform((v) => {
405
+ return remap$(v, {
406
+ id: "_id",
407
+ retrievalSettings: "retrieval_settings",
408
+ createdById: "created_by_id",
409
+ updatedById: "updated_by_id",
410
+ });
411
+ });
412
+
413
+ /**
414
+ * @internal
415
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
416
+ */
417
+ export namespace GetOneKnowledgeResponseBody$ {
418
+ /** @deprecated use `GetOneKnowledgeResponseBody$inboundSchema` instead. */
419
+ export const inboundSchema = GetOneKnowledgeResponseBody$inboundSchema;
420
+ /** @deprecated use `GetOneKnowledgeResponseBody$outboundSchema` instead. */
421
+ export const outboundSchema = GetOneKnowledgeResponseBody$outboundSchema;
422
+ /** @deprecated use `GetOneKnowledgeResponseBody$Outbound` instead. */
423
+ export type Outbound = GetOneKnowledgeResponseBody$Outbound;
424
+ }
425
+
426
+ export function getOneKnowledgeResponseBodyToJSON(
427
+ getOneKnowledgeResponseBody: GetOneKnowledgeResponseBody,
428
+ ): string {
429
+ return JSON.stringify(
430
+ GetOneKnowledgeResponseBody$outboundSchema.parse(
431
+ getOneKnowledgeResponseBody,
432
+ ),
433
+ );
434
+ }
435
+
436
+ export function getOneKnowledgeResponseBodyFromJSON(
437
+ jsonString: string,
438
+ ): SafeParseResult<GetOneKnowledgeResponseBody, SDKValidationError> {
439
+ return safeParse(
440
+ jsonString,
441
+ (x) => GetOneKnowledgeResponseBody$inboundSchema.parse(JSON.parse(x)),
442
+ `Failed to parse 'GetOneKnowledgeResponseBody' from JSON`,
443
+ );
444
+ }