honeyhive 1.0.6 → 1.0.9

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 (576) hide show
  1. package/README.md +464 -401
  2. package/docs/sdks/configurations/README.md +31 -33
  3. package/docs/sdks/datapoints/README.md +21 -21
  4. package/docs/sdks/datasets/README.md +16 -10
  5. package/docs/sdks/events/README.md +83 -67
  6. package/docs/sdks/metrics/README.md +10 -10
  7. package/docs/sdks/projects/README.md +6 -6
  8. package/docs/sdks/runs/README.md +12 -12
  9. package/docs/sdks/session/README.md +21 -17
  10. package/docs/sdks/tools/README.md +11 -9
  11. package/funcs/configurationsCreateConfiguration.d.ts +1 -1
  12. package/funcs/configurationsCreateConfiguration.d.ts.map +1 -1
  13. package/funcs/configurationsCreateConfiguration.js +30 -29
  14. package/funcs/configurationsCreateConfiguration.js.map +1 -1
  15. package/funcs/configurationsDeleteConfiguration.d.ts +1 -1
  16. package/funcs/configurationsDeleteConfiguration.d.ts.map +1 -1
  17. package/funcs/configurationsDeleteConfiguration.js +35 -31
  18. package/funcs/configurationsDeleteConfiguration.js.map +1 -1
  19. package/funcs/configurationsGetConfigurations.d.ts +1 -1
  20. package/funcs/configurationsGetConfigurations.d.ts.map +1 -1
  21. package/funcs/configurationsGetConfigurations.js +35 -34
  22. package/funcs/configurationsGetConfigurations.js.map +1 -1
  23. package/funcs/configurationsUpdateConfiguration.d.ts +1 -1
  24. package/funcs/configurationsUpdateConfiguration.d.ts.map +1 -1
  25. package/funcs/configurationsUpdateConfiguration.js +37 -31
  26. package/funcs/configurationsUpdateConfiguration.js.map +1 -1
  27. package/funcs/datapointsCreateDatapoint.d.ts +1 -1
  28. package/funcs/datapointsCreateDatapoint.d.ts.map +1 -1
  29. package/funcs/datapointsCreateDatapoint.js +29 -28
  30. package/funcs/datapointsCreateDatapoint.js.map +1 -1
  31. package/funcs/datapointsDeleteDatapoint.d.ts +1 -1
  32. package/funcs/datapointsDeleteDatapoint.d.ts.map +1 -1
  33. package/funcs/datapointsDeleteDatapoint.js +34 -30
  34. package/funcs/datapointsDeleteDatapoint.js.map +1 -1
  35. package/funcs/datapointsGetDatapoint.d.ts +1 -1
  36. package/funcs/datapointsGetDatapoint.d.ts.map +1 -1
  37. package/funcs/datapointsGetDatapoint.js +34 -30
  38. package/funcs/datapointsGetDatapoint.js.map +1 -1
  39. package/funcs/datapointsGetDatapoints.d.ts +1 -1
  40. package/funcs/datapointsGetDatapoints.d.ts.map +1 -1
  41. package/funcs/datapointsGetDatapoints.js +34 -33
  42. package/funcs/datapointsGetDatapoints.js.map +1 -1
  43. package/funcs/datapointsUpdateDatapoint.d.ts +1 -1
  44. package/funcs/datapointsUpdateDatapoint.d.ts.map +1 -1
  45. package/funcs/datapointsUpdateDatapoint.js +37 -31
  46. package/funcs/datapointsUpdateDatapoint.js.map +1 -1
  47. package/funcs/datasetsAddDatapoints.d.ts +1 -1
  48. package/funcs/datasetsAddDatapoints.d.ts.map +1 -1
  49. package/funcs/datasetsAddDatapoints.js +31 -30
  50. package/funcs/datasetsAddDatapoints.js.map +1 -1
  51. package/funcs/datasetsCreateDataset.d.ts +1 -1
  52. package/funcs/datasetsCreateDataset.d.ts.map +1 -1
  53. package/funcs/datasetsCreateDataset.js +29 -28
  54. package/funcs/datasetsCreateDataset.js.map +1 -1
  55. package/funcs/datasetsDeleteDataset.d.ts +1 -1
  56. package/funcs/datasetsDeleteDataset.d.ts.map +1 -1
  57. package/funcs/datasetsDeleteDataset.js +33 -32
  58. package/funcs/datasetsDeleteDataset.js.map +1 -1
  59. package/funcs/datasetsGetDatasets.d.ts +1 -1
  60. package/funcs/datasetsGetDatasets.d.ts.map +1 -1
  61. package/funcs/datasetsGetDatasets.js +34 -33
  62. package/funcs/datasetsGetDatasets.js.map +1 -1
  63. package/funcs/datasetsUpdateDataset.d.ts +1 -1
  64. package/funcs/datasetsUpdateDataset.d.ts.map +1 -1
  65. package/funcs/datasetsUpdateDataset.js +30 -29
  66. package/funcs/datasetsUpdateDataset.js.map +1 -1
  67. package/funcs/eventsCreateEvent.d.ts +1 -1
  68. package/funcs/eventsCreateEvent.d.ts.map +1 -1
  69. package/funcs/eventsCreateEvent.js +29 -28
  70. package/funcs/eventsCreateEvent.js.map +1 -1
  71. package/funcs/eventsCreateEventBatch.d.ts +1 -1
  72. package/funcs/eventsCreateEventBatch.d.ts.map +1 -1
  73. package/funcs/eventsCreateEventBatch.js +31 -30
  74. package/funcs/eventsCreateEventBatch.js.map +1 -1
  75. package/funcs/eventsCreateModelEvent.d.ts +1 -1
  76. package/funcs/eventsCreateModelEvent.d.ts.map +1 -1
  77. package/funcs/eventsCreateModelEvent.js +29 -28
  78. package/funcs/eventsCreateModelEvent.js.map +1 -1
  79. package/funcs/eventsCreateModelEventBatch.d.ts +1 -1
  80. package/funcs/eventsCreateModelEventBatch.d.ts.map +1 -1
  81. package/funcs/eventsCreateModelEventBatch.js +31 -30
  82. package/funcs/eventsCreateModelEventBatch.js.map +1 -1
  83. package/funcs/eventsGetEvents.d.ts +1 -1
  84. package/funcs/eventsGetEvents.d.ts.map +1 -1
  85. package/funcs/eventsGetEvents.js +29 -28
  86. package/funcs/eventsGetEvents.js.map +1 -1
  87. package/funcs/eventsUpdateEvent.d.ts +1 -1
  88. package/funcs/eventsUpdateEvent.d.ts.map +1 -1
  89. package/funcs/eventsUpdateEvent.js +30 -29
  90. package/funcs/eventsUpdateEvent.js.map +1 -1
  91. package/funcs/metricsCreateMetric.d.ts +1 -1
  92. package/funcs/metricsCreateMetric.d.ts.map +1 -1
  93. package/funcs/metricsCreateMetric.js +30 -29
  94. package/funcs/metricsCreateMetric.js.map +1 -1
  95. package/funcs/metricsDeleteMetric.d.ts +1 -1
  96. package/funcs/metricsDeleteMetric.d.ts.map +1 -1
  97. package/funcs/metricsDeleteMetric.js +33 -32
  98. package/funcs/metricsDeleteMetric.js.map +1 -1
  99. package/funcs/metricsGetMetrics.d.ts +1 -1
  100. package/funcs/metricsGetMetrics.d.ts.map +1 -1
  101. package/funcs/metricsGetMetrics.js +33 -32
  102. package/funcs/metricsGetMetrics.js.map +1 -1
  103. package/funcs/metricsUpdateMetric.d.ts +1 -1
  104. package/funcs/metricsUpdateMetric.d.ts.map +1 -1
  105. package/funcs/metricsUpdateMetric.js +30 -29
  106. package/funcs/metricsUpdateMetric.js.map +1 -1
  107. package/funcs/projectsCreateProject.d.ts +1 -1
  108. package/funcs/projectsCreateProject.d.ts.map +1 -1
  109. package/funcs/projectsCreateProject.js +29 -28
  110. package/funcs/projectsCreateProject.js.map +1 -1
  111. package/funcs/projectsDeleteProject.d.ts +1 -1
  112. package/funcs/projectsDeleteProject.d.ts.map +1 -1
  113. package/funcs/projectsDeleteProject.js +33 -32
  114. package/funcs/projectsDeleteProject.js.map +1 -1
  115. package/funcs/projectsGetProjects.d.ts +1 -1
  116. package/funcs/projectsGetProjects.d.ts.map +1 -1
  117. package/funcs/projectsGetProjects.js +33 -32
  118. package/funcs/projectsGetProjects.js.map +1 -1
  119. package/funcs/projectsUpdateProject.d.ts +1 -1
  120. package/funcs/projectsUpdateProject.d.ts.map +1 -1
  121. package/funcs/projectsUpdateProject.js +30 -29
  122. package/funcs/projectsUpdateProject.js.map +1 -1
  123. package/funcs/runsCreateRun.d.ts +1 -1
  124. package/funcs/runsCreateRun.d.ts.map +1 -1
  125. package/funcs/runsCreateRun.js +29 -28
  126. package/funcs/runsCreateRun.js.map +1 -1
  127. package/funcs/runsDeleteRun.d.ts +1 -1
  128. package/funcs/runsDeleteRun.d.ts.map +1 -1
  129. package/funcs/runsDeleteRun.js +31 -30
  130. package/funcs/runsDeleteRun.js.map +1 -1
  131. package/funcs/runsGetRun.d.ts +1 -1
  132. package/funcs/runsGetRun.d.ts.map +1 -1
  133. package/funcs/runsGetRun.js +31 -30
  134. package/funcs/runsGetRun.js.map +1 -1
  135. package/funcs/runsGetRuns.d.ts +1 -1
  136. package/funcs/runsGetRuns.d.ts.map +1 -1
  137. package/funcs/runsGetRuns.js +32 -31
  138. package/funcs/runsGetRuns.js.map +1 -1
  139. package/funcs/runsUpdateRun.d.ts +1 -1
  140. package/funcs/runsUpdateRun.d.ts.map +1 -1
  141. package/funcs/runsUpdateRun.js +31 -30
  142. package/funcs/runsUpdateRun.js.map +1 -1
  143. package/funcs/sessionGetSession.d.ts +1 -1
  144. package/funcs/sessionGetSession.d.ts.map +1 -1
  145. package/funcs/sessionGetSession.js +31 -30
  146. package/funcs/sessionGetSession.js.map +1 -1
  147. package/funcs/sessionStartSession.d.ts +1 -1
  148. package/funcs/sessionStartSession.d.ts.map +1 -1
  149. package/funcs/sessionStartSession.js +29 -28
  150. package/funcs/sessionStartSession.js.map +1 -1
  151. package/funcs/toolsCreateTool.d.ts +1 -1
  152. package/funcs/toolsCreateTool.d.ts.map +1 -1
  153. package/funcs/toolsCreateTool.js +29 -28
  154. package/funcs/toolsCreateTool.js.map +1 -1
  155. package/funcs/toolsDeleteTool.d.ts +1 -1
  156. package/funcs/toolsDeleteTool.d.ts.map +1 -1
  157. package/funcs/toolsDeleteTool.js +33 -32
  158. package/funcs/toolsDeleteTool.js.map +1 -1
  159. package/funcs/toolsGetTools.d.ts +1 -1
  160. package/funcs/toolsGetTools.d.ts.map +1 -1
  161. package/funcs/toolsGetTools.js +22 -21
  162. package/funcs/toolsGetTools.js.map +1 -1
  163. package/funcs/toolsUpdateTool.d.ts +1 -1
  164. package/funcs/toolsUpdateTool.d.ts.map +1 -1
  165. package/funcs/toolsUpdateTool.js +30 -29
  166. package/funcs/toolsUpdateTool.js.map +1 -1
  167. package/hooks/hooks.d.ts +1 -1
  168. package/hooks/hooks.d.ts.map +1 -1
  169. package/hooks/hooks.js +0 -2
  170. package/hooks/hooks.js.map +1 -1
  171. package/hooks/index.d.ts +1 -1
  172. package/hooks/index.js +1 -1
  173. package/hooks/types.d.ts.map +1 -1
  174. package/index.d.ts +2 -1
  175. package/index.d.ts.map +1 -1
  176. package/index.js +15 -1
  177. package/index.js.map +1 -1
  178. package/lib/config.d.ts +4 -4
  179. package/lib/config.d.ts.map +1 -1
  180. package/lib/config.js +7 -5
  181. package/lib/config.js.map +1 -1
  182. package/lib/matchers.d.ts +1 -1
  183. package/lib/matchers.d.ts.map +1 -1
  184. package/lib/matchers.js +9 -13
  185. package/lib/matchers.js.map +1 -1
  186. package/lib/schemas.d.ts.map +1 -1
  187. package/lib/schemas.js.map +1 -1
  188. package/lib/sdks.d.ts +8 -11
  189. package/lib/sdks.d.ts.map +1 -1
  190. package/lib/sdks.js +70 -36
  191. package/lib/sdks.js.map +1 -1
  192. package/lib/security.d.ts +6 -1
  193. package/lib/security.d.ts.map +1 -1
  194. package/lib/security.js +7 -1
  195. package/lib/security.js.map +1 -1
  196. package/models/components/configuration.d.ts +1 -1
  197. package/models/components/configuration.d.ts.map +1 -1
  198. package/models/components/configuration.js +17 -24
  199. package/models/components/configuration.js.map +1 -1
  200. package/models/components/createdatapointrequest.d.ts.map +1 -1
  201. package/models/components/createdatapointrequest.js +8 -12
  202. package/models/components/createdatapointrequest.js.map +1 -1
  203. package/models/components/createdatasetrequest.d.ts +1 -1
  204. package/models/components/createdatasetrequest.d.ts.map +1 -1
  205. package/models/components/createdatasetrequest.js +7 -11
  206. package/models/components/createdatasetrequest.js.map +1 -1
  207. package/models/components/createeventrequest.d.ts +1 -1
  208. package/models/components/createeventrequest.d.ts.map +1 -1
  209. package/models/components/createeventrequest.js +14 -18
  210. package/models/components/createeventrequest.js.map +1 -1
  211. package/models/components/createmodelevent.d.ts.map +1 -1
  212. package/models/components/createmodelevent.js +9 -13
  213. package/models/components/createmodelevent.js.map +1 -1
  214. package/models/components/createprojectrequest.d.ts.map +1 -1
  215. package/models/components/createprojectrequest.js.map +1 -1
  216. package/models/components/createrunrequest.d.ts +1 -1
  217. package/models/components/createrunrequest.d.ts.map +1 -1
  218. package/models/components/createrunrequest.js +10 -13
  219. package/models/components/createrunrequest.js.map +1 -1
  220. package/models/components/createrunresponse.d.ts +1 -1
  221. package/models/components/createrunresponse.d.ts.map +1 -1
  222. package/models/components/createrunresponse.js +6 -10
  223. package/models/components/createrunresponse.js.map +1 -1
  224. package/models/components/createtoolrequest.d.ts +1 -1
  225. package/models/components/createtoolrequest.d.ts.map +1 -1
  226. package/models/components/createtoolrequest.js.map +1 -1
  227. package/models/components/datapoint.d.ts.map +1 -1
  228. package/models/components/datapoint.js +17 -33
  229. package/models/components/datapoint.js.map +1 -1
  230. package/models/components/dataset.d.ts +1 -1
  231. package/models/components/dataset.d.ts.map +1 -1
  232. package/models/components/dataset.js +16 -33
  233. package/models/components/dataset.js.map +1 -1
  234. package/models/components/datasetupdate.d.ts.map +1 -1
  235. package/models/components/datasetupdate.js +7 -11
  236. package/models/components/datasetupdate.js.map +1 -1
  237. package/models/components/deleterunresponse.d.ts.map +1 -1
  238. package/models/components/deleterunresponse.js.map +1 -1
  239. package/models/components/evaluationrun.d.ts +1 -1
  240. package/models/components/evaluationrun.d.ts.map +1 -1
  241. package/models/components/evaluationrun.js +12 -22
  242. package/models/components/evaluationrun.js.map +1 -1
  243. package/models/components/event.d.ts +5 -5
  244. package/models/components/event.d.ts.map +1 -1
  245. package/models/components/event.js +20 -22
  246. package/models/components/event.js.map +1 -1
  247. package/models/components/eventfilter.d.ts +1 -1
  248. package/models/components/eventfilter.d.ts.map +1 -1
  249. package/models/components/eventfilter.js +2 -1
  250. package/models/components/eventfilter.js.map +1 -1
  251. package/models/components/getrunresponse.d.ts +1 -1
  252. package/models/components/getrunresponse.d.ts.map +1 -1
  253. package/models/components/getrunresponse.js +1 -1
  254. package/models/components/getrunresponse.js.map +1 -1
  255. package/models/components/getrunsresponse.d.ts +1 -1
  256. package/models/components/getrunsresponse.d.ts.map +1 -1
  257. package/models/components/getrunsresponse.js +1 -1
  258. package/models/components/getrunsresponse.js.map +1 -1
  259. package/models/components/metric.d.ts +17 -5
  260. package/models/components/metric.d.ts.map +1 -1
  261. package/models/components/metric.js +22 -18
  262. package/models/components/metric.js.map +1 -1
  263. package/models/components/metricedit.d.ts +17 -5
  264. package/models/components/metricedit.d.ts.map +1 -1
  265. package/models/components/metricedit.js +19 -18
  266. package/models/components/metricedit.js.map +1 -1
  267. package/models/components/postconfigurationrequest.d.ts +1 -1
  268. package/models/components/postconfigurationrequest.d.ts.map +1 -1
  269. package/models/components/postconfigurationrequest.js +19 -32
  270. package/models/components/postconfigurationrequest.js.map +1 -1
  271. package/models/components/project.d.ts.map +1 -1
  272. package/models/components/project.js.map +1 -1
  273. package/models/components/putconfigurationrequest.d.ts +1 -1
  274. package/models/components/putconfigurationrequest.d.ts.map +1 -1
  275. package/models/components/putconfigurationrequest.js +19 -32
  276. package/models/components/putconfigurationrequest.js.map +1 -1
  277. package/models/components/security.d.ts.map +1 -1
  278. package/models/components/security.js +6 -10
  279. package/models/components/security.js.map +1 -1
  280. package/models/components/sessionstartrequest.d.ts.map +1 -1
  281. package/models/components/sessionstartrequest.js +11 -15
  282. package/models/components/sessionstartrequest.js.map +1 -1
  283. package/models/components/tool.d.ts +1 -1
  284. package/models/components/tool.d.ts.map +1 -1
  285. package/models/components/tool.js +8 -10
  286. package/models/components/tool.js.map +1 -1
  287. package/models/components/updatedatapointrequest.d.ts.map +1 -1
  288. package/models/components/updatedatapointrequest.js +8 -12
  289. package/models/components/updatedatapointrequest.js.map +1 -1
  290. package/models/components/updateprojectrequest.d.ts.map +1 -1
  291. package/models/components/updateprojectrequest.js +6 -10
  292. package/models/components/updateprojectrequest.js.map +1 -1
  293. package/models/components/updaterunrequest.d.ts +1 -1
  294. package/models/components/updaterunrequest.d.ts.map +1 -1
  295. package/models/components/updaterunrequest.js +8 -12
  296. package/models/components/updaterunrequest.js.map +1 -1
  297. package/models/components/updaterunresponse.d.ts.map +1 -1
  298. package/models/components/updaterunresponse.js.map +1 -1
  299. package/models/components/updatetoolrequest.d.ts.map +1 -1
  300. package/models/components/updatetoolrequest.js.map +1 -1
  301. package/models/errors/createeventbatch.d.ts.map +1 -1
  302. package/models/errors/createeventbatch.js +10 -17
  303. package/models/errors/createeventbatch.js.map +1 -1
  304. package/models/errors/createmodeleventbatch.d.ts.map +1 -1
  305. package/models/errors/createmodeleventbatch.js +10 -17
  306. package/models/errors/createmodeleventbatch.js.map +1 -1
  307. package/models/errors/httpclienterrors.d.ts.map +1 -1
  308. package/models/errors/httpclienterrors.js.map +1 -1
  309. package/models/errors/sdkerror.d.ts.map +1 -1
  310. package/models/errors/sdkerror.js.map +1 -1
  311. package/models/operations/adddatapoints.d.ts.map +1 -1
  312. package/models/operations/adddatapoints.js +17 -29
  313. package/models/operations/adddatapoints.js.map +1 -1
  314. package/models/operations/createdatapoint.d.ts.map +1 -1
  315. package/models/operations/createdatapoint.js.map +1 -1
  316. package/models/operations/createdataset.d.ts.map +1 -1
  317. package/models/operations/createdataset.js.map +1 -1
  318. package/models/operations/createevent.d.ts +1 -1
  319. package/models/operations/createevent.d.ts.map +1 -1
  320. package/models/operations/createevent.js +6 -10
  321. package/models/operations/createevent.js.map +1 -1
  322. package/models/operations/createeventbatch.d.ts +1 -1
  323. package/models/operations/createeventbatch.d.ts.map +1 -1
  324. package/models/operations/createeventbatch.js +12 -20
  325. package/models/operations/createeventbatch.js.map +1 -1
  326. package/models/operations/createmodelevent.d.ts +1 -1
  327. package/models/operations/createmodelevent.d.ts.map +1 -1
  328. package/models/operations/createmodelevent.js +11 -19
  329. package/models/operations/createmodelevent.js.map +1 -1
  330. package/models/operations/createmodeleventbatch.d.ts +1 -1
  331. package/models/operations/createmodeleventbatch.d.ts.map +1 -1
  332. package/models/operations/createmodeleventbatch.js +11 -19
  333. package/models/operations/createmodeleventbatch.js.map +1 -1
  334. package/models/operations/createtool.d.ts.map +1 -1
  335. package/models/operations/createtool.js +2 -1
  336. package/models/operations/createtool.js.map +1 -1
  337. package/models/operations/deleteconfiguration.d.ts.map +1 -1
  338. package/models/operations/deleteconfiguration.js.map +1 -1
  339. package/models/operations/deletedatapoint.d.ts.map +1 -1
  340. package/models/operations/deletedatapoint.js.map +1 -1
  341. package/models/operations/deletedataset.d.ts.map +1 -1
  342. package/models/operations/deletedataset.js +6 -10
  343. package/models/operations/deletedataset.js.map +1 -1
  344. package/models/operations/deletemetric.d.ts.map +1 -1
  345. package/models/operations/deletemetric.js +6 -10
  346. package/models/operations/deletemetric.js.map +1 -1
  347. package/models/operations/deleteproject.d.ts.map +1 -1
  348. package/models/operations/deleteproject.js.map +1 -1
  349. package/models/operations/deleterun.d.ts.map +1 -1
  350. package/models/operations/deleterun.js +6 -10
  351. package/models/operations/deleterun.js.map +1 -1
  352. package/models/operations/deletetool.d.ts.map +1 -1
  353. package/models/operations/deletetool.js +6 -10
  354. package/models/operations/deletetool.js.map +1 -1
  355. package/models/operations/getconfigurations.d.ts +1 -1
  356. package/models/operations/getconfigurations.d.ts.map +1 -1
  357. package/models/operations/getconfigurations.js.map +1 -1
  358. package/models/operations/getdatapoint.d.ts +1 -1
  359. package/models/operations/getdatapoint.d.ts.map +1 -1
  360. package/models/operations/getdatapoint.js +1 -1
  361. package/models/operations/getdatapoint.js.map +1 -1
  362. package/models/operations/getdatapoints.d.ts +1 -1
  363. package/models/operations/getdatapoints.d.ts.map +1 -1
  364. package/models/operations/getdatapoints.js +7 -11
  365. package/models/operations/getdatapoints.js.map +1 -1
  366. package/models/operations/getdatasets.d.ts +1 -1
  367. package/models/operations/getdatasets.d.ts.map +1 -1
  368. package/models/operations/getdatasets.js +6 -10
  369. package/models/operations/getdatasets.js.map +1 -1
  370. package/models/operations/getevents.d.ts +6 -1
  371. package/models/operations/getevents.d.ts.map +1 -1
  372. package/models/operations/getevents.js +9 -11
  373. package/models/operations/getevents.js.map +1 -1
  374. package/models/operations/getmetrics.d.ts.map +1 -1
  375. package/models/operations/getmetrics.js +6 -10
  376. package/models/operations/getmetrics.js.map +1 -1
  377. package/models/operations/getprojects.d.ts.map +1 -1
  378. package/models/operations/getprojects.js.map +1 -1
  379. package/models/operations/getrun.d.ts.map +1 -1
  380. package/models/operations/getrun.js +6 -10
  381. package/models/operations/getrun.js.map +1 -1
  382. package/models/operations/getruns.d.ts.map +1 -1
  383. package/models/operations/getruns.js.map +1 -1
  384. package/models/operations/getsession.d.ts.map +1 -1
  385. package/models/operations/getsession.js +6 -10
  386. package/models/operations/getsession.js.map +1 -1
  387. package/models/operations/startsession.d.ts +1 -1
  388. package/models/operations/startsession.d.ts.map +1 -1
  389. package/models/operations/startsession.js +6 -10
  390. package/models/operations/startsession.js.map +1 -1
  391. package/models/operations/updateconfiguration.d.ts +1 -1
  392. package/models/operations/updateconfiguration.d.ts.map +1 -1
  393. package/models/operations/updateconfiguration.js +6 -10
  394. package/models/operations/updateconfiguration.js.map +1 -1
  395. package/models/operations/updatedatapoint.d.ts +1 -1
  396. package/models/operations/updatedatapoint.d.ts.map +1 -1
  397. package/models/operations/updatedatapoint.js +6 -10
  398. package/models/operations/updatedatapoint.js.map +1 -1
  399. package/models/operations/updateevent.d.ts.map +1 -1
  400. package/models/operations/updateevent.js +7 -11
  401. package/models/operations/updateevent.js.map +1 -1
  402. package/models/operations/updaterun.d.ts +1 -1
  403. package/models/operations/updaterun.d.ts.map +1 -1
  404. package/models/operations/updaterun.js +7 -11
  405. package/models/operations/updaterun.js.map +1 -1
  406. package/package.json +3 -3
  407. package/sdk/configurations.d.ts.map +1 -1
  408. package/sdk/configurations.js.map +1 -1
  409. package/sdk/datapoints.d.ts.map +1 -1
  410. package/sdk/datapoints.js.map +1 -1
  411. package/sdk/datasets.d.ts.map +1 -1
  412. package/sdk/datasets.js.map +1 -1
  413. package/sdk/events.d.ts.map +1 -1
  414. package/sdk/events.js.map +1 -1
  415. package/sdk/metrics.d.ts.map +1 -1
  416. package/sdk/metrics.js.map +1 -1
  417. package/sdk/projects.d.ts.map +1 -1
  418. package/sdk/projects.js.map +1 -1
  419. package/sdk/runs.d.ts.map +1 -1
  420. package/sdk/runs.js.map +1 -1
  421. package/sdk/sdk.d.ts.map +1 -1
  422. package/sdk/sdk.js +9 -9
  423. package/sdk/sdk.js.map +1 -1
  424. package/sdk/session.d.ts.map +1 -1
  425. package/sdk/session.js.map +1 -1
  426. package/sdk/telemetry.js +2 -2
  427. package/sdk/telemetry.js.map +1 -1
  428. package/sdk/tools.d.ts.map +1 -1
  429. package/sdk/tools.js.map +1 -1
  430. package/sdk/tracer.d.ts +27 -6
  431. package/sdk/tracer.d.ts.map +1 -1
  432. package/sdk/tracer.js +126 -47
  433. package/sdk/tracer.js.map +1 -1
  434. package/src/funcs/configurationsCreateConfiguration.ts +86 -89
  435. package/src/funcs/configurationsDeleteConfiguration.ts +94 -93
  436. package/src/funcs/configurationsGetConfigurations.ts +97 -100
  437. package/src/funcs/configurationsUpdateConfiguration.ts +99 -96
  438. package/src/funcs/datapointsCreateDatapoint.ts +85 -88
  439. package/src/funcs/datapointsDeleteDatapoint.ts +92 -92
  440. package/src/funcs/datapointsGetDatapoint.ts +92 -92
  441. package/src/funcs/datapointsGetDatapoints.ts +96 -99
  442. package/src/funcs/datapointsUpdateDatapoint.ts +98 -96
  443. package/src/funcs/datasetsAddDatapoints.ts +95 -98
  444. package/src/funcs/datasetsCreateDataset.ts +85 -88
  445. package/src/funcs/datasetsDeleteDataset.ts +91 -94
  446. package/src/funcs/datasetsGetDatasets.ts +96 -99
  447. package/src/funcs/datasetsUpdateDataset.ts +86 -89
  448. package/src/funcs/eventsCreateEvent.ts +85 -88
  449. package/src/funcs/eventsCreateEventBatch.ts +92 -94
  450. package/src/funcs/eventsCreateModelEvent.ts +86 -88
  451. package/src/funcs/eventsCreateModelEventBatch.ts +92 -94
  452. package/src/funcs/eventsGetEvents.ts +85 -88
  453. package/src/funcs/eventsUpdateEvent.ts +86 -89
  454. package/src/funcs/metricsCreateMetric.ts +86 -89
  455. package/src/funcs/metricsDeleteMetric.ts +91 -94
  456. package/src/funcs/metricsGetMetrics.ts +91 -94
  457. package/src/funcs/metricsUpdateMetric.ts +86 -89
  458. package/src/funcs/projectsCreateProject.ts +85 -88
  459. package/src/funcs/projectsDeleteProject.ts +91 -94
  460. package/src/funcs/projectsGetProjects.ts +91 -94
  461. package/src/funcs/projectsUpdateProject.ts +86 -89
  462. package/src/funcs/runsCreateRun.ts +85 -88
  463. package/src/funcs/runsDeleteRun.ts +92 -95
  464. package/src/funcs/runsGetRun.ts +92 -95
  465. package/src/funcs/runsGetRuns.ts +90 -93
  466. package/src/funcs/runsUpdateRun.ts +95 -98
  467. package/src/funcs/sessionGetSession.ts +92 -95
  468. package/src/funcs/sessionStartSession.ts +85 -88
  469. package/src/funcs/toolsCreateTool.ts +85 -88
  470. package/src/funcs/toolsDeleteTool.ts +91 -94
  471. package/src/funcs/toolsGetTools.ts +70 -73
  472. package/src/funcs/toolsUpdateTool.ts +86 -89
  473. package/src/hooks/hooks.ts +87 -81
  474. package/src/hooks/index.ts +1 -1
  475. package/src/hooks/types.ts +58 -49
  476. package/src/index.ts +2 -1
  477. package/src/lib/config.ts +35 -33
  478. package/src/lib/files.ts +40 -0
  479. package/src/lib/matchers.ts +218 -204
  480. package/src/lib/schemas.ts +54 -42
  481. package/src/lib/sdks.ts +334 -307
  482. package/src/lib/security.ts +163 -138
  483. package/src/models/components/configuration.ts +268 -256
  484. package/src/models/components/createdatapointrequest.ts +78 -82
  485. package/src/models/components/createdatasetrequest.ts +109 -109
  486. package/src/models/components/createeventrequest.ts +186 -188
  487. package/src/models/components/createmodelevent.ts +151 -151
  488. package/src/models/components/createprojectrequest.ts +20 -20
  489. package/src/models/components/createrunrequest.ts +96 -94
  490. package/src/models/components/createrunresponse.ts +38 -39
  491. package/src/models/components/createtoolrequest.ts +54 -49
  492. package/src/models/components/datapoint.ts +123 -131
  493. package/src/models/components/dataset.ts +126 -135
  494. package/src/models/components/datasetupdate.ts +70 -70
  495. package/src/models/components/deleterunresponse.ts +23 -20
  496. package/src/models/components/evaluationrun.ts +131 -132
  497. package/src/models/components/event.ts +185 -182
  498. package/src/models/components/eventfilter.ts +69 -60
  499. package/src/models/components/getrunresponse.ts +24 -21
  500. package/src/models/components/getrunsresponse.ts +24 -21
  501. package/src/models/components/metric.ts +198 -180
  502. package/src/models/components/metricedit.ts +211 -191
  503. package/src/models/components/postconfigurationrequest.ts +251 -241
  504. package/src/models/components/project.ts +23 -18
  505. package/src/models/components/putconfigurationrequest.ts +272 -261
  506. package/src/models/components/security.ts +31 -27
  507. package/src/models/components/sessionstartrequest.ts +147 -151
  508. package/src/models/components/tool.ts +60 -60
  509. package/src/models/components/updatedatapointrequest.ts +71 -75
  510. package/src/models/components/updateprojectrequest.ts +37 -41
  511. package/src/models/components/updaterunrequest.ts +88 -86
  512. package/src/models/components/updaterunresponse.ts +29 -26
  513. package/src/models/components/updatetoolrequest.ts +31 -28
  514. package/src/models/errors/createeventbatch.ts +59 -70
  515. package/src/models/errors/createmodeleventbatch.ts +60 -70
  516. package/src/models/errors/httpclienterrors.ts +19 -19
  517. package/src/models/errors/sdkerror.ts +17 -15
  518. package/src/models/operations/adddatapoints.ts +149 -156
  519. package/src/models/operations/createdatapoint.ts +32 -32
  520. package/src/models/operations/createdataset.ts +39 -39
  521. package/src/models/operations/createevent.ts +49 -53
  522. package/src/models/operations/createeventbatch.ts +74 -82
  523. package/src/models/operations/createmodelevent.ts +61 -69
  524. package/src/models/operations/createmodeleventbatch.ts +62 -69
  525. package/src/models/operations/createtool.ts +33 -28
  526. package/src/models/operations/deleteconfiguration.ts +19 -19
  527. package/src/models/operations/deletedatapoint.ts +35 -35
  528. package/src/models/operations/deletedataset.ts +32 -36
  529. package/src/models/operations/deletemetric.ts +29 -33
  530. package/src/models/operations/deleteproject.ts +16 -16
  531. package/src/models/operations/deleterun.ts +30 -30
  532. package/src/models/operations/deletetool.ts +30 -31
  533. package/src/models/operations/getconfigurations.ts +43 -42
  534. package/src/models/operations/getdatapoint.ts +36 -36
  535. package/src/models/operations/getdatapoints.ts +64 -68
  536. package/src/models/operations/getdatasets.ts +73 -74
  537. package/src/models/operations/getevents.ts +114 -103
  538. package/src/models/operations/getmetrics.ts +33 -34
  539. package/src/models/operations/getprojects.ts +16 -16
  540. package/src/models/operations/getrun.ts +30 -30
  541. package/src/models/operations/getruns.ts +19 -16
  542. package/src/models/operations/getsession.ts +30 -31
  543. package/src/models/operations/startsession.ts +45 -49
  544. package/src/models/operations/updateconfiguration.ts +36 -40
  545. package/src/models/operations/updatedatapoint.ts +36 -40
  546. package/src/models/operations/updateevent.ts +59 -63
  547. package/src/models/operations/updaterun.ts +36 -36
  548. package/src/sdk/configurations.ts +58 -38
  549. package/src/sdk/datapoints.ts +71 -50
  550. package/src/sdk/datasets.ts +71 -45
  551. package/src/sdk/events.ts +90 -66
  552. package/src/sdk/metrics.ts +64 -39
  553. package/src/sdk/projects.ts +52 -33
  554. package/src/sdk/runs.ts +67 -43
  555. package/src/sdk/sdk.ts +44 -44
  556. package/src/sdk/session.ts +26 -15
  557. package/src/sdk/telemetry.ts +2 -2
  558. package/src/sdk/tools.ts +50 -30
  559. package/src/sdk/tracer.ts +148 -45
  560. package/src/types/index.ts +4 -4
  561. package/src/types/streams.ts +21 -0
  562. package/tests/agent_script.ts +2 -2
  563. package/tests/enrich_span.ts +111 -0
  564. package/tests/tracer.test.ts +7 -10
  565. package/types/index.d.ts +4 -4
  566. package/types/index.d.ts.map +1 -1
  567. package/types/index.js +5 -5
  568. package/types/index.js.map +1 -1
  569. package/sdk/custom_tracer.d.ts +0 -2
  570. package/sdk/custom_tracer.d.ts.map +0 -1
  571. package/sdk/custom_tracer.js +0 -68
  572. package/sdk/custom_tracer.js.map +0 -1
  573. package/sdk/evaluation.d.ts +0 -35
  574. package/sdk/evaluation.d.ts.map +0 -1
  575. package/sdk/evaluation.js +0 -167
  576. package/sdk/evaluation.js.map +0 -1
package/README.md CHANGED
@@ -1,8 +1,32 @@
1
1
  # HoneyHive
2
2
 
3
+ <!-- Start Summary [summary] -->
4
+ ## Summary
5
+
6
+
7
+ <!-- End Summary [summary] -->
8
+
9
+ <!-- Start Table of Contents [toc] -->
10
+ ## Table of Contents
11
+
12
+ * [SDK Installation](#sdk-installation)
13
+ * [Requirements](#requirements)
14
+ * [SDK Example Usage](#sdk-example-usage)
15
+ * [Available Resources and Operations](#available-resources-and-operations)
16
+ * [Standalone functions](#standalone-functions)
17
+ * [Retries](#retries)
18
+ * [Error Handling](#error-handling)
19
+ * [Server Selection](#server-selection)
20
+ * [Custom HTTP Client](#custom-http-client)
21
+ * [Authentication](#authentication)
22
+ * [Debugging](#debugging)
23
+ <!-- End Table of Contents [toc] -->
24
+
3
25
  <!-- Start SDK Installation [installation] -->
4
26
  ## SDK Installation
5
27
 
28
+ The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
29
+
6
30
  ### NPM
7
31
 
8
32
  ```bash
@@ -40,51 +64,55 @@ yarn add https://github.com/honeyhiveai/typescript-sdk zod
40
64
  import { HoneyHive } from "honeyhive";
41
65
 
42
66
  const honeyHive = new HoneyHive({
43
- bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
67
+ bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
44
68
  });
45
69
 
46
70
  async function run() {
47
- const result = await honeyHive.session.startSession({
48
- session: {
49
- project: "Simple RAG Project",
50
- sessionName: "Playground Session",
51
- source: "playground",
52
- sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
53
- childrenIds: ["7f22137a-6911-4ed3-bc36-110f1dde6b66"],
54
- inputs: {
55
- context: "Hello world",
56
- question: "What is in the context?",
57
- chat_history: [
58
- {
59
- role: "system",
60
- content:
61
- "Answer the user's question only using provided context. Context: Hello world",
62
- },
63
- {
64
- role: "user",
65
- content: "What is in the context?",
66
- },
67
- ],
68
- },
69
- outputs: {
70
- role: "assistant",
71
- content: "Hello world",
72
- },
73
- error: null,
74
- duration: 824.8056,
75
- userProperties: {
76
- user: "google-oauth2|111840237613341303366",
77
- },
78
- metrics: {},
79
- feedback: {},
80
- metadata: {},
81
- startTime: 1712025501605,
82
- endTime: 1712025499832,
83
- },
84
- });
71
+ const result = await honeyHive.session.startSession({
72
+ session: {
73
+ project: "Simple RAG Project",
74
+ sessionName: "Playground Session",
75
+ source: "playground",
76
+ sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
77
+ childrenIds: [
78
+ "7f22137a-6911-4ed3-bc36-110f1dde6b66",
79
+ ],
80
+ inputs: {
81
+ "chat_history": [
82
+ {
83
+ "role": "system",
84
+ "content":
85
+ "Answer the user's question only using provided context.\n"
86
+ + "\n"
87
+ + "Context: Hello world",
88
+ },
89
+ {
90
+ "role": "user",
91
+ "content": "What is in the context?",
92
+ },
93
+ ],
94
+ "context": "Hello world",
95
+ "question": "What is in the context?",
96
+ },
97
+ outputs: {
98
+ "content": "Hello world",
99
+ "role": "assistant",
100
+ },
101
+ error: "<value>",
102
+ duration: 824.8056,
103
+ userProperties: {
104
+ "user": "google-oauth2|111840237613341303366",
105
+ },
106
+ metrics: {},
107
+ feedback: {},
108
+ metadata: {},
109
+ startTime: 1712025501605,
110
+ endTime: 1712025499832,
111
+ },
112
+ });
85
113
 
86
- // Handle the result
87
- console.log(result);
114
+ // Handle the result
115
+ console.log(result);
88
116
  }
89
117
 
90
118
  run();
@@ -95,33 +123,15 @@ run();
95
123
  <!-- Start Available Resources and Operations [operations] -->
96
124
  ## Available Resources and Operations
97
125
 
98
- ### [session](docs/sdks/session/README.md)
99
-
100
- * [startSession](docs/sdks/session/README.md#startsession) - Start a new session
101
- * [getSession](docs/sdks/session/README.md#getsession) - Retrieve a session
126
+ <details open>
127
+ <summary>Available methods</summary>
102
128
 
103
- ### [events](docs/sdks/events/README.md)
104
-
105
- * [createEvent](docs/sdks/events/README.md#createevent) - Create a new event
106
- * [updateEvent](docs/sdks/events/README.md#updateevent) - Update an event
107
- * [getEvents](docs/sdks/events/README.md#getevents) - Retrieve events based on filters
108
- * [createModelEvent](docs/sdks/events/README.md#createmodelevent) - Create a new model event
109
- * [createEventBatch](docs/sdks/events/README.md#createeventbatch) - Create a batch of events
110
- * [createModelEventBatch](docs/sdks/events/README.md#createmodeleventbatch) - Create a batch of model events
111
-
112
- ### [metrics](docs/sdks/metrics/README.md)
113
-
114
- * [getMetrics](docs/sdks/metrics/README.md#getmetrics) - Get all metrics
115
- * [createMetric](docs/sdks/metrics/README.md#createmetric) - Create a new metric
116
- * [updateMetric](docs/sdks/metrics/README.md#updatemetric) - Update an existing metric
117
- * [deleteMetric](docs/sdks/metrics/README.md#deletemetric) - Delete a metric
118
-
119
- ### [tools](docs/sdks/tools/README.md)
129
+ ### [configurations](docs/sdks/configurations/README.md)
120
130
 
121
- * [getTools](docs/sdks/tools/README.md#gettools) - Retrieve a list of tools
122
- * [createTool](docs/sdks/tools/README.md#createtool) - Create a new tool
123
- * [updateTool](docs/sdks/tools/README.md#updatetool) - Update an existing tool
124
- * [deleteTool](docs/sdks/tools/README.md#deletetool) - Delete a tool
131
+ * [getConfigurations](docs/sdks/configurations/README.md#getconfigurations) - Retrieve a list of configurations
132
+ * [createConfiguration](docs/sdks/configurations/README.md#createconfiguration) - Create a new configuration
133
+ * [updateConfiguration](docs/sdks/configurations/README.md#updateconfiguration) - Update an existing configuration
134
+ * [deleteConfiguration](docs/sdks/configurations/README.md#deleteconfiguration) - Delete a configuration
125
135
 
126
136
  ### [datapoints](docs/sdks/datapoints/README.md)
127
137
 
@@ -139,6 +149,23 @@ run();
139
149
  * [deleteDataset](docs/sdks/datasets/README.md#deletedataset) - Delete a dataset
140
150
  * [addDatapoints](docs/sdks/datasets/README.md#adddatapoints) - Add datapoints to a dataset
141
151
 
152
+ ### [events](docs/sdks/events/README.md)
153
+
154
+ * [createEvent](docs/sdks/events/README.md#createevent) - Create a new event
155
+ * [updateEvent](docs/sdks/events/README.md#updateevent) - Update an event
156
+ * [getEvents](docs/sdks/events/README.md#getevents) - Retrieve events based on filters
157
+ * [createModelEvent](docs/sdks/events/README.md#createmodelevent) - Create a new model event
158
+ * [createEventBatch](docs/sdks/events/README.md#createeventbatch) - Create a batch of events
159
+ * [createModelEventBatch](docs/sdks/events/README.md#createmodeleventbatch) - Create a batch of model events
160
+
161
+
162
+ ### [metrics](docs/sdks/metrics/README.md)
163
+
164
+ * [getMetrics](docs/sdks/metrics/README.md#getmetrics) - Get all metrics
165
+ * [createMetric](docs/sdks/metrics/README.md#createmetric) - Create a new metric
166
+ * [updateMetric](docs/sdks/metrics/README.md#updatemetric) - Update an existing metric
167
+ * [deleteMetric](docs/sdks/metrics/README.md#deletemetric) - Delete a metric
168
+
142
169
  ### [projects](docs/sdks/projects/README.md)
143
170
 
144
171
  * [getProjects](docs/sdks/projects/README.md#getprojects) - Get a list of projects
@@ -154,12 +181,19 @@ run();
154
181
  * [updateRun](docs/sdks/runs/README.md#updaterun) - Update an evaluation run
155
182
  * [deleteRun](docs/sdks/runs/README.md#deleterun) - Delete an evaluation run
156
183
 
157
- ### [configurations](docs/sdks/configurations/README.md)
184
+ ### [session](docs/sdks/session/README.md)
158
185
 
159
- * [getConfigurations](docs/sdks/configurations/README.md#getconfigurations) - Retrieve a list of configurations
160
- * [createConfiguration](docs/sdks/configurations/README.md#createconfiguration) - Create a new configuration
161
- * [updateConfiguration](docs/sdks/configurations/README.md#updateconfiguration) - Update an existing configuration
162
- * [deleteConfiguration](docs/sdks/configurations/README.md#deleteconfiguration) - Delete a configuration
186
+ * [startSession](docs/sdks/session/README.md#startsession) - Start a new session
187
+ * [getSession](docs/sdks/session/README.md#getsession) - Retrieve a session
188
+
189
+ ### [tools](docs/sdks/tools/README.md)
190
+
191
+ * [getTools](docs/sdks/tools/README.md#gettools) - Retrieve a list of tools
192
+ * [createTool](docs/sdks/tools/README.md#createtool) - Create a new tool
193
+ * [updateTool](docs/sdks/tools/README.md#updatetool) - Update an existing tool
194
+ * [deleteTool](docs/sdks/tools/README.md#deletetool) - Delete a tool
195
+
196
+ </details>
163
197
  <!-- End Available Resources and Operations [operations] -->
164
198
 
165
199
  <!-- Start Error Handling [errors] -->
@@ -177,115 +211,127 @@ Validation errors can also occur when either method arguments or data returned f
177
211
 
178
212
  ```typescript
179
213
  import { HoneyHive } from "honeyhive";
180
- import { SDKValidationError } from "honeyhive/models/errors";
214
+ import {
215
+ CreateEventBatchResponseBody,
216
+ SDKValidationError,
217
+ } from "honeyhive/models/errors";
181
218
 
182
219
  const honeyHive = new HoneyHive({
183
- bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
220
+ bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
184
221
  });
185
222
 
186
223
  async function run() {
187
- let result;
188
- try {
189
- result = await honeyHive.events.createEventBatch({
190
- events: [
191
- {
192
- project: "Simple RAG",
193
- source: "playground",
194
- eventName: "Model Completion",
195
- eventType: "model",
196
- eventId: "7f22137a-6911-4ed3-bc36-110f1dde6b66",
197
- sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
198
- parentId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
199
- childrenIds: ["<value>"],
200
- config: {
201
- model: "gpt-3.5-turbo",
202
- version: "v0.1",
203
- provider: "openai",
204
- hyperparameters: {
205
- temperature: 0,
206
- top_p: 1,
207
- max_tokens: 1000,
208
- presence_penalty: 0,
209
- frequency_penalty: 0,
210
- stop: ["<value>"],
211
- n: 1,
212
- },
213
- template: [
214
- {
215
- role: "system",
216
- content:
217
- "Answer the user's question only using provided context. Context: {{ context }}",
218
- },
219
- {
220
- role: "user",
221
- content: "{{question}}",
222
- },
223
- ],
224
- type: "chat",
225
- },
226
- inputs: {
227
- context: "Hello world",
228
- question: "What is in the context?",
229
- chat_history: [
230
- {
231
- role: "system",
232
- content:
233
- "Answer the user's question only using provided context. Context: Hello world",
234
- },
235
- {
236
- role: "user",
237
- content: "What is in the context?",
238
- },
239
- ],
240
- },
241
- outputs: {
242
- role: "assistant",
243
- content: "Hello world",
244
- },
245
- error: null,
246
- startTime: 1714978764301,
247
- endTime: 1714978765301,
248
- duration: 999.8056,
249
- metadata: {
250
- cost: 0.00008,
251
- completion_tokens: 23,
252
- prompt_tokens: 35,
253
- total_tokens: 58,
254
- },
255
- feedback: {},
256
- metrics: {
257
- "Answer Faithfulness": 5,
258
- "Answer Faithfulness_explanation":
259
- "The AI assistant's answer is a concise and accurate description of Ramp's API. It provides a clear explanation of what the API does and how developers can use it to integrate Ramp's financial services into their own applications. The answer is faithful to the provided context.",
260
- "Number of words": 18,
261
- },
262
- userProperties: {
263
- user: "google-oauth2|111840237613341303366",
264
- },
265
- },
224
+ let result;
225
+ try {
226
+ result = await honeyHive.events.createEventBatch({
227
+ events: [
228
+ {
229
+ project: "Simple RAG",
230
+ source: "playground",
231
+ eventName: "Model Completion",
232
+ eventType: "model",
233
+ eventId: "7f22137a-6911-4ed3-bc36-110f1dde6b66",
234
+ sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
235
+ parentId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
236
+ childrenIds: [
237
+ "<value>",
238
+ ],
239
+ config: {
240
+ "model": "gpt-3.5-turbo",
241
+ "version": "v0.1",
242
+ "provider": "openai",
243
+ "hyperparameters": {
244
+ "temperature": 0,
245
+ "top_p": 1,
246
+ "max_tokens": 1000,
247
+ "presence_penalty": 0,
248
+ "frequency_penalty": 0,
249
+ "stop": [
250
+ "<value>",
251
+ ],
252
+ "n": 1,
253
+ },
254
+ "template": [
255
+ {
256
+ "role": "system",
257
+ "content":
258
+ "Answer the user's question only using provided context.\n"
259
+ + "\n"
260
+ + "Context: {{ context }}",
261
+ },
262
+ {
263
+ "role": "user",
264
+ "content": "{{question}}",
265
+ },
266
266
  ],
267
- });
268
- } catch (err) {
269
- switch (true) {
270
- case err instanceof SDKValidationError: {
271
- // Validation errors can be pretty-printed
272
- console.error(err.pretty());
273
- // Raw value may also be inspected
274
- console.error(err.rawValue);
275
- return;
276
- }
277
- case err instanceof errors.CreateEventBatchResponseBody: {
278
- console.error(err); // handle exception
279
- return;
280
- }
281
- default: {
282
- throw err;
283
- }
284
- }
285
- }
267
+ "type": "chat",
268
+ },
269
+ inputs: {
270
+ "context": "Hello world",
271
+ "question": "What is in the context?",
272
+ "chat_history": [
273
+ {
274
+ "role": "system",
275
+ "content":
276
+ "Answer the user's question only using provided context.\n"
277
+ + "\n"
278
+ + "Context: Hello world",
279
+ },
280
+ {
281
+ "role": "user",
282
+ "content": "What is in the context?",
283
+ },
284
+ ],
285
+ },
286
+ outputs: {
287
+ "role": "assistant",
288
+ "content": "Hello world",
289
+ },
290
+ error: "<value>",
291
+ startTime: 1714978764301,
292
+ endTime: 1714978765301,
293
+ duration: 999.8056,
294
+ metadata: {
295
+ "cost": 0.00008,
296
+ "completion_tokens": 23,
297
+ "prompt_tokens": 35,
298
+ "total_tokens": 58,
299
+ },
300
+ feedback: {},
301
+ metrics: {
302
+ "Answer Faithfulness": 5,
303
+ "Answer Faithfulness_explanation":
304
+ "The AI assistant's answer is a concise and accurate description of Ramp's API. It provides a clear explanation of what the API does and how developers can use it to integrate Ramp's financial services into their own applications. The answer is faithful to the provided context.",
305
+ "Number of words": 18,
306
+ },
307
+ userProperties: {
308
+ "user": "google-oauth2|111840237613341303366",
309
+ },
310
+ },
311
+ ],
312
+ });
286
313
 
287
314
  // Handle the result
288
315
  console.log(result);
316
+ } catch (err) {
317
+ switch (true) {
318
+ case (err instanceof SDKValidationError): {
319
+ // Validation errors can be pretty-printed
320
+ console.error(err.pretty());
321
+ // Raw value may also be inspected
322
+ console.error(err.rawValue);
323
+ return;
324
+ }
325
+ case (err instanceof CreateEventBatchResponseBody): {
326
+ // Handle err.data$: CreateEventBatchResponseBodyData
327
+ console.error(err);
328
+ return;
329
+ }
330
+ default: {
331
+ throw err;
332
+ }
333
+ }
334
+ }
289
335
  }
290
336
 
291
337
  run();
@@ -308,52 +354,56 @@ You can override the default server globally by passing a server index to the `s
308
354
  import { HoneyHive } from "honeyhive";
309
355
 
310
356
  const honeyHive = new HoneyHive({
311
- serverIdx: 0,
312
- bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
357
+ serverIdx: 0,
358
+ bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
313
359
  });
314
360
 
315
361
  async function run() {
316
- const result = await honeyHive.session.startSession({
317
- session: {
318
- project: "Simple RAG Project",
319
- sessionName: "Playground Session",
320
- source: "playground",
321
- sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
322
- childrenIds: ["7f22137a-6911-4ed3-bc36-110f1dde6b66"],
323
- inputs: {
324
- context: "Hello world",
325
- question: "What is in the context?",
326
- chat_history: [
327
- {
328
- role: "system",
329
- content:
330
- "Answer the user's question only using provided context. Context: Hello world",
331
- },
332
- {
333
- role: "user",
334
- content: "What is in the context?",
335
- },
336
- ],
337
- },
338
- outputs: {
339
- role: "assistant",
340
- content: "Hello world",
341
- },
342
- error: null,
343
- duration: 824.8056,
344
- userProperties: {
345
- user: "google-oauth2|111840237613341303366",
346
- },
347
- metrics: {},
348
- feedback: {},
349
- metadata: {},
350
- startTime: 1712025501605,
351
- endTime: 1712025499832,
352
- },
353
- });
362
+ const result = await honeyHive.session.startSession({
363
+ session: {
364
+ project: "Simple RAG Project",
365
+ sessionName: "Playground Session",
366
+ source: "playground",
367
+ sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
368
+ childrenIds: [
369
+ "7f22137a-6911-4ed3-bc36-110f1dde6b66",
370
+ ],
371
+ inputs: {
372
+ "chat_history": [
373
+ {
374
+ "role": "system",
375
+ "content":
376
+ "Answer the user's question only using provided context.\n"
377
+ + "\n"
378
+ + "Context: Hello world",
379
+ },
380
+ {
381
+ "role": "user",
382
+ "content": "What is in the context?",
383
+ },
384
+ ],
385
+ "context": "Hello world",
386
+ "question": "What is in the context?",
387
+ },
388
+ outputs: {
389
+ "content": "Hello world",
390
+ "role": "assistant",
391
+ },
392
+ error: "<value>",
393
+ duration: 824.8056,
394
+ userProperties: {
395
+ "user": "google-oauth2|111840237613341303366",
396
+ },
397
+ metrics: {},
398
+ feedback: {},
399
+ metadata: {},
400
+ startTime: 1712025501605,
401
+ endTime: 1712025499832,
402
+ },
403
+ });
354
404
 
355
- // Handle the result
356
- console.log(result);
405
+ // Handle the result
406
+ console.log(result);
357
407
  }
358
408
 
359
409
  run();
@@ -369,52 +419,56 @@ The default server can also be overridden globally by passing a URL to the `serv
369
419
  import { HoneyHive } from "honeyhive";
370
420
 
371
421
  const honeyHive = new HoneyHive({
372
- serverURL: "https://api.honeyhive.ai",
373
- bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
422
+ serverURL: "https://api.honeyhive.ai",
423
+ bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
374
424
  });
375
425
 
376
426
  async function run() {
377
- const result = await honeyHive.session.startSession({
378
- session: {
379
- project: "Simple RAG Project",
380
- sessionName: "Playground Session",
381
- source: "playground",
382
- sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
383
- childrenIds: ["7f22137a-6911-4ed3-bc36-110f1dde6b66"],
384
- inputs: {
385
- context: "Hello world",
386
- question: "What is in the context?",
387
- chat_history: [
388
- {
389
- role: "system",
390
- content:
391
- "Answer the user's question only using provided context. Context: Hello world",
392
- },
393
- {
394
- role: "user",
395
- content: "What is in the context?",
396
- },
397
- ],
398
- },
399
- outputs: {
400
- role: "assistant",
401
- content: "Hello world",
402
- },
403
- error: null,
404
- duration: 824.8056,
405
- userProperties: {
406
- user: "google-oauth2|111840237613341303366",
407
- },
408
- metrics: {},
409
- feedback: {},
410
- metadata: {},
411
- startTime: 1712025501605,
412
- endTime: 1712025499832,
413
- },
414
- });
427
+ const result = await honeyHive.session.startSession({
428
+ session: {
429
+ project: "Simple RAG Project",
430
+ sessionName: "Playground Session",
431
+ source: "playground",
432
+ sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
433
+ childrenIds: [
434
+ "7f22137a-6911-4ed3-bc36-110f1dde6b66",
435
+ ],
436
+ inputs: {
437
+ "chat_history": [
438
+ {
439
+ "role": "system",
440
+ "content":
441
+ "Answer the user's question only using provided context.\n"
442
+ + "\n"
443
+ + "Context: Hello world",
444
+ },
445
+ {
446
+ "role": "user",
447
+ "content": "What is in the context?",
448
+ },
449
+ ],
450
+ "context": "Hello world",
451
+ "question": "What is in the context?",
452
+ },
453
+ outputs: {
454
+ "content": "Hello world",
455
+ "role": "assistant",
456
+ },
457
+ error: "<value>",
458
+ duration: 824.8056,
459
+ userProperties: {
460
+ "user": "google-oauth2|111840237613341303366",
461
+ },
462
+ metrics: {},
463
+ feedback: {},
464
+ metadata: {},
465
+ startTime: 1712025501605,
466
+ endTime: 1712025499832,
467
+ },
468
+ });
415
469
 
416
- // Handle the result
417
- console.log(result);
470
+ // Handle the result
471
+ console.log(result);
418
472
  }
419
473
 
420
474
  run();
@@ -487,51 +541,55 @@ To authenticate with the API the `bearerAuth` parameter must be set when initial
487
541
  import { HoneyHive } from "honeyhive";
488
542
 
489
543
  const honeyHive = new HoneyHive({
490
- bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
544
+ bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
491
545
  });
492
546
 
493
547
  async function run() {
494
- const result = await honeyHive.session.startSession({
495
- session: {
496
- project: "Simple RAG Project",
497
- sessionName: "Playground Session",
498
- source: "playground",
499
- sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
500
- childrenIds: ["7f22137a-6911-4ed3-bc36-110f1dde6b66"],
501
- inputs: {
502
- context: "Hello world",
503
- question: "What is in the context?",
504
- chat_history: [
505
- {
506
- role: "system",
507
- content:
508
- "Answer the user's question only using provided context. Context: Hello world",
509
- },
510
- {
511
- role: "user",
512
- content: "What is in the context?",
513
- },
514
- ],
515
- },
516
- outputs: {
517
- role: "assistant",
518
- content: "Hello world",
519
- },
520
- error: null,
521
- duration: 824.8056,
522
- userProperties: {
523
- user: "google-oauth2|111840237613341303366",
524
- },
525
- metrics: {},
526
- feedback: {},
527
- metadata: {},
528
- startTime: 1712025501605,
529
- endTime: 1712025499832,
530
- },
531
- });
548
+ const result = await honeyHive.session.startSession({
549
+ session: {
550
+ project: "Simple RAG Project",
551
+ sessionName: "Playground Session",
552
+ source: "playground",
553
+ sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
554
+ childrenIds: [
555
+ "7f22137a-6911-4ed3-bc36-110f1dde6b66",
556
+ ],
557
+ inputs: {
558
+ "chat_history": [
559
+ {
560
+ "role": "system",
561
+ "content":
562
+ "Answer the user's question only using provided context.\n"
563
+ + "\n"
564
+ + "Context: Hello world",
565
+ },
566
+ {
567
+ "role": "user",
568
+ "content": "What is in the context?",
569
+ },
570
+ ],
571
+ "context": "Hello world",
572
+ "question": "What is in the context?",
573
+ },
574
+ outputs: {
575
+ "content": "Hello world",
576
+ "role": "assistant",
577
+ },
578
+ error: "<value>",
579
+ duration: 824.8056,
580
+ userProperties: {
581
+ "user": "google-oauth2|111840237613341303366",
582
+ },
583
+ metrics: {},
584
+ feedback: {},
585
+ metadata: {},
586
+ startTime: 1712025501605,
587
+ endTime: 1712025499832,
588
+ },
589
+ });
532
590
 
533
- // Handle the result
534
- console.log(result);
591
+ // Handle the result
592
+ console.log(result);
535
593
  }
536
594
 
537
595
  run();
@@ -614,65 +672,66 @@ To change the default retry strategy for a single API call, simply provide a ret
614
672
  import { HoneyHive } from "honeyhive";
615
673
 
616
674
  const honeyHive = new HoneyHive({
617
- bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
675
+ bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
618
676
  });
619
677
 
620
678
  async function run() {
621
- const result = await honeyHive.session.startSession(
622
- {
623
- session: {
624
- project: "Simple RAG Project",
625
- sessionName: "Playground Session",
626
- source: "playground",
627
- sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
628
- childrenIds: ["7f22137a-6911-4ed3-bc36-110f1dde6b66"],
629
- inputs: {
630
- context: "Hello world",
631
- question: "What is in the context?",
632
- chat_history: [
633
- {
634
- role: "system",
635
- content:
636
- "Answer the user's question only using provided context. Context: Hello world",
637
- },
638
- {
639
- role: "user",
640
- content: "What is in the context?",
641
- },
642
- ],
643
- },
644
- outputs: {
645
- role: "assistant",
646
- content: "Hello world",
647
- },
648
- error: null,
649
- duration: 824.8056,
650
- userProperties: {
651
- user: "google-oauth2|111840237613341303366",
652
- },
653
- metrics: {},
654
- feedback: {},
655
- metadata: {},
656
- startTime: 1712025501605,
657
- endTime: 1712025499832,
658
- },
659
- },
660
- {
661
- retries: {
662
- strategy: "backoff",
663
- backoff: {
664
- initialInterval: 1,
665
- maxInterval: 50,
666
- exponent: 1.1,
667
- maxElapsedTime: 100,
668
- },
669
- retryConnectionErrors: false,
670
- },
671
- }
672
- );
679
+ const result = await honeyHive.session.startSession({
680
+ session: {
681
+ project: "Simple RAG Project",
682
+ sessionName: "Playground Session",
683
+ source: "playground",
684
+ sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
685
+ childrenIds: [
686
+ "7f22137a-6911-4ed3-bc36-110f1dde6b66",
687
+ ],
688
+ inputs: {
689
+ "chat_history": [
690
+ {
691
+ "role": "system",
692
+ "content":
693
+ "Answer the user's question only using provided context.\n"
694
+ + "\n"
695
+ + "Context: Hello world",
696
+ },
697
+ {
698
+ "role": "user",
699
+ "content": "What is in the context?",
700
+ },
701
+ ],
702
+ "context": "Hello world",
703
+ "question": "What is in the context?",
704
+ },
705
+ outputs: {
706
+ "content": "Hello world",
707
+ "role": "assistant",
708
+ },
709
+ error: "<value>",
710
+ duration: 824.8056,
711
+ userProperties: {
712
+ "user": "google-oauth2|111840237613341303366",
713
+ },
714
+ metrics: {},
715
+ feedback: {},
716
+ metadata: {},
717
+ startTime: 1712025501605,
718
+ endTime: 1712025499832,
719
+ },
720
+ }, {
721
+ retries: {
722
+ strategy: "backoff",
723
+ backoff: {
724
+ initialInterval: 1,
725
+ maxInterval: 50,
726
+ exponent: 1.1,
727
+ maxElapsedTime: 100,
728
+ },
729
+ retryConnectionErrors: false,
730
+ },
731
+ });
673
732
 
674
- // Handle the result
675
- console.log(result);
733
+ // Handle the result
734
+ console.log(result);
676
735
  }
677
736
 
678
737
  run();
@@ -684,61 +743,65 @@ If you'd like to override the default retry strategy for all operations that sup
684
743
  import { HoneyHive } from "honeyhive";
685
744
 
686
745
  const honeyHive = new HoneyHive({
687
- retryConfig: {
688
- strategy: "backoff",
689
- backoff: {
690
- initialInterval: 1,
691
- maxInterval: 50,
692
- exponent: 1.1,
693
- maxElapsedTime: 100,
694
- },
695
- retryConnectionErrors: false,
746
+ retryConfig: {
747
+ strategy: "backoff",
748
+ backoff: {
749
+ initialInterval: 1,
750
+ maxInterval: 50,
751
+ exponent: 1.1,
752
+ maxElapsedTime: 100,
696
753
  },
697
- bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
754
+ retryConnectionErrors: false,
755
+ },
756
+ bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
698
757
  });
699
758
 
700
759
  async function run() {
701
- const result = await honeyHive.session.startSession({
702
- session: {
703
- project: "Simple RAG Project",
704
- sessionName: "Playground Session",
705
- source: "playground",
706
- sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
707
- childrenIds: ["7f22137a-6911-4ed3-bc36-110f1dde6b66"],
708
- inputs: {
709
- context: "Hello world",
710
- question: "What is in the context?",
711
- chat_history: [
712
- {
713
- role: "system",
714
- content:
715
- "Answer the user's question only using provided context. Context: Hello world",
716
- },
717
- {
718
- role: "user",
719
- content: "What is in the context?",
720
- },
721
- ],
722
- },
723
- outputs: {
724
- role: "assistant",
725
- content: "Hello world",
726
- },
727
- error: null,
728
- duration: 824.8056,
729
- userProperties: {
730
- user: "google-oauth2|111840237613341303366",
731
- },
732
- metrics: {},
733
- feedback: {},
734
- metadata: {},
735
- startTime: 1712025501605,
736
- endTime: 1712025499832,
737
- },
738
- });
760
+ const result = await honeyHive.session.startSession({
761
+ session: {
762
+ project: "Simple RAG Project",
763
+ sessionName: "Playground Session",
764
+ source: "playground",
765
+ sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
766
+ childrenIds: [
767
+ "7f22137a-6911-4ed3-bc36-110f1dde6b66",
768
+ ],
769
+ inputs: {
770
+ "chat_history": [
771
+ {
772
+ "role": "system",
773
+ "content":
774
+ "Answer the user's question only using provided context.\n"
775
+ + "\n"
776
+ + "Context: Hello world",
777
+ },
778
+ {
779
+ "role": "user",
780
+ "content": "What is in the context?",
781
+ },
782
+ ],
783
+ "context": "Hello world",
784
+ "question": "What is in the context?",
785
+ },
786
+ outputs: {
787
+ "content": "Hello world",
788
+ "role": "assistant",
789
+ },
790
+ error: "<value>",
791
+ duration: 824.8056,
792
+ userProperties: {
793
+ "user": "google-oauth2|111840237613341303366",
794
+ },
795
+ metrics: {},
796
+ feedback: {},
797
+ metadata: {},
798
+ startTime: 1712025501605,
799
+ endTime: 1712025499832,
800
+ },
801
+ });
739
802
 
740
- // Handle the result
741
- console.log(result);
803
+ // Handle the result
804
+ console.log(result);
742
805
  }
743
806
 
744
807
  run();