@orq-ai/node 3.14.8 → 4.0.0-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (494) hide show
  1. package/bin/mcp-server.js +210 -213
  2. package/bin/mcp-server.js.map +38 -38
  3. package/docs/sdks/agents/README.md +8 -4
  4. package/docs/sdks/budgets/README.md +4 -2
  5. package/docs/sdks/tools/README.md +4 -2
  6. package/examples/package-lock.json +5 -6
  7. package/jsr.json +1 -1
  8. package/lib/config.d.ts +2 -2
  9. package/lib/config.js +2 -2
  10. package/lib/config.js.map +1 -1
  11. package/mcp-server/mcp-server.js +1 -1
  12. package/mcp-server/mcp-server.js.map +1 -1
  13. package/mcp-server/server.js +1 -1
  14. package/mcp-server/server.js.map +1 -1
  15. package/models/operations/createbudget.js +2 -2
  16. package/models/operations/createcontact.js +2 -2
  17. package/models/operations/createdataset.js +2 -2
  18. package/models/operations/createdatasetitem.js +8 -8
  19. package/models/operations/createdatasource.js +2 -2
  20. package/models/operations/createeval.js +28 -28
  21. package/models/operations/createtool.js +10 -10
  22. package/models/operations/duplicatetool.js +10 -10
  23. package/models/operations/fileget.js +2 -2
  24. package/models/operations/filelist.js +2 -2
  25. package/models/operations/fileupload.js +2 -2
  26. package/models/operations/getalltools.js +10 -10
  27. package/models/operations/getbudget.js +2 -2
  28. package/models/operations/getevals.js +28 -28
  29. package/models/operations/listbudgets.js +2 -2
  30. package/models/operations/listcontacts.js +2 -2
  31. package/models/operations/listdatasetdatapoints.js +8 -8
  32. package/models/operations/listdatasets.js +2 -2
  33. package/models/operations/listdatasources.js +2 -2
  34. package/models/operations/retrievecontact.js +2 -2
  35. package/models/operations/retrievedatapoint.js +8 -8
  36. package/models/operations/retrievedataset.js +2 -2
  37. package/models/operations/retrievedatasource.js +2 -2
  38. package/models/operations/retrievetool.js +10 -10
  39. package/models/operations/updatebudget.js +2 -2
  40. package/models/operations/updatecontact.js +2 -2
  41. package/models/operations/updatedatapoint.js +8 -8
  42. package/models/operations/updatedataset.js +2 -2
  43. package/models/operations/updatedatasource.js +2 -2
  44. package/models/operations/updateeval.js +28 -28
  45. package/models/operations/updatetool.js +10 -10
  46. package/package.json +4 -4
  47. package/src/lib/config.ts +2 -2
  48. package/src/mcp-server/mcp-server.ts +1 -1
  49. package/src/mcp-server/server.ts +1 -1
  50. package/src/models/operations/createbudget.ts +2 -2
  51. package/src/models/operations/createcontact.ts +2 -2
  52. package/src/models/operations/createdataset.ts +2 -2
  53. package/src/models/operations/createdatasetitem.ts +8 -8
  54. package/src/models/operations/createdatasource.ts +2 -2
  55. package/src/models/operations/createeval.ts +28 -28
  56. package/src/models/operations/createtool.ts +10 -10
  57. package/src/models/operations/duplicatetool.ts +10 -10
  58. package/src/models/operations/fileget.ts +2 -2
  59. package/src/models/operations/filelist.ts +2 -2
  60. package/src/models/operations/fileupload.ts +2 -2
  61. package/src/models/operations/getalltools.ts +10 -10
  62. package/src/models/operations/getbudget.ts +2 -2
  63. package/src/models/operations/getevals.ts +28 -28
  64. package/src/models/operations/listbudgets.ts +2 -2
  65. package/src/models/operations/listcontacts.ts +2 -2
  66. package/src/models/operations/listdatasetdatapoints.ts +8 -8
  67. package/src/models/operations/listdatasets.ts +2 -2
  68. package/src/models/operations/listdatasources.ts +2 -2
  69. package/src/models/operations/retrievecontact.ts +2 -2
  70. package/src/models/operations/retrievedatapoint.ts +8 -8
  71. package/src/models/operations/retrievedataset.ts +2 -2
  72. package/src/models/operations/retrievedatasource.ts +2 -2
  73. package/src/models/operations/retrievetool.ts +10 -10
  74. package/src/models/operations/updatebudget.ts +2 -2
  75. package/src/models/operations/updatecontact.ts +2 -2
  76. package/src/models/operations/updatedatapoint.ts +8 -8
  77. package/src/models/operations/updatedataset.ts +2 -2
  78. package/src/models/operations/updatedatasource.ts +2 -2
  79. package/src/models/operations/updateeval.ts +28 -28
  80. package/src/models/operations/updatetool.ts +10 -10
  81. package/packages/orq-rc/FUNCTIONS.md +0 -103
  82. package/packages/orq-rc/README.md +0 -909
  83. package/packages/orq-rc/RUNTIMES.md +0 -48
  84. package/packages/orq-rc/docs/sdks/agents/README.md +0 -1319
  85. package/packages/orq-rc/docs/sdks/budgets/README.md +0 -401
  86. package/packages/orq-rc/docs/sdks/chunking/README.md +0 -95
  87. package/packages/orq-rc/docs/sdks/contacts/README.md +0 -450
  88. package/packages/orq-rc/docs/sdks/datasets/README.md +0 -836
  89. package/packages/orq-rc/docs/sdks/deployments/README.md +0 -312
  90. package/packages/orq-rc/docs/sdks/evals/README.md +0 -339
  91. package/packages/orq-rc/docs/sdks/feedback/README.md +0 -89
  92. package/packages/orq-rc/docs/sdks/files/README.md +0 -301
  93. package/packages/orq-rc/docs/sdks/knowledge/README.md +0 -1489
  94. package/packages/orq-rc/docs/sdks/memorystores/README.md +0 -1172
  95. package/packages/orq-rc/docs/sdks/metrics/README.md +0 -83
  96. package/packages/orq-rc/docs/sdks/models/README.md +0 -76
  97. package/packages/orq-rc/docs/sdks/prompts/README.md +0 -591
  98. package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +0 -77
  99. package/packages/orq-rc/docs/sdks/tools/README.md +0 -490
  100. package/packages/orq-rc/examples/README.md +0 -31
  101. package/packages/orq-rc/examples/contactsCreate.example.ts +0 -42
  102. package/packages/orq-rc/examples/package-lock.json +0 -627
  103. package/packages/orq-rc/examples/package.json +0 -18
  104. package/packages/orq-rc/jsr.json +0 -28
  105. package/packages/orq-rc/package-lock.json +0 -3071
  106. package/packages/orq-rc/package.json +0 -43
  107. package/packages/orq-rc/src/core.ts +0 -13
  108. package/packages/orq-rc/src/funcs/agentsCreate.ts +0 -172
  109. package/packages/orq-rc/src/funcs/agentsDelete.ts +0 -176
  110. package/packages/orq-rc/src/funcs/agentsInvoke.ts +0 -167
  111. package/packages/orq-rc/src/funcs/agentsList.ts +0 -167
  112. package/packages/orq-rc/src/funcs/agentsListActions.ts +0 -169
  113. package/packages/orq-rc/src/funcs/agentsListTasks.ts +0 -183
  114. package/packages/orq-rc/src/funcs/agentsRetrieve.ts +0 -175
  115. package/packages/orq-rc/src/funcs/agentsRetrieveAction.ts +0 -173
  116. package/packages/orq-rc/src/funcs/agentsRetrieveTask.ts +0 -179
  117. package/packages/orq-rc/src/funcs/agentsRun.ts +0 -163
  118. package/packages/orq-rc/src/funcs/agentsStream.ts +0 -190
  119. package/packages/orq-rc/src/funcs/agentsStreamRun.ts +0 -188
  120. package/packages/orq-rc/src/funcs/agentsUpdate.ts +0 -176
  121. package/packages/orq-rc/src/funcs/budgetsCreate.ts +0 -160
  122. package/packages/orq-rc/src/funcs/budgetsDelete.ts +0 -167
  123. package/packages/orq-rc/src/funcs/budgetsGet.ts +0 -166
  124. package/packages/orq-rc/src/funcs/budgetsList.ts +0 -170
  125. package/packages/orq-rc/src/funcs/budgetsUpdate.ts +0 -167
  126. package/packages/orq-rc/src/funcs/chunkingParse.ts +0 -160
  127. package/packages/orq-rc/src/funcs/contactsCreate.ts +0 -165
  128. package/packages/orq-rc/src/funcs/contactsDelete.ts +0 -176
  129. package/packages/orq-rc/src/funcs/contactsList.ts +0 -169
  130. package/packages/orq-rc/src/funcs/contactsRetrieve.ts +0 -175
  131. package/packages/orq-rc/src/funcs/contactsUpdate.ts +0 -176
  132. package/packages/orq-rc/src/funcs/datasetsClear.ts +0 -167
  133. package/packages/orq-rc/src/funcs/datasetsCreate.ts +0 -165
  134. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +0 -171
  135. package/packages/orq-rc/src/funcs/datasetsDelete.ts +0 -167
  136. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +0 -182
  137. package/packages/orq-rc/src/funcs/datasetsList.ts +0 -167
  138. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +0 -174
  139. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +0 -175
  140. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +0 -181
  141. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +0 -176
  142. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +0 -179
  143. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +0 -168
  144. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +0 -176
  145. package/packages/orq-rc/src/funcs/deploymentsList.ts +0 -176
  146. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +0 -168
  147. package/packages/orq-rc/src/funcs/deploymentsStream.ts +0 -183
  148. package/packages/orq-rc/src/funcs/evalsAll.ts +0 -173
  149. package/packages/orq-rc/src/funcs/evalsCreate.ts +0 -169
  150. package/packages/orq-rc/src/funcs/evalsDelete.ts +0 -173
  151. package/packages/orq-rc/src/funcs/evalsUpdate.ts +0 -173
  152. package/packages/orq-rc/src/funcs/feedbackCreate.ts +0 -160
  153. package/packages/orq-rc/src/funcs/filesCreate.ts +0 -187
  154. package/packages/orq-rc/src/funcs/filesDelete.ts +0 -164
  155. package/packages/orq-rc/src/funcs/filesGet.ts +0 -166
  156. package/packages/orq-rc/src/funcs/filesList.ts +0 -167
  157. package/packages/orq-rc/src/funcs/knowledgeCreate.ts +0 -158
  158. package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +0 -171
  159. package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +0 -166
  160. package/packages/orq-rc/src/funcs/knowledgeDelete.ts +0 -167
  161. package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +0 -174
  162. package/packages/orq-rc/src/funcs/knowledgeDeleteChunks.ts +0 -170
  163. package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +0 -173
  164. package/packages/orq-rc/src/funcs/knowledgeGetChunksCount.ts +0 -170
  165. package/packages/orq-rc/src/funcs/knowledgeList.ts +0 -169
  166. package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +0 -178
  167. package/packages/orq-rc/src/funcs/knowledgeListChunksPaginated.ts +0 -171
  168. package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +0 -174
  169. package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +0 -166
  170. package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +0 -173
  171. package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +0 -169
  172. package/packages/orq-rc/src/funcs/knowledgeSearch.ts +0 -167
  173. package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +0 -164
  174. package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +0 -174
  175. package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +0 -170
  176. package/packages/orq-rc/src/funcs/memoryStoresCreate.ts +0 -171
  177. package/packages/orq-rc/src/funcs/memoryStoresCreateDocument.ts +0 -175
  178. package/packages/orq-rc/src/funcs/memoryStoresCreateMemory.ts +0 -170
  179. package/packages/orq-rc/src/funcs/memoryStoresDelete.ts +0 -168
  180. package/packages/orq-rc/src/funcs/memoryStoresDeleteDocument.ts +0 -184
  181. package/packages/orq-rc/src/funcs/memoryStoresDeleteMemory.ts +0 -179
  182. package/packages/orq-rc/src/funcs/memoryStoresList.ts +0 -178
  183. package/packages/orq-rc/src/funcs/memoryStoresListDocuments.ts +0 -181
  184. package/packages/orq-rc/src/funcs/memoryStoresListMemories.ts +0 -176
  185. package/packages/orq-rc/src/funcs/memoryStoresRetrieve.ts +0 -177
  186. package/packages/orq-rc/src/funcs/memoryStoresRetrieveDocument.ts +0 -178
  187. package/packages/orq-rc/src/funcs/memoryStoresRetrieveMemory.ts +0 -173
  188. package/packages/orq-rc/src/funcs/memoryStoresUpdate.ts +0 -168
  189. package/packages/orq-rc/src/funcs/memoryStoresUpdateDocument.ts +0 -179
  190. package/packages/orq-rc/src/funcs/memoryStoresUpdateMemory.ts +0 -174
  191. package/packages/orq-rc/src/funcs/modelsList.ts +0 -142
  192. package/packages/orq-rc/src/funcs/promptsCreate.ts +0 -160
  193. package/packages/orq-rc/src/funcs/promptsDelete.ts +0 -164
  194. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +0 -181
  195. package/packages/orq-rc/src/funcs/promptsList.ts +0 -167
  196. package/packages/orq-rc/src/funcs/promptsListVersions.ts +0 -173
  197. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +0 -166
  198. package/packages/orq-rc/src/funcs/promptsUpdate.ts +0 -173
  199. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +0 -161
  200. package/packages/orq-rc/src/funcs/toolsCreate.ts +0 -163
  201. package/packages/orq-rc/src/funcs/toolsDelete.ts +0 -167
  202. package/packages/orq-rc/src/funcs/toolsDuplicate.ts +0 -175
  203. package/packages/orq-rc/src/funcs/toolsList.ts +0 -176
  204. package/packages/orq-rc/src/funcs/toolsRetrieve.ts +0 -166
  205. package/packages/orq-rc/src/funcs/toolsUpdate.ts +0 -176
  206. package/packages/orq-rc/src/hooks/global.ts +0 -44
  207. package/packages/orq-rc/src/hooks/hooks.ts +0 -132
  208. package/packages/orq-rc/src/hooks/index.ts +0 -6
  209. package/packages/orq-rc/src/hooks/registration.ts +0 -15
  210. package/packages/orq-rc/src/hooks/types.ts +0 -112
  211. package/packages/orq-rc/src/index.ts +0 -9
  212. package/packages/orq-rc/src/lib/base64.ts +0 -37
  213. package/packages/orq-rc/src/lib/config.ts +0 -74
  214. package/packages/orq-rc/src/lib/dlv.ts +0 -53
  215. package/packages/orq-rc/src/lib/encodings.ts +0 -483
  216. package/packages/orq-rc/src/lib/env.ts +0 -89
  217. package/packages/orq-rc/src/lib/event-streams.ts +0 -135
  218. package/packages/orq-rc/src/lib/files.ts +0 -82
  219. package/packages/orq-rc/src/lib/http.ts +0 -323
  220. package/packages/orq-rc/src/lib/is-plain-object.ts +0 -43
  221. package/packages/orq-rc/src/lib/logger.ts +0 -9
  222. package/packages/orq-rc/src/lib/matchers.ts +0 -345
  223. package/packages/orq-rc/src/lib/primitives.ts +0 -150
  224. package/packages/orq-rc/src/lib/retries.ts +0 -218
  225. package/packages/orq-rc/src/lib/schemas.ts +0 -91
  226. package/packages/orq-rc/src/lib/sdks.ts +0 -407
  227. package/packages/orq-rc/src/lib/security.ts +0 -264
  228. package/packages/orq-rc/src/lib/url.ts +0 -33
  229. package/packages/orq-rc/src/mcp-server/cli/start/command.ts +0 -111
  230. package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +0 -136
  231. package/packages/orq-rc/src/mcp-server/cli.ts +0 -13
  232. package/packages/orq-rc/src/mcp-server/console-logger.ts +0 -71
  233. package/packages/orq-rc/src/mcp-server/extensions.ts +0 -17
  234. package/packages/orq-rc/src/mcp-server/mcp-server.ts +0 -26
  235. package/packages/orq-rc/src/mcp-server/prompts.ts +0 -117
  236. package/packages/orq-rc/src/mcp-server/resources.ts +0 -172
  237. package/packages/orq-rc/src/mcp-server/scopes.ts +0 -7
  238. package/packages/orq-rc/src/mcp-server/server.ts +0 -259
  239. package/packages/orq-rc/src/mcp-server/shared.ts +0 -74
  240. package/packages/orq-rc/src/mcp-server/tools/agentsCreate.ts +0 -37
  241. package/packages/orq-rc/src/mcp-server/tools/agentsDelete.ts +0 -35
  242. package/packages/orq-rc/src/mcp-server/tools/agentsInvoke.ts +0 -37
  243. package/packages/orq-rc/src/mcp-server/tools/agentsList.ts +0 -37
  244. package/packages/orq-rc/src/mcp-server/tools/agentsListActions.ts +0 -35
  245. package/packages/orq-rc/src/mcp-server/tools/agentsListTasks.ts +0 -37
  246. package/packages/orq-rc/src/mcp-server/tools/agentsRetrieve.ts +0 -37
  247. package/packages/orq-rc/src/mcp-server/tools/agentsRetrieveAction.ts +0 -35
  248. package/packages/orq-rc/src/mcp-server/tools/agentsRetrieveTask.ts +0 -37
  249. package/packages/orq-rc/src/mcp-server/tools/agentsRun.ts +0 -37
  250. package/packages/orq-rc/src/mcp-server/tools/agentsStream.ts +0 -37
  251. package/packages/orq-rc/src/mcp-server/tools/agentsStreamRun.ts +0 -37
  252. package/packages/orq-rc/src/mcp-server/tools/agentsUpdate.ts +0 -37
  253. package/packages/orq-rc/src/mcp-server/tools/budgetsCreate.ts +0 -37
  254. package/packages/orq-rc/src/mcp-server/tools/budgetsDelete.ts +0 -35
  255. package/packages/orq-rc/src/mcp-server/tools/budgetsGet.ts +0 -37
  256. package/packages/orq-rc/src/mcp-server/tools/budgetsList.ts +0 -37
  257. package/packages/orq-rc/src/mcp-server/tools/budgetsUpdate.ts +0 -37
  258. package/packages/orq-rc/src/mcp-server/tools/chunkingParse.ts +0 -37
  259. package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +0 -37
  260. package/packages/orq-rc/src/mcp-server/tools/contactsDelete.ts +0 -35
  261. package/packages/orq-rc/src/mcp-server/tools/contactsList.ts +0 -37
  262. package/packages/orq-rc/src/mcp-server/tools/contactsRetrieve.ts +0 -37
  263. package/packages/orq-rc/src/mcp-server/tools/contactsUpdate.ts +0 -37
  264. package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +0 -35
  265. package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +0 -37
  266. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +0 -37
  267. package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +0 -35
  268. package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +0 -35
  269. package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +0 -37
  270. package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +0 -37
  271. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +0 -37
  272. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +0 -37
  273. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +0 -37
  274. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +0 -35
  275. package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +0 -37
  276. package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +0 -37
  277. package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +0 -37
  278. package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +0 -37
  279. package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +0 -37
  280. package/packages/orq-rc/src/mcp-server/tools/evalsAll.ts +0 -35
  281. package/packages/orq-rc/src/mcp-server/tools/evalsCreate.ts +0 -35
  282. package/packages/orq-rc/src/mcp-server/tools/evalsDelete.ts +0 -33
  283. package/packages/orq-rc/src/mcp-server/tools/evalsUpdate.ts +0 -35
  284. package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +0 -37
  285. package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +0 -37
  286. package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +0 -33
  287. package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +0 -37
  288. package/packages/orq-rc/src/mcp-server/tools/filesList.ts +0 -37
  289. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +0 -35
  290. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +0 -35
  291. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +0 -35
  292. package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +0 -35
  293. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +0 -33
  294. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunks.ts +0 -35
  295. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +0 -35
  296. package/packages/orq-rc/src/mcp-server/tools/knowledgeGetChunksCount.ts +0 -35
  297. package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +0 -37
  298. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +0 -35
  299. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunksPaginated.ts +0 -35
  300. package/packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts +0 -35
  301. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +0 -37
  302. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +0 -35
  303. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +0 -35
  304. package/packages/orq-rc/src/mcp-server/tools/knowledgeSearch.ts +0 -37
  305. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +0 -35
  306. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +0 -35
  307. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +0 -35
  308. package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreate.ts +0 -35
  309. package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreateDocument.ts +0 -37
  310. package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreateMemory.ts +0 -37
  311. package/packages/orq-rc/src/mcp-server/tools/memoryStoresDelete.ts +0 -35
  312. package/packages/orq-rc/src/mcp-server/tools/memoryStoresDeleteDocument.ts +0 -40
  313. package/packages/orq-rc/src/mcp-server/tools/memoryStoresDeleteMemory.ts +0 -40
  314. package/packages/orq-rc/src/mcp-server/tools/memoryStoresList.ts +0 -37
  315. package/packages/orq-rc/src/mcp-server/tools/memoryStoresListDocuments.ts +0 -37
  316. package/packages/orq-rc/src/mcp-server/tools/memoryStoresListMemories.ts +0 -37
  317. package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieve.ts +0 -37
  318. package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieveDocument.ts +0 -37
  319. package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieveMemory.ts +0 -37
  320. package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdate.ts +0 -37
  321. package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdateDocument.ts +0 -37
  322. package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdateMemory.ts +0 -37
  323. package/packages/orq-rc/src/mcp-server/tools/modelsList.ts +0 -30
  324. package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +0 -35
  325. package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +0 -33
  326. package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +0 -37
  327. package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +0 -37
  328. package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +0 -37
  329. package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +0 -37
  330. package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +0 -35
  331. package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +0 -36
  332. package/packages/orq-rc/src/mcp-server/tools/toolsCreate.ts +0 -37
  333. package/packages/orq-rc/src/mcp-server/tools/toolsDelete.ts +0 -35
  334. package/packages/orq-rc/src/mcp-server/tools/toolsDuplicate.ts +0 -37
  335. package/packages/orq-rc/src/mcp-server/tools/toolsList.ts +0 -37
  336. package/packages/orq-rc/src/mcp-server/tools/toolsRetrieve.ts +0 -37
  337. package/packages/orq-rc/src/mcp-server/tools/toolsUpdate.ts +0 -37
  338. package/packages/orq-rc/src/mcp-server/tools.ts +0 -129
  339. package/packages/orq-rc/src/models/components/deployments.ts +0 -8147
  340. package/packages/orq-rc/src/models/components/index.ts +0 -6
  341. package/packages/orq-rc/src/models/components/security.ts +0 -71
  342. package/packages/orq-rc/src/models/errors/apierror.ts +0 -40
  343. package/packages/orq-rc/src/models/errors/createagent.ts +0 -80
  344. package/packages/orq-rc/src/models/errors/createeval.ts +0 -80
  345. package/packages/orq-rc/src/models/errors/deleteagent.ts +0 -80
  346. package/packages/orq-rc/src/models/errors/deletecontact.ts +0 -91
  347. package/packages/orq-rc/src/models/errors/deleteeval.ts +0 -80
  348. package/packages/orq-rc/src/models/errors/duplicatetool.ts +0 -91
  349. package/packages/orq-rc/src/models/errors/getagent.ts +0 -80
  350. package/packages/orq-rc/src/models/errors/getagenttask.ts +0 -80
  351. package/packages/orq-rc/src/models/errors/getevals.ts +0 -80
  352. package/packages/orq-rc/src/models/errors/getpromptversion.ts +0 -80
  353. package/packages/orq-rc/src/models/errors/honoapierror.ts +0 -90
  354. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +0 -62
  355. package/packages/orq-rc/src/models/errors/index.ts +0 -29
  356. package/packages/orq-rc/src/models/errors/listagenttasks.ts +0 -80
  357. package/packages/orq-rc/src/models/errors/orqerror.ts +0 -35
  358. package/packages/orq-rc/src/models/errors/responsevalidationerror.ts +0 -50
  359. package/packages/orq-rc/src/models/errors/retrievecontact.ts +0 -91
  360. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +0 -109
  361. package/packages/orq-rc/src/models/errors/streamagent.ts +0 -80
  362. package/packages/orq-rc/src/models/errors/streamrunagent.ts +0 -80
  363. package/packages/orq-rc/src/models/errors/updateagent.ts +0 -80
  364. package/packages/orq-rc/src/models/errors/updatecontact.ts +0 -83
  365. package/packages/orq-rc/src/models/errors/updateeval.ts +0 -80
  366. package/packages/orq-rc/src/models/errors/updateprompt.ts +0 -80
  367. package/packages/orq-rc/src/models/errors/updatetool.ts +0 -91
  368. package/packages/orq-rc/src/models/operations/cleardataset.ts +0 -78
  369. package/packages/orq-rc/src/models/operations/createagent.ts +0 -3104
  370. package/packages/orq-rc/src/models/operations/createbudget.ts +0 -745
  371. package/packages/orq-rc/src/models/operations/createchunk.ts +0 -428
  372. package/packages/orq-rc/src/models/operations/createcontact.ts +0 -267
  373. package/packages/orq-rc/src/models/operations/createdataset.ts +0 -302
  374. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +0 -6943
  375. package/packages/orq-rc/src/models/operations/createdatasource.ts +0 -852
  376. package/packages/orq-rc/src/models/operations/createeval.ts +0 -9341
  377. package/packages/orq-rc/src/models/operations/createfeedback.ts +0 -286
  378. package/packages/orq-rc/src/models/operations/createknowledge.ts +0 -1850
  379. package/packages/orq-rc/src/models/operations/creatememory.ts +0 -274
  380. package/packages/orq-rc/src/models/operations/creatememorydocument.ts +0 -287
  381. package/packages/orq-rc/src/models/operations/creatememorystore.ts +0 -2032
  382. package/packages/orq-rc/src/models/operations/createprompt.ts +0 -7812
  383. package/packages/orq-rc/src/models/operations/createtool.ts +0 -4077
  384. package/packages/orq-rc/src/models/operations/deleteagent.ts +0 -78
  385. package/packages/orq-rc/src/models/operations/deletebudget.ts +0 -69
  386. package/packages/orq-rc/src/models/operations/deletechunk.ts +0 -96
  387. package/packages/orq-rc/src/models/operations/deletechunks.ts +0 -243
  388. package/packages/orq-rc/src/models/operations/deletecontact.ts +0 -69
  389. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +0 -87
  390. package/packages/orq-rc/src/models/operations/deletedataset.ts +0 -78
  391. package/packages/orq-rc/src/models/operations/deletedatasource.ts +0 -87
  392. package/packages/orq-rc/src/models/operations/deleteeval.ts +0 -66
  393. package/packages/orq-rc/src/models/operations/deleteknowledge.ts +0 -78
  394. package/packages/orq-rc/src/models/operations/deletememory.ts +0 -87
  395. package/packages/orq-rc/src/models/operations/deletememorydocument.ts +0 -98
  396. package/packages/orq-rc/src/models/operations/deletememorystore.ts +0 -78
  397. package/packages/orq-rc/src/models/operations/deleteprompt.ts +0 -69
  398. package/packages/orq-rc/src/models/operations/deletetool.ts +0 -75
  399. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +0 -6547
  400. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +0 -10532
  401. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +0 -1266
  402. package/packages/orq-rc/src/models/operations/deployments.ts +0 -2606
  403. package/packages/orq-rc/src/models/operations/deploymentstream.ts +0 -10655
  404. package/packages/orq-rc/src/models/operations/duplicatetool.ts +0 -2349
  405. package/packages/orq-rc/src/models/operations/filedelete.ts +0 -78
  406. package/packages/orq-rc/src/models/operations/fileget.ts +0 -223
  407. package/packages/orq-rc/src/models/operations/filelist.ts +0 -337
  408. package/packages/orq-rc/src/models/operations/fileupload.ts +0 -327
  409. package/packages/orq-rc/src/models/operations/getagent.ts +0 -957
  410. package/packages/orq-rc/src/models/operations/getagenttask.ts +0 -259
  411. package/packages/orq-rc/src/models/operations/getallmemories.ts +0 -318
  412. package/packages/orq-rc/src/models/operations/getallmemorydocuments.ts +0 -338
  413. package/packages/orq-rc/src/models/operations/getallmemorystores.ts +0 -1277
  414. package/packages/orq-rc/src/models/operations/getallprompts.ts +0 -2572
  415. package/packages/orq-rc/src/models/operations/getalltools.ts +0 -2308
  416. package/packages/orq-rc/src/models/operations/getbudget.ts +0 -441
  417. package/packages/orq-rc/src/models/operations/getchunkscount.ts +0 -230
  418. package/packages/orq-rc/src/models/operations/getevals.ts +0 -7486
  419. package/packages/orq-rc/src/models/operations/getonechunk.ts +0 -315
  420. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +0 -1292
  421. package/packages/orq-rc/src/models/operations/getoneprompt.ts +0 -2437
  422. package/packages/orq-rc/src/models/operations/getpromptversion.ts +0 -2444
  423. package/packages/orq-rc/src/models/operations/index.ts +0 -102
  424. package/packages/orq-rc/src/models/operations/invokeagent.ts +0 -1569
  425. package/packages/orq-rc/src/models/operations/listactions.ts +0 -526
  426. package/packages/orq-rc/src/models/operations/listagents.ts +0 -1077
  427. package/packages/orq-rc/src/models/operations/listagenttasks.ts +0 -1106
  428. package/packages/orq-rc/src/models/operations/listbudgets.ts +0 -617
  429. package/packages/orq-rc/src/models/operations/listchunks.ts +0 -494
  430. package/packages/orq-rc/src/models/operations/listchunkspaginated.ts +0 -507
  431. package/packages/orq-rc/src/models/operations/listcontacts.ts +0 -500
  432. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +0 -4086
  433. package/packages/orq-rc/src/models/operations/listdatasets.ts +0 -406
  434. package/packages/orq-rc/src/models/operations/listdatasources.ts +0 -454
  435. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +0 -1303
  436. package/packages/orq-rc/src/models/operations/listmodels.ts +0 -273
  437. package/packages/orq-rc/src/models/operations/listpromptversions.ts +0 -2580
  438. package/packages/orq-rc/src/models/operations/parse.ts +0 -1295
  439. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +0 -190
  440. package/packages/orq-rc/src/models/operations/retrieveaction.ts +0 -426
  441. package/packages/orq-rc/src/models/operations/retrievecontact.ts +0 -210
  442. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +0 -3853
  443. package/packages/orq-rc/src/models/operations/retrievedataset.ts +0 -291
  444. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +0 -273
  445. package/packages/orq-rc/src/models/operations/retrievememory.ts +0 -201
  446. package/packages/orq-rc/src/models/operations/retrievememorydocument.ts +0 -220
  447. package/packages/orq-rc/src/models/operations/retrievememorystore.ts +0 -1160
  448. package/packages/orq-rc/src/models/operations/retrievetool.ts +0 -2333
  449. package/packages/orq-rc/src/models/operations/runagent.ts +0 -4342
  450. package/packages/orq-rc/src/models/operations/searchknowledge.ts +0 -3573
  451. package/packages/orq-rc/src/models/operations/streamagent.ts +0 -1367
  452. package/packages/orq-rc/src/models/operations/streamrunagent.ts +0 -4355
  453. package/packages/orq-rc/src/models/operations/updateagent.ts +0 -3321
  454. package/packages/orq-rc/src/models/operations/updatebudget.ts +0 -628
  455. package/packages/orq-rc/src/models/operations/updatechunk.ts +0 -448
  456. package/packages/orq-rc/src/models/operations/updatecontact.ts +0 -325
  457. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +0 -6934
  458. package/packages/orq-rc/src/models/operations/updatedataset.ts +0 -386
  459. package/packages/orq-rc/src/models/operations/updatedatasource.ts +0 -345
  460. package/packages/orq-rc/src/models/operations/updateeval.ts +0 -9704
  461. package/packages/orq-rc/src/models/operations/updateknowledge.ts +0 -2341
  462. package/packages/orq-rc/src/models/operations/updatememory.ts +0 -283
  463. package/packages/orq-rc/src/models/operations/updatememorydocument.ts +0 -296
  464. package/packages/orq-rc/src/models/operations/updatememorystore.ts +0 -1363
  465. package/packages/orq-rc/src/models/operations/updateprompt.ts +0 -8176
  466. package/packages/orq-rc/src/models/operations/updatetool.ts +0 -4288
  467. package/packages/orq-rc/src/sdk/agents.ts +0 -238
  468. package/packages/orq-rc/src/sdk/budgets.ts +0 -99
  469. package/packages/orq-rc/src/sdk/chunking.ts +0 -27
  470. package/packages/orq-rc/src/sdk/contacts.ts +0 -99
  471. package/packages/orq-rc/src/sdk/datasets.ts +0 -204
  472. package/packages/orq-rc/src/sdk/deployments.ts +0 -89
  473. package/packages/orq-rc/src/sdk/evals.ts +0 -69
  474. package/packages/orq-rc/src/sdk/feedback.ts +0 -27
  475. package/packages/orq-rc/src/sdk/files.ts +0 -78
  476. package/packages/orq-rc/src/sdk/index.ts +0 -5
  477. package/packages/orq-rc/src/sdk/knowledge.ts +0 -309
  478. package/packages/orq-rc/src/sdk/memorystores.ts +0 -286
  479. package/packages/orq-rc/src/sdk/metrics.ts +0 -27
  480. package/packages/orq-rc/src/sdk/models.ts +0 -25
  481. package/packages/orq-rc/src/sdk/prompts.ts +0 -126
  482. package/packages/orq-rc/src/sdk/remoteconfigs.ts +0 -24
  483. package/packages/orq-rc/src/sdk/sdk.ts +0 -97
  484. package/packages/orq-rc/src/sdk/tools.ts +0 -117
  485. package/packages/orq-rc/src/types/async.ts +0 -68
  486. package/packages/orq-rc/src/types/blobs.ts +0 -32
  487. package/packages/orq-rc/src/types/constdatetime.ts +0 -15
  488. package/packages/orq-rc/src/types/enums.ts +0 -16
  489. package/packages/orq-rc/src/types/fp.ts +0 -50
  490. package/packages/orq-rc/src/types/index.ts +0 -11
  491. package/packages/orq-rc/src/types/operations.ts +0 -105
  492. package/packages/orq-rc/src/types/rfcdate.ts +0 -54
  493. package/packages/orq-rc/src/types/streams.ts +0 -21
  494. package/packages/orq-rc/tsconfig.json +0 -41
@@ -1,1489 +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
- * [deleteChunks](#deletechunks) - Delete multiple chunks
22
- * [listChunksPaginated](#listchunkspaginated) - List chunks with offset-based pagination
23
- * [getChunksCount](#getchunkscount) - Get chunks total count
24
- * [updateChunk](#updatechunk) - Update a chunk
25
- * [deleteChunk](#deletechunk) - Delete a chunk
26
- * [retrieveChunk](#retrievechunk) - Retrieve a chunk
27
-
28
- ## list
29
-
30
- Returns a list of your knowledge bases. The knowledge bases are returned sorted by creation date, with the most recent knowledge bases appearing first
31
-
32
- ### Example Usage
33
-
34
- <!-- UsageSnippet language="typescript" operationID="ListKnowledgeBases" method="get" path="/v2/knowledge" -->
35
- ```typescript
36
- import { Orq } from "@orq-ai/node";
37
-
38
- const orq = new Orq({
39
- apiKey: process.env["ORQ_API_KEY"] ?? "",
40
- });
41
-
42
- async function run() {
43
- const result = await orq.knowledge.list({});
44
-
45
- console.log(result);
46
- }
47
-
48
- run();
49
- ```
50
-
51
- ### Standalone function
52
-
53
- The standalone function version of this method:
54
-
55
- ```typescript
56
- import { OrqCore } from "@orq-ai/node/core.js";
57
- import { knowledgeList } from "@orq-ai/node/funcs/knowledgeList.js";
58
-
59
- // Use `OrqCore` for best tree-shaking performance.
60
- // You can create one instance of it to use across an application.
61
- const orq = new OrqCore({
62
- apiKey: process.env["ORQ_API_KEY"] ?? "",
63
- });
64
-
65
- async function run() {
66
- const res = await knowledgeList(orq, {});
67
- if (res.ok) {
68
- const { value: result } = res;
69
- console.log(result);
70
- } else {
71
- console.log("knowledgeList failed:", res.error);
72
- }
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
- <!-- UsageSnippet language="typescript" operationID="CreateKnowledge" method="post" path="/v2/knowledge" -->
104
- ```typescript
105
- import { Orq } from "@orq-ai/node";
106
-
107
- const orq = new Orq({
108
- apiKey: process.env["ORQ_API_KEY"] ?? "",
109
- });
110
-
111
- async function run() {
112
- const result = await orq.knowledge.create({
113
- type: "internal",
114
- key: "<key>",
115
- embeddingModel: "<value>",
116
- isPrivateModel: false,
117
- path: "Default",
118
- });
119
-
120
- console.log(result);
121
- }
122
-
123
- run();
124
- ```
125
-
126
- ### Standalone function
127
-
128
- The standalone function version of this method:
129
-
130
- ```typescript
131
- import { OrqCore } from "@orq-ai/node/core.js";
132
- import { knowledgeCreate } from "@orq-ai/node/funcs/knowledgeCreate.js";
133
-
134
- // Use `OrqCore` for best tree-shaking performance.
135
- // You can create one instance of it to use across an application.
136
- const orq = new OrqCore({
137
- apiKey: process.env["ORQ_API_KEY"] ?? "",
138
- });
139
-
140
- async function run() {
141
- const res = await knowledgeCreate(orq, {
142
- type: "internal",
143
- key: "<key>",
144
- embeddingModel: "<value>",
145
- isPrivateModel: false,
146
- path: "Default",
147
- });
148
- if (res.ok) {
149
- const { value: result } = res;
150
- console.log(result);
151
- } else {
152
- console.log("knowledgeCreate failed:", res.error);
153
- }
154
- }
155
-
156
- run();
157
- ```
158
-
159
- ### Parameters
160
-
161
- | Parameter | Type | Required | Description |
162
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
163
- | `request` | [operations.CreateKnowledgeRequestBody](../../models/operations/createknowledgerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
164
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
165
- | `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. |
166
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
167
-
168
- ### Response
169
-
170
- **Promise\<[operations.CreateKnowledgeResponseBody](../../models/operations/createknowledgeresponsebody.md)\>**
171
-
172
- ### Errors
173
-
174
- | Error Type | Status Code | Content Type |
175
- | --------------- | --------------- | --------------- |
176
- | errors.APIError | 4XX, 5XX | \*/\* |
177
-
178
- ## retrieve
179
-
180
- Retrieve a knowledge base with the settings.
181
-
182
- ### Example Usage
183
-
184
- <!-- UsageSnippet language="typescript" operationID="GetOneKnowledge" method="get" path="/v2/knowledge/{knowledge_id}" -->
185
- ```typescript
186
- import { Orq } from "@orq-ai/node";
187
-
188
- const orq = new Orq({
189
- apiKey: process.env["ORQ_API_KEY"] ?? "",
190
- });
191
-
192
- async function run() {
193
- const result = await orq.knowledge.retrieve({
194
- knowledgeId: "<id>",
195
- });
196
-
197
- console.log(result);
198
- }
199
-
200
- run();
201
- ```
202
-
203
- ### Standalone function
204
-
205
- The standalone function version of this method:
206
-
207
- ```typescript
208
- import { OrqCore } from "@orq-ai/node/core.js";
209
- import { knowledgeRetrieve } from "@orq-ai/node/funcs/knowledgeRetrieve.js";
210
-
211
- // Use `OrqCore` for best tree-shaking performance.
212
- // You can create one instance of it to use across an application.
213
- const orq = new OrqCore({
214
- apiKey: process.env["ORQ_API_KEY"] ?? "",
215
- });
216
-
217
- async function run() {
218
- const res = await knowledgeRetrieve(orq, {
219
- knowledgeId: "<id>",
220
- });
221
- if (res.ok) {
222
- const { value: result } = res;
223
- console.log(result);
224
- } else {
225
- console.log("knowledgeRetrieve failed:", res.error);
226
- }
227
- }
228
-
229
- run();
230
- ```
231
-
232
- ### Parameters
233
-
234
- | Parameter | Type | Required | Description |
235
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
236
- | `request` | [operations.GetOneKnowledgeRequest](../../models/operations/getoneknowledgerequest.md) | :heavy_check_mark: | The request object to use for the request. |
237
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
238
- | `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. |
239
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
240
-
241
- ### Response
242
-
243
- **Promise\<[operations.GetOneKnowledgeResponseBody](../../models/operations/getoneknowledgeresponsebody.md)\>**
244
-
245
- ### Errors
246
-
247
- | Error Type | Status Code | Content Type |
248
- | --------------- | --------------- | --------------- |
249
- | errors.APIError | 4XX, 5XX | \*/\* |
250
-
251
- ## update
252
-
253
- Updates a knowledge
254
-
255
- ### Example Usage
256
-
257
- <!-- UsageSnippet language="typescript" operationID="UpdateKnowledge" method="patch" path="/v2/knowledge/{knowledge_id}" -->
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
- type: "external",
271
- },
272
- });
273
-
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
- type: "external",
300
- },
301
- });
302
- if (res.ok) {
303
- const { value: result } = res;
304
- console.log(result);
305
- } else {
306
- console.log("knowledgeUpdate failed:", res.error);
307
- }
308
- }
309
-
310
- run();
311
- ```
312
-
313
- ### Parameters
314
-
315
- | Parameter | Type | Required | Description |
316
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
317
- | `request` | [operations.UpdateKnowledgeRequest](../../models/operations/updateknowledgerequest.md) | :heavy_check_mark: | The request object to use for the request. |
318
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
319
- | `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. |
320
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
321
-
322
- ### Response
323
-
324
- **Promise\<[operations.UpdateKnowledgeResponseBody](../../models/operations/updateknowledgeresponsebody.md)\>**
325
-
326
- ### Errors
327
-
328
- | Error Type | Status Code | Content Type |
329
- | --------------- | --------------- | --------------- |
330
- | errors.APIError | 4XX, 5XX | \*/\* |
331
-
332
- ## delete
333
-
334
- Deletes a knowledge base. Deleting a knowledge base will delete all the datasources and chunks associated with it.
335
-
336
- ### Example Usage
337
-
338
- <!-- UsageSnippet language="typescript" operationID="DeleteKnowledge" method="delete" path="/v2/knowledge/{knowledge_id}" -->
339
- ```typescript
340
- import { Orq } from "@orq-ai/node";
341
-
342
- const orq = new Orq({
343
- apiKey: process.env["ORQ_API_KEY"] ?? "",
344
- });
345
-
346
- async function run() {
347
- await orq.knowledge.delete({
348
- knowledgeId: "<id>",
349
- });
350
-
351
-
352
- }
353
-
354
- run();
355
- ```
356
-
357
- ### Standalone function
358
-
359
- The standalone function version of this method:
360
-
361
- ```typescript
362
- import { OrqCore } from "@orq-ai/node/core.js";
363
- import { knowledgeDelete } from "@orq-ai/node/funcs/knowledgeDelete.js";
364
-
365
- // Use `OrqCore` for best tree-shaking performance.
366
- // You can create one instance of it to use across an application.
367
- const orq = new OrqCore({
368
- apiKey: process.env["ORQ_API_KEY"] ?? "",
369
- });
370
-
371
- async function run() {
372
- const res = await knowledgeDelete(orq, {
373
- knowledgeId: "<id>",
374
- });
375
- if (res.ok) {
376
- const { value: result } = res;
377
-
378
- } else {
379
- console.log("knowledgeDelete failed:", res.error);
380
- }
381
- }
382
-
383
- run();
384
- ```
385
-
386
- ### Parameters
387
-
388
- | Parameter | Type | Required | Description |
389
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
390
- | `request` | [operations.DeleteKnowledgeRequest](../../models/operations/deleteknowledgerequest.md) | :heavy_check_mark: | The request object to use for the request. |
391
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
392
- | `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. |
393
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
394
-
395
- ### Response
396
-
397
- **Promise\<void\>**
398
-
399
- ### Errors
400
-
401
- | Error Type | Status Code | Content Type |
402
- | --------------- | --------------- | --------------- |
403
- | errors.APIError | 4XX, 5XX | \*/\* |
404
-
405
- ## search
406
-
407
- Search a Knowledge Base and return the most similar chunks, along with their search and rerank scores. Note that all configuration changes made in the API will override the settings in the UI.
408
-
409
- ### Example Usage
410
-
411
- <!-- UsageSnippet language="typescript" operationID="SearchKnowledge" method="post" path="/v2/knowledge/{knowledge_id}/search" -->
412
- ```typescript
413
- import { Orq } from "@orq-ai/node";
414
-
415
- const orq = new Orq({
416
- apiKey: process.env["ORQ_API_KEY"] ?? "",
417
- });
418
-
419
- async function run() {
420
- const result = await orq.knowledge.search({
421
- knowledgeId: "<id>",
422
- requestBody: {
423
- query: "<value>",
424
- rerankConfig: {
425
- model: "cohere/rerank-multilingual-v3.0",
426
- },
427
- },
428
- });
429
-
430
- console.log(result);
431
- }
432
-
433
- run();
434
- ```
435
-
436
- ### Standalone function
437
-
438
- The standalone function version of this method:
439
-
440
- ```typescript
441
- import { OrqCore } from "@orq-ai/node/core.js";
442
- import { knowledgeSearch } from "@orq-ai/node/funcs/knowledgeSearch.js";
443
-
444
- // Use `OrqCore` for best tree-shaking performance.
445
- // You can create one instance of it to use across an application.
446
- const orq = new OrqCore({
447
- apiKey: process.env["ORQ_API_KEY"] ?? "",
448
- });
449
-
450
- async function run() {
451
- const res = await knowledgeSearch(orq, {
452
- knowledgeId: "<id>",
453
- requestBody: {
454
- query: "<value>",
455
- rerankConfig: {
456
- model: "cohere/rerank-multilingual-v3.0",
457
- },
458
- },
459
- });
460
- if (res.ok) {
461
- const { value: result } = res;
462
- console.log(result);
463
- } else {
464
- console.log("knowledgeSearch failed:", res.error);
465
- }
466
- }
467
-
468
- run();
469
- ```
470
-
471
- ### Parameters
472
-
473
- | Parameter | Type | Required | Description |
474
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
475
- | `request` | [operations.SearchKnowledgeRequest](../../models/operations/searchknowledgerequest.md) | :heavy_check_mark: | The request object to use for the request. |
476
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
477
- | `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. |
478
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
479
-
480
- ### Response
481
-
482
- **Promise\<[operations.SearchKnowledgeResponseBody](../../models/operations/searchknowledgeresponsebody.md)\>**
483
-
484
- ### Errors
485
-
486
- | Error Type | Status Code | Content Type |
487
- | --------------- | --------------- | --------------- |
488
- | errors.APIError | 4XX, 5XX | \*/\* |
489
-
490
- ## listDatasources
491
-
492
- List all datasources
493
-
494
- ### Example Usage
495
-
496
- <!-- UsageSnippet language="typescript" operationID="ListDatasources" method="get" path="/v2/knowledge/{knowledge_id}/datasources" -->
497
- ```typescript
498
- import { Orq } from "@orq-ai/node";
499
-
500
- const orq = new Orq({
501
- apiKey: process.env["ORQ_API_KEY"] ?? "",
502
- });
503
-
504
- async function run() {
505
- const result = await orq.knowledge.listDatasources({
506
- knowledgeId: "<id>",
507
- status: [
508
- "completed",
509
- "failed",
510
- ],
511
- });
512
-
513
- console.log(result);
514
- }
515
-
516
- run();
517
- ```
518
-
519
- ### Standalone function
520
-
521
- The standalone function version of this method:
522
-
523
- ```typescript
524
- import { OrqCore } from "@orq-ai/node/core.js";
525
- import { knowledgeListDatasources } from "@orq-ai/node/funcs/knowledgeListDatasources.js";
526
-
527
- // Use `OrqCore` for best tree-shaking performance.
528
- // You can create one instance of it to use across an application.
529
- const orq = new OrqCore({
530
- apiKey: process.env["ORQ_API_KEY"] ?? "",
531
- });
532
-
533
- async function run() {
534
- const res = await knowledgeListDatasources(orq, {
535
- knowledgeId: "<id>",
536
- status: [
537
- "completed",
538
- "failed",
539
- ],
540
- });
541
- if (res.ok) {
542
- const { value: result } = res;
543
- console.log(result);
544
- } else {
545
- console.log("knowledgeListDatasources failed:", res.error);
546
- }
547
- }
548
-
549
- run();
550
- ```
551
-
552
- ### Parameters
553
-
554
- | Parameter | Type | Required | Description |
555
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
556
- | `request` | [operations.ListDatasourcesRequest](../../models/operations/listdatasourcesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
557
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
558
- | `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. |
559
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
560
-
561
- ### Response
562
-
563
- **Promise\<[operations.ListDatasourcesResponseBody](../../models/operations/listdatasourcesresponsebody.md)\>**
564
-
565
- ### Errors
566
-
567
- | Error Type | Status Code | Content Type |
568
- | --------------- | --------------- | --------------- |
569
- | errors.APIError | 4XX, 5XX | \*/\* |
570
-
571
- ## createDatasource
572
-
573
- Create a new datasource
574
-
575
- ### Example Usage
576
-
577
- <!-- UsageSnippet language="typescript" operationID="CreateDatasource" method="post" path="/v2/knowledge/{knowledge_id}/datasources" -->
578
- ```typescript
579
- import { Orq } from "@orq-ai/node";
580
-
581
- const orq = new Orq({
582
- apiKey: process.env["ORQ_API_KEY"] ?? "",
583
- });
584
-
585
- async function run() {
586
- const result = await orq.knowledge.createDatasource({
587
- knowledgeId: "<id>",
588
- requestBody: {},
589
- });
590
-
591
- console.log(result);
592
- }
593
-
594
- run();
595
- ```
596
-
597
- ### Standalone function
598
-
599
- The standalone function version of this method:
600
-
601
- ```typescript
602
- import { OrqCore } from "@orq-ai/node/core.js";
603
- import { knowledgeCreateDatasource } from "@orq-ai/node/funcs/knowledgeCreateDatasource.js";
604
-
605
- // Use `OrqCore` for best tree-shaking performance.
606
- // You can create one instance of it to use across an application.
607
- const orq = new OrqCore({
608
- apiKey: process.env["ORQ_API_KEY"] ?? "",
609
- });
610
-
611
- async function run() {
612
- const res = await knowledgeCreateDatasource(orq, {
613
- knowledgeId: "<id>",
614
- requestBody: {},
615
- });
616
- if (res.ok) {
617
- const { value: result } = res;
618
- console.log(result);
619
- } else {
620
- console.log("knowledgeCreateDatasource failed:", res.error);
621
- }
622
- }
623
-
624
- run();
625
- ```
626
-
627
- ### Parameters
628
-
629
- | Parameter | Type | Required | Description |
630
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
631
- | `request` | [operations.CreateDatasourceRequest](../../models/operations/createdatasourcerequest.md) | :heavy_check_mark: | The request object to use for the request. |
632
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
633
- | `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. |
634
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
635
-
636
- ### Response
637
-
638
- **Promise\<[operations.CreateDatasourceResponseBody](../../models/operations/createdatasourceresponsebody.md)\>**
639
-
640
- ### Errors
641
-
642
- | Error Type | Status Code | Content Type |
643
- | --------------- | --------------- | --------------- |
644
- | errors.APIError | 4XX, 5XX | \*/\* |
645
-
646
- ## retrieveDatasource
647
-
648
- Retrieve a datasource
649
-
650
- ### Example Usage
651
-
652
- <!-- UsageSnippet language="typescript" operationID="RetrieveDatasource" method="get" path="/v2/knowledge/{knowledge_id}/datasources/{datasource_id}" -->
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
- console.log(result);
667
- }
668
-
669
- run();
670
- ```
671
-
672
- ### Standalone function
673
-
674
- The standalone function version of this method:
675
-
676
- ```typescript
677
- import { OrqCore } from "@orq-ai/node/core.js";
678
- import { knowledgeRetrieveDatasource } from "@orq-ai/node/funcs/knowledgeRetrieveDatasource.js";
679
-
680
- // Use `OrqCore` for best tree-shaking performance.
681
- // You can create one instance of it to use across an application.
682
- const orq = new OrqCore({
683
- apiKey: process.env["ORQ_API_KEY"] ?? "",
684
- });
685
-
686
- async function run() {
687
- const res = await knowledgeRetrieveDatasource(orq, {
688
- knowledgeId: "<id>",
689
- datasourceId: "<id>",
690
- });
691
- if (res.ok) {
692
- const { value: result } = res;
693
- console.log(result);
694
- } else {
695
- console.log("knowledgeRetrieveDatasource failed:", res.error);
696
- }
697
- }
698
-
699
- run();
700
- ```
701
-
702
- ### Parameters
703
-
704
- | Parameter | Type | Required | Description |
705
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
706
- | `request` | [operations.RetrieveDatasourceRequest](../../models/operations/retrievedatasourcerequest.md) | :heavy_check_mark: | The request object to use for the request. |
707
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
708
- | `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. |
709
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
710
-
711
- ### Response
712
-
713
- **Promise\<[operations.RetrieveDatasourceResponseBody](../../models/operations/retrievedatasourceresponsebody.md)\>**
714
-
715
- ### Errors
716
-
717
- | Error Type | Status Code | Content Type |
718
- | --------------- | --------------- | --------------- |
719
- | errors.APIError | 4XX, 5XX | \*/\* |
720
-
721
- ## deleteDatasource
722
-
723
- 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.
724
-
725
- ### Example Usage
726
-
727
- <!-- UsageSnippet language="typescript" operationID="DeleteDatasource" method="delete" path="/v2/knowledge/{knowledge_id}/datasources/{datasource_id}" -->
728
- ```typescript
729
- import { Orq } from "@orq-ai/node";
730
-
731
- const orq = new Orq({
732
- apiKey: process.env["ORQ_API_KEY"] ?? "",
733
- });
734
-
735
- async function run() {
736
- await orq.knowledge.deleteDatasource({
737
- knowledgeId: "<id>",
738
- datasourceId: "<id>",
739
- });
740
-
741
-
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 { knowledgeDeleteDatasource } from "@orq-ai/node/funcs/knowledgeDeleteDatasource.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 knowledgeDeleteDatasource(orq, {
763
- knowledgeId: "<id>",
764
- datasourceId: "<id>",
765
- });
766
- if (res.ok) {
767
- const { value: result } = res;
768
-
769
- } else {
770
- console.log("knowledgeDeleteDatasource failed:", res.error);
771
- }
772
- }
773
-
774
- run();
775
- ```
776
-
777
- ### Parameters
778
-
779
- | Parameter | Type | Required | Description |
780
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
781
- | `request` | [operations.DeleteDatasourceRequest](../../models/operations/deletedatasourcerequest.md) | :heavy_check_mark: | The request object to use for the request. |
782
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
783
- | `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. |
784
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
785
-
786
- ### Response
787
-
788
- **Promise\<void\>**
789
-
790
- ### Errors
791
-
792
- | Error Type | Status Code | Content Type |
793
- | --------------- | --------------- | --------------- |
794
- | errors.APIError | 4XX, 5XX | \*/\* |
795
-
796
- ## updateDatasource
797
-
798
- Update a datasource
799
-
800
- ### Example Usage
801
-
802
- <!-- UsageSnippet language="typescript" operationID="UpdateDatasource" method="patch" path="/v2/knowledge/{knowledge_id}/datasources/{datasource_id}" -->
803
- ```typescript
804
- import { Orq } from "@orq-ai/node";
805
-
806
- const orq = new Orq({
807
- apiKey: process.env["ORQ_API_KEY"] ?? "",
808
- });
809
-
810
- async function run() {
811
- const result = await orq.knowledge.updateDatasource({
812
- knowledgeId: "<id>",
813
- datasourceId: "<id>",
814
- requestBody: {
815
- displayName: "Tony_Roberts",
816
- },
817
- });
818
-
819
- console.log(result);
820
- }
821
-
822
- run();
823
- ```
824
-
825
- ### Standalone function
826
-
827
- The standalone function version of this method:
828
-
829
- ```typescript
830
- import { OrqCore } from "@orq-ai/node/core.js";
831
- import { knowledgeUpdateDatasource } from "@orq-ai/node/funcs/knowledgeUpdateDatasource.js";
832
-
833
- // Use `OrqCore` for best tree-shaking performance.
834
- // You can create one instance of it to use across an application.
835
- const orq = new OrqCore({
836
- apiKey: process.env["ORQ_API_KEY"] ?? "",
837
- });
838
-
839
- async function run() {
840
- const res = await knowledgeUpdateDatasource(orq, {
841
- knowledgeId: "<id>",
842
- datasourceId: "<id>",
843
- requestBody: {
844
- displayName: "Tony_Roberts",
845
- },
846
- });
847
- if (res.ok) {
848
- const { value: result } = res;
849
- console.log(result);
850
- } else {
851
- console.log("knowledgeUpdateDatasource failed:", res.error);
852
- }
853
- }
854
-
855
- run();
856
- ```
857
-
858
- ### Parameters
859
-
860
- | Parameter | Type | Required | Description |
861
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
862
- | `request` | [operations.UpdateDatasourceRequest](../../models/operations/updatedatasourcerequest.md) | :heavy_check_mark: | The request object to use for the request. |
863
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
864
- | `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. |
865
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
866
-
867
- ### Response
868
-
869
- **Promise\<[operations.UpdateDatasourceResponseBody](../../models/operations/updatedatasourceresponsebody.md)\>**
870
-
871
- ### Errors
872
-
873
- | Error Type | Status Code | Content Type |
874
- | --------------- | --------------- | --------------- |
875
- | errors.APIError | 4XX, 5XX | \*/\* |
876
-
877
- ## createChunks
878
-
879
- Create chunks for a datasource
880
-
881
- ### Example Usage
882
-
883
- <!-- UsageSnippet language="typescript" operationID="CreateChunk" method="post" path="/v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks" -->
884
- ```typescript
885
- import { Orq } from "@orq-ai/node";
886
-
887
- const orq = new Orq({
888
- apiKey: process.env["ORQ_API_KEY"] ?? "",
889
- });
890
-
891
- async function run() {
892
- const result = await orq.knowledge.createChunks({
893
- knowledgeId: "<id>",
894
- datasourceId: "<id>",
895
- });
896
-
897
- console.log(result);
898
- }
899
-
900
- run();
901
- ```
902
-
903
- ### Standalone function
904
-
905
- The standalone function version of this method:
906
-
907
- ```typescript
908
- import { OrqCore } from "@orq-ai/node/core.js";
909
- import { knowledgeCreateChunks } from "@orq-ai/node/funcs/knowledgeCreateChunks.js";
910
-
911
- // Use `OrqCore` for best tree-shaking performance.
912
- // You can create one instance of it to use across an application.
913
- const orq = new OrqCore({
914
- apiKey: process.env["ORQ_API_KEY"] ?? "",
915
- });
916
-
917
- async function run() {
918
- const res = await knowledgeCreateChunks(orq, {
919
- knowledgeId: "<id>",
920
- datasourceId: "<id>",
921
- });
922
- if (res.ok) {
923
- const { value: result } = res;
924
- console.log(result);
925
- } else {
926
- console.log("knowledgeCreateChunks failed:", res.error);
927
- }
928
- }
929
-
930
- run();
931
- ```
932
-
933
- ### Parameters
934
-
935
- | Parameter | Type | Required | Description |
936
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
937
- | `request` | [operations.CreateChunkRequest](../../models/operations/createchunkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
938
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
939
- | `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. |
940
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
941
-
942
- ### Response
943
-
944
- **Promise\<[operations.ResponseBody[]](../../models/.md)\>**
945
-
946
- ### Errors
947
-
948
- | Error Type | Status Code | Content Type |
949
- | --------------- | --------------- | --------------- |
950
- | errors.APIError | 4XX, 5XX | \*/\* |
951
-
952
- ## listChunks
953
-
954
- List all chunks for a datasource
955
-
956
- ### Example Usage
957
-
958
- <!-- UsageSnippet language="typescript" operationID="ListChunks" method="get" path="/v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks" -->
959
- ```typescript
960
- import { Orq } from "@orq-ai/node";
961
-
962
- const orq = new Orq({
963
- apiKey: process.env["ORQ_API_KEY"] ?? "",
964
- });
965
-
966
- async function run() {
967
- const result = await orq.knowledge.listChunks({
968
- knowledgeId: "<id>",
969
- datasourceId: "<id>",
970
- status: [
971
- "completed",
972
- "failed",
973
- ],
974
- });
975
-
976
- console.log(result);
977
- }
978
-
979
- run();
980
- ```
981
-
982
- ### Standalone function
983
-
984
- The standalone function version of this method:
985
-
986
- ```typescript
987
- import { OrqCore } from "@orq-ai/node/core.js";
988
- import { knowledgeListChunks } from "@orq-ai/node/funcs/knowledgeListChunks.js";
989
-
990
- // Use `OrqCore` for best tree-shaking performance.
991
- // You can create one instance of it to use across an application.
992
- const orq = new OrqCore({
993
- apiKey: process.env["ORQ_API_KEY"] ?? "",
994
- });
995
-
996
- async function run() {
997
- const res = await knowledgeListChunks(orq, {
998
- knowledgeId: "<id>",
999
- datasourceId: "<id>",
1000
- status: [
1001
- "completed",
1002
- "failed",
1003
- ],
1004
- });
1005
- if (res.ok) {
1006
- const { value: result } = res;
1007
- console.log(result);
1008
- } else {
1009
- console.log("knowledgeListChunks failed:", res.error);
1010
- }
1011
- }
1012
-
1013
- run();
1014
- ```
1015
-
1016
- ### Parameters
1017
-
1018
- | Parameter | Type | Required | Description |
1019
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1020
- | `request` | [operations.ListChunksRequest](../../models/operations/listchunksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1021
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1022
- | `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. |
1023
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1024
-
1025
- ### Response
1026
-
1027
- **Promise\<[operations.ListChunksResponseBody](../../models/operations/listchunksresponsebody.md)\>**
1028
-
1029
- ### Errors
1030
-
1031
- | Error Type | Status Code | Content Type |
1032
- | --------------- | --------------- | --------------- |
1033
- | errors.APIError | 4XX, 5XX | \*/\* |
1034
-
1035
- ## deleteChunks
1036
-
1037
- Delete multiple chunks
1038
-
1039
- ### Example Usage
1040
-
1041
- <!-- UsageSnippet language="typescript" operationID="DeleteChunks" method="delete" path="/v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks" -->
1042
- ```typescript
1043
- import { Orq } from "@orq-ai/node";
1044
-
1045
- const orq = new Orq({
1046
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1047
- });
1048
-
1049
- async function run() {
1050
- const result = await orq.knowledge.deleteChunks({
1051
- knowledgeId: "<id>",
1052
- datasourceId: "<id>",
1053
- });
1054
-
1055
- console.log(result);
1056
- }
1057
-
1058
- run();
1059
- ```
1060
-
1061
- ### Standalone function
1062
-
1063
- The standalone function version of this method:
1064
-
1065
- ```typescript
1066
- import { OrqCore } from "@orq-ai/node/core.js";
1067
- import { knowledgeDeleteChunks } from "@orq-ai/node/funcs/knowledgeDeleteChunks.js";
1068
-
1069
- // Use `OrqCore` for best tree-shaking performance.
1070
- // You can create one instance of it to use across an application.
1071
- const orq = new OrqCore({
1072
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1073
- });
1074
-
1075
- async function run() {
1076
- const res = await knowledgeDeleteChunks(orq, {
1077
- knowledgeId: "<id>",
1078
- datasourceId: "<id>",
1079
- });
1080
- if (res.ok) {
1081
- const { value: result } = res;
1082
- console.log(result);
1083
- } else {
1084
- console.log("knowledgeDeleteChunks failed:", res.error);
1085
- }
1086
- }
1087
-
1088
- run();
1089
- ```
1090
-
1091
- ### Parameters
1092
-
1093
- | Parameter | Type | Required | Description |
1094
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1095
- | `request` | [operations.DeleteChunksRequest](../../models/operations/deletechunksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1096
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1097
- | `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. |
1098
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1099
-
1100
- ### Response
1101
-
1102
- **Promise\<[operations.DeleteChunksResponseBody](../../models/operations/deletechunksresponsebody.md)\>**
1103
-
1104
- ### Errors
1105
-
1106
- | Error Type | Status Code | Content Type |
1107
- | --------------- | --------------- | --------------- |
1108
- | errors.APIError | 4XX, 5XX | \*/\* |
1109
-
1110
- ## listChunksPaginated
1111
-
1112
- List chunks with offset-based pagination
1113
-
1114
- ### Example Usage
1115
-
1116
- <!-- UsageSnippet language="typescript" operationID="ListChunksPaginated" method="post" path="/v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/list" -->
1117
- ```typescript
1118
- import { Orq } from "@orq-ai/node";
1119
-
1120
- const orq = new Orq({
1121
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1122
- });
1123
-
1124
- async function run() {
1125
- const result = await orq.knowledge.listChunksPaginated({
1126
- knowledgeId: "<id>",
1127
- datasourceId: "<id>",
1128
- });
1129
-
1130
- console.log(result);
1131
- }
1132
-
1133
- run();
1134
- ```
1135
-
1136
- ### Standalone function
1137
-
1138
- The standalone function version of this method:
1139
-
1140
- ```typescript
1141
- import { OrqCore } from "@orq-ai/node/core.js";
1142
- import { knowledgeListChunksPaginated } from "@orq-ai/node/funcs/knowledgeListChunksPaginated.js";
1143
-
1144
- // Use `OrqCore` for best tree-shaking performance.
1145
- // You can create one instance of it to use across an application.
1146
- const orq = new OrqCore({
1147
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1148
- });
1149
-
1150
- async function run() {
1151
- const res = await knowledgeListChunksPaginated(orq, {
1152
- knowledgeId: "<id>",
1153
- datasourceId: "<id>",
1154
- });
1155
- if (res.ok) {
1156
- const { value: result } = res;
1157
- console.log(result);
1158
- } else {
1159
- console.log("knowledgeListChunksPaginated failed:", res.error);
1160
- }
1161
- }
1162
-
1163
- run();
1164
- ```
1165
-
1166
- ### Parameters
1167
-
1168
- | Parameter | Type | Required | Description |
1169
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1170
- | `request` | [operations.ListChunksPaginatedRequest](../../models/operations/listchunkspaginatedrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1171
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1172
- | `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. |
1173
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1174
-
1175
- ### Response
1176
-
1177
- **Promise\<[operations.ListChunksPaginatedResponseBody](../../models/operations/listchunkspaginatedresponsebody.md)\>**
1178
-
1179
- ### Errors
1180
-
1181
- | Error Type | Status Code | Content Type |
1182
- | --------------- | --------------- | --------------- |
1183
- | errors.APIError | 4XX, 5XX | \*/\* |
1184
-
1185
- ## getChunksCount
1186
-
1187
- Get chunks total count
1188
-
1189
- ### Example Usage
1190
-
1191
- <!-- UsageSnippet language="typescript" operationID="GetChunksCount" method="post" path="/v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/count" -->
1192
- ```typescript
1193
- import { Orq } from "@orq-ai/node";
1194
-
1195
- const orq = new Orq({
1196
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1197
- });
1198
-
1199
- async function run() {
1200
- const result = await orq.knowledge.getChunksCount({
1201
- knowledgeId: "<id>",
1202
- datasourceId: "<id>",
1203
- });
1204
-
1205
- console.log(result);
1206
- }
1207
-
1208
- run();
1209
- ```
1210
-
1211
- ### Standalone function
1212
-
1213
- The standalone function version of this method:
1214
-
1215
- ```typescript
1216
- import { OrqCore } from "@orq-ai/node/core.js";
1217
- import { knowledgeGetChunksCount } from "@orq-ai/node/funcs/knowledgeGetChunksCount.js";
1218
-
1219
- // Use `OrqCore` for best tree-shaking performance.
1220
- // You can create one instance of it to use across an application.
1221
- const orq = new OrqCore({
1222
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1223
- });
1224
-
1225
- async function run() {
1226
- const res = await knowledgeGetChunksCount(orq, {
1227
- knowledgeId: "<id>",
1228
- datasourceId: "<id>",
1229
- });
1230
- if (res.ok) {
1231
- const { value: result } = res;
1232
- console.log(result);
1233
- } else {
1234
- console.log("knowledgeGetChunksCount failed:", res.error);
1235
- }
1236
- }
1237
-
1238
- run();
1239
- ```
1240
-
1241
- ### Parameters
1242
-
1243
- | Parameter | Type | Required | Description |
1244
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1245
- | `request` | [operations.GetChunksCountRequest](../../models/operations/getchunkscountrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1246
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1247
- | `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. |
1248
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1249
-
1250
- ### Response
1251
-
1252
- **Promise\<[operations.GetChunksCountResponseBody](../../models/operations/getchunkscountresponsebody.md)\>**
1253
-
1254
- ### Errors
1255
-
1256
- | Error Type | Status Code | Content Type |
1257
- | --------------- | --------------- | --------------- |
1258
- | errors.APIError | 4XX, 5XX | \*/\* |
1259
-
1260
- ## updateChunk
1261
-
1262
- Update a chunk
1263
-
1264
- ### Example Usage
1265
-
1266
- <!-- UsageSnippet language="typescript" operationID="UpdateChunk" method="patch" path="/v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/{chunk_id}" -->
1267
- ```typescript
1268
- import { Orq } from "@orq-ai/node";
1269
-
1270
- const orq = new Orq({
1271
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1272
- });
1273
-
1274
- async function run() {
1275
- const result = await orq.knowledge.updateChunk({
1276
- chunkId: "<id>",
1277
- datasourceId: "<id>",
1278
- knowledgeId: "<id>",
1279
- });
1280
-
1281
- console.log(result);
1282
- }
1283
-
1284
- run();
1285
- ```
1286
-
1287
- ### Standalone function
1288
-
1289
- The standalone function version of this method:
1290
-
1291
- ```typescript
1292
- import { OrqCore } from "@orq-ai/node/core.js";
1293
- import { knowledgeUpdateChunk } from "@orq-ai/node/funcs/knowledgeUpdateChunk.js";
1294
-
1295
- // Use `OrqCore` for best tree-shaking performance.
1296
- // You can create one instance of it to use across an application.
1297
- const orq = new OrqCore({
1298
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1299
- });
1300
-
1301
- async function run() {
1302
- const res = await knowledgeUpdateChunk(orq, {
1303
- chunkId: "<id>",
1304
- datasourceId: "<id>",
1305
- knowledgeId: "<id>",
1306
- });
1307
- if (res.ok) {
1308
- const { value: result } = res;
1309
- console.log(result);
1310
- } else {
1311
- console.log("knowledgeUpdateChunk failed:", res.error);
1312
- }
1313
- }
1314
-
1315
- run();
1316
- ```
1317
-
1318
- ### Parameters
1319
-
1320
- | Parameter | Type | Required | Description |
1321
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1322
- | `request` | [operations.UpdateChunkRequest](../../models/operations/updatechunkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1323
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1324
- | `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. |
1325
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1326
-
1327
- ### Response
1328
-
1329
- **Promise\<[operations.UpdateChunkResponseBody](../../models/operations/updatechunkresponsebody.md)\>**
1330
-
1331
- ### Errors
1332
-
1333
- | Error Type | Status Code | Content Type |
1334
- | --------------- | --------------- | --------------- |
1335
- | errors.APIError | 4XX, 5XX | \*/\* |
1336
-
1337
- ## deleteChunk
1338
-
1339
- Delete a chunk
1340
-
1341
- ### Example Usage
1342
-
1343
- <!-- UsageSnippet language="typescript" operationID="DeleteChunk" method="delete" path="/v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/{chunk_id}" -->
1344
- ```typescript
1345
- import { Orq } from "@orq-ai/node";
1346
-
1347
- const orq = new Orq({
1348
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1349
- });
1350
-
1351
- async function run() {
1352
- await orq.knowledge.deleteChunk({
1353
- chunkId: "<id>",
1354
- datasourceId: "<id>",
1355
- knowledgeId: "<id>",
1356
- });
1357
-
1358
-
1359
- }
1360
-
1361
- run();
1362
- ```
1363
-
1364
- ### Standalone function
1365
-
1366
- The standalone function version of this method:
1367
-
1368
- ```typescript
1369
- import { OrqCore } from "@orq-ai/node/core.js";
1370
- import { knowledgeDeleteChunk } from "@orq-ai/node/funcs/knowledgeDeleteChunk.js";
1371
-
1372
- // Use `OrqCore` for best tree-shaking performance.
1373
- // You can create one instance of it to use across an application.
1374
- const orq = new OrqCore({
1375
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1376
- });
1377
-
1378
- async function run() {
1379
- const res = await knowledgeDeleteChunk(orq, {
1380
- chunkId: "<id>",
1381
- datasourceId: "<id>",
1382
- knowledgeId: "<id>",
1383
- });
1384
- if (res.ok) {
1385
- const { value: result } = res;
1386
-
1387
- } else {
1388
- console.log("knowledgeDeleteChunk failed:", res.error);
1389
- }
1390
- }
1391
-
1392
- run();
1393
- ```
1394
-
1395
- ### Parameters
1396
-
1397
- | Parameter | Type | Required | Description |
1398
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1399
- | `request` | [operations.DeleteChunkRequest](../../models/operations/deletechunkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1400
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1401
- | `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. |
1402
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1403
-
1404
- ### Response
1405
-
1406
- **Promise\<void\>**
1407
-
1408
- ### Errors
1409
-
1410
- | Error Type | Status Code | Content Type |
1411
- | --------------- | --------------- | --------------- |
1412
- | errors.APIError | 4XX, 5XX | \*/\* |
1413
-
1414
- ## retrieveChunk
1415
-
1416
- Retrieve a chunk
1417
-
1418
- ### Example Usage
1419
-
1420
- <!-- UsageSnippet language="typescript" operationID="GetOneChunk" method="get" path="/v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/{chunk_id}" -->
1421
- ```typescript
1422
- import { Orq } from "@orq-ai/node";
1423
-
1424
- const orq = new Orq({
1425
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1426
- });
1427
-
1428
- async function run() {
1429
- const result = await orq.knowledge.retrieveChunk({
1430
- chunkId: "<id>",
1431
- datasourceId: "<id>",
1432
- knowledgeId: "<id>",
1433
- });
1434
-
1435
- console.log(result);
1436
- }
1437
-
1438
- run();
1439
- ```
1440
-
1441
- ### Standalone function
1442
-
1443
- The standalone function version of this method:
1444
-
1445
- ```typescript
1446
- import { OrqCore } from "@orq-ai/node/core.js";
1447
- import { knowledgeRetrieveChunk } from "@orq-ai/node/funcs/knowledgeRetrieveChunk.js";
1448
-
1449
- // Use `OrqCore` for best tree-shaking performance.
1450
- // You can create one instance of it to use across an application.
1451
- const orq = new OrqCore({
1452
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1453
- });
1454
-
1455
- async function run() {
1456
- const res = await knowledgeRetrieveChunk(orq, {
1457
- chunkId: "<id>",
1458
- datasourceId: "<id>",
1459
- knowledgeId: "<id>",
1460
- });
1461
- if (res.ok) {
1462
- const { value: result } = res;
1463
- console.log(result);
1464
- } else {
1465
- console.log("knowledgeRetrieveChunk failed:", res.error);
1466
- }
1467
- }
1468
-
1469
- run();
1470
- ```
1471
-
1472
- ### Parameters
1473
-
1474
- | Parameter | Type | Required | Description |
1475
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1476
- | `request` | [operations.GetOneChunkRequest](../../models/operations/getonechunkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1477
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1478
- | `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. |
1479
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1480
-
1481
- ### Response
1482
-
1483
- **Promise\<[operations.GetOneChunkResponseBody](../../models/operations/getonechunkresponsebody.md)\>**
1484
-
1485
- ### Errors
1486
-
1487
- | Error Type | Status Code | Content Type |
1488
- | --------------- | --------------- | --------------- |
1489
- | errors.APIError | 4XX, 5XX | \*/\* |