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
package/docs/models/shared/metricresponse.md ADDED
@@ -0,0 +1,22 @@
1
+ # MetricResponse
2
+
3
+ The response object for a metric
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
10
+ | `codeSnippet` | *string* | :heavy_minus_sign: | The code snippet for the metric |
11
+ | `criteria` | *string* | :heavy_minus_sign: | The passing criteria of the metric |
12
+ | `description` | *string* | :heavy_minus_sign: | The description of for the metric |
13
+ | `enabledInProd` | *boolean* | :heavy_minus_sign: | Boolean flag representing whether the metric is enabled in production |
14
+ | `id` | *string* | :heavy_minus_sign: | The ID of the metric |
15
+ | `name` | *string* | :heavy_minus_sign: | The name of the metric |
16
+ | `needsGroundTruth` | *boolean* | :heavy_minus_sign: | Boolean flag representing whether the metrics needs ground-truth labeling |
17
+ | `passWhen` | *boolean* | :heavy_minus_sign: | Specifies when the metric will pass |
18
+ | `prompt` | *string* | :heavy_minus_sign: | The prompt that this metric is calculated on |
19
+ | `returnType` | *string* | :heavy_minus_sign: | The return type of the metric |
20
+ | `task` | *string* | :heavy_minus_sign: | The task name for the metric |
21
+ | `threshold` | [MetricResponseThreshold](../../models/shared/metricresponsethreshold.md) | :heavy_minus_sign: | The alerting thresholds of the metric |
22
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The timestamp when the metric was last updated |
package/docs/models/shared/metricresponsethreshold.md ADDED
@@ -0,0 +1,9 @@
1
+ # MetricResponseThreshold
2
+
3
+ The alerting thresholds of the metric
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/promptcreationquery.md ADDED
@@ -0,0 +1,18 @@
1
+ # PromptCreationQuery
2
+
3
+ The request object for creating a prompt
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
10
+ | `chat` | *string* | :heavy_minus_sign: | The text of the chat prompt |
11
+ | `fewShotExamples` | [PromptCreationQueryFewShotExamples](../../models/shared/promptcreationqueryfewshotexamples.md)[] | :heavy_minus_sign: | The few shot examples for the prompt |
12
+ | `hyperparameters` | Record<string, *any*> | :heavy_minus_sign: | The hyperparameters for the prompt |
13
+ | `isDeployed` | *boolean* | :heavy_minus_sign: | Flag indicating if the prompt is deployed |
14
+ | `model` | *string* | :heavy_minus_sign: | The model to be used for the prompt |
15
+ | `provider` | *string* | :heavy_minus_sign: | The model provider |
16
+ | `task` | *string* | :heavy_minus_sign: | The task for which the prompt is being created |
17
+ | `text` | *string* | :heavy_minus_sign: | The text of the prompt |
18
+ | `version` | *string* | :heavy_minus_sign: | The version of the prompt |
package/docs/models/shared/promptcreationqueryfewshotexamples.md ADDED
@@ -0,0 +1,7 @@
1
+ # PromptCreationQueryFewShotExamples
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/promptresponse.md ADDED
@@ -0,0 +1,20 @@
1
+ # PromptResponse
2
+
3
+ The response object for a prompt
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
10
+ | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The timestamp of when the prompt was created |
11
+ | `fewShotExamples` | [PromptResponseFewShotExamples](../../models/shared/promptresponsefewshotexamples.md)[] | :heavy_minus_sign: | The few shot examples for the prompt |
12
+ | `hyperparameters` | Record<string, *any*> | :heavy_minus_sign: | The hyperparameters for the prompt |
13
+ | `inputVariables` | *string*[] | :heavy_minus_sign: | The input variables to feed into the prompt |
14
+ | `isDeployed` | *boolean* | :heavy_minus_sign: | Flag indicating if the prompt is deployed |
15
+ | `model` | *string* | :heavy_minus_sign: | The model to be used for the prompt |
16
+ | `name` | *string* | :heavy_minus_sign: | The unique name of the prompt |
17
+ | `task` | *string* | :heavy_minus_sign: | The task for which the prompt is being created |
18
+ | `text` | *string* | :heavy_minus_sign: | The text of the prompt |
19
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The timestamp of when the prompt was last updated |
20
+ | `version` | *string* | :heavy_minus_sign: | The version of the prompt |
package/docs/models/shared/promptresponsefewshotexamples.md ADDED
@@ -0,0 +1,7 @@
1
+ # PromptResponseFewShotExamples
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/promptupdatequery.md ADDED
@@ -0,0 +1,16 @@
1
+ # PromptUpdateQuery
2
+
3
+ The request object for updating a prompt
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
10
+ | `fewShotExamples` | [PromptUpdateQueryFewShotExamples](../../models/shared/promptupdatequeryfewshotexamples.md)[] | :heavy_minus_sign: | The few shot examples for the prompt |
11
+ | `hyperparameters` | Record<string, *any*> | :heavy_minus_sign: | The hyperparameters for the prompt |
12
+ | `id` | *string* | :heavy_minus_sign: | The ID of the prompt |
13
+ | `inputVariables` | *string*[] | :heavy_minus_sign: | The input variables to feed into the prompt |
14
+ | `isDeployed` | *boolean* | :heavy_minus_sign: | Flag indicating if the prompt is deployed |
15
+ | `model` | *string* | :heavy_minus_sign: | The model to be used for the prompt |
16
+ | `version` | *string* | :heavy_minus_sign: | The version of the prompt |
package/docs/models/shared/promptupdatequeryfewshotexamples.md ADDED
@@ -0,0 +1,7 @@
1
+ # PromptUpdateQueryFewShotExamples
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/security.md ADDED
@@ -0,0 +1,8 @@
1
+ # Security
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description | Example |
7
+ | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
8
+ | `bearerAuth` | *string* | :heavy_check_mark: | N/A | |
package/docs/models/shared/sessionendresponse.md ADDED
@@ -0,0 +1,11 @@
1
+ # SessionEndResponse
2
+
3
+ The response object for ending a session
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
10
+ | `id` | *string* | :heavy_minus_sign: | The id of the session |
11
+ | `success` | *boolean* | :heavy_minus_sign: | Indicates whether ending the session was successful |
package/docs/models/shared/sessioneventquery.md ADDED
@@ -0,0 +1,21 @@
1
+ # SessionEventQuery
2
+
3
+ The request object for querying session events
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
10
+ | `children` | [SessionEventQueryChildren](../../models/shared/sessioneventquerychildren.md)[] | :heavy_minus_sign: | Child events |
11
+ | `config` | [SessionEventQueryConfig](../../models/shared/sessioneventqueryconfig.md) | :heavy_minus_sign: | The configuration of LLM, Tool or other for the event |
12
+ | `duration` | *number* | :heavy_minus_sign: | Duration of the event |
13
+ | `error` | [SessionEventQueryError](../../models/shared/sessioneventqueryerror.md) | :heavy_minus_sign: | Error from the event |
14
+ | `eventId` | *string* | :heavy_minus_sign: | The ID of the event |
15
+ | `eventName` | *string* | :heavy_minus_sign: | The name for the event |
16
+ | `eventType` | *string* | :heavy_minus_sign: | The type of the event |
17
+ | `inputs` | [SessionEventQueryInputs](../../models/shared/sessioneventqueryinputs.md) | :heavy_minus_sign: | Inputs to the event |
18
+ | `metadata` | [SessionEventQueryMetadata](../../models/shared/sessioneventquerymetadata.md) | :heavy_minus_sign: | Metadata of the event |
19
+ | `output` | *string* | :heavy_minus_sign: | Output of the event |
20
+ | `parentId` | *string* | :heavy_minus_sign: | The parent ID of the event |
21
+ | `source` | *string* | :heavy_minus_sign: | Source of the event |
package/docs/models/shared/sessioneventquerychildren.md ADDED
@@ -0,0 +1,7 @@
1
+ # SessionEventQueryChildren
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/sessioneventqueryconfig.md ADDED
@@ -0,0 +1,9 @@
1
+ # SessionEventQueryConfig
2
+
3
+ The configuration of LLM, Tool or other for the event
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/sessioneventqueryerror.md ADDED
@@ -0,0 +1,9 @@
1
+ # SessionEventQueryError
2
+
3
+ Error from the event
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/sessioneventqueryinputs.md ADDED
@@ -0,0 +1,9 @@
1
+ # SessionEventQueryInputs
2
+
3
+ Inputs to the event
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/sessioneventquerymetadata.md ADDED
@@ -0,0 +1,9 @@
1
+ # SessionEventQueryMetadata
2
+
3
+ Metadata of the event
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/sessioneventresponse.md ADDED
@@ -0,0 +1,11 @@
1
+ # SessionEventResponse
2
+
3
+ The response object for recording a session event
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
10
+ | `eventId` | *string* | :heavy_minus_sign: | The ID of the event |
11
+ | `success` | *boolean* | :heavy_minus_sign: | Indicates whether recording the event was successful |
package/docs/models/shared/sessionfeedback.md ADDED
@@ -0,0 +1,11 @@
1
+ # SessionFeedback
2
+
3
+ The request object for providing feedback for a session
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
10
+ | `eventId` | *string* | :heavy_minus_sign: | The ID of the specific event to provide feedback for |
11
+ | `feedback` | [SessionFeedbackFeedback](../../models/shared/sessionfeedbackfeedback.md) | :heavy_minus_sign: | The feedback for the session |
package/docs/models/shared/sessionfeedbackfeedback.md ADDED
@@ -0,0 +1,9 @@
1
+ # SessionFeedbackFeedback
2
+
3
+ The feedback for the session
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/sessionstartquery.md ADDED
@@ -0,0 +1,14 @@
1
+ # SessionStartQuery
2
+
3
+ The request object for starting a session
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
10
+ | `project` | *string* | :heavy_minus_sign: | The project name for the session |
11
+ | `sessionId` | *string* | :heavy_minus_sign: | The ID of the session |
12
+ | `sessionName` | *string* | :heavy_minus_sign: | The name for the session |
13
+ | `source` | *string* | :heavy_minus_sign: | The source of the session |
14
+ | `userProperties` | [SessionStartQueryUserProperties](../../models/shared/sessionstartqueryuserproperties.md) | :heavy_minus_sign: | The user properties for the session |
package/docs/models/shared/sessionstartqueryuserproperties.md ADDED
@@ -0,0 +1,9 @@
1
+ # SessionStartQueryUserProperties
2
+
3
+ The user properties for the session
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/sessionstartresponse.md ADDED
@@ -0,0 +1,11 @@
1
+ # SessionStartResponse
2
+
3
+ The response object for starting a session
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
10
+ | `projectId` | *string* | :heavy_minus_sign: | The ID of the project for the session |
11
+ | `sessionId` | *string* | :heavy_minus_sign: | The ID of the started session |
package/docs/models/shared/sessiontrace.md ADDED
@@ -0,0 +1,10 @@
1
+ # SessionTrace
2
+
3
+ The response object for a session trace
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
10
+ | `logs` | [SessionEventQuery](../../models/shared/sessioneventquery.md)[] | :heavy_minus_sign: | The trace logs for the session |
package/docs/models/shared/successresponse.md ADDED
@@ -0,0 +1,11 @@
1
+ # SuccessResponse
2
+
3
+ The response object indicating the success of an operation
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
10
+ | `id` | *string* | :heavy_minus_sign: | The ID of the created object |
11
+ | `success` | *boolean* | :heavy_minus_sign: | Indicates whether the request was successful |
package/docs/models/shared/successtraceresponse.md ADDED
@@ -0,0 +1,11 @@
1
+ # SuccessTraceResponse
2
+
3
+ The response object indicating the success of the tracing operation
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
10
+ | `sessionId` | *string* | :heavy_minus_sign: | The ID of the session |
11
+ | `success` | *boolean* | :heavy_minus_sign: | Indicates whether the request was successful |
package/docs/models/shared/taskcreationquery.md ADDED
@@ -0,0 +1,18 @@
1
+ # TaskCreationQuery
2
+
3
+ The request object for creating a task
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
10
+ | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The timestamp of when the task was created |
11
+ | `datasets` | [DatasetResponse](../../models/shared/datasetresponse.md)[] | :heavy_minus_sign: | The datasets for the task |
12
+ | `description` | *string* | :heavy_minus_sign: | The description of the task |
13
+ | `fineTunedModels` | [FineTunedModelResponse](../../models/shared/finetunedmodelresponse.md)[] | :heavy_minus_sign: | The fine-tuned models for the task |
14
+ | `metrics` | [MetricResponse](../../models/shared/metricresponse.md)[] | :heavy_minus_sign: | The metrics for the task |
15
+ | `name` | *string* | :heavy_minus_sign: | The name of the task |
16
+ | `prompts` | [PromptResponse](../../models/shared/promptresponse.md)[] | :heavy_minus_sign: | The prompts for the task |
17
+ | `type` | *string* | :heavy_minus_sign: | The type of the task |
18
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The timestamp of when the task was last updated |
package/docs/models/shared/taskresponse.md ADDED
@@ -0,0 +1,20 @@
1
+ # TaskResponse
2
+
3
+ The response object for a task
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
10
+ | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The timestamp of when the task was created |
11
+ | `datasets` | [DatasetResponse](../../models/shared/datasetresponse.md)[] | :heavy_minus_sign: | The datasets for the task |
12
+ | `description` | *string* | :heavy_minus_sign: | The description of the task |
13
+ | `fineTunedModels` | [FineTunedModelResponse](../../models/shared/finetunedmodelresponse.md)[] | :heavy_minus_sign: | The fine-tuned models for the task |
14
+ | `id` | *string* | :heavy_minus_sign: | The ID of the task |
15
+ | `metrics` | [MetricResponse](../../models/shared/metricresponse.md)[] | :heavy_minus_sign: | The metrics for the task |
16
+ | `name` | *string* | :heavy_minus_sign: | The name of the task |
17
+ | `prompts` | [PromptResponse](../../models/shared/promptresponse.md)[] | :heavy_minus_sign: | The prompts for the task |
18
+ | `tenant` | *string* | :heavy_minus_sign: | The tenant that this task belongs to |
19
+ | `type` | *string* | :heavy_minus_sign: | The type of the task |
20
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The timestamp of when the task was last updated |
package/docs/models/shared/taskupdatequery.md ADDED
@@ -0,0 +1,16 @@
1
+ # TaskUpdateQuery
2
+
3
+ The request object for updating a task
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
10
+ | `datasets` | [DatasetResponse](../../models/shared/datasetresponse.md)[] | :heavy_minus_sign: | The new datasets for the task |
11
+ | `fineTunedModels` | [FineTunedModelResponse](../../models/shared/finetunedmodelresponse.md)[] | :heavy_minus_sign: | The new fine-tuned models for the task |
12
+ | `metrics` | [MetricResponse](../../models/shared/metricresponse.md)[] | :heavy_minus_sign: | The new metrics for the task |
13
+ | `name` | *string* | :heavy_minus_sign: | The new name of the task |
14
+ | `prompts` | [PromptResponse](../../models/shared/promptresponse.md)[] | :heavy_minus_sign: | The new prompts for the task |
15
+ | `taskId` | *string* | :heavy_minus_sign: | The id of the task being updated |
16
+ | `type` | *string* | :heavy_minus_sign: | The new type of the task |
package/docs/models/shared/taskupdateresponse.md ADDED
@@ -0,0 +1,12 @@
1
+ # TaskUpdateResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
8
+ | `acknowledged` | *boolean* | :heavy_minus_sign: | Boolean flag representing if the update operation was successful |
9
+ | `matchedCount` | *number* | :heavy_minus_sign: | Number of modified tasks |
10
+ | `modifiedCount` | *number* | :heavy_minus_sign: | Number of modified tasks |
11
+ | `upsertedCount` | *number* | :heavy_minus_sign: | Number of upserted tasks |
12
+ | `upsertedId` | *string* | :heavy_minus_sign: | The upserted ID of the task, if id has been changed |
package/docs/models/shared/traceevent.md ADDED
@@ -0,0 +1,14 @@
1
+ # TraceEvent
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
8
+ | `args` | Record<string, *any*> | :heavy_minus_sign: | Arguments associated with the event. |
9
+ | `cat` | *string* | :heavy_minus_sign: | The category of the event. |
10
+ | `name` | *string* | :heavy_check_mark: | The name of the event. |
11
+ | `ph` | *string* | :heavy_check_mark: | The phase of the event. |
12
+ | `pid` | *number* | :heavy_check_mark: | The process ID. |
13
+ | `tid` | *number* | :heavy_check_mark: | The thread ID. |
14
+ | `ts` | *number* | :heavy_check_mark: | The timestamp of the event in microseconds. |
package/docs/models/shared/uploaddataset.md ADDED
@@ -0,0 +1,15 @@
1
+ # UploadDataset
2
+
3
+ The request object for uploading a dataset
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
10
+ | `description` | *string* | :heavy_minus_sign: | The description of the dataset |
11
+ | `file` | [UploadDatasetFile](../../models/shared/uploaddatasetfile.md)[] | :heavy_minus_sign: | N/A |
12
+ | `name` | *string* | :heavy_minus_sign: | The name of the dataset |
13
+ | `prompt` | *string* | :heavy_minus_sign: | The prompt related to the dataset |
14
+ | `purpose` | *string* | :heavy_minus_sign: | The purpose of the dataset |
15
+ | `task` | *string* | :heavy_minus_sign: | The task related to the dataset |
package/docs/models/shared/uploaddatasetfile.md ADDED
@@ -0,0 +1,7 @@
1
+ # UploadDatasetFile
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ----------- | ----------- | ----------- | ----------- |