honeyhive 1.0.21 → 1.0.23

package/docs/models/components/createtoolrequesttype.md

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

package/docs/models/components/datapoint.md

@@ -0,0 +1,69 @@
+# Datapoint
+
+## Example Usage
+
+```typescript
+import { Datapoint } from "honeyhive/models/components";
+
+let value: Datapoint = {
+  id: "65c13dbbd65fb876b7886cdb",
+  tenant: "org_XiCNIMTZzUKiY2As",
+  projectId: "653454f3138a956964341c07",
+  createdAt: "2024-02-05T19:57:47.05Z",
+  updatedAt: "2024-02-05T19:57:47.05Z",
+  inputs: {
+    "query": "what's the temperature in Iceland?",
+  },
+  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 Iceland?\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.",
+  },
+  linkedEvent: "6bba5182-d4b1-4b29-a64a-f0a8bd964f76",
+  linkedEvals: [
+    "<value>",
+  ],
+  linkedDatasets: [
+    "<value>",
+  ],
+  saved: false,
+  type: "event",
+  metadata: {
+    "question_type": "weather",
+    "completion_tokens": 47,
+    "prompt_tokens": 696,
+    "total_tokens": 743,
+  },
+};
+```
+
+## Fields
+
+| Field                                                         | Type                                                          | Required                                                      | Description                                                   |
+| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
+| `id`                                                          | *string*                                                      | :heavy_minus_sign:                                            | UUID for the datapoint                                        |
+| `tenant`                                                      | *string*                                                      | :heavy_minus_sign:                                            | N/A                                                           |
+| `projectId`                                                   | *string*                                                      | :heavy_minus_sign:                                            | UUID for the project where the datapoint is stored            |
+| `createdAt`                                                   | *string*                                                      | :heavy_minus_sign:                                            | N/A                                                           |
+| `updatedAt`                                                   | *string*                                                      | :heavy_minus_sign:                                            | N/A                                                           |
+| `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:                                            | N/A                                                           |
+| `linkedEvent`                                                 | *string*                                                      | :heavy_minus_sign:                                            | Event id for the event from which the datapoint was created   |
+| `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                |
+| `saved`                                                       | *boolean*                                                     | :heavy_minus_sign:                                            | N/A                                                           |
+| `type`                                                        | *string*                                                      | :heavy_minus_sign:                                            | session or event - specify the type of data                   |
+| `metadata`                                                    | Record<string, *any*>                                         | :heavy_minus_sign:                                            | N/A                                                           |

package/docs/models/components/datapoints.md

@@ -0,0 +1,18 @@
+# Datapoints
+
+## Example Usage
+
+```typescript
+import { Datapoints } from "honeyhive/models/components";
+
+let value: Datapoints = {};
+```
+
+## Fields
+
+| Field                                                                                                      | Type                                                                                                       | Required                                                                                                   | Description                                                                                                |
+| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `datapointId`                                                                                              | *string*                                                                                                   | :heavy_minus_sign:                                                                                         | N/A                                                                                                        |
+| `sessionId`                                                                                                | *string*                                                                                                   | :heavy_minus_sign:                                                                                         | N/A                                                                                                        |
+| `passed`                                                                                                   | *boolean*                                                                                                  | :heavy_minus_sign:                                                                                         | N/A                                                                                                        |
+| `metrics`                                                                                                  | [components.ExperimentResultResponseMetrics](../../models/components/experimentresultresponsemetrics.md)[] | :heavy_minus_sign:                                                                                         | N/A                                                                                                        |

package/docs/models/components/dataset.md

@@ -0,0 +1,41 @@
+# Dataset
+
+## Example Usage
+
+```typescript
+import { Dataset } from "honeyhive/models/components";
+
+let value: Dataset = {
+  project: "New Project",
+  name: "test-dataset",
+  description: "A test dataset",
+  type: "evaluation",
+  datapoints: [
+    "66369748b5773befbdc661e2",
+  ],
+  numPoints: 1,
+  linkedEvals: [
+    "<value>",
+  ],
+  saved: false,
+  pipelineType: "event",
+  createdAt: "2024-05-04T20:15:04.124Z",
+  updatedAt: "2024-05-04T20:15:04.124Z",
+};
+```
+
+## Fields
+
+| Field                                                                     | Type                                                                      | Required                                                                  | Description                                                               |
+| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `project`                                                                 | *string*                                                                  | :heavy_minus_sign:                                                        | UUID of the project associated with this dataset                          |
+| `name`                                                                    | *string*                                                                  | :heavy_minus_sign:                                                        | Name of the dataset                                                       |
+| `description`                                                             | *string*                                                                  | :heavy_minus_sign:                                                        | A description for the dataset                                             |
+| `type`                                                                    | [components.DatasetType](../../models/components/datasettype.md)          | :heavy_minus_sign:                                                        | What the dataset is to be used for - "evaluation" or "fine-tuning"        |
+| `datapoints`                                                              | *string*[]                                                                | :heavy_minus_sign:                                                        | List of unique datapoint ids to be included in this dataset               |
+| `numPoints`                                                               | *number*                                                                  | :heavy_minus_sign:                                                        | Number of datapoints included in the dataset                              |
+| `linkedEvals`                                                             | *string*[]                                                                | :heavy_minus_sign:                                                        | N/A                                                                       |
+| `saved`                                                                   | *boolean*                                                                 | :heavy_minus_sign:                                                        | Whether the dataset has been saved or detected                            |
+| `pipelineType`                                                            | [components.PipelineType](../../models/components/pipelinetype.md)        | :heavy_minus_sign:                                                        | The type of data included in the dataset - "event" (default) or "session" |
+| `createdAt`                                                               | *string*                                                                  | :heavy_minus_sign:                                                        | Timestamp of when the dataset was created                                 |
+| `updatedAt`                                                               | *string*                                                                  | :heavy_minus_sign:                                                        | Timestamp of when the dataset was last updated                            |

package/docs/models/components/datasettype.md

@@ -0,0 +1,17 @@
+# DatasetType
+
+What the dataset is to be used for - "evaluation" or "fine-tuning"
+
+## Example Usage
+
+```typescript
+import { DatasetType } from "honeyhive/models/components";
+
+let value: DatasetType = "evaluation";
+```
+
+## Values
+
+```typescript
+"evaluation" | "fine-tuning"
+```

package/docs/models/components/datasetupdate.md

@@ -0,0 +1,34 @@
+# DatasetUpdate
+
+## Example Usage
+
+```typescript
+import { DatasetUpdate } from "honeyhive/models/components";
+
+let value: DatasetUpdate = {
+  datasetId: "663876ec4611c47f4970f0c3",
+  name: "new-dataset-name",
+  description: "An updated dataset description",
+  datapoints: [
+    "66369748b5773befbdc661e",
+  ],
+  linkedEvals: [
+    "66369748b5773befbdasdk1",
+  ],
+  metadata: {
+    "updated": true,
+    "source": "prod",
+  },
+};
+```
+
+## Fields
+
+| Field                                                                        | Type                                                                         | Required                                                                     | Description                                                                  |
+| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| `datasetId`                                                                  | *string*                                                                     | :heavy_check_mark:                                                           | The unique identifier of the dataset being updated                           |
+| `name`                                                                       | *string*                                                                     | :heavy_minus_sign:                                                           | Updated name for the dataset                                                 |
+| `description`                                                                | *string*                                                                     | :heavy_minus_sign:                                                           | Updated description for the dataset                                          |
+| `datapoints`                                                                 | *string*[]                                                                   | :heavy_minus_sign:                                                           | Updated list of datapoint ids for the dataset - note the full list is needed |
+| `linkedEvals`                                                                | *string*[]                                                                   | :heavy_minus_sign:                                                           | Updated list of unique evaluation run ids to be associated with this dataset |
+| `metadata`                                                                   | Record<string, *any*>                                                        | :heavy_minus_sign:                                                           | Updated metadata to track for the dataset                                    |

package/docs/models/components/deleterunresponse.md

@@ -0,0 +1,16 @@
+# DeleteRunResponse
+
+## Example Usage
+
+```typescript
+import { DeleteRunResponse } from "honeyhive/models/components";
+
+let value: DeleteRunResponse = {};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `id`               | *string*           | :heavy_minus_sign: | N/A                |
+| `deleted`          | *boolean*          | :heavy_minus_sign: | N/A                |

package/docs/models/components/details.md

@@ -0,0 +1,21 @@
+# Details
+
+## Example Usage
+
+```typescript
+import { Details } from "honeyhive/models/components";
+
+let value: Details = {};
+```
+
+## Fields
+
+| Field                                                                                                          | Type                                                                                                           | Required                                                                                                       | Description                                                                                                    |
+| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
+| `metricName`                                                                                                   | *string*                                                                                                       | :heavy_minus_sign:                                                                                             | N/A                                                                                                            |
+| `metricType`                                                                                                   | *string*                                                                                                       | :heavy_minus_sign:                                                                                             | N/A                                                                                                            |
+| `eventName`                                                                                                    | *string*                                                                                                       | :heavy_minus_sign:                                                                                             | N/A                                                                                                            |
+| `eventType`                                                                                                    | *string*                                                                                                       | :heavy_minus_sign:                                                                                             | N/A                                                                                                            |
+| `aggregate`                                                                                                    | *number*                                                                                                       | :heavy_minus_sign:                                                                                             | N/A                                                                                                            |
+| `values`                                                                                                       | *components.Values*[]                                                                                          | :heavy_minus_sign:                                                                                             | N/A                                                                                                            |
+| `datapoints`                                                                                                   | [components.ExperimentResultResponseDatapoints](../../models/components/experimentresultresponsedatapoints.md) | :heavy_minus_sign:                                                                                             | N/A                                                                                                            |

package/docs/models/components/env.md

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

package/docs/models/components/evaluationrun.md

@@ -0,0 +1,25 @@
+# EvaluationRun
+
+## Example Usage
+
+```typescript
+import { EvaluationRun } from "honeyhive/models/components";
+
+let value: EvaluationRun = {};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `runId`                                                                                       | *string*                                                                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `project`                                                                                     | *string*                                                                                      | :heavy_minus_sign:                                                                            | The UUID of the project this run is associated with                                           |
+| `createdAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | The date and time the run was created                                                         |
+| `eventIds`                                                                                    | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | The UUIDs of the sessions/events this run is associated with                                  |
+| `datasetId`                                                                                   | *string*                                                                                      | :heavy_minus_sign:                                                                            | The UUID of the dataset this run is associated with                                           |
+| `datapointIds`                                                                                | *string*[]                                                                                    | :heavy_minus_sign:                                                                            | The UUIDs of the datapoints from the original dataset this run is associated with             |
+| `results`                                                                                     | [components.Results](../../models/components/results.md)                                      | :heavy_minus_sign:                                                                            | The results of the evaluation (including pass/fails and metric aggregations)                  |
+| `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                                                               |
+| `status`                                                                                      | [components.EvaluationRunStatus](../../models/components/evaluationrunstatus.md)              | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `name`                                                                                        | *string*                                                                                      | :heavy_minus_sign:                                                                            | The name of the run to be displayed                                                           |

package/docs/models/components/evaluationrunstatus.md

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

package/docs/models/components/evaluators.md

@@ -0,0 +1,14 @@
+# Evaluators
+
+## Example Usage
+
+```typescript
+import { Evaluators } from "honeyhive/models/components";
+
+let value: Evaluators = {};
+```
+
+## Fields
+
+| Field       | Type        | Required    | Description |
+| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/event.md

@@ -0,0 +1,114 @@
+# Event
+
+## Example Usage
+
+```typescript
+import { Event } from "honeyhive/models/components";
+
+let value: Event = {
+  projectId: "New Project",
+  source: "playground",
+  eventName: "Model Completion",
+  eventType: "model",
+  eventId: "7f22137a-6911-4ed3-bc36-110f1dde6b66",
+  sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
+  parentId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
+  childrenIds: [
+    "<value>",
+  ],
+  config: {
+    "model": "gpt-3.5-turbo",
+    "version": "v0.1 - Fork",
+    "provider": "openai",
+    "hyperparameters": {
+      "temperature": 0,
+      "top_p": 1,
+      "max_tokens": 1000,
+      "presence_penalty": 0,
+      "frequency_penalty": 0,
+      "stop": [
+        "<value>",
+      ],
+      "n": 1,
+    },
+    "template": [
+      {
+        "role": "system",
+        "content": "Answer the user's question only using provided context.\n" +
+        "\n" +
+        "Context: {{ context }}",
+      },
+      {
+        "role": "user",
+        "content": "{{question}}",
+      },
+    ],
+    "type": "chat",
+  },
+  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,
+  startTime: 2024-04-01 22:38:19,
+  endTime: 2024-04-01 22:38:19,
+  duration: 824.8056,
+  metadata: {
+    "cost": 0.00008,
+    "completion_tokens": 23,
+    "prompt_tokens": 35,
+    "total_tokens": 58,
+  },
+  feedback: {
+
+  },
+  metrics: {
+    "Answer Faithfulness": 5,
+    "Answer Faithfulness_explanation": "The AI assistant's answer is a concise and accurate description of Ramp's API. It provides a clear explanation of what the API does and how developers can use it to integrate Ramp's financial services into their own applications. The answer is faithful to the provided context.",
+    "Number of words": 18,
+  },
+  userProperties: {
+    "user": "google-oauth2|111840237613341303366",
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                     | Type                                                                                      | Required                                                                                  | Description                                                                               |
+| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
+| `projectId`                                                                               | *string*                                                                                  | :heavy_minus_sign:                                                                        | Name of project associated with the event                                                 |
+| `source`                                                                                  | *string*                                                                                  | :heavy_minus_sign:                                                                        | Source of the event - production, staging, etc                                            |
+| `eventName`                                                                               | *string*                                                                                  | :heavy_minus_sign:                                                                        | Name of the event                                                                         |
+| `eventType`                                                                               | [components.EventType](../../models/components/eventtype.md)                              | :heavy_minus_sign:                                                                        | Specify whether the event is of "session", "model", "tool" or "chain" type                |
+| `eventId`                                                                                 | *string*                                                                                  | :heavy_minus_sign:                                                                        | Unique id of the event, if not set, it will be auto-generated                             |
+| `sessionId`                                                                               | *string*                                                                                  | :heavy_minus_sign:                                                                        | Unique id of the session associated with the event, if not set, it will be auto-generated |
+| `parentId`                                                                                | *string*                                                                                  | :heavy_minus_sign:                                                                        | Id of the parent event if nested                                                          |
+| `childrenIds`                                                                             | *string*[]                                                                                | :heavy_minus_sign:                                                                        | Id of events that are nested within the event                                             |
+| `config`                                                                                  | Record<string, *any*>                                                                     | :heavy_minus_sign:                                                                        | Associated configuration JSON for the event - model name, vector index name, etc          |
+| `inputs`                                                                                  | Record<string, *any*>                                                                     | :heavy_minus_sign:                                                                        | Input JSON given to the event - prompt, chunks, etc                                       |
+| `outputs`                                                                                 | Record<string, *any*>                                                                     | :heavy_minus_sign:                                                                        | Final output JSON of the event                                                            |
+| `error`                                                                                   | *string*                                                                                  | :heavy_minus_sign:                                                                        | Any error description if event failed                                                     |
+| `startTime`                                                                               | *number*                                                                                  | :heavy_minus_sign:                                                                        | UTC timestamp (in milliseconds) for the event start                                       |
+| `endTime`                                                                                 | *number*                                                                                  | :heavy_minus_sign:                                                                        | UTC timestamp (in milliseconds) for the event end                                         |
+| `duration`                                                                                | *number*                                                                                  | :heavy_minus_sign:                                                                        | How long the event took in milliseconds                                                   |
+| `metadata`                                                                                | Record<string, *any*>                                                                     | :heavy_minus_sign:                                                                        | Any system or application metadata associated with the event                              |
+| `feedback`                                                                                | Record<string, *any*>                                                                     | :heavy_minus_sign:                                                                        | Any user feedback provided for the event output                                           |
+| `metrics`                                                                                 | Record<string, *any*>                                                                     | :heavy_minus_sign:                                                                        | Any values computed over the output of the event                                          |
+| `userProperties`                                                                          | Record<string, *any*>                                                                     | :heavy_minus_sign:                                                                        | Any user properties associated with the event                                             |

package/docs/models/components/eventdetails.md

@@ -0,0 +1,17 @@
+# EventDetails
+
+## Example Usage
+
+```typescript
+import { EventDetails } from "honeyhive/models/components";
+
+let value: EventDetails = {};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `eventName`        | *string*           | :heavy_minus_sign: | N/A                |
+| `eventType`        | *string*           | :heavy_minus_sign: | N/A                |
+| `presence`         | *string*           | :heavy_minus_sign: | N/A                |

package/docs/models/components/eventfilter.md

@@ -0,0 +1,23 @@
+# EventFilter
+
+## Example Usage
+
+```typescript
+import { EventFilter } from "honeyhive/models/components";
+
+let value: EventFilter = {
+  field: "event_type",
+  value: "model",
+  operator: "is",
+  type: "string",
+};
+```
+
+## Fields
+
+| Field                                                                                              | Type                                                                                               | Required                                                                                           | Description                                                                                        |
+| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| `field`                                                                                            | *string*                                                                                           | :heavy_minus_sign:                                                                                 | The field name that you are filtering by like `metadata.cost`, `inputs.chat_history.0.content`     |
+| `value`                                                                                            | *string*                                                                                           | :heavy_minus_sign:                                                                                 | The value that you are filtering the field for                                                     |
+| `operator`                                                                                         | [components.Operator](../../models/components/operator.md)                                         | :heavy_minus_sign:                                                                                 | The type of filter you are performing - "is", "is not", "contains", "not contains", "greater than" |
+| `type`                                                                                             | [components.Type](../../models/components/type.md)                                                 | :heavy_minus_sign:                                                                                 | The data type you are using - "string", "number", "boolean", "id" (for object ids)                 |

package/docs/models/components/eventtype.md

@@ -0,0 +1,17 @@
+# EventType
+
+Specify whether the event is of "session", "model", "tool" or "chain" type
+
+## Example Usage
+
+```typescript
+import { EventType } from "honeyhive/models/components";
+
+let value: EventType = "model";
+```
+
+## Values
+
+```typescript
+"session" | "model" | "tool" | "chain"
+```

package/docs/models/components/experimentcomparisonresponse.md

@@ -0,0 +1,19 @@
+# ExperimentComparisonResponse
+
+## Example Usage
+
+```typescript
+import { ExperimentComparisonResponse } from "honeyhive/models/components";
+
+let value: ExperimentComparisonResponse = {};
+```
+
+## Fields
+
+| Field                                                                                                              | Type                                                                                                               | Required                                                                                                           | Description                                                                                                        |
+| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
+| `metrics`                                                                                                          | [components.ExperimentComparisonResponseMetrics](../../models/components/experimentcomparisonresponsemetrics.md)[] | :heavy_minus_sign:                                                                                                 | N/A                                                                                                                |
+| `commonDatapoints`                                                                                                 | *string*[]                                                                                                         | :heavy_minus_sign:                                                                                                 | N/A                                                                                                                |
+| `eventDetails`                                                                                                     | [components.EventDetails](../../models/components/eventdetails.md)[]                                               | :heavy_minus_sign:                                                                                                 | N/A                                                                                                                |
+| `oldRun`                                                                                                           | [components.OldRun](../../models/components/oldrun.md)                                                             | :heavy_minus_sign:                                                                                                 | N/A                                                                                                                |
+| `newRun`                                                                                                           | [components.NewRun](../../models/components/newrun.md)                                                             | :heavy_minus_sign:                                                                                                 | N/A                                                                                                                |

package/docs/models/components/experimentcomparisonresponseconfiguration.md

@@ -0,0 +1,14 @@
+# ExperimentComparisonResponseConfiguration
+
+## Example Usage
+
+```typescript
+import { ExperimentComparisonResponseConfiguration } from "honeyhive/models/components";
+
+let value: ExperimentComparisonResponseConfiguration = {};
+```
+
+## Fields
+
+| Field       | Type        | Required    | Description |
+| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/experimentcomparisonresponseevaluators.md

@@ -0,0 +1,14 @@
+# ExperimentComparisonResponseEvaluators
+
+## Example Usage
+
+```typescript
+import { ExperimentComparisonResponseEvaluators } from "honeyhive/models/components";
+
+let value: ExperimentComparisonResponseEvaluators = {};
+```
+
+## Fields
+
+| Field       | Type        | Required    | Description |
+| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/experimentcomparisonresponsemetadata.md

@@ -0,0 +1,14 @@
+# ExperimentComparisonResponseMetadata
+
+## Example Usage
+
+```typescript
+import { ExperimentComparisonResponseMetadata } from "honeyhive/models/components";
+
+let value: ExperimentComparisonResponseMetadata = {};
+```
+
+## Fields
+
+| Field       | Type        | Required    | Description |
+| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/experimentcomparisonresponsemetrics.md

@@ -0,0 +1,29 @@
+# ExperimentComparisonResponseMetrics
+
+## Example Usage
+
+```typescript
+import { ExperimentComparisonResponseMetrics } from "honeyhive/models/components";
+
+let value: ExperimentComparisonResponseMetrics = {};
+```
+
+## Fields
+
+| Field                    | Type                     | Required                 | Description              |
+| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
+| `metricName`             | *string*                 | :heavy_minus_sign:       | N/A                      |
+| `eventName`              | *string*                 | :heavy_minus_sign:       | N/A                      |
+| `metricType`             | *string*                 | :heavy_minus_sign:       | N/A                      |
+| `eventType`              | *string*                 | :heavy_minus_sign:       | N/A                      |
+| `oldAggregate`           | *number*                 | :heavy_minus_sign:       | N/A                      |
+| `newAggregate`           | *number*                 | :heavy_minus_sign:       | N/A                      |
+| `foundCount`             | *number*                 | :heavy_minus_sign:       | N/A                      |
+| `improvedCount`          | *number*                 | :heavy_minus_sign:       | N/A                      |
+| `degradedCount`          | *number*                 | :heavy_minus_sign:       | N/A                      |
+| `sameCount`              | *number*                 | :heavy_minus_sign:       | N/A                      |
+| `improved`               | *string*[]               | :heavy_minus_sign:       | N/A                      |
+| `degraded`               | *string*[]               | :heavy_minus_sign:       | N/A                      |
+| `same`                   | *string*[]               | :heavy_minus_sign:       | N/A                      |
+| `oldValues`              | *components.OldValues*[] | :heavy_minus_sign:       | N/A                      |
+| `newValues`              | *components.NewValues*[] | :heavy_minus_sign:       | N/A                      |