@orq-ai/node 3.3.0-rc.10 → 3.3.0-rc.12

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 (421) hide show
  1. package/README.md +37 -1
  2. package/bin/mcp-server.js +7459 -1630
  3. package/bin/mcp-server.js.map +103 -58
  4. package/docs/sdks/files/README.md +8 -2
  5. package/docs/sdks/knowledge/README.md +1193 -0
  6. package/funcs/contactsCreate.js +1 -1
  7. package/funcs/contactsCreate.js.map +1 -1
  8. package/funcs/datasetsClear.js +1 -1
  9. package/funcs/datasetsClear.js.map +1 -1
  10. package/funcs/datasetsCreate.js +1 -1
  11. package/funcs/datasetsCreate.js.map +1 -1
  12. package/funcs/datasetsCreateDatapoint.js +1 -1
  13. package/funcs/datasetsCreateDatapoint.js.map +1 -1
  14. package/funcs/datasetsCreateDatapoints.js +1 -1
  15. package/funcs/datasetsCreateDatapoints.js.map +1 -1
  16. package/funcs/datasetsDelete.js +1 -1
  17. package/funcs/datasetsDelete.js.map +1 -1
  18. package/funcs/datasetsDeleteDatapoint.js +1 -1
  19. package/funcs/datasetsDeleteDatapoint.js.map +1 -1
  20. package/funcs/datasetsList.js +1 -1
  21. package/funcs/datasetsList.js.map +1 -1
  22. package/funcs/datasetsListDatapoints.js +1 -1
  23. package/funcs/datasetsListDatapoints.js.map +1 -1
  24. package/funcs/datasetsRetrieve.js +1 -1
  25. package/funcs/datasetsRetrieve.js.map +1 -1
  26. package/funcs/datasetsRetrieveDatapoint.js +1 -1
  27. package/funcs/datasetsRetrieveDatapoint.js.map +1 -1
  28. package/funcs/datasetsUpdate.js +1 -1
  29. package/funcs/datasetsUpdate.js.map +1 -1
  30. package/funcs/datasetsUpdateDatapoint.js +1 -1
  31. package/funcs/datasetsUpdateDatapoint.js.map +1 -1
  32. package/funcs/deploymentsGetConfig.js +1 -1
  33. package/funcs/deploymentsGetConfig.js.map +1 -1
  34. package/funcs/deploymentsInvoke.js +1 -1
  35. package/funcs/deploymentsInvoke.js.map +1 -1
  36. package/funcs/deploymentsList.js +1 -1
  37. package/funcs/deploymentsList.js.map +1 -1
  38. package/funcs/deploymentsMetricsCreate.js +1 -1
  39. package/funcs/deploymentsMetricsCreate.js.map +1 -1
  40. package/funcs/deploymentsStream.js +1 -1
  41. package/funcs/deploymentsStream.js.map +1 -1
  42. package/funcs/feedbackCreate.js +1 -1
  43. package/funcs/feedbackCreate.js.map +1 -1
  44. package/funcs/filesCreate.d.ts +1 -1
  45. package/funcs/filesCreate.d.ts.map +1 -1
  46. package/funcs/filesCreate.js +14 -16
  47. package/funcs/filesCreate.js.map +1 -1
  48. package/funcs/filesDelete.js +1 -1
  49. package/funcs/filesDelete.js.map +1 -1
  50. package/funcs/filesGet.js +1 -1
  51. package/funcs/filesGet.js.map +1 -1
  52. package/funcs/filesList.js +1 -1
  53. package/funcs/filesList.js.map +1 -1
  54. package/funcs/knowledgeCreate.d.ts +13 -0
  55. package/funcs/knowledgeCreate.d.ts.map +1 -0
  56. package/funcs/knowledgeCreate.js +109 -0
  57. package/funcs/knowledgeCreate.js.map +1 -0
  58. package/funcs/knowledgeCreateChunks.d.ts +13 -0
  59. package/funcs/knowledgeCreateChunks.d.ts.map +1 -0
  60. package/funcs/knowledgeCreateChunks.js +120 -0
  61. package/funcs/knowledgeCreateChunks.js.map +1 -0
  62. package/funcs/knowledgeCreateDatasource.d.ts +13 -0
  63. package/funcs/knowledgeCreateDatasource.d.ts.map +1 -0
  64. package/funcs/knowledgeCreateDatasource.js +115 -0
  65. package/funcs/knowledgeCreateDatasource.js.map +1 -0
  66. package/funcs/knowledgeDelete.d.ts +16 -0
  67. package/funcs/knowledgeDelete.d.ts.map +1 -0
  68. package/funcs/knowledgeDelete.js +118 -0
  69. package/funcs/knowledgeDelete.js.map +1 -0
  70. package/funcs/knowledgeDeleteChunk.d.ts +13 -0
  71. package/funcs/knowledgeDeleteChunk.d.ts.map +1 -0
  72. package/funcs/knowledgeDeleteChunk.js +123 -0
  73. package/funcs/knowledgeDeleteChunk.js.map +1 -0
  74. package/funcs/knowledgeDeleteDatasource.d.ts +16 -0
  75. package/funcs/knowledgeDeleteDatasource.d.ts.map +1 -0
  76. package/funcs/knowledgeDeleteDatasource.js +122 -0
  77. package/funcs/knowledgeDeleteDatasource.js.map +1 -0
  78. package/funcs/knowledgeList.d.ts +16 -0
  79. package/funcs/knowledgeList.d.ts.map +1 -0
  80. package/funcs/knowledgeList.js +117 -0
  81. package/funcs/knowledgeList.js.map +1 -0
  82. package/funcs/knowledgeListChunks.d.ts +13 -0
  83. package/funcs/knowledgeListChunks.d.ts.map +1 -0
  84. package/funcs/knowledgeListChunks.js +124 -0
  85. package/funcs/knowledgeListChunks.js.map +1 -0
  86. package/funcs/knowledgeListDatasources.d.ts +13 -0
  87. package/funcs/knowledgeListDatasources.d.ts.map +1 -0
  88. package/funcs/knowledgeListDatasources.js +120 -0
  89. package/funcs/knowledgeListDatasources.js.map +1 -0
  90. package/funcs/knowledgeRetrieve.d.ts +16 -0
  91. package/funcs/knowledgeRetrieve.d.ts.map +1 -0
  92. package/funcs/knowledgeRetrieve.js +117 -0
  93. package/funcs/knowledgeRetrieve.js.map +1 -0
  94. package/funcs/knowledgeRetrieveDatasource.d.ts +13 -0
  95. package/funcs/knowledgeRetrieveDatasource.d.ts.map +1 -0
  96. package/funcs/knowledgeRetrieveDatasource.js +118 -0
  97. package/funcs/knowledgeRetrieveDatasource.js.map +1 -0
  98. package/funcs/knowledgeRetrieveFileUrl.d.ts +14 -0
  99. package/funcs/knowledgeRetrieveFileUrl.d.ts.map +1 -0
  100. package/funcs/knowledgeRetrieveFileUrl.js +124 -0
  101. package/funcs/knowledgeRetrieveFileUrl.js.map +1 -0
  102. package/funcs/knowledgeSearch.d.ts +13 -0
  103. package/funcs/knowledgeSearch.d.ts.map +1 -0
  104. package/funcs/knowledgeSearch.js +115 -0
  105. package/funcs/knowledgeSearch.js.map +1 -0
  106. package/funcs/knowledgeUpdate.d.ts +13 -0
  107. package/funcs/knowledgeUpdate.d.ts.map +1 -0
  108. package/funcs/knowledgeUpdate.js +115 -0
  109. package/funcs/knowledgeUpdate.js.map +1 -0
  110. package/funcs/knowledgeUpdateChunk.d.ts +13 -0
  111. package/funcs/knowledgeUpdateChunk.d.ts.map +1 -0
  112. package/funcs/knowledgeUpdateChunk.js +123 -0
  113. package/funcs/knowledgeUpdateChunk.js.map +1 -0
  114. package/funcs/promptsCreate.js +1 -1
  115. package/funcs/promptsCreate.js.map +1 -1
  116. package/funcs/promptsDelete.js +1 -1
  117. package/funcs/promptsDelete.js.map +1 -1
  118. package/funcs/promptsGetVersion.js +1 -1
  119. package/funcs/promptsGetVersion.js.map +1 -1
  120. package/funcs/promptsList.js +1 -1
  121. package/funcs/promptsList.js.map +1 -1
  122. package/funcs/promptsListVersions.js +1 -1
  123. package/funcs/promptsListVersions.js.map +1 -1
  124. package/funcs/promptsRetrieve.js +1 -1
  125. package/funcs/promptsRetrieve.js.map +1 -1
  126. package/funcs/promptsUpdate.js +1 -1
  127. package/funcs/promptsUpdate.js.map +1 -1
  128. package/funcs/remoteconfigsRetrieve.js +1 -1
  129. package/funcs/remoteconfigsRetrieve.js.map +1 -1
  130. package/hooks/types.d.ts +1 -1
  131. package/hooks/types.d.ts.map +1 -1
  132. package/jsr.json +1 -1
  133. package/lib/config.d.ts +3 -3
  134. package/lib/config.js +3 -3
  135. package/mcp-server/mcp-server.js +1 -1
  136. package/mcp-server/server.d.ts.map +1 -1
  137. package/mcp-server/server.js +31 -1
  138. package/mcp-server/server.js.map +1 -1
  139. package/mcp-server/tools/filesCreate.d.ts +1 -1
  140. package/mcp-server/tools/filesCreate.js +1 -1
  141. package/mcp-server/tools/filesCreate.js.map +1 -1
  142. package/mcp-server/tools/knowledgeCreate.d.ts +8 -0
  143. package/mcp-server/tools/knowledgeCreate.d.ts.map +1 -0
  144. package/mcp-server/tools/knowledgeCreate.js +62 -0
  145. package/mcp-server/tools/knowledgeCreate.js.map +1 -0
  146. package/mcp-server/tools/knowledgeCreateChunks.d.ts +8 -0
  147. package/mcp-server/tools/knowledgeCreateChunks.d.ts.map +1 -0
  148. package/mcp-server/tools/knowledgeCreateChunks.js +62 -0
  149. package/mcp-server/tools/knowledgeCreateChunks.js.map +1 -0
  150. package/mcp-server/tools/knowledgeCreateDatasource.d.ts +8 -0
  151. package/mcp-server/tools/knowledgeCreateDatasource.d.ts.map +1 -0
  152. package/mcp-server/tools/knowledgeCreateDatasource.js +62 -0
  153. package/mcp-server/tools/knowledgeCreateDatasource.js.map +1 -0
  154. package/mcp-server/tools/knowledgeDelete.d.ts +8 -0
  155. package/mcp-server/tools/knowledgeDelete.d.ts.map +1 -0
  156. package/mcp-server/tools/knowledgeDelete.js +63 -0
  157. package/mcp-server/tools/knowledgeDelete.js.map +1 -0
  158. package/mcp-server/tools/knowledgeDeleteChunk.d.ts +8 -0
  159. package/mcp-server/tools/knowledgeDeleteChunk.d.ts.map +1 -0
  160. package/mcp-server/tools/knowledgeDeleteChunk.js +61 -0
  161. package/mcp-server/tools/knowledgeDeleteChunk.js.map +1 -0
  162. package/mcp-server/tools/knowledgeDeleteDatasource.d.ts +8 -0
  163. package/mcp-server/tools/knowledgeDeleteDatasource.d.ts.map +1 -0
  164. package/mcp-server/tools/knowledgeDeleteDatasource.js +63 -0
  165. package/mcp-server/tools/knowledgeDeleteDatasource.js.map +1 -0
  166. package/mcp-server/tools/knowledgeList.d.ts +8 -0
  167. package/mcp-server/tools/knowledgeList.d.ts.map +1 -0
  168. package/mcp-server/tools/knowledgeList.js +64 -0
  169. package/mcp-server/tools/knowledgeList.js.map +1 -0
  170. package/mcp-server/tools/knowledgeListChunks.d.ts +8 -0
  171. package/mcp-server/tools/knowledgeListChunks.d.ts.map +1 -0
  172. package/mcp-server/tools/knowledgeListChunks.js +62 -0
  173. package/mcp-server/tools/knowledgeListChunks.js.map +1 -0
  174. package/mcp-server/tools/knowledgeListDatasources.d.ts +8 -0
  175. package/mcp-server/tools/knowledgeListDatasources.d.ts.map +1 -0
  176. package/mcp-server/tools/knowledgeListDatasources.js +62 -0
  177. package/mcp-server/tools/knowledgeListDatasources.js.map +1 -0
  178. package/mcp-server/tools/knowledgeRetrieve.d.ts +8 -0
  179. package/mcp-server/tools/knowledgeRetrieve.d.ts.map +1 -0
  180. package/mcp-server/tools/knowledgeRetrieve.js +64 -0
  181. package/mcp-server/tools/knowledgeRetrieve.js.map +1 -0
  182. package/mcp-server/tools/knowledgeRetrieveDatasource.d.ts +8 -0
  183. package/mcp-server/tools/knowledgeRetrieveDatasource.d.ts.map +1 -0
  184. package/mcp-server/tools/knowledgeRetrieveDatasource.js +62 -0
  185. package/mcp-server/tools/knowledgeRetrieveDatasource.js.map +1 -0
  186. package/mcp-server/tools/knowledgeRetrieveFileUrl.d.ts +8 -0
  187. package/mcp-server/tools/knowledgeRetrieveFileUrl.d.ts.map +1 -0
  188. package/mcp-server/tools/knowledgeRetrieveFileUrl.js +62 -0
  189. package/mcp-server/tools/knowledgeRetrieveFileUrl.js.map +1 -0
  190. package/mcp-server/tools/knowledgeSearch.d.ts +8 -0
  191. package/mcp-server/tools/knowledgeSearch.d.ts.map +1 -0
  192. package/mcp-server/tools/knowledgeSearch.js +62 -0
  193. package/mcp-server/tools/knowledgeSearch.js.map +1 -0
  194. package/mcp-server/tools/knowledgeUpdate.d.ts +8 -0
  195. package/mcp-server/tools/knowledgeUpdate.d.ts.map +1 -0
  196. package/mcp-server/tools/knowledgeUpdate.js +62 -0
  197. package/mcp-server/tools/knowledgeUpdate.js.map +1 -0
  198. package/mcp-server/tools/knowledgeUpdateChunk.d.ts +8 -0
  199. package/mcp-server/tools/knowledgeUpdateChunk.d.ts.map +1 -0
  200. package/mcp-server/tools/knowledgeUpdateChunk.js +62 -0
  201. package/mcp-server/tools/knowledgeUpdateChunk.js.map +1 -0
  202. package/models/operations/bulkcreatedatapoints.js +2 -2
  203. package/models/operations/createchunk.d.ts +320 -0
  204. package/models/operations/createchunk.d.ts.map +1 -0
  205. package/models/operations/createchunk.js +366 -0
  206. package/models/operations/createchunk.js.map +1 -0
  207. package/models/operations/createcontact.js +2 -2
  208. package/models/operations/createdataset.js +2 -2
  209. package/models/operations/createdatasetitem.js +2 -2
  210. package/models/operations/createdatasource.d.ts +421 -0
  211. package/models/operations/createdatasource.d.ts.map +1 -0
  212. package/models/operations/createdatasource.js +459 -0
  213. package/models/operations/createdatasource.js.map +1 -0
  214. package/models/operations/createknowledge.d.ts +1549 -0
  215. package/models/operations/createknowledge.d.ts.map +1 -0
  216. package/models/operations/createknowledge.js +1461 -0
  217. package/models/operations/createknowledge.js.map +1 -0
  218. package/models/operations/createprompt.d.ts +18 -0
  219. package/models/operations/createprompt.d.ts.map +1 -1
  220. package/models/operations/createprompt.js +6 -0
  221. package/models/operations/createprompt.js.map +1 -1
  222. package/models/operations/deletechunk.d.ts +42 -0
  223. package/models/operations/deletechunk.d.ts.map +1 -0
  224. package/models/operations/deletechunk.js +86 -0
  225. package/models/operations/deletechunk.js.map +1 -0
  226. package/models/operations/deletedatasource.d.ts +37 -0
  227. package/models/operations/deletedatasource.d.ts.map +1 -0
  228. package/models/operations/deletedatasource.js +82 -0
  229. package/models/operations/deletedatasource.js.map +1 -0
  230. package/models/operations/deleteknowledge.d.ts +32 -0
  231. package/models/operations/deleteknowledge.d.ts.map +1 -0
  232. package/models/operations/deleteknowledge.js +78 -0
  233. package/models/operations/deleteknowledge.js.map +1 -0
  234. package/models/operations/fileget.js +2 -2
  235. package/models/operations/filelist.js +2 -2
  236. package/models/operations/fileupload.d.ts +2 -2
  237. package/models/operations/fileupload.d.ts.map +1 -1
  238. package/models/operations/fileupload.js +4 -4
  239. package/models/operations/fileupload.js.map +1 -1
  240. package/models/operations/getallprompts.d.ts +9 -0
  241. package/models/operations/getallprompts.d.ts.map +1 -1
  242. package/models/operations/getallprompts.js +3 -0
  243. package/models/operations/getallprompts.js.map +1 -1
  244. package/models/operations/getonefileuploadurl.d.ts +68 -0
  245. package/models/operations/getonefileuploadurl.d.ts.map +1 -0
  246. package/models/operations/getonefileuploadurl.js +113 -0
  247. package/models/operations/getonefileuploadurl.js.map +1 -0
  248. package/models/operations/getoneknowledge.d.ts +842 -0
  249. package/models/operations/getoneknowledge.d.ts.map +1 -0
  250. package/models/operations/getoneknowledge.js +826 -0
  251. package/models/operations/getoneknowledge.js.map +1 -0
  252. package/models/operations/getoneprompt.d.ts +9 -0
  253. package/models/operations/getoneprompt.d.ts.map +1 -1
  254. package/models/operations/getoneprompt.js +3 -0
  255. package/models/operations/getoneprompt.js.map +1 -1
  256. package/models/operations/getpromptversion.d.ts +9 -0
  257. package/models/operations/getpromptversion.d.ts.map +1 -1
  258. package/models/operations/getpromptversion.js +3 -0
  259. package/models/operations/getpromptversion.js.map +1 -1
  260. package/models/operations/index.d.ts +15 -0
  261. package/models/operations/index.d.ts.map +1 -1
  262. package/models/operations/index.js +15 -0
  263. package/models/operations/index.js.map +1 -1
  264. package/models/operations/listchunks.d.ts +219 -0
  265. package/models/operations/listchunks.d.ts.map +1 -0
  266. package/models/operations/listchunks.js +229 -0
  267. package/models/operations/listchunks.js.map +1 -0
  268. package/models/operations/listdatasetdatapoints.js +2 -2
  269. package/models/operations/listdatasets.js +2 -2
  270. package/models/operations/listdatasources.d.ts +208 -0
  271. package/models/operations/listdatasources.d.ts.map +1 -0
  272. package/models/operations/listdatasources.js +234 -0
  273. package/models/operations/listdatasources.js.map +1 -0
  274. package/models/operations/listknowledgebases.d.ts +906 -0
  275. package/models/operations/listknowledgebases.d.ts.map +1 -0
  276. package/models/operations/listknowledgebases.js +891 -0
  277. package/models/operations/listknowledgebases.js.map +1 -0
  278. package/models/operations/listpromptversions.d.ts +9 -0
  279. package/models/operations/listpromptversions.d.ts.map +1 -1
  280. package/models/operations/listpromptversions.js +3 -0
  281. package/models/operations/listpromptversions.js.map +1 -1
  282. package/models/operations/retrievedatapoint.js +2 -2
  283. package/models/operations/retrievedataset.js +2 -2
  284. package/models/operations/retrievedatasource.d.ts +150 -0
  285. package/models/operations/retrievedatasource.d.ts.map +1 -0
  286. package/models/operations/retrievedatasource.js +171 -0
  287. package/models/operations/retrievedatasource.js.map +1 -0
  288. package/models/operations/searchknowledge.d.ts +894 -0
  289. package/models/operations/searchknowledge.d.ts.map +1 -0
  290. package/models/operations/searchknowledge.js +879 -0
  291. package/models/operations/searchknowledge.js.map +1 -0
  292. package/models/operations/updatechunk.d.ts +229 -0
  293. package/models/operations/updatechunk.d.ts.map +1 -0
  294. package/models/operations/updatechunk.js +236 -0
  295. package/models/operations/updatechunk.js.map +1 -0
  296. package/models/operations/updatedatapoint.js +2 -2
  297. package/models/operations/updatedataset.js +2 -2
  298. package/models/operations/updateknowledge.d.ts +1574 -0
  299. package/models/operations/updateknowledge.d.ts.map +1 -0
  300. package/models/operations/updateknowledge.js +1503 -0
  301. package/models/operations/updateknowledge.js.map +1 -0
  302. package/models/operations/updateprompt.d.ts +18 -0
  303. package/models/operations/updateprompt.d.ts.map +1 -1
  304. package/models/operations/updateprompt.js +6 -0
  305. package/models/operations/updateprompt.js.map +1 -1
  306. package/package.json +1 -1
  307. package/sdk/files.d.ts +1 -1
  308. package/sdk/files.d.ts.map +1 -1
  309. package/sdk/files.js.map +1 -1
  310. package/sdk/knowledge.d.ts +77 -0
  311. package/sdk/knowledge.d.ts.map +1 -0
  312. package/sdk/knowledge.js +129 -0
  313. package/sdk/knowledge.js.map +1 -0
  314. package/sdk/sdk.d.ts +3 -0
  315. package/sdk/sdk.d.ts.map +1 -1
  316. package/sdk/sdk.js +4 -0
  317. package/sdk/sdk.js.map +1 -1
  318. package/src/funcs/contactsCreate.ts +1 -1
  319. package/src/funcs/datasetsClear.ts +1 -1
  320. package/src/funcs/datasetsCreate.ts +1 -1
  321. package/src/funcs/datasetsCreateDatapoint.ts +1 -1
  322. package/src/funcs/datasetsCreateDatapoints.ts +1 -1
  323. package/src/funcs/datasetsDelete.ts +1 -1
  324. package/src/funcs/datasetsDeleteDatapoint.ts +1 -1
  325. package/src/funcs/datasetsList.ts +1 -1
  326. package/src/funcs/datasetsListDatapoints.ts +1 -1
  327. package/src/funcs/datasetsRetrieve.ts +1 -1
  328. package/src/funcs/datasetsRetrieveDatapoint.ts +1 -1
  329. package/src/funcs/datasetsUpdate.ts +1 -1
  330. package/src/funcs/datasetsUpdateDatapoint.ts +1 -1
  331. package/src/funcs/deploymentsGetConfig.ts +1 -1
  332. package/src/funcs/deploymentsInvoke.ts +1 -1
  333. package/src/funcs/deploymentsList.ts +1 -1
  334. package/src/funcs/deploymentsMetricsCreate.ts +1 -1
  335. package/src/funcs/deploymentsStream.ts +1 -1
  336. package/src/funcs/feedbackCreate.ts +1 -1
  337. package/src/funcs/filesCreate.ts +19 -22
  338. package/src/funcs/filesDelete.ts +1 -1
  339. package/src/funcs/filesGet.ts +1 -1
  340. package/src/funcs/filesList.ts +1 -1
  341. package/src/funcs/knowledgeCreate.ts +152 -0
  342. package/src/funcs/knowledgeCreateChunks.ts +165 -0
  343. package/src/funcs/knowledgeCreateDatasource.ts +160 -0
  344. package/src/funcs/knowledgeDelete.ts +161 -0
  345. package/src/funcs/knowledgeDeleteChunk.ts +168 -0
  346. package/src/funcs/knowledgeDeleteDatasource.ts +167 -0
  347. package/src/funcs/knowledgeList.ts +163 -0
  348. package/src/funcs/knowledgeListChunks.ts +170 -0
  349. package/src/funcs/knowledgeListDatasources.ts +166 -0
  350. package/src/funcs/knowledgeRetrieve.ts +160 -0
  351. package/src/funcs/knowledgeRetrieveDatasource.ts +163 -0
  352. package/src/funcs/knowledgeRetrieveFileUrl.ts +176 -0
  353. package/src/funcs/knowledgeSearch.ts +158 -0
  354. package/src/funcs/knowledgeUpdate.ts +158 -0
  355. package/src/funcs/knowledgeUpdateChunk.ts +168 -0
  356. package/src/funcs/promptsCreate.ts +1 -1
  357. package/src/funcs/promptsDelete.ts +1 -1
  358. package/src/funcs/promptsGetVersion.ts +1 -1
  359. package/src/funcs/promptsList.ts +1 -1
  360. package/src/funcs/promptsListVersions.ts +1 -1
  361. package/src/funcs/promptsRetrieve.ts +1 -1
  362. package/src/funcs/promptsUpdate.ts +1 -1
  363. package/src/funcs/remoteconfigsRetrieve.ts +1 -1
  364. package/src/hooks/types.ts +1 -1
  365. package/src/lib/config.ts +3 -3
  366. package/src/mcp-server/mcp-server.ts +1 -1
  367. package/src/mcp-server/server.ts +31 -1
  368. package/src/mcp-server/tools/filesCreate.ts +1 -1
  369. package/src/mcp-server/tools/knowledgeCreate.ts +35 -0
  370. package/src/mcp-server/tools/knowledgeCreateChunks.ts +35 -0
  371. package/src/mcp-server/tools/knowledgeCreateDatasource.ts +35 -0
  372. package/src/mcp-server/tools/knowledgeDelete.ts +35 -0
  373. package/src/mcp-server/tools/knowledgeDeleteChunk.ts +33 -0
  374. package/src/mcp-server/tools/knowledgeDeleteDatasource.ts +35 -0
  375. package/src/mcp-server/tools/knowledgeList.ts +37 -0
  376. package/src/mcp-server/tools/knowledgeListChunks.ts +35 -0
  377. package/src/mcp-server/tools/knowledgeListDatasources.ts +35 -0
  378. package/src/mcp-server/tools/knowledgeRetrieve.ts +37 -0
  379. package/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +35 -0
  380. package/src/mcp-server/tools/knowledgeRetrieveFileUrl.ts +35 -0
  381. package/src/mcp-server/tools/knowledgeSearch.ts +35 -0
  382. package/src/mcp-server/tools/knowledgeUpdate.ts +35 -0
  383. package/src/mcp-server/tools/knowledgeUpdateChunk.ts +35 -0
  384. package/src/models/operations/bulkcreatedatapoints.ts +2 -2
  385. package/src/models/operations/createchunk.ts +680 -0
  386. package/src/models/operations/createcontact.ts +2 -2
  387. package/src/models/operations/createdataset.ts +2 -2
  388. package/src/models/operations/createdatasetitem.ts +2 -2
  389. package/src/models/operations/createdatasource.ts +850 -0
  390. package/src/models/operations/createknowledge.ts +2920 -0
  391. package/src/models/operations/createprompt.ts +6 -0
  392. package/src/models/operations/deletechunk.ts +96 -0
  393. package/src/models/operations/deletedatasource.ts +87 -0
  394. package/src/models/operations/deleteknowledge.ts +78 -0
  395. package/src/models/operations/fileget.ts +2 -2
  396. package/src/models/operations/filelist.ts +2 -2
  397. package/src/models/operations/fileupload.ts +6 -6
  398. package/src/models/operations/getallprompts.ts +3 -0
  399. package/src/models/operations/getonefileuploadurl.ts +157 -0
  400. package/src/models/operations/getoneknowledge.ts +1631 -0
  401. package/src/models/operations/getoneprompt.ts +3 -0
  402. package/src/models/operations/getpromptversion.ts +3 -0
  403. package/src/models/operations/index.ts +15 -0
  404. package/src/models/operations/listchunks.ts +377 -0
  405. package/src/models/operations/listdatasetdatapoints.ts +2 -2
  406. package/src/models/operations/listdatasets.ts +2 -2
  407. package/src/models/operations/listdatasources.ts +384 -0
  408. package/src/models/operations/listknowledgebases.ts +1782 -0
  409. package/src/models/operations/listpromptversions.ts +3 -0
  410. package/src/models/operations/retrievedatapoint.ts +2 -2
  411. package/src/models/operations/retrievedataset.ts +2 -2
  412. package/src/models/operations/retrievedatasource.ts +273 -0
  413. package/src/models/operations/searchknowledge.ts +1673 -0
  414. package/src/models/operations/updatechunk.ts +418 -0
  415. package/src/models/operations/updatedatapoint.ts +2 -2
  416. package/src/models/operations/updatedataset.ts +2 -2
  417. package/src/models/operations/updateknowledge.ts +3123 -0
  418. package/src/models/operations/updateprompt.ts +6 -0
  419. package/src/sdk/files.ts +1 -1
  420. package/src/sdk/knowledge.ts +246 -0
  421. package/src/sdk/sdk.ts +6 -0
@@ -0,0 +1,1193 @@
1
+ # Knowledge
2
+ (*knowledge*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [list](#list) - List all knowledge bases
9
+ * [create](#create) - Create a knowledge
10
+ * [retrieve](#retrieve) - Retrieves a knowledge base
11
+ * [update](#update) - Updates a knowledge
12
+ * [delete](#delete) - Deletes a knowledge
13
+ * [search](#search) - Retrieves the documents used for retrieval
14
+ * [retrieveFileUrl](#retrievefileurl) - Retrieves the file upload url
15
+ * [listDatasources](#listdatasources) - List all datasources
16
+ * [createDatasource](#createdatasource) - Create a new datasource
17
+ * [retrieveDatasource](#retrievedatasource) - Retrieve a datasource
18
+ * [deleteDatasource](#deletedatasource) - Deletes a datasource
19
+ * [createChunks](#createchunks) - Create chunks for a datasource
20
+ * [listChunks](#listchunks) - List all chunks for a datasource
21
+ * [updateChunk](#updatechunk) - Update a chunk
22
+ * [deleteChunk](#deletechunk) - Delete a chunk
23
+
24
+ ## list
25
+
26
+ Returns a list of your knowledge bases. The knowledge bases are returned sorted by creation date, with the most recent knowledge bases appearing first
27
+
28
+ ### Example Usage
29
+
30
+ ```typescript
31
+ import { Orq } from "@orq-ai/node";
32
+
33
+ const orq = new Orq({
34
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
35
+ });
36
+
37
+ async function run() {
38
+ const result = await orq.knowledge.list({});
39
+
40
+ // Handle the result
41
+ console.log(result);
42
+ }
43
+
44
+ run();
45
+ ```
46
+
47
+ ### Standalone function
48
+
49
+ The standalone function version of this method:
50
+
51
+ ```typescript
52
+ import { OrqCore } from "@orq-ai/node/core.js";
53
+ import { knowledgeList } from "@orq-ai/node/funcs/knowledgeList.js";
54
+
55
+ // Use `OrqCore` for best tree-shaking performance.
56
+ // You can create one instance of it to use across an application.
57
+ const orq = new OrqCore({
58
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
59
+ });
60
+
61
+ async function run() {
62
+ const res = await knowledgeList(orq, {});
63
+
64
+ if (!res.ok) {
65
+ throw res.error;
66
+ }
67
+
68
+ const { value: result } = res;
69
+
70
+ // Handle the result
71
+ console.log(result);
72
+ }
73
+
74
+ run();
75
+ ```
76
+
77
+ ### Parameters
78
+
79
+ | Parameter | Type | Required | Description |
80
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
81
+ | `request` | [operations.ListKnowledgeBasesRequest](../../models/operations/listknowledgebasesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
82
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
83
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
84
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
85
+
86
+ ### Response
87
+
88
+ **Promise\<[operations.ListKnowledgeBasesResponseBody](../../models/operations/listknowledgebasesresponsebody.md)\>**
89
+
90
+ ### Errors
91
+
92
+ | Error Type | Status Code | Content Type |
93
+ | --------------- | --------------- | --------------- |
94
+ | errors.APIError | 4XX, 5XX | \*/\* |
95
+
96
+ ## create
97
+
98
+ Create a knowledge
99
+
100
+ ### Example Usage
101
+
102
+ ```typescript
103
+ import { Orq } from "@orq-ai/node";
104
+
105
+ const orq = new Orq({
106
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
107
+ });
108
+
109
+ async function run() {
110
+ const result = await orq.knowledge.create({
111
+ key: "<key>",
112
+ model: "Fiesta",
113
+ path: "Customer Service/Billing/Refund",
114
+ });
115
+
116
+ // Handle the result
117
+ console.log(result);
118
+ }
119
+
120
+ run();
121
+ ```
122
+
123
+ ### Standalone function
124
+
125
+ The standalone function version of this method:
126
+
127
+ ```typescript
128
+ import { OrqCore } from "@orq-ai/node/core.js";
129
+ import { knowledgeCreate } from "@orq-ai/node/funcs/knowledgeCreate.js";
130
+
131
+ // Use `OrqCore` for best tree-shaking performance.
132
+ // You can create one instance of it to use across an application.
133
+ const orq = new OrqCore({
134
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
135
+ });
136
+
137
+ async function run() {
138
+ const res = await knowledgeCreate(orq, {
139
+ key: "<key>",
140
+ model: "Fiesta",
141
+ path: "Customer Service/Billing/Refund",
142
+ });
143
+
144
+ if (!res.ok) {
145
+ throw res.error;
146
+ }
147
+
148
+ const { value: result } = res;
149
+
150
+ // Handle the result
151
+ console.log(result);
152
+ }
153
+
154
+ run();
155
+ ```
156
+
157
+ ### Parameters
158
+
159
+ | Parameter | Type | Required | Description |
160
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
161
+ | `request` | [operations.CreateKnowledgeRequestBody](../../models/operations/createknowledgerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
162
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
163
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
164
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
165
+
166
+ ### Response
167
+
168
+ **Promise\<[operations.CreateKnowledgeResponseBody](../../models/operations/createknowledgeresponsebody.md)\>**
169
+
170
+ ### Errors
171
+
172
+ | Error Type | Status Code | Content Type |
173
+ | --------------- | --------------- | --------------- |
174
+ | errors.APIError | 4XX, 5XX | \*/\* |
175
+
176
+ ## retrieve
177
+
178
+ Retrieve a knowledge base with the settings.
179
+
180
+ ### Example Usage
181
+
182
+ ```typescript
183
+ import { Orq } from "@orq-ai/node";
184
+
185
+ const orq = new Orq({
186
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
187
+ });
188
+
189
+ async function run() {
190
+ const result = await orq.knowledge.retrieve({
191
+ knowledgeId: "<id>",
192
+ });
193
+
194
+ // Handle the result
195
+ console.log(result);
196
+ }
197
+
198
+ run();
199
+ ```
200
+
201
+ ### Standalone function
202
+
203
+ The standalone function version of this method:
204
+
205
+ ```typescript
206
+ import { OrqCore } from "@orq-ai/node/core.js";
207
+ import { knowledgeRetrieve } from "@orq-ai/node/funcs/knowledgeRetrieve.js";
208
+
209
+ // Use `OrqCore` for best tree-shaking performance.
210
+ // You can create one instance of it to use across an application.
211
+ const orq = new OrqCore({
212
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
213
+ });
214
+
215
+ async function run() {
216
+ const res = await knowledgeRetrieve(orq, {
217
+ knowledgeId: "<id>",
218
+ });
219
+
220
+ if (!res.ok) {
221
+ throw res.error;
222
+ }
223
+
224
+ const { value: result } = res;
225
+
226
+ // Handle the result
227
+ console.log(result);
228
+ }
229
+
230
+ run();
231
+ ```
232
+
233
+ ### Parameters
234
+
235
+ | Parameter | Type | Required | Description |
236
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
237
+ | `request` | [operations.GetOneKnowledgeRequest](../../models/operations/getoneknowledgerequest.md) | :heavy_check_mark: | The request object to use for the request. |
238
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
239
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
240
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
241
+
242
+ ### Response
243
+
244
+ **Promise\<[operations.GetOneKnowledgeResponseBody](../../models/operations/getoneknowledgeresponsebody.md)\>**
245
+
246
+ ### Errors
247
+
248
+ | Error Type | Status Code | Content Type |
249
+ | --------------- | --------------- | --------------- |
250
+ | errors.APIError | 4XX, 5XX | \*/\* |
251
+
252
+ ## update
253
+
254
+ Updates a knowledge
255
+
256
+ ### Example Usage
257
+
258
+ ```typescript
259
+ import { Orq } from "@orq-ai/node";
260
+
261
+ const orq = new Orq({
262
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
263
+ });
264
+
265
+ async function run() {
266
+ const result = await orq.knowledge.update({
267
+ knowledgeId: "<id>",
268
+ requestBody: {
269
+ path: "Customer Service/Billing/Refund",
270
+ },
271
+ });
272
+
273
+ // Handle the result
274
+ console.log(result);
275
+ }
276
+
277
+ run();
278
+ ```
279
+
280
+ ### Standalone function
281
+
282
+ The standalone function version of this method:
283
+
284
+ ```typescript
285
+ import { OrqCore } from "@orq-ai/node/core.js";
286
+ import { knowledgeUpdate } from "@orq-ai/node/funcs/knowledgeUpdate.js";
287
+
288
+ // Use `OrqCore` for best tree-shaking performance.
289
+ // You can create one instance of it to use across an application.
290
+ const orq = new OrqCore({
291
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
292
+ });
293
+
294
+ async function run() {
295
+ const res = await knowledgeUpdate(orq, {
296
+ knowledgeId: "<id>",
297
+ requestBody: {
298
+ path: "Customer Service/Billing/Refund",
299
+ },
300
+ });
301
+
302
+ if (!res.ok) {
303
+ throw res.error;
304
+ }
305
+
306
+ const { value: result } = res;
307
+
308
+ // Handle the result
309
+ console.log(result);
310
+ }
311
+
312
+ run();
313
+ ```
314
+
315
+ ### Parameters
316
+
317
+ | Parameter | Type | Required | Description |
318
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
319
+ | `request` | [operations.UpdateKnowledgeRequest](../../models/operations/updateknowledgerequest.md) | :heavy_check_mark: | The request object to use for the request. |
320
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
321
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
322
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
323
+
324
+ ### Response
325
+
326
+ **Promise\<[operations.UpdateKnowledgeResponseBody](../../models/operations/updateknowledgeresponsebody.md)\>**
327
+
328
+ ### Errors
329
+
330
+ | Error Type | Status Code | Content Type |
331
+ | --------------- | --------------- | --------------- |
332
+ | errors.APIError | 4XX, 5XX | \*/\* |
333
+
334
+ ## delete
335
+
336
+ Deletes a knowledge base. Deleting a knowledge base will delete all the datasources and chunks associated with it.
337
+
338
+ ### Example Usage
339
+
340
+ ```typescript
341
+ import { Orq } from "@orq-ai/node";
342
+
343
+ const orq = new Orq({
344
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
345
+ });
346
+
347
+ async function run() {
348
+ await orq.knowledge.delete({
349
+ knowledgeId: "<id>",
350
+ });
351
+
352
+
353
+ }
354
+
355
+ run();
356
+ ```
357
+
358
+ ### Standalone function
359
+
360
+ The standalone function version of this method:
361
+
362
+ ```typescript
363
+ import { OrqCore } from "@orq-ai/node/core.js";
364
+ import { knowledgeDelete } from "@orq-ai/node/funcs/knowledgeDelete.js";
365
+
366
+ // Use `OrqCore` for best tree-shaking performance.
367
+ // You can create one instance of it to use across an application.
368
+ const orq = new OrqCore({
369
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
370
+ });
371
+
372
+ async function run() {
373
+ const res = await knowledgeDelete(orq, {
374
+ knowledgeId: "<id>",
375
+ });
376
+
377
+ if (!res.ok) {
378
+ throw res.error;
379
+ }
380
+
381
+ const { value: result } = res;
382
+
383
+
384
+ }
385
+
386
+ run();
387
+ ```
388
+
389
+ ### Parameters
390
+
391
+ | Parameter | Type | Required | Description |
392
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
393
+ | `request` | [operations.DeleteKnowledgeRequest](../../models/operations/deleteknowledgerequest.md) | :heavy_check_mark: | The request object to use for the request. |
394
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
395
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
396
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
397
+
398
+ ### Response
399
+
400
+ **Promise\<void\>**
401
+
402
+ ### Errors
403
+
404
+ | Error Type | Status Code | Content Type |
405
+ | --------------- | --------------- | --------------- |
406
+ | errors.APIError | 4XX, 5XX | \*/\* |
407
+
408
+ ## search
409
+
410
+ Retrieves the documents used for retrieval
411
+
412
+ ### Example Usage
413
+
414
+ ```typescript
415
+ import { Orq } from "@orq-ai/node";
416
+
417
+ const orq = new Orq({
418
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
419
+ });
420
+
421
+ async function run() {
422
+ const result = await orq.knowledge.search({
423
+ knowledgeId: "<id>",
424
+ requestBody: {
425
+ query: "<value>",
426
+ },
427
+ });
428
+
429
+ // Handle the result
430
+ console.log(result);
431
+ }
432
+
433
+ run();
434
+ ```
435
+
436
+ ### Standalone function
437
+
438
+ The standalone function version of this method:
439
+
440
+ ```typescript
441
+ import { OrqCore } from "@orq-ai/node/core.js";
442
+ import { knowledgeSearch } from "@orq-ai/node/funcs/knowledgeSearch.js";
443
+
444
+ // Use `OrqCore` for best tree-shaking performance.
445
+ // You can create one instance of it to use across an application.
446
+ const orq = new OrqCore({
447
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
448
+ });
449
+
450
+ async function run() {
451
+ const res = await knowledgeSearch(orq, {
452
+ knowledgeId: "<id>",
453
+ requestBody: {
454
+ query: "<value>",
455
+ },
456
+ });
457
+
458
+ if (!res.ok) {
459
+ throw res.error;
460
+ }
461
+
462
+ const { value: result } = res;
463
+
464
+ // Handle the result
465
+ console.log(result);
466
+ }
467
+
468
+ run();
469
+ ```
470
+
471
+ ### Parameters
472
+
473
+ | Parameter | Type | Required | Description |
474
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
475
+ | `request` | [operations.SearchKnowledgeRequest](../../models/operations/searchknowledgerequest.md) | :heavy_check_mark: | The request object to use for the request. |
476
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
477
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
478
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
479
+
480
+ ### Response
481
+
482
+ **Promise\<[operations.SearchKnowledgeResponseBody](../../models/operations/searchknowledgeresponsebody.md)\>**
483
+
484
+ ### Errors
485
+
486
+ | Error Type | Status Code | Content Type |
487
+ | --------------- | --------------- | --------------- |
488
+ | errors.APIError | 4XX, 5XX | \*/\* |
489
+
490
+ ## retrieveFileUrl
491
+
492
+ Retrieves the file upload url
493
+
494
+ ### Example Usage
495
+
496
+ ```typescript
497
+ import { Orq } from "@orq-ai/node";
498
+
499
+ const orq = new Orq({
500
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
501
+ });
502
+
503
+ async function run() {
504
+ const result = await orq.knowledge.retrieveFileUrl({
505
+ knowledgeId: "<id>",
506
+ fileName: "example.file",
507
+ contentType: "<value>",
508
+ datasourceId: "<id>",
509
+ });
510
+
511
+ // Handle the result
512
+ console.log(result);
513
+ }
514
+
515
+ run();
516
+ ```
517
+
518
+ ### Standalone function
519
+
520
+ The standalone function version of this method:
521
+
522
+ ```typescript
523
+ import { OrqCore } from "@orq-ai/node/core.js";
524
+ import { knowledgeRetrieveFileUrl } from "@orq-ai/node/funcs/knowledgeRetrieveFileUrl.js";
525
+
526
+ // Use `OrqCore` for best tree-shaking performance.
527
+ // You can create one instance of it to use across an application.
528
+ const orq = new OrqCore({
529
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
530
+ });
531
+
532
+ async function run() {
533
+ const res = await knowledgeRetrieveFileUrl(orq, {
534
+ knowledgeId: "<id>",
535
+ fileName: "example.file",
536
+ contentType: "<value>",
537
+ datasourceId: "<id>",
538
+ });
539
+
540
+ if (!res.ok) {
541
+ throw res.error;
542
+ }
543
+
544
+ const { value: result } = res;
545
+
546
+ // Handle the result
547
+ console.log(result);
548
+ }
549
+
550
+ run();
551
+ ```
552
+
553
+ ### Parameters
554
+
555
+ | Parameter | Type | Required | Description |
556
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
557
+ | `request` | [operations.GetOneFileUploadUrlRequest](../../models/operations/getonefileuploadurlrequest.md) | :heavy_check_mark: | The request object to use for the request. |
558
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
559
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
560
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
561
+
562
+ ### Response
563
+
564
+ **Promise\<[operations.GetOneFileUploadUrlResponseBody](../../models/operations/getonefileuploadurlresponsebody.md)\>**
565
+
566
+ ### Errors
567
+
568
+ | Error Type | Status Code | Content Type |
569
+ | ------------------- | ------------------- | ------------------- |
570
+ | errors.HonoApiError | 500 | application/json |
571
+ | errors.APIError | 4XX, 5XX | \*/\* |
572
+
573
+ ## listDatasources
574
+
575
+ List all datasources
576
+
577
+ ### Example Usage
578
+
579
+ ```typescript
580
+ import { Orq } from "@orq-ai/node";
581
+
582
+ const orq = new Orq({
583
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
584
+ });
585
+
586
+ async function run() {
587
+ const result = await orq.knowledge.listDatasources({
588
+ knowledgeId: "<id>",
589
+ });
590
+
591
+ // Handle the result
592
+ console.log(result);
593
+ }
594
+
595
+ run();
596
+ ```
597
+
598
+ ### Standalone function
599
+
600
+ The standalone function version of this method:
601
+
602
+ ```typescript
603
+ import { OrqCore } from "@orq-ai/node/core.js";
604
+ import { knowledgeListDatasources } from "@orq-ai/node/funcs/knowledgeListDatasources.js";
605
+
606
+ // Use `OrqCore` for best tree-shaking performance.
607
+ // You can create one instance of it to use across an application.
608
+ const orq = new OrqCore({
609
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
610
+ });
611
+
612
+ async function run() {
613
+ const res = await knowledgeListDatasources(orq, {
614
+ knowledgeId: "<id>",
615
+ });
616
+
617
+ if (!res.ok) {
618
+ throw res.error;
619
+ }
620
+
621
+ const { value: result } = res;
622
+
623
+ // Handle the result
624
+ console.log(result);
625
+ }
626
+
627
+ run();
628
+ ```
629
+
630
+ ### Parameters
631
+
632
+ | Parameter | Type | Required | Description |
633
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
634
+ | `request` | [operations.ListDatasourcesRequest](../../models/operations/listdatasourcesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
635
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
636
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
637
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
638
+
639
+ ### Response
640
+
641
+ **Promise\<[operations.ListDatasourcesResponseBody](../../models/operations/listdatasourcesresponsebody.md)\>**
642
+
643
+ ### Errors
644
+
645
+ | Error Type | Status Code | Content Type |
646
+ | --------------- | --------------- | --------------- |
647
+ | errors.APIError | 4XX, 5XX | \*/\* |
648
+
649
+ ## createDatasource
650
+
651
+ Create a new datasource
652
+
653
+ ### Example Usage
654
+
655
+ ```typescript
656
+ import { Orq } from "@orq-ai/node";
657
+
658
+ const orq = new Orq({
659
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
660
+ });
661
+
662
+ async function run() {
663
+ const result = await orq.knowledge.createDatasource({
664
+ knowledgeId: "<id>",
665
+ requestBody: {},
666
+ });
667
+
668
+ // Handle the result
669
+ console.log(result);
670
+ }
671
+
672
+ run();
673
+ ```
674
+
675
+ ### Standalone function
676
+
677
+ The standalone function version of this method:
678
+
679
+ ```typescript
680
+ import { OrqCore } from "@orq-ai/node/core.js";
681
+ import { knowledgeCreateDatasource } from "@orq-ai/node/funcs/knowledgeCreateDatasource.js";
682
+
683
+ // Use `OrqCore` for best tree-shaking performance.
684
+ // You can create one instance of it to use across an application.
685
+ const orq = new OrqCore({
686
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
687
+ });
688
+
689
+ async function run() {
690
+ const res = await knowledgeCreateDatasource(orq, {
691
+ knowledgeId: "<id>",
692
+ requestBody: {},
693
+ });
694
+
695
+ if (!res.ok) {
696
+ throw res.error;
697
+ }
698
+
699
+ const { value: result } = res;
700
+
701
+ // Handle the result
702
+ console.log(result);
703
+ }
704
+
705
+ run();
706
+ ```
707
+
708
+ ### Parameters
709
+
710
+ | Parameter | Type | Required | Description |
711
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
712
+ | `request` | [operations.CreateDatasourceRequest](../../models/operations/createdatasourcerequest.md) | :heavy_check_mark: | The request object to use for the request. |
713
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
714
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
715
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
716
+
717
+ ### Response
718
+
719
+ **Promise\<[operations.CreateDatasourceResponseBody](../../models/operations/createdatasourceresponsebody.md)\>**
720
+
721
+ ### Errors
722
+
723
+ | Error Type | Status Code | Content Type |
724
+ | --------------- | --------------- | --------------- |
725
+ | errors.APIError | 4XX, 5XX | \*/\* |
726
+
727
+ ## retrieveDatasource
728
+
729
+ Retrieve a datasource
730
+
731
+ ### Example Usage
732
+
733
+ ```typescript
734
+ import { Orq } from "@orq-ai/node";
735
+
736
+ const orq = new Orq({
737
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
738
+ });
739
+
740
+ async function run() {
741
+ const result = await orq.knowledge.retrieveDatasource({
742
+ knowledgeId: "<id>",
743
+ datasourceId: "<id>",
744
+ });
745
+
746
+ // Handle the result
747
+ console.log(result);
748
+ }
749
+
750
+ run();
751
+ ```
752
+
753
+ ### Standalone function
754
+
755
+ The standalone function version of this method:
756
+
757
+ ```typescript
758
+ import { OrqCore } from "@orq-ai/node/core.js";
759
+ import { knowledgeRetrieveDatasource } from "@orq-ai/node/funcs/knowledgeRetrieveDatasource.js";
760
+
761
+ // Use `OrqCore` for best tree-shaking performance.
762
+ // You can create one instance of it to use across an application.
763
+ const orq = new OrqCore({
764
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
765
+ });
766
+
767
+ async function run() {
768
+ const res = await knowledgeRetrieveDatasource(orq, {
769
+ knowledgeId: "<id>",
770
+ datasourceId: "<id>",
771
+ });
772
+
773
+ if (!res.ok) {
774
+ throw res.error;
775
+ }
776
+
777
+ const { value: result } = res;
778
+
779
+ // Handle the result
780
+ console.log(result);
781
+ }
782
+
783
+ run();
784
+ ```
785
+
786
+ ### Parameters
787
+
788
+ | Parameter | Type | Required | Description |
789
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
790
+ | `request` | [operations.RetrieveDatasourceRequest](../../models/operations/retrievedatasourcerequest.md) | :heavy_check_mark: | The request object to use for the request. |
791
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
792
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
793
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
794
+
795
+ ### Response
796
+
797
+ **Promise\<[operations.RetrieveDatasourceResponseBody](../../models/operations/retrievedatasourceresponsebody.md)\>**
798
+
799
+ ### Errors
800
+
801
+ | Error Type | Status Code | Content Type |
802
+ | --------------- | --------------- | --------------- |
803
+ | errors.APIError | 4XX, 5XX | \*/\* |
804
+
805
+ ## deleteDatasource
806
+
807
+ Deletes a datasource from a knowledge base. Deleting a datasource will remove it from the knowledge base and all associated chunks. This action is irreversible and cannot be undone.
808
+
809
+ ### Example Usage
810
+
811
+ ```typescript
812
+ import { Orq } from "@orq-ai/node";
813
+
814
+ const orq = new Orq({
815
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
816
+ });
817
+
818
+ async function run() {
819
+ await orq.knowledge.deleteDatasource({
820
+ knowledgeId: "<id>",
821
+ datasourceId: "<id>",
822
+ });
823
+
824
+
825
+ }
826
+
827
+ run();
828
+ ```
829
+
830
+ ### Standalone function
831
+
832
+ The standalone function version of this method:
833
+
834
+ ```typescript
835
+ import { OrqCore } from "@orq-ai/node/core.js";
836
+ import { knowledgeDeleteDatasource } from "@orq-ai/node/funcs/knowledgeDeleteDatasource.js";
837
+
838
+ // Use `OrqCore` for best tree-shaking performance.
839
+ // You can create one instance of it to use across an application.
840
+ const orq = new OrqCore({
841
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
842
+ });
843
+
844
+ async function run() {
845
+ const res = await knowledgeDeleteDatasource(orq, {
846
+ knowledgeId: "<id>",
847
+ datasourceId: "<id>",
848
+ });
849
+
850
+ if (!res.ok) {
851
+ throw res.error;
852
+ }
853
+
854
+ const { value: result } = res;
855
+
856
+
857
+ }
858
+
859
+ run();
860
+ ```
861
+
862
+ ### Parameters
863
+
864
+ | Parameter | Type | Required | Description |
865
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
866
+ | `request` | [operations.DeleteDatasourceRequest](../../models/operations/deletedatasourcerequest.md) | :heavy_check_mark: | The request object to use for the request. |
867
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
868
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
869
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
870
+
871
+ ### Response
872
+
873
+ **Promise\<void\>**
874
+
875
+ ### Errors
876
+
877
+ | Error Type | Status Code | Content Type |
878
+ | --------------- | --------------- | --------------- |
879
+ | errors.APIError | 4XX, 5XX | \*/\* |
880
+
881
+ ## createChunks
882
+
883
+ Create chunks for a datasource
884
+
885
+ ### Example Usage
886
+
887
+ ```typescript
888
+ import { Orq } from "@orq-ai/node";
889
+
890
+ const orq = new Orq({
891
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
892
+ });
893
+
894
+ async function run() {
895
+ const result = await orq.knowledge.createChunks({
896
+ knowledgeId: "<id>",
897
+ datasourceId: "<id>",
898
+ });
899
+
900
+ // Handle the result
901
+ console.log(result);
902
+ }
903
+
904
+ run();
905
+ ```
906
+
907
+ ### Standalone function
908
+
909
+ The standalone function version of this method:
910
+
911
+ ```typescript
912
+ import { OrqCore } from "@orq-ai/node/core.js";
913
+ import { knowledgeCreateChunks } from "@orq-ai/node/funcs/knowledgeCreateChunks.js";
914
+
915
+ // Use `OrqCore` for best tree-shaking performance.
916
+ // You can create one instance of it to use across an application.
917
+ const orq = new OrqCore({
918
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
919
+ });
920
+
921
+ async function run() {
922
+ const res = await knowledgeCreateChunks(orq, {
923
+ knowledgeId: "<id>",
924
+ datasourceId: "<id>",
925
+ });
926
+
927
+ if (!res.ok) {
928
+ throw res.error;
929
+ }
930
+
931
+ const { value: result } = res;
932
+
933
+ // Handle the result
934
+ console.log(result);
935
+ }
936
+
937
+ run();
938
+ ```
939
+
940
+ ### Parameters
941
+
942
+ | Parameter | Type | Required | Description |
943
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
944
+ | `request` | [operations.CreateChunkRequest](../../models/operations/createchunkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
945
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
946
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
947
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
948
+
949
+ ### Response
950
+
951
+ **Promise\<[operations.CreateChunkResponseBody[]](../../models/.md)\>**
952
+
953
+ ### Errors
954
+
955
+ | Error Type | Status Code | Content Type |
956
+ | --------------- | --------------- | --------------- |
957
+ | errors.APIError | 4XX, 5XX | \*/\* |
958
+
959
+ ## listChunks
960
+
961
+ List all chunks for a datasource
962
+
963
+ ### Example Usage
964
+
965
+ ```typescript
966
+ import { Orq } from "@orq-ai/node";
967
+
968
+ const orq = new Orq({
969
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
970
+ });
971
+
972
+ async function run() {
973
+ const result = await orq.knowledge.listChunks({
974
+ knowledgeId: "<id>",
975
+ datasourceId: "<id>",
976
+ });
977
+
978
+ // Handle the result
979
+ console.log(result);
980
+ }
981
+
982
+ run();
983
+ ```
984
+
985
+ ### Standalone function
986
+
987
+ The standalone function version of this method:
988
+
989
+ ```typescript
990
+ import { OrqCore } from "@orq-ai/node/core.js";
991
+ import { knowledgeListChunks } from "@orq-ai/node/funcs/knowledgeListChunks.js";
992
+
993
+ // Use `OrqCore` for best tree-shaking performance.
994
+ // You can create one instance of it to use across an application.
995
+ const orq = new OrqCore({
996
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
997
+ });
998
+
999
+ async function run() {
1000
+ const res = await knowledgeListChunks(orq, {
1001
+ knowledgeId: "<id>",
1002
+ datasourceId: "<id>",
1003
+ });
1004
+
1005
+ if (!res.ok) {
1006
+ throw res.error;
1007
+ }
1008
+
1009
+ const { value: result } = res;
1010
+
1011
+ // Handle the result
1012
+ console.log(result);
1013
+ }
1014
+
1015
+ run();
1016
+ ```
1017
+
1018
+ ### Parameters
1019
+
1020
+ | Parameter | Type | Required | Description |
1021
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1022
+ | `request` | [operations.ListChunksRequest](../../models/operations/listchunksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1023
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1024
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1025
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1026
+
1027
+ ### Response
1028
+
1029
+ **Promise\<[operations.ListChunksResponseBody](../../models/operations/listchunksresponsebody.md)\>**
1030
+
1031
+ ### Errors
1032
+
1033
+ | Error Type | Status Code | Content Type |
1034
+ | --------------- | --------------- | --------------- |
1035
+ | errors.APIError | 4XX, 5XX | \*/\* |
1036
+
1037
+ ## updateChunk
1038
+
1039
+ Update a chunk
1040
+
1041
+ ### Example Usage
1042
+
1043
+ ```typescript
1044
+ import { Orq } from "@orq-ai/node";
1045
+
1046
+ const orq = new Orq({
1047
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1048
+ });
1049
+
1050
+ async function run() {
1051
+ const result = await orq.knowledge.updateChunk({
1052
+ chunkId: "<id>",
1053
+ datasourceId: "<id>",
1054
+ knowledgeId: "<id>",
1055
+ });
1056
+
1057
+ // Handle the result
1058
+ console.log(result);
1059
+ }
1060
+
1061
+ run();
1062
+ ```
1063
+
1064
+ ### Standalone function
1065
+
1066
+ The standalone function version of this method:
1067
+
1068
+ ```typescript
1069
+ import { OrqCore } from "@orq-ai/node/core.js";
1070
+ import { knowledgeUpdateChunk } from "@orq-ai/node/funcs/knowledgeUpdateChunk.js";
1071
+
1072
+ // Use `OrqCore` for best tree-shaking performance.
1073
+ // You can create one instance of it to use across an application.
1074
+ const orq = new OrqCore({
1075
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1076
+ });
1077
+
1078
+ async function run() {
1079
+ const res = await knowledgeUpdateChunk(orq, {
1080
+ chunkId: "<id>",
1081
+ datasourceId: "<id>",
1082
+ knowledgeId: "<id>",
1083
+ });
1084
+
1085
+ if (!res.ok) {
1086
+ throw res.error;
1087
+ }
1088
+
1089
+ const { value: result } = res;
1090
+
1091
+ // Handle the result
1092
+ console.log(result);
1093
+ }
1094
+
1095
+ run();
1096
+ ```
1097
+
1098
+ ### Parameters
1099
+
1100
+ | Parameter | Type | Required | Description |
1101
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1102
+ | `request` | [operations.UpdateChunkRequest](../../models/operations/updatechunkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1103
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1104
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1105
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1106
+
1107
+ ### Response
1108
+
1109
+ **Promise\<[operations.UpdateChunkResponseBody](../../models/operations/updatechunkresponsebody.md)\>**
1110
+
1111
+ ### Errors
1112
+
1113
+ | Error Type | Status Code | Content Type |
1114
+ | --------------- | --------------- | --------------- |
1115
+ | errors.APIError | 4XX, 5XX | \*/\* |
1116
+
1117
+ ## deleteChunk
1118
+
1119
+ Delete a chunk
1120
+
1121
+ ### Example Usage
1122
+
1123
+ ```typescript
1124
+ import { Orq } from "@orq-ai/node";
1125
+
1126
+ const orq = new Orq({
1127
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1128
+ });
1129
+
1130
+ async function run() {
1131
+ await orq.knowledge.deleteChunk({
1132
+ chunkId: "<id>",
1133
+ datasourceId: "<id>",
1134
+ knowledgeId: "<id>",
1135
+ });
1136
+
1137
+
1138
+ }
1139
+
1140
+ run();
1141
+ ```
1142
+
1143
+ ### Standalone function
1144
+
1145
+ The standalone function version of this method:
1146
+
1147
+ ```typescript
1148
+ import { OrqCore } from "@orq-ai/node/core.js";
1149
+ import { knowledgeDeleteChunk } from "@orq-ai/node/funcs/knowledgeDeleteChunk.js";
1150
+
1151
+ // Use `OrqCore` for best tree-shaking performance.
1152
+ // You can create one instance of it to use across an application.
1153
+ const orq = new OrqCore({
1154
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
1155
+ });
1156
+
1157
+ async function run() {
1158
+ const res = await knowledgeDeleteChunk(orq, {
1159
+ chunkId: "<id>",
1160
+ datasourceId: "<id>",
1161
+ knowledgeId: "<id>",
1162
+ });
1163
+
1164
+ if (!res.ok) {
1165
+ throw res.error;
1166
+ }
1167
+
1168
+ const { value: result } = res;
1169
+
1170
+
1171
+ }
1172
+
1173
+ run();
1174
+ ```
1175
+
1176
+ ### Parameters
1177
+
1178
+ | Parameter | Type | Required | Description |
1179
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1180
+ | `request` | [operations.DeleteChunkRequest](../../models/operations/deletechunkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1181
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1182
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1183
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1184
+
1185
+ ### Response
1186
+
1187
+ **Promise\<void\>**
1188
+
1189
+ ### Errors
1190
+
1191
+ | Error Type | Status Code | Content Type |
1192
+ | --------------- | --------------- | --------------- |
1193
+ | errors.APIError | 4XX, 5XX | \*/\* |