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