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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (443) hide show
  1. package/bin/mcp-server.js +144 -47
  2. package/bin/mcp-server.js.map +75 -75
  3. package/funcs/contactsCreate.js +2 -0
  4. package/funcs/contactsCreate.js.map +1 -1
  5. package/funcs/datasetsClear.js +2 -0
  6. package/funcs/datasetsClear.js.map +1 -1
  7. package/funcs/datasetsCreate.js +2 -0
  8. package/funcs/datasetsCreate.js.map +1 -1
  9. package/funcs/datasetsCreateDatapoint.js +2 -0
  10. package/funcs/datasetsCreateDatapoint.js.map +1 -1
  11. package/funcs/datasetsCreateDatapoints.js +2 -0
  12. package/funcs/datasetsCreateDatapoints.js.map +1 -1
  13. package/funcs/datasetsCreateExperiment.js +2 -0
  14. package/funcs/datasetsCreateExperiment.js.map +1 -1
  15. package/funcs/datasetsDelete.js +2 -0
  16. package/funcs/datasetsDelete.js.map +1 -1
  17. package/funcs/datasetsDeleteDatapoint.js +2 -0
  18. package/funcs/datasetsDeleteDatapoint.js.map +1 -1
  19. package/funcs/datasetsList.js +2 -0
  20. package/funcs/datasetsList.js.map +1 -1
  21. package/funcs/datasetsListDatapoints.js +2 -0
  22. package/funcs/datasetsListDatapoints.js.map +1 -1
  23. package/funcs/datasetsRetrieve.js +2 -0
  24. package/funcs/datasetsRetrieve.js.map +1 -1
  25. package/funcs/datasetsRetrieveDatapoint.js +2 -0
  26. package/funcs/datasetsRetrieveDatapoint.js.map +1 -1
  27. package/funcs/datasetsUpdate.js +2 -0
  28. package/funcs/datasetsUpdate.js.map +1 -1
  29. package/funcs/datasetsUpdateDatapoint.js +2 -0
  30. package/funcs/datasetsUpdateDatapoint.js.map +1 -1
  31. package/funcs/deploymentsCreateExperiment.js +2 -0
  32. package/funcs/deploymentsCreateExperiment.js.map +1 -1
  33. package/funcs/deploymentsGetConfig.js +2 -0
  34. package/funcs/deploymentsGetConfig.js.map +1 -1
  35. package/funcs/deploymentsInvoke.js +2 -0
  36. package/funcs/deploymentsInvoke.js.map +1 -1
  37. package/funcs/deploymentsList.js +2 -0
  38. package/funcs/deploymentsList.js.map +1 -1
  39. package/funcs/deploymentsMetricsCreate.js +2 -0
  40. package/funcs/deploymentsMetricsCreate.js.map +1 -1
  41. package/funcs/deploymentsStream.js +2 -0
  42. package/funcs/deploymentsStream.js.map +1 -1
  43. package/funcs/feedbackCreate.js +2 -0
  44. package/funcs/feedbackCreate.js.map +1 -1
  45. package/funcs/filesCreate.js +2 -0
  46. package/funcs/filesCreate.js.map +1 -1
  47. package/funcs/filesDelete.js +2 -0
  48. package/funcs/filesDelete.js.map +1 -1
  49. package/funcs/filesGet.js +2 -0
  50. package/funcs/filesGet.js.map +1 -1
  51. package/funcs/filesList.js +2 -0
  52. package/funcs/filesList.js.map +1 -1
  53. package/funcs/knowledgeCreate.js +2 -0
  54. package/funcs/knowledgeCreate.js.map +1 -1
  55. package/funcs/knowledgeCreateChunks.js +2 -0
  56. package/funcs/knowledgeCreateChunks.js.map +1 -1
  57. package/funcs/knowledgeCreateDatasource.js +2 -0
  58. package/funcs/knowledgeCreateDatasource.js.map +1 -1
  59. package/funcs/knowledgeDelete.js +2 -0
  60. package/funcs/knowledgeDelete.js.map +1 -1
  61. package/funcs/knowledgeDeleteChunk.js +2 -0
  62. package/funcs/knowledgeDeleteChunk.js.map +1 -1
  63. package/funcs/knowledgeDeleteDatasource.js +2 -0
  64. package/funcs/knowledgeDeleteDatasource.js.map +1 -1
  65. package/funcs/knowledgeList.js +2 -0
  66. package/funcs/knowledgeList.js.map +1 -1
  67. package/funcs/knowledgeListChunks.js +2 -0
  68. package/funcs/knowledgeListChunks.js.map +1 -1
  69. package/funcs/knowledgeListDatasources.js +2 -0
  70. package/funcs/knowledgeListDatasources.js.map +1 -1
  71. package/funcs/knowledgeRetrieve.js +2 -0
  72. package/funcs/knowledgeRetrieve.js.map +1 -1
  73. package/funcs/knowledgeRetrieveChunk.js +2 -0
  74. package/funcs/knowledgeRetrieveChunk.js.map +1 -1
  75. package/funcs/knowledgeRetrieveDatasource.js +2 -0
  76. package/funcs/knowledgeRetrieveDatasource.js.map +1 -1
  77. package/funcs/knowledgeSearch.js +2 -0
  78. package/funcs/knowledgeSearch.js.map +1 -1
  79. package/funcs/knowledgeUpdate.js +2 -0
  80. package/funcs/knowledgeUpdate.js.map +1 -1
  81. package/funcs/knowledgeUpdateChunk.js +2 -0
  82. package/funcs/knowledgeUpdateChunk.js.map +1 -1
  83. package/funcs/knowledgeUpdateDatasource.js +2 -0
  84. package/funcs/knowledgeUpdateDatasource.js.map +1 -1
  85. package/funcs/modelsList.js +2 -0
  86. package/funcs/modelsList.js.map +1 -1
  87. package/funcs/promptsCreate.js +2 -0
  88. package/funcs/promptsCreate.js.map +1 -1
  89. package/funcs/promptsDelete.js +2 -0
  90. package/funcs/promptsDelete.js.map +1 -1
  91. package/funcs/promptsGetVersion.js +2 -0
  92. package/funcs/promptsGetVersion.js.map +1 -1
  93. package/funcs/promptsList.js +2 -0
  94. package/funcs/promptsList.js.map +1 -1
  95. package/funcs/promptsListVersions.js +2 -0
  96. package/funcs/promptsListVersions.js.map +1 -1
  97. package/funcs/promptsRetrieve.js +2 -0
  98. package/funcs/promptsRetrieve.js.map +1 -1
  99. package/funcs/promptsUpdate.js +2 -0
  100. package/funcs/promptsUpdate.js.map +1 -1
  101. package/funcs/remoteconfigsRetrieve.js +2 -0
  102. package/funcs/remoteconfigsRetrieve.js.map +1 -1
  103. package/hooks/types.d.ts +2 -0
  104. package/hooks/types.d.ts.map +1 -1
  105. package/jsr.json +1 -1
  106. package/lib/config.d.ts +7 -3
  107. package/lib/config.d.ts.map +1 -1
  108. package/lib/config.js +3 -3
  109. package/lib/config.js.map +1 -1
  110. package/lib/sdks.d.ts +1 -0
  111. package/lib/sdks.d.ts.map +1 -1
  112. package/lib/sdks.js +3 -3
  113. package/lib/sdks.js.map +1 -1
  114. package/mcp-server/mcp-server.js +1 -1
  115. package/mcp-server/mcp-server.js.map +1 -1
  116. package/mcp-server/server.js +1 -1
  117. package/mcp-server/server.js.map +1 -1
  118. package/models/operations/bulkcreatedatapoints.js +2 -2
  119. package/models/operations/createcontact.js +2 -2
  120. package/models/operations/createdataset.js +2 -2
  121. package/models/operations/createdatasetitem.js +2 -2
  122. package/models/operations/createdatasource.js +2 -2
  123. package/models/operations/fileget.js +2 -2
  124. package/models/operations/filelist.js +2 -2
  125. package/models/operations/fileupload.js +2 -2
  126. package/models/operations/listdatasetdatapoints.js +2 -2
  127. package/models/operations/listdatasets.js +2 -2
  128. package/models/operations/listdatasources.js +2 -2
  129. package/models/operations/retrievedatapoint.js +2 -2
  130. package/models/operations/retrievedataset.js +2 -2
  131. package/models/operations/retrievedatasource.js +2 -2
  132. package/models/operations/updatedatapoint.js +2 -2
  133. package/models/operations/updatedataset.js +2 -2
  134. package/models/operations/updatedatasource.js +2 -2
  135. package/package.json +3 -2
  136. package/src/funcs/contactsCreate.ts +2 -0
  137. package/src/funcs/datasetsClear.ts +2 -0
  138. package/src/funcs/datasetsCreate.ts +2 -0
  139. package/src/funcs/datasetsCreateDatapoint.ts +2 -0
  140. package/src/funcs/datasetsCreateDatapoints.ts +2 -0
  141. package/src/funcs/datasetsCreateExperiment.ts +2 -0
  142. package/src/funcs/datasetsDelete.ts +2 -0
  143. package/src/funcs/datasetsDeleteDatapoint.ts +2 -0
  144. package/src/funcs/datasetsList.ts +2 -0
  145. package/src/funcs/datasetsListDatapoints.ts +2 -0
  146. package/src/funcs/datasetsRetrieve.ts +2 -0
  147. package/src/funcs/datasetsRetrieveDatapoint.ts +2 -0
  148. package/src/funcs/datasetsUpdate.ts +2 -0
  149. package/src/funcs/datasetsUpdateDatapoint.ts +2 -0
  150. package/src/funcs/deploymentsCreateExperiment.ts +2 -0
  151. package/src/funcs/deploymentsGetConfig.ts +2 -0
  152. package/src/funcs/deploymentsInvoke.ts +2 -0
  153. package/src/funcs/deploymentsList.ts +2 -0
  154. package/src/funcs/deploymentsMetricsCreate.ts +2 -0
  155. package/src/funcs/deploymentsStream.ts +2 -0
  156. package/src/funcs/feedbackCreate.ts +2 -0
  157. package/src/funcs/filesCreate.ts +2 -0
  158. package/src/funcs/filesDelete.ts +2 -0
  159. package/src/funcs/filesGet.ts +2 -0
  160. package/src/funcs/filesList.ts +2 -0
  161. package/src/funcs/knowledgeCreate.ts +2 -0
  162. package/src/funcs/knowledgeCreateChunks.ts +2 -0
  163. package/src/funcs/knowledgeCreateDatasource.ts +2 -0
  164. package/src/funcs/knowledgeDelete.ts +2 -0
  165. package/src/funcs/knowledgeDeleteChunk.ts +2 -0
  166. package/src/funcs/knowledgeDeleteDatasource.ts +2 -0
  167. package/src/funcs/knowledgeList.ts +2 -0
  168. package/src/funcs/knowledgeListChunks.ts +2 -0
  169. package/src/funcs/knowledgeListDatasources.ts +2 -0
  170. package/src/funcs/knowledgeRetrieve.ts +2 -0
  171. package/src/funcs/knowledgeRetrieveChunk.ts +2 -0
  172. package/src/funcs/knowledgeRetrieveDatasource.ts +2 -0
  173. package/src/funcs/knowledgeSearch.ts +2 -0
  174. package/src/funcs/knowledgeUpdate.ts +2 -0
  175. package/src/funcs/knowledgeUpdateChunk.ts +2 -0
  176. package/src/funcs/knowledgeUpdateDatasource.ts +2 -0
  177. package/src/funcs/modelsList.ts +2 -0
  178. package/src/funcs/promptsCreate.ts +2 -0
  179. package/src/funcs/promptsDelete.ts +2 -0
  180. package/src/funcs/promptsGetVersion.ts +2 -0
  181. package/src/funcs/promptsList.ts +2 -0
  182. package/src/funcs/promptsListVersions.ts +2 -0
  183. package/src/funcs/promptsRetrieve.ts +2 -0
  184. package/src/funcs/promptsUpdate.ts +2 -0
  185. package/src/funcs/remoteconfigsRetrieve.ts +2 -0
  186. package/src/hooks/types.ts +2 -0
  187. package/src/lib/config.ts +7 -3
  188. package/src/lib/sdks.ts +10 -4
  189. package/src/mcp-server/mcp-server.ts +1 -1
  190. package/src/mcp-server/server.ts +1 -1
  191. package/src/models/operations/bulkcreatedatapoints.ts +2 -2
  192. package/src/models/operations/createcontact.ts +2 -2
  193. package/src/models/operations/createdataset.ts +2 -2
  194. package/src/models/operations/createdatasetitem.ts +2 -2
  195. package/src/models/operations/createdatasource.ts +2 -2
  196. package/src/models/operations/fileget.ts +2 -2
  197. package/src/models/operations/filelist.ts +2 -2
  198. package/src/models/operations/fileupload.ts +2 -2
  199. package/src/models/operations/listdatasetdatapoints.ts +2 -2
  200. package/src/models/operations/listdatasets.ts +2 -2
  201. package/src/models/operations/listdatasources.ts +2 -2
  202. package/src/models/operations/retrievedatapoint.ts +2 -2
  203. package/src/models/operations/retrievedataset.ts +2 -2
  204. package/src/models/operations/retrievedatasource.ts +2 -2
  205. package/src/models/operations/updatedatapoint.ts +2 -2
  206. package/src/models/operations/updatedataset.ts +2 -2
  207. package/src/models/operations/updatedatasource.ts +2 -2
  208. package/packages/orq-rc/FUNCTIONS.md +0 -106
  209. package/packages/orq-rc/README.md +0 -707
  210. package/packages/orq-rc/RUNTIMES.md +0 -48
  211. package/packages/orq-rc/docs/sdks/contacts/README.md +0 -84
  212. package/packages/orq-rc/docs/sdks/datasets/README.md +0 -1027
  213. package/packages/orq-rc/docs/sdks/deployments/README.md +0 -405
  214. package/packages/orq-rc/docs/sdks/feedback/README.md +0 -92
  215. package/packages/orq-rc/docs/sdks/files/README.md +0 -311
  216. package/packages/orq-rc/docs/sdks/knowledge/README.md +0 -1285
  217. package/packages/orq-rc/docs/sdks/metrics/README.md +0 -86
  218. package/packages/orq-rc/docs/sdks/models/README.md +0 -79
  219. package/packages/orq-rc/docs/sdks/orq/README.md +0 -10
  220. package/packages/orq-rc/docs/sdks/prompts/README.md +0 -576
  221. package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +0 -80
  222. package/packages/orq-rc/jsr.json +0 -28
  223. package/packages/orq-rc/package-lock.json +0 -3217
  224. package/packages/orq-rc/package.json +0 -45
  225. package/packages/orq-rc/src/core.ts +0 -13
  226. package/packages/orq-rc/src/funcs/contactsCreate.ts +0 -154
  227. package/packages/orq-rc/src/funcs/datasetsClear.ts +0 -161
  228. package/packages/orq-rc/src/funcs/datasetsCreate.ts +0 -159
  229. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +0 -161
  230. package/packages/orq-rc/src/funcs/datasetsCreateDatapoints.ts +0 -165
  231. package/packages/orq-rc/src/funcs/datasetsCreateExperiment.ts +0 -162
  232. package/packages/orq-rc/src/funcs/datasetsDelete.ts +0 -161
  233. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +0 -176
  234. package/packages/orq-rc/src/funcs/datasetsList.ts +0 -161
  235. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +0 -168
  236. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +0 -169
  237. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +0 -175
  238. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +0 -170
  239. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +0 -173
  240. package/packages/orq-rc/src/funcs/deploymentsCreateExperiment.ts +0 -167
  241. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +0 -162
  242. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +0 -170
  243. package/packages/orq-rc/src/funcs/deploymentsList.ts +0 -170
  244. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +0 -162
  245. package/packages/orq-rc/src/funcs/deploymentsStream.ts +0 -178
  246. package/packages/orq-rc/src/funcs/feedbackCreate.ts +0 -154
  247. package/packages/orq-rc/src/funcs/filesCreate.ts +0 -174
  248. package/packages/orq-rc/src/funcs/filesDelete.ts +0 -158
  249. package/packages/orq-rc/src/funcs/filesGet.ts +0 -160
  250. package/packages/orq-rc/src/funcs/filesList.ts +0 -161
  251. package/packages/orq-rc/src/funcs/knowledgeCreate.ts +0 -152
  252. package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +0 -165
  253. package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +0 -160
  254. package/packages/orq-rc/src/funcs/knowledgeDelete.ts +0 -161
  255. package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +0 -168
  256. package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +0 -167
  257. package/packages/orq-rc/src/funcs/knowledgeList.ts +0 -163
  258. package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +0 -172
  259. package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +0 -168
  260. package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +0 -160
  261. package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +0 -167
  262. package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +0 -163
  263. package/packages/orq-rc/src/funcs/knowledgeSearch.ts +0 -161
  264. package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +0 -158
  265. package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +0 -168
  266. package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +0 -164
  267. package/packages/orq-rc/src/funcs/modelsList.ts +0 -136
  268. package/packages/orq-rc/src/funcs/promptsCreate.ts +0 -154
  269. package/packages/orq-rc/src/funcs/promptsDelete.ts +0 -158
  270. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +0 -175
  271. package/packages/orq-rc/src/funcs/promptsList.ts +0 -161
  272. package/packages/orq-rc/src/funcs/promptsListVersions.ts +0 -167
  273. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +0 -160
  274. package/packages/orq-rc/src/funcs/promptsUpdate.ts +0 -167
  275. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +0 -155
  276. package/packages/orq-rc/src/hooks/global.ts +0 -44
  277. package/packages/orq-rc/src/hooks/hooks.ts +0 -132
  278. package/packages/orq-rc/src/hooks/index.ts +0 -6
  279. package/packages/orq-rc/src/hooks/registration.ts +0 -15
  280. package/packages/orq-rc/src/hooks/types.ts +0 -110
  281. package/packages/orq-rc/src/index.ts +0 -7
  282. package/packages/orq-rc/src/lib/base64.ts +0 -37
  283. package/packages/orq-rc/src/lib/config.ts +0 -70
  284. package/packages/orq-rc/src/lib/dlv.ts +0 -53
  285. package/packages/orq-rc/src/lib/encodings.ts +0 -483
  286. package/packages/orq-rc/src/lib/env.ts +0 -73
  287. package/packages/orq-rc/src/lib/event-streams.ts +0 -264
  288. package/packages/orq-rc/src/lib/files.ts +0 -40
  289. package/packages/orq-rc/src/lib/http.ts +0 -323
  290. package/packages/orq-rc/src/lib/is-plain-object.ts +0 -43
  291. package/packages/orq-rc/src/lib/logger.ts +0 -9
  292. package/packages/orq-rc/src/lib/matchers.ts +0 -345
  293. package/packages/orq-rc/src/lib/primitives.ts +0 -150
  294. package/packages/orq-rc/src/lib/retries.ts +0 -218
  295. package/packages/orq-rc/src/lib/schemas.ts +0 -91
  296. package/packages/orq-rc/src/lib/sdks.ts +0 -401
  297. package/packages/orq-rc/src/lib/security.ts +0 -261
  298. package/packages/orq-rc/src/lib/url.ts +0 -33
  299. package/packages/orq-rc/src/mcp-server/cli/start/command.ts +0 -125
  300. package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +0 -140
  301. package/packages/orq-rc/src/mcp-server/cli.ts +0 -13
  302. package/packages/orq-rc/src/mcp-server/console-logger.ts +0 -71
  303. package/packages/orq-rc/src/mcp-server/extensions.ts +0 -17
  304. package/packages/orq-rc/src/mcp-server/mcp-server.ts +0 -26
  305. package/packages/orq-rc/src/mcp-server/prompts.ts +0 -117
  306. package/packages/orq-rc/src/mcp-server/resources.ts +0 -172
  307. package/packages/orq-rc/src/mcp-server/scopes.ts +0 -7
  308. package/packages/orq-rc/src/mcp-server/server.ts +0 -163
  309. package/packages/orq-rc/src/mcp-server/shared.ts +0 -75
  310. package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +0 -37
  311. package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +0 -35
  312. package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +0 -37
  313. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +0 -37
  314. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoints.ts +0 -37
  315. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateExperiment.ts +0 -37
  316. package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +0 -35
  317. package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +0 -35
  318. package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +0 -37
  319. package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +0 -37
  320. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +0 -37
  321. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +0 -37
  322. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +0 -37
  323. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +0 -35
  324. package/packages/orq-rc/src/mcp-server/tools/deploymentsCreateExperiment.ts +0 -37
  325. package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +0 -37
  326. package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +0 -37
  327. package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +0 -37
  328. package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +0 -37
  329. package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +0 -37
  330. package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +0 -37
  331. package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +0 -37
  332. package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +0 -33
  333. package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +0 -37
  334. package/packages/orq-rc/src/mcp-server/tools/filesList.ts +0 -37
  335. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +0 -35
  336. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +0 -35
  337. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +0 -35
  338. package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +0 -35
  339. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +0 -33
  340. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +0 -35
  341. package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +0 -37
  342. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +0 -35
  343. package/packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts +0 -35
  344. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +0 -37
  345. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +0 -35
  346. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +0 -35
  347. package/packages/orq-rc/src/mcp-server/tools/knowledgeSearch.ts +0 -37
  348. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +0 -35
  349. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +0 -35
  350. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +0 -35
  351. package/packages/orq-rc/src/mcp-server/tools/modelsList.ts +0 -30
  352. package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +0 -35
  353. package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +0 -33
  354. package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +0 -37
  355. package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +0 -37
  356. package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +0 -37
  357. package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +0 -37
  358. package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +0 -35
  359. package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +0 -36
  360. package/packages/orq-rc/src/mcp-server/tools.ts +0 -129
  361. package/packages/orq-rc/src/models/components/deployments.ts +0 -7289
  362. package/packages/orq-rc/src/models/components/index.ts +0 -6
  363. package/packages/orq-rc/src/models/components/security.ts +0 -71
  364. package/packages/orq-rc/src/models/errors/apierror.ts +0 -27
  365. package/packages/orq-rc/src/models/errors/getpromptversion.ts +0 -71
  366. package/packages/orq-rc/src/models/errors/honoapierror.ts +0 -82
  367. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +0 -62
  368. package/packages/orq-rc/src/models/errors/index.ts +0 -10
  369. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +0 -97
  370. package/packages/orq-rc/src/models/errors/updateprompt.ts +0 -71
  371. package/packages/orq-rc/src/models/operations/bulkcreatedatapoints.ts +0 -2232
  372. package/packages/orq-rc/src/models/operations/cleardataset.ts +0 -75
  373. package/packages/orq-rc/src/models/operations/createchunk.ts +0 -432
  374. package/packages/orq-rc/src/models/operations/createcontact.ts +0 -256
  375. package/packages/orq-rc/src/models/operations/createdataset.ts +0 -296
  376. package/packages/orq-rc/src/models/operations/createdatasetexperiment.ts +0 -307
  377. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +0 -2149
  378. package/packages/orq-rc/src/models/operations/createdatasource.ts +0 -852
  379. package/packages/orq-rc/src/models/operations/createdeploymentexperiment.ts +0 -321
  380. package/packages/orq-rc/src/models/operations/createfeedback.ts +0 -286
  381. package/packages/orq-rc/src/models/operations/createknowledge.ts +0 -846
  382. package/packages/orq-rc/src/models/operations/createprompt.ts +0 -4079
  383. package/packages/orq-rc/src/models/operations/deletechunk.ts +0 -96
  384. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +0 -81
  385. package/packages/orq-rc/src/models/operations/deletedataset.ts +0 -75
  386. package/packages/orq-rc/src/models/operations/deletedatasource.ts +0 -87
  387. package/packages/orq-rc/src/models/operations/deleteknowledge.ts +0 -78
  388. package/packages/orq-rc/src/models/operations/deleteprompt.ts +0 -69
  389. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +0 -5435
  390. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +0 -9378
  391. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +0 -1255
  392. package/packages/orq-rc/src/models/operations/deployments.ts +0 -2316
  393. package/packages/orq-rc/src/models/operations/deploymentstream.ts +0 -9499
  394. package/packages/orq-rc/src/models/operations/filedelete.ts +0 -78
  395. package/packages/orq-rc/src/models/operations/fileget.ts +0 -223
  396. package/packages/orq-rc/src/models/operations/filelist.ts +0 -337
  397. package/packages/orq-rc/src/models/operations/fileupload.ts +0 -327
  398. package/packages/orq-rc/src/models/operations/getallprompts.ts +0 -2294
  399. package/packages/orq-rc/src/models/operations/getonechunk.ts +0 -315
  400. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +0 -537
  401. package/packages/orq-rc/src/models/operations/getoneprompt.ts +0 -2155
  402. package/packages/orq-rc/src/models/operations/getpromptversion.ts +0 -2160
  403. package/packages/orq-rc/src/models/operations/index.ts +0 -54
  404. package/packages/orq-rc/src/models/operations/listchunks.ts +0 -494
  405. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +0 -1276
  406. package/packages/orq-rc/src/models/operations/listdatasets.ts +0 -406
  407. package/packages/orq-rc/src/models/operations/listdatasources.ts +0 -447
  408. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +0 -663
  409. package/packages/orq-rc/src/models/operations/listmodels.ts +0 -273
  410. package/packages/orq-rc/src/models/operations/listpromptversions.ts +0 -2292
  411. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +0 -190
  412. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +0 -1126
  413. package/packages/orq-rc/src/models/operations/retrievedataset.ts +0 -288
  414. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +0 -273
  415. package/packages/orq-rc/src/models/operations/searchknowledge.ts +0 -3367
  416. package/packages/orq-rc/src/models/operations/updatechunk.ts +0 -448
  417. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +0 -2139
  418. package/packages/orq-rc/src/models/operations/updatedataset.ts +0 -393
  419. package/packages/orq-rc/src/models/operations/updatedatasource.ts +0 -345
  420. package/packages/orq-rc/src/models/operations/updateknowledge.ts +0 -980
  421. package/packages/orq-rc/src/models/operations/updateprompt.ts +0 -4261
  422. package/packages/orq-rc/src/sdk/contacts.ts +0 -27
  423. package/packages/orq-rc/src/sdk/datasets.ts +0 -240
  424. package/packages/orq-rc/src/sdk/deployments.ts +0 -107
  425. package/packages/orq-rc/src/sdk/feedback.ts +0 -27
  426. package/packages/orq-rc/src/sdk/files.ts +0 -78
  427. package/packages/orq-rc/src/sdk/index.ts +0 -5
  428. package/packages/orq-rc/src/sdk/knowledge.ts +0 -264
  429. package/packages/orq-rc/src/sdk/metrics.ts +0 -27
  430. package/packages/orq-rc/src/sdk/models.ts +0 -25
  431. package/packages/orq-rc/src/sdk/prompts.ts +0 -126
  432. package/packages/orq-rc/src/sdk/remoteconfigs.ts +0 -24
  433. package/packages/orq-rc/src/sdk/sdk.ts +0 -61
  434. package/packages/orq-rc/src/types/async.ts +0 -68
  435. package/packages/orq-rc/src/types/blobs.ts +0 -31
  436. package/packages/orq-rc/src/types/constdatetime.ts +0 -15
  437. package/packages/orq-rc/src/types/enums.ts +0 -16
  438. package/packages/orq-rc/src/types/fp.ts +0 -50
  439. package/packages/orq-rc/src/types/index.ts +0 -11
  440. package/packages/orq-rc/src/types/operations.ts +0 -105
  441. package/packages/orq-rc/src/types/rfcdate.ts +0 -54
  442. package/packages/orq-rc/src/types/streams.ts +0 -21
  443. package/packages/orq-rc/tsconfig.json +0 -41
@@ -1,1027 +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
- * [createExperiment](#createexperiment) - Create an experiment from a dataset
14
- * [listDatapoints](#listdatapoints) - List datapoints
15
- * [createDatapoint](#createdatapoint) - Create a datapoint
16
- * [retrieveDatapoint](#retrievedatapoint) - Retrieve a datapoint
17
- * [updateDatapoint](#updatedatapoint) - Update a datapoint
18
- * [deleteDatapoint](#deletedatapoint) - Delete a datapoint
19
- * [createDatapoints](#createdatapoints) - Create multiple datapoints
20
- * [clear](#clear) - Delete all datapoints
21
-
22
- ## list
23
-
24
- Retrieves a paginated list of datasets for the current workspace. Results can be paginated using cursor-based pagination.
25
-
26
- ### Example Usage
27
-
28
- ```typescript
29
- import { Orq } from "@orq-ai/node";
30
-
31
- const orq = new Orq({
32
- apiKey: process.env["ORQ_API_KEY"] ?? "",
33
- });
34
-
35
- async function run() {
36
- const result = await orq.datasets.list({});
37
-
38
- // Handle the result
39
- console.log(result);
40
- }
41
-
42
- run();
43
- ```
44
-
45
- ### Standalone function
46
-
47
- The standalone function version of this method:
48
-
49
- ```typescript
50
- import { OrqCore } from "@orq-ai/node/core.js";
51
- import { datasetsList } from "@orq-ai/node/funcs/datasetsList.js";
52
-
53
- // Use `OrqCore` for best tree-shaking performance.
54
- // You can create one instance of it to use across an application.
55
- const orq = new OrqCore({
56
- apiKey: process.env["ORQ_API_KEY"] ?? "",
57
- });
58
-
59
- async function run() {
60
- const res = await datasetsList(orq, {});
61
-
62
- if (!res.ok) {
63
- throw res.error;
64
- }
65
-
66
- const { value: result } = res;
67
-
68
- // Handle the result
69
- console.log(result);
70
- }
71
-
72
- run();
73
- ```
74
-
75
- ### Parameters
76
-
77
- | Parameter | Type | Required | Description |
78
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
79
- | `request` | [operations.ListDatasetsRequest](../../models/operations/listdatasetsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
80
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
81
- | `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. |
82
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
83
-
84
- ### Response
85
-
86
- **Promise\<[operations.ListDatasetsResponseBody](../../models/operations/listdatasetsresponsebody.md)\>**
87
-
88
- ### Errors
89
-
90
- | Error Type | Status Code | Content Type |
91
- | --------------- | --------------- | --------------- |
92
- | errors.APIError | 4XX, 5XX | \*/\* |
93
-
94
- ## create
95
-
96
- Creates a new dataset in the specified project.
97
-
98
- ### Example Usage
99
-
100
- ```typescript
101
- import { Orq } from "@orq-ai/node";
102
-
103
- const orq = new Orq({
104
- apiKey: process.env["ORQ_API_KEY"] ?? "",
105
- });
106
-
107
- async function run() {
108
- const result = await orq.datasets.create({
109
- displayName: "Neva.Raynor10",
110
- path: "Default",
111
- });
112
-
113
- // Handle the result
114
- console.log(result);
115
- }
116
-
117
- run();
118
- ```
119
-
120
- ### Standalone function
121
-
122
- The standalone function version of this method:
123
-
124
- ```typescript
125
- import { OrqCore } from "@orq-ai/node/core.js";
126
- import { datasetsCreate } from "@orq-ai/node/funcs/datasetsCreate.js";
127
-
128
- // Use `OrqCore` for best tree-shaking performance.
129
- // You can create one instance of it to use across an application.
130
- const orq = new OrqCore({
131
- apiKey: process.env["ORQ_API_KEY"] ?? "",
132
- });
133
-
134
- async function run() {
135
- const res = await datasetsCreate(orq, {
136
- displayName: "Neva.Raynor10",
137
- path: "Default",
138
- });
139
-
140
- if (!res.ok) {
141
- throw res.error;
142
- }
143
-
144
- const { value: result } = res;
145
-
146
- // Handle the result
147
- console.log(result);
148
- }
149
-
150
- run();
151
- ```
152
-
153
- ### Parameters
154
-
155
- | Parameter | Type | Required | Description |
156
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
157
- | `request` | [operations.CreateDatasetRequestBody](../../models/operations/createdatasetrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
158
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
159
- | `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. |
160
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
161
-
162
- ### Response
163
-
164
- **Promise\<[operations.CreateDatasetResponseBody](../../models/operations/createdatasetresponsebody.md)\>**
165
-
166
- ### Errors
167
-
168
- | Error Type | Status Code | Content Type |
169
- | --------------- | --------------- | --------------- |
170
- | errors.APIError | 4XX, 5XX | \*/\* |
171
-
172
- ## retrieve
173
-
174
- Retrieves a specific dataset by its unique identifier
175
-
176
- ### Example Usage
177
-
178
- ```typescript
179
- import { Orq } from "@orq-ai/node";
180
-
181
- const orq = new Orq({
182
- apiKey: process.env["ORQ_API_KEY"] ?? "",
183
- });
184
-
185
- async function run() {
186
- const result = await orq.datasets.retrieve({
187
- datasetId: "<id>",
188
- });
189
-
190
- // Handle the result
191
- console.log(result);
192
- }
193
-
194
- run();
195
- ```
196
-
197
- ### Standalone function
198
-
199
- The standalone function version of this method:
200
-
201
- ```typescript
202
- import { OrqCore } from "@orq-ai/node/core.js";
203
- import { datasetsRetrieve } from "@orq-ai/node/funcs/datasetsRetrieve.js";
204
-
205
- // Use `OrqCore` for best tree-shaking performance.
206
- // You can create one instance of it to use across an application.
207
- const orq = new OrqCore({
208
- apiKey: process.env["ORQ_API_KEY"] ?? "",
209
- });
210
-
211
- async function run() {
212
- const res = await datasetsRetrieve(orq, {
213
- datasetId: "<id>",
214
- });
215
-
216
- if (!res.ok) {
217
- throw res.error;
218
- }
219
-
220
- const { value: result } = res;
221
-
222
- // Handle the result
223
- console.log(result);
224
- }
225
-
226
- run();
227
- ```
228
-
229
- ### Parameters
230
-
231
- | Parameter | Type | Required | Description |
232
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
233
- | `request` | [operations.RetrieveDatasetRequest](../../models/operations/retrievedatasetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
234
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
235
- | `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. |
236
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
237
-
238
- ### Response
239
-
240
- **Promise\<[operations.RetrieveDatasetResponseBody](../../models/operations/retrievedatasetresponsebody.md)\>**
241
-
242
- ### Errors
243
-
244
- | Error Type | Status Code | Content Type |
245
- | ------------------- | ------------------- | ------------------- |
246
- | errors.HonoApiError | 404 | application/json |
247
- | errors.APIError | 4XX, 5XX | \*/\* |
248
-
249
- ## update
250
-
251
- Update a dataset
252
-
253
- ### Example Usage
254
-
255
- ```typescript
256
- import { Orq } from "@orq-ai/node";
257
-
258
- const orq = new Orq({
259
- apiKey: process.env["ORQ_API_KEY"] ?? "",
260
- });
261
-
262
- async function run() {
263
- const result = await orq.datasets.update({
264
- datasetId: "<id>",
265
- requestBody: {
266
- path: "Default",
267
- },
268
- });
269
-
270
- // Handle the result
271
- console.log(result);
272
- }
273
-
274
- run();
275
- ```
276
-
277
- ### Standalone function
278
-
279
- The standalone function version of this method:
280
-
281
- ```typescript
282
- import { OrqCore } from "@orq-ai/node/core.js";
283
- import { datasetsUpdate } from "@orq-ai/node/funcs/datasetsUpdate.js";
284
-
285
- // Use `OrqCore` for best tree-shaking performance.
286
- // You can create one instance of it to use across an application.
287
- const orq = new OrqCore({
288
- apiKey: process.env["ORQ_API_KEY"] ?? "",
289
- });
290
-
291
- async function run() {
292
- const res = await datasetsUpdate(orq, {
293
- datasetId: "<id>",
294
- requestBody: {
295
- path: "Default",
296
- },
297
- });
298
-
299
- if (!res.ok) {
300
- throw res.error;
301
- }
302
-
303
- const { value: result } = res;
304
-
305
- // Handle the result
306
- console.log(result);
307
- }
308
-
309
- run();
310
- ```
311
-
312
- ### Parameters
313
-
314
- | Parameter | Type | Required | Description |
315
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
316
- | `request` | [operations.UpdateDatasetRequest](../../models/operations/updatedatasetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
317
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
318
- | `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. |
319
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
320
-
321
- ### Response
322
-
323
- **Promise\<[operations.UpdateDatasetResponseBody](../../models/operations/updatedatasetresponsebody.md)\>**
324
-
325
- ### Errors
326
-
327
- | Error Type | Status Code | Content Type |
328
- | ------------------- | ------------------- | ------------------- |
329
- | errors.HonoApiError | 404 | application/json |
330
- | errors.APIError | 4XX, 5XX | \*/\* |
331
-
332
- ## delete
333
-
334
- Permanently deletes a dataset and all its datapoints. This action is irreversible.
335
-
336
- ### Example Usage
337
-
338
- ```typescript
339
- import { Orq } from "@orq-ai/node";
340
-
341
- const orq = new Orq({
342
- apiKey: process.env["ORQ_API_KEY"] ?? "",
343
- });
344
-
345
- async function run() {
346
- await orq.datasets.delete({
347
- datasetId: "<id>",
348
- });
349
-
350
-
351
- }
352
-
353
- run();
354
- ```
355
-
356
- ### Standalone function
357
-
358
- The standalone function version of this method:
359
-
360
- ```typescript
361
- import { OrqCore } from "@orq-ai/node/core.js";
362
- import { datasetsDelete } from "@orq-ai/node/funcs/datasetsDelete.js";
363
-
364
- // Use `OrqCore` for best tree-shaking performance.
365
- // You can create one instance of it to use across an application.
366
- const orq = new OrqCore({
367
- apiKey: process.env["ORQ_API_KEY"] ?? "",
368
- });
369
-
370
- async function run() {
371
- const res = await datasetsDelete(orq, {
372
- datasetId: "<id>",
373
- });
374
-
375
- if (!res.ok) {
376
- throw res.error;
377
- }
378
-
379
- const { value: result } = res;
380
-
381
-
382
- }
383
-
384
- run();
385
- ```
386
-
387
- ### Parameters
388
-
389
- | Parameter | Type | Required | Description |
390
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
391
- | `request` | [operations.DeleteDatasetRequest](../../models/operations/deletedatasetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
392
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
393
- | `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. |
394
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
395
-
396
- ### Response
397
-
398
- **Promise\<void\>**
399
-
400
- ### Errors
401
-
402
- | Error Type | Status Code | Content Type |
403
- | --------------- | --------------- | --------------- |
404
- | errors.APIError | 4XX, 5XX | \*/\* |
405
-
406
- ## createExperiment
407
-
408
- Create an experiment from a dataset
409
-
410
- ### Example Usage
411
-
412
- ```typescript
413
- import { Orq } from "@orq-ai/node";
414
-
415
- const orq = new Orq({
416
- apiKey: process.env["ORQ_API_KEY"] ?? "",
417
- });
418
-
419
- async function run() {
420
- const result = await orq.datasets.createExperiment({
421
- datasetId: "<id>",
422
- requestBody: {
423
- experimentKey: "<value>",
424
- path: "Default/Experiments",
425
- type: "dataset_experiment",
426
- },
427
- });
428
-
429
- // Handle the result
430
- console.log(result);
431
- }
432
-
433
- run();
434
- ```
435
-
436
- ### Standalone function
437
-
438
- The standalone function version of this method:
439
-
440
- ```typescript
441
- import { OrqCore } from "@orq-ai/node/core.js";
442
- import { datasetsCreateExperiment } from "@orq-ai/node/funcs/datasetsCreateExperiment.js";
443
-
444
- // Use `OrqCore` for best tree-shaking performance.
445
- // You can create one instance of it to use across an application.
446
- const orq = new OrqCore({
447
- apiKey: process.env["ORQ_API_KEY"] ?? "",
448
- });
449
-
450
- async function run() {
451
- const res = await datasetsCreateExperiment(orq, {
452
- datasetId: "<id>",
453
- requestBody: {
454
- experimentKey: "<value>",
455
- path: "Default/Experiments",
456
- type: "dataset_experiment",
457
- },
458
- });
459
-
460
- if (!res.ok) {
461
- throw res.error;
462
- }
463
-
464
- const { value: result } = res;
465
-
466
- // Handle the result
467
- console.log(result);
468
- }
469
-
470
- run();
471
- ```
472
-
473
- ### Parameters
474
-
475
- | Parameter | Type | Required | Description |
476
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
477
- | `request` | [operations.CreateDatasetExperimentRequest](../../models/operations/createdatasetexperimentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
478
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
479
- | `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. |
480
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
481
-
482
- ### Response
483
-
484
- **Promise\<[operations.CreateDatasetExperimentResponseBody](../../models/operations/createdatasetexperimentresponsebody.md)\>**
485
-
486
- ### Errors
487
-
488
- | Error Type | Status Code | Content Type |
489
- | --------------- | --------------- | --------------- |
490
- | errors.APIError | 4XX, 5XX | \*/\* |
491
-
492
- ## listDatapoints
493
-
494
- Retrieves a paginated list of datapoints from a specific dataset.
495
-
496
- ### Example Usage
497
-
498
- ```typescript
499
- import { Orq } from "@orq-ai/node";
500
-
501
- const orq = new Orq({
502
- apiKey: process.env["ORQ_API_KEY"] ?? "",
503
- });
504
-
505
- async function run() {
506
- const result = await orq.datasets.listDatapoints({
507
- datasetId: "<id>",
508
- });
509
-
510
- // Handle the result
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 { datasetsListDatapoints } from "@orq-ai/node/funcs/datasetsListDatapoints.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 datasetsListDatapoints(orq, {
533
- datasetId: "<id>",
534
- });
535
-
536
- if (!res.ok) {
537
- throw res.error;
538
- }
539
-
540
- const { value: result } = res;
541
-
542
- // Handle the result
543
- console.log(result);
544
- }
545
-
546
- run();
547
- ```
548
-
549
- ### Parameters
550
-
551
- | Parameter | Type | Required | Description |
552
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
553
- | `request` | [operations.ListDatasetDatapointsRequest](../../models/operations/listdatasetdatapointsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
554
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
555
- | `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. |
556
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
557
-
558
- ### Response
559
-
560
- **Promise\<[operations.ListDatasetDatapointsResponseBody](../../models/operations/listdatasetdatapointsresponsebody.md)\>**
561
-
562
- ### Errors
563
-
564
- | Error Type | Status Code | Content Type |
565
- | --------------- | --------------- | --------------- |
566
- | errors.APIError | 4XX, 5XX | \*/\* |
567
-
568
- ## createDatapoint
569
-
570
- Creates a new datapoint in the specified dataset.
571
-
572
- ### Example Usage
573
-
574
- ```typescript
575
- import { Orq } from "@orq-ai/node";
576
-
577
- const orq = new Orq({
578
- apiKey: process.env["ORQ_API_KEY"] ?? "",
579
- });
580
-
581
- async function run() {
582
- const result = await orq.datasets.createDatapoint({
583
- datasetId: "<id>",
584
- });
585
-
586
- // Handle the result
587
- console.log(result);
588
- }
589
-
590
- run();
591
- ```
592
-
593
- ### Standalone function
594
-
595
- The standalone function version of this method:
596
-
597
- ```typescript
598
- import { OrqCore } from "@orq-ai/node/core.js";
599
- import { datasetsCreateDatapoint } from "@orq-ai/node/funcs/datasetsCreateDatapoint.js";
600
-
601
- // Use `OrqCore` for best tree-shaking performance.
602
- // You can create one instance of it to use across an application.
603
- const orq = new OrqCore({
604
- apiKey: process.env["ORQ_API_KEY"] ?? "",
605
- });
606
-
607
- async function run() {
608
- const res = await datasetsCreateDatapoint(orq, {
609
- datasetId: "<id>",
610
- });
611
-
612
- if (!res.ok) {
613
- throw res.error;
614
- }
615
-
616
- const { value: result } = res;
617
-
618
- // Handle the result
619
- console.log(result);
620
- }
621
-
622
- run();
623
- ```
624
-
625
- ### Parameters
626
-
627
- | Parameter | Type | Required | Description |
628
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
629
- | `request` | [operations.CreateDatasetItemRequest](../../models/operations/createdatasetitemrequest.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.CreateDatasetItemResponseBody](../../models/operations/createdatasetitemresponsebody.md)\>**
637
-
638
- ### Errors
639
-
640
- | Error Type | Status Code | Content Type |
641
- | --------------- | --------------- | --------------- |
642
- | errors.APIError | 4XX, 5XX | \*/\* |
643
-
644
- ## retrieveDatapoint
645
-
646
- Retrieves a datapoint object
647
-
648
- ### Example Usage
649
-
650
- ```typescript
651
- import { Orq } from "@orq-ai/node";
652
-
653
- const orq = new Orq({
654
- apiKey: process.env["ORQ_API_KEY"] ?? "",
655
- });
656
-
657
- async function run() {
658
- const result = await orq.datasets.retrieveDatapoint({
659
- datasetId: "<id>",
660
- datapointId: "<id>",
661
- });
662
-
663
- // Handle the result
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 { datasetsRetrieveDatapoint } from "@orq-ai/node/funcs/datasetsRetrieveDatapoint.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 datasetsRetrieveDatapoint(orq, {
686
- datasetId: "<id>",
687
- datapointId: "<id>",
688
- });
689
-
690
- if (!res.ok) {
691
- throw res.error;
692
- }
693
-
694
- const { value: result } = res;
695
-
696
- // Handle the result
697
- console.log(result);
698
- }
699
-
700
- run();
701
- ```
702
-
703
- ### Parameters
704
-
705
- | Parameter | Type | Required | Description |
706
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
707
- | `request` | [operations.RetrieveDatapointRequest](../../models/operations/retrievedatapointrequest.md) | :heavy_check_mark: | The request object to use for the request. |
708
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
709
- | `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. |
710
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
711
-
712
- ### Response
713
-
714
- **Promise\<[operations.RetrieveDatapointResponseBody](../../models/operations/retrievedatapointresponsebody.md)\>**
715
-
716
- ### Errors
717
-
718
- | Error Type | Status Code | Content Type |
719
- | ------------------- | ------------------- | ------------------- |
720
- | errors.HonoApiError | 404 | application/json |
721
- | errors.APIError | 4XX, 5XX | \*/\* |
722
-
723
- ## updateDatapoint
724
-
725
- Update a datapoint
726
-
727
- ### Example Usage
728
-
729
- ```typescript
730
- import { Orq } from "@orq-ai/node";
731
-
732
- const orq = new Orq({
733
- apiKey: process.env["ORQ_API_KEY"] ?? "",
734
- });
735
-
736
- async function run() {
737
- const result = await orq.datasets.updateDatapoint({
738
- datasetId: "<id>",
739
- datapointId: "<id>",
740
- });
741
-
742
- // Handle the result
743
- console.log(result);
744
- }
745
-
746
- run();
747
- ```
748
-
749
- ### Standalone function
750
-
751
- The standalone function version of this method:
752
-
753
- ```typescript
754
- import { OrqCore } from "@orq-ai/node/core.js";
755
- import { datasetsUpdateDatapoint } from "@orq-ai/node/funcs/datasetsUpdateDatapoint.js";
756
-
757
- // Use `OrqCore` for best tree-shaking performance.
758
- // You can create one instance of it to use across an application.
759
- const orq = new OrqCore({
760
- apiKey: process.env["ORQ_API_KEY"] ?? "",
761
- });
762
-
763
- async function run() {
764
- const res = await datasetsUpdateDatapoint(orq, {
765
- datasetId: "<id>",
766
- datapointId: "<id>",
767
- });
768
-
769
- if (!res.ok) {
770
- throw res.error;
771
- }
772
-
773
- const { value: result } = res;
774
-
775
- // Handle the result
776
- console.log(result);
777
- }
778
-
779
- run();
780
- ```
781
-
782
- ### Parameters
783
-
784
- | Parameter | Type | Required | Description |
785
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
786
- | `request` | [operations.UpdateDatapointRequest](../../models/operations/updatedatapointrequest.md) | :heavy_check_mark: | The request object to use for the request. |
787
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
788
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
789
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
790
-
791
- ### Response
792
-
793
- **Promise\<[operations.UpdateDatapointResponseBody](../../models/operations/updatedatapointresponsebody.md)\>**
794
-
795
- ### Errors
796
-
797
- | Error Type | Status Code | Content Type |
798
- | ------------------- | ------------------- | ------------------- |
799
- | errors.HonoApiError | 404 | application/json |
800
- | errors.APIError | 4XX, 5XX | \*/\* |
801
-
802
- ## deleteDatapoint
803
-
804
- Permanently deletes a specific datapoint from a dataset.
805
-
806
- ### Example Usage
807
-
808
- ```typescript
809
- import { Orq } from "@orq-ai/node";
810
-
811
- const orq = new Orq({
812
- apiKey: process.env["ORQ_API_KEY"] ?? "",
813
- });
814
-
815
- async function run() {
816
- await orq.datasets.deleteDatapoint({
817
- datasetId: "<id>",
818
- datapointId: "<id>",
819
- });
820
-
821
-
822
- }
823
-
824
- run();
825
- ```
826
-
827
- ### Standalone function
828
-
829
- The standalone function version of this method:
830
-
831
- ```typescript
832
- import { OrqCore } from "@orq-ai/node/core.js";
833
- import { datasetsDeleteDatapoint } from "@orq-ai/node/funcs/datasetsDeleteDatapoint.js";
834
-
835
- // Use `OrqCore` for best tree-shaking performance.
836
- // You can create one instance of it to use across an application.
837
- const orq = new OrqCore({
838
- apiKey: process.env["ORQ_API_KEY"] ?? "",
839
- });
840
-
841
- async function run() {
842
- const res = await datasetsDeleteDatapoint(orq, {
843
- datasetId: "<id>",
844
- datapointId: "<id>",
845
- });
846
-
847
- if (!res.ok) {
848
- throw res.error;
849
- }
850
-
851
- const { value: result } = res;
852
-
853
-
854
- }
855
-
856
- run();
857
- ```
858
-
859
- ### Parameters
860
-
861
- | Parameter | Type | Required | Description |
862
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
863
- | `request` | [operations.DeleteDatapointRequest](../../models/operations/deletedatapointrequest.md) | :heavy_check_mark: | The request object to use for the request. |
864
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
865
- | `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. |
866
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
867
-
868
- ### Response
869
-
870
- **Promise\<void\>**
871
-
872
- ### Errors
873
-
874
- | Error Type | Status Code | Content Type |
875
- | ------------------- | ------------------- | ------------------- |
876
- | errors.HonoApiError | 404 | application/json |
877
- | errors.APIError | 4XX, 5XX | \*/\* |
878
-
879
- ## createDatapoints
880
-
881
- Create multiple datapoints at once.
882
-
883
- ### Example Usage
884
-
885
- ```typescript
886
- import { Orq } from "@orq-ai/node";
887
-
888
- const orq = new Orq({
889
- apiKey: process.env["ORQ_API_KEY"] ?? "",
890
- });
891
-
892
- async function run() {
893
- const result = await orq.datasets.createDatapoints({
894
- datasetId: "<id>",
895
- });
896
-
897
- // Handle the result
898
- console.log(result);
899
- }
900
-
901
- run();
902
- ```
903
-
904
- ### Standalone function
905
-
906
- The standalone function version of this method:
907
-
908
- ```typescript
909
- import { OrqCore } from "@orq-ai/node/core.js";
910
- import { datasetsCreateDatapoints } from "@orq-ai/node/funcs/datasetsCreateDatapoints.js";
911
-
912
- // Use `OrqCore` for best tree-shaking performance.
913
- // You can create one instance of it to use across an application.
914
- const orq = new OrqCore({
915
- apiKey: process.env["ORQ_API_KEY"] ?? "",
916
- });
917
-
918
- async function run() {
919
- const res = await datasetsCreateDatapoints(orq, {
920
- datasetId: "<id>",
921
- });
922
-
923
- if (!res.ok) {
924
- throw res.error;
925
- }
926
-
927
- const { value: result } = res;
928
-
929
- // Handle the result
930
- console.log(result);
931
- }
932
-
933
- run();
934
- ```
935
-
936
- ### Parameters
937
-
938
- | Parameter | Type | Required | Description |
939
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
940
- | `request` | [operations.BulkCreateDatapointsRequest](../../models/operations/bulkcreatedatapointsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
941
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
942
- | `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. |
943
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
944
-
945
- ### Response
946
-
947
- **Promise\<[operations.ResponseBody[]](../../models/.md)\>**
948
-
949
- ### Errors
950
-
951
- | Error Type | Status Code | Content Type |
952
- | --------------- | --------------- | --------------- |
953
- | errors.APIError | 4XX, 5XX | \*/\* |
954
-
955
- ## clear
956
-
957
- Delete all datapoints from a dataset. This action is irreversible.
958
-
959
- ### Example Usage
960
-
961
- ```typescript
962
- import { Orq } from "@orq-ai/node";
963
-
964
- const orq = new Orq({
965
- apiKey: process.env["ORQ_API_KEY"] ?? "",
966
- });
967
-
968
- async function run() {
969
- await orq.datasets.clear({
970
- datasetId: "<id>",
971
- });
972
-
973
-
974
- }
975
-
976
- run();
977
- ```
978
-
979
- ### Standalone function
980
-
981
- The standalone function version of this method:
982
-
983
- ```typescript
984
- import { OrqCore } from "@orq-ai/node/core.js";
985
- import { datasetsClear } from "@orq-ai/node/funcs/datasetsClear.js";
986
-
987
- // Use `OrqCore` for best tree-shaking performance.
988
- // You can create one instance of it to use across an application.
989
- const orq = new OrqCore({
990
- apiKey: process.env["ORQ_API_KEY"] ?? "",
991
- });
992
-
993
- async function run() {
994
- const res = await datasetsClear(orq, {
995
- datasetId: "<id>",
996
- });
997
-
998
- if (!res.ok) {
999
- throw res.error;
1000
- }
1001
-
1002
- const { value: result } = res;
1003
-
1004
-
1005
- }
1006
-
1007
- run();
1008
- ```
1009
-
1010
- ### Parameters
1011
-
1012
- | Parameter | Type | Required | Description |
1013
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1014
- | `request` | [operations.ClearDatasetRequest](../../models/operations/cleardatasetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1015
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1016
- | `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. |
1017
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1018
-
1019
- ### Response
1020
-
1021
- **Promise\<void\>**
1022
-
1023
- ### Errors
1024
-
1025
- | Error Type | Status Code | Content Type |
1026
- | --------------- | --------------- | --------------- |
1027
- | errors.APIError | 4XX, 5XX | \*/\* |