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