@orq-ai/node 3.5.12 → 3.6.0-rc.10

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