@orq-ai/node 3.6.2 → 3.7.0-rc.2

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