honeyhive 0.3.13 → 0.3.14

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 (195) hide show
  1. package/README.md +35 -47
  2. package/dist/models/components/configuration.d.ts +17 -73
  3. package/dist/models/components/configuration.js +22 -115
  4. package/dist/models/components/createdatapointrequest.d.ts +2 -12
  5. package/dist/models/components/createdatapointrequest.js +3 -27
  6. package/dist/models/components/createdatasetrequest.d.ts +1 -6
  7. package/dist/models/components/createdatasetrequest.js +2 -14
  8. package/dist/models/components/createeventrequest.d.ts +15 -42
  9. package/dist/models/components/createeventrequest.js +18 -92
  10. package/dist/models/components/createprojectrequest.d.ts +0 -5
  11. package/dist/models/components/createprojectrequest.js +1 -11
  12. package/dist/models/components/createtoolrequest.d.ts +18 -0
  13. package/dist/models/components/createtoolrequest.js +70 -0
  14. package/dist/models/components/datapoint.d.ts +1 -3
  15. package/dist/models/components/datapoint.js +2 -11
  16. package/dist/models/components/datasetupdate.d.ts +1 -6
  17. package/dist/models/components/datasetupdate.js +2 -14
  18. package/dist/models/components/event.d.ts +7 -42
  19. package/dist/models/components/event.js +8 -92
  20. package/dist/models/components/index.d.ts +3 -1
  21. package/dist/models/components/index.js +3 -1
  22. package/dist/models/components/metric.d.ts +8 -3
  23. package/dist/models/components/metric.js +7 -1
  24. package/dist/models/components/metricedit.d.ts +9 -4
  25. package/dist/models/components/metricedit.js +7 -1
  26. package/dist/models/components/project.d.ts +0 -5
  27. package/dist/models/components/project.js +1 -11
  28. package/dist/models/components/sessionstartrequest.d.ts +7 -42
  29. package/dist/models/components/sessionstartrequest.js +8 -92
  30. package/dist/models/components/tool.d.ts +2 -7
  31. package/dist/models/components/tool.js +4 -16
  32. package/dist/models/components/updatedatapointrequest.d.ts +2 -12
  33. package/dist/models/components/updatedatapointrequest.js +3 -27
  34. package/dist/models/components/updateprojectrequest.d.ts +6 -0
  35. package/dist/models/components/updateprojectrequest.js +55 -0
  36. package/dist/models/components/updatetoolrequest.d.ts +7 -0
  37. package/dist/models/components/updatetoolrequest.js +60 -0
  38. package/dist/models/operations/createdataset.d.ts +12 -3
  39. package/dist/models/operations/createdataset.js +39 -27
  40. package/dist/models/operations/createevent.d.ts +31 -0
  41. package/dist/models/operations/createevent.js +115 -0
  42. package/dist/models/operations/createmetric.d.ts +16 -0
  43. package/dist/models/operations/createmetric.js +51 -0
  44. package/dist/models/operations/createtool.d.ts +12 -2
  45. package/dist/models/operations/createtool.js +31 -10
  46. package/dist/models/operations/deletedataset.d.ts +4 -11
  47. package/dist/models/operations/deletedataset.js +3 -24
  48. package/dist/models/operations/deleteevent.d.ts +20 -0
  49. package/dist/models/operations/deleteevent.js +67 -0
  50. package/dist/models/operations/deletemetric.d.ts +19 -0
  51. package/dist/models/operations/deletemetric.js +63 -0
  52. package/dist/models/operations/getconfigurations.d.ts +19 -3
  53. package/dist/models/operations/getconfigurations.js +19 -2
  54. package/dist/models/operations/getdatapoint.d.ts +7 -1
  55. package/dist/models/operations/getdatapoint.js +21 -3
  56. package/dist/models/operations/getdatasets.d.ts +1 -1
  57. package/dist/models/operations/getdatasets.js +2 -2
  58. package/dist/models/operations/gettools.d.ts +0 -3
  59. package/dist/models/operations/gettools.js +1 -15
  60. package/dist/models/operations/index.d.ts +9 -9
  61. package/dist/models/operations/index.js +9 -9
  62. package/dist/models/operations/updatedataset.d.ts +0 -9
  63. package/dist/models/operations/updatedataset.js +1 -45
  64. package/dist/models/operations/updateevent.d.ts +23 -0
  65. package/dist/models/operations/updateevent.js +85 -0
  66. package/dist/models/operations/updatemetric.d.ts +16 -0
  67. package/dist/models/operations/updatemetric.js +51 -0
  68. package/dist/models/operations/updateproject.d.ts +0 -5
  69. package/dist/models/operations/updateproject.js +0 -28
  70. package/dist/models/operations/updatetool.d.ts +0 -3
  71. package/dist/models/operations/updatetool.js +1 -15
  72. package/dist/sdk/configurations.d.ts +1 -1
  73. package/dist/sdk/configurations.js +3 -1
  74. package/dist/sdk/datapoints.js +1 -1
  75. package/dist/sdk/datasets.d.ts +3 -3
  76. package/dist/sdk/datasets.js +8 -8
  77. package/dist/sdk/events.d.ts +3 -3
  78. package/dist/sdk/events.js +10 -10
  79. package/dist/sdk/metrics.d.ts +3 -3
  80. package/dist/sdk/metrics.js +7 -7
  81. package/dist/sdk/projects.d.ts +1 -1
  82. package/dist/sdk/projects.js +4 -11
  83. package/dist/sdk/sdk.js +3 -3
  84. package/dist/sdk/tools.d.ts +3 -3
  85. package/dist/sdk/tools.js +50 -22
  86. package/dist/sdk/tracer.d.ts +18 -1
  87. package/dist/sdk/tracer.js +176 -16
  88. package/docs/models/components/configuration.md +10 -8
  89. package/docs/models/components/createdatapointrequest.md +11 -11
  90. package/docs/models/components/createdatasetrequest.md +11 -11
  91. package/docs/models/components/createeventrequest.md +21 -19
  92. package/docs/models/components/createprojectrequest.md +4 -5
  93. package/docs/models/components/createtoolrequest.md +12 -0
  94. package/docs/models/components/createtoolrequesttype.md +9 -0
  95. package/docs/models/components/datapoint.md +1 -1
  96. package/docs/models/components/datasetupdate.md +10 -10
  97. package/docs/models/components/env.md +10 -0
  98. package/docs/models/components/event.md +21 -21
  99. package/docs/models/components/metric.md +2 -1
  100. package/docs/models/components/metricedit.md +3 -2
  101. package/docs/models/components/metricedittype.md +3 -2
  102. package/docs/models/components/metrictype.md +3 -2
  103. package/docs/models/components/project.md +5 -6
  104. package/docs/models/components/sessionstartrequest.md +18 -18
  105. package/docs/models/components/tool.md +8 -8
  106. package/docs/models/components/updatedatapointrequest.md +2 -2
  107. package/docs/models/components/updateprojectrequest.md +10 -0
  108. package/docs/models/components/updatetoolrequest.md +11 -0
  109. package/docs/models/operations/createdatasetresponse.md +11 -0
  110. package/docs/models/operations/createdatasetresponsebody.md +11 -0
  111. package/docs/models/operations/{createtoolsecurity.md → createdatasetresult.md} +2 -2
  112. package/docs/models/operations/{posteventsrequestbody.md → createeventrequestbody.md} +1 -1
  113. package/docs/models/operations/createeventresponse.md +11 -0
  114. package/docs/models/operations/{posteventsresponsebody.md → createeventresponsebody.md} +1 -1
  115. package/docs/models/operations/{postmetricsresponse.md → createmetricresponse.md} +1 -1
  116. package/docs/models/operations/createtoolresponse.md +6 -5
  117. package/docs/models/operations/createtoolresponsebody.md +10 -0
  118. package/docs/models/operations/{postdatasetsresult.md → createtoolresult.md} +1 -1
  119. package/docs/models/operations/{deletedatasetsrequest.md → deletedatasetrequest.md} +1 -1
  120. package/docs/models/operations/{deletemetricsresponse.md → deletedatasetresponse.md} +1 -1
  121. package/docs/models/operations/{deleteeventseventidrequest.md → deleteeventrequest.md} +1 -1
  122. package/docs/models/operations/{putmetricsresponse.md → deleteeventresponse.md} +1 -1
  123. package/docs/models/operations/{deletemetricsrequest.md → deletemetricrequest.md} +1 -1
  124. package/docs/models/operations/{puteventsresponse.md → deletemetricresponse.md} +1 -1
  125. package/docs/models/operations/env.md +12 -0
  126. package/docs/models/operations/getconfigurationsrequest.md +6 -4
  127. package/docs/models/operations/getdatapointresponse.md +6 -6
  128. package/docs/models/operations/getdatapointresponsebody.md +10 -0
  129. package/docs/models/operations/getdatasetsresponsebody.md +1 -1
  130. package/docs/models/operations/typet.md +1 -1
  131. package/docs/models/operations/updatedatasetresponse.md +10 -0
  132. package/docs/models/operations/updateeventrequestbody.md +12 -0
  133. package/docs/models/operations/{putdatasetsresponse.md → updateeventresponse.md} +1 -1
  134. package/docs/models/operations/updatemetricresponse.md +10 -0
  135. package/docs/models/operations/updateprojectresponse.md +5 -6
  136. package/docs/sdks/configurations/README.md +35 -52
  137. package/docs/sdks/datapoints/README.md +23 -20
  138. package/docs/sdks/datasets/README.md +25 -21
  139. package/docs/sdks/events/README.md +59 -37
  140. package/docs/sdks/metrics/README.md +24 -23
  141. package/docs/sdks/projects/README.md +11 -15
  142. package/docs/sdks/session/README.md +28 -14
  143. package/docs/sdks/tools/README.md +37 -35
  144. package/package.json +1 -1
  145. package/docs/models/components/calltype.md +0 -11
  146. package/docs/models/components/config.md +0 -9
  147. package/docs/models/components/createdatapointrequestinputs.md +0 -9
  148. package/docs/models/components/createdatapointrequestmetadata.md +0 -9
  149. package/docs/models/components/createdatasetrequestmetadata.md +0 -9
  150. package/docs/models/components/createeventrequestinputs.md +0 -9
  151. package/docs/models/components/createeventrequestmetadata.md +0 -9
  152. package/docs/models/components/createeventrequestuserproperties.md +0 -9
  153. package/docs/models/components/createprojectrequesttype.md +0 -9
  154. package/docs/models/components/datasetupdatemetadata.md +0 -9
  155. package/docs/models/components/eventconfig.md +0 -9
  156. package/docs/models/components/eventfeedback.md +0 -9
  157. package/docs/models/components/eventinputs.md +0 -9
  158. package/docs/models/components/eventmetadata.md +0 -9
  159. package/docs/models/components/eventmetrics.md +0 -9
  160. package/docs/models/components/eventoutputs.md +0 -9
  161. package/docs/models/components/eventuserproperties.md +0 -9
  162. package/docs/models/components/feedback.md +0 -9
  163. package/docs/models/components/functioncallparams.md +0 -12
  164. package/docs/models/components/hyperparameters.md +0 -9
  165. package/docs/models/components/metadata.md +0 -7
  166. package/docs/models/components/metrics.md +0 -9
  167. package/docs/models/components/outputs.md +0 -9
  168. package/docs/models/components/parameterst.md +0 -13
  169. package/docs/models/components/projecttype.md +0 -9
  170. package/docs/models/components/selectedfunctions.md +0 -11
  171. package/docs/models/components/sessionstartrequestconfig.md +0 -9
  172. package/docs/models/components/sessionstartrequestfeedback.md +0 -9
  173. package/docs/models/components/sessionstartrequestinputs.md +0 -9
  174. package/docs/models/components/sessionstartrequestmetadata.md +0 -9
  175. package/docs/models/components/sessionstartrequestmetrics.md +0 -9
  176. package/docs/models/components/sessionstartrequestoutputs.md +0 -9
  177. package/docs/models/components/sessionstartrequestuserproperties.md +0 -9
  178. package/docs/models/components/toolparameters.md +0 -9
  179. package/docs/models/components/toolupdate.md +0 -11
  180. package/docs/models/components/toolupdateparameters.md +0 -7
  181. package/docs/models/components/updatedatapointrequestinputs.md +0 -9
  182. package/docs/models/components/updatedatapointrequestmetadata.md +0 -9
  183. package/docs/models/components/userproperties.md +0 -9
  184. package/docs/models/operations/deletedatasetsresponse.md +0 -10
  185. package/docs/models/operations/deleteeventseventidresponse.md +0 -10
  186. package/docs/models/operations/feedback.md +0 -7
  187. package/docs/models/operations/gettoolssecurity.md +0 -8
  188. package/docs/models/operations/metadata.md +0 -7
  189. package/docs/models/operations/metrics.md +0 -7
  190. package/docs/models/operations/outputs.md +0 -7
  191. package/docs/models/operations/postdatasetsresponse.md +0 -11
  192. package/docs/models/operations/postdatasetsresponsebody.md +0 -11
  193. package/docs/models/operations/posteventsresponse.md +0 -11
  194. package/docs/models/operations/puteventsrequestbody.md +0 -12
  195. package/docs/models/operations/updatetoolsecurity.md +0 -8
package/docs/models/components/createdatasetrequest.md CHANGED
@@ -3,14 +3,14 @@
3
3
 
4
4
  ## Fields
5
5
 
6
- | Field | Type | Required | Description |
7
- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
8
- | `datapoints` | *string*[] | :heavy_minus_sign: | List of unique datapoint ids to be included in this dataset |
9
- | `description` | *string* | :heavy_minus_sign: | N/A |
10
- | `linkedEvals` | *string*[] | :heavy_minus_sign: | List of unique evaluation run ids to be associated with this dataset |
11
- | `metadata` | [components.CreateDatasetRequestMetadata](../../models/components/createdatasetrequestmetadata.md) | :heavy_minus_sign: | Any helpful metadata to track for the dataset |
12
- | `name` | *string* | :heavy_check_mark: | N/A |
13
- | `pipelineType` | [components.PipelineType](../../models/components/pipelinetype.md) | :heavy_minus_sign: | The type of data included in the dataset - "event" or "session" |
14
- | `project` | *string* | :heavy_check_mark: | UUID of the project associated with this dataset |
15
- | `saved` | *boolean* | :heavy_minus_sign: | N/A |
16
- | `type` | [components.CreateDatasetRequestType](../../models/components/createdatasetrequesttype.md) | :heavy_minus_sign: | What the dataset is to be used for - "evaluation" or "fine-tuning" |
6
+ | Field | Type | Required | Description |
7
+ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
8
+ | `datapoints` | *string*[] | :heavy_minus_sign: | List of unique datapoint ids to be included in this dataset |
9
+ | `description` | *string* | :heavy_minus_sign: | N/A |
10
+ | `linkedEvals` | *string*[] | :heavy_minus_sign: | List of unique evaluation run ids to be associated with this dataset |
11
+ | `metadata` | Record<string, *any*> | :heavy_minus_sign: | Any helpful metadata to track for the dataset |
12
+ | `name` | *string* | :heavy_check_mark: | N/A |
13
+ | `pipelineType` | [components.PipelineType](../../models/components/pipelinetype.md) | :heavy_minus_sign: | The type of data included in the dataset - "event" or "session" |
14
+ | `project` | *string* | :heavy_check_mark: | UUID of the project associated with this dataset |
15
+ | `saved` | *boolean* | :heavy_minus_sign: | N/A |
16
+ | `type` | [components.CreateDatasetRequestType](../../models/components/createdatasetrequesttype.md) | :heavy_minus_sign: | What the dataset is to be used for - "evaluation" or "fine-tuning" |
package/docs/models/components/createeventrequest.md CHANGED
@@ -3,22 +3,24 @@
3
3
 
4
4
  ## Fields
5
5
 
6
- | Field | Type | Required | Description |
7
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
8
- | `childrenIds` | *string*[] | :heavy_minus_sign: | Id of events that are nested within the event |
9
- | `config` | [components.Config](../../models/components/config.md) | :heavy_minus_sign: | Associated configuration JSON for the event - model name, vector index name, etc |
10
- | `duration` | *number* | :heavy_minus_sign: | How long the event took in milliseconds |
11
- | `endTime` | *number* | :heavy_minus_sign: | UTC timestamp (in milliseconds) for the event end |
12
- | `error` | *string* | :heavy_minus_sign: | Any error description if event failed |
13
- | `eventName` | *string* | :heavy_check_mark: | Name of the event |
14
- | `eventType` | [components.EventType](../../models/components/eventtype.md) | :heavy_check_mark: | Specify whether the event is of "model", "tool" or "chain" type |
15
- | `feedback` | [components.Feedback](../../models/components/feedback.md) | :heavy_minus_sign: | Any user feedback provided for the event output |
16
- | `inputs` | [components.CreateEventRequestInputs](../../models/components/createeventrequestinputs.md) | :heavy_minus_sign: | Input JSON given to the event - prompt, chunks, etc |
17
- | `metadata` | [components.CreateEventRequestMetadata](../../models/components/createeventrequestmetadata.md) | :heavy_minus_sign: | Any system or application metadata associated with the event |
18
- | `metrics` | [components.Metrics](../../models/components/metrics.md) | :heavy_minus_sign: | Any values computed over the output of the event |
19
- | `outputs` | [components.Outputs](../../models/components/outputs.md) | :heavy_minus_sign: | Final output JSON of the event |
20
- | `parentId` | *string* | :heavy_minus_sign: | Id of the parent event if nested |
21
- | `project` | *string* | :heavy_check_mark: | Project associated with the event |
22
- | `source` | *string* | :heavy_check_mark: | Source of the event - production, staging, etc |
23
- | `startTime` | *number* | :heavy_minus_sign: | UTC timestamp (in milliseconds) for the event start |
24
- | `userProperties` | [components.CreateEventRequestUserProperties](../../models/components/createeventrequestuserproperties.md) | :heavy_minus_sign: | Any user properties associated with the event |
6
+ | Field | Type | Required | Description |
7
+ | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
8
+ | `childrenIds` | *string*[] | :heavy_minus_sign: | Id of events that are nested within the event |
9
+ | `config` | Record<string, *any*> | :heavy_minus_sign: | Associated configuration JSON for the event - model name, vector index name, etc |
10
+ | `duration` | *number* | :heavy_minus_sign: | How long the event took in milliseconds |
11
+ | `endTime` | *number* | :heavy_minus_sign: | UTC timestamp (in milliseconds) for the event end |
12
+ | `error` | *string* | :heavy_minus_sign: | Any error description if event failed |
13
+ | `eventId` | *string* | :heavy_minus_sign: | Unique id of the event, if not set, it will be auto-generated |
14
+ | `eventName` | *string* | :heavy_check_mark: | Name of the event |
15
+ | `eventType` | [components.EventType](../../models/components/eventtype.md) | :heavy_check_mark: | Specify whether the event is of "model", "tool" or "chain" type |
16
+ | `feedback` | Record<string, *any*> | :heavy_minus_sign: | Any user feedback provided for the event output |
17
+ | `inputs` | Record<string, *any*> | :heavy_minus_sign: | Input JSON given to the event - prompt, chunks, etc |
18
+ | `metadata` | Record<string, *any*> | :heavy_minus_sign: | Any system or application metadata associated with the event |
19
+ | `metrics` | Record<string, *any*> | :heavy_minus_sign: | Any values computed over the output of the event |
20
+ | `outputs` | Record<string, *any*> | :heavy_minus_sign: | Final output JSON of the event |
21
+ | `parentId` | *string* | :heavy_minus_sign: | Id of the parent event if nested |
22
+ | `project` | *string* | :heavy_check_mark: | Project associated with the event |
23
+ | `sessionId` | *string* | :heavy_minus_sign: | Unique id of the session associated with the event, if not set, it will be auto-generated |
24
+ | `source` | *string* | :heavy_check_mark: | Source of the event - production, staging, etc |
25
+ | `startTime` | *number* | :heavy_minus_sign: | UTC timestamp (in milliseconds) for the event start |
26
+ | `userProperties` | Record<string, *any*> | :heavy_minus_sign: | Any user properties associated with the event |
package/docs/models/components/createprojectrequest.md CHANGED
@@ -3,8 +3,7 @@
3
3
 
4
4
  ## Fields
5
5
 
6
- | Field | Type | Required | Description |
7
- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
8
- | `description` | *string* | :heavy_minus_sign: | N/A |
9
- | `name` | *string* | :heavy_check_mark: | N/A |
10
- | `type` | [components.CreateProjectRequestType](../../models/components/createprojectrequesttype.md) | :heavy_minus_sign: | N/A |
6
+ | Field | Type | Required | Description |
7
+ | ------------------ | ------------------ | ------------------ | ------------------ |
8
+ | `description` | *string* | :heavy_minus_sign: | N/A |
9
+ | `name` | *string* | :heavy_check_mark: | N/A |
package/docs/models/components/createtoolrequest.md ADDED
@@ -0,0 +1,12 @@
1
+ # CreateToolRequest
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
8
+ | `description` | *string* | :heavy_minus_sign: | N/A |
9
+ | `name` | *string* | :heavy_check_mark: | N/A |
10
+ | `parameters` | Record<string, *any*> | :heavy_check_mark: | These can be function call params or plugin call params |
11
+ | `task` | *string* | :heavy_check_mark: | Name of the project associated with this tool |
12
+ | `type` | [components.CreateToolRequestType](../../models/components/createtoolrequesttype.md) | :heavy_check_mark: | N/A |
package/docs/models/components/createtoolrequesttype.md ADDED
@@ -0,0 +1,9 @@
1
+ # CreateToolRequestType
2
+
3
+
4
+ ## Values
5
+
6
+ | Name | Value |
7
+ | ---------- | ---------- |
8
+ | `Function` | function |
9
+ | `Tool` | tool |
package/docs/models/components/datapoint.md CHANGED
@@ -12,7 +12,7 @@
12
12
  | `linkedDatasets` | *string*[] | :heavy_minus_sign: | Ids of all datasets that include the datapoint |
13
13
  | `linkedEvals` | *string*[] | :heavy_minus_sign: | Ids of evaluations where the datapoint is included |
14
14
  | `linkedEvent` | *string* | :heavy_minus_sign: | Event id for the event from which the datapoint was created |
15
- | `metadata` | [components.Metadata](../../models/components/metadata.md) | :heavy_minus_sign: | N/A |
15
+ | `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
16
16
  | `projectId` | *string* | :heavy_minus_sign: | N/A |
17
17
  | `saved` | *boolean* | :heavy_minus_sign: | N/A |
18
18
  | `tenant` | *string* | :heavy_minus_sign: | N/A |
package/docs/models/components/datasetupdate.md CHANGED
@@ -3,13 +3,13 @@
3
3
 
4
4
  ## Fields
5
5
 
6
- | Field | Type | Required | Description |
7
- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
8
- | `datapoints` | *string*[] | :heavy_minus_sign: | Updated list of datapoint ids for the dataset |
9
- | `datasetId` | *string* | :heavy_check_mark: | The unique identifier of the dataset being updated |
10
- | `description` | *string* | :heavy_minus_sign: | Updated description for the dataset |
11
- | `linkedEvals` | *string*[] | :heavy_minus_sign: | Updated list of unique evaluation run ids to be associated with this dataset |
12
- | `metadata` | [components.DatasetUpdateMetadata](../../models/components/datasetupdatemetadata.md) | :heavy_minus_sign: | Updated metadata to track for the dataset |
13
- | `name` | *string* | :heavy_minus_sign: | Updated name for the dataset |
14
- | `numPoints` | *number* | :heavy_minus_sign: | N/A |
15
- | `saved` | *boolean* | :heavy_minus_sign: | N/A |
6
+ | Field | Type | Required | Description |
7
+ | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
8
+ | `datapoints` | *string*[] | :heavy_minus_sign: | Updated list of datapoint ids for the dataset |
9
+ | `datasetId` | *string* | :heavy_check_mark: | The unique identifier of the dataset being updated |
10
+ | `description` | *string* | :heavy_minus_sign: | Updated description for the dataset |
11
+ | `linkedEvals` | *string*[] | :heavy_minus_sign: | Updated list of unique evaluation run ids to be associated with this dataset |
12
+ | `metadata` | Record<string, *any*> | :heavy_minus_sign: | Updated metadata to track for the dataset |
13
+ | `name` | *string* | :heavy_minus_sign: | Updated name for the dataset |
14
+ | `numPoints` | *number* | :heavy_minus_sign: | N/A |
15
+ | `saved` | *boolean* | :heavy_minus_sign: | N/A |
package/docs/models/components/env.md ADDED
@@ -0,0 +1,10 @@
1
+ # Env
2
+
3
+
4
+ ## Values
5
+
6
+ | Name | Value |
7
+ | --------- | --------- |
8
+ | `Dev` | dev |
9
+ | `Staging` | staging |
10
+ | `Prod` | prod |
package/docs/models/components/event.md CHANGED
@@ -3,24 +3,24 @@
3
3
 
4
4
  ## Fields
5
5
 
6
- | Field | Type | Required | Description |
7
- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
8
- | `childrenIds` | *string*[] | :heavy_minus_sign: | Id of events that are nested within the event |
9
- | `config` | [components.EventConfig](../../models/components/eventconfig.md) | :heavy_minus_sign: | Associated configuration for the event - model, provider, etc |
10
- | `duration` | *number* | :heavy_minus_sign: | How long the event took in milliseconds |
11
- | `endTime` | *number* | :heavy_minus_sign: | UTC timestamp (in milliseconds) for the event end |
12
- | `error` | *string* | :heavy_minus_sign: | Any error description if the event failed |
13
- | `eventId` | *string* | :heavy_minus_sign: | Unique id of the event, if not set, it will be auto-generated |
14
- | `eventName` | *string* | :heavy_minus_sign: | Name of the event |
15
- | `eventType` | [components.EventEventType](../../models/components/eventeventtype.md) | :heavy_minus_sign: | Specify whether the event is of "model", "tool", "session" or "chain" type |
16
- | `feedback` | [components.EventFeedback](../../models/components/eventfeedback.md) | :heavy_minus_sign: | Any user feedback provided for the event output |
17
- | `inputs` | [components.EventInputs](../../models/components/eventinputs.md) | :heavy_minus_sign: | Input object passed to the event - user query, text blob, etc |
18
- | `metadata` | [components.EventMetadata](../../models/components/eventmetadata.md) | :heavy_minus_sign: | Any system or application metadata associated with the event |
19
- | `metrics` | [components.EventMetrics](../../models/components/eventmetrics.md) | :heavy_minus_sign: | Any values computed over the output of the event |
20
- | `outputs` | [components.EventOutputs](../../models/components/eventoutputs.md) | :heavy_minus_sign: | Final output of the event - completion, chunks, etc |
21
- | `parentId` | *string* | :heavy_minus_sign: | Id of the parent event if nested |
22
- | `project` | *string* | :heavy_minus_sign: | Project associated with the event |
23
- | `sessionId` | *string* | :heavy_minus_sign: | Unique id of the session associated with the event |
24
- | `source` | *string* | :heavy_minus_sign: | Source of the event - production, staging, etc |
25
- | `startTime` | *number* | :heavy_minus_sign: | UTC timestamp (in milliseconds) for the event start |
26
- | `userProperties` | [components.EventUserProperties](../../models/components/eventuserproperties.md) | :heavy_minus_sign: | Any user properties associated with the event |
6
+ | Field | Type | Required | Description |
7
+ | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
8
+ | `childrenIds` | *string*[] | :heavy_minus_sign: | Id of events that are nested within the event |
9
+ | `config` | Record<string, *any*> | :heavy_minus_sign: | Associated configuration for the event - model, provider, etc |
10
+ | `duration` | *number* | :heavy_minus_sign: | How long the event took in milliseconds |
11
+ | `endTime` | *number* | :heavy_minus_sign: | UTC timestamp (in milliseconds) for the event end |
12
+ | `error` | *string* | :heavy_minus_sign: | Any error description if the event failed |
13
+ | `eventId` | *string* | :heavy_minus_sign: | Unique id of the event, if not set, it will be auto-generated |
14
+ | `eventName` | *string* | :heavy_minus_sign: | Name of the event |
15
+ | `eventType` | [components.EventEventType](../../models/components/eventeventtype.md) | :heavy_minus_sign: | Specify whether the event is of "model", "tool", "session" or "chain" type |
16
+ | `feedback` | Record<string, *any*> | :heavy_minus_sign: | Any user feedback provided for the event output |
17
+ | `inputs` | Record<string, *any*> | :heavy_minus_sign: | Input object passed to the event - user query, text blob, etc |
18
+ | `metadata` | Record<string, *any*> | :heavy_minus_sign: | Any system or application metadata associated with the event |
19
+ | `metrics` | Record<string, *any*> | :heavy_minus_sign: | Any values computed over the output of the event |
20
+ | `outputs` | Record<string, *any*> | :heavy_minus_sign: | Final output of the event - completion, chunks, etc |
21
+ | `parentId` | *string* | :heavy_minus_sign: | Id of the parent event if nested |
22
+ | `project` | *string* | :heavy_minus_sign: | Project associated with the event |
23
+ | `sessionId` | *string* | :heavy_minus_sign: | Unique id of the session associated with the event |
24
+ | `source` | *string* | :heavy_minus_sign: | Source of the event - production, staging, etc |
25
+ | `startTime` | *number* | :heavy_minus_sign: | UTC timestamp (in milliseconds) for the event start |
26
+ | `userProperties` | Record<string, *any*> | :heavy_minus_sign: | Any user properties associated with the event |
package/docs/models/components/metric.md CHANGED
@@ -7,6 +7,7 @@
7
7
  | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
8
8
  | `id` | *string* | :heavy_minus_sign: | Unique idenitifier |
9
9
  | `codeSnippet` | *string* | :heavy_minus_sign: | Associated code block for the metric |
10
+ | `criteria` | *string* | :heavy_minus_sign: | Criteria for human metrics |
10
11
  | `description` | *string* | :heavy_check_mark: | Short description of what the metric does |
11
12
  | `enabledInProd` | *boolean* | :heavy_minus_sign: | Whether to compute on all production events automatically |
12
13
  | `eventName` | *string* | :heavy_minus_sign: | Name of event that the metric is set to be computed on |
@@ -18,4 +19,4 @@
18
19
  | `returnType` | [components.ReturnTypeT](../../models/components/returntypet.md) | :heavy_check_mark: | The data type of the metric value - "boolean", "float", "string" |
19
20
  | `task` | *string* | :heavy_check_mark: | Name of the project associated with metric |
20
21
  | `threshold` | [components.Threshold](../../models/components/threshold.md) | :heavy_minus_sign: | Threshold for numeric metrics to decide passing or failing in tests |
21
- | `type` | [components.MetricType](../../models/components/metrictype.md) | :heavy_check_mark: | Type of the metric - "custom" or "model" |
22
+ | `type` | [components.MetricType](../../models/components/metrictype.md) | :heavy_check_mark: | Type of the metric - "custom", "model" or "human" |
package/docs/models/components/metricedit.md CHANGED
@@ -6,15 +6,16 @@
6
6
  | Field | Type | Required | Description |
7
7
  | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
8
8
  | `codeSnippet` | *string* | :heavy_minus_sign: | Updated code block for the metric |
9
+ | `criteria` | *string* | :heavy_minus_sign: | Criteria for human metrics |
9
10
  | `description` | *string* | :heavy_minus_sign: | Short description of what the metric does |
10
11
  | `enabledInProd` | *boolean* | :heavy_minus_sign: | Whether to compute on all production events automatically |
11
12
  | `eventName` | *string* | :heavy_minus_sign: | Name of event that the metric is set to be computed on |
12
13
  | `eventType` | [components.MetricEditEventType](../../models/components/metricediteventtype.md) | :heavy_minus_sign: | Type of event that the metric is set to be computed on |
13
- | `metricId` | *string* | :heavy_minus_sign: | Unique identifier of the metric |
14
+ | `metricId` | *string* | :heavy_check_mark: | Unique identifier of the metric |
14
15
  | `name` | *string* | :heavy_minus_sign: | Updated name of the metric |
15
16
  | `needsGroundTruth` | *boolean* | :heavy_minus_sign: | Whether a ground truth (on metadata) is required to compute it |
16
17
  | `passWhen` | *boolean* | :heavy_minus_sign: | Threshold for boolean metrics to decide passing or failing in tests |
17
18
  | `prompt` | *string* | :heavy_minus_sign: | Updated Evaluator prompt for the metric |
18
19
  | `returnType` | [components.MetricEditReturnType](../../models/components/metriceditreturntype.md) | :heavy_minus_sign: | The data type of the metric value - "boolean", "float", "string" |
19
20
  | `threshold` | [components.MetricEditThreshold](../../models/components/metriceditthreshold.md) | :heavy_minus_sign: | Threshold for numeric metrics to decide passing or failing in tests |
20
- | `type` | [components.MetricEditType](../../models/components/metricedittype.md) | :heavy_minus_sign: | Type of the metric - "custom" or "model" |
21
+ | `type` | [components.MetricEditType](../../models/components/metricedittype.md) | :heavy_minus_sign: | Type of the metric - "custom", "model" or "human" |
package/docs/models/components/metricedittype.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # MetricEditType
2
2
 
3
- Type of the metric - "custom" or "model"
3
+ Type of the metric - "custom", "model" or "human"
4
4
 
5
5
 
6
6
  ## Values
@@ -8,4 +8,5 @@ Type of the metric - "custom" or "model"
8
8
  | Name | Value |
9
9
  | -------- | -------- |
10
10
  | `Custom` | custom |
11
- | `Model` | model |
11
+ | `Model` | model |
12
+ | `Human` | human |
package/docs/models/components/metrictype.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # MetricType
2
2
 
3
- Type of the metric - "custom" or "model"
3
+ Type of the metric - "custom", "model" or "human"
4
4
 
5
5
 
6
6
  ## Values
@@ -8,4 +8,5 @@ Type of the metric - "custom" or "model"
8
8
  | Name | Value |
9
9
  | -------- | -------- |
10
10
  | `Custom` | custom |
11
- | `Model` | model |
11
+ | `Model` | model |
12
+ | `Human` | human |
package/docs/models/components/project.md CHANGED
@@ -3,9 +3,8 @@
3
3
 
4
4
  ## Fields
5
5
 
6
- | Field | Type | Required | Description |
7
- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
8
- | `description` | *string* | :heavy_check_mark: | N/A |
9
- | `id` | *string* | :heavy_minus_sign: | N/A |
10
- | `name` | *string* | :heavy_check_mark: | N/A |
11
- | `type` | [components.ProjectType](../../models/components/projecttype.md) | :heavy_check_mark: | N/A |
6
+ | Field | Type | Required | Description |
7
+ | ------------------ | ------------------ | ------------------ | ------------------ |
8
+ | `description` | *string* | :heavy_check_mark: | N/A |
9
+ | `id` | *string* | :heavy_minus_sign: | N/A |
10
+ | `name` | *string* | :heavy_check_mark: | N/A |
package/docs/models/components/sessionstartrequest.md CHANGED
@@ -3,21 +3,21 @@
3
3
 
4
4
  ## Fields
5
5
 
6
- | Field | Type | Required | Description |
7
- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
8
- | `childrenIds` | *string*[] | :heavy_minus_sign: | Id of events that are nested within the session |
9
- | `config` | [components.SessionStartRequestConfig](../../models/components/sessionstartrequestconfig.md) | :heavy_minus_sign: | Associated configuration for the session |
10
- | `duration` | *number* | :heavy_minus_sign: | How long the session took in milliseconds |
11
- | `endTime` | *number* | :heavy_minus_sign: | UTC timestamp (in milliseconds) for the session end |
12
- | `error` | *string* | :heavy_minus_sign: | Any error description if session failed |
13
- | `feedback` | [components.SessionStartRequestFeedback](../../models/components/sessionstartrequestfeedback.md) | :heavy_minus_sign: | Any user feedback provided for the session output |
14
- | `inputs` | [components.SessionStartRequestInputs](../../models/components/sessionstartrequestinputs.md) | :heavy_minus_sign: | Input object passed to the session - user query, text blob, etc |
15
- | `metadata` | [components.SessionStartRequestMetadata](../../models/components/sessionstartrequestmetadata.md) | :heavy_minus_sign: | Any system or application metadata associated with the session |
16
- | `metrics` | [components.SessionStartRequestMetrics](../../models/components/sessionstartrequestmetrics.md) | :heavy_minus_sign: | Any values computed over the output of the session |
17
- | `outputs` | [components.SessionStartRequestOutputs](../../models/components/sessionstartrequestoutputs.md) | :heavy_minus_sign: | Final output of the session - completion, chunks, etc |
18
- | `project` | *string* | :heavy_check_mark: | Project name associated with the session |
19
- | `sessionId` | *string* | :heavy_minus_sign: | Unique id of the session, if not set, it will be auto-generated |
20
- | `sessionName` | *string* | :heavy_check_mark: | Name of the session |
21
- | `source` | *string* | :heavy_check_mark: | Source of the session - production, staging, etc |
22
- | `startTime` | *number* | :heavy_minus_sign: | UTC timestamp (in milliseconds) for the session start |
23
- | `userProperties` | [components.SessionStartRequestUserProperties](../../models/components/sessionstartrequestuserproperties.md) | :heavy_minus_sign: | Any user properties associated with the session |
6
+ | Field | Type | Required | Description |
7
+ | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
8
+ | `childrenIds` | *string*[] | :heavy_minus_sign: | Id of events that are nested within the session |
9
+ | `config` | Record<string, *any*> | :heavy_minus_sign: | Associated configuration for the session |
10
+ | `duration` | *number* | :heavy_minus_sign: | How long the session took in milliseconds |
11
+ | `endTime` | *number* | :heavy_minus_sign: | UTC timestamp (in milliseconds) for the session end |
12
+ | `error` | *string* | :heavy_minus_sign: | Any error description if session failed |
13
+ | `feedback` | Record<string, *any*> | :heavy_minus_sign: | Any user feedback provided for the session output |
14
+ | `inputs` | Record<string, *any*> | :heavy_minus_sign: | Input object passed to the session - user query, text blob, etc |
15
+ | `metadata` | Record<string, *any*> | :heavy_minus_sign: | Any system or application metadata associated with the session |
16
+ | `metrics` | Record<string, *any*> | :heavy_minus_sign: | Any values computed over the output of the session |
17
+ | `outputs` | Record<string, *any*> | :heavy_minus_sign: | Final output of the session - completion, chunks, etc |
18
+ | `project` | *string* | :heavy_check_mark: | Project name associated with the session |
19
+ | `sessionId` | *string* | :heavy_minus_sign: | Unique id of the session, if not set, it will be auto-generated |
20
+ | `sessionName` | *string* | :heavy_check_mark: | Name of the session |
21
+ | `source` | *string* | :heavy_check_mark: | Source of the session - production, staging, etc |
22
+ | `startTime` | *number* | :heavy_minus_sign: | UTC timestamp (in milliseconds) for the session start |
23
+ | `userProperties` | Record<string, *any*> | :heavy_minus_sign: | Any user properties associated with the session |
package/docs/models/components/tool.md CHANGED
@@ -3,11 +3,11 @@
3
3
 
4
4
  ## Fields
5
5
 
6
- | Field | Type | Required | Description |
7
- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
8
- | `id` | *string* | :heavy_minus_sign: | N/A |
9
- | `description` | *string* | :heavy_minus_sign: | N/A |
10
- | `name` | *string* | :heavy_check_mark: | N/A |
11
- | `parameters` | [components.ToolParameters](../../models/components/toolparameters.md) | :heavy_check_mark: | These can be function call params or plugin call params |
12
- | `task` | *string* | :heavy_check_mark: | Name of the project associated with this tool |
13
- | `type` | [components.ToolType](../../models/components/tooltype.md) | :heavy_check_mark: | N/A |
6
+ | Field | Type | Required | Description |
7
+ | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
8
+ | `id` | *string* | :heavy_minus_sign: | N/A |
9
+ | `description` | *string* | :heavy_minus_sign: | N/A |
10
+ | `name` | *string* | :heavy_check_mark: | N/A |
11
+ | `parameters` | Record<string, *any*> | :heavy_check_mark: | These can be function call params or plugin call params |
12
+ | `task` | *string* | :heavy_check_mark: | Name of the project associated with this tool |
13
+ | `toolType` | [components.ToolType](../../models/components/tooltype.md) | :heavy_check_mark: | N/A |
package/docs/models/components/updatedatapointrequest.md CHANGED
@@ -7,9 +7,9 @@
7
7
  | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
8
8
  | `groundTruth` | Record<string, *any*> | :heavy_minus_sign: | Expected output JSON object for the datapoint |
9
9
  | `history` | [components.UpdateDatapointRequestHistory](../../models/components/updatedatapointrequesthistory.md)[] | :heavy_minus_sign: | Update history for the datapoint |
10
- | `inputs` | [components.UpdateDatapointRequestInputs](../../models/components/updatedatapointrequestinputs.md) | :heavy_minus_sign: | Arbitrary JSON object containing the inputs for the datapoint |
10
+ | `inputs` | Record<string, *any*> | :heavy_minus_sign: | Arbitrary JSON object containing the inputs for the datapoint |
11
11
  | `linkedDatasets` | *string*[] | :heavy_minus_sign: | Ids of all datasets that include the datapoint |
12
12
  | `linkedEvals` | *string*[] | :heavy_minus_sign: | Ids of evaluations where the datapoint is included |
13
- | `metadata` | [components.UpdateDatapointRequestMetadata](../../models/components/updatedatapointrequestmetadata.md) | :heavy_minus_sign: | Any additional metadata for the datapoint |
13
+ | `metadata` | Record<string, *any*> | :heavy_minus_sign: | Any additional metadata for the datapoint |
14
14
  | `saved` | *boolean* | :heavy_minus_sign: | Whether the datapoint is saved or detected |
15
15
  | `type` | *string* | :heavy_minus_sign: | evaluation or event - specify the type of usage |
package/docs/models/components/updateprojectrequest.md ADDED
@@ -0,0 +1,10 @@
1
+ # UpdateProjectRequest
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | ------------------ | ------------------ | ------------------ | ------------------ |
8
+ | `description` | *string* | :heavy_minus_sign: | N/A |
9
+ | `name` | *string* | :heavy_minus_sign: | N/A |
10
+ | `projectId` | *string* | :heavy_check_mark: | N/A |
package/docs/models/components/updatetoolrequest.md ADDED
@@ -0,0 +1,11 @@
1
+ # UpdateToolRequest
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | --------------------- | --------------------- | --------------------- | --------------------- |
8
+ | `description` | *string* | :heavy_minus_sign: | N/A |
9
+ | `id` | *string* | :heavy_check_mark: | N/A |
10
+ | `name` | *string* | :heavy_check_mark: | N/A |
11
+ | `parameters` | Record<string, *any*> | :heavy_check_mark: | N/A |
package/docs/models/operations/createdatasetresponse.md ADDED
@@ -0,0 +1,11 @@
1
+ # CreateDatasetResponse
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_check_mark: | Raw HTTP response; suitable for custom response parsing |
11
+ | `object` | [operations.CreateDatasetResponseBody](../../models/operations/createdatasetresponsebody.md) | :heavy_minus_sign: | Successful creation |
package/docs/models/operations/createdatasetresponsebody.md ADDED
@@ -0,0 +1,11 @@
1
+ # CreateDatasetResponseBody
2
+
3
+ Successful creation
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
10
+ | `inserted` | *boolean* | :heavy_minus_sign: | N/A |
11
+ | `result` | [operations.CreateDatasetResult](../../models/operations/createdatasetresult.md) | :heavy_minus_sign: | N/A |
package/docs/models/operations/{createtoolsecurity.md → createdatasetresult.md} RENAMED
@@ -1,8 +1,8 @@
1
- # CreateToolSecurity
1
+ # CreateDatasetResult
2
2
 
3
3
 
4
4
  ## Fields
5
5
 
6
6
  | Field | Type | Required | Description |
7
7
  | ------------------ | ------------------ | ------------------ | ------------------ |
8
- | `bearerAuth` | *string* | :heavy_check_mark: | N/A |
8
+ | `insertedId` | *string* | :heavy_minus_sign: | N/A |