@orq-ai/node 3.5.12 → 3.6.0-rc.10

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 (392) hide show
  1. package/README.md +6 -0
  2. package/bin/mcp-server.js +4828 -608
  3. package/bin/mcp-server.js.map +44 -35
  4. package/docs/sdks/datasets/README.md +91 -4
  5. package/docs/sdks/deployments/README.md +89 -0
  6. package/docs/sdks/knowledge/README.md +81 -4
  7. package/docs/sdks/prompts/README.md +4 -4
  8. package/funcs/datasetsCreateExperiment.d.ts +16 -0
  9. package/funcs/datasetsCreateExperiment.d.ts.map +1 -0
  10. package/funcs/datasetsCreateExperiment.js +118 -0
  11. package/funcs/datasetsCreateExperiment.js.map +1 -0
  12. package/funcs/deploymentsCreateExperiment.d.ts +16 -0
  13. package/funcs/deploymentsCreateExperiment.d.ts.map +1 -0
  14. package/funcs/deploymentsCreateExperiment.js +118 -0
  15. package/funcs/deploymentsCreateExperiment.js.map +1 -0
  16. package/funcs/knowledgeSearch.d.ts +16 -0
  17. package/funcs/knowledgeSearch.d.ts.map +1 -0
  18. package/funcs/knowledgeSearch.js +118 -0
  19. package/funcs/knowledgeSearch.js.map +1 -0
  20. package/jsr.json +1 -1
  21. package/lib/config.d.ts +2 -2
  22. package/lib/config.js +2 -2
  23. package/lib/config.js.map +1 -1
  24. package/mcp-server/mcp-server.js +1 -1
  25. package/mcp-server/mcp-server.js.map +1 -1
  26. package/mcp-server/server.d.ts.map +1 -1
  27. package/mcp-server/server.js +7 -1
  28. package/mcp-server/server.js.map +1 -1
  29. package/mcp-server/tools/datasetsCreateExperiment.d.ts +8 -0
  30. package/mcp-server/tools/datasetsCreateExperiment.d.ts.map +1 -0
  31. package/mcp-server/tools/datasetsCreateExperiment.js +64 -0
  32. package/mcp-server/tools/datasetsCreateExperiment.js.map +1 -0
  33. package/mcp-server/tools/deploymentsCreateExperiment.d.ts +8 -0
  34. package/mcp-server/tools/deploymentsCreateExperiment.d.ts.map +1 -0
  35. package/mcp-server/tools/deploymentsCreateExperiment.js +64 -0
  36. package/mcp-server/tools/deploymentsCreateExperiment.js.map +1 -0
  37. package/mcp-server/tools/knowledgeSearch.d.ts +8 -0
  38. package/mcp-server/tools/knowledgeSearch.d.ts.map +1 -0
  39. package/mcp-server/tools/knowledgeSearch.js +64 -0
  40. package/mcp-server/tools/knowledgeSearch.js.map +1 -0
  41. package/models/components/deployments.d.ts +1442 -67
  42. package/models/components/deployments.d.ts.map +1 -1
  43. package/models/components/deployments.js +1881 -126
  44. package/models/components/deployments.js.map +1 -1
  45. package/models/operations/bulkcreatedatapoints.js +2 -2
  46. package/models/operations/createchunk.d.ts +32 -17
  47. package/models/operations/createchunk.d.ts.map +1 -1
  48. package/models/operations/createchunk.js +30 -19
  49. package/models/operations/createchunk.js.map +1 -1
  50. package/models/operations/createcontact.js +2 -2
  51. package/models/operations/createdataset.js +2 -2
  52. package/models/operations/createdatasetexperiment.d.ts +140 -0
  53. package/models/operations/createdatasetexperiment.d.ts.map +1 -0
  54. package/models/operations/createdatasetexperiment.js +188 -0
  55. package/models/operations/createdatasetexperiment.js.map +1 -0
  56. package/models/operations/createdatasetitem.js +2 -2
  57. package/models/operations/createdatasource.js +2 -2
  58. package/models/operations/createdeploymentexperiment.d.ts +152 -0
  59. package/models/operations/createdeploymentexperiment.d.ts.map +1 -0
  60. package/models/operations/createdeploymentexperiment.js +189 -0
  61. package/models/operations/createdeploymentexperiment.js.map +1 -0
  62. package/models/operations/deploymentcreatemetric.d.ts +240 -28
  63. package/models/operations/deploymentcreatemetric.d.ts.map +1 -1
  64. package/models/operations/deploymentcreatemetric.js +236 -29
  65. package/models/operations/deploymentcreatemetric.js.map +1 -1
  66. package/models/operations/deploymentgetconfig.d.ts +1428 -53
  67. package/models/operations/deploymentgetconfig.d.ts.map +1 -1
  68. package/models/operations/deploymentgetconfig.js +1876 -120
  69. package/models/operations/deploymentgetconfig.js.map +1 -1
  70. package/models/operations/deploymentinvoke.d.ts +34 -4
  71. package/models/operations/deploymentinvoke.d.ts.map +1 -1
  72. package/models/operations/deploymentinvoke.js +30 -4
  73. package/models/operations/deploymentinvoke.js.map +1 -1
  74. package/models/operations/deploymentstream.d.ts +1425 -50
  75. package/models/operations/deploymentstream.d.ts.map +1 -1
  76. package/models/operations/deploymentstream.js +1840 -88
  77. package/models/operations/deploymentstream.js.map +1 -1
  78. package/models/operations/fileget.js +2 -2
  79. package/models/operations/filelist.js +2 -2
  80. package/models/operations/fileupload.d.ts +15 -15
  81. package/models/operations/fileupload.d.ts.map +1 -1
  82. package/models/operations/fileupload.js +20 -21
  83. package/models/operations/fileupload.js.map +1 -1
  84. package/models/operations/getonechunk.d.ts +24 -3
  85. package/models/operations/getonechunk.d.ts.map +1 -1
  86. package/models/operations/getonechunk.js +26 -3
  87. package/models/operations/getonechunk.js.map +1 -1
  88. package/models/operations/index.d.ts +3 -0
  89. package/models/operations/index.d.ts.map +1 -1
  90. package/models/operations/index.js +3 -0
  91. package/models/operations/index.js.map +1 -1
  92. package/models/operations/listchunks.d.ts +24 -3
  93. package/models/operations/listchunks.d.ts.map +1 -1
  94. package/models/operations/listchunks.js +26 -3
  95. package/models/operations/listchunks.js.map +1 -1
  96. package/models/operations/listdatasetdatapoints.js +2 -2
  97. package/models/operations/listdatasets.js +2 -2
  98. package/models/operations/listdatasources.js +2 -2
  99. package/models/operations/retrievedatapoint.js +2 -2
  100. package/models/operations/retrievedataset.js +2 -2
  101. package/models/operations/retrievedatasource.js +2 -2
  102. package/models/operations/searchknowledge.d.ts +1379 -0
  103. package/models/operations/searchknowledge.d.ts.map +1 -0
  104. package/models/operations/searchknowledge.js +1817 -0
  105. package/models/operations/searchknowledge.js.map +1 -0
  106. package/models/operations/updatechunk.d.ts +32 -17
  107. package/models/operations/updatechunk.d.ts.map +1 -1
  108. package/models/operations/updatechunk.js +30 -19
  109. package/models/operations/updatechunk.js.map +1 -1
  110. package/models/operations/updatedatapoint.js +2 -2
  111. package/models/operations/updatedataset.js +2 -2
  112. package/models/operations/updatedatasource.js +2 -2
  113. package/package.json +3 -2
  114. package/sdk/datasets.d.ts +7 -0
  115. package/sdk/datasets.d.ts.map +1 -1
  116. package/sdk/datasets.js +10 -0
  117. package/sdk/datasets.js.map +1 -1
  118. package/sdk/deployments.d.ts +7 -0
  119. package/sdk/deployments.d.ts.map +1 -1
  120. package/sdk/deployments.js +10 -0
  121. package/sdk/deployments.js.map +1 -1
  122. package/sdk/knowledge.d.ts +7 -0
  123. package/sdk/knowledge.d.ts.map +1 -1
  124. package/sdk/knowledge.js +10 -0
  125. package/sdk/knowledge.js.map +1 -1
  126. package/{packages/orq-rc/src/funcs/knowledgeUpdate.ts → src/funcs/knowledgeSearch.ts} +15 -12
  127. package/src/lib/config.ts +2 -2
  128. package/src/mcp-server/mcp-server.ts +1 -1
  129. package/src/mcp-server/server.ts +7 -1
  130. package/{packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts → src/mcp-server/tools/knowledgeSearch.ts} +8 -6
  131. package/src/models/components/deployments.ts +3655 -165
  132. package/src/models/operations/bulkcreatedatapoints.ts +2 -2
  133. package/src/models/operations/createchunk.ts +65 -35
  134. package/src/models/operations/createcontact.ts +2 -2
  135. package/src/models/operations/createdataset.ts +2 -2
  136. package/src/models/operations/createdatasetitem.ts +2 -2
  137. package/src/models/operations/createdatasource.ts +2 -2
  138. package/src/models/operations/deploymentcreatemetric.ts +517 -40
  139. package/src/models/operations/deploymentgetconfig.ts +3656 -118
  140. package/src/models/operations/deploymentinvoke.ts +64 -8
  141. package/src/models/operations/deploymentstream.ts +3997 -116
  142. package/src/models/operations/fileget.ts +2 -2
  143. package/src/models/operations/filelist.ts +2 -2
  144. package/src/models/operations/fileupload.ts +37 -34
  145. package/src/models/operations/getonechunk.ts +55 -5
  146. package/src/models/operations/index.ts +3 -0
  147. package/src/models/operations/listchunks.ts +55 -5
  148. package/src/models/operations/listdatasetdatapoints.ts +2 -2
  149. package/src/models/operations/listdatasets.ts +2 -2
  150. package/src/models/operations/listdatasources.ts +2 -2
  151. package/src/models/operations/retrievedatapoint.ts +2 -2
  152. package/src/models/operations/retrievedataset.ts +2 -2
  153. package/src/models/operations/retrievedatasource.ts +2 -2
  154. package/src/models/operations/searchknowledge.ts +3783 -0
  155. package/src/models/operations/updatechunk.ts +65 -35
  156. package/src/models/operations/updatedatapoint.ts +2 -2
  157. package/src/models/operations/updatedataset.ts +2 -2
  158. package/src/models/operations/updatedatasource.ts +2 -2
  159. package/src/sdk/datasets.ts +18 -0
  160. package/src/sdk/deployments.ts +18 -0
  161. package/src/sdk/knowledge.ts +18 -0
  162. package/packages/orq-rc/FUNCTIONS.md +0 -106
  163. package/packages/orq-rc/README.md +0 -705
  164. package/packages/orq-rc/RUNTIMES.md +0 -48
  165. package/packages/orq-rc/docs/sdks/contacts/README.md +0 -84
  166. package/packages/orq-rc/docs/sdks/datasets/README.md +0 -1027
  167. package/packages/orq-rc/docs/sdks/deployments/README.md +0 -405
  168. package/packages/orq-rc/docs/sdks/feedback/README.md +0 -92
  169. package/packages/orq-rc/docs/sdks/files/README.md +0 -311
  170. package/packages/orq-rc/docs/sdks/knowledge/README.md +0 -1196
  171. package/packages/orq-rc/docs/sdks/metrics/README.md +0 -86
  172. package/packages/orq-rc/docs/sdks/models/README.md +0 -79
  173. package/packages/orq-rc/docs/sdks/orq/README.md +0 -10
  174. package/packages/orq-rc/docs/sdks/prompts/README.md +0 -576
  175. package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +0 -80
  176. package/packages/orq-rc/jsr.json +0 -28
  177. package/packages/orq-rc/package-lock.json +0 -3217
  178. package/packages/orq-rc/package.json +0 -45
  179. package/packages/orq-rc/src/core.ts +0 -13
  180. package/packages/orq-rc/src/funcs/contactsCreate.ts +0 -154
  181. package/packages/orq-rc/src/funcs/datasetsClear.ts +0 -161
  182. package/packages/orq-rc/src/funcs/datasetsCreate.ts +0 -159
  183. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +0 -161
  184. package/packages/orq-rc/src/funcs/datasetsCreateDatapoints.ts +0 -165
  185. package/packages/orq-rc/src/funcs/datasetsDelete.ts +0 -161
  186. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +0 -176
  187. package/packages/orq-rc/src/funcs/datasetsList.ts +0 -161
  188. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +0 -168
  189. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +0 -169
  190. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +0 -175
  191. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +0 -170
  192. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +0 -173
  193. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +0 -162
  194. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +0 -170
  195. package/packages/orq-rc/src/funcs/deploymentsList.ts +0 -170
  196. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +0 -162
  197. package/packages/orq-rc/src/funcs/deploymentsStream.ts +0 -178
  198. package/packages/orq-rc/src/funcs/feedbackCreate.ts +0 -154
  199. package/packages/orq-rc/src/funcs/filesCreate.ts +0 -174
  200. package/packages/orq-rc/src/funcs/filesDelete.ts +0 -158
  201. package/packages/orq-rc/src/funcs/filesGet.ts +0 -160
  202. package/packages/orq-rc/src/funcs/filesList.ts +0 -161
  203. package/packages/orq-rc/src/funcs/knowledgeCreate.ts +0 -152
  204. package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +0 -165
  205. package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +0 -160
  206. package/packages/orq-rc/src/funcs/knowledgeDelete.ts +0 -161
  207. package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +0 -168
  208. package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +0 -167
  209. package/packages/orq-rc/src/funcs/knowledgeList.ts +0 -163
  210. package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +0 -172
  211. package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +0 -168
  212. package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +0 -160
  213. package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +0 -167
  214. package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +0 -163
  215. package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +0 -168
  216. package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +0 -164
  217. package/packages/orq-rc/src/funcs/modelsList.ts +0 -136
  218. package/packages/orq-rc/src/funcs/promptsCreate.ts +0 -154
  219. package/packages/orq-rc/src/funcs/promptsDelete.ts +0 -158
  220. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +0 -175
  221. package/packages/orq-rc/src/funcs/promptsList.ts +0 -161
  222. package/packages/orq-rc/src/funcs/promptsListVersions.ts +0 -167
  223. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +0 -160
  224. package/packages/orq-rc/src/funcs/promptsUpdate.ts +0 -167
  225. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +0 -155
  226. package/packages/orq-rc/src/hooks/global.ts +0 -44
  227. package/packages/orq-rc/src/hooks/hooks.ts +0 -132
  228. package/packages/orq-rc/src/hooks/index.ts +0 -6
  229. package/packages/orq-rc/src/hooks/registration.ts +0 -15
  230. package/packages/orq-rc/src/hooks/types.ts +0 -110
  231. package/packages/orq-rc/src/index.ts +0 -7
  232. package/packages/orq-rc/src/lib/base64.ts +0 -37
  233. package/packages/orq-rc/src/lib/config.ts +0 -70
  234. package/packages/orq-rc/src/lib/dlv.ts +0 -53
  235. package/packages/orq-rc/src/lib/encodings.ts +0 -483
  236. package/packages/orq-rc/src/lib/env.ts +0 -73
  237. package/packages/orq-rc/src/lib/event-streams.ts +0 -264
  238. package/packages/orq-rc/src/lib/files.ts +0 -40
  239. package/packages/orq-rc/src/lib/http.ts +0 -323
  240. package/packages/orq-rc/src/lib/is-plain-object.ts +0 -43
  241. package/packages/orq-rc/src/lib/logger.ts +0 -9
  242. package/packages/orq-rc/src/lib/matchers.ts +0 -345
  243. package/packages/orq-rc/src/lib/primitives.ts +0 -150
  244. package/packages/orq-rc/src/lib/retries.ts +0 -218
  245. package/packages/orq-rc/src/lib/schemas.ts +0 -91
  246. package/packages/orq-rc/src/lib/sdks.ts +0 -401
  247. package/packages/orq-rc/src/lib/security.ts +0 -261
  248. package/packages/orq-rc/src/lib/url.ts +0 -33
  249. package/packages/orq-rc/src/mcp-server/cli/start/command.ts +0 -125
  250. package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +0 -140
  251. package/packages/orq-rc/src/mcp-server/cli.ts +0 -13
  252. package/packages/orq-rc/src/mcp-server/console-logger.ts +0 -71
  253. package/packages/orq-rc/src/mcp-server/extensions.ts +0 -17
  254. package/packages/orq-rc/src/mcp-server/mcp-server.ts +0 -26
  255. package/packages/orq-rc/src/mcp-server/prompts.ts +0 -117
  256. package/packages/orq-rc/src/mcp-server/resources.ts +0 -172
  257. package/packages/orq-rc/src/mcp-server/scopes.ts +0 -7
  258. package/packages/orq-rc/src/mcp-server/server.ts +0 -161
  259. package/packages/orq-rc/src/mcp-server/shared.ts +0 -75
  260. package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +0 -37
  261. package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +0 -35
  262. package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +0 -37
  263. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +0 -37
  264. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoints.ts +0 -37
  265. package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +0 -35
  266. package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +0 -35
  267. package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +0 -37
  268. package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +0 -37
  269. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +0 -37
  270. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +0 -37
  271. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +0 -37
  272. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +0 -35
  273. package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +0 -37
  274. package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +0 -37
  275. package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +0 -37
  276. package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +0 -37
  277. package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +0 -37
  278. package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +0 -37
  279. package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +0 -37
  280. package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +0 -33
  281. package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +0 -37
  282. package/packages/orq-rc/src/mcp-server/tools/filesList.ts +0 -37
  283. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +0 -35
  284. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +0 -35
  285. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +0 -35
  286. package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +0 -35
  287. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +0 -33
  288. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +0 -35
  289. package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +0 -37
  290. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +0 -35
  291. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +0 -37
  292. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +0 -35
  293. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +0 -35
  294. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +0 -35
  295. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +0 -35
  296. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +0 -35
  297. package/packages/orq-rc/src/mcp-server/tools/modelsList.ts +0 -30
  298. package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +0 -35
  299. package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +0 -33
  300. package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +0 -37
  301. package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +0 -37
  302. package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +0 -37
  303. package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +0 -37
  304. package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +0 -35
  305. package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +0 -36
  306. package/packages/orq-rc/src/mcp-server/tools.ts +0 -129
  307. package/packages/orq-rc/src/models/components/deployments.ts +0 -4654
  308. package/packages/orq-rc/src/models/components/index.ts +0 -6
  309. package/packages/orq-rc/src/models/components/security.ts +0 -71
  310. package/packages/orq-rc/src/models/errors/apierror.ts +0 -27
  311. package/packages/orq-rc/src/models/errors/getpromptversion.ts +0 -71
  312. package/packages/orq-rc/src/models/errors/honoapierror.ts +0 -82
  313. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +0 -62
  314. package/packages/orq-rc/src/models/errors/index.ts +0 -10
  315. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +0 -97
  316. package/packages/orq-rc/src/models/errors/updateprompt.ts +0 -71
  317. package/packages/orq-rc/src/models/operations/bulkcreatedatapoints.ts +0 -1828
  318. package/packages/orq-rc/src/models/operations/cleardataset.ts +0 -75
  319. package/packages/orq-rc/src/models/operations/createchunk.ts +0 -402
  320. package/packages/orq-rc/src/models/operations/createcontact.ts +0 -256
  321. package/packages/orq-rc/src/models/operations/createdataset.ts +0 -296
  322. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +0 -1752
  323. package/packages/orq-rc/src/models/operations/createdatasource.ts +0 -852
  324. package/packages/orq-rc/src/models/operations/createfeedback.ts +0 -286
  325. package/packages/orq-rc/src/models/operations/createknowledge.ts +0 -846
  326. package/packages/orq-rc/src/models/operations/createprompt.ts +0 -3691
  327. package/packages/orq-rc/src/models/operations/deletechunk.ts +0 -96
  328. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +0 -81
  329. package/packages/orq-rc/src/models/operations/deletedataset.ts +0 -75
  330. package/packages/orq-rc/src/models/operations/deletedatasource.ts +0 -87
  331. package/packages/orq-rc/src/models/operations/deleteknowledge.ts +0 -78
  332. package/packages/orq-rc/src/models/operations/deleteprompt.ts +0 -69
  333. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +0 -5435
  334. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +0 -6577
  335. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +0 -1255
  336. package/packages/orq-rc/src/models/operations/deployments.ts +0 -2128
  337. package/packages/orq-rc/src/models/operations/deploymentstream.ts +0 -6523
  338. package/packages/orq-rc/src/models/operations/filedelete.ts +0 -78
  339. package/packages/orq-rc/src/models/operations/fileget.ts +0 -223
  340. package/packages/orq-rc/src/models/operations/filelist.ts +0 -337
  341. package/packages/orq-rc/src/models/operations/fileupload.ts +0 -327
  342. package/packages/orq-rc/src/models/operations/getallprompts.ts +0 -2100
  343. package/packages/orq-rc/src/models/operations/getonechunk.ts +0 -265
  344. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +0 -537
  345. package/packages/orq-rc/src/models/operations/getoneprompt.ts +0 -1966
  346. package/packages/orq-rc/src/models/operations/getpromptversion.ts +0 -1962
  347. package/packages/orq-rc/src/models/operations/index.ts +0 -53
  348. package/packages/orq-rc/src/models/operations/listchunks.ts +0 -444
  349. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +0 -1077
  350. package/packages/orq-rc/src/models/operations/listdatasets.ts +0 -406
  351. package/packages/orq-rc/src/models/operations/listdatasources.ts +0 -447
  352. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +0 -663
  353. package/packages/orq-rc/src/models/operations/listmodels.ts +0 -273
  354. package/packages/orq-rc/src/models/operations/listpromptversions.ts +0 -2096
  355. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +0 -190
  356. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +0 -930
  357. package/packages/orq-rc/src/models/operations/retrievedataset.ts +0 -288
  358. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +0 -273
  359. package/packages/orq-rc/src/models/operations/updatechunk.ts +0 -418
  360. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +0 -1741
  361. package/packages/orq-rc/src/models/operations/updatedataset.ts +0 -393
  362. package/packages/orq-rc/src/models/operations/updatedatasource.ts +0 -345
  363. package/packages/orq-rc/src/models/operations/updateknowledge.ts +0 -980
  364. package/packages/orq-rc/src/models/operations/updateprompt.ts +0 -3873
  365. package/packages/orq-rc/src/sdk/contacts.ts +0 -27
  366. package/packages/orq-rc/src/sdk/datasets.ts +0 -240
  367. package/packages/orq-rc/src/sdk/deployments.ts +0 -107
  368. package/packages/orq-rc/src/sdk/feedback.ts +0 -27
  369. package/packages/orq-rc/src/sdk/files.ts +0 -78
  370. package/packages/orq-rc/src/sdk/index.ts +0 -5
  371. package/packages/orq-rc/src/sdk/knowledge.ts +0 -246
  372. package/packages/orq-rc/src/sdk/metrics.ts +0 -27
  373. package/packages/orq-rc/src/sdk/models.ts +0 -25
  374. package/packages/orq-rc/src/sdk/prompts.ts +0 -126
  375. package/packages/orq-rc/src/sdk/remoteconfigs.ts +0 -24
  376. package/packages/orq-rc/src/sdk/sdk.ts +0 -61
  377. package/packages/orq-rc/src/types/async.ts +0 -68
  378. package/packages/orq-rc/src/types/blobs.ts +0 -31
  379. package/packages/orq-rc/src/types/constdatetime.ts +0 -15
  380. package/packages/orq-rc/src/types/enums.ts +0 -16
  381. package/packages/orq-rc/src/types/fp.ts +0 -50
  382. package/packages/orq-rc/src/types/index.ts +0 -11
  383. package/packages/orq-rc/src/types/operations.ts +0 -105
  384. package/packages/orq-rc/src/types/rfcdate.ts +0 -54
  385. package/packages/orq-rc/src/types/streams.ts +0 -21
  386. package/packages/orq-rc/tsconfig.json +0 -41
  387. /package/{packages/orq-rc/src → src}/funcs/datasetsCreateExperiment.ts +0 -0
  388. /package/{packages/orq-rc/src → src}/funcs/deploymentsCreateExperiment.ts +0 -0
  389. /package/{packages/orq-rc/src → src}/mcp-server/tools/datasetsCreateExperiment.ts +0 -0
  390. /package/{packages/orq-rc/src → src}/mcp-server/tools/deploymentsCreateExperiment.ts +0 -0
  391. /package/{packages/orq-rc/src → src}/models/operations/createdatasetexperiment.ts +0 -0
  392. /package/{packages/orq-rc/src → src}/models/operations/createdeploymentexperiment.ts +0 -0
@@ -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 | \*/\* |