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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (494) hide show
  1. package/bin/mcp-server.js +210 -213
  2. package/bin/mcp-server.js.map +38 -38
  3. package/docs/sdks/agents/README.md +8 -4
  4. package/docs/sdks/budgets/README.md +4 -2
  5. package/docs/sdks/tools/README.md +4 -2
  6. package/examples/package-lock.json +5 -6
  7. package/jsr.json +1 -1
  8. package/lib/config.d.ts +2 -2
  9. package/lib/config.js +2 -2
  10. package/lib/config.js.map +1 -1
  11. package/mcp-server/mcp-server.js +1 -1
  12. package/mcp-server/mcp-server.js.map +1 -1
  13. package/mcp-server/server.js +1 -1
  14. package/mcp-server/server.js.map +1 -1
  15. package/models/operations/createbudget.js +2 -2
  16. package/models/operations/createcontact.js +2 -2
  17. package/models/operations/createdataset.js +2 -2
  18. package/models/operations/createdatasetitem.js +8 -8
  19. package/models/operations/createdatasource.js +2 -2
  20. package/models/operations/createeval.js +28 -28
  21. package/models/operations/createtool.js +10 -10
  22. package/models/operations/duplicatetool.js +10 -10
  23. package/models/operations/fileget.js +2 -2
  24. package/models/operations/filelist.js +2 -2
  25. package/models/operations/fileupload.js +2 -2
  26. package/models/operations/getalltools.js +10 -10
  27. package/models/operations/getbudget.js +2 -2
  28. package/models/operations/getevals.js +28 -28
  29. package/models/operations/listbudgets.js +2 -2
  30. package/models/operations/listcontacts.js +2 -2
  31. package/models/operations/listdatasetdatapoints.js +8 -8
  32. package/models/operations/listdatasets.js +2 -2
  33. package/models/operations/listdatasources.js +2 -2
  34. package/models/operations/retrievecontact.js +2 -2
  35. package/models/operations/retrievedatapoint.js +8 -8
  36. package/models/operations/retrievedataset.js +2 -2
  37. package/models/operations/retrievedatasource.js +2 -2
  38. package/models/operations/retrievetool.js +10 -10
  39. package/models/operations/updatebudget.js +2 -2
  40. package/models/operations/updatecontact.js +2 -2
  41. package/models/operations/updatedatapoint.js +8 -8
  42. package/models/operations/updatedataset.js +2 -2
  43. package/models/operations/updatedatasource.js +2 -2
  44. package/models/operations/updateeval.js +28 -28
  45. package/models/operations/updatetool.js +10 -10
  46. package/package.json +4 -4
  47. package/src/lib/config.ts +2 -2
  48. package/src/mcp-server/mcp-server.ts +1 -1
  49. package/src/mcp-server/server.ts +1 -1
  50. package/src/models/operations/createbudget.ts +2 -2
  51. package/src/models/operations/createcontact.ts +2 -2
  52. package/src/models/operations/createdataset.ts +2 -2
  53. package/src/models/operations/createdatasetitem.ts +8 -8
  54. package/src/models/operations/createdatasource.ts +2 -2
  55. package/src/models/operations/createeval.ts +28 -28
  56. package/src/models/operations/createtool.ts +10 -10
  57. package/src/models/operations/duplicatetool.ts +10 -10
  58. package/src/models/operations/fileget.ts +2 -2
  59. package/src/models/operations/filelist.ts +2 -2
  60. package/src/models/operations/fileupload.ts +2 -2
  61. package/src/models/operations/getalltools.ts +10 -10
  62. package/src/models/operations/getbudget.ts +2 -2
  63. package/src/models/operations/getevals.ts +28 -28
  64. package/src/models/operations/listbudgets.ts +2 -2
  65. package/src/models/operations/listcontacts.ts +2 -2
  66. package/src/models/operations/listdatasetdatapoints.ts +8 -8
  67. package/src/models/operations/listdatasets.ts +2 -2
  68. package/src/models/operations/listdatasources.ts +2 -2
  69. package/src/models/operations/retrievecontact.ts +2 -2
  70. package/src/models/operations/retrievedatapoint.ts +8 -8
  71. package/src/models/operations/retrievedataset.ts +2 -2
  72. package/src/models/operations/retrievedatasource.ts +2 -2
  73. package/src/models/operations/retrievetool.ts +10 -10
  74. package/src/models/operations/updatebudget.ts +2 -2
  75. package/src/models/operations/updatecontact.ts +2 -2
  76. package/src/models/operations/updatedatapoint.ts +8 -8
  77. package/src/models/operations/updatedataset.ts +2 -2
  78. package/src/models/operations/updatedatasource.ts +2 -2
  79. package/src/models/operations/updateeval.ts +28 -28
  80. package/src/models/operations/updatetool.ts +10 -10
  81. package/packages/orq-rc/FUNCTIONS.md +0 -103
  82. package/packages/orq-rc/README.md +0 -909
  83. package/packages/orq-rc/RUNTIMES.md +0 -48
  84. package/packages/orq-rc/docs/sdks/agents/README.md +0 -1319
  85. package/packages/orq-rc/docs/sdks/budgets/README.md +0 -401
  86. package/packages/orq-rc/docs/sdks/chunking/README.md +0 -95
  87. package/packages/orq-rc/docs/sdks/contacts/README.md +0 -450
  88. package/packages/orq-rc/docs/sdks/datasets/README.md +0 -836
  89. package/packages/orq-rc/docs/sdks/deployments/README.md +0 -312
  90. package/packages/orq-rc/docs/sdks/evals/README.md +0 -339
  91. package/packages/orq-rc/docs/sdks/feedback/README.md +0 -89
  92. package/packages/orq-rc/docs/sdks/files/README.md +0 -301
  93. package/packages/orq-rc/docs/sdks/knowledge/README.md +0 -1489
  94. package/packages/orq-rc/docs/sdks/memorystores/README.md +0 -1172
  95. package/packages/orq-rc/docs/sdks/metrics/README.md +0 -83
  96. package/packages/orq-rc/docs/sdks/models/README.md +0 -76
  97. package/packages/orq-rc/docs/sdks/prompts/README.md +0 -591
  98. package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +0 -77
  99. package/packages/orq-rc/docs/sdks/tools/README.md +0 -490
  100. package/packages/orq-rc/examples/README.md +0 -31
  101. package/packages/orq-rc/examples/contactsCreate.example.ts +0 -42
  102. package/packages/orq-rc/examples/package-lock.json +0 -627
  103. package/packages/orq-rc/examples/package.json +0 -18
  104. package/packages/orq-rc/jsr.json +0 -28
  105. package/packages/orq-rc/package-lock.json +0 -3071
  106. package/packages/orq-rc/package.json +0 -43
  107. package/packages/orq-rc/src/core.ts +0 -13
  108. package/packages/orq-rc/src/funcs/agentsCreate.ts +0 -172
  109. package/packages/orq-rc/src/funcs/agentsDelete.ts +0 -176
  110. package/packages/orq-rc/src/funcs/agentsInvoke.ts +0 -167
  111. package/packages/orq-rc/src/funcs/agentsList.ts +0 -167
  112. package/packages/orq-rc/src/funcs/agentsListActions.ts +0 -169
  113. package/packages/orq-rc/src/funcs/agentsListTasks.ts +0 -183
  114. package/packages/orq-rc/src/funcs/agentsRetrieve.ts +0 -175
  115. package/packages/orq-rc/src/funcs/agentsRetrieveAction.ts +0 -173
  116. package/packages/orq-rc/src/funcs/agentsRetrieveTask.ts +0 -179
  117. package/packages/orq-rc/src/funcs/agentsRun.ts +0 -163
  118. package/packages/orq-rc/src/funcs/agentsStream.ts +0 -190
  119. package/packages/orq-rc/src/funcs/agentsStreamRun.ts +0 -188
  120. package/packages/orq-rc/src/funcs/agentsUpdate.ts +0 -176
  121. package/packages/orq-rc/src/funcs/budgetsCreate.ts +0 -160
  122. package/packages/orq-rc/src/funcs/budgetsDelete.ts +0 -167
  123. package/packages/orq-rc/src/funcs/budgetsGet.ts +0 -166
  124. package/packages/orq-rc/src/funcs/budgetsList.ts +0 -170
  125. package/packages/orq-rc/src/funcs/budgetsUpdate.ts +0 -167
  126. package/packages/orq-rc/src/funcs/chunkingParse.ts +0 -160
  127. package/packages/orq-rc/src/funcs/contactsCreate.ts +0 -165
  128. package/packages/orq-rc/src/funcs/contactsDelete.ts +0 -176
  129. package/packages/orq-rc/src/funcs/contactsList.ts +0 -169
  130. package/packages/orq-rc/src/funcs/contactsRetrieve.ts +0 -175
  131. package/packages/orq-rc/src/funcs/contactsUpdate.ts +0 -176
  132. package/packages/orq-rc/src/funcs/datasetsClear.ts +0 -167
  133. package/packages/orq-rc/src/funcs/datasetsCreate.ts +0 -165
  134. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +0 -171
  135. package/packages/orq-rc/src/funcs/datasetsDelete.ts +0 -167
  136. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +0 -182
  137. package/packages/orq-rc/src/funcs/datasetsList.ts +0 -167
  138. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +0 -174
  139. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +0 -175
  140. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +0 -181
  141. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +0 -176
  142. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +0 -179
  143. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +0 -168
  144. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +0 -176
  145. package/packages/orq-rc/src/funcs/deploymentsList.ts +0 -176
  146. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +0 -168
  147. package/packages/orq-rc/src/funcs/deploymentsStream.ts +0 -183
  148. package/packages/orq-rc/src/funcs/evalsAll.ts +0 -173
  149. package/packages/orq-rc/src/funcs/evalsCreate.ts +0 -169
  150. package/packages/orq-rc/src/funcs/evalsDelete.ts +0 -173
  151. package/packages/orq-rc/src/funcs/evalsUpdate.ts +0 -173
  152. package/packages/orq-rc/src/funcs/feedbackCreate.ts +0 -160
  153. package/packages/orq-rc/src/funcs/filesCreate.ts +0 -187
  154. package/packages/orq-rc/src/funcs/filesDelete.ts +0 -164
  155. package/packages/orq-rc/src/funcs/filesGet.ts +0 -166
  156. package/packages/orq-rc/src/funcs/filesList.ts +0 -167
  157. package/packages/orq-rc/src/funcs/knowledgeCreate.ts +0 -158
  158. package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +0 -171
  159. package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +0 -166
  160. package/packages/orq-rc/src/funcs/knowledgeDelete.ts +0 -167
  161. package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +0 -174
  162. package/packages/orq-rc/src/funcs/knowledgeDeleteChunks.ts +0 -170
  163. package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +0 -173
  164. package/packages/orq-rc/src/funcs/knowledgeGetChunksCount.ts +0 -170
  165. package/packages/orq-rc/src/funcs/knowledgeList.ts +0 -169
  166. package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +0 -178
  167. package/packages/orq-rc/src/funcs/knowledgeListChunksPaginated.ts +0 -171
  168. package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +0 -174
  169. package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +0 -166
  170. package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +0 -173
  171. package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +0 -169
  172. package/packages/orq-rc/src/funcs/knowledgeSearch.ts +0 -167
  173. package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +0 -164
  174. package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +0 -174
  175. package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +0 -170
  176. package/packages/orq-rc/src/funcs/memoryStoresCreate.ts +0 -171
  177. package/packages/orq-rc/src/funcs/memoryStoresCreateDocument.ts +0 -175
  178. package/packages/orq-rc/src/funcs/memoryStoresCreateMemory.ts +0 -170
  179. package/packages/orq-rc/src/funcs/memoryStoresDelete.ts +0 -168
  180. package/packages/orq-rc/src/funcs/memoryStoresDeleteDocument.ts +0 -184
  181. package/packages/orq-rc/src/funcs/memoryStoresDeleteMemory.ts +0 -179
  182. package/packages/orq-rc/src/funcs/memoryStoresList.ts +0 -178
  183. package/packages/orq-rc/src/funcs/memoryStoresListDocuments.ts +0 -181
  184. package/packages/orq-rc/src/funcs/memoryStoresListMemories.ts +0 -176
  185. package/packages/orq-rc/src/funcs/memoryStoresRetrieve.ts +0 -177
  186. package/packages/orq-rc/src/funcs/memoryStoresRetrieveDocument.ts +0 -178
  187. package/packages/orq-rc/src/funcs/memoryStoresRetrieveMemory.ts +0 -173
  188. package/packages/orq-rc/src/funcs/memoryStoresUpdate.ts +0 -168
  189. package/packages/orq-rc/src/funcs/memoryStoresUpdateDocument.ts +0 -179
  190. package/packages/orq-rc/src/funcs/memoryStoresUpdateMemory.ts +0 -174
  191. package/packages/orq-rc/src/funcs/modelsList.ts +0 -142
  192. package/packages/orq-rc/src/funcs/promptsCreate.ts +0 -160
  193. package/packages/orq-rc/src/funcs/promptsDelete.ts +0 -164
  194. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +0 -181
  195. package/packages/orq-rc/src/funcs/promptsList.ts +0 -167
  196. package/packages/orq-rc/src/funcs/promptsListVersions.ts +0 -173
  197. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +0 -166
  198. package/packages/orq-rc/src/funcs/promptsUpdate.ts +0 -173
  199. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +0 -161
  200. package/packages/orq-rc/src/funcs/toolsCreate.ts +0 -163
  201. package/packages/orq-rc/src/funcs/toolsDelete.ts +0 -167
  202. package/packages/orq-rc/src/funcs/toolsDuplicate.ts +0 -175
  203. package/packages/orq-rc/src/funcs/toolsList.ts +0 -176
  204. package/packages/orq-rc/src/funcs/toolsRetrieve.ts +0 -166
  205. package/packages/orq-rc/src/funcs/toolsUpdate.ts +0 -176
  206. package/packages/orq-rc/src/hooks/global.ts +0 -44
  207. package/packages/orq-rc/src/hooks/hooks.ts +0 -132
  208. package/packages/orq-rc/src/hooks/index.ts +0 -6
  209. package/packages/orq-rc/src/hooks/registration.ts +0 -15
  210. package/packages/orq-rc/src/hooks/types.ts +0 -112
  211. package/packages/orq-rc/src/index.ts +0 -9
  212. package/packages/orq-rc/src/lib/base64.ts +0 -37
  213. package/packages/orq-rc/src/lib/config.ts +0 -74
  214. package/packages/orq-rc/src/lib/dlv.ts +0 -53
  215. package/packages/orq-rc/src/lib/encodings.ts +0 -483
  216. package/packages/orq-rc/src/lib/env.ts +0 -89
  217. package/packages/orq-rc/src/lib/event-streams.ts +0 -135
  218. package/packages/orq-rc/src/lib/files.ts +0 -82
  219. package/packages/orq-rc/src/lib/http.ts +0 -323
  220. package/packages/orq-rc/src/lib/is-plain-object.ts +0 -43
  221. package/packages/orq-rc/src/lib/logger.ts +0 -9
  222. package/packages/orq-rc/src/lib/matchers.ts +0 -345
  223. package/packages/orq-rc/src/lib/primitives.ts +0 -150
  224. package/packages/orq-rc/src/lib/retries.ts +0 -218
  225. package/packages/orq-rc/src/lib/schemas.ts +0 -91
  226. package/packages/orq-rc/src/lib/sdks.ts +0 -407
  227. package/packages/orq-rc/src/lib/security.ts +0 -264
  228. package/packages/orq-rc/src/lib/url.ts +0 -33
  229. package/packages/orq-rc/src/mcp-server/cli/start/command.ts +0 -111
  230. package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +0 -136
  231. package/packages/orq-rc/src/mcp-server/cli.ts +0 -13
  232. package/packages/orq-rc/src/mcp-server/console-logger.ts +0 -71
  233. package/packages/orq-rc/src/mcp-server/extensions.ts +0 -17
  234. package/packages/orq-rc/src/mcp-server/mcp-server.ts +0 -26
  235. package/packages/orq-rc/src/mcp-server/prompts.ts +0 -117
  236. package/packages/orq-rc/src/mcp-server/resources.ts +0 -172
  237. package/packages/orq-rc/src/mcp-server/scopes.ts +0 -7
  238. package/packages/orq-rc/src/mcp-server/server.ts +0 -259
  239. package/packages/orq-rc/src/mcp-server/shared.ts +0 -74
  240. package/packages/orq-rc/src/mcp-server/tools/agentsCreate.ts +0 -37
  241. package/packages/orq-rc/src/mcp-server/tools/agentsDelete.ts +0 -35
  242. package/packages/orq-rc/src/mcp-server/tools/agentsInvoke.ts +0 -37
  243. package/packages/orq-rc/src/mcp-server/tools/agentsList.ts +0 -37
  244. package/packages/orq-rc/src/mcp-server/tools/agentsListActions.ts +0 -35
  245. package/packages/orq-rc/src/mcp-server/tools/agentsListTasks.ts +0 -37
  246. package/packages/orq-rc/src/mcp-server/tools/agentsRetrieve.ts +0 -37
  247. package/packages/orq-rc/src/mcp-server/tools/agentsRetrieveAction.ts +0 -35
  248. package/packages/orq-rc/src/mcp-server/tools/agentsRetrieveTask.ts +0 -37
  249. package/packages/orq-rc/src/mcp-server/tools/agentsRun.ts +0 -37
  250. package/packages/orq-rc/src/mcp-server/tools/agentsStream.ts +0 -37
  251. package/packages/orq-rc/src/mcp-server/tools/agentsStreamRun.ts +0 -37
  252. package/packages/orq-rc/src/mcp-server/tools/agentsUpdate.ts +0 -37
  253. package/packages/orq-rc/src/mcp-server/tools/budgetsCreate.ts +0 -37
  254. package/packages/orq-rc/src/mcp-server/tools/budgetsDelete.ts +0 -35
  255. package/packages/orq-rc/src/mcp-server/tools/budgetsGet.ts +0 -37
  256. package/packages/orq-rc/src/mcp-server/tools/budgetsList.ts +0 -37
  257. package/packages/orq-rc/src/mcp-server/tools/budgetsUpdate.ts +0 -37
  258. package/packages/orq-rc/src/mcp-server/tools/chunkingParse.ts +0 -37
  259. package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +0 -37
  260. package/packages/orq-rc/src/mcp-server/tools/contactsDelete.ts +0 -35
  261. package/packages/orq-rc/src/mcp-server/tools/contactsList.ts +0 -37
  262. package/packages/orq-rc/src/mcp-server/tools/contactsRetrieve.ts +0 -37
  263. package/packages/orq-rc/src/mcp-server/tools/contactsUpdate.ts +0 -37
  264. package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +0 -35
  265. package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +0 -37
  266. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +0 -37
  267. package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +0 -35
  268. package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +0 -35
  269. package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +0 -37
  270. package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +0 -37
  271. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +0 -37
  272. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +0 -37
  273. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +0 -37
  274. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +0 -35
  275. package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +0 -37
  276. package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +0 -37
  277. package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +0 -37
  278. package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +0 -37
  279. package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +0 -37
  280. package/packages/orq-rc/src/mcp-server/tools/evalsAll.ts +0 -35
  281. package/packages/orq-rc/src/mcp-server/tools/evalsCreate.ts +0 -35
  282. package/packages/orq-rc/src/mcp-server/tools/evalsDelete.ts +0 -33
  283. package/packages/orq-rc/src/mcp-server/tools/evalsUpdate.ts +0 -35
  284. package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +0 -37
  285. package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +0 -37
  286. package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +0 -33
  287. package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +0 -37
  288. package/packages/orq-rc/src/mcp-server/tools/filesList.ts +0 -37
  289. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +0 -35
  290. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +0 -35
  291. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +0 -35
  292. package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +0 -35
  293. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +0 -33
  294. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunks.ts +0 -35
  295. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +0 -35
  296. package/packages/orq-rc/src/mcp-server/tools/knowledgeGetChunksCount.ts +0 -35
  297. package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +0 -37
  298. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +0 -35
  299. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunksPaginated.ts +0 -35
  300. package/packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts +0 -35
  301. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +0 -37
  302. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +0 -35
  303. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +0 -35
  304. package/packages/orq-rc/src/mcp-server/tools/knowledgeSearch.ts +0 -37
  305. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +0 -35
  306. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +0 -35
  307. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +0 -35
  308. package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreate.ts +0 -35
  309. package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreateDocument.ts +0 -37
  310. package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreateMemory.ts +0 -37
  311. package/packages/orq-rc/src/mcp-server/tools/memoryStoresDelete.ts +0 -35
  312. package/packages/orq-rc/src/mcp-server/tools/memoryStoresDeleteDocument.ts +0 -40
  313. package/packages/orq-rc/src/mcp-server/tools/memoryStoresDeleteMemory.ts +0 -40
  314. package/packages/orq-rc/src/mcp-server/tools/memoryStoresList.ts +0 -37
  315. package/packages/orq-rc/src/mcp-server/tools/memoryStoresListDocuments.ts +0 -37
  316. package/packages/orq-rc/src/mcp-server/tools/memoryStoresListMemories.ts +0 -37
  317. package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieve.ts +0 -37
  318. package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieveDocument.ts +0 -37
  319. package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieveMemory.ts +0 -37
  320. package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdate.ts +0 -37
  321. package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdateDocument.ts +0 -37
  322. package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdateMemory.ts +0 -37
  323. package/packages/orq-rc/src/mcp-server/tools/modelsList.ts +0 -30
  324. package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +0 -35
  325. package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +0 -33
  326. package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +0 -37
  327. package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +0 -37
  328. package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +0 -37
  329. package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +0 -37
  330. package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +0 -35
  331. package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +0 -36
  332. package/packages/orq-rc/src/mcp-server/tools/toolsCreate.ts +0 -37
  333. package/packages/orq-rc/src/mcp-server/tools/toolsDelete.ts +0 -35
  334. package/packages/orq-rc/src/mcp-server/tools/toolsDuplicate.ts +0 -37
  335. package/packages/orq-rc/src/mcp-server/tools/toolsList.ts +0 -37
  336. package/packages/orq-rc/src/mcp-server/tools/toolsRetrieve.ts +0 -37
  337. package/packages/orq-rc/src/mcp-server/tools/toolsUpdate.ts +0 -37
  338. package/packages/orq-rc/src/mcp-server/tools.ts +0 -129
  339. package/packages/orq-rc/src/models/components/deployments.ts +0 -8147
  340. package/packages/orq-rc/src/models/components/index.ts +0 -6
  341. package/packages/orq-rc/src/models/components/security.ts +0 -71
  342. package/packages/orq-rc/src/models/errors/apierror.ts +0 -40
  343. package/packages/orq-rc/src/models/errors/createagent.ts +0 -80
  344. package/packages/orq-rc/src/models/errors/createeval.ts +0 -80
  345. package/packages/orq-rc/src/models/errors/deleteagent.ts +0 -80
  346. package/packages/orq-rc/src/models/errors/deletecontact.ts +0 -91
  347. package/packages/orq-rc/src/models/errors/deleteeval.ts +0 -80
  348. package/packages/orq-rc/src/models/errors/duplicatetool.ts +0 -91
  349. package/packages/orq-rc/src/models/errors/getagent.ts +0 -80
  350. package/packages/orq-rc/src/models/errors/getagenttask.ts +0 -80
  351. package/packages/orq-rc/src/models/errors/getevals.ts +0 -80
  352. package/packages/orq-rc/src/models/errors/getpromptversion.ts +0 -80
  353. package/packages/orq-rc/src/models/errors/honoapierror.ts +0 -90
  354. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +0 -62
  355. package/packages/orq-rc/src/models/errors/index.ts +0 -29
  356. package/packages/orq-rc/src/models/errors/listagenttasks.ts +0 -80
  357. package/packages/orq-rc/src/models/errors/orqerror.ts +0 -35
  358. package/packages/orq-rc/src/models/errors/responsevalidationerror.ts +0 -50
  359. package/packages/orq-rc/src/models/errors/retrievecontact.ts +0 -91
  360. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +0 -109
  361. package/packages/orq-rc/src/models/errors/streamagent.ts +0 -80
  362. package/packages/orq-rc/src/models/errors/streamrunagent.ts +0 -80
  363. package/packages/orq-rc/src/models/errors/updateagent.ts +0 -80
  364. package/packages/orq-rc/src/models/errors/updatecontact.ts +0 -83
  365. package/packages/orq-rc/src/models/errors/updateeval.ts +0 -80
  366. package/packages/orq-rc/src/models/errors/updateprompt.ts +0 -80
  367. package/packages/orq-rc/src/models/errors/updatetool.ts +0 -91
  368. package/packages/orq-rc/src/models/operations/cleardataset.ts +0 -78
  369. package/packages/orq-rc/src/models/operations/createagent.ts +0 -3104
  370. package/packages/orq-rc/src/models/operations/createbudget.ts +0 -745
  371. package/packages/orq-rc/src/models/operations/createchunk.ts +0 -428
  372. package/packages/orq-rc/src/models/operations/createcontact.ts +0 -267
  373. package/packages/orq-rc/src/models/operations/createdataset.ts +0 -302
  374. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +0 -6943
  375. package/packages/orq-rc/src/models/operations/createdatasource.ts +0 -852
  376. package/packages/orq-rc/src/models/operations/createeval.ts +0 -9341
  377. package/packages/orq-rc/src/models/operations/createfeedback.ts +0 -286
  378. package/packages/orq-rc/src/models/operations/createknowledge.ts +0 -1850
  379. package/packages/orq-rc/src/models/operations/creatememory.ts +0 -274
  380. package/packages/orq-rc/src/models/operations/creatememorydocument.ts +0 -287
  381. package/packages/orq-rc/src/models/operations/creatememorystore.ts +0 -2032
  382. package/packages/orq-rc/src/models/operations/createprompt.ts +0 -7812
  383. package/packages/orq-rc/src/models/operations/createtool.ts +0 -4077
  384. package/packages/orq-rc/src/models/operations/deleteagent.ts +0 -78
  385. package/packages/orq-rc/src/models/operations/deletebudget.ts +0 -69
  386. package/packages/orq-rc/src/models/operations/deletechunk.ts +0 -96
  387. package/packages/orq-rc/src/models/operations/deletechunks.ts +0 -243
  388. package/packages/orq-rc/src/models/operations/deletecontact.ts +0 -69
  389. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +0 -87
  390. package/packages/orq-rc/src/models/operations/deletedataset.ts +0 -78
  391. package/packages/orq-rc/src/models/operations/deletedatasource.ts +0 -87
  392. package/packages/orq-rc/src/models/operations/deleteeval.ts +0 -66
  393. package/packages/orq-rc/src/models/operations/deleteknowledge.ts +0 -78
  394. package/packages/orq-rc/src/models/operations/deletememory.ts +0 -87
  395. package/packages/orq-rc/src/models/operations/deletememorydocument.ts +0 -98
  396. package/packages/orq-rc/src/models/operations/deletememorystore.ts +0 -78
  397. package/packages/orq-rc/src/models/operations/deleteprompt.ts +0 -69
  398. package/packages/orq-rc/src/models/operations/deletetool.ts +0 -75
  399. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +0 -6547
  400. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +0 -10532
  401. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +0 -1266
  402. package/packages/orq-rc/src/models/operations/deployments.ts +0 -2606
  403. package/packages/orq-rc/src/models/operations/deploymentstream.ts +0 -10655
  404. package/packages/orq-rc/src/models/operations/duplicatetool.ts +0 -2349
  405. package/packages/orq-rc/src/models/operations/filedelete.ts +0 -78
  406. package/packages/orq-rc/src/models/operations/fileget.ts +0 -223
  407. package/packages/orq-rc/src/models/operations/filelist.ts +0 -337
  408. package/packages/orq-rc/src/models/operations/fileupload.ts +0 -327
  409. package/packages/orq-rc/src/models/operations/getagent.ts +0 -957
  410. package/packages/orq-rc/src/models/operations/getagenttask.ts +0 -259
  411. package/packages/orq-rc/src/models/operations/getallmemories.ts +0 -318
  412. package/packages/orq-rc/src/models/operations/getallmemorydocuments.ts +0 -338
  413. package/packages/orq-rc/src/models/operations/getallmemorystores.ts +0 -1277
  414. package/packages/orq-rc/src/models/operations/getallprompts.ts +0 -2572
  415. package/packages/orq-rc/src/models/operations/getalltools.ts +0 -2308
  416. package/packages/orq-rc/src/models/operations/getbudget.ts +0 -441
  417. package/packages/orq-rc/src/models/operations/getchunkscount.ts +0 -230
  418. package/packages/orq-rc/src/models/operations/getevals.ts +0 -7486
  419. package/packages/orq-rc/src/models/operations/getonechunk.ts +0 -315
  420. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +0 -1292
  421. package/packages/orq-rc/src/models/operations/getoneprompt.ts +0 -2437
  422. package/packages/orq-rc/src/models/operations/getpromptversion.ts +0 -2444
  423. package/packages/orq-rc/src/models/operations/index.ts +0 -102
  424. package/packages/orq-rc/src/models/operations/invokeagent.ts +0 -1569
  425. package/packages/orq-rc/src/models/operations/listactions.ts +0 -526
  426. package/packages/orq-rc/src/models/operations/listagents.ts +0 -1077
  427. package/packages/orq-rc/src/models/operations/listagenttasks.ts +0 -1106
  428. package/packages/orq-rc/src/models/operations/listbudgets.ts +0 -617
  429. package/packages/orq-rc/src/models/operations/listchunks.ts +0 -494
  430. package/packages/orq-rc/src/models/operations/listchunkspaginated.ts +0 -507
  431. package/packages/orq-rc/src/models/operations/listcontacts.ts +0 -500
  432. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +0 -4086
  433. package/packages/orq-rc/src/models/operations/listdatasets.ts +0 -406
  434. package/packages/orq-rc/src/models/operations/listdatasources.ts +0 -454
  435. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +0 -1303
  436. package/packages/orq-rc/src/models/operations/listmodels.ts +0 -273
  437. package/packages/orq-rc/src/models/operations/listpromptversions.ts +0 -2580
  438. package/packages/orq-rc/src/models/operations/parse.ts +0 -1295
  439. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +0 -190
  440. package/packages/orq-rc/src/models/operations/retrieveaction.ts +0 -426
  441. package/packages/orq-rc/src/models/operations/retrievecontact.ts +0 -210
  442. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +0 -3853
  443. package/packages/orq-rc/src/models/operations/retrievedataset.ts +0 -291
  444. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +0 -273
  445. package/packages/orq-rc/src/models/operations/retrievememory.ts +0 -201
  446. package/packages/orq-rc/src/models/operations/retrievememorydocument.ts +0 -220
  447. package/packages/orq-rc/src/models/operations/retrievememorystore.ts +0 -1160
  448. package/packages/orq-rc/src/models/operations/retrievetool.ts +0 -2333
  449. package/packages/orq-rc/src/models/operations/runagent.ts +0 -4342
  450. package/packages/orq-rc/src/models/operations/searchknowledge.ts +0 -3573
  451. package/packages/orq-rc/src/models/operations/streamagent.ts +0 -1367
  452. package/packages/orq-rc/src/models/operations/streamrunagent.ts +0 -4355
  453. package/packages/orq-rc/src/models/operations/updateagent.ts +0 -3321
  454. package/packages/orq-rc/src/models/operations/updatebudget.ts +0 -628
  455. package/packages/orq-rc/src/models/operations/updatechunk.ts +0 -448
  456. package/packages/orq-rc/src/models/operations/updatecontact.ts +0 -325
  457. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +0 -6934
  458. package/packages/orq-rc/src/models/operations/updatedataset.ts +0 -386
  459. package/packages/orq-rc/src/models/operations/updatedatasource.ts +0 -345
  460. package/packages/orq-rc/src/models/operations/updateeval.ts +0 -9704
  461. package/packages/orq-rc/src/models/operations/updateknowledge.ts +0 -2341
  462. package/packages/orq-rc/src/models/operations/updatememory.ts +0 -283
  463. package/packages/orq-rc/src/models/operations/updatememorydocument.ts +0 -296
  464. package/packages/orq-rc/src/models/operations/updatememorystore.ts +0 -1363
  465. package/packages/orq-rc/src/models/operations/updateprompt.ts +0 -8176
  466. package/packages/orq-rc/src/models/operations/updatetool.ts +0 -4288
  467. package/packages/orq-rc/src/sdk/agents.ts +0 -238
  468. package/packages/orq-rc/src/sdk/budgets.ts +0 -99
  469. package/packages/orq-rc/src/sdk/chunking.ts +0 -27
  470. package/packages/orq-rc/src/sdk/contacts.ts +0 -99
  471. package/packages/orq-rc/src/sdk/datasets.ts +0 -204
  472. package/packages/orq-rc/src/sdk/deployments.ts +0 -89
  473. package/packages/orq-rc/src/sdk/evals.ts +0 -69
  474. package/packages/orq-rc/src/sdk/feedback.ts +0 -27
  475. package/packages/orq-rc/src/sdk/files.ts +0 -78
  476. package/packages/orq-rc/src/sdk/index.ts +0 -5
  477. package/packages/orq-rc/src/sdk/knowledge.ts +0 -309
  478. package/packages/orq-rc/src/sdk/memorystores.ts +0 -286
  479. package/packages/orq-rc/src/sdk/metrics.ts +0 -27
  480. package/packages/orq-rc/src/sdk/models.ts +0 -25
  481. package/packages/orq-rc/src/sdk/prompts.ts +0 -126
  482. package/packages/orq-rc/src/sdk/remoteconfigs.ts +0 -24
  483. package/packages/orq-rc/src/sdk/sdk.ts +0 -97
  484. package/packages/orq-rc/src/sdk/tools.ts +0 -117
  485. package/packages/orq-rc/src/types/async.ts +0 -68
  486. package/packages/orq-rc/src/types/blobs.ts +0 -32
  487. package/packages/orq-rc/src/types/constdatetime.ts +0 -15
  488. package/packages/orq-rc/src/types/enums.ts +0 -16
  489. package/packages/orq-rc/src/types/fp.ts +0 -50
  490. package/packages/orq-rc/src/types/index.ts +0 -11
  491. package/packages/orq-rc/src/types/operations.ts +0 -105
  492. package/packages/orq-rc/src/types/rfcdate.ts +0 -54
  493. package/packages/orq-rc/src/types/streams.ts +0 -21
  494. package/packages/orq-rc/tsconfig.json +0 -41
@@ -1,836 +0,0 @@
1
- # Datasets
2
- (*datasets*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [list](#list) - List datasets
9
- * [create](#create) - Create a dataset
10
- * [retrieve](#retrieve) - Retrieve a dataset
11
- * [update](#update) - Update a dataset
12
- * [delete](#delete) - Delete a dataset
13
- * [listDatapoints](#listdatapoints) - List datapoints
14
- * [createDatapoint](#createdatapoint) - Create a datapoint
15
- * [retrieveDatapoint](#retrievedatapoint) - Retrieve a datapoint
16
- * [updateDatapoint](#updatedatapoint) - Update a datapoint
17
- * [deleteDatapoint](#deletedatapoint) - Delete a datapoint
18
- * [clear](#clear) - Delete all datapoints
19
-
20
- ## list
21
-
22
- Retrieves a paginated list of datasets for the current workspace. Results can be paginated using cursor-based pagination.
23
-
24
- ### Example Usage
25
-
26
- <!-- UsageSnippet language="typescript" operationID="ListDatasets" method="get" path="/v2/datasets" -->
27
- ```typescript
28
- import { Orq } from "@orq-ai/node";
29
-
30
- const orq = new Orq({
31
- apiKey: process.env["ORQ_API_KEY"] ?? "",
32
- });
33
-
34
- async function run() {
35
- const result = await orq.datasets.list({});
36
-
37
- console.log(result);
38
- }
39
-
40
- run();
41
- ```
42
-
43
- ### Standalone function
44
-
45
- The standalone function version of this method:
46
-
47
- ```typescript
48
- import { OrqCore } from "@orq-ai/node/core.js";
49
- import { datasetsList } from "@orq-ai/node/funcs/datasetsList.js";
50
-
51
- // Use `OrqCore` for best tree-shaking performance.
52
- // You can create one instance of it to use across an application.
53
- const orq = new OrqCore({
54
- apiKey: process.env["ORQ_API_KEY"] ?? "",
55
- });
56
-
57
- async function run() {
58
- const res = await datasetsList(orq, {});
59
- if (res.ok) {
60
- const { value: result } = res;
61
- console.log(result);
62
- } else {
63
- console.log("datasetsList failed:", res.error);
64
- }
65
- }
66
-
67
- run();
68
- ```
69
-
70
- ### Parameters
71
-
72
- | Parameter | Type | Required | Description |
73
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
74
- | `request` | [operations.ListDatasetsRequest](../../models/operations/listdatasetsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
75
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
76
- | `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. |
77
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
78
-
79
- ### Response
80
-
81
- **Promise\<[operations.ListDatasetsResponseBody](../../models/operations/listdatasetsresponsebody.md)\>**
82
-
83
- ### Errors
84
-
85
- | Error Type | Status Code | Content Type |
86
- | --------------- | --------------- | --------------- |
87
- | errors.APIError | 4XX, 5XX | \*/\* |
88
-
89
- ## create
90
-
91
- Creates a new dataset in the specified project.
92
-
93
- ### Example Usage
94
-
95
- <!-- UsageSnippet language="typescript" operationID="CreateDataset" method="post" path="/v2/datasets" -->
96
- ```typescript
97
- import { Orq } from "@orq-ai/node";
98
-
99
- const orq = new Orq({
100
- apiKey: process.env["ORQ_API_KEY"] ?? "",
101
- });
102
-
103
- async function run() {
104
- const result = await orq.datasets.create({
105
- displayName: "Neva.Raynor10",
106
- path: "Default",
107
- });
108
-
109
- console.log(result);
110
- }
111
-
112
- run();
113
- ```
114
-
115
- ### Standalone function
116
-
117
- The standalone function version of this method:
118
-
119
- ```typescript
120
- import { OrqCore } from "@orq-ai/node/core.js";
121
- import { datasetsCreate } from "@orq-ai/node/funcs/datasetsCreate.js";
122
-
123
- // Use `OrqCore` for best tree-shaking performance.
124
- // You can create one instance of it to use across an application.
125
- const orq = new OrqCore({
126
- apiKey: process.env["ORQ_API_KEY"] ?? "",
127
- });
128
-
129
- async function run() {
130
- const res = await datasetsCreate(orq, {
131
- displayName: "Neva.Raynor10",
132
- path: "Default",
133
- });
134
- if (res.ok) {
135
- const { value: result } = res;
136
- console.log(result);
137
- } else {
138
- console.log("datasetsCreate failed:", res.error);
139
- }
140
- }
141
-
142
- run();
143
- ```
144
-
145
- ### Parameters
146
-
147
- | Parameter | Type | Required | Description |
148
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
149
- | `request` | [operations.CreateDatasetRequestBody](../../models/operations/createdatasetrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
150
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
151
- | `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. |
152
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
153
-
154
- ### Response
155
-
156
- **Promise\<[operations.CreateDatasetResponseBody](../../models/operations/createdatasetresponsebody.md)\>**
157
-
158
- ### Errors
159
-
160
- | Error Type | Status Code | Content Type |
161
- | --------------- | --------------- | --------------- |
162
- | errors.APIError | 4XX, 5XX | \*/\* |
163
-
164
- ## retrieve
165
-
166
- Retrieves a specific dataset by its unique identifier
167
-
168
- ### Example Usage
169
-
170
- <!-- UsageSnippet language="typescript" operationID="RetrieveDataset" method="get" path="/v2/datasets/{dataset_id}" -->
171
- ```typescript
172
- import { Orq } from "@orq-ai/node";
173
-
174
- const orq = new Orq({
175
- apiKey: process.env["ORQ_API_KEY"] ?? "",
176
- });
177
-
178
- async function run() {
179
- const result = await orq.datasets.retrieve({
180
- datasetId: "<id>",
181
- });
182
-
183
- console.log(result);
184
- }
185
-
186
- run();
187
- ```
188
-
189
- ### Standalone function
190
-
191
- The standalone function version of this method:
192
-
193
- ```typescript
194
- import { OrqCore } from "@orq-ai/node/core.js";
195
- import { datasetsRetrieve } from "@orq-ai/node/funcs/datasetsRetrieve.js";
196
-
197
- // Use `OrqCore` for best tree-shaking performance.
198
- // You can create one instance of it to use across an application.
199
- const orq = new OrqCore({
200
- apiKey: process.env["ORQ_API_KEY"] ?? "",
201
- });
202
-
203
- async function run() {
204
- const res = await datasetsRetrieve(orq, {
205
- datasetId: "<id>",
206
- });
207
- if (res.ok) {
208
- const { value: result } = res;
209
- console.log(result);
210
- } else {
211
- console.log("datasetsRetrieve failed:", res.error);
212
- }
213
- }
214
-
215
- run();
216
- ```
217
-
218
- ### Parameters
219
-
220
- | Parameter | Type | Required | Description |
221
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
222
- | `request` | [operations.RetrieveDatasetRequest](../../models/operations/retrievedatasetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
223
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
224
- | `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. |
225
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
226
-
227
- ### Response
228
-
229
- **Promise\<[operations.RetrieveDatasetResponseBody](../../models/operations/retrievedatasetresponsebody.md)\>**
230
-
231
- ### Errors
232
-
233
- | Error Type | Status Code | Content Type |
234
- | ------------------- | ------------------- | ------------------- |
235
- | errors.HonoApiError | 404 | application/json |
236
- | errors.APIError | 4XX, 5XX | \*/\* |
237
-
238
- ## update
239
-
240
- Update a dataset
241
-
242
- ### Example Usage
243
-
244
- <!-- UsageSnippet language="typescript" operationID="UpdateDataset" method="patch" path="/v2/datasets/{dataset_id}" -->
245
- ```typescript
246
- import { Orq } from "@orq-ai/node";
247
-
248
- const orq = new Orq({
249
- apiKey: process.env["ORQ_API_KEY"] ?? "",
250
- });
251
-
252
- async function run() {
253
- const result = await orq.datasets.update({
254
- datasetId: "<id>",
255
- requestBody: {
256
- path: "Default",
257
- },
258
- });
259
-
260
- console.log(result);
261
- }
262
-
263
- run();
264
- ```
265
-
266
- ### Standalone function
267
-
268
- The standalone function version of this method:
269
-
270
- ```typescript
271
- import { OrqCore } from "@orq-ai/node/core.js";
272
- import { datasetsUpdate } from "@orq-ai/node/funcs/datasetsUpdate.js";
273
-
274
- // Use `OrqCore` for best tree-shaking performance.
275
- // You can create one instance of it to use across an application.
276
- const orq = new OrqCore({
277
- apiKey: process.env["ORQ_API_KEY"] ?? "",
278
- });
279
-
280
- async function run() {
281
- const res = await datasetsUpdate(orq, {
282
- datasetId: "<id>",
283
- requestBody: {
284
- path: "Default",
285
- },
286
- });
287
- if (res.ok) {
288
- const { value: result } = res;
289
- console.log(result);
290
- } else {
291
- console.log("datasetsUpdate failed:", res.error);
292
- }
293
- }
294
-
295
- run();
296
- ```
297
-
298
- ### Parameters
299
-
300
- | Parameter | Type | Required | Description |
301
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
302
- | `request` | [operations.UpdateDatasetRequest](../../models/operations/updatedatasetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
303
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
304
- | `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. |
305
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
306
-
307
- ### Response
308
-
309
- **Promise\<[operations.UpdateDatasetResponseBody](../../models/operations/updatedatasetresponsebody.md)\>**
310
-
311
- ### Errors
312
-
313
- | Error Type | Status Code | Content Type |
314
- | ------------------- | ------------------- | ------------------- |
315
- | errors.HonoApiError | 404 | application/json |
316
- | errors.APIError | 4XX, 5XX | \*/\* |
317
-
318
- ## delete
319
-
320
- Permanently deletes a dataset and all its datapoints. This action is irreversible.
321
-
322
- ### Example Usage
323
-
324
- <!-- UsageSnippet language="typescript" operationID="DeleteDataset" method="delete" path="/v2/datasets/{dataset_id}" -->
325
- ```typescript
326
- import { Orq } from "@orq-ai/node";
327
-
328
- const orq = new Orq({
329
- apiKey: process.env["ORQ_API_KEY"] ?? "",
330
- });
331
-
332
- async function run() {
333
- await orq.datasets.delete({
334
- datasetId: "<id>",
335
- });
336
-
337
-
338
- }
339
-
340
- run();
341
- ```
342
-
343
- ### Standalone function
344
-
345
- The standalone function version of this method:
346
-
347
- ```typescript
348
- import { OrqCore } from "@orq-ai/node/core.js";
349
- import { datasetsDelete } from "@orq-ai/node/funcs/datasetsDelete.js";
350
-
351
- // Use `OrqCore` for best tree-shaking performance.
352
- // You can create one instance of it to use across an application.
353
- const orq = new OrqCore({
354
- apiKey: process.env["ORQ_API_KEY"] ?? "",
355
- });
356
-
357
- async function run() {
358
- const res = await datasetsDelete(orq, {
359
- datasetId: "<id>",
360
- });
361
- if (res.ok) {
362
- const { value: result } = res;
363
-
364
- } else {
365
- console.log("datasetsDelete failed:", res.error);
366
- }
367
- }
368
-
369
- run();
370
- ```
371
-
372
- ### Parameters
373
-
374
- | Parameter | Type | Required | Description |
375
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
376
- | `request` | [operations.DeleteDatasetRequest](../../models/operations/deletedatasetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
377
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
378
- | `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. |
379
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
380
-
381
- ### Response
382
-
383
- **Promise\<void\>**
384
-
385
- ### Errors
386
-
387
- | Error Type | Status Code | Content Type |
388
- | --------------- | --------------- | --------------- |
389
- | errors.APIError | 4XX, 5XX | \*/\* |
390
-
391
- ## listDatapoints
392
-
393
- Retrieves a paginated list of datapoints from a specific dataset.
394
-
395
- ### Example Usage
396
-
397
- <!-- UsageSnippet language="typescript" operationID="ListDatasetDatapoints" method="get" path="/v2/datasets/{dataset_id}/datapoints" -->
398
- ```typescript
399
- import { Orq } from "@orq-ai/node";
400
-
401
- const orq = new Orq({
402
- apiKey: process.env["ORQ_API_KEY"] ?? "",
403
- });
404
-
405
- async function run() {
406
- const result = await orq.datasets.listDatapoints({
407
- datasetId: "<id>",
408
- });
409
-
410
- console.log(result);
411
- }
412
-
413
- run();
414
- ```
415
-
416
- ### Standalone function
417
-
418
- The standalone function version of this method:
419
-
420
- ```typescript
421
- import { OrqCore } from "@orq-ai/node/core.js";
422
- import { datasetsListDatapoints } from "@orq-ai/node/funcs/datasetsListDatapoints.js";
423
-
424
- // Use `OrqCore` for best tree-shaking performance.
425
- // You can create one instance of it to use across an application.
426
- const orq = new OrqCore({
427
- apiKey: process.env["ORQ_API_KEY"] ?? "",
428
- });
429
-
430
- async function run() {
431
- const res = await datasetsListDatapoints(orq, {
432
- datasetId: "<id>",
433
- });
434
- if (res.ok) {
435
- const { value: result } = res;
436
- console.log(result);
437
- } else {
438
- console.log("datasetsListDatapoints failed:", res.error);
439
- }
440
- }
441
-
442
- run();
443
- ```
444
-
445
- ### Parameters
446
-
447
- | Parameter | Type | Required | Description |
448
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
449
- | `request` | [operations.ListDatasetDatapointsRequest](../../models/operations/listdatasetdatapointsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
450
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
451
- | `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. |
452
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
453
-
454
- ### Response
455
-
456
- **Promise\<[operations.ListDatasetDatapointsResponseBody](../../models/operations/listdatasetdatapointsresponsebody.md)\>**
457
-
458
- ### Errors
459
-
460
- | Error Type | Status Code | Content Type |
461
- | --------------- | --------------- | --------------- |
462
- | errors.APIError | 4XX, 5XX | \*/\* |
463
-
464
- ## createDatapoint
465
-
466
- Creates a new datapoint in the specified dataset.
467
-
468
- ### Example Usage
469
-
470
- <!-- UsageSnippet language="typescript" operationID="CreateDatasetItem" method="post" path="/v2/datasets/{dataset_id}/datapoints" -->
471
- ```typescript
472
- import { Orq } from "@orq-ai/node";
473
-
474
- const orq = new Orq({
475
- apiKey: process.env["ORQ_API_KEY"] ?? "",
476
- });
477
-
478
- async function run() {
479
- const result = await orq.datasets.createDatapoint({
480
- datasetId: "<id>",
481
- });
482
-
483
- console.log(result);
484
- }
485
-
486
- run();
487
- ```
488
-
489
- ### Standalone function
490
-
491
- The standalone function version of this method:
492
-
493
- ```typescript
494
- import { OrqCore } from "@orq-ai/node/core.js";
495
- import { datasetsCreateDatapoint } from "@orq-ai/node/funcs/datasetsCreateDatapoint.js";
496
-
497
- // Use `OrqCore` for best tree-shaking performance.
498
- // You can create one instance of it to use across an application.
499
- const orq = new OrqCore({
500
- apiKey: process.env["ORQ_API_KEY"] ?? "",
501
- });
502
-
503
- async function run() {
504
- const res = await datasetsCreateDatapoint(orq, {
505
- datasetId: "<id>",
506
- });
507
- if (res.ok) {
508
- const { value: result } = res;
509
- console.log(result);
510
- } else {
511
- console.log("datasetsCreateDatapoint failed:", res.error);
512
- }
513
- }
514
-
515
- run();
516
- ```
517
-
518
- ### Parameters
519
-
520
- | Parameter | Type | Required | Description |
521
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
522
- | `request` | [operations.CreateDatasetItemRequest](../../models/operations/createdatasetitemrequest.md) | :heavy_check_mark: | The request object to use for the request. |
523
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
524
- | `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. |
525
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
526
-
527
- ### Response
528
-
529
- **Promise\<[operations.CreateDatasetItemResponseBody[]](../../models/.md)\>**
530
-
531
- ### Errors
532
-
533
- | Error Type | Status Code | Content Type |
534
- | --------------- | --------------- | --------------- |
535
- | errors.APIError | 4XX, 5XX | \*/\* |
536
-
537
- ## retrieveDatapoint
538
-
539
- Retrieves a datapoint object
540
-
541
- ### Example Usage
542
-
543
- <!-- UsageSnippet language="typescript" operationID="RetrieveDatapoint" method="get" path="/v2/datasets/{dataset_id}/datapoints/{datapoint_id}" -->
544
- ```typescript
545
- import { Orq } from "@orq-ai/node";
546
-
547
- const orq = new Orq({
548
- apiKey: process.env["ORQ_API_KEY"] ?? "",
549
- });
550
-
551
- async function run() {
552
- const result = await orq.datasets.retrieveDatapoint({
553
- datasetId: "<id>",
554
- datapointId: "<id>",
555
- });
556
-
557
- console.log(result);
558
- }
559
-
560
- run();
561
- ```
562
-
563
- ### Standalone function
564
-
565
- The standalone function version of this method:
566
-
567
- ```typescript
568
- import { OrqCore } from "@orq-ai/node/core.js";
569
- import { datasetsRetrieveDatapoint } from "@orq-ai/node/funcs/datasetsRetrieveDatapoint.js";
570
-
571
- // Use `OrqCore` for best tree-shaking performance.
572
- // You can create one instance of it to use across an application.
573
- const orq = new OrqCore({
574
- apiKey: process.env["ORQ_API_KEY"] ?? "",
575
- });
576
-
577
- async function run() {
578
- const res = await datasetsRetrieveDatapoint(orq, {
579
- datasetId: "<id>",
580
- datapointId: "<id>",
581
- });
582
- if (res.ok) {
583
- const { value: result } = res;
584
- console.log(result);
585
- } else {
586
- console.log("datasetsRetrieveDatapoint failed:", res.error);
587
- }
588
- }
589
-
590
- run();
591
- ```
592
-
593
- ### Parameters
594
-
595
- | Parameter | Type | Required | Description |
596
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
597
- | `request` | [operations.RetrieveDatapointRequest](../../models/operations/retrievedatapointrequest.md) | :heavy_check_mark: | The request object to use for the request. |
598
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
599
- | `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. |
600
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
601
-
602
- ### Response
603
-
604
- **Promise\<[operations.RetrieveDatapointResponseBody](../../models/operations/retrievedatapointresponsebody.md)\>**
605
-
606
- ### Errors
607
-
608
- | Error Type | Status Code | Content Type |
609
- | ------------------- | ------------------- | ------------------- |
610
- | errors.HonoApiError | 404 | application/json |
611
- | errors.APIError | 4XX, 5XX | \*/\* |
612
-
613
- ## updateDatapoint
614
-
615
- Update a datapoint
616
-
617
- ### Example Usage
618
-
619
- <!-- UsageSnippet language="typescript" operationID="UpdateDatapoint" method="patch" path="/v2/datasets/{dataset_id}/datapoints/{datapoint_id}" -->
620
- ```typescript
621
- import { Orq } from "@orq-ai/node";
622
-
623
- const orq = new Orq({
624
- apiKey: process.env["ORQ_API_KEY"] ?? "",
625
- });
626
-
627
- async function run() {
628
- const result = await orq.datasets.updateDatapoint({
629
- datasetId: "<id>",
630
- datapointId: "<id>",
631
- });
632
-
633
- console.log(result);
634
- }
635
-
636
- run();
637
- ```
638
-
639
- ### Standalone function
640
-
641
- The standalone function version of this method:
642
-
643
- ```typescript
644
- import { OrqCore } from "@orq-ai/node/core.js";
645
- import { datasetsUpdateDatapoint } from "@orq-ai/node/funcs/datasetsUpdateDatapoint.js";
646
-
647
- // Use `OrqCore` for best tree-shaking performance.
648
- // You can create one instance of it to use across an application.
649
- const orq = new OrqCore({
650
- apiKey: process.env["ORQ_API_KEY"] ?? "",
651
- });
652
-
653
- async function run() {
654
- const res = await datasetsUpdateDatapoint(orq, {
655
- datasetId: "<id>",
656
- datapointId: "<id>",
657
- });
658
- if (res.ok) {
659
- const { value: result } = res;
660
- console.log(result);
661
- } else {
662
- console.log("datasetsUpdateDatapoint failed:", res.error);
663
- }
664
- }
665
-
666
- run();
667
- ```
668
-
669
- ### Parameters
670
-
671
- | Parameter | Type | Required | Description |
672
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
673
- | `request` | [operations.UpdateDatapointRequest](../../models/operations/updatedatapointrequest.md) | :heavy_check_mark: | The request object to use for the request. |
674
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
675
- | `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. |
676
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
677
-
678
- ### Response
679
-
680
- **Promise\<[operations.UpdateDatapointResponseBody](../../models/operations/updatedatapointresponsebody.md)\>**
681
-
682
- ### Errors
683
-
684
- | Error Type | Status Code | Content Type |
685
- | ------------------- | ------------------- | ------------------- |
686
- | errors.HonoApiError | 404 | application/json |
687
- | errors.APIError | 4XX, 5XX | \*/\* |
688
-
689
- ## deleteDatapoint
690
-
691
- Permanently deletes a specific datapoint from a dataset.
692
-
693
- ### Example Usage
694
-
695
- <!-- UsageSnippet language="typescript" operationID="DeleteDatapoint" method="delete" path="/v2/datasets/{dataset_id}/datapoints/{datapoint_id}" -->
696
- ```typescript
697
- import { Orq } from "@orq-ai/node";
698
-
699
- const orq = new Orq({
700
- apiKey: process.env["ORQ_API_KEY"] ?? "",
701
- });
702
-
703
- async function run() {
704
- await orq.datasets.deleteDatapoint({
705
- datasetId: "<id>",
706
- datapointId: "<id>",
707
- });
708
-
709
-
710
- }
711
-
712
- run();
713
- ```
714
-
715
- ### Standalone function
716
-
717
- The standalone function version of this method:
718
-
719
- ```typescript
720
- import { OrqCore } from "@orq-ai/node/core.js";
721
- import { datasetsDeleteDatapoint } from "@orq-ai/node/funcs/datasetsDeleteDatapoint.js";
722
-
723
- // Use `OrqCore` for best tree-shaking performance.
724
- // You can create one instance of it to use across an application.
725
- const orq = new OrqCore({
726
- apiKey: process.env["ORQ_API_KEY"] ?? "",
727
- });
728
-
729
- async function run() {
730
- const res = await datasetsDeleteDatapoint(orq, {
731
- datasetId: "<id>",
732
- datapointId: "<id>",
733
- });
734
- if (res.ok) {
735
- const { value: result } = res;
736
-
737
- } else {
738
- console.log("datasetsDeleteDatapoint failed:", res.error);
739
- }
740
- }
741
-
742
- run();
743
- ```
744
-
745
- ### Parameters
746
-
747
- | Parameter | Type | Required | Description |
748
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
749
- | `request` | [operations.DeleteDatapointRequest](../../models/operations/deletedatapointrequest.md) | :heavy_check_mark: | The request object to use for the request. |
750
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
751
- | `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. |
752
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
753
-
754
- ### Response
755
-
756
- **Promise\<void\>**
757
-
758
- ### Errors
759
-
760
- | Error Type | Status Code | Content Type |
761
- | ------------------- | ------------------- | ------------------- |
762
- | errors.HonoApiError | 404 | application/json |
763
- | errors.APIError | 4XX, 5XX | \*/\* |
764
-
765
- ## clear
766
-
767
- Delete all datapoints from a dataset. This action is irreversible.
768
-
769
- ### Example Usage
770
-
771
- <!-- UsageSnippet language="typescript" operationID="ClearDataset" method="delete" path="/v2/datasets/{dataset_id}/clear" -->
772
- ```typescript
773
- import { Orq } from "@orq-ai/node";
774
-
775
- const orq = new Orq({
776
- apiKey: process.env["ORQ_API_KEY"] ?? "",
777
- });
778
-
779
- async function run() {
780
- await orq.datasets.clear({
781
- datasetId: "<id>",
782
- });
783
-
784
-
785
- }
786
-
787
- run();
788
- ```
789
-
790
- ### Standalone function
791
-
792
- The standalone function version of this method:
793
-
794
- ```typescript
795
- import { OrqCore } from "@orq-ai/node/core.js";
796
- import { datasetsClear } from "@orq-ai/node/funcs/datasetsClear.js";
797
-
798
- // Use `OrqCore` for best tree-shaking performance.
799
- // You can create one instance of it to use across an application.
800
- const orq = new OrqCore({
801
- apiKey: process.env["ORQ_API_KEY"] ?? "",
802
- });
803
-
804
- async function run() {
805
- const res = await datasetsClear(orq, {
806
- datasetId: "<id>",
807
- });
808
- if (res.ok) {
809
- const { value: result } = res;
810
-
811
- } else {
812
- console.log("datasetsClear failed:", res.error);
813
- }
814
- }
815
-
816
- run();
817
- ```
818
-
819
- ### Parameters
820
-
821
- | Parameter | Type | Required | Description |
822
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
823
- | `request` | [operations.ClearDatasetRequest](../../models/operations/cleardatasetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
824
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
825
- | `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. |
826
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
827
-
828
- ### Response
829
-
830
- **Promise\<void\>**
831
-
832
- ### Errors
833
-
834
- | Error Type | Status Code | Content Type |
835
- | --------------- | --------------- | --------------- |
836
- | errors.APIError | 4XX, 5XX | \*/\* |