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