honeyhive 1.0.21 → 1.0.25

package/docs/models/components/sessionstartrequest.md

@@ -0,0 +1,68 @@
+# SessionStartRequest
+
+## Example Usage
+
+```typescript
+import { SessionStartRequest } from "honeyhive/models/components";
+
+let value: SessionStartRequest = {
+  project: "Simple RAG Project",
+  sessionName: "Playground Session",
+  source: "playground",
+  sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
+  childrenIds: [
+    "7f22137a-6911-4ed3-bc36-110f1dde6b66",
+  ],
+  inputs: {
+    "context": "Hello world",
+    "question": "What is in the context?",
+    "chat_history": [
+      {
+        "role": "system",
+        "content": "Answer the user's question only using provided context.\n"
+          + "\n"
+          + "Context: Hello world",
+      },
+      {
+        "role": "user",
+        "content": "What is in the context?",
+      },
+    ],
+  },
+  outputs: {
+    "role": "assistant",
+    "content": "Hello world",
+  },
+  error: null,
+  duration: 824.8056,
+  userProperties: {
+    "user": "google-oauth2|111840237613341303366",
+  },
+  metrics: {},
+  feedback: {},
+  metadata: {},
+  startTime: 1712025501605,
+  endTime: 1712025499832,
+};
+```
+
+## Fields
+
+| Field                                                           | Type                                                            | Required                                                        | Description                                                     |
+| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
+| `project`                                                       | *string*                                                        | :heavy_check_mark:                                              | Project name associated with the session                        |
+| `sessionName`                                                   | *string*                                                        | :heavy_check_mark:                                              | Name of the session                                             |
+| `source`                                                        | *string*                                                        | :heavy_check_mark:                                              | Source of the session - production, staging, etc                |
+| `sessionId`                                                     | *string*                                                        | :heavy_minus_sign:                                              | Unique id of the session, if not set, it will be auto-generated |
+| `childrenIds`                                                   | *string*[]                                                      | :heavy_minus_sign:                                              | Id of events that are nested within the session                 |
+| `config`                                                        | Record<string, *any*>                                           | :heavy_minus_sign:                                              | Associated configuration for the session                        |
+| `inputs`                                                        | Record<string, *any*>                                           | :heavy_minus_sign:                                              | Input object passed to the session - user query, text blob, etc |
+| `outputs`                                                       | Record<string, *any*>                                           | :heavy_minus_sign:                                              | Final output of the session - completion, chunks, etc           |
+| `error`                                                         | *string*                                                        | :heavy_minus_sign:                                              | Any error description if session failed                         |
+| `duration`                                                      | *number*                                                        | :heavy_minus_sign:                                              | How long the session took in milliseconds                       |
+| `userProperties`                                                | Record<string, *any*>                                           | :heavy_minus_sign:                                              | Any user properties associated with the session                 |
+| `metrics`                                                       | Record<string, *any*>                                           | :heavy_minus_sign:                                              | Any values computed over the output of the session              |
+| `feedback`                                                      | Record<string, *any*>                                           | :heavy_minus_sign:                                              | Any user feedback provided for the session output               |
+| `metadata`                                                      | Record<string, *any*>                                           | :heavy_minus_sign:                                              | Any system or application metadata associated with the session  |
+| `startTime`                                                     | *number*                                                        | :heavy_minus_sign:                                              | UTC timestamp (in milliseconds) for the session start           |
+| `endTime`                                                       | *number*                                                        | :heavy_minus_sign:                                              | UTC timestamp (in milliseconds) for the session end             |

package/docs/models/components/status.md

@@ -0,0 +1,17 @@
+# Status
+
+The status of the run
+
+## Example Usage
+
+```typescript
+import { Status } from "honeyhive/models/components";
+
+let value: Status = "pending";
+```
+
+## Values
+
+```typescript
+"pending" | "completed"
+```

package/docs/models/components/threshold.md

@@ -0,0 +1,18 @@
+# Threshold
+
+Threshold for numeric metrics to decide passing or failing in tests
+
+## Example Usage
+
+```typescript
+import { Threshold } from "honeyhive/models/components";
+
+let value: Threshold = {};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `min`              | *number*           | :heavy_minus_sign: | N/A                |
+| `max`              | *number*           | :heavy_minus_sign: | N/A                |

package/docs/models/components/tool.md

@@ -0,0 +1,27 @@
+# Tool
+
+## Example Usage
+
+```typescript
+import { Tool } from "honeyhive/models/components";
+
+let value: Tool = {
+  task: "<value>",
+  name: "<value>",
+  parameters: {
+    "key": "<value>",
+  },
+  toolType: "tool",
+};
+```
+
+## Fields
+
+| Field                                                      | Type                                                       | Required                                                   | Description                                                |
+| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
+| `id`                                                       | *string*                                                   | :heavy_minus_sign:                                         | N/A                                                        |
+| `task`                                                     | *string*                                                   | :heavy_check_mark:                                         | Name of the project associated with this tool              |
+| `name`                                                     | *string*                                                   | :heavy_check_mark:                                         | N/A                                                        |
+| `description`                                              | *string*                                                   | :heavy_minus_sign:                                         | N/A                                                        |
+| `parameters`                                               | Record<string, *any*>                                      | :heavy_check_mark:                                         | These can be function call params or plugin call params    |
+| `toolType`                                                 | [components.ToolType](../../models/components/tooltype.md) | :heavy_check_mark:                                         | N/A                                                        |

package/docs/models/components/tooltype.md

@@ -0,0 +1,15 @@
+# ToolType
+
+## Example Usage
+
+```typescript
+import { ToolType } from "honeyhive/models/components";
+
+let value: ToolType = "function";
+```
+
+## Values
+
+```typescript
+"function" | "tool"
+```

package/docs/models/components/type.md

@@ -0,0 +1,17 @@
+# Type
+
+The data type you are using - "string", "number", "boolean", "id" (for object ids)
+
+## Example Usage
+
+```typescript
+import { Type } from "honeyhive/models/components";
+
+let value: Type = "id";
+```
+
+## Values
+
+```typescript
+"string" | "number" | "boolean" | "id"
+```

package/docs/models/components/updatedatapointrequest.md

@@ -0,0 +1,51 @@
+# UpdateDatapointRequest
+
+## Example Usage
+
+```typescript
+import { UpdateDatapointRequest } from "honeyhive/models/components";
+
+let value: UpdateDatapointRequest = {
+  inputs: {
+    "query": "what's the temperature in Reykjavik?",
+  },
+  history: [
+    {
+      "role": "system",
+      "content":
+        "You are a helpful web assistant that helps users answer questions about the world based on the information provided to you by Google's search API. Answer the questions as truthfully as you can. In case you are unsure about the correct answer, please respond with \"I apologize but I'm not sure.\"",
+    },
+    {
+      "role": "user",
+      "content":
+        "what's the temperature in Reykjavik?\n\n\n--Google search API results below:---\n\n\"snippet\":\"2 Week Extended Forecast in Reykjavik, Iceland ; Feb 4, 29 / 20 °F · Snow showers early. Broken clouds. ; Feb 5, 27 / 16 °F · Light snow. Decreasing cloudiness.\",\"snippet_highlighted_words\":[\"Feb 4, 29 / 20 °F\"]",
+    },
+  ],
+  groundTruth: {
+    "role": "assistant",
+    "content":
+      "The temperature in Reykjavik, Iceland is currently around 5F or -15C. Please note that weather conditions can change rapidly, so it's best to check a reliable source for the most up-to-date information.",
+  },
+  linkedEvals: [
+    "<value>",
+  ],
+  linkedDatasets: [
+    "<value>",
+  ],
+  metadata: {
+    "question_type": "capital-weather",
+    "random_field": 0,
+  },
+};
+```
+
+## Fields
+
+| Field                                                         | Type                                                          | Required                                                      | Description                                                   |
+| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
+| `inputs`                                                      | Record<string, *any*>                                         | :heavy_minus_sign:                                            | Arbitrary JSON object containing the inputs for the datapoint |
+| `history`                                                     | Record<string, *any*>[]                                       | :heavy_minus_sign:                                            | Conversation history associated with the datapoint            |
+| `groundTruth`                                                 | Record<string, *any*>                                         | :heavy_minus_sign:                                            | Expected output JSON object for the datapoint                 |
+| `linkedEvals`                                                 | *string*[]                                                    | :heavy_minus_sign:                                            | Ids of evaluations where the datapoint is included            |
+| `linkedDatasets`                                              | *string*[]                                                    | :heavy_minus_sign:                                            | Ids of all datasets that include the datapoint                |
+| `metadata`                                                    | Record<string, *any*>                                         | :heavy_minus_sign:                                            | Any additional metadata for the datapoint                     |

package/docs/models/components/updateprojectrequest.md

@@ -0,0 +1,19 @@
+# UpdateProjectRequest
+
+## Example Usage
+
+```typescript
+import { UpdateProjectRequest } from "honeyhive/models/components";
+
+let value: UpdateProjectRequest = {
+  projectId: "<id>",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `projectId`        | *string*           | :heavy_check_mark: | N/A                |
+| `name`             | *string*           | :heavy_minus_sign: | N/A                |
+| `description`      | *string*           | :heavy_minus_sign: | N/A                |

package/docs/models/components/updaterunrequest.md

@@ -0,0 +1,21 @@
+# UpdateRunRequest
+
+## Example Usage
+
+```typescript
+import { UpdateRunRequest } from "honeyhive/models/components";
+
+let value: UpdateRunRequest = {};
+```
+
+## Fields
+
+| Field                                                                                  | Type                                                                                   | Required                                                                               | Description                                                                            |
+| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
+| `eventIds`                                                                             | *string*[]                                                                             | :heavy_minus_sign:                                                                     | Additional sessions/events to associate with this run                                  |
+| `datasetId`                                                                            | *string*                                                                               | :heavy_minus_sign:                                                                     | The UUID of the dataset this run is associated with                                    |
+| `datapointIds`                                                                         | *string*[]                                                                             | :heavy_minus_sign:                                                                     | Additional datapoints to associate with this run                                       |
+| `configuration`                                                                        | Record<string, *any*>                                                                  | :heavy_minus_sign:                                                                     | The configuration being used for this run                                              |
+| `metadata`                                                                             | Record<string, *any*>                                                                  | :heavy_minus_sign:                                                                     | Additional metadata for the run                                                        |
+| `name`                                                                                 | *string*                                                                               | :heavy_minus_sign:                                                                     | The name of the run to be displayed                                                    |
+| `status`                                                                               | [components.UpdateRunRequestStatus](../../models/components/updaterunrequeststatus.md) | :heavy_minus_sign:                                                                     | N/A                                                                                    |

package/docs/models/components/updaterunrequeststatus.md

@@ -0,0 +1,15 @@
+# UpdateRunRequestStatus
+
+## Example Usage
+
+```typescript
+import { UpdateRunRequestStatus } from "honeyhive/models/components";
+
+let value: UpdateRunRequestStatus = "completed";
+```
+
+## Values
+
+```typescript
+"pending" | "completed"
+```

package/docs/models/components/updaterunresponse.md

@@ -0,0 +1,16 @@
+# UpdateRunResponse
+
+## Example Usage
+
+```typescript
+import { UpdateRunResponse } from "honeyhive/models/components";
+
+let value: UpdateRunResponse = {};
+```
+
+## Fields
+
+| Field                                                                                              | Type                                                                                               | Required                                                                                           | Description                                                                                        |
+| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| `evaluation`                                                                                       | Record<string, *any*>                                                                              | :heavy_minus_sign:                                                                                 | Database update success message                                                                    |
+| `warning`                                                                                          | *string*                                                                                           | :heavy_minus_sign:                                                                                 | A warning message if the logged events don't have an associated datapoint id on the event metadata |

package/docs/models/components/updatetoolrequest.md

@@ -0,0 +1,24 @@
+# UpdateToolRequest
+
+## Example Usage
+
+```typescript
+import { UpdateToolRequest } from "honeyhive/models/components";
+
+let value: UpdateToolRequest = {
+  id: "<id>",
+  name: "<value>",
+  parameters: {
+    "key": "<value>",
+  },
+};
+```
+
+## Fields
+
+| Field                 | Type                  | Required              | Description           |
+| --------------------- | --------------------- | --------------------- | --------------------- |
+| `id`                  | *string*              | :heavy_check_mark:    | N/A                   |
+| `name`                | *string*              | :heavy_check_mark:    | N/A                   |
+| `description`         | *string*              | :heavy_minus_sign:    | N/A                   |
+| `parameters`          | Record<string, *any*> | :heavy_check_mark:    | N/A                   |

package/docs/models/components/value.md

@@ -0,0 +1,17 @@
+# Value
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 4071.83;
+```
+
+### `boolean`
+
+```typescript
+const value: boolean = false;
+```
+

package/docs/models/components/values.md

@@ -0,0 +1,17 @@
+# Values
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 5691.01;
+```
+
+### `boolean`
+
+```typescript
+const value: boolean = false;
+```
+

package/docs/models/errors/createeventbatchresponsebody.md

@@ -0,0 +1,19 @@
+# CreateEventBatchResponseBody
+
+Events partially created
+
+## Example Usage
+
+```typescript
+import { CreateEventBatchResponseBody } from "honeyhive/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `eventIds`         | *string*[]         | :heavy_minus_sign: | N/A                |
+| `errors`           | *string*[]         | :heavy_minus_sign: | N/A                |
+| `success`          | *boolean*          | :heavy_minus_sign: | N/A                |

package/docs/models/errors/createmodeleventbatchresponsebody.md

@@ -0,0 +1,19 @@
+# CreateModelEventBatchResponseBody
+
+Model events partially created
+
+## Example Usage
+
+```typescript
+import { CreateModelEventBatchResponseBody } from "honeyhive/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `eventIds`         | *string*[]         | :heavy_minus_sign: | N/A                |
+| `errors`           | *string*[]         | :heavy_minus_sign: | N/A                |
+| `success`          | *boolean*          | :heavy_minus_sign: | N/A                |

package/docs/models/operations/adddatapointsrequest.md

@@ -0,0 +1,37 @@
+# AddDatapointsRequest
+
+## Example Usage
+
+```typescript
+import { AddDatapointsRequest } from "honeyhive/models/operations";
+
+let value: AddDatapointsRequest = {
+  datasetId: "<id>",
+  requestBody: {
+    project: "<value>",
+    data: [
+      {
+        "key": "<value>",
+      },
+    ],
+    mapping: {
+      inputs: [
+        "<value>",
+      ],
+      groundTruth: [
+        "<value>",
+      ],
+      history: [
+        "<value>",
+      ],
+    },
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                      | Type                                                                                       | Required                                                                                   | Description                                                                                |
+| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
+| `datasetId`                                                                                | *string*                                                                                   | :heavy_check_mark:                                                                         | The unique identifier of the dataset to add datapoints to like  `663876ec4611c47f4970f0c3` |
+| `requestBody`                                                                              | [operations.AddDatapointsRequestBody](../../models/operations/adddatapointsrequestbody.md) | :heavy_check_mark:                                                                         | N/A                                                                                        |

package/docs/models/operations/adddatapointsrequestbody.md

@@ -0,0 +1,35 @@
+# AddDatapointsRequestBody
+
+## Example Usage
+
+```typescript
+import { AddDatapointsRequestBody } from "honeyhive/models/operations";
+
+let value: AddDatapointsRequestBody = {
+  project: "<value>",
+  data: [
+    {
+      "key": "<value>",
+    },
+  ],
+  mapping: {
+    inputs: [
+      "<value>",
+    ],
+    groundTruth: [
+      "<value>",
+    ],
+    history: [
+      "<value>",
+    ],
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                                                  | Type                                                                                                                   | Required                                                                                                               | Description                                                                                                            |
+| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| `project`                                                                                                              | *string*                                                                                                               | :heavy_check_mark:                                                                                                     | Name of the project associated with this dataset like `New Project`                                                    |
+| `data`                                                                                                                 | Record<string, *any*>[]                                                                                                | :heavy_check_mark:                                                                                                     | List of JSON objects to be added as datapoints                                                                         |
+| `mapping`                                                                                                              | [operations.Mapping](../../models/operations/mapping.md)                                                               | :heavy_check_mark:                                                                                                     | Mapping of keys in the data object to be used as inputs, ground truth, and history, everything else goes into metadata |

package/docs/models/operations/adddatapointsresponsebody.md

@@ -0,0 +1,18 @@
+# AddDatapointsResponseBody
+
+Successful addition
+
+## Example Usage
+
+```typescript
+import { AddDatapointsResponseBody } from "honeyhive/models/operations";
+
+let value: AddDatapointsResponseBody = {};
+```
+
+## Fields
+
+| Field                                             | Type                                              | Required                                          | Description                                       |
+| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- |
+| `inserted`                                        | *boolean*                                         | :heavy_minus_sign:                                | N/A                                               |
+| `datapointIds`                                    | *string*[]                                        | :heavy_minus_sign:                                | List of unique datapoint ids added to the dataset |

package/docs/models/operations/aggregatefunction.md

@@ -0,0 +1,15 @@
+# AggregateFunction
+
+## Example Usage
+
+```typescript
+import { AggregateFunction } from "honeyhive/models/operations";
+
+let value: AggregateFunction = "p90";
+```
+
+## Values
+
+```typescript
+"average" | "min" | "max" | "median" | "p95" | "p99" | "p90" | "sum" | "count"
+```

package/docs/models/operations/createdatapointresponsebody.md

@@ -0,0 +1,17 @@
+# CreateDatapointResponseBody
+
+Datapoint successfully created
+
+## Example Usage
+
+```typescript
+import { CreateDatapointResponseBody } from "honeyhive/models/operations";
+
+let value: CreateDatapointResponseBody = {};
+```
+
+## Fields
+
+| Field                                                                                | Type                                                                                 | Required                                                                             | Description                                                                          |
+| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
+| `result`                                                                             | [operations.CreateDatapointResult](../../models/operations/createdatapointresult.md) | :heavy_minus_sign:                                                                   | N/A                                                                                  |

package/docs/models/operations/createdatapointresult.md

@@ -0,0 +1,15 @@
+# CreateDatapointResult
+
+## Example Usage
+
+```typescript
+import { CreateDatapointResult } from "honeyhive/models/operations";
+
+let value: CreateDatapointResult = {};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `insertedId`       | *string*           | :heavy_minus_sign: | N/A                |

package/docs/models/operations/createdatasetresponsebody.md

@@ -0,0 +1,18 @@
+# CreateDatasetResponseBody
+
+Successful creation
+
+## Example Usage
+
+```typescript
+import { CreateDatasetResponseBody } from "honeyhive/models/operations";
+
+let value: CreateDatasetResponseBody = {};
+```
+
+## Fields
+
+| Field                                                                            | Type                                                                             | Required                                                                         | Description                                                                      |
+| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
+| `inserted`                                                                       | *boolean*                                                                        | :heavy_minus_sign:                                                               | N/A                                                                              |
+| `result`                                                                         | [operations.CreateDatasetResult](../../models/operations/createdatasetresult.md) | :heavy_minus_sign:                                                               | N/A                                                                              |

package/docs/models/operations/createdatasetresult.md

@@ -0,0 +1,15 @@
+# CreateDatasetResult
+
+## Example Usage
+
+```typescript
+import { CreateDatasetResult } from "honeyhive/models/operations";
+
+let value: CreateDatasetResult = {};
+```
+
+## Fields
+
+| Field                        | Type                         | Required                     | Description                  |
+| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
+| `insertedId`                 | *string*                     | :heavy_minus_sign:           | UUID for the created dataset |