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/operations/postsessionsessionideventresponse.md ADDED
@@ -0,0 +1,11 @@
1
+ # PostSessionSessionIdEventResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
8
+ | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
9
+ | `sessionEventResponse` | [shared.SessionEventResponse](../../models/shared/sessioneventresponse.md) | :heavy_minus_sign: | OK |
10
+ | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
11
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
package/docs/models/operations/postsessionsessionidfeedbackrequest.md ADDED
@@ -0,0 +1,9 @@
1
+ # PostSessionSessionIdFeedbackRequest
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
8
+ | `sessionFeedback` | [shared.SessionFeedback](../../models/shared/sessionfeedback.md) | :heavy_check_mark: | N/A |
9
+ | `sessionId` | *string* | :heavy_check_mark: | N/A |
package/docs/models/operations/postsessionsessionidfeedbackresponse.md ADDED
@@ -0,0 +1,11 @@
1
+ # PostSessionSessionIdFeedbackResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
8
+ | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
9
+ | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
10
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
11
+ | `successResponse` | [shared.SuccessResponse](../../models/shared/successresponse.md) | :heavy_minus_sign: | OK |
package/docs/models/operations/postsessionssessionidtracesrequest.md ADDED
@@ -0,0 +1,9 @@
1
+ # PostSessionsSessionIdTracesRequest
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
8
+ | `sessionTrace` | [shared.SessionTrace](../../models/shared/sessiontrace.md) | :heavy_check_mark: | N/A |
9
+ | `sessionId` | *string* | :heavy_check_mark: | N/A |
package/docs/models/operations/postsessionssessionidtracesresponse.md ADDED
@@ -0,0 +1,11 @@
1
+ # PostSessionsSessionIdTracesResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
8
+ | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
9
+ | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
10
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
11
+ | `successTraceResponse` | [shared.SuccessTraceResponse](../../models/shared/successtraceresponse.md) | :heavy_minus_sign: | OK |
package/docs/models/operations/postsessionstartresponse.md ADDED
@@ -0,0 +1,11 @@
1
+ # PostSessionStartResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
8
+ | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
9
+ | `sessionStartResponse` | [shared.SessionStartResponse](../../models/shared/sessionstartresponse.md) | :heavy_minus_sign: | OK |
10
+ | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
11
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
package/docs/models/operations/posttasksresponse.md ADDED
@@ -0,0 +1,11 @@
1
+ # PostTasksResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
8
+ | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
9
+ | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
10
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
11
+ | `taskResponse` | [shared.TaskResponse](../../models/shared/taskresponse.md) | :heavy_minus_sign: | OK |
package/docs/models/operations/putpromptsidrequest.md ADDED
@@ -0,0 +1,9 @@
1
+ # PutPromptsIdRequest
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
8
+ | `promptUpdateQuery` | [shared.PromptUpdateQuery](../../models/shared/promptupdatequery.md) | :heavy_check_mark: | N/A |
9
+ | `id` | *string* | :heavy_check_mark: | N/A |
package/docs/models/operations/putpromptsidresponse.md ADDED
@@ -0,0 +1,11 @@
1
+ # PutPromptsIdResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
8
+ | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
9
+ | `promptResponse` | [shared.PromptResponse](../../models/shared/promptresponse.md) | :heavy_minus_sign: | OK |
10
+ | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
11
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
package/docs/models/operations/puttasksresponse.md ADDED
@@ -0,0 +1,11 @@
1
+ # PutTasksResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
8
+ | `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
9
+ | `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
10
+ | `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
11
+ | `taskUpdateResponse` | [shared.TaskUpdateResponse](../../models/shared/taskupdateresponse.md) | :heavy_minus_sign: | OK |
package/docs/models/shared/datasetresponse.md ADDED
@@ -0,0 +1,20 @@
1
+ # DatasetResponse
2
+
3
+ The response object for a dataset
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
10
+ | `bytes` | *number* | :heavy_minus_sign: | The size of the dataset in bytes |
11
+ | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The timestamp of when the dataset was created |
12
+ | `description` | *string* | :heavy_minus_sign: | The description of the dataset |
13
+ | `file` | [DatasetResponseFile](../../models/shared/datasetresponsefile.md)[] | :heavy_minus_sign: | The file in the dataset |
14
+ | `id` | *string* | :heavy_minus_sign: | The id of this dataset |
15
+ | `name` | *string* | :heavy_minus_sign: | The name of the dataset file |
16
+ | `prompt` | *string* | :heavy_minus_sign: | The prompt related to the dataset |
17
+ | `purpose` | *string* | :heavy_minus_sign: | The purpose of the dataset |
18
+ | `task` | *string* | :heavy_minus_sign: | The task related to the dataset |
19
+ | `tenant` | *string* | :heavy_minus_sign: | The tenant that this dataset belongs to |
20
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The timestamp of when the dataset was last updated |
package/docs/models/shared/datasetresponsefile.md ADDED
@@ -0,0 +1,7 @@
1
+ # DatasetResponseFile
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/deleteresponse.md ADDED
@@ -0,0 +1,10 @@
1
+ # DeleteResponse
2
+
3
+ The response object for a delete operation
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
10
+ | `deleted` | *boolean* | :heavy_minus_sign: | Indicates whether the object was deleted or not |
package/docs/models/shared/evaluationloggingquery.md ADDED
@@ -0,0 +1,23 @@
1
+ # EvaluationLoggingQuery
2
+
3
+ The request object for logging an evaluation
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
10
+ | `comments` | [EvaluationLoggingQueryComments](../../models/shared/evaluationloggingquerycomments.md)[] | :heavy_minus_sign: | The comments for the evaluation |
11
+ | `dataset` | [EvaluationLoggingQueryDataset](../../models/shared/evaluationloggingquerydataset.md)[] | :heavy_minus_sign: | The dataset for which the evaluation is being created |
12
+ | `datasetName` | *string* | :heavy_minus_sign: | The name of the dataset for which the evaluation is being created |
13
+ | `description` | *string* | :heavy_minus_sign: | The description of the evaluation |
14
+ | `generations` | [EvaluationLoggingQueryGenerations](../../models/shared/evaluationloggingquerygenerations.md)[] | :heavy_minus_sign: | The completions for prompts that are being evaluated |
15
+ | `id` | *string* | :heavy_minus_sign: | The id of the evaluation |
16
+ | `metrics` | [EvaluationLoggingQueryMetrics](../../models/shared/evaluationloggingquerymetrics.md)[][] | :heavy_minus_sign: | The metrics that are computed for the completions |
17
+ | `metricsToCompute` | *string*[] | :heavy_minus_sign: | The metrics that are computed for the completions |
18
+ | `name` | *string* | :heavy_minus_sign: | The name of the evaluation |
19
+ | `prompts` | [EvaluationLoggingQueryPrompts](../../models/shared/evaluationloggingqueryprompts.md)[] | :heavy_minus_sign: | The prompts for which the evaluation is being created |
20
+ | `results` | [EvaluationLoggingQueryResults](../../models/shared/evaluationloggingqueryresults.md)[] | :heavy_minus_sign: | The results of the evaluation |
21
+ | `summary` | [EvaluationLoggingQuerySummary](../../models/shared/evaluationloggingquerysummary.md)[] | :heavy_minus_sign: | The metric summary of the evaluation |
22
+ | `task` | *string* | :heavy_minus_sign: | The task for which the evaluation is being created |
23
+ | `user` | *string* | :heavy_minus_sign: | The user running the evaluation |
package/docs/models/shared/evaluationloggingquerycomments.md ADDED
@@ -0,0 +1,7 @@
1
+ # EvaluationLoggingQueryComments
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/evaluationloggingquerydataset.md ADDED
@@ -0,0 +1,7 @@
1
+ # EvaluationLoggingQueryDataset
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/evaluationloggingquerygenerations.md ADDED
@@ -0,0 +1,7 @@
1
+ # EvaluationLoggingQueryGenerations
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/evaluationloggingquerymetrics.md ADDED
@@ -0,0 +1,7 @@
1
+ # EvaluationLoggingQueryMetrics
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/evaluationloggingqueryprompts.md ADDED
@@ -0,0 +1,7 @@
1
+ # EvaluationLoggingQueryPrompts
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/evaluationloggingqueryresults.md ADDED
@@ -0,0 +1,7 @@
1
+ # EvaluationLoggingQueryResults
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/evaluationloggingquerysummary.md ADDED
@@ -0,0 +1,7 @@
1
+ # EvaluationLoggingQuerySummary
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/feedbackquery.md ADDED
@@ -0,0 +1,13 @@
1
+ # FeedbackQuery
2
+
3
+ The request object for providing feedback
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
10
+ | `feedbackJson` | [FeedbackQueryFeedbackJson](../../models/shared/feedbackqueryfeedbackjson.md) | :heavy_minus_sign: | The feedback JSON with one or many feedback items |
11
+ | `generationId` | *string* | :heavy_minus_sign: | The ID of the generation for which feedback is being submitted |
12
+ | `groundTruth` | *string* | :heavy_minus_sign: | The ground truth for the generation |
13
+ | `task` | *string* | :heavy_minus_sign: | The task for which the feedback is being submitted |
package/docs/models/shared/feedbackqueryfeedbackjson.md ADDED
@@ -0,0 +1,9 @@
1
+ # FeedbackQueryFeedbackJson
2
+
3
+ The feedback JSON with one or many feedback items
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/feedbackresponse.md ADDED
@@ -0,0 +1,14 @@
1
+ # FeedbackResponse
2
+
3
+ The response object for providing feedback
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 feedback was created |
11
+ | `feedback` | [FeedbackResponseFeedback](../../models/shared/feedbackresponsefeedback.md) | :heavy_minus_sign: | The feedback JSON with one or many feedback items |
12
+ | `generationId` | *string* | :heavy_minus_sign: | The ID of the generation for which feedback was submitted |
13
+ | `groundTruth` | *string* | :heavy_minus_sign: | The ground truth for the generation |
14
+ | `task` | *string* | :heavy_minus_sign: | The task for which the feedback was submitted |
package/docs/models/shared/feedbackresponsefeedback.md ADDED
@@ -0,0 +1,9 @@
1
+ # FeedbackResponseFeedback
2
+
3
+ The feedback JSON with one or many feedback items
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/finetunedmodelresponse.md ADDED
@@ -0,0 +1,21 @@
1
+ # FineTunedModelResponse
2
+
3
+ The response object for a fine-tuned model
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 fine-tuned model was created |
11
+ | `fineTunedModel` | *string* | :heavy_minus_sign: | The fine-tuned model |
12
+ | `hyperparams` | *string* | :heavy_minus_sign: | The hyperparameters used for fine-tuning |
13
+ | `id` | *string* | :heavy_minus_sign: | The ID of the fine-tuned model |
14
+ | `model` | *string* | :heavy_minus_sign: | The model used for fine-tuning |
15
+ | `object` | *string* | :heavy_minus_sign: | The object type of the fine-tuned model |
16
+ | `orgId` | *string* | :heavy_minus_sign: | The ID of the organization |
17
+ | `resultFiles` | *string* | :heavy_minus_sign: | The result files of the fine-tuned model |
18
+ | `status` | *string* | :heavy_minus_sign: | The status of the fine-tuned model |
19
+ | `trainingFiles` | *string* | :heavy_minus_sign: | The training files used for fine-tuning |
20
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The timestamp of when the fine-tuned model was last updated |
21
+ | `validationFiles` | *string* | :heavy_minus_sign: | The validation files used for fine-tuning |
package/docs/models/shared/generatequery.md ADDED
@@ -0,0 +1,21 @@
1
+ # GenerateQuery
2
+
3
+ The request object for generating text
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
10
+ | `bestOf` | *number* | :heavy_minus_sign: | The number of generations to be returned |
11
+ | `groundTruth` | *string* | :heavy_minus_sign: | The ground truth of the generation |
12
+ | `input` | [GenerateQueryInput](../../models/shared/generatequeryinput.md) | :heavy_minus_sign: | The input variables for the generation |
13
+ | `metadata` | [GenerateQueryMetadata](../../models/shared/generatequerymetadata.md) | :heavy_minus_sign: | The metadata to track for the generation |
14
+ | `metric` | *string* | :heavy_minus_sign: | The metric used for sorting the generations |
15
+ | `modelId` | *string* | :heavy_minus_sign: | The unique ID of the fine-tuned model to generate from |
16
+ | `prompts` | *string*[] | :heavy_minus_sign: | The unique IDs of the prompts to generate from |
17
+ | `sampling` | *string* | :heavy_minus_sign: | The sampling method used for generating the generations |
18
+ | `source` | *string* | :heavy_minus_sign: | The source of the generation |
19
+ | `stream` | *boolean* | :heavy_minus_sign: | A boolean flag that represents whether you want to generate a streaming output |
20
+ | `task` | *string* | :heavy_minus_sign: | The task for which the generation is being requested |
21
+ | `userProperties` | [GenerateQueryUserProperties](../../models/shared/generatequeryuserproperties.md) | :heavy_minus_sign: | The user properties to track for the generation |
package/docs/models/shared/generatequeryinput.md ADDED
@@ -0,0 +1,9 @@
1
+ # GenerateQueryInput
2
+
3
+ The input variables for the generation
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/generatequerymetadata.md ADDED
@@ -0,0 +1,9 @@
1
+ # GenerateQueryMetadata
2
+
3
+ The metadata to track for the generation
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/generatequeryuserproperties.md ADDED
@@ -0,0 +1,9 @@
1
+ # GenerateQueryUserProperties
2
+
3
+ The user properties to track for the generation
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/generation.md ADDED
@@ -0,0 +1,21 @@
1
+ # Generation
2
+
3
+ The response object for a generation
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
10
+ | `completionTokens` | *number* | :heavy_minus_sign: | The number of tokens generated for the completion |
11
+ | `cost` | *number* | :heavy_minus_sign: | The cost of the generation |
12
+ | `feedback` | Record<string, *any*> | :heavy_minus_sign: | The feedback associated with this generation |
13
+ | `generation` | *string* | :heavy_minus_sign: | The generated completion |
14
+ | `generationId` | *string* | :heavy_minus_sign: | The unique ID of the generation |
15
+ | `hyperparameters` | Record<string, *any*> | :heavy_minus_sign: | The hyperparameters that were used to generate the text |
16
+ | `latency` | *number* | :heavy_minus_sign: | The latency of the generation in milliseconds |
17
+ | `model` | *string* | :heavy_minus_sign: | The model that was used to generate the text |
18
+ | `source` | *string* | :heavy_minus_sign: | The source of the generation |
19
+ | `task` | *string* | :heavy_minus_sign: | The task for which the generation is being requested |
20
+ | `totalTokens` | *number* | :heavy_minus_sign: | The total number of tokens generated |
21
+ | `version` | *string* | :heavy_minus_sign: | The unique ID of the prompt |
package/docs/models/shared/generationloggingquery.md ADDED
@@ -0,0 +1,23 @@
1
+ # GenerationLoggingQuery
2
+
3
+ The request object for logging a generation
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
10
+ | `feedback` | [GenerationLoggingQueryFeedback](../../models/shared/generationloggingqueryfeedback.md) | :heavy_minus_sign: | The feedback associated with this generation |
11
+ | `generation` | *string* | :heavy_minus_sign: | The text that was generated by the model provider |
12
+ | `groundTruth` | *string* | :heavy_minus_sign: | The ground truth for the generation |
13
+ | `hyperparameters` | [GenerationLoggingQueryHyperparameters](../../models/shared/generationloggingqueryhyperparameters.md) | :heavy_minus_sign: | The hyperparameters that were used to generate the text |
14
+ | `inputs` | [GenerationLoggingQueryInputs](../../models/shared/generationloggingqueryinputs.md) | :heavy_minus_sign: | The inputs filled into the prompt |
15
+ | `latency` | *number* | :heavy_minus_sign: | The latency of the generation in milliseconds |
16
+ | `metadata` | [GenerationLoggingQueryMetadata](../../models/shared/generationloggingquerymetadata.md) | :heavy_minus_sign: | The metadata to track for the generation |
17
+ | `model` | *string* | :heavy_minus_sign: | The model that was used to generate the text |
18
+ | `prompt` | *string* | :heavy_minus_sign: | The prompt used to generate the text |
19
+ | `source` | *string* | :heavy_minus_sign: | The source of the generation |
20
+ | `task` | *string* | :heavy_minus_sign: | The task for which the generation is being logged |
21
+ | `usage` | [GenerationLoggingQueryUsage](../../models/shared/generationloggingqueryusage.md) | :heavy_minus_sign: | The token usage for the generation |
22
+ | `userProperties` | [GenerationLoggingQueryUserProperties](../../models/shared/generationloggingqueryuserproperties.md) | :heavy_minus_sign: | The user properties to track for the generation |
23
+ | `version` | *string* | :heavy_minus_sign: | The version of the prompt |
package/docs/models/shared/generationloggingqueryfeedback.md ADDED
@@ -0,0 +1,9 @@
1
+ # GenerationLoggingQueryFeedback
2
+
3
+ The feedback associated with this generation
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/generationloggingqueryhyperparameters.md ADDED
@@ -0,0 +1,9 @@
1
+ # GenerationLoggingQueryHyperparameters
2
+
3
+ The hyperparameters that were used to generate the text
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/generationloggingqueryinputs.md ADDED
@@ -0,0 +1,9 @@
1
+ # GenerationLoggingQueryInputs
2
+
3
+ The inputs filled into the prompt
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/generationloggingquerymetadata.md ADDED
@@ -0,0 +1,9 @@
1
+ # GenerationLoggingQueryMetadata
2
+
3
+ The metadata to track for the generation
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/generationloggingqueryusage.md ADDED
@@ -0,0 +1,9 @@
1
+ # GenerationLoggingQueryUsage
2
+
3
+ The token usage for the generation
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/generationloggingqueryuserproperties.md ADDED
@@ -0,0 +1,9 @@
1
+ # GenerationLoggingQueryUserProperties
2
+
3
+ The user properties to track for the generation
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------- | ----------- | ----------- | ----------- |
package/docs/models/shared/generationresponse.md ADDED
@@ -0,0 +1,12 @@
1
+ # GenerationResponse
2
+
3
+ The response object for a generation
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
10
+ | `generation` | *string* | :heavy_minus_sign: | The generated completion |
11
+ | `generationId` | *string* | :heavy_minus_sign: | The unique ID of the generation |
12
+ | `version` | *string* | :heavy_minus_sign: | The unique ID of the prompt |
package/docs/models/shared/metriccreateresponse.md ADDED
@@ -0,0 +1,8 @@
1
+ # MetricCreateResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
8
+ | `inserted` | *boolean* | :heavy_minus_sign: | Boolean flag representing whether the metric was successfully inserted |
package/docs/models/shared/metricrequest.md ADDED
@@ -0,0 +1,12 @@
1
+ # MetricRequest
2
+
3
+ The request object for creating 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
+ | `name` | *string* | :heavy_minus_sign: | The name of the metric |
12
+ | `task` | *string* | :heavy_minus_sign: | The task related to the metric |