honeyhive 1.0.21 → 1.0.23

package/docs/lib/utils/retryconfig.md

@@ -0,0 +1,24 @@
+# RetryConfig
+
+Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies.
+
+## Fields
+
+| Name                      | Type                                | Description                                                                                | Example     |
+| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
+| `strategy`                | `"backoff" | "none"`                | The retry strategy to use.                                                                 | `"backoff"` |
+| `backoff`                 | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters.                  |             |
+| `retryConnectionErrors`   | `*boolean*`                         | When strategy is "backoff", this determines whether or not to retry on connection errors.  | `true`      |
+
+## BackoffStrategy
+
+The backoff strategy allows retrying a request with an exponential backoff between each retry.
+
+### Fields
+
+| Name               | Type         | Description                               | Example  |
+| ------------------ | ------------ | ----------------------------------------- | -------- |
+| `initialInterval`  | `*number*`   | The initial interval in milliseconds.     | `500`    |
+| `maxInterval`      | `*number*`   | The maximum interval in milliseconds.     | `60000`  |
+| `exponent`         | `*number*`   | The exponent to use for the backoff.      | `1.5`    |
+| `maxElapsedTime`   | `*number*`   | The maximum elapsed time in milliseconds. | `300000` |

package/docs/models/components/calltype.md

@@ -0,0 +1,17 @@
+# CallType
+
+Type of API calling - "chat" or "completion"
+
+## Example Usage
+
+```typescript
+import { CallType } from "honeyhive/models/components";
+
+let value: CallType = "completion";
+```
+
+## Values
+
+```typescript
+"chat" | "completion"
+```

package/docs/models/components/configuration.md

@@ -0,0 +1,88 @@
+# Configuration
+
+## Example Usage
+
+```typescript
+import { Configuration } from "honeyhive/models/components";
+
+let value: Configuration = {
+  id: "6638187d505c6812e4044f24",
+  project: "New Project",
+  name: "function-v0",
+  env: [
+    "staging",
+  ],
+  provider: "openai",
+  parameters: {
+    callType: "chat",
+    model: "gpt-4-turbo-preview",
+    hyperparameters: {
+      "temperature": 0,
+      "max_tokens": 1000,
+      "top_p": 1,
+      "top_k": -1,
+      "frequency_penalty": 0,
+      "presence_penalty": 0,
+      "stop_sequences": [
+        "<value>",
+      ],
+    },
+    responseFormat: {},
+    selectedFunctions: [
+      {
+        id: "64e3ba90e81f9b3a3808c27f",
+        name: "get_google_information",
+        description: "Get information from Google when you do not have that information in your context",
+        parameters: {
+          "type": "object",
+          "properties": {
+            "query": {
+              "type": "string",
+              "description": "The query asked by the user",
+            },
+          },
+          "required": [
+            "query",
+          ],
+        },
+      },
+    ],
+    functionCallParams: "auto",
+    forceFunction: {
+
+    },
+    additionalProperties: {
+      "template": [
+        {
+          "role": "system",
+          "content": "You are a web search assistant.",
+        },
+        {
+          "role": "user",
+          "content": "{{ query }}",
+        },
+      ],
+    },
+  },
+  type: "LLM",
+  userProperties: {
+    "user_id": "google-oauth2|108897808434934946583",
+    "user_name": "Dhruv Singh",
+    "user_picture": "https://lh3.googleusercontent.com/a/ACg8ocLyQilNtK9RIv4M0p-0FBSbxljBP0p5JabnStku1AQKtFSK=s96-c",
+    "user_email": "dhruv@honeyhive.ai",
+  },
+};
+```
+
+## Fields
+
+| Field                                                                        | Type                                                                         | Required                                                                     | Description                                                                  |
+| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| `id`                                                                         | *string*                                                                     | :heavy_minus_sign:                                                           | ID of the configuration                                                      |
+| `project`                                                                    | *string*                                                                     | :heavy_check_mark:                                                           | ID of the project to which this configuration belongs                        |
+| `name`                                                                       | *string*                                                                     | :heavy_check_mark:                                                           | Name of the configuration                                                    |
+| `env`                                                                        | [components.Env](../../models/components/env.md)[]                           | :heavy_minus_sign:                                                           | List of environments where the configuration is active                       |
+| `provider`                                                                   | *string*                                                                     | :heavy_check_mark:                                                           | Name of the provider - "openai", "anthropic", etc.                           |
+| `parameters`                                                                 | [components.ParametersT](../../models/components/parameterst.md)             | :heavy_check_mark:                                                           | N/A                                                                          |
+| `type`                                                                       | [components.ConfigurationType](../../models/components/configurationtype.md) | :heavy_minus_sign:                                                           | Type of the configuration - "LLM" or "pipeline" - "LLM" by default           |
+| `userProperties`                                                             | Record<string, *any*>                                                        | :heavy_minus_sign:                                                           | Details of user who created the configuration                                |

package/docs/models/components/configurationtype.md

@@ -0,0 +1,17 @@
+# ConfigurationType
+
+Type of the configuration - "LLM" or "pipeline" - "LLM" by default
+
+## Example Usage
+
+```typescript
+import { ConfigurationType } from "honeyhive/models/components";
+
+let value: ConfigurationType = "LLM";
+```
+
+## Values
+
+```typescript
+"LLM" | "pipeline"
+```

package/docs/models/components/createdatapointrequest.md

@@ -0,0 +1,53 @@
+# CreateDatapointRequest
+
+## Example Usage
+
+```typescript
+import { CreateDatapointRequest } from "honeyhive/models/components";
+
+let value: CreateDatapointRequest = {
+  project: "New Project",
+  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",
+  linkedDatasets: [
+    "<value>",
+  ],
+  metadata: {
+    "question_type": "weather",
+    "completion_tokens": 47,
+    "prompt_tokens": 696,
+    "total_tokens": 743,
+  },
+};
+```
+
+## Fields
+
+| Field                                                         | Type                                                          | Required                                                      | Description                                                   |
+| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
+| `project`                                                     | *string*                                                      | :heavy_check_mark:                                            | Name for the project to which the datapoint belongs           |
+| `inputs`                                                      | Record<string, *any*>                                         | :heavy_check_mark:                                            | 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                 |
+| `linkedEvent`                                                 | *string*                                                      | :heavy_minus_sign:                                            | Event id for the event from which the datapoint was created   |
+| `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/createdatasetrequest.md

@@ -0,0 +1,39 @@
+# CreateDatasetRequest
+
+## Example Usage
+
+```typescript
+import { CreateDatasetRequest } from "honeyhive/models/components";
+
+let value: CreateDatasetRequest = {
+  project: "New Project",
+  name: "test-dataset",
+  description: "A test dataset",
+  type: "evaluation",
+  datapoints: [
+    "66369748b5773befbdc661e2",
+  ],
+  linkedEvals: [
+    "<value>",
+  ],
+  saved: false,
+  pipelineType: "event",
+  metadata: {
+    "source": "dev",
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                                      | Type                                                                                                       | Required                                                                                                   | Description                                                                                                |
+| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `project`                                                                                                  | *string*                                                                                                   | :heavy_check_mark:                                                                                         | Name of the project associated with this dataset like `New Project`                                        |
+| `name`                                                                                                     | *string*                                                                                                   | :heavy_check_mark:                                                                                         | Name of the dataset                                                                                        |
+| `description`                                                                                              | *string*                                                                                                   | :heavy_minus_sign:                                                                                         | A description for the dataset                                                                              |
+| `type`                                                                                                     | [components.CreateDatasetRequestType](../../models/components/createdatasetrequesttype.md)                 | :heavy_minus_sign:                                                                                         | What the dataset is to be used for - "evaluation" (default) or "fine-tuning"                               |
+| `datapoints`                                                                                               | *string*[]                                                                                                 | :heavy_minus_sign:                                                                                         | List of unique datapoint ids to be included in this dataset                                                |
+| `linkedEvals`                                                                                              | *string*[]                                                                                                 | :heavy_minus_sign:                                                                                         | List of unique evaluation run ids to be associated with this dataset                                       |
+| `saved`                                                                                                    | *boolean*                                                                                                  | :heavy_minus_sign:                                                                                         | N/A                                                                                                        |
+| `pipelineType`                                                                                             | [components.CreateDatasetRequestPipelineType](../../models/components/createdatasetrequestpipelinetype.md) | :heavy_minus_sign:                                                                                         | The type of data included in the dataset - "event" (default) or "session"                                  |
+| `metadata`                                                                                                 | Record<string, *any*>                                                                                      | :heavy_minus_sign:                                                                                         | Any helpful metadata to track for the dataset                                                              |

package/docs/models/components/createdatasetrequestpipelinetype.md

@@ -0,0 +1,17 @@
+# CreateDatasetRequestPipelineType
+
+The type of data included in the dataset - "event" (default) or "session"
+
+## Example Usage
+
+```typescript
+import { CreateDatasetRequestPipelineType } from "honeyhive/models/components";
+
+let value: CreateDatasetRequestPipelineType = "session";
+```
+
+## Values
+
+```typescript
+"event" | "session"
+```

package/docs/models/components/createdatasetrequesttype.md

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

package/docs/models/components/createeventrequest.md

@@ -0,0 +1,114 @@
+# CreateEventRequest
+
+## Example Usage
+
+```typescript
+import { CreateEventRequest } from "honeyhive/models/components";
+
+let value: CreateEventRequest = {
+  project: "Simple RAG",
+  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",
+    "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: 1714978764301,
+  endTime: 1714978765301,
+  duration: 999.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                                                                                      |
+| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
+| `project`                                                                                        | *string*                                                                                         | :heavy_check_mark:                                                                               | Project associated with the event                                                                |
+| `source`                                                                                         | *string*                                                                                         | :heavy_check_mark:                                                                               | Source of the event - production, staging, etc                                                   |
+| `eventName`                                                                                      | *string*                                                                                         | :heavy_check_mark:                                                                               | Name of the event                                                                                |
+| `eventType`                                                                                      | [components.CreateEventRequestEventType](../../models/components/createeventrequesteventtype.md) | :heavy_check_mark:                                                                               | Specify whether the event is of "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_check_mark:                                                                               | Associated configuration JSON for the event - model name, vector index name, etc                 |
+| `inputs`                                                                                         | Record<string, *any*>                                                                            | :heavy_check_mark:                                                                               | 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_check_mark:                                                                               | 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/createeventrequesteventtype.md

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

package/docs/models/components/createmodelevent.md

@@ -0,0 +1,109 @@
+# CreateModelEvent
+
+## Example Usage
+
+```typescript
+import { CreateModelEvent } from "honeyhive/models/components";
+
+let value: CreateModelEvent = {
+  project: "New Project",
+  model: "gpt-4o",
+  provider: "openai",
+  messages: [
+    {
+      "role": "system",
+      "content": "Hello, world!",
+    },
+  ],
+  response: {
+    "role": "assistant",
+    "content": "Hello, world!",
+  },
+  duration: 42,
+  usage: {
+    "prompt_tokens": 10,
+    "completion_tokens": 10,
+    "total_tokens": 20,
+  },
+  cost: 0.00008,
+  error: null,
+  source: "playground",
+  eventName: "Model Completion",
+  hyperparameters: {
+    "temperature": 0,
+    "top_p": 1,
+    "max_tokens": 1000,
+    "presence_penalty": 0,
+    "frequency_penalty": 0,
+    "stop": [
+      "<value>",
+    ],
+    "n": 1,
+  },
+  template: [
+    {
+      "role": "system",
+      "content": "Hello, {{ name }}!",
+    },
+  ],
+  templateInputs: {
+    "name": "world",
+  },
+  tools: [
+    {
+      "type": "function",
+      "function": {
+        "name": "get_current_weather",
+        "description": "Get the current weather",
+        "parameters": {
+          "type": "object",
+          "properties": {
+            "location": {
+              "type": "string",
+              "description": "The city and state, e.g. San Francisco, CA",
+            },
+            "format": {
+              "type": "string",
+              "enum": [
+                "celsius",
+                "fahrenheit",
+              ],
+              "description": "The temperature unit to use. Infer this from the users location.",
+            },
+          },
+          "required": [
+            "location",
+            "format",
+          ],
+        },
+      },
+    },
+  ],
+  toolChoice: "none",
+  responseFormat: {
+    "type": "text",
+  },
+};
+```
+
+## Fields
+
+| Field                                          | Type                                           | Required                                       | Description                                    |
+| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
+| `project`                                      | *string*                                       | :heavy_check_mark:                             | Project associated with the event              |
+| `model`                                        | *string*                                       | :heavy_check_mark:                             | Model name                                     |
+| `provider`                                     | *string*                                       | :heavy_check_mark:                             | Model provider                                 |
+| `messages`                                     | Record<string, *any*>[]                        | :heavy_check_mark:                             | Messages passed to the model                   |
+| `response`                                     | Record<string, *any*>                          | :heavy_check_mark:                             | Final output JSON of the event                 |
+| `duration`                                     | *number*                                       | :heavy_check_mark:                             | How long the event took in milliseconds        |
+| `usage`                                        | Record<string, *any*>                          | :heavy_check_mark:                             | Usage statistics of the model                  |
+| `cost`                                         | *number*                                       | :heavy_minus_sign:                             | Cost of the model completion                   |
+| `error`                                        | *string*                                       | :heavy_minus_sign:                             | Any error description if event failed          |
+| `source`                                       | *string*                                       | :heavy_minus_sign:                             | Source of the event - production, staging, etc |
+| `eventName`                                    | *string*                                       | :heavy_minus_sign:                             | Name of the event                              |
+| `hyperparameters`                              | Record<string, *any*>                          | :heavy_minus_sign:                             | Hyperparameters used for the model             |
+| `template`                                     | Record<string, *any*>[]                        | :heavy_minus_sign:                             | Template used for the model                    |
+| `templateInputs`                               | Record<string, *any*>                          | :heavy_minus_sign:                             | Inputs for the template                        |
+| `tools`                                        | Record<string, *any*>[]                        | :heavy_minus_sign:                             | Tools used for the model                       |
+| `toolChoice`                                   | *string*                                       | :heavy_minus_sign:                             | Tool choice for the model                      |
+| `responseFormat`                               | Record<string, *any*>                          | :heavy_minus_sign:                             | Response format for the model                  |

package/docs/models/components/createprojectrequest.md

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

package/docs/models/components/createrunrequest.md

@@ -0,0 +1,28 @@
+# CreateRunRequest
+
+## Example Usage
+
+```typescript
+import { CreateRunRequest } from "honeyhive/models/components";
+
+let value: CreateRunRequest = {
+  project: "<value>",
+  name: "<value>",
+  eventIds: [
+    "904a4962-4999-4aa6-be56-ecb1ebf2d291",
+  ],
+};
+```
+
+## Fields
+
+| Field                                                                             | Type                                                                              | Required                                                                          | Description                                                                       |
+| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
+| `project`                                                                         | *string*                                                                          | :heavy_check_mark:                                                                | The UUID of the project this run is associated with                               |
+| `name`                                                                            | *string*                                                                          | :heavy_check_mark:                                                                | The name of the run to be displayed                                               |
+| `eventIds`                                                                        | *string*[]                                                                        | :heavy_check_mark:                                                                | 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 |
+| `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.Status](../../models/components/status.md)                            | :heavy_minus_sign:                                                                | The status of the run                                                             |

package/docs/models/components/createrunresponse.md

@@ -0,0 +1,16 @@
+# CreateRunResponse
+
+## Example Usage
+
+```typescript
+import { CreateRunResponse } from "honeyhive/models/components";
+
+let value: CreateRunResponse = {};
+```
+
+## Fields
+
+| Field                                                                | Type                                                                 | Required                                                             | Description                                                          |
+| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
+| `evaluation`                                                         | [components.EvaluationRun](../../models/components/evaluationrun.md) | :heavy_minus_sign:                                                   | N/A                                                                  |
+| `runId`                                                              | *string*                                                             | :heavy_minus_sign:                                                   | N/A                                                                  |

package/docs/models/components/createtoolrequest.md

@@ -0,0 +1,26 @@
+# CreateToolRequest
+
+## Example Usage
+
+```typescript
+import { CreateToolRequest } from "honeyhive/models/components";
+
+let value: CreateToolRequest = {
+  task: "<value>",
+  name: "<value>",
+  parameters: {
+    "key": "<value>",
+  },
+  type: "tool",
+};
+```
+
+## Fields
+
+| Field                                                                                | Type                                                                                 | Required                                                                             | Description                                                                          |
+| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
+| `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                              |
+| `type`                                                                               | [components.CreateToolRequestType](../../models/components/createtoolrequesttype.md) | :heavy_check_mark:                                                                   | N/A                                                                                  |