@orq-ai/node 3.5.13 → 3.6.0-rc.11

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