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