@orq-ai/node 3.10.0-rc.9 → 3.10.2

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