@orq-ai/node 3.9.0-rc.13 → 3.9.0-rc.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (347) hide show
  1. package/README.md +90 -86
  2. package/bin/mcp-server.js +1194 -796
  3. package/bin/mcp-server.js.map +94 -87
  4. package/docs/sdks/datasets/README.md +83 -0
  5. package/docs/sdks/deployments/README.md +85 -0
  6. package/funcs/datasetsCreateExperiment.d.ts +17 -0
  7. package/funcs/datasetsCreateExperiment.d.ts.map +1 -0
  8. package/funcs/datasetsCreateExperiment.js +120 -0
  9. package/funcs/datasetsCreateExperiment.js.map +1 -0
  10. package/funcs/deploymentsCreateExperiment.d.ts +17 -0
  11. package/funcs/deploymentsCreateExperiment.d.ts.map +1 -0
  12. package/funcs/deploymentsCreateExperiment.js +120 -0
  13. package/funcs/deploymentsCreateExperiment.js.map +1 -0
  14. package/jsr.json +1 -1
  15. package/lib/config.d.ts +3 -3
  16. package/lib/config.js +3 -3
  17. package/lib/config.js.map +1 -1
  18. package/mcp-server/cli/start/command.d.ts.map +1 -1
  19. package/mcp-server/cli/start/command.js +12 -0
  20. package/mcp-server/cli/start/command.js.map +1 -1
  21. package/mcp-server/cli/start/impl.d.ts +2 -0
  22. package/mcp-server/cli/start/impl.d.ts.map +1 -1
  23. package/mcp-server/cli/start/impl.js +2 -0
  24. package/mcp-server/cli/start/impl.js.map +1 -1
  25. package/mcp-server/mcp-server.js +1 -1
  26. package/mcp-server/mcp-server.js.map +1 -1
  27. package/mcp-server/server.d.ts.map +1 -1
  28. package/mcp-server/server.js +5 -1
  29. package/mcp-server/server.js.map +1 -1
  30. package/mcp-server/tools/datasetsCreateExperiment.d.ts +8 -0
  31. package/mcp-server/tools/datasetsCreateExperiment.d.ts.map +1 -0
  32. package/mcp-server/tools/datasetsCreateExperiment.js +64 -0
  33. package/mcp-server/tools/datasetsCreateExperiment.js.map +1 -0
  34. package/mcp-server/tools/deploymentsCreateExperiment.d.ts +8 -0
  35. package/mcp-server/tools/deploymentsCreateExperiment.d.ts.map +1 -0
  36. package/mcp-server/tools/deploymentsCreateExperiment.js +64 -0
  37. package/mcp-server/tools/deploymentsCreateExperiment.js.map +1 -0
  38. package/models/errors/apierror.d.ts.map +1 -1
  39. package/models/errors/apierror.js +2 -8
  40. package/models/errors/apierror.js.map +1 -1
  41. package/models/errors/createeval.d.ts.map +1 -1
  42. package/models/errors/createeval.js +3 -1
  43. package/models/errors/createeval.js.map +1 -1
  44. package/models/errors/deleteeval.d.ts.map +1 -1
  45. package/models/errors/deleteeval.js +3 -1
  46. package/models/errors/deleteeval.js.map +1 -1
  47. package/models/errors/evalsageappropriate.d.ts.map +1 -1
  48. package/models/errors/evalsageappropriate.js +6 -2
  49. package/models/errors/evalsageappropriate.js.map +1 -1
  50. package/models/errors/evalsbertscore.d.ts.map +1 -1
  51. package/models/errors/evalsbertscore.js +6 -2
  52. package/models/errors/evalsbertscore.js.map +1 -1
  53. package/models/errors/evalsbleuscore.d.ts.map +1 -1
  54. package/models/errors/evalsbleuscore.js +6 -2
  55. package/models/errors/evalsbleuscore.js.map +1 -1
  56. package/models/errors/evalsbotdetection.d.ts.map +1 -1
  57. package/models/errors/evalsbotdetection.js +6 -2
  58. package/models/errors/evalsbotdetection.js.map +1 -1
  59. package/models/errors/evalscontains.d.ts.map +1 -1
  60. package/models/errors/evalscontains.js +6 -2
  61. package/models/errors/evalscontains.js.map +1 -1
  62. package/models/errors/evalscontainsall.d.ts.map +1 -1
  63. package/models/errors/evalscontainsall.js +6 -2
  64. package/models/errors/evalscontainsall.js.map +1 -1
  65. package/models/errors/evalscontainsany.d.ts.map +1 -1
  66. package/models/errors/evalscontainsany.js +6 -2
  67. package/models/errors/evalscontainsany.js.map +1 -1
  68. package/models/errors/evalscontainsemail.d.ts.map +1 -1
  69. package/models/errors/evalscontainsemail.js +6 -2
  70. package/models/errors/evalscontainsemail.js.map +1 -1
  71. package/models/errors/evalscontainsnone.d.ts.map +1 -1
  72. package/models/errors/evalscontainsnone.js +6 -2
  73. package/models/errors/evalscontainsnone.js.map +1 -1
  74. package/models/errors/evalscontainsurl.d.ts.map +1 -1
  75. package/models/errors/evalscontainsurl.js +6 -2
  76. package/models/errors/evalscontainsurl.js.map +1 -1
  77. package/models/errors/evalscontainsvalidlink.d.ts.map +1 -1
  78. package/models/errors/evalscontainsvalidlink.js +6 -2
  79. package/models/errors/evalscontainsvalidlink.js.map +1 -1
  80. package/models/errors/evalsendswith.d.ts.map +1 -1
  81. package/models/errors/evalsendswith.js +6 -2
  82. package/models/errors/evalsendswith.js.map +1 -1
  83. package/models/errors/evalsexactmatch.d.ts.map +1 -1
  84. package/models/errors/evalsexactmatch.js +6 -2
  85. package/models/errors/evalsexactmatch.js.map +1 -1
  86. package/models/errors/evalsfactcheckingknowledgebase.d.ts.map +1 -1
  87. package/models/errors/evalsfactcheckingknowledgebase.js +6 -2
  88. package/models/errors/evalsfactcheckingknowledgebase.js.map +1 -1
  89. package/models/errors/evalsgrammar.d.ts.map +1 -1
  90. package/models/errors/evalsgrammar.js +6 -2
  91. package/models/errors/evalsgrammar.js.map +1 -1
  92. package/models/errors/evalslengthbetween.d.ts.map +1 -1
  93. package/models/errors/evalslengthbetween.js +6 -2
  94. package/models/errors/evalslengthbetween.js.map +1 -1
  95. package/models/errors/evalslengthgreaterthan.d.ts.map +1 -1
  96. package/models/errors/evalslengthgreaterthan.js +6 -2
  97. package/models/errors/evalslengthgreaterthan.js.map +1 -1
  98. package/models/errors/evalslengthlessthan.d.ts.map +1 -1
  99. package/models/errors/evalslengthlessthan.js +6 -2
  100. package/models/errors/evalslengthlessthan.js.map +1 -1
  101. package/models/errors/evalslocalization.d.ts.map +1 -1
  102. package/models/errors/evalslocalization.js +6 -2
  103. package/models/errors/evalslocalization.js.map +1 -1
  104. package/models/errors/evalspii.d.ts.map +1 -1
  105. package/models/errors/evalspii.js +6 -2
  106. package/models/errors/evalspii.js.map +1 -1
  107. package/models/errors/evalsragascoherence.d.ts.map +1 -1
  108. package/models/errors/evalsragascoherence.js +6 -2
  109. package/models/errors/evalsragascoherence.js.map +1 -1
  110. package/models/errors/evalsragasconciseness.d.ts.map +1 -1
  111. package/models/errors/evalsragasconciseness.js +6 -2
  112. package/models/errors/evalsragasconciseness.js.map +1 -1
  113. package/models/errors/evalsragascontextentitiesrecall.d.ts.map +1 -1
  114. package/models/errors/evalsragascontextentitiesrecall.js +6 -2
  115. package/models/errors/evalsragascontextentitiesrecall.js.map +1 -1
  116. package/models/errors/evalsragascontextprecision.d.ts.map +1 -1
  117. package/models/errors/evalsragascontextprecision.js +6 -2
  118. package/models/errors/evalsragascontextprecision.js.map +1 -1
  119. package/models/errors/evalsragascontextrecall.d.ts.map +1 -1
  120. package/models/errors/evalsragascontextrecall.js +6 -2
  121. package/models/errors/evalsragascontextrecall.js.map +1 -1
  122. package/models/errors/evalsragascorrectness.d.ts.map +1 -1
  123. package/models/errors/evalsragascorrectness.js +6 -2
  124. package/models/errors/evalsragascorrectness.js.map +1 -1
  125. package/models/errors/evalsragasfaithfulness.d.ts.map +1 -1
  126. package/models/errors/evalsragasfaithfulness.js +6 -2
  127. package/models/errors/evalsragasfaithfulness.js.map +1 -1
  128. package/models/errors/evalsragasharmfulness.d.ts.map +1 -1
  129. package/models/errors/evalsragasharmfulness.js +6 -2
  130. package/models/errors/evalsragasharmfulness.js.map +1 -1
  131. package/models/errors/evalsragasmaliciousness.d.ts.map +1 -1
  132. package/models/errors/evalsragasmaliciousness.js +6 -2
  133. package/models/errors/evalsragasmaliciousness.js.map +1 -1
  134. package/models/errors/evalsragasnoisesensitivity.d.ts.map +1 -1
  135. package/models/errors/evalsragasnoisesensitivity.js +6 -2
  136. package/models/errors/evalsragasnoisesensitivity.js.map +1 -1
  137. package/models/errors/evalsragasresponserelevancy.d.ts.map +1 -1
  138. package/models/errors/evalsragasresponserelevancy.js +6 -2
  139. package/models/errors/evalsragasresponserelevancy.js.map +1 -1
  140. package/models/errors/evalsragassummarization.d.ts.map +1 -1
  141. package/models/errors/evalsragassummarization.js +6 -2
  142. package/models/errors/evalsragassummarization.js.map +1 -1
  143. package/models/errors/evalssentimentclassification.d.ts.map +1 -1
  144. package/models/errors/evalssentimentclassification.js +6 -2
  145. package/models/errors/evalssentimentclassification.js.map +1 -1
  146. package/models/errors/evalssummarization.d.ts.map +1 -1
  147. package/models/errors/evalssummarization.js +6 -2
  148. package/models/errors/evalssummarization.js.map +1 -1
  149. package/models/errors/evalstoneofvoice.d.ts.map +1 -1
  150. package/models/errors/evalstoneofvoice.js +6 -2
  151. package/models/errors/evalstoneofvoice.js.map +1 -1
  152. package/models/errors/evalstranslation.d.ts.map +1 -1
  153. package/models/errors/evalstranslation.js +6 -2
  154. package/models/errors/evalstranslation.js.map +1 -1
  155. package/models/errors/evalsvalidjson.d.ts.map +1 -1
  156. package/models/errors/evalsvalidjson.js +6 -2
  157. package/models/errors/evalsvalidjson.js.map +1 -1
  158. package/models/errors/getevals.d.ts.map +1 -1
  159. package/models/errors/getevals.js +3 -1
  160. package/models/errors/getevals.js.map +1 -1
  161. package/models/errors/getpromptversion.d.ts.map +1 -1
  162. package/models/errors/getpromptversion.js +3 -1
  163. package/models/errors/getpromptversion.js.map +1 -1
  164. package/models/errors/honoapierror.d.ts.map +1 -1
  165. package/models/errors/honoapierror.js +3 -1
  166. package/models/errors/honoapierror.js.map +1 -1
  167. package/models/errors/invokeeval.d.ts.map +1 -1
  168. package/models/errors/invokeeval.js +6 -2
  169. package/models/errors/invokeeval.js.map +1 -1
  170. package/models/errors/updatecontact.d.ts.map +1 -1
  171. package/models/errors/updatecontact.js +3 -1
  172. package/models/errors/updatecontact.js.map +1 -1
  173. package/models/errors/updateeval.d.ts.map +1 -1
  174. package/models/errors/updateeval.js +3 -1
  175. package/models/errors/updateeval.js.map +1 -1
  176. package/models/errors/updateprompt.d.ts.map +1 -1
  177. package/models/errors/updateprompt.js +3 -1
  178. package/models/errors/updateprompt.js.map +1 -1
  179. package/models/operations/createcontact.js +2 -2
  180. package/models/operations/createdataset.js +2 -2
  181. package/models/operations/createdatasetexperiment.d.ts +140 -0
  182. package/models/operations/createdatasetexperiment.d.ts.map +1 -0
  183. package/models/operations/createdatasetexperiment.js +188 -0
  184. package/models/operations/createdatasetexperiment.js.map +1 -0
  185. package/models/operations/createdatasetitem.js +2 -2
  186. package/models/operations/createdatasource.js +2 -2
  187. package/models/operations/createdeploymentexperiment.d.ts +152 -0
  188. package/models/operations/createdeploymentexperiment.d.ts.map +1 -0
  189. package/models/operations/createdeploymentexperiment.js +189 -0
  190. package/models/operations/createdeploymentexperiment.js.map +1 -0
  191. package/models/operations/createeval.js +16 -16
  192. package/models/operations/createfeedback.d.ts +2 -2
  193. package/models/operations/createprompt.d.ts +0 -6
  194. package/models/operations/createprompt.d.ts.map +1 -1
  195. package/models/operations/createprompt.js +0 -2
  196. package/models/operations/createprompt.js.map +1 -1
  197. package/models/operations/deploymentgetconfig.d.ts +0 -3
  198. package/models/operations/deploymentgetconfig.d.ts.map +1 -1
  199. package/models/operations/deploymentgetconfig.js +0 -1
  200. package/models/operations/deploymentgetconfig.js.map +1 -1
  201. package/models/operations/deployments.d.ts +0 -3
  202. package/models/operations/deployments.d.ts.map +1 -1
  203. package/models/operations/deployments.js +0 -1
  204. package/models/operations/deployments.js.map +1 -1
  205. package/models/operations/fileget.js +2 -2
  206. package/models/operations/filelist.js +2 -2
  207. package/models/operations/fileupload.js +2 -2
  208. package/models/operations/getallprompts.d.ts +0 -3
  209. package/models/operations/getallprompts.d.ts.map +1 -1
  210. package/models/operations/getallprompts.js +0 -1
  211. package/models/operations/getallprompts.js.map +1 -1
  212. package/models/operations/getevals.js +28 -28
  213. package/models/operations/getoneprompt.d.ts +0 -3
  214. package/models/operations/getoneprompt.d.ts.map +1 -1
  215. package/models/operations/getoneprompt.js +0 -1
  216. package/models/operations/getoneprompt.js.map +1 -1
  217. package/models/operations/getpromptversion.d.ts +0 -3
  218. package/models/operations/getpromptversion.d.ts.map +1 -1
  219. package/models/operations/getpromptversion.js +0 -1
  220. package/models/operations/getpromptversion.js.map +1 -1
  221. package/models/operations/index.d.ts +2 -0
  222. package/models/operations/index.d.ts.map +1 -1
  223. package/models/operations/index.js +2 -0
  224. package/models/operations/index.js.map +1 -1
  225. package/models/operations/listcontacts.d.ts +2 -2
  226. package/models/operations/listcontacts.js +2 -2
  227. package/models/operations/listdatasetdatapoints.js +2 -2
  228. package/models/operations/listdatasets.js +2 -2
  229. package/models/operations/listdatasources.js +2 -2
  230. package/models/operations/listpromptversions.d.ts +0 -3
  231. package/models/operations/listpromptversions.d.ts.map +1 -1
  232. package/models/operations/listpromptversions.js +0 -1
  233. package/models/operations/listpromptversions.js.map +1 -1
  234. package/models/operations/retrievecontact.js +2 -2
  235. package/models/operations/retrievedatapoint.js +2 -2
  236. package/models/operations/retrievedataset.js +2 -2
  237. package/models/operations/retrievedatasource.js +2 -2
  238. package/models/operations/updatecontact.js +2 -2
  239. package/models/operations/updatedatapoint.js +2 -2
  240. package/models/operations/updatedataset.js +2 -2
  241. package/models/operations/updatedatasource.js +2 -2
  242. package/models/operations/updateeval.js +16 -16
  243. package/models/operations/updateprompt.d.ts +0 -6
  244. package/models/operations/updateprompt.d.ts.map +1 -1
  245. package/models/operations/updateprompt.js +0 -2
  246. package/models/operations/updateprompt.js.map +1 -1
  247. package/package.json +1 -1
  248. package/sdk/datasets.d.ts +7 -0
  249. package/sdk/datasets.d.ts.map +1 -1
  250. package/sdk/datasets.js +10 -0
  251. package/sdk/datasets.js.map +1 -1
  252. package/sdk/deployments.d.ts +7 -0
  253. package/sdk/deployments.d.ts.map +1 -1
  254. package/sdk/deployments.js +10 -0
  255. package/sdk/deployments.js.map +1 -1
  256. package/src/funcs/datasetsCreateExperiment.ts +168 -0
  257. package/src/funcs/deploymentsCreateExperiment.ts +173 -0
  258. package/src/lib/config.ts +3 -3
  259. package/src/mcp-server/cli/start/command.ts +13 -0
  260. package/src/mcp-server/cli/start/impl.ts +4 -0
  261. package/src/mcp-server/mcp-server.ts +1 -1
  262. package/src/mcp-server/server.ts +5 -1
  263. package/src/mcp-server/tools/datasetsCreateExperiment.ts +37 -0
  264. package/src/mcp-server/tools/deploymentsCreateExperiment.ts +37 -0
  265. package/src/models/errors/apierror.ts +2 -8
  266. package/src/models/errors/createeval.ts +3 -1
  267. package/src/models/errors/deleteeval.ts +3 -1
  268. package/src/models/errors/evalsageappropriate.ts +6 -2
  269. package/src/models/errors/evalsbertscore.ts +6 -2
  270. package/src/models/errors/evalsbleuscore.ts +6 -2
  271. package/src/models/errors/evalsbotdetection.ts +6 -2
  272. package/src/models/errors/evalscontains.ts +6 -2
  273. package/src/models/errors/evalscontainsall.ts +6 -2
  274. package/src/models/errors/evalscontainsany.ts +6 -2
  275. package/src/models/errors/evalscontainsemail.ts +6 -2
  276. package/src/models/errors/evalscontainsnone.ts +6 -2
  277. package/src/models/errors/evalscontainsurl.ts +6 -2
  278. package/src/models/errors/evalscontainsvalidlink.ts +6 -2
  279. package/src/models/errors/evalsendswith.ts +6 -2
  280. package/src/models/errors/evalsexactmatch.ts +6 -2
  281. package/src/models/errors/evalsfactcheckingknowledgebase.ts +6 -2
  282. package/src/models/errors/evalsgrammar.ts +6 -2
  283. package/src/models/errors/evalslengthbetween.ts +6 -2
  284. package/src/models/errors/evalslengthgreaterthan.ts +6 -2
  285. package/src/models/errors/evalslengthlessthan.ts +6 -2
  286. package/src/models/errors/evalslocalization.ts +6 -2
  287. package/src/models/errors/evalspii.ts +6 -2
  288. package/src/models/errors/evalsragascoherence.ts +6 -2
  289. package/src/models/errors/evalsragasconciseness.ts +6 -2
  290. package/src/models/errors/evalsragascontextentitiesrecall.ts +6 -2
  291. package/src/models/errors/evalsragascontextprecision.ts +6 -2
  292. package/src/models/errors/evalsragascontextrecall.ts +6 -2
  293. package/src/models/errors/evalsragascorrectness.ts +6 -2
  294. package/src/models/errors/evalsragasfaithfulness.ts +6 -2
  295. package/src/models/errors/evalsragasharmfulness.ts +6 -2
  296. package/src/models/errors/evalsragasmaliciousness.ts +6 -2
  297. package/src/models/errors/evalsragasnoisesensitivity.ts +6 -2
  298. package/src/models/errors/evalsragasresponserelevancy.ts +6 -2
  299. package/src/models/errors/evalsragassummarization.ts +6 -2
  300. package/src/models/errors/evalssentimentclassification.ts +6 -2
  301. package/src/models/errors/evalssummarization.ts +6 -2
  302. package/src/models/errors/evalstoneofvoice.ts +6 -2
  303. package/src/models/errors/evalstranslation.ts +6 -2
  304. package/src/models/errors/evalsvalidjson.ts +6 -2
  305. package/src/models/errors/getevals.ts +3 -1
  306. package/src/models/errors/getpromptversion.ts +3 -1
  307. package/src/models/errors/honoapierror.ts +3 -1
  308. package/src/models/errors/invokeeval.ts +6 -2
  309. package/src/models/errors/updatecontact.ts +3 -1
  310. package/src/models/errors/updateeval.ts +3 -1
  311. package/src/models/errors/updateprompt.ts +3 -1
  312. package/src/models/operations/createcontact.ts +2 -2
  313. package/src/models/operations/createdataset.ts +2 -2
  314. package/src/models/operations/createdatasetexperiment.ts +307 -0
  315. package/src/models/operations/createdatasetitem.ts +2 -2
  316. package/src/models/operations/createdatasource.ts +2 -2
  317. package/src/models/operations/createdeploymentexperiment.ts +321 -0
  318. package/src/models/operations/createeval.ts +16 -16
  319. package/src/models/operations/createfeedback.ts +2 -2
  320. package/src/models/operations/createprompt.ts +0 -2
  321. package/src/models/operations/deploymentgetconfig.ts +0 -1
  322. package/src/models/operations/deployments.ts +0 -1
  323. package/src/models/operations/fileget.ts +2 -2
  324. package/src/models/operations/filelist.ts +2 -2
  325. package/src/models/operations/fileupload.ts +2 -2
  326. package/src/models/operations/getallprompts.ts +0 -1
  327. package/src/models/operations/getevals.ts +28 -28
  328. package/src/models/operations/getoneprompt.ts +0 -1
  329. package/src/models/operations/getpromptversion.ts +0 -1
  330. package/src/models/operations/index.ts +2 -0
  331. package/src/models/operations/listcontacts.ts +4 -4
  332. package/src/models/operations/listdatasetdatapoints.ts +2 -2
  333. package/src/models/operations/listdatasets.ts +2 -2
  334. package/src/models/operations/listdatasources.ts +2 -2
  335. package/src/models/operations/listpromptversions.ts +0 -1
  336. package/src/models/operations/retrievecontact.ts +2 -2
  337. package/src/models/operations/retrievedatapoint.ts +2 -2
  338. package/src/models/operations/retrievedataset.ts +2 -2
  339. package/src/models/operations/retrievedatasource.ts +2 -2
  340. package/src/models/operations/updatecontact.ts +2 -2
  341. package/src/models/operations/updatedatapoint.ts +2 -2
  342. package/src/models/operations/updatedataset.ts +2 -2
  343. package/src/models/operations/updatedatasource.ts +2 -2
  344. package/src/models/operations/updateeval.ts +16 -16
  345. package/src/models/operations/updateprompt.ts +0 -2
  346. package/src/sdk/datasets.ts +18 -0
  347. package/src/sdk/deployments.ts +18 -0
@@ -0,0 +1,321 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { ClosedEnum } from "../../types/enums.js";
9
+ import { Result as SafeParseResult } from "../../types/fp.js";
10
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+
12
+ export const CreateDeploymentExperimentType = {
13
+ DeploymentExperiment: "deployment_experiment",
14
+ } as const;
15
+ export type CreateDeploymentExperimentType = ClosedEnum<
16
+ typeof CreateDeploymentExperimentType
17
+ >;
18
+
19
+ export type CreateDeploymentExperimentRequestBody = {
20
+ /**
21
+ * The unique key of the experiment
22
+ */
23
+ experimentKey: string;
24
+ /**
25
+ * The list of evaluators to use for the experiment. You can apply multiple evaluators to the same experiment. By default we always consider latency and cost as evaluators.
26
+ */
27
+ evaluators?: Array<string> | undefined;
28
+ /**
29
+ * The path where the experiment needs to be stored. If not provided, the experiment will be stored in the same path of the dataset used for the experiment.
30
+ */
31
+ path?: string | undefined;
32
+ /**
33
+ * The id of the dataset to run the experiment on
34
+ */
35
+ datasetId: string;
36
+ type: CreateDeploymentExperimentType;
37
+ /**
38
+ * Key-value pairs that match your data model and fields declared in your deployment routing configuration. If not provided, the default variant of the deployment will be used to create the experiment
39
+ */
40
+ context?: { [k: string]: any } | undefined;
41
+ };
42
+
43
+ export type CreateDeploymentExperimentRequest = {
44
+ /**
45
+ * Deployment Key
46
+ */
47
+ deploymentKey: string;
48
+ requestBody?: CreateDeploymentExperimentRequestBody | undefined;
49
+ };
50
+
51
+ /**
52
+ * Experiment created
53
+ */
54
+ export type CreateDeploymentExperimentResponseBody = {
55
+ /**
56
+ * The url of the experiment run that was just created
57
+ */
58
+ url: string;
59
+ /**
60
+ * The unique identifier of the experiment
61
+ */
62
+ experimentId: string;
63
+ /**
64
+ * The unique identifier of the experiment run
65
+ */
66
+ experimentRunId: string;
67
+ };
68
+
69
+ /** @internal */
70
+ export const CreateDeploymentExperimentType$inboundSchema: z.ZodNativeEnum<
71
+ typeof CreateDeploymentExperimentType
72
+ > = z.nativeEnum(CreateDeploymentExperimentType);
73
+
74
+ /** @internal */
75
+ export const CreateDeploymentExperimentType$outboundSchema: z.ZodNativeEnum<
76
+ typeof CreateDeploymentExperimentType
77
+ > = CreateDeploymentExperimentType$inboundSchema;
78
+
79
+ /**
80
+ * @internal
81
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
82
+ */
83
+ export namespace CreateDeploymentExperimentType$ {
84
+ /** @deprecated use `CreateDeploymentExperimentType$inboundSchema` instead. */
85
+ export const inboundSchema = CreateDeploymentExperimentType$inboundSchema;
86
+ /** @deprecated use `CreateDeploymentExperimentType$outboundSchema` instead. */
87
+ export const outboundSchema = CreateDeploymentExperimentType$outboundSchema;
88
+ }
89
+
90
+ /** @internal */
91
+ export const CreateDeploymentExperimentRequestBody$inboundSchema: z.ZodType<
92
+ CreateDeploymentExperimentRequestBody,
93
+ z.ZodTypeDef,
94
+ unknown
95
+ > = z.object({
96
+ experiment_key: z.string(),
97
+ evaluators: z.array(z.string()).optional(),
98
+ path: z.string().optional(),
99
+ dataset_id: z.string(),
100
+ type: CreateDeploymentExperimentType$inboundSchema,
101
+ context: z.record(z.any()).optional(),
102
+ }).transform((v) => {
103
+ return remap$(v, {
104
+ "experiment_key": "experimentKey",
105
+ "dataset_id": "datasetId",
106
+ });
107
+ });
108
+
109
+ /** @internal */
110
+ export type CreateDeploymentExperimentRequestBody$Outbound = {
111
+ experiment_key: string;
112
+ evaluators?: Array<string> | undefined;
113
+ path?: string | undefined;
114
+ dataset_id: string;
115
+ type: string;
116
+ context?: { [k: string]: any } | undefined;
117
+ };
118
+
119
+ /** @internal */
120
+ export const CreateDeploymentExperimentRequestBody$outboundSchema: z.ZodType<
121
+ CreateDeploymentExperimentRequestBody$Outbound,
122
+ z.ZodTypeDef,
123
+ CreateDeploymentExperimentRequestBody
124
+ > = z.object({
125
+ experimentKey: z.string(),
126
+ evaluators: z.array(z.string()).optional(),
127
+ path: z.string().optional(),
128
+ datasetId: z.string(),
129
+ type: CreateDeploymentExperimentType$outboundSchema,
130
+ context: z.record(z.any()).optional(),
131
+ }).transform((v) => {
132
+ return remap$(v, {
133
+ experimentKey: "experiment_key",
134
+ datasetId: "dataset_id",
135
+ });
136
+ });
137
+
138
+ /**
139
+ * @internal
140
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
141
+ */
142
+ export namespace CreateDeploymentExperimentRequestBody$ {
143
+ /** @deprecated use `CreateDeploymentExperimentRequestBody$inboundSchema` instead. */
144
+ export const inboundSchema =
145
+ CreateDeploymentExperimentRequestBody$inboundSchema;
146
+ /** @deprecated use `CreateDeploymentExperimentRequestBody$outboundSchema` instead. */
147
+ export const outboundSchema =
148
+ CreateDeploymentExperimentRequestBody$outboundSchema;
149
+ /** @deprecated use `CreateDeploymentExperimentRequestBody$Outbound` instead. */
150
+ export type Outbound = CreateDeploymentExperimentRequestBody$Outbound;
151
+ }
152
+
153
+ export function createDeploymentExperimentRequestBodyToJSON(
154
+ createDeploymentExperimentRequestBody: CreateDeploymentExperimentRequestBody,
155
+ ): string {
156
+ return JSON.stringify(
157
+ CreateDeploymentExperimentRequestBody$outboundSchema.parse(
158
+ createDeploymentExperimentRequestBody,
159
+ ),
160
+ );
161
+ }
162
+
163
+ export function createDeploymentExperimentRequestBodyFromJSON(
164
+ jsonString: string,
165
+ ): SafeParseResult<CreateDeploymentExperimentRequestBody, SDKValidationError> {
166
+ return safeParse(
167
+ jsonString,
168
+ (x) =>
169
+ CreateDeploymentExperimentRequestBody$inboundSchema.parse(JSON.parse(x)),
170
+ `Failed to parse 'CreateDeploymentExperimentRequestBody' from JSON`,
171
+ );
172
+ }
173
+
174
+ /** @internal */
175
+ export const CreateDeploymentExperimentRequest$inboundSchema: z.ZodType<
176
+ CreateDeploymentExperimentRequest,
177
+ z.ZodTypeDef,
178
+ unknown
179
+ > = z.object({
180
+ deployment_key: z.string(),
181
+ RequestBody: z.lazy(() => CreateDeploymentExperimentRequestBody$inboundSchema)
182
+ .optional(),
183
+ }).transform((v) => {
184
+ return remap$(v, {
185
+ "deployment_key": "deploymentKey",
186
+ "RequestBody": "requestBody",
187
+ });
188
+ });
189
+
190
+ /** @internal */
191
+ export type CreateDeploymentExperimentRequest$Outbound = {
192
+ deployment_key: string;
193
+ RequestBody?: CreateDeploymentExperimentRequestBody$Outbound | undefined;
194
+ };
195
+
196
+ /** @internal */
197
+ export const CreateDeploymentExperimentRequest$outboundSchema: z.ZodType<
198
+ CreateDeploymentExperimentRequest$Outbound,
199
+ z.ZodTypeDef,
200
+ CreateDeploymentExperimentRequest
201
+ > = z.object({
202
+ deploymentKey: z.string(),
203
+ requestBody: z.lazy(() =>
204
+ CreateDeploymentExperimentRequestBody$outboundSchema
205
+ ).optional(),
206
+ }).transform((v) => {
207
+ return remap$(v, {
208
+ deploymentKey: "deployment_key",
209
+ requestBody: "RequestBody",
210
+ });
211
+ });
212
+
213
+ /**
214
+ * @internal
215
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
216
+ */
217
+ export namespace CreateDeploymentExperimentRequest$ {
218
+ /** @deprecated use `CreateDeploymentExperimentRequest$inboundSchema` instead. */
219
+ export const inboundSchema = CreateDeploymentExperimentRequest$inboundSchema;
220
+ /** @deprecated use `CreateDeploymentExperimentRequest$outboundSchema` instead. */
221
+ export const outboundSchema =
222
+ CreateDeploymentExperimentRequest$outboundSchema;
223
+ /** @deprecated use `CreateDeploymentExperimentRequest$Outbound` instead. */
224
+ export type Outbound = CreateDeploymentExperimentRequest$Outbound;
225
+ }
226
+
227
+ export function createDeploymentExperimentRequestToJSON(
228
+ createDeploymentExperimentRequest: CreateDeploymentExperimentRequest,
229
+ ): string {
230
+ return JSON.stringify(
231
+ CreateDeploymentExperimentRequest$outboundSchema.parse(
232
+ createDeploymentExperimentRequest,
233
+ ),
234
+ );
235
+ }
236
+
237
+ export function createDeploymentExperimentRequestFromJSON(
238
+ jsonString: string,
239
+ ): SafeParseResult<CreateDeploymentExperimentRequest, SDKValidationError> {
240
+ return safeParse(
241
+ jsonString,
242
+ (x) => CreateDeploymentExperimentRequest$inboundSchema.parse(JSON.parse(x)),
243
+ `Failed to parse 'CreateDeploymentExperimentRequest' from JSON`,
244
+ );
245
+ }
246
+
247
+ /** @internal */
248
+ export const CreateDeploymentExperimentResponseBody$inboundSchema: z.ZodType<
249
+ CreateDeploymentExperimentResponseBody,
250
+ z.ZodTypeDef,
251
+ unknown
252
+ > = z.object({
253
+ url: z.string(),
254
+ experiment_id: z.string(),
255
+ experiment_run_id: z.string(),
256
+ }).transform((v) => {
257
+ return remap$(v, {
258
+ "experiment_id": "experimentId",
259
+ "experiment_run_id": "experimentRunId",
260
+ });
261
+ });
262
+
263
+ /** @internal */
264
+ export type CreateDeploymentExperimentResponseBody$Outbound = {
265
+ url: string;
266
+ experiment_id: string;
267
+ experiment_run_id: string;
268
+ };
269
+
270
+ /** @internal */
271
+ export const CreateDeploymentExperimentResponseBody$outboundSchema: z.ZodType<
272
+ CreateDeploymentExperimentResponseBody$Outbound,
273
+ z.ZodTypeDef,
274
+ CreateDeploymentExperimentResponseBody
275
+ > = z.object({
276
+ url: z.string(),
277
+ experimentId: z.string(),
278
+ experimentRunId: z.string(),
279
+ }).transform((v) => {
280
+ return remap$(v, {
281
+ experimentId: "experiment_id",
282
+ experimentRunId: "experiment_run_id",
283
+ });
284
+ });
285
+
286
+ /**
287
+ * @internal
288
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
289
+ */
290
+ export namespace CreateDeploymentExperimentResponseBody$ {
291
+ /** @deprecated use `CreateDeploymentExperimentResponseBody$inboundSchema` instead. */
292
+ export const inboundSchema =
293
+ CreateDeploymentExperimentResponseBody$inboundSchema;
294
+ /** @deprecated use `CreateDeploymentExperimentResponseBody$outboundSchema` instead. */
295
+ export const outboundSchema =
296
+ CreateDeploymentExperimentResponseBody$outboundSchema;
297
+ /** @deprecated use `CreateDeploymentExperimentResponseBody$Outbound` instead. */
298
+ export type Outbound = CreateDeploymentExperimentResponseBody$Outbound;
299
+ }
300
+
301
+ export function createDeploymentExperimentResponseBodyToJSON(
302
+ createDeploymentExperimentResponseBody:
303
+ CreateDeploymentExperimentResponseBody,
304
+ ): string {
305
+ return JSON.stringify(
306
+ CreateDeploymentExperimentResponseBody$outboundSchema.parse(
307
+ createDeploymentExperimentResponseBody,
308
+ ),
309
+ );
310
+ }
311
+
312
+ export function createDeploymentExperimentResponseBodyFromJSON(
313
+ jsonString: string,
314
+ ): SafeParseResult<CreateDeploymentExperimentResponseBody, SDKValidationError> {
315
+ return safeParse(
316
+ jsonString,
317
+ (x) =>
318
+ CreateDeploymentExperimentResponseBody$inboundSchema.parse(JSON.parse(x)),
319
+ `Failed to parse 'CreateDeploymentExperimentResponseBody' from JSON`,
320
+ );
321
+ }
@@ -2399,8 +2399,8 @@ export const ResponseBodyPython$inboundSchema: z.ZodType<
2399
2399
  > = z.object({
2400
2400
  _id: z.string(),
2401
2401
  description: z.string(),
2402
- created: z.string().default("2025-07-02T14:35:10.278Z"),
2403
- updated: z.string().default("2025-07-02T14:35:10.278Z"),
2402
+ created: z.string().default("2025-06-24T05:41:48.250Z"),
2403
+ updated: z.string().default("2025-06-24T05:41:48.250Z"),
2404
2404
  guardrail_config: z.union([
2405
2405
  z.lazy(() =>
2406
2406
  CreateEvalGuardrailConfigEvalsResponse200ApplicationJSONResponseBodyNumber$inboundSchema
@@ -2442,8 +2442,8 @@ export const ResponseBodyPython$outboundSchema: z.ZodType<
2442
2442
  > = z.object({
2443
2443
  id: z.string(),
2444
2444
  description: z.string(),
2445
- created: z.string().default("2025-07-02T14:35:10.278Z"),
2446
- updated: z.string().default("2025-07-02T14:35:10.278Z"),
2445
+ created: z.string().default("2025-06-24T05:41:48.250Z"),
2446
+ updated: z.string().default("2025-06-24T05:41:48.250Z"),
2447
2447
  guardrailConfig: z.union([
2448
2448
  z.lazy(() =>
2449
2449
  CreateEvalGuardrailConfigEvalsResponse200ApplicationJSONResponseBodyNumber$outboundSchema
@@ -2856,8 +2856,8 @@ export const ResponseBodyHTTP$inboundSchema: z.ZodType<
2856
2856
  > = z.object({
2857
2857
  _id: z.string(),
2858
2858
  description: z.string(),
2859
- created: z.string().default("2025-07-02T14:35:10.278Z"),
2860
- updated: z.string().default("2025-07-02T14:35:10.278Z"),
2859
+ created: z.string().default("2025-06-24T05:41:48.250Z"),
2860
+ updated: z.string().default("2025-06-24T05:41:48.250Z"),
2861
2861
  guardrail_config: z.union([
2862
2862
  z.lazy(() =>
2863
2863
  CreateEvalGuardrailConfigEvalsResponse200ApplicationJSONNumber$inboundSchema
@@ -2905,8 +2905,8 @@ export const ResponseBodyHTTP$outboundSchema: z.ZodType<
2905
2905
  > = z.object({
2906
2906
  id: z.string(),
2907
2907
  description: z.string(),
2908
- created: z.string().default("2025-07-02T14:35:10.278Z"),
2909
- updated: z.string().default("2025-07-02T14:35:10.278Z"),
2908
+ created: z.string().default("2025-06-24T05:41:48.250Z"),
2909
+ updated: z.string().default("2025-06-24T05:41:48.250Z"),
2910
2910
  guardrailConfig: z.union([
2911
2911
  z.lazy(() =>
2912
2912
  CreateEvalGuardrailConfigEvalsResponse200ApplicationJSONNumber$outboundSchema
@@ -3283,8 +3283,8 @@ export const ResponseBodyJSON$inboundSchema: z.ZodType<
3283
3283
  > = z.object({
3284
3284
  _id: z.string(),
3285
3285
  description: z.string(),
3286
- created: z.string().default("2025-07-02T14:35:10.278Z"),
3287
- updated: z.string().default("2025-07-02T14:35:10.278Z"),
3286
+ created: z.string().default("2025-06-24T05:41:48.250Z"),
3287
+ updated: z.string().default("2025-06-24T05:41:48.250Z"),
3288
3288
  guardrail_config: z.union([
3289
3289
  z.lazy(() => CreateEvalGuardrailConfigEvalsResponse200Number$inboundSchema),
3290
3290
  z.lazy(() =>
@@ -3324,8 +3324,8 @@ export const ResponseBodyJSON$outboundSchema: z.ZodType<
3324
3324
  > = z.object({
3325
3325
  id: z.string(),
3326
3326
  description: z.string(),
3327
- created: z.string().default("2025-07-02T14:35:10.278Z"),
3328
- updated: z.string().default("2025-07-02T14:35:10.278Z"),
3327
+ created: z.string().default("2025-06-24T05:41:48.250Z"),
3328
+ updated: z.string().default("2025-06-24T05:41:48.250Z"),
3329
3329
  guardrailConfig: z.union([
3330
3330
  z.lazy(() =>
3331
3331
  CreateEvalGuardrailConfigEvalsResponse200Number$outboundSchema
@@ -3680,8 +3680,8 @@ export const ResponseBodyLLM$inboundSchema: z.ZodType<
3680
3680
  > = z.object({
3681
3681
  _id: z.string(),
3682
3682
  description: z.string(),
3683
- created: z.string().default("2025-07-02T14:35:10.278Z"),
3684
- updated: z.string().default("2025-07-02T14:35:10.278Z"),
3683
+ created: z.string().default("2025-06-24T05:41:48.250Z"),
3684
+ updated: z.string().default("2025-06-24T05:41:48.250Z"),
3685
3685
  guardrail_config: z.union([
3686
3686
  z.lazy(() => CreateEvalGuardrailConfigEvalsResponseNumber$inboundSchema),
3687
3687
  z.lazy(() => CreateEvalGuardrailConfigEvalsResponseBoolean$inboundSchema),
@@ -3721,8 +3721,8 @@ export const ResponseBodyLLM$outboundSchema: z.ZodType<
3721
3721
  > = z.object({
3722
3722
  id: z.string(),
3723
3723
  description: z.string(),
3724
- created: z.string().default("2025-07-02T14:35:10.278Z"),
3725
- updated: z.string().default("2025-07-02T14:35:10.278Z"),
3724
+ created: z.string().default("2025-06-24T05:41:48.250Z"),
3725
+ updated: z.string().default("2025-06-24T05:41:48.250Z"),
3726
3726
  guardrailConfig: z.union([
3727
3727
  z.lazy(() => CreateEvalGuardrailConfigEvalsResponseNumber$outboundSchema),
3728
3728
  z.lazy(() => CreateEvalGuardrailConfigEvalsResponseBoolean$outboundSchema),
@@ -26,7 +26,7 @@ export type CreateFeedbackRequestBody = {
26
26
  */
27
27
  value: string | number | Array<string>;
28
28
  /**
29
- * The id returned by the [`get_config`](https://docs.orq.ai/reference/deploymentgetconfig-1) or [`invoke`](https://docs.orq.ai/reference/deploymentinvoke-1) endpoints
29
+ * The id returned by the [`get_config`]() or [`invoke`](https://docs.orq.ai/reference/post_deployments-invoke-1) endpoints
30
30
  */
31
31
  traceId: string;
32
32
  };
@@ -49,7 +49,7 @@ export type CreateFeedbackResponseBody = {
49
49
  */
50
50
  value: string | number | Array<string>;
51
51
  /**
52
- * The id returned by the [`get_config`](https://docs.orq.ai/reference/deploymentgetconfig-1) or [`invoke`](https://docs.orq.ai/reference/deploymentinvoke-1) endpoints
52
+ * The id returned by the [`get_config`]() or [`invoke`](https://docs.orq.ai/reference/post_deployments-invoke-1) endpoints
53
53
  */
54
54
  traceId: string;
55
55
  id: string;
@@ -110,7 +110,6 @@ export type EncodingFormat = ClosedEnum<typeof EncodingFormat>;
110
110
  * Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
111
111
  */
112
112
  export const ReasoningEffort = {
113
- Disable: "disable",
114
113
  Low: "low",
115
114
  Medium: "medium",
116
115
  High: "high",
@@ -568,7 +567,6 @@ export type CreatePromptEncodingFormat = ClosedEnum<
568
567
  * Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
569
568
  */
570
569
  export const CreatePromptReasoningEffort = {
571
- Disable: "disable",
572
570
  Low: "low",
573
571
  Medium: "medium",
574
572
  High: "high",
@@ -1492,7 +1492,6 @@ export type DeploymentGetConfigEncodingFormat = ClosedEnum<
1492
1492
  * Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
1493
1493
  */
1494
1494
  export const DeploymentGetConfigReasoningEffort = {
1495
- Disable: "disable",
1496
1495
  Low: "low",
1497
1496
  Medium: "medium",
1498
1497
  High: "high",
@@ -199,7 +199,6 @@ export type DeploymentsEncodingFormat = ClosedEnum<
199
199
  * Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
200
200
  */
201
201
  export const DeploymentsReasoningEffort = {
202
- Disable: "disable",
203
202
  Low: "low",
204
203
  Medium: "medium",
205
204
  High: "high",
@@ -146,7 +146,7 @@ export const FileGetResponseBody$inboundSchema: z.ZodType<
146
146
  file_name: z.string(),
147
147
  workspace_id: z.string(),
148
148
  created: z.string().datetime({ offset: true }).default(
149
- "2025-07-02T14:35:11.157Z",
149
+ "2025-06-24T05:41:49.240Z",
150
150
  ).transform(v => new Date(v)),
151
151
  }).transform((v) => {
152
152
  return remap$(v, {
@@ -180,7 +180,7 @@ export const FileGetResponseBody$outboundSchema: z.ZodType<
180
180
  bytes: z.number(),
181
181
  fileName: z.string(),
182
182
  workspaceId: z.string(),
183
- created: z.date().default(() => new Date("2025-07-02T14:35:11.157Z"))
183
+ created: z.date().default(() => new Date("2025-06-24T05:41:49.240Z"))
184
184
  .transform(v => v.toISOString()),
185
185
  }).transform((v) => {
186
186
  return remap$(v, {
@@ -196,7 +196,7 @@ export const FileListData$inboundSchema: z.ZodType<
196
196
  file_name: z.string(),
197
197
  workspace_id: z.string(),
198
198
  created: z.string().datetime({ offset: true }).default(
199
- "2025-07-02T14:35:11.157Z",
199
+ "2025-06-24T05:41:49.240Z",
200
200
  ).transform(v => new Date(v)),
201
201
  }).transform((v) => {
202
202
  return remap$(v, {
@@ -230,7 +230,7 @@ export const FileListData$outboundSchema: z.ZodType<
230
230
  bytes: z.number(),
231
231
  fileName: z.string(),
232
232
  workspaceId: z.string(),
233
- created: z.date().default(() => new Date("2025-07-02T14:35:11.157Z"))
233
+ created: z.date().default(() => new Date("2025-06-24T05:41:49.240Z"))
234
234
  .transform(v => v.toISOString()),
235
235
  }).transform((v) => {
236
236
  return remap$(v, {
@@ -250,7 +250,7 @@ export const FileUploadResponseBody$inboundSchema: z.ZodType<
250
250
  file_name: z.string(),
251
251
  workspace_id: z.string(),
252
252
  created: z.string().datetime({ offset: true }).default(
253
- "2025-07-02T14:35:11.157Z",
253
+ "2025-06-24T05:41:49.240Z",
254
254
  ).transform(v => new Date(v)),
255
255
  }).transform((v) => {
256
256
  return remap$(v, {
@@ -284,7 +284,7 @@ export const FileUploadResponseBody$outboundSchema: z.ZodType<
284
284
  bytes: z.number(),
285
285
  fileName: z.string(),
286
286
  workspaceId: z.string(),
287
- created: z.date().default(() => new Date("2025-07-02T14:35:11.157Z"))
287
+ created: z.date().default(() => new Date("2025-06-24T05:41:49.240Z"))
288
288
  .transform(v => v.toISOString()),
289
289
  }).transform((v) => {
290
290
  return remap$(v, {
@@ -143,7 +143,6 @@ export type GetAllPromptsEncodingFormat = ClosedEnum<
143
143
  * Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
144
144
  */
145
145
  export const GetAllPromptsReasoningEffort = {
146
- Disable: "disable",
147
146
  Low: "low",
148
147
  Medium: "medium",
149
148
  High: "high",