@orq-ai/node 3.9.0-rc.8 → 3.9.0

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