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.
- package/README.md +35 -47
- package/dist/models/components/configuration.d.ts +17 -73
- package/dist/models/components/configuration.js +22 -115
- package/dist/models/components/createdatapointrequest.d.ts +2 -12
- package/dist/models/components/createdatapointrequest.js +3 -27
- package/dist/models/components/createdatasetrequest.d.ts +1 -6
- package/dist/models/components/createdatasetrequest.js +2 -14
- package/dist/models/components/createeventrequest.d.ts +15 -42
- package/dist/models/components/createeventrequest.js +18 -92
- package/dist/models/components/createprojectrequest.d.ts +0 -5
- package/dist/models/components/createprojectrequest.js +1 -11
- package/dist/models/components/createtoolrequest.d.ts +18 -0
- package/dist/models/components/createtoolrequest.js +70 -0
- package/dist/models/components/datapoint.d.ts +1 -3
- package/dist/models/components/datapoint.js +2 -11
- package/dist/models/components/datasetupdate.d.ts +1 -6
- package/dist/models/components/datasetupdate.js +2 -14
- package/dist/models/components/event.d.ts +7 -42
- package/dist/models/components/event.js +8 -92
- package/dist/models/components/index.d.ts +3 -1
- package/dist/models/components/index.js +3 -1
- package/dist/models/components/metric.d.ts +8 -3
- package/dist/models/components/metric.js +7 -1
- package/dist/models/components/metricedit.d.ts +9 -4
- package/dist/models/components/metricedit.js +7 -1
- package/dist/models/components/project.d.ts +0 -5
- package/dist/models/components/project.js +1 -11
- package/dist/models/components/sessionstartrequest.d.ts +7 -42
- package/dist/models/components/sessionstartrequest.js +8 -92
- package/dist/models/components/tool.d.ts +2 -7
- package/dist/models/components/tool.js +4 -16
- package/dist/models/components/updatedatapointrequest.d.ts +2 -12
- package/dist/models/components/updatedatapointrequest.js +3 -27
- package/dist/models/components/updateprojectrequest.d.ts +6 -0
- package/dist/models/components/updateprojectrequest.js +55 -0
- package/dist/models/components/updatetoolrequest.d.ts +7 -0
- package/dist/models/components/updatetoolrequest.js +60 -0
- package/dist/models/operations/createdataset.d.ts +12 -3
- package/dist/models/operations/createdataset.js +39 -27
- package/dist/models/operations/createevent.d.ts +31 -0
- package/dist/models/operations/createevent.js +115 -0
- package/dist/models/operations/createmetric.d.ts +16 -0
- package/dist/models/operations/createmetric.js +51 -0
- package/dist/models/operations/createtool.d.ts +12 -2
- package/dist/models/operations/createtool.js +31 -10
- package/dist/models/operations/deletedataset.d.ts +4 -11
- package/dist/models/operations/deletedataset.js +3 -24
- package/dist/models/operations/deleteevent.d.ts +20 -0
- package/dist/models/operations/deleteevent.js +67 -0
- package/dist/models/operations/deletemetric.d.ts +19 -0
- package/dist/models/operations/deletemetric.js +63 -0
- package/dist/models/operations/getconfigurations.d.ts +19 -3
- package/dist/models/operations/getconfigurations.js +19 -2
- package/dist/models/operations/getdatapoint.d.ts +7 -1
- package/dist/models/operations/getdatapoint.js +21 -3
- package/dist/models/operations/getdatasets.d.ts +1 -1
- package/dist/models/operations/getdatasets.js +2 -2
- package/dist/models/operations/gettools.d.ts +0 -3
- package/dist/models/operations/gettools.js +1 -15
- package/dist/models/operations/index.d.ts +9 -9
- package/dist/models/operations/index.js +9 -9
- package/dist/models/operations/updatedataset.d.ts +0 -9
- package/dist/models/operations/updatedataset.js +1 -45
- package/dist/models/operations/updateevent.d.ts +23 -0
- package/dist/models/operations/updateevent.js +85 -0
- package/dist/models/operations/updatemetric.d.ts +16 -0
- package/dist/models/operations/updatemetric.js +51 -0
- package/dist/models/operations/updateproject.d.ts +0 -5
- package/dist/models/operations/updateproject.js +0 -28
- package/dist/models/operations/updatetool.d.ts +0 -3
- package/dist/models/operations/updatetool.js +1 -15
- package/dist/sdk/configurations.d.ts +1 -1
- package/dist/sdk/configurations.js +3 -1
- package/dist/sdk/datapoints.js +1 -1
- package/dist/sdk/datasets.d.ts +3 -3
- package/dist/sdk/datasets.js +8 -8
- package/dist/sdk/events.d.ts +3 -3
- package/dist/sdk/events.js +10 -10
- package/dist/sdk/metrics.d.ts +3 -3
- package/dist/sdk/metrics.js +7 -7
- package/dist/sdk/projects.d.ts +1 -1
- package/dist/sdk/projects.js +4 -11
- package/dist/sdk/sdk.js +3 -3
- package/dist/sdk/tools.d.ts +3 -3
- package/dist/sdk/tools.js +50 -22
- package/dist/sdk/tracer.d.ts +18 -1
- package/dist/sdk/tracer.js +176 -16
- package/docs/models/components/configuration.md +10 -8
- package/docs/models/components/createdatapointrequest.md +11 -11
- package/docs/models/components/createdatasetrequest.md +11 -11
- package/docs/models/components/createeventrequest.md +21 -19
- package/docs/models/components/createprojectrequest.md +4 -5
- package/docs/models/components/createtoolrequest.md +12 -0
- package/docs/models/components/createtoolrequesttype.md +9 -0
- package/docs/models/components/datapoint.md +1 -1
- package/docs/models/components/datasetupdate.md +10 -10
- package/docs/models/components/env.md +10 -0
- package/docs/models/components/event.md +21 -21
- package/docs/models/components/metric.md +2 -1
- package/docs/models/components/metricedit.md +3 -2
- package/docs/models/components/metricedittype.md +3 -2
- package/docs/models/components/metrictype.md +3 -2
- package/docs/models/components/project.md +5 -6
- package/docs/models/components/sessionstartrequest.md +18 -18
- package/docs/models/components/tool.md +8 -8
- package/docs/models/components/updatedatapointrequest.md +2 -2
- package/docs/models/components/updateprojectrequest.md +10 -0
- package/docs/models/components/updatetoolrequest.md +11 -0
- package/docs/models/operations/createdatasetresponse.md +11 -0
- package/docs/models/operations/createdatasetresponsebody.md +11 -0
- package/docs/models/operations/{createtoolsecurity.md → createdatasetresult.md} +2 -2
- package/docs/models/operations/{posteventsrequestbody.md → createeventrequestbody.md} +1 -1
- package/docs/models/operations/createeventresponse.md +11 -0
- package/docs/models/operations/{posteventsresponsebody.md → createeventresponsebody.md} +1 -1
- package/docs/models/operations/{postmetricsresponse.md → createmetricresponse.md} +1 -1
- package/docs/models/operations/createtoolresponse.md +6 -5
- package/docs/models/operations/createtoolresponsebody.md +10 -0
- package/docs/models/operations/{postdatasetsresult.md → createtoolresult.md} +1 -1
- package/docs/models/operations/{deletedatasetsrequest.md → deletedatasetrequest.md} +1 -1
- package/docs/models/operations/{deletemetricsresponse.md → deletedatasetresponse.md} +1 -1
- package/docs/models/operations/{deleteeventseventidrequest.md → deleteeventrequest.md} +1 -1
- package/docs/models/operations/{putmetricsresponse.md → deleteeventresponse.md} +1 -1
- package/docs/models/operations/{deletemetricsrequest.md → deletemetricrequest.md} +1 -1
- package/docs/models/operations/{puteventsresponse.md → deletemetricresponse.md} +1 -1
- package/docs/models/operations/env.md +12 -0
- package/docs/models/operations/getconfigurationsrequest.md +6 -4
- package/docs/models/operations/getdatapointresponse.md +6 -6
- package/docs/models/operations/getdatapointresponsebody.md +10 -0
- package/docs/models/operations/getdatasetsresponsebody.md +1 -1
- package/docs/models/operations/typet.md +1 -1
- package/docs/models/operations/updatedatasetresponse.md +10 -0
- package/docs/models/operations/updateeventrequestbody.md +12 -0
- package/docs/models/operations/{putdatasetsresponse.md → updateeventresponse.md} +1 -1
- package/docs/models/operations/updatemetricresponse.md +10 -0
- package/docs/models/operations/updateprojectresponse.md +5 -6
- package/docs/sdks/configurations/README.md +35 -52
- package/docs/sdks/datapoints/README.md +23 -20
- package/docs/sdks/datasets/README.md +25 -21
- package/docs/sdks/events/README.md +59 -37
- package/docs/sdks/metrics/README.md +24 -23
- package/docs/sdks/projects/README.md +11 -15
- package/docs/sdks/session/README.md +28 -14
- package/docs/sdks/tools/README.md +37 -35
- package/package.json +1 -1
- package/docs/models/components/calltype.md +0 -11
- package/docs/models/components/config.md +0 -9
- package/docs/models/components/createdatapointrequestinputs.md +0 -9
- package/docs/models/components/createdatapointrequestmetadata.md +0 -9
- package/docs/models/components/createdatasetrequestmetadata.md +0 -9
- package/docs/models/components/createeventrequestinputs.md +0 -9
- package/docs/models/components/createeventrequestmetadata.md +0 -9
- package/docs/models/components/createeventrequestuserproperties.md +0 -9
- package/docs/models/components/createprojectrequesttype.md +0 -9
- package/docs/models/components/datasetupdatemetadata.md +0 -9
- package/docs/models/components/eventconfig.md +0 -9
- package/docs/models/components/eventfeedback.md +0 -9
- package/docs/models/components/eventinputs.md +0 -9
- package/docs/models/components/eventmetadata.md +0 -9
- package/docs/models/components/eventmetrics.md +0 -9
- package/docs/models/components/eventoutputs.md +0 -9
- package/docs/models/components/eventuserproperties.md +0 -9
- package/docs/models/components/feedback.md +0 -9
- package/docs/models/components/functioncallparams.md +0 -12
- package/docs/models/components/hyperparameters.md +0 -9
- package/docs/models/components/metadata.md +0 -7
- package/docs/models/components/metrics.md +0 -9
- package/docs/models/components/outputs.md +0 -9
- package/docs/models/components/parameterst.md +0 -13
- package/docs/models/components/projecttype.md +0 -9
- package/docs/models/components/selectedfunctions.md +0 -11
- package/docs/models/components/sessionstartrequestconfig.md +0 -9
- package/docs/models/components/sessionstartrequestfeedback.md +0 -9
- package/docs/models/components/sessionstartrequestinputs.md +0 -9
- package/docs/models/components/sessionstartrequestmetadata.md +0 -9
- package/docs/models/components/sessionstartrequestmetrics.md +0 -9
- package/docs/models/components/sessionstartrequestoutputs.md +0 -9
- package/docs/models/components/sessionstartrequestuserproperties.md +0 -9
- package/docs/models/components/toolparameters.md +0 -9
- package/docs/models/components/toolupdate.md +0 -11
- package/docs/models/components/toolupdateparameters.md +0 -7
- package/docs/models/components/updatedatapointrequestinputs.md +0 -9
- package/docs/models/components/updatedatapointrequestmetadata.md +0 -9
- package/docs/models/components/userproperties.md +0 -9
- package/docs/models/operations/deletedatasetsresponse.md +0 -10
- package/docs/models/operations/deleteeventseventidresponse.md +0 -10
- package/docs/models/operations/feedback.md +0 -7
- package/docs/models/operations/gettoolssecurity.md +0 -8
- package/docs/models/operations/metadata.md +0 -7
- package/docs/models/operations/metrics.md +0 -7
- package/docs/models/operations/outputs.md +0 -7
- package/docs/models/operations/postdatasetsresponse.md +0 -11
- package/docs/models/operations/postdatasetsresponsebody.md +0 -11
- package/docs/models/operations/posteventsresponse.md +0 -11
- package/docs/models/operations/puteventsrequestbody.md +0 -12
- package/docs/models/operations/updatetoolsecurity.md +0 -8
|
@@ -3,20 +3,20 @@
|
|
|
3
3
|
|
|
4
4
|
### Available Operations
|
|
5
5
|
|
|
6
|
-
* [
|
|
6
|
+
* [deleteDataset](#deletedataset) - Delete a dataset
|
|
7
7
|
* [getDatasets](#getdatasets) - Get datasets
|
|
8
|
-
* [
|
|
9
|
-
* [
|
|
8
|
+
* [createDataset](#createdataset) - Create a dataset
|
|
9
|
+
* [updateDataset](#updatedataset) - Update a dataset
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## deleteDataset
|
|
12
12
|
|
|
13
13
|
Delete a dataset
|
|
14
14
|
|
|
15
15
|
### Example Usage
|
|
16
16
|
|
|
17
17
|
```typescript
|
|
18
|
-
import { HoneyHive } from "
|
|
19
|
-
import {
|
|
18
|
+
import { HoneyHive } from "honeyhive";
|
|
19
|
+
import { DeleteDatasetRequest } from "honeyhive/dist/models/operations";
|
|
20
20
|
|
|
21
21
|
async function run() {
|
|
22
22
|
const sdk = new HoneyHive({
|
|
@@ -24,7 +24,7 @@ async function run() {
|
|
|
24
24
|
});
|
|
25
25
|
const datasetId: string = "<value>";
|
|
26
26
|
|
|
27
|
-
const res = await sdk.datasets.
|
|
27
|
+
const res = await sdk.datasets.deleteDataset(datasetId);
|
|
28
28
|
|
|
29
29
|
if (res.statusCode == 200) {
|
|
30
30
|
// handle response
|
|
@@ -44,7 +44,7 @@ run();
|
|
|
44
44
|
|
|
45
45
|
### Response
|
|
46
46
|
|
|
47
|
-
**Promise<[operations.
|
|
47
|
+
**Promise<[operations.DeleteDatasetResponse](../../models/operations/deletedatasetresponse.md)>**
|
|
48
48
|
### Errors
|
|
49
49
|
|
|
50
50
|
| Error Object | Status Code | Content Type |
|
|
@@ -58,8 +58,8 @@ Get datasets
|
|
|
58
58
|
### Example Usage
|
|
59
59
|
|
|
60
60
|
```typescript
|
|
61
|
-
import { HoneyHive } from "
|
|
62
|
-
import { GetDatasetsQueryParamType, GetDatasetsRequest } from "
|
|
61
|
+
import { HoneyHive } from "honeyhive";
|
|
62
|
+
import { GetDatasetsQueryParamType, GetDatasetsRequest } from "honeyhive/dist/models/operations";
|
|
63
63
|
|
|
64
64
|
async function run() {
|
|
65
65
|
const sdk = new HoneyHive({
|
|
@@ -98,29 +98,31 @@ run();
|
|
|
98
98
|
| --------------- | --------------- | --------------- |
|
|
99
99
|
| errors.SDKError | 4xx-5xx | */* |
|
|
100
100
|
|
|
101
|
-
##
|
|
101
|
+
## createDataset
|
|
102
102
|
|
|
103
103
|
Create a dataset
|
|
104
104
|
|
|
105
105
|
### Example Usage
|
|
106
106
|
|
|
107
107
|
```typescript
|
|
108
|
-
import { HoneyHive } from "
|
|
109
|
-
import { CreateDatasetRequestType, PipelineType } from "
|
|
108
|
+
import { HoneyHive } from "honeyhive";
|
|
109
|
+
import { CreateDatasetRequestType, PipelineType } from "honeyhive/dist/models/components";
|
|
110
110
|
|
|
111
111
|
async function run() {
|
|
112
112
|
const sdk = new HoneyHive({
|
|
113
113
|
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
|
|
114
114
|
});
|
|
115
115
|
|
|
116
|
-
const res = await sdk.datasets.
|
|
116
|
+
const res = await sdk.datasets.createDataset({
|
|
117
117
|
datapoints: [
|
|
118
118
|
"<value>",
|
|
119
119
|
],
|
|
120
120
|
linkedEvals: [
|
|
121
121
|
"<value>",
|
|
122
122
|
],
|
|
123
|
-
metadata: {
|
|
123
|
+
metadata: {
|
|
124
|
+
"key": "<value>",
|
|
125
|
+
},
|
|
124
126
|
name: "<value>",
|
|
125
127
|
project: "<value>",
|
|
126
128
|
});
|
|
@@ -143,28 +145,28 @@ run();
|
|
|
143
145
|
|
|
144
146
|
### Response
|
|
145
147
|
|
|
146
|
-
**Promise<[operations.
|
|
148
|
+
**Promise<[operations.CreateDatasetResponse](../../models/operations/createdatasetresponse.md)>**
|
|
147
149
|
### Errors
|
|
148
150
|
|
|
149
151
|
| Error Object | Status Code | Content Type |
|
|
150
152
|
| --------------- | --------------- | --------------- |
|
|
151
153
|
| errors.SDKError | 4xx-5xx | */* |
|
|
152
154
|
|
|
153
|
-
##
|
|
155
|
+
## updateDataset
|
|
154
156
|
|
|
155
157
|
Update a dataset
|
|
156
158
|
|
|
157
159
|
### Example Usage
|
|
158
160
|
|
|
159
161
|
```typescript
|
|
160
|
-
import { HoneyHive } from "
|
|
162
|
+
import { HoneyHive } from "honeyhive";
|
|
161
163
|
|
|
162
164
|
async function run() {
|
|
163
165
|
const sdk = new HoneyHive({
|
|
164
166
|
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
|
|
165
167
|
});
|
|
166
168
|
|
|
167
|
-
const res = await sdk.datasets.
|
|
169
|
+
const res = await sdk.datasets.updateDataset({
|
|
168
170
|
datapoints: [
|
|
169
171
|
"<value>",
|
|
170
172
|
],
|
|
@@ -172,7 +174,9 @@ async function run() {
|
|
|
172
174
|
linkedEvals: [
|
|
173
175
|
"<value>",
|
|
174
176
|
],
|
|
175
|
-
metadata: {
|
|
177
|
+
metadata: {
|
|
178
|
+
"key": "<value>",
|
|
179
|
+
},
|
|
176
180
|
});
|
|
177
181
|
|
|
178
182
|
if (res.statusCode == 200) {
|
|
@@ -193,7 +197,7 @@ run();
|
|
|
193
197
|
|
|
194
198
|
### Response
|
|
195
199
|
|
|
196
|
-
**Promise<[operations.
|
|
200
|
+
**Promise<[operations.UpdateDatasetResponse](../../models/operations/updatedatasetresponse.md)>**
|
|
197
201
|
### Errors
|
|
198
202
|
|
|
199
203
|
| Error Object | Status Code | Content Type |
|
|
@@ -3,41 +3,55 @@
|
|
|
3
3
|
|
|
4
4
|
### Available Operations
|
|
5
5
|
|
|
6
|
-
* [
|
|
7
|
-
* [
|
|
8
|
-
* [
|
|
6
|
+
* [createEvent](#createevent) - Create a new event
|
|
7
|
+
* [updateEvent](#updateevent) - Update an event
|
|
8
|
+
* [deleteEvent](#deleteevent) - Delete an event
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## createEvent
|
|
11
11
|
|
|
12
12
|
Please refer to our instrumentation guide for detailed information
|
|
13
13
|
|
|
14
14
|
### Example Usage
|
|
15
15
|
|
|
16
16
|
```typescript
|
|
17
|
-
import { HoneyHive } from "
|
|
18
|
-
import { EventType } from "
|
|
17
|
+
import { HoneyHive } from "honeyhive";
|
|
18
|
+
import { EventType } from "honeyhive/dist/models/components";
|
|
19
19
|
|
|
20
20
|
async function run() {
|
|
21
21
|
const sdk = new HoneyHive({
|
|
22
22
|
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
|
|
23
23
|
});
|
|
24
24
|
|
|
25
|
-
const res = await sdk.events.
|
|
25
|
+
const res = await sdk.events.createEvent({
|
|
26
26
|
event: {
|
|
27
27
|
childrenIds: [
|
|
28
28
|
"<value>",
|
|
29
29
|
],
|
|
30
|
-
config: {
|
|
30
|
+
config: {
|
|
31
|
+
"key": "<value>",
|
|
32
|
+
},
|
|
31
33
|
eventName: "<value>",
|
|
32
|
-
eventType: EventType.
|
|
33
|
-
feedback: {
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
34
|
+
eventType: EventType.Model,
|
|
35
|
+
feedback: {
|
|
36
|
+
"key": "<value>",
|
|
37
|
+
},
|
|
38
|
+
inputs: {
|
|
39
|
+
"key": "<value>",
|
|
40
|
+
},
|
|
41
|
+
metadata: {
|
|
42
|
+
"key": "<value>",
|
|
43
|
+
},
|
|
44
|
+
metrics: {
|
|
45
|
+
"key": "<value>",
|
|
46
|
+
},
|
|
47
|
+
outputs: {
|
|
48
|
+
"key": "<value>",
|
|
49
|
+
},
|
|
38
50
|
project: "<value>",
|
|
39
51
|
source: "<value>",
|
|
40
|
-
userProperties: {
|
|
52
|
+
userProperties: {
|
|
53
|
+
"key": "<value>",
|
|
54
|
+
},
|
|
41
55
|
},
|
|
42
56
|
});
|
|
43
57
|
|
|
@@ -51,41 +65,49 @@ run();
|
|
|
51
65
|
|
|
52
66
|
### Parameters
|
|
53
67
|
|
|
54
|
-
| Parameter
|
|
55
|
-
|
|
|
56
|
-
| `request`
|
|
57
|
-
| `config`
|
|
68
|
+
| Parameter | Type | Required | Description |
|
|
69
|
+
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
70
|
+
| `request` | [operations.CreateEventRequestBody](../../models/operations/createeventrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
71
|
+
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
58
72
|
|
|
59
73
|
|
|
60
74
|
### Response
|
|
61
75
|
|
|
62
|
-
**Promise<[operations.
|
|
76
|
+
**Promise<[operations.CreateEventResponse](../../models/operations/createeventresponse.md)>**
|
|
63
77
|
### Errors
|
|
64
78
|
|
|
65
79
|
| Error Object | Status Code | Content Type |
|
|
66
80
|
| --------------- | --------------- | --------------- |
|
|
67
81
|
| errors.SDKError | 4xx-5xx | */* |
|
|
68
82
|
|
|
69
|
-
##
|
|
83
|
+
## updateEvent
|
|
70
84
|
|
|
71
85
|
Update an event
|
|
72
86
|
|
|
73
87
|
### Example Usage
|
|
74
88
|
|
|
75
89
|
```typescript
|
|
76
|
-
import { HoneyHive } from "
|
|
90
|
+
import { HoneyHive } from "honeyhive";
|
|
77
91
|
|
|
78
92
|
async function run() {
|
|
79
93
|
const sdk = new HoneyHive({
|
|
80
94
|
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
|
|
81
95
|
});
|
|
82
96
|
|
|
83
|
-
const res = await sdk.events.
|
|
97
|
+
const res = await sdk.events.updateEvent({
|
|
84
98
|
eventId: "<value>",
|
|
85
|
-
feedback: {
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
99
|
+
feedback: {
|
|
100
|
+
"key": "<value>",
|
|
101
|
+
},
|
|
102
|
+
metadata: {
|
|
103
|
+
"key": "<value>",
|
|
104
|
+
},
|
|
105
|
+
metrics: {
|
|
106
|
+
"key": "<value>",
|
|
107
|
+
},
|
|
108
|
+
outputs: {
|
|
109
|
+
"key": "<value>",
|
|
110
|
+
},
|
|
89
111
|
});
|
|
90
112
|
|
|
91
113
|
if (res.statusCode == 200) {
|
|
@@ -98,30 +120,30 @@ run();
|
|
|
98
120
|
|
|
99
121
|
### Parameters
|
|
100
122
|
|
|
101
|
-
| Parameter
|
|
102
|
-
|
|
|
103
|
-
| `request`
|
|
104
|
-
| `config`
|
|
123
|
+
| Parameter | Type | Required | Description |
|
|
124
|
+
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
125
|
+
| `request` | [operations.UpdateEventRequestBody](../../models/operations/updateeventrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
126
|
+
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
105
127
|
|
|
106
128
|
|
|
107
129
|
### Response
|
|
108
130
|
|
|
109
|
-
**Promise<[operations.
|
|
131
|
+
**Promise<[operations.UpdateEventResponse](../../models/operations/updateeventresponse.md)>**
|
|
110
132
|
### Errors
|
|
111
133
|
|
|
112
134
|
| Error Object | Status Code | Content Type |
|
|
113
135
|
| --------------- | --------------- | --------------- |
|
|
114
136
|
| errors.SDKError | 4xx-5xx | */* |
|
|
115
137
|
|
|
116
|
-
##
|
|
138
|
+
## deleteEvent
|
|
117
139
|
|
|
118
140
|
Delete an event
|
|
119
141
|
|
|
120
142
|
### Example Usage
|
|
121
143
|
|
|
122
144
|
```typescript
|
|
123
|
-
import { HoneyHive } from "
|
|
124
|
-
import {
|
|
145
|
+
import { HoneyHive } from "honeyhive";
|
|
146
|
+
import { DeleteEventRequest } from "honeyhive/dist/models/operations";
|
|
125
147
|
|
|
126
148
|
async function run() {
|
|
127
149
|
const sdk = new HoneyHive({
|
|
@@ -130,7 +152,7 @@ async function run() {
|
|
|
130
152
|
const eventId: string = "<value>";
|
|
131
153
|
const project: string = "<value>";
|
|
132
154
|
|
|
133
|
-
const res = await sdk.events.
|
|
155
|
+
const res = await sdk.events.deleteEvent(eventId, project);
|
|
134
156
|
|
|
135
157
|
if (res.statusCode == 200) {
|
|
136
158
|
// handle response
|
|
@@ -151,7 +173,7 @@ run();
|
|
|
151
173
|
|
|
152
174
|
### Response
|
|
153
175
|
|
|
154
|
-
**Promise<[operations.
|
|
176
|
+
**Promise<[operations.DeleteEventResponse](../../models/operations/deleteeventresponse.md)>**
|
|
155
177
|
### Errors
|
|
156
178
|
|
|
157
179
|
| Error Object | Status Code | Content Type |
|
|
@@ -3,20 +3,20 @@
|
|
|
3
3
|
|
|
4
4
|
### Available Operations
|
|
5
5
|
|
|
6
|
-
* [
|
|
6
|
+
* [deleteMetric](#deletemetric) - Delete a metric
|
|
7
7
|
* [getMetrics](#getmetrics) - Get all metrics
|
|
8
|
-
* [
|
|
9
|
-
* [
|
|
8
|
+
* [createMetric](#createmetric) - Create a new metric
|
|
9
|
+
* [updateMetric](#updatemetric) - Update an existing metric
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## deleteMetric
|
|
12
12
|
|
|
13
13
|
Remove a metric
|
|
14
14
|
|
|
15
15
|
### Example Usage
|
|
16
16
|
|
|
17
17
|
```typescript
|
|
18
|
-
import { HoneyHive } from "
|
|
19
|
-
import {
|
|
18
|
+
import { HoneyHive } from "honeyhive";
|
|
19
|
+
import { DeleteMetricRequest } from "honeyhive/dist/models/operations";
|
|
20
20
|
|
|
21
21
|
async function run() {
|
|
22
22
|
const sdk = new HoneyHive({
|
|
@@ -24,7 +24,7 @@ async function run() {
|
|
|
24
24
|
});
|
|
25
25
|
const metricId: string = "<value>";
|
|
26
26
|
|
|
27
|
-
const res = await sdk.metrics.
|
|
27
|
+
const res = await sdk.metrics.deleteMetric(metricId);
|
|
28
28
|
|
|
29
29
|
if (res.statusCode == 200) {
|
|
30
30
|
// handle response
|
|
@@ -44,7 +44,7 @@ run();
|
|
|
44
44
|
|
|
45
45
|
### Response
|
|
46
46
|
|
|
47
|
-
**Promise<[operations.
|
|
47
|
+
**Promise<[operations.DeleteMetricResponse](../../models/operations/deletemetricresponse.md)>**
|
|
48
48
|
### Errors
|
|
49
49
|
|
|
50
50
|
| Error Object | Status Code | Content Type |
|
|
@@ -58,8 +58,8 @@ Retrieve a list of all metrics
|
|
|
58
58
|
### Example Usage
|
|
59
59
|
|
|
60
60
|
```typescript
|
|
61
|
-
import { HoneyHive } from "
|
|
62
|
-
import { GetMetricsRequest } from "
|
|
61
|
+
import { HoneyHive } from "honeyhive";
|
|
62
|
+
import { GetMetricsRequest } from "honeyhive/dist/models/operations";
|
|
63
63
|
|
|
64
64
|
async function run() {
|
|
65
65
|
const sdk = new HoneyHive({
|
|
@@ -94,28 +94,28 @@ run();
|
|
|
94
94
|
| --------------- | --------------- | --------------- |
|
|
95
95
|
| errors.SDKError | 4xx-5xx | */* |
|
|
96
96
|
|
|
97
|
-
##
|
|
97
|
+
## createMetric
|
|
98
98
|
|
|
99
99
|
Add a new metric
|
|
100
100
|
|
|
101
101
|
### Example Usage
|
|
102
102
|
|
|
103
103
|
```typescript
|
|
104
|
-
import { HoneyHive } from "
|
|
105
|
-
import { MetricType, ReturnTypeT } from "
|
|
104
|
+
import { HoneyHive } from "honeyhive";
|
|
105
|
+
import { MetricType, ReturnTypeT } from "honeyhive/dist/models/components";
|
|
106
106
|
|
|
107
107
|
async function run() {
|
|
108
108
|
const sdk = new HoneyHive({
|
|
109
109
|
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
|
|
110
110
|
});
|
|
111
111
|
|
|
112
|
-
const res = await sdk.metrics.
|
|
113
|
-
description: "
|
|
112
|
+
const res = await sdk.metrics.createMetric({
|
|
113
|
+
description: "Mandatory eco-centric open system",
|
|
114
114
|
name: "<value>",
|
|
115
|
-
returnType: ReturnTypeT.
|
|
115
|
+
returnType: ReturnTypeT.Float,
|
|
116
116
|
task: "<value>",
|
|
117
117
|
threshold: {},
|
|
118
|
-
type: MetricType.
|
|
118
|
+
type: MetricType.Human,
|
|
119
119
|
});
|
|
120
120
|
|
|
121
121
|
if (res.statusCode == 200) {
|
|
@@ -136,29 +136,30 @@ run();
|
|
|
136
136
|
|
|
137
137
|
### Response
|
|
138
138
|
|
|
139
|
-
**Promise<[operations.
|
|
139
|
+
**Promise<[operations.CreateMetricResponse](../../models/operations/createmetricresponse.md)>**
|
|
140
140
|
### Errors
|
|
141
141
|
|
|
142
142
|
| Error Object | Status Code | Content Type |
|
|
143
143
|
| --------------- | --------------- | --------------- |
|
|
144
144
|
| errors.SDKError | 4xx-5xx | */* |
|
|
145
145
|
|
|
146
|
-
##
|
|
146
|
+
## updateMetric
|
|
147
147
|
|
|
148
148
|
Edit a metric
|
|
149
149
|
|
|
150
150
|
### Example Usage
|
|
151
151
|
|
|
152
152
|
```typescript
|
|
153
|
-
import { HoneyHive } from "
|
|
154
|
-
import { MetricEditEventType, MetricEditReturnType, MetricEditType } from "
|
|
153
|
+
import { HoneyHive } from "honeyhive";
|
|
154
|
+
import { MetricEditEventType, MetricEditReturnType, MetricEditType } from "honeyhive/dist/models/components";
|
|
155
155
|
|
|
156
156
|
async function run() {
|
|
157
157
|
const sdk = new HoneyHive({
|
|
158
158
|
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
|
|
159
159
|
});
|
|
160
160
|
|
|
161
|
-
const res = await sdk.metrics.
|
|
161
|
+
const res = await sdk.metrics.updateMetric({
|
|
162
|
+
metricId: "<value>",
|
|
162
163
|
threshold: {},
|
|
163
164
|
});
|
|
164
165
|
|
|
@@ -180,7 +181,7 @@ run();
|
|
|
180
181
|
|
|
181
182
|
### Response
|
|
182
183
|
|
|
183
|
-
**Promise<[operations.
|
|
184
|
+
**Promise<[operations.UpdateMetricResponse](../../models/operations/updatemetricresponse.md)>**
|
|
184
185
|
### Errors
|
|
185
186
|
|
|
186
187
|
| Error Object | Status Code | Content Type |
|
|
@@ -15,8 +15,8 @@ Delete a project
|
|
|
15
15
|
### Example Usage
|
|
16
16
|
|
|
17
17
|
```typescript
|
|
18
|
-
import { HoneyHive } from "
|
|
19
|
-
import { DeleteProjectRequest } from "
|
|
18
|
+
import { HoneyHive } from "honeyhive";
|
|
19
|
+
import { DeleteProjectRequest } from "honeyhive/dist/models/operations";
|
|
20
20
|
|
|
21
21
|
async function run() {
|
|
22
22
|
const sdk = new HoneyHive({
|
|
@@ -58,8 +58,8 @@ Get a list of projects
|
|
|
58
58
|
### Example Usage
|
|
59
59
|
|
|
60
60
|
```typescript
|
|
61
|
-
import { HoneyHive } from "
|
|
62
|
-
import { GetProjectsRequest } from "
|
|
61
|
+
import { HoneyHive } from "honeyhive";
|
|
62
|
+
import { GetProjectsRequest } from "honeyhive/dist/models/operations";
|
|
63
63
|
|
|
64
64
|
async function run() {
|
|
65
65
|
const sdk = new HoneyHive({
|
|
@@ -101,8 +101,7 @@ Create a new project
|
|
|
101
101
|
### Example Usage
|
|
102
102
|
|
|
103
103
|
```typescript
|
|
104
|
-
import { HoneyHive } from "
|
|
105
|
-
import { CreateProjectRequestType } from "HoneyHive/dist/models/components";
|
|
104
|
+
import { HoneyHive } from "honeyhive";
|
|
106
105
|
|
|
107
106
|
async function run() {
|
|
108
107
|
const sdk = new HoneyHive({
|
|
@@ -145,8 +144,7 @@ Update an existing project
|
|
|
145
144
|
### Example Usage
|
|
146
145
|
|
|
147
146
|
```typescript
|
|
148
|
-
import { HoneyHive } from "
|
|
149
|
-
import { ProjectType } from "HoneyHive/dist/models/components";
|
|
147
|
+
import { HoneyHive } from "honeyhive";
|
|
150
148
|
|
|
151
149
|
async function run() {
|
|
152
150
|
const sdk = new HoneyHive({
|
|
@@ -154,9 +152,7 @@ async function run() {
|
|
|
154
152
|
});
|
|
155
153
|
|
|
156
154
|
const res = await sdk.projects.updateProject({
|
|
157
|
-
|
|
158
|
-
name: "<value>",
|
|
159
|
-
type: ProjectType.Completions,
|
|
155
|
+
projectId: "<value>",
|
|
160
156
|
});
|
|
161
157
|
|
|
162
158
|
if (res.statusCode == 200) {
|
|
@@ -169,10 +165,10 @@ run();
|
|
|
169
165
|
|
|
170
166
|
### Parameters
|
|
171
167
|
|
|
172
|
-
| Parameter
|
|
173
|
-
|
|
|
174
|
-
| `request`
|
|
175
|
-
| `config`
|
|
168
|
+
| Parameter | Type | Required | Description |
|
|
169
|
+
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
|
170
|
+
| `request` | [components.UpdateProjectRequest](../../models/components/updateprojectrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
171
|
+
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
|
176
172
|
|
|
177
173
|
|
|
178
174
|
### Response
|
|
@@ -15,7 +15,7 @@ Start a new session
|
|
|
15
15
|
### Example Usage
|
|
16
16
|
|
|
17
17
|
```typescript
|
|
18
|
-
import { HoneyHive } from "
|
|
18
|
+
import { HoneyHive } from "honeyhive";
|
|
19
19
|
|
|
20
20
|
async function run() {
|
|
21
21
|
const sdk = new HoneyHive({
|
|
@@ -27,16 +27,30 @@ async function run() {
|
|
|
27
27
|
childrenIds: [
|
|
28
28
|
"<value>",
|
|
29
29
|
],
|
|
30
|
-
config: {
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
30
|
+
config: {
|
|
31
|
+
"key": "<value>",
|
|
32
|
+
},
|
|
33
|
+
feedback: {
|
|
34
|
+
"key": "<value>",
|
|
35
|
+
},
|
|
36
|
+
inputs: {
|
|
37
|
+
"key": "<value>",
|
|
38
|
+
},
|
|
39
|
+
metadata: {
|
|
40
|
+
"key": "<value>",
|
|
41
|
+
},
|
|
42
|
+
metrics: {
|
|
43
|
+
"key": "<value>",
|
|
44
|
+
},
|
|
45
|
+
outputs: {
|
|
46
|
+
"key": "<value>",
|
|
47
|
+
},
|
|
36
48
|
project: "<value>",
|
|
37
49
|
sessionName: "<value>",
|
|
38
50
|
source: "<value>",
|
|
39
|
-
userProperties: {
|
|
51
|
+
userProperties: {
|
|
52
|
+
"key": "<value>",
|
|
53
|
+
},
|
|
40
54
|
},
|
|
41
55
|
});
|
|
42
56
|
|
|
@@ -72,8 +86,8 @@ Delete a session
|
|
|
72
86
|
### Example Usage
|
|
73
87
|
|
|
74
88
|
```typescript
|
|
75
|
-
import { HoneyHive } from "
|
|
76
|
-
import { DeleteSessionRequest } from "
|
|
89
|
+
import { HoneyHive } from "honeyhive";
|
|
90
|
+
import { DeleteSessionRequest } from "honeyhive/dist/models/operations";
|
|
77
91
|
|
|
78
92
|
async function run() {
|
|
79
93
|
const sdk = new HoneyHive({
|
|
@@ -115,8 +129,8 @@ Retrieve a session
|
|
|
115
129
|
### Example Usage
|
|
116
130
|
|
|
117
131
|
```typescript
|
|
118
|
-
import { HoneyHive } from "
|
|
119
|
-
import { GetSessionRequest } from "
|
|
132
|
+
import { HoneyHive } from "honeyhive";
|
|
133
|
+
import { GetSessionRequest } from "honeyhive/dist/models/operations";
|
|
120
134
|
|
|
121
135
|
async function run() {
|
|
122
136
|
const sdk = new HoneyHive({
|
|
@@ -158,8 +172,8 @@ Process an event trace for a given session
|
|
|
158
172
|
### Example Usage
|
|
159
173
|
|
|
160
174
|
```typescript
|
|
161
|
-
import { HoneyHive } from "
|
|
162
|
-
import { ProcessEventTraceRequest, ProcessEventTraceRequestBody } from "
|
|
175
|
+
import { HoneyHive } from "honeyhive";
|
|
176
|
+
import { ProcessEventTraceRequest, ProcessEventTraceRequestBody } from "honeyhive/dist/models/operations";
|
|
163
177
|
|
|
164
178
|
async function run() {
|
|
165
179
|
const sdk = new HoneyHive({
|