@orq-ai/node 3.3.1 → 3.4.0-rc.0

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