honeyhive 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (274) hide show
  1. package/LICENSE.md +21 -0
  2. package/README.md +190 -0
  3. package/dist/index.d.ts +1 -0
  4. package/dist/index.js +20 -0
  5. package/dist/internal/utils/contenttype.d.ts +1 -0
  6. package/dist/internal/utils/contenttype.js +33 -0
  7. package/dist/internal/utils/headers.d.ts +4 -0
  8. package/dist/internal/utils/headers.js +92 -0
  9. package/dist/internal/utils/index.d.ts +8 -0
  10. package/dist/internal/utils/index.js +27 -0
  11. package/dist/internal/utils/pathparams.d.ts +2 -0
  12. package/dist/internal/utils/pathparams.js +53 -0
  13. package/dist/internal/utils/queryparams.d.ts +2 -0
  14. package/dist/internal/utils/queryparams.js +180 -0
  15. package/dist/internal/utils/requestbody.d.ts +2 -0
  16. package/dist/internal/utils/requestbody.js +318 -0
  17. package/dist/internal/utils/retries.d.ts +20 -0
  18. package/dist/internal/utils/retries.js +250 -0
  19. package/dist/internal/utils/security.d.ts +5 -0
  20. package/dist/internal/utils/security.js +188 -0
  21. package/dist/internal/utils/utils.d.ts +37 -0
  22. package/dist/internal/utils/utils.js +370 -0
  23. package/dist/sdk/index.d.ts +1 -0
  24. package/dist/sdk/index.js +20 -0
  25. package/dist/sdk/models/errors/index.d.ts +1 -0
  26. package/dist/sdk/models/errors/index.js +20 -0
  27. package/dist/sdk/models/errors/sdkerror.d.ts +7 -0
  28. package/dist/sdk/models/errors/sdkerror.js +40 -0
  29. package/dist/sdk/models/operations/deletedatasetsname.d.ts +24 -0
  30. package/dist/sdk/models/operations/deletedatasetsname.js +91 -0
  31. package/dist/sdk/models/operations/deletemetrics.d.ts +26 -0
  32. package/dist/sdk/models/operations/deletemetrics.js +99 -0
  33. package/dist/sdk/models/operations/deletepromptsid.d.ts +24 -0
  34. package/dist/sdk/models/operations/deletepromptsid.js +91 -0
  35. package/dist/sdk/models/operations/deletetasks.d.ts +24 -0
  36. package/dist/sdk/models/operations/deletetasks.js +91 -0
  37. package/dist/sdk/models/operations/getdatasets.d.ts +27 -0
  38. package/dist/sdk/models/operations/getdatasets.js +103 -0
  39. package/dist/sdk/models/operations/getfinetunedmodels.d.ts +25 -0
  40. package/dist/sdk/models/operations/getfinetunedmodels.js +95 -0
  41. package/dist/sdk/models/operations/getfinetunedmodelsid.d.ts +24 -0
  42. package/dist/sdk/models/operations/getfinetunedmodelsid.js +91 -0
  43. package/dist/sdk/models/operations/getgenerations.d.ts +26 -0
  44. package/dist/sdk/models/operations/getgenerations.js +99 -0
  45. package/dist/sdk/models/operations/getmetrics.d.ts +25 -0
  46. package/dist/sdk/models/operations/getmetrics.js +95 -0
  47. package/dist/sdk/models/operations/getprompts.d.ts +25 -0
  48. package/dist/sdk/models/operations/getprompts.js +95 -0
  49. package/dist/sdk/models/operations/getsession.d.ts +40 -0
  50. package/dist/sdk/models/operations/getsession.js +110 -0
  51. package/dist/sdk/models/operations/getsessionsessionid.d.ts +24 -0
  52. package/dist/sdk/models/operations/getsessionsessionid.js +91 -0
  53. package/dist/sdk/models/operations/getsessionsessionidexport.d.ts +24 -0
  54. package/dist/sdk/models/operations/getsessionsessionidexport.js +91 -0
  55. package/dist/sdk/models/operations/gettasks.d.ts +24 -0
  56. package/dist/sdk/models/operations/gettasks.js +91 -0
  57. package/dist/sdk/models/operations/index.d.ts +29 -0
  58. package/dist/sdk/models/operations/index.js +48 -0
  59. package/dist/sdk/models/operations/postdatasets.d.ts +21 -0
  60. package/dist/sdk/models/operations/postdatasets.js +79 -0
  61. package/dist/sdk/models/operations/postevaluations.d.ts +21 -0
  62. package/dist/sdk/models/operations/postevaluations.js +79 -0
  63. package/dist/sdk/models/operations/postfeedback.d.ts +21 -0
  64. package/dist/sdk/models/operations/postfeedback.js +79 -0
  65. package/dist/sdk/models/operations/postgenerations.d.ts +21 -0
  66. package/dist/sdk/models/operations/postgenerations.js +79 -0
  67. package/dist/sdk/models/operations/postgenerationslog.d.ts +21 -0
  68. package/dist/sdk/models/operations/postgenerationslog.js +79 -0
  69. package/dist/sdk/models/operations/postmetrics.d.ts +21 -0
  70. package/dist/sdk/models/operations/postmetrics.js +79 -0
  71. package/dist/sdk/models/operations/postprompts.d.ts +21 -0
  72. package/dist/sdk/models/operations/postprompts.js +79 -0
  73. package/dist/sdk/models/operations/postsessionsessionidend.d.ts +24 -0
  74. package/dist/sdk/models/operations/postsessionsessionidend.js +91 -0
  75. package/dist/sdk/models/operations/postsessionsessionidevent.d.ts +25 -0
  76. package/dist/sdk/models/operations/postsessionsessionidevent.js +95 -0
  77. package/dist/sdk/models/operations/postsessionsessionidfeedback.d.ts +25 -0
  78. package/dist/sdk/models/operations/postsessionsessionidfeedback.js +95 -0
  79. package/dist/sdk/models/operations/postsessionssessionidtraces.d.ts +25 -0
  80. package/dist/sdk/models/operations/postsessionssessionidtraces.js +95 -0
  81. package/dist/sdk/models/operations/postsessionstart.d.ts +21 -0
  82. package/dist/sdk/models/operations/postsessionstart.js +79 -0
  83. package/dist/sdk/models/operations/posttasks.d.ts +21 -0
  84. package/dist/sdk/models/operations/posttasks.js +79 -0
  85. package/dist/sdk/models/operations/putpromptsid.d.ts +25 -0
  86. package/dist/sdk/models/operations/putpromptsid.js +95 -0
  87. package/dist/sdk/models/operations/puttasks.d.ts +21 -0
  88. package/dist/sdk/models/operations/puttasks.js +79 -0
  89. package/dist/sdk/models/shared/datasetresponse.d.ts +52 -0
  90. package/dist/sdk/models/shared/datasetresponse.js +115 -0
  91. package/dist/sdk/models/shared/deleteresponse.d.ts +10 -0
  92. package/dist/sdk/models/shared/deleteresponse.js +48 -0
  93. package/dist/sdk/models/shared/evaluationloggingquery.d.ts +76 -0
  94. package/dist/sdk/models/shared/evaluationloggingquery.js +176 -0
  95. package/dist/sdk/models/shared/feedbackquery.d.ts +27 -0
  96. package/dist/sdk/models/shared/feedbackquery.js +75 -0
  97. package/dist/sdk/models/shared/feedbackresponse.d.ts +31 -0
  98. package/dist/sdk/models/shared/feedbackresponse.js +84 -0
  99. package/dist/sdk/models/shared/finetunedmodelresponse.d.ts +54 -0
  100. package/dist/sdk/models/shared/finetunedmodelresponse.js +111 -0
  101. package/dist/sdk/models/shared/generatequery.d.ts +69 -0
  102. package/dist/sdk/models/shared/generatequery.js +139 -0
  103. package/dist/sdk/models/shared/generation.d.ts +54 -0
  104. package/dist/sdk/models/shared/generation.js +103 -0
  105. package/dist/sdk/models/shared/generationloggingquery.d.ts +92 -0
  106. package/dist/sdk/models/shared/generationloggingquery.js +185 -0
  107. package/dist/sdk/models/shared/generationresponse.d.ts +18 -0
  108. package/dist/sdk/models/shared/generationresponse.js +58 -0
  109. package/dist/sdk/models/shared/index.d.ts +32 -0
  110. package/dist/sdk/models/shared/index.js +51 -0
  111. package/dist/sdk/models/shared/metriccreateresponse.d.ts +7 -0
  112. package/dist/sdk/models/shared/metriccreateresponse.js +45 -0
  113. package/dist/sdk/models/shared/metricrequest.d.ts +18 -0
  114. package/dist/sdk/models/shared/metricrequest.js +58 -0
  115. package/dist/sdk/models/shared/metricresponse.d.ts +63 -0
  116. package/dist/sdk/models/shared/metricresponse.js +124 -0
  117. package/dist/sdk/models/shared/promptcreationquery.d.ts +44 -0
  118. package/dist/sdk/models/shared/promptcreationquery.js +97 -0
  119. package/dist/sdk/models/shared/promptresponse.d.ts +52 -0
  120. package/dist/sdk/models/shared/promptresponse.js +115 -0
  121. package/dist/sdk/models/shared/promptupdatequery.d.ts +36 -0
  122. package/dist/sdk/models/shared/promptupdatequery.js +87 -0
  123. package/dist/sdk/models/shared/security.d.ts +4 -0
  124. package/dist/sdk/models/shared/security.js +45 -0
  125. package/dist/sdk/models/shared/sessionendresponse.d.ts +14 -0
  126. package/dist/sdk/models/shared/sessionendresponse.js +53 -0
  127. package/dist/sdk/models/shared/sessioneventquery.d.ts +76 -0
  128. package/dist/sdk/models/shared/sessioneventquery.js +160 -0
  129. package/dist/sdk/models/shared/sessioneventresponse.d.ts +14 -0
  130. package/dist/sdk/models/shared/sessioneventresponse.js +53 -0
  131. package/dist/sdk/models/shared/sessionfeedback.d.ts +19 -0
  132. package/dist/sdk/models/shared/sessionfeedback.js +65 -0
  133. package/dist/sdk/models/shared/sessionstartquery.d.ts +31 -0
  134. package/dist/sdk/models/shared/sessionstartquery.js +80 -0
  135. package/dist/sdk/models/shared/sessionstartresponse.d.ts +14 -0
  136. package/dist/sdk/models/shared/sessionstartresponse.js +53 -0
  137. package/dist/sdk/models/shared/sessiontrace.d.ts +11 -0
  138. package/dist/sdk/models/shared/sessiontrace.js +50 -0
  139. package/dist/sdk/models/shared/successresponse.d.ts +14 -0
  140. package/dist/sdk/models/shared/successresponse.js +53 -0
  141. package/dist/sdk/models/shared/successtraceresponse.d.ts +14 -0
  142. package/dist/sdk/models/shared/successtraceresponse.js +53 -0
  143. package/dist/sdk/models/shared/taskcreationquery.d.ts +46 -0
  144. package/dist/sdk/models/shared/taskcreationquery.js +104 -0
  145. package/dist/sdk/models/shared/taskresponse.d.ts +54 -0
  146. package/dist/sdk/models/shared/taskresponse.js +114 -0
  147. package/dist/sdk/models/shared/taskupdatequery.d.ts +38 -0
  148. package/dist/sdk/models/shared/taskupdatequery.js +86 -0
  149. package/dist/sdk/models/shared/taskupdateresponse.d.ts +23 -0
  150. package/dist/sdk/models/shared/taskupdateresponse.js +65 -0
  151. package/dist/sdk/models/shared/traceevent.d.ts +31 -0
  152. package/dist/sdk/models/shared/traceevent.js +75 -0
  153. package/dist/sdk/models/shared/uploaddataset.d.ts +29 -0
  154. package/dist/sdk/models/shared/uploaddataset.js +82 -0
  155. package/dist/sdk/sdk.d.ts +163 -0
  156. package/dist/sdk/sdk.js +2097 -0
  157. package/dist/sdk/types/index.d.ts +1 -0
  158. package/dist/sdk/types/index.js +20 -0
  159. package/dist/sdk/types/rfcdate.d.ts +9 -0
  160. package/dist/sdk/types/rfcdate.js +59 -0
  161. package/docs/models/operations/deletedatasetsnamerequest.md +8 -0
  162. package/docs/models/operations/deletedatasetsnameresponse.md +11 -0
  163. package/docs/models/operations/deletemetricsrequest.md +10 -0
  164. package/docs/models/operations/deletemetricsresponse.md +11 -0
  165. package/docs/models/operations/deletepromptsidrequest.md +8 -0
  166. package/docs/models/operations/deletepromptsidresponse.md +11 -0
  167. package/docs/models/operations/deletetasksrequest.md +8 -0
  168. package/docs/models/operations/deletetasksresponse.md +11 -0
  169. package/docs/models/operations/getdatasetsrequest.md +11 -0
  170. package/docs/models/operations/getdatasetsresponse.md +11 -0
  171. package/docs/models/operations/getfinetunedmodelsidrequest.md +8 -0
  172. package/docs/models/operations/getfinetunedmodelsidresponse.md +11 -0
  173. package/docs/models/operations/getfinetunedmodelsrequest.md +9 -0
  174. package/docs/models/operations/getfinetunedmodelsresponse.md +11 -0
  175. package/docs/models/operations/getgenerationsrequest.md +10 -0
  176. package/docs/models/operations/getgenerationsresponse.md +11 -0
  177. package/docs/models/operations/getmetricsrequest.md +9 -0
  178. package/docs/models/operations/getmetricsresponse.md +11 -0
  179. package/docs/models/operations/getpromptsrequest.md +9 -0
  180. package/docs/models/operations/getpromptsresponse.md +11 -0
  181. package/docs/models/operations/getsessionquery.md +9 -0
  182. package/docs/models/operations/getsessionrequest.md +10 -0
  183. package/docs/models/operations/getsessionresponse.md +11 -0
  184. package/docs/models/operations/getsessionsessionidexportrequest.md +8 -0
  185. package/docs/models/operations/getsessionsessionidexportresponse.md +11 -0
  186. package/docs/models/operations/getsessionsessionidrequest.md +8 -0
  187. package/docs/models/operations/getsessionsessionidresponse.md +11 -0
  188. package/docs/models/operations/gettasksrequest.md +8 -0
  189. package/docs/models/operations/gettasksresponse.md +11 -0
  190. package/docs/models/operations/postdatasetsresponse.md +11 -0
  191. package/docs/models/operations/postevaluationsresponse.md +11 -0
  192. package/docs/models/operations/postfeedbackresponse.md +11 -0
  193. package/docs/models/operations/postgenerationslogresponse.md +11 -0
  194. package/docs/models/operations/postgenerationsresponse.md +11 -0
  195. package/docs/models/operations/postmetricsresponse.md +11 -0
  196. package/docs/models/operations/postpromptsresponse.md +11 -0
  197. package/docs/models/operations/postsessionsessionidendrequest.md +8 -0
  198. package/docs/models/operations/postsessionsessionidendresponse.md +11 -0
  199. package/docs/models/operations/postsessionsessionideventrequest.md +9 -0
  200. package/docs/models/operations/postsessionsessionideventresponse.md +11 -0
  201. package/docs/models/operations/postsessionsessionidfeedbackrequest.md +9 -0
  202. package/docs/models/operations/postsessionsessionidfeedbackresponse.md +11 -0
  203. package/docs/models/operations/postsessionssessionidtracesrequest.md +9 -0
  204. package/docs/models/operations/postsessionssessionidtracesresponse.md +11 -0
  205. package/docs/models/operations/postsessionstartresponse.md +11 -0
  206. package/docs/models/operations/posttasksresponse.md +11 -0
  207. package/docs/models/operations/putpromptsidrequest.md +9 -0
  208. package/docs/models/operations/putpromptsidresponse.md +11 -0
  209. package/docs/models/operations/puttasksresponse.md +11 -0
  210. package/docs/models/shared/datasetresponse.md +20 -0
  211. package/docs/models/shared/datasetresponsefile.md +7 -0
  212. package/docs/models/shared/deleteresponse.md +10 -0
  213. package/docs/models/shared/evaluationloggingquery.md +23 -0
  214. package/docs/models/shared/evaluationloggingquerycomments.md +7 -0
  215. package/docs/models/shared/evaluationloggingquerydataset.md +7 -0
  216. package/docs/models/shared/evaluationloggingquerygenerations.md +7 -0
  217. package/docs/models/shared/evaluationloggingquerymetrics.md +7 -0
  218. package/docs/models/shared/evaluationloggingqueryprompts.md +7 -0
  219. package/docs/models/shared/evaluationloggingqueryresults.md +7 -0
  220. package/docs/models/shared/evaluationloggingquerysummary.md +7 -0
  221. package/docs/models/shared/feedbackquery.md +13 -0
  222. package/docs/models/shared/feedbackqueryfeedbackjson.md +9 -0
  223. package/docs/models/shared/feedbackresponse.md +14 -0
  224. package/docs/models/shared/feedbackresponsefeedback.md +9 -0
  225. package/docs/models/shared/finetunedmodelresponse.md +21 -0
  226. package/docs/models/shared/generatequery.md +21 -0
  227. package/docs/models/shared/generatequeryinput.md +9 -0
  228. package/docs/models/shared/generatequerymetadata.md +9 -0
  229. package/docs/models/shared/generatequeryuserproperties.md +9 -0
  230. package/docs/models/shared/generation.md +21 -0
  231. package/docs/models/shared/generationloggingquery.md +23 -0
  232. package/docs/models/shared/generationloggingqueryfeedback.md +9 -0
  233. package/docs/models/shared/generationloggingqueryhyperparameters.md +9 -0
  234. package/docs/models/shared/generationloggingqueryinputs.md +9 -0
  235. package/docs/models/shared/generationloggingquerymetadata.md +9 -0
  236. package/docs/models/shared/generationloggingqueryusage.md +9 -0
  237. package/docs/models/shared/generationloggingqueryuserproperties.md +9 -0
  238. package/docs/models/shared/generationresponse.md +12 -0
  239. package/docs/models/shared/metriccreateresponse.md +8 -0
  240. package/docs/models/shared/metricrequest.md +12 -0
  241. package/docs/models/shared/metricresponse.md +22 -0
  242. package/docs/models/shared/metricresponsethreshold.md +9 -0
  243. package/docs/models/shared/promptcreationquery.md +18 -0
  244. package/docs/models/shared/promptcreationqueryfewshotexamples.md +7 -0
  245. package/docs/models/shared/promptresponse.md +20 -0
  246. package/docs/models/shared/promptresponsefewshotexamples.md +7 -0
  247. package/docs/models/shared/promptupdatequery.md +16 -0
  248. package/docs/models/shared/promptupdatequeryfewshotexamples.md +7 -0
  249. package/docs/models/shared/security.md +8 -0
  250. package/docs/models/shared/sessionendresponse.md +11 -0
  251. package/docs/models/shared/sessioneventquery.md +21 -0
  252. package/docs/models/shared/sessioneventquerychildren.md +7 -0
  253. package/docs/models/shared/sessioneventqueryconfig.md +9 -0
  254. package/docs/models/shared/sessioneventqueryerror.md +9 -0
  255. package/docs/models/shared/sessioneventqueryinputs.md +9 -0
  256. package/docs/models/shared/sessioneventquerymetadata.md +9 -0
  257. package/docs/models/shared/sessioneventresponse.md +11 -0
  258. package/docs/models/shared/sessionfeedback.md +11 -0
  259. package/docs/models/shared/sessionfeedbackfeedback.md +9 -0
  260. package/docs/models/shared/sessionstartquery.md +14 -0
  261. package/docs/models/shared/sessionstartqueryuserproperties.md +9 -0
  262. package/docs/models/shared/sessionstartresponse.md +11 -0
  263. package/docs/models/shared/sessiontrace.md +10 -0
  264. package/docs/models/shared/successresponse.md +11 -0
  265. package/docs/models/shared/successtraceresponse.md +11 -0
  266. package/docs/models/shared/taskcreationquery.md +18 -0
  267. package/docs/models/shared/taskresponse.md +20 -0
  268. package/docs/models/shared/taskupdatequery.md +16 -0
  269. package/docs/models/shared/taskupdateresponse.md +12 -0
  270. package/docs/models/shared/traceevent.md +14 -0
  271. package/docs/models/shared/uploaddataset.md +15 -0
  272. package/docs/models/shared/uploaddatasetfile.md +7 -0
  273. package/docs/sdks/honeyhive/README.md +1258 -0
  274. package/package.json +37 -0
@@ -0,0 +1,1258 @@
1
+ # HoneyHive SDK
2
+
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [deleteDatasetsName](#deletedatasetsname) - Delete a dataset
9
+ * [deleteMetrics](#deletemetrics) - Delete a metric
10
+ * [deletePromptsId](#deletepromptsid) - Delete a prompt
11
+ * [deleteTasks](#deletetasks) - Delete a task
12
+ * [getDatasets](#getdatasets) - Get datasets
13
+ * [getFineTunedModels](#getfinetunedmodels) - Get all fine-tuned models
14
+ * [getFineTunedModelsId](#getfinetunedmodelsid) - Get a fine-tuned model
15
+ * [getGenerations](#getgenerations) - Get all generations
16
+ * [getMetrics](#getmetrics) - Get all metrics
17
+ * [getPrompts](#getprompts) - Get all prompts
18
+ * [getSession](#getsession) - Get all sessions
19
+ * [getSessionSessionId](#getsessionsessionid) - Get a session
20
+ * [getSessionSessionIdExport](#getsessionsessionidexport) - Get a session in Trace Event format
21
+ * [getTasks](#gettasks) - Get all tasks
22
+ * [postDatasets](#postdatasets) - Create a dataset
23
+ * [postEvaluations](#postevaluations) - Log an evaluation
24
+ * [postFeedback](#postfeedback) - Send feedback
25
+ * [postGenerations](#postgenerations) - Generate a text
26
+ * [postGenerationsLog](#postgenerationslog) - Log a generation
27
+ * [postMetrics](#postmetrics) - Create a metric
28
+ * [postPrompts](#postprompts) - Create a prompt
29
+ * [postSessionStart](#postsessionstart) - Start a session
30
+ * [postSessionSessionIdEnd](#postsessionsessionidend) - End a session
31
+ * [postSessionSessionIdEvent](#postsessionsessionidevent) - Log an event
32
+ * [postSessionSessionIdFeedback](#postsessionsessionidfeedback) - Log session feedback
33
+ * [postSessionsSessionIdTraces](#postsessionssessionidtraces) - Log a trace
34
+ * [postTasks](#posttasks) - Create a task
35
+ * [putPromptsId](#putpromptsid) - Update a prompt
36
+ * [putTasks](#puttasks) - Update a task
37
+
38
+ ## deleteDatasetsName
39
+
40
+ Delete a dataset
41
+
42
+ ### Example Usage
43
+
44
+ ```typescript
45
+ import { HoneyHive } from "HoneyHive";
46
+
47
+ (async() => {
48
+ const sdk = new HoneyHive({
49
+ bearerAuth: "",
50
+ });
51
+
52
+ const res = await sdk.honeyHive.deleteDatasetsName({
53
+ name: "string",
54
+ });
55
+
56
+
57
+ if (res.statusCode == 200) {
58
+ // handle response
59
+ }
60
+ })();
61
+ ```
62
+
63
+ ### Parameters
64
+
65
+ | Parameter | Type | Required | Description |
66
+ | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
67
+ | `request` | [operations.DeleteDatasetsNameRequest](../../models/operations/deletedatasetsnamerequest.md) | :heavy_check_mark: | The request object to use for the request. |
68
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
69
+
70
+
71
+ ### Response
72
+
73
+ **Promise<[operations.DeleteDatasetsNameResponse](../../models/operations/deletedatasetsnameresponse.md)>**
74
+
75
+
76
+ ## deleteMetrics
77
+
78
+ Delete a metric
79
+
80
+ ### Example Usage
81
+
82
+ ```typescript
83
+ import { HoneyHive } from "HoneyHive";
84
+
85
+ (async() => {
86
+ const sdk = new HoneyHive({
87
+ bearerAuth: "",
88
+ });
89
+
90
+ const res = await sdk.honeyHive.deleteMetrics({
91
+ metricId: "string",
92
+ name: "string",
93
+ task: "string",
94
+ });
95
+
96
+
97
+ if (res.statusCode == 200) {
98
+ // handle response
99
+ }
100
+ })();
101
+ ```
102
+
103
+ ### Parameters
104
+
105
+ | Parameter | Type | Required | Description |
106
+ | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
107
+ | `request` | [operations.DeleteMetricsRequest](../../models/operations/deletemetricsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
108
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
109
+
110
+
111
+ ### Response
112
+
113
+ **Promise<[operations.DeleteMetricsResponse](../../models/operations/deletemetricsresponse.md)>**
114
+
115
+
116
+ ## deletePromptsId
117
+
118
+ Delete a prompt
119
+
120
+ ### Example Usage
121
+
122
+ ```typescript
123
+ import { HoneyHive } from "HoneyHive";
124
+
125
+ (async() => {
126
+ const sdk = new HoneyHive({
127
+ bearerAuth: "",
128
+ });
129
+
130
+ const res = await sdk.honeyHive.deletePromptsId({
131
+ id: "<ID>",
132
+ });
133
+
134
+
135
+ if (res.statusCode == 200) {
136
+ // handle response
137
+ }
138
+ })();
139
+ ```
140
+
141
+ ### Parameters
142
+
143
+ | Parameter | Type | Required | Description |
144
+ | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
145
+ | `request` | [operations.DeletePromptsIdRequest](../../models/operations/deletepromptsidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
146
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
147
+
148
+
149
+ ### Response
150
+
151
+ **Promise<[operations.DeletePromptsIdResponse](../../models/operations/deletepromptsidresponse.md)>**
152
+
153
+
154
+ ## deleteTasks
155
+
156
+ Delete a task
157
+
158
+ ### Example Usage
159
+
160
+ ```typescript
161
+ import { HoneyHive } from "HoneyHive";
162
+
163
+ (async() => {
164
+ const sdk = new HoneyHive({
165
+ bearerAuth: "",
166
+ });
167
+
168
+ const res = await sdk.honeyHive.deleteTasks({
169
+ name: "string",
170
+ });
171
+
172
+
173
+ if (res.statusCode == 200) {
174
+ // handle response
175
+ }
176
+ })();
177
+ ```
178
+
179
+ ### Parameters
180
+
181
+ | Parameter | Type | Required | Description |
182
+ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
183
+ | `request` | [operations.DeleteTasksRequest](../../models/operations/deletetasksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
184
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
185
+
186
+
187
+ ### Response
188
+
189
+ **Promise<[operations.DeleteTasksResponse](../../models/operations/deletetasksresponse.md)>**
190
+
191
+
192
+ ## getDatasets
193
+
194
+ Get datasets
195
+
196
+ ### Example Usage
197
+
198
+ ```typescript
199
+ import { HoneyHive } from "HoneyHive";
200
+
201
+ (async() => {
202
+ const sdk = new HoneyHive({
203
+ bearerAuth: "",
204
+ });
205
+
206
+ const res = await sdk.honeyHive.getDatasets({});
207
+
208
+
209
+ if (res.statusCode == 200) {
210
+ // handle response
211
+ }
212
+ })();
213
+ ```
214
+
215
+ ### Parameters
216
+
217
+ | Parameter | Type | Required | Description |
218
+ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
219
+ | `request` | [operations.GetDatasetsRequest](../../models/operations/getdatasetsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
220
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
221
+
222
+
223
+ ### Response
224
+
225
+ **Promise<[operations.GetDatasetsResponse](../../models/operations/getdatasetsresponse.md)>**
226
+
227
+
228
+ ## getFineTunedModels
229
+
230
+ Get all fine-tuned models
231
+
232
+ ### Example Usage
233
+
234
+ ```typescript
235
+ import { HoneyHive } from "HoneyHive";
236
+
237
+ (async() => {
238
+ const sdk = new HoneyHive({
239
+ bearerAuth: "",
240
+ });
241
+
242
+ const res = await sdk.honeyHive.getFineTunedModels({});
243
+
244
+
245
+ if (res.statusCode == 200) {
246
+ // handle response
247
+ }
248
+ })();
249
+ ```
250
+
251
+ ### Parameters
252
+
253
+ | Parameter | Type | Required | Description |
254
+ | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
255
+ | `request` | [operations.GetFineTunedModelsRequest](../../models/operations/getfinetunedmodelsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
256
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
257
+
258
+
259
+ ### Response
260
+
261
+ **Promise<[operations.GetFineTunedModelsResponse](../../models/operations/getfinetunedmodelsresponse.md)>**
262
+
263
+
264
+ ## getFineTunedModelsId
265
+
266
+ Get a fine-tuned model
267
+
268
+ ### Example Usage
269
+
270
+ ```typescript
271
+ import { HoneyHive } from "HoneyHive";
272
+
273
+ (async() => {
274
+ const sdk = new HoneyHive({
275
+ bearerAuth: "",
276
+ });
277
+
278
+ const res = await sdk.honeyHive.getFineTunedModelsId({
279
+ id: "<ID>",
280
+ });
281
+
282
+
283
+ if (res.statusCode == 200) {
284
+ // handle response
285
+ }
286
+ })();
287
+ ```
288
+
289
+ ### Parameters
290
+
291
+ | Parameter | Type | Required | Description |
292
+ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
293
+ | `request` | [operations.GetFineTunedModelsIdRequest](../../models/operations/getfinetunedmodelsidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
294
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
295
+
296
+
297
+ ### Response
298
+
299
+ **Promise<[operations.GetFineTunedModelsIdResponse](../../models/operations/getfinetunedmodelsidresponse.md)>**
300
+
301
+
302
+ ## getGenerations
303
+
304
+ Get all generations
305
+
306
+ ### Example Usage
307
+
308
+ ```typescript
309
+ import { HoneyHive } from "HoneyHive";
310
+
311
+ (async() => {
312
+ const sdk = new HoneyHive({
313
+ bearerAuth: "",
314
+ });
315
+
316
+ const res = await sdk.honeyHive.getGenerations({});
317
+
318
+
319
+ if (res.statusCode == 200) {
320
+ // handle response
321
+ }
322
+ })();
323
+ ```
324
+
325
+ ### Parameters
326
+
327
+ | Parameter | Type | Required | Description |
328
+ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
329
+ | `request` | [operations.GetGenerationsRequest](../../models/operations/getgenerationsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
330
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
331
+
332
+
333
+ ### Response
334
+
335
+ **Promise<[operations.GetGenerationsResponse](../../models/operations/getgenerationsresponse.md)>**
336
+
337
+
338
+ ## getMetrics
339
+
340
+ Get all metrics
341
+
342
+ ### Example Usage
343
+
344
+ ```typescript
345
+ import { HoneyHive } from "HoneyHive";
346
+
347
+ (async() => {
348
+ const sdk = new HoneyHive({
349
+ bearerAuth: "",
350
+ });
351
+
352
+ const res = await sdk.honeyHive.getMetrics({});
353
+
354
+
355
+ if (res.statusCode == 200) {
356
+ // handle response
357
+ }
358
+ })();
359
+ ```
360
+
361
+ ### Parameters
362
+
363
+ | Parameter | Type | Required | Description |
364
+ | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
365
+ | `request` | [operations.GetMetricsRequest](../../models/operations/getmetricsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
366
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
367
+
368
+
369
+ ### Response
370
+
371
+ **Promise<[operations.GetMetricsResponse](../../models/operations/getmetricsresponse.md)>**
372
+
373
+
374
+ ## getPrompts
375
+
376
+ Get all prompts
377
+
378
+ ### Example Usage
379
+
380
+ ```typescript
381
+ import { HoneyHive } from "HoneyHive";
382
+
383
+ (async() => {
384
+ const sdk = new HoneyHive({
385
+ bearerAuth: "",
386
+ });
387
+
388
+ const res = await sdk.honeyHive.getPrompts({});
389
+
390
+
391
+ if (res.statusCode == 200) {
392
+ // handle response
393
+ }
394
+ })();
395
+ ```
396
+
397
+ ### Parameters
398
+
399
+ | Parameter | Type | Required | Description |
400
+ | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
401
+ | `request` | [operations.GetPromptsRequest](../../models/operations/getpromptsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
402
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
403
+
404
+
405
+ ### Response
406
+
407
+ **Promise<[operations.GetPromptsResponse](../../models/operations/getpromptsresponse.md)>**
408
+
409
+
410
+ ## getSession
411
+
412
+ Get all sessions
413
+
414
+ ### Example Usage
415
+
416
+ ```typescript
417
+ import { HoneyHive } from "HoneyHive";
418
+
419
+ (async() => {
420
+ const sdk = new HoneyHive({
421
+ bearerAuth: "",
422
+ });
423
+
424
+ const res = await sdk.honeyHive.getSession({
425
+ query: {},
426
+ });
427
+
428
+
429
+ if (res.statusCode == 200) {
430
+ // handle response
431
+ }
432
+ })();
433
+ ```
434
+
435
+ ### Parameters
436
+
437
+ | Parameter | Type | Required | Description |
438
+ | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
439
+ | `request` | [operations.GetSessionRequest](../../models/operations/getsessionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
440
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
441
+
442
+
443
+ ### Response
444
+
445
+ **Promise<[operations.GetSessionResponse](../../models/operations/getsessionresponse.md)>**
446
+
447
+
448
+ ## getSessionSessionId
449
+
450
+ Get a session
451
+
452
+ ### Example Usage
453
+
454
+ ```typescript
455
+ import { HoneyHive } from "HoneyHive";
456
+
457
+ (async() => {
458
+ const sdk = new HoneyHive({
459
+ bearerAuth: "",
460
+ });
461
+
462
+ const res = await sdk.honeyHive.getSessionSessionId({
463
+ sessionId: "string",
464
+ });
465
+
466
+
467
+ if (res.statusCode == 200) {
468
+ // handle response
469
+ }
470
+ })();
471
+ ```
472
+
473
+ ### Parameters
474
+
475
+ | Parameter | Type | Required | Description |
476
+ | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
477
+ | `request` | [operations.GetSessionSessionIdRequest](../../models/operations/getsessionsessionidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
478
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
479
+
480
+
481
+ ### Response
482
+
483
+ **Promise<[operations.GetSessionSessionIdResponse](../../models/operations/getsessionsessionidresponse.md)>**
484
+
485
+
486
+ ## getSessionSessionIdExport
487
+
488
+ Get a session in Trace Event format
489
+
490
+ ### Example Usage
491
+
492
+ ```typescript
493
+ import { HoneyHive } from "HoneyHive";
494
+
495
+ (async() => {
496
+ const sdk = new HoneyHive({
497
+ bearerAuth: "",
498
+ });
499
+
500
+ const res = await sdk.honeyHive.getSessionSessionIdExport({
501
+ sessionId: "string",
502
+ });
503
+
504
+
505
+ if (res.statusCode == 200) {
506
+ // handle response
507
+ }
508
+ })();
509
+ ```
510
+
511
+ ### Parameters
512
+
513
+ | Parameter | Type | Required | Description |
514
+ | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
515
+ | `request` | [operations.GetSessionSessionIdExportRequest](../../models/operations/getsessionsessionidexportrequest.md) | :heavy_check_mark: | The request object to use for the request. |
516
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
517
+
518
+
519
+ ### Response
520
+
521
+ **Promise<[operations.GetSessionSessionIdExportResponse](../../models/operations/getsessionsessionidexportresponse.md)>**
522
+
523
+
524
+ ## getTasks
525
+
526
+ Get all tasks
527
+
528
+ ### Example Usage
529
+
530
+ ```typescript
531
+ import { HoneyHive } from "HoneyHive";
532
+
533
+ (async() => {
534
+ const sdk = new HoneyHive({
535
+ bearerAuth: "",
536
+ });
537
+
538
+ const res = await sdk.honeyHive.getTasks({});
539
+
540
+
541
+ if (res.statusCode == 200) {
542
+ // handle response
543
+ }
544
+ })();
545
+ ```
546
+
547
+ ### Parameters
548
+
549
+ | Parameter | Type | Required | Description |
550
+ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
551
+ | `request` | [operations.GetTasksRequest](../../models/operations/gettasksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
552
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
553
+
554
+
555
+ ### Response
556
+
557
+ **Promise<[operations.GetTasksResponse](../../models/operations/gettasksresponse.md)>**
558
+
559
+
560
+ ## postDatasets
561
+
562
+ Create a dataset
563
+
564
+ ### Example Usage
565
+
566
+ ```typescript
567
+ import { HoneyHive } from "HoneyHive";
568
+
569
+ (async() => {
570
+ const sdk = new HoneyHive({
571
+ bearerAuth: "",
572
+ });
573
+
574
+ const res = await sdk.honeyHive.postDatasets({
575
+ file: [
576
+ {},
577
+ ],
578
+ });
579
+
580
+
581
+ if (res.statusCode == 200) {
582
+ // handle response
583
+ }
584
+ })();
585
+ ```
586
+
587
+ ### Parameters
588
+
589
+ | Parameter | Type | Required | Description |
590
+ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
591
+ | `request` | [shared.UploadDataset](../../models/shared/uploaddataset.md) | :heavy_check_mark: | The request object to use for the request. |
592
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
593
+
594
+
595
+ ### Response
596
+
597
+ **Promise<[operations.PostDatasetsResponse](../../models/operations/postdatasetsresponse.md)>**
598
+
599
+
600
+ ## postEvaluations
601
+
602
+ Log an evaluation
603
+
604
+ ### Example Usage
605
+
606
+ ```typescript
607
+ import { HoneyHive } from "HoneyHive";
608
+
609
+ (async() => {
610
+ const sdk = new HoneyHive({
611
+ bearerAuth: "",
612
+ });
613
+
614
+ const res = await sdk.honeyHive.postEvaluations({
615
+ comments: [
616
+ {},
617
+ ],
618
+ dataset: [
619
+ {},
620
+ ],
621
+ generations: [
622
+ {},
623
+ ],
624
+ metrics: [
625
+ [
626
+ {},
627
+ ],
628
+ ],
629
+ metricsToCompute: [
630
+ "string",
631
+ ],
632
+ prompts: [
633
+ {},
634
+ ],
635
+ results: [
636
+ {},
637
+ ],
638
+ summary: [
639
+ {},
640
+ ],
641
+ });
642
+
643
+
644
+ if (res.statusCode == 200) {
645
+ // handle response
646
+ }
647
+ })();
648
+ ```
649
+
650
+ ### Parameters
651
+
652
+ | Parameter | Type | Required | Description |
653
+ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
654
+ | `request` | [shared.EvaluationLoggingQuery](../../models/shared/evaluationloggingquery.md) | :heavy_check_mark: | The request object to use for the request. |
655
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
656
+
657
+
658
+ ### Response
659
+
660
+ **Promise<[operations.PostEvaluationsResponse](../../models/operations/postevaluationsresponse.md)>**
661
+
662
+
663
+ ## postFeedback
664
+
665
+ Send feedback
666
+
667
+ ### Example Usage
668
+
669
+ ```typescript
670
+ import { HoneyHive } from "HoneyHive";
671
+
672
+ (async() => {
673
+ const sdk = new HoneyHive({
674
+ bearerAuth: "",
675
+ });
676
+
677
+ const res = await sdk.honeyHive.postFeedback({
678
+ feedbackJson: {},
679
+ });
680
+
681
+
682
+ if (res.statusCode == 200) {
683
+ // handle response
684
+ }
685
+ })();
686
+ ```
687
+
688
+ ### Parameters
689
+
690
+ | Parameter | Type | Required | Description |
691
+ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
692
+ | `request` | [shared.FeedbackQuery](../../models/shared/feedbackquery.md) | :heavy_check_mark: | The request object to use for the request. |
693
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
694
+
695
+
696
+ ### Response
697
+
698
+ **Promise<[operations.PostFeedbackResponse](../../models/operations/postfeedbackresponse.md)>**
699
+
700
+
701
+ ## postGenerations
702
+
703
+ Generate a text
704
+
705
+ ### Example Usage
706
+
707
+ ```typescript
708
+ import { HoneyHive } from "HoneyHive";
709
+
710
+ (async() => {
711
+ const sdk = new HoneyHive({
712
+ bearerAuth: "",
713
+ });
714
+
715
+ const res = await sdk.honeyHive.postGenerations({
716
+ input: {},
717
+ metadata: {},
718
+ prompts: [
719
+ "string",
720
+ ],
721
+ userProperties: {},
722
+ });
723
+
724
+
725
+ if (res.statusCode == 200) {
726
+ // handle response
727
+ }
728
+ })();
729
+ ```
730
+
731
+ ### Parameters
732
+
733
+ | Parameter | Type | Required | Description |
734
+ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
735
+ | `request` | [shared.GenerateQuery](../../models/shared/generatequery.md) | :heavy_check_mark: | The request object to use for the request. |
736
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
737
+
738
+
739
+ ### Response
740
+
741
+ **Promise<[operations.PostGenerationsResponse](../../models/operations/postgenerationsresponse.md)>**
742
+
743
+
744
+ ## postGenerationsLog
745
+
746
+ Log a generation
747
+
748
+ ### Example Usage
749
+
750
+ ```typescript
751
+ import { HoneyHive } from "HoneyHive";
752
+
753
+ (async() => {
754
+ const sdk = new HoneyHive({
755
+ bearerAuth: "",
756
+ });
757
+
758
+ const res = await sdk.honeyHive.postGenerationsLog({
759
+ feedback: {},
760
+ hyperparameters: {},
761
+ inputs: {},
762
+ metadata: {},
763
+ usage: {},
764
+ userProperties: {},
765
+ });
766
+
767
+
768
+ if (res.statusCode == 200) {
769
+ // handle response
770
+ }
771
+ })();
772
+ ```
773
+
774
+ ### Parameters
775
+
776
+ | Parameter | Type | Required | Description |
777
+ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
778
+ | `request` | [shared.GenerationLoggingQuery](../../models/shared/generationloggingquery.md) | :heavy_check_mark: | The request object to use for the request. |
779
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
780
+
781
+
782
+ ### Response
783
+
784
+ **Promise<[operations.PostGenerationsLogResponse](../../models/operations/postgenerationslogresponse.md)>**
785
+
786
+
787
+ ## postMetrics
788
+
789
+ Create a metric
790
+
791
+ ### Example Usage
792
+
793
+ ```typescript
794
+ import { HoneyHive } from "HoneyHive";
795
+
796
+ (async() => {
797
+ const sdk = new HoneyHive({
798
+ bearerAuth: "",
799
+ });
800
+
801
+ const res = await sdk.honeyHive.postMetrics({});
802
+
803
+
804
+ if (res.statusCode == 200) {
805
+ // handle response
806
+ }
807
+ })();
808
+ ```
809
+
810
+ ### Parameters
811
+
812
+ | Parameter | Type | Required | Description |
813
+ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
814
+ | `request` | [shared.MetricRequest](../../models/shared/metricrequest.md) | :heavy_check_mark: | The request object to use for the request. |
815
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
816
+
817
+
818
+ ### Response
819
+
820
+ **Promise<[operations.PostMetricsResponse](../../models/operations/postmetricsresponse.md)>**
821
+
822
+
823
+ ## postPrompts
824
+
825
+ Create a prompt
826
+
827
+ ### Example Usage
828
+
829
+ ```typescript
830
+ import { HoneyHive } from "HoneyHive";
831
+
832
+ (async() => {
833
+ const sdk = new HoneyHive({
834
+ bearerAuth: "",
835
+ });
836
+
837
+ const res = await sdk.honeyHive.postPrompts({
838
+ fewShotExamples: [
839
+ {},
840
+ ],
841
+ hyperparameters: {
842
+ "key": "string",
843
+ },
844
+ });
845
+
846
+
847
+ if (res.statusCode == 200) {
848
+ // handle response
849
+ }
850
+ })();
851
+ ```
852
+
853
+ ### Parameters
854
+
855
+ | Parameter | Type | Required | Description |
856
+ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
857
+ | `request` | [shared.PromptCreationQuery](../../models/shared/promptcreationquery.md) | :heavy_check_mark: | The request object to use for the request. |
858
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
859
+
860
+
861
+ ### Response
862
+
863
+ **Promise<[operations.PostPromptsResponse](../../models/operations/postpromptsresponse.md)>**
864
+
865
+
866
+ ## postSessionStart
867
+
868
+ Start a session
869
+
870
+ ### Example Usage
871
+
872
+ ```typescript
873
+ import { HoneyHive } from "HoneyHive";
874
+
875
+ (async() => {
876
+ const sdk = new HoneyHive({
877
+ bearerAuth: "",
878
+ });
879
+
880
+ const res = await sdk.honeyHive.postSessionStart({
881
+ userProperties: {},
882
+ });
883
+
884
+
885
+ if (res.statusCode == 200) {
886
+ // handle response
887
+ }
888
+ })();
889
+ ```
890
+
891
+ ### Parameters
892
+
893
+ | Parameter | Type | Required | Description |
894
+ | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
895
+ | `request` | [shared.SessionStartQuery](../../models/shared/sessionstartquery.md) | :heavy_check_mark: | The request object to use for the request. |
896
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
897
+
898
+
899
+ ### Response
900
+
901
+ **Promise<[operations.PostSessionStartResponse](../../models/operations/postsessionstartresponse.md)>**
902
+
903
+
904
+ ## postSessionSessionIdEnd
905
+
906
+ End a session
907
+
908
+ ### Example Usage
909
+
910
+ ```typescript
911
+ import { HoneyHive } from "HoneyHive";
912
+
913
+ (async() => {
914
+ const sdk = new HoneyHive({
915
+ bearerAuth: "",
916
+ });
917
+
918
+ const res = await sdk.honeyHive.postSessionSessionIdEnd({
919
+ sessionId: "string",
920
+ });
921
+
922
+
923
+ if (res.statusCode == 200) {
924
+ // handle response
925
+ }
926
+ })();
927
+ ```
928
+
929
+ ### Parameters
930
+
931
+ | Parameter | Type | Required | Description |
932
+ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
933
+ | `request` | [operations.PostSessionSessionIdEndRequest](../../models/operations/postsessionsessionidendrequest.md) | :heavy_check_mark: | The request object to use for the request. |
934
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
935
+
936
+
937
+ ### Response
938
+
939
+ **Promise<[operations.PostSessionSessionIdEndResponse](../../models/operations/postsessionsessionidendresponse.md)>**
940
+
941
+
942
+ ## postSessionSessionIdEvent
943
+
944
+ Log an event
945
+
946
+ ### Example Usage
947
+
948
+ ```typescript
949
+ import { HoneyHive } from "HoneyHive";
950
+
951
+ (async() => {
952
+ const sdk = new HoneyHive({
953
+ bearerAuth: "",
954
+ });
955
+
956
+ const res = await sdk.honeyHive.postSessionSessionIdEvent({
957
+ sessionEventQuery: {
958
+ children: [
959
+ {},
960
+ ],
961
+ config: {},
962
+ error: {},
963
+ inputs: {},
964
+ metadata: {},
965
+ },
966
+ sessionId: "string",
967
+ });
968
+
969
+
970
+ if (res.statusCode == 200) {
971
+ // handle response
972
+ }
973
+ })();
974
+ ```
975
+
976
+ ### Parameters
977
+
978
+ | Parameter | Type | Required | Description |
979
+ | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
980
+ | `request` | [operations.PostSessionSessionIdEventRequest](../../models/operations/postsessionsessionideventrequest.md) | :heavy_check_mark: | The request object to use for the request. |
981
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
982
+
983
+
984
+ ### Response
985
+
986
+ **Promise<[operations.PostSessionSessionIdEventResponse](../../models/operations/postsessionsessionideventresponse.md)>**
987
+
988
+
989
+ ## postSessionSessionIdFeedback
990
+
991
+ Log session feedback
992
+
993
+ ### Example Usage
994
+
995
+ ```typescript
996
+ import { HoneyHive } from "HoneyHive";
997
+
998
+ (async() => {
999
+ const sdk = new HoneyHive({
1000
+ bearerAuth: "",
1001
+ });
1002
+
1003
+ const res = await sdk.honeyHive.postSessionSessionIdFeedback({
1004
+ sessionFeedback: {
1005
+ feedback: {},
1006
+ },
1007
+ sessionId: "string",
1008
+ });
1009
+
1010
+
1011
+ if (res.statusCode == 200) {
1012
+ // handle response
1013
+ }
1014
+ })();
1015
+ ```
1016
+
1017
+ ### Parameters
1018
+
1019
+ | Parameter | Type | Required | Description |
1020
+ | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
1021
+ | `request` | [operations.PostSessionSessionIdFeedbackRequest](../../models/operations/postsessionsessionidfeedbackrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1022
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1023
+
1024
+
1025
+ ### Response
1026
+
1027
+ **Promise<[operations.PostSessionSessionIdFeedbackResponse](../../models/operations/postsessionsessionidfeedbackresponse.md)>**
1028
+
1029
+
1030
+ ## postSessionsSessionIdTraces
1031
+
1032
+ Log a trace
1033
+
1034
+ ### Example Usage
1035
+
1036
+ ```typescript
1037
+ import { HoneyHive } from "HoneyHive";
1038
+
1039
+ (async() => {
1040
+ const sdk = new HoneyHive({
1041
+ bearerAuth: "",
1042
+ });
1043
+
1044
+ const res = await sdk.honeyHive.postSessionsSessionIdTraces({
1045
+ sessionTrace: {
1046
+ logs: [
1047
+ {
1048
+ children: [
1049
+ {},
1050
+ ],
1051
+ config: {},
1052
+ error: {},
1053
+ inputs: {},
1054
+ metadata: {},
1055
+ },
1056
+ ],
1057
+ },
1058
+ sessionId: "string",
1059
+ });
1060
+
1061
+
1062
+ if (res.statusCode == 200) {
1063
+ // handle response
1064
+ }
1065
+ })();
1066
+ ```
1067
+
1068
+ ### Parameters
1069
+
1070
+ | Parameter | Type | Required | Description |
1071
+ | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
1072
+ | `request` | [operations.PostSessionsSessionIdTracesRequest](../../models/operations/postsessionssessionidtracesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1073
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1074
+
1075
+
1076
+ ### Response
1077
+
1078
+ **Promise<[operations.PostSessionsSessionIdTracesResponse](../../models/operations/postsessionssessionidtracesresponse.md)>**
1079
+
1080
+
1081
+ ## postTasks
1082
+
1083
+ Create a task
1084
+
1085
+ ### Example Usage
1086
+
1087
+ ```typescript
1088
+ import { HoneyHive } from "HoneyHive";
1089
+
1090
+ (async() => {
1091
+ const sdk = new HoneyHive({
1092
+ bearerAuth: "",
1093
+ });
1094
+
1095
+ const res = await sdk.honeyHive.postTasks({
1096
+ datasets: [
1097
+ {
1098
+ file: [
1099
+ {},
1100
+ ],
1101
+ },
1102
+ ],
1103
+ fineTunedModels: [
1104
+ {},
1105
+ ],
1106
+ metrics: [
1107
+ {
1108
+ threshold: {},
1109
+ },
1110
+ ],
1111
+ prompts: [
1112
+ {
1113
+ fewShotExamples: [
1114
+ {},
1115
+ ],
1116
+ hyperparameters: {
1117
+ "key": "string",
1118
+ },
1119
+ inputVariables: [
1120
+ "string",
1121
+ ],
1122
+ },
1123
+ ],
1124
+ });
1125
+
1126
+
1127
+ if (res.statusCode == 200) {
1128
+ // handle response
1129
+ }
1130
+ })();
1131
+ ```
1132
+
1133
+ ### Parameters
1134
+
1135
+ | Parameter | Type | Required | Description |
1136
+ | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
1137
+ | `request` | [shared.TaskCreationQuery](../../models/shared/taskcreationquery.md) | :heavy_check_mark: | The request object to use for the request. |
1138
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1139
+
1140
+
1141
+ ### Response
1142
+
1143
+ **Promise<[operations.PostTasksResponse](../../models/operations/posttasksresponse.md)>**
1144
+
1145
+
1146
+ ## putPromptsId
1147
+
1148
+ Update a prompt
1149
+
1150
+ ### Example Usage
1151
+
1152
+ ```typescript
1153
+ import { HoneyHive } from "HoneyHive";
1154
+
1155
+ (async() => {
1156
+ const sdk = new HoneyHive({
1157
+ bearerAuth: "",
1158
+ });
1159
+
1160
+ const res = await sdk.honeyHive.putPromptsId({
1161
+ promptUpdateQuery: {
1162
+ fewShotExamples: [
1163
+ {},
1164
+ ],
1165
+ hyperparameters: {
1166
+ "key": "string",
1167
+ },
1168
+ inputVariables: [
1169
+ "string",
1170
+ ],
1171
+ },
1172
+ id: "<ID>",
1173
+ });
1174
+
1175
+
1176
+ if (res.statusCode == 200) {
1177
+ // handle response
1178
+ }
1179
+ })();
1180
+ ```
1181
+
1182
+ ### Parameters
1183
+
1184
+ | Parameter | Type | Required | Description |
1185
+ | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
1186
+ | `request` | [operations.PutPromptsIdRequest](../../models/operations/putpromptsidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1187
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1188
+
1189
+
1190
+ ### Response
1191
+
1192
+ **Promise<[operations.PutPromptsIdResponse](../../models/operations/putpromptsidresponse.md)>**
1193
+
1194
+
1195
+ ## putTasks
1196
+
1197
+ Update a task
1198
+
1199
+ ### Example Usage
1200
+
1201
+ ```typescript
1202
+ import { HoneyHive } from "HoneyHive";
1203
+
1204
+ (async() => {
1205
+ const sdk = new HoneyHive({
1206
+ bearerAuth: "",
1207
+ });
1208
+
1209
+ const res = await sdk.honeyHive.putTasks({
1210
+ datasets: [
1211
+ {
1212
+ file: [
1213
+ {},
1214
+ ],
1215
+ },
1216
+ ],
1217
+ fineTunedModels: [
1218
+ {},
1219
+ ],
1220
+ metrics: [
1221
+ {
1222
+ threshold: {},
1223
+ },
1224
+ ],
1225
+ prompts: [
1226
+ {
1227
+ fewShotExamples: [
1228
+ {},
1229
+ ],
1230
+ hyperparameters: {
1231
+ "key": "string",
1232
+ },
1233
+ inputVariables: [
1234
+ "string",
1235
+ ],
1236
+ },
1237
+ ],
1238
+ });
1239
+
1240
+
1241
+ if (res.statusCode == 200) {
1242
+ // handle response
1243
+ }
1244
+ })();
1245
+ ```
1246
+
1247
+ ### Parameters
1248
+
1249
+ | Parameter | Type | Required | Description |
1250
+ | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
1251
+ | `request` | [shared.TaskUpdateQuery](../../models/shared/taskupdatequery.md) | :heavy_check_mark: | The request object to use for the request. |
1252
+ | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1253
+
1254
+
1255
+ ### Response
1256
+
1257
+ **Promise<[operations.PutTasksResponse](../../models/operations/puttasksresponse.md)>**
1258
+