npm - honeyhive - Versions diffs - 0.3.13 → 0.3.14 - Mend

honeyhive 0.3.13 → 0.3.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (195) hide show

package/docs/sdks/tools/README.md CHANGED Viewed

@@ -15,8 +15,8 @@ Delete a tool
 ### Example Usage
 ```typescript
-import { HoneyHive } from "HoneyHive";
-import { DeleteToolRequest } from "HoneyHive/dist/models/operations";
+import { HoneyHive } from "honeyhive";
+import { DeleteToolRequest } from "honeyhive/dist/models/operations";
 async function run() {
   const sdk = new HoneyHive({
@@ -58,14 +58,14 @@ Retrieve a list of tools
 ### Example Usage
 ```typescript
-import { HoneyHive } from "HoneyHive";
-import { GetToolsSecurity } from "HoneyHive/dist/models/operations";
+import { HoneyHive } from "honeyhive";
 async function run() {
-  const sdk = new HoneyHive();
-const operationSecurity: GetToolsSecurity = "<YOUR_BEARER_TOKEN_HERE>";
+  const sdk = new HoneyHive({
+    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+  });
-  const res = await sdk.tools.getTools(operationSecurity);
+  const res = await sdk.tools.getTools();
   if (res.statusCode == 200) {
     // handle response
@@ -77,10 +77,9 @@ run();
 ### Parameters
-| Parameter                                                                  | Type                                                                       | Required                                                                   | Description                                                                |
-| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
-| `security`                                                                 | [operations.GetToolsSecurity](../../models/operations/gettoolssecurity.md) | :heavy_check_mark:                                                         | The security requirements to use for the request.                          |
-| `config`                                                                   | [AxiosRequestConfig](https://axios-http.com/docs/req_config)               | :heavy_minus_sign:                                                         | Available config options for making requests.                              |
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
 ### Response
@@ -99,20 +98,22 @@ Create a new tool
 ### Example Usage
 ```typescript
-import { HoneyHive } from "HoneyHive";
-import { ToolType } from "HoneyHive/dist/models/components";
-import { CreateToolSecurity } from "HoneyHive/dist/models/operations";
+import { HoneyHive } from "honeyhive";
+import { CreateToolRequestType } from "honeyhive/dist/models/components";
 async function run() {
-  const sdk = new HoneyHive();
-const operationSecurity: CreateToolSecurity = "<YOUR_BEARER_TOKEN_HERE>";
+  const sdk = new HoneyHive({
+    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+  });
   const res = await sdk.tools.createTool({
     name: "<value>",
-    parameters: {},
+    parameters: {
+      "key": "<value>",
+    },
     task: "<value>",
-    type: ToolType.Tool,
-  }, operationSecurity);
+    type: CreateToolRequestType.Tool,
+  });
   if (res.statusCode == 200) {
     // handle response
@@ -124,11 +125,10 @@ run();
 ### Parameters
-| Parameter                                                                      | Type                                                                           | Required                                                                       | Description                                                                    |
-| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
-| `request`                                                                      | [components.Tool](../../models/components/tool.md)                             | :heavy_check_mark:                                                             | The request object to use for the request.                                     |
-| `security`                                                                     | [operations.CreateToolSecurity](../../models/operations/createtoolsecurity.md) | :heavy_check_mark:                                                             | The security requirements to use for the request.                              |
-| `config`                                                                       | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                   | :heavy_minus_sign:                                                             | Available config options for making requests.                                  |
+| Parameter                                                                    | Type                                                                         | Required                                                                     | Description                                                                  |
+| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| `request`                                                                    | [components.CreateToolRequest](../../models/components/createtoolrequest.md) | :heavy_check_mark:                                                           | The request object to use for the request.                                   |
+| `config`                                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                 | :heavy_minus_sign:                                                           | Available config options for making requests.                                |
 ### Response
@@ -147,17 +147,20 @@ Update an existing tool
 ### Example Usage
 ```typescript
-import { HoneyHive } from "HoneyHive";
-import { UpdateToolSecurity } from "HoneyHive/dist/models/operations";
+import { HoneyHive } from "honeyhive";
 async function run() {
-  const sdk = new HoneyHive();
-const operationSecurity: UpdateToolSecurity = "<YOUR_BEARER_TOKEN_HERE>";
+  const sdk = new HoneyHive({
+    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+  });
   const res = await sdk.tools.updateTool({
     id: "<id>",
-    parameters: {},
-  }, operationSecurity);
+    name: "<value>",
+    parameters: {
+      "key": "<value>",
+    },
+  });
   if (res.statusCode == 200) {
     // handle response
@@ -169,11 +172,10 @@ run();
 ### Parameters
-| Parameter                                                                      | Type                                                                           | Required                                                                       | Description                                                                    |
-| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
-| `request`                                                                      | [components.ToolUpdate](../../models/components/toolupdate.md)                 | :heavy_check_mark:                                                             | The request object to use for the request.                                     |
-| `security`                                                                     | [operations.UpdateToolSecurity](../../models/operations/updatetoolsecurity.md) | :heavy_check_mark:                                                             | The security requirements to use for the request.                              |
-| `config`                                                                       | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                   | :heavy_minus_sign:                                                             | Available config options for making requests.                                  |
+| Parameter                                                                    | Type                                                                         | Required                                                                     | Description                                                                  |
+| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| `request`                                                                    | [components.UpdateToolRequest](../../models/components/updatetoolrequest.md) | :heavy_check_mark:                                                           | The request object to use for the request.                                   |
+| `config`                                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                 | :heavy_minus_sign:                                                           | Available config options for making requests.                                |
 ### Response

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "honeyhive",
-  "version": "0.3.13",
+  "version": "0.3.14",
   "author": "HoneyHive",
   "scripts": {
     "prepare": "tsc --build",

package/docs/models/components/calltype.md DELETED Viewed

@@ -1,11 +0,0 @@
-# CallType
-Type of API calling - "chat" or "completion"
-## Values
-| Name         | Value        |
-| ------------ | ------------ |
-| `Chat`       | chat         |
-| `Completion` | completion   |

package/docs/models/components/config.md DELETED Viewed

@@ -1,9 +0,0 @@
-# Config
-Associated configuration JSON for the event - model name, vector index name, etc
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/createdatapointrequestinputs.md DELETED Viewed

@@ -1,9 +0,0 @@
-# CreateDatapointRequestInputs
-Arbitrary JSON object containing the inputs for the datapoint
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/createdatapointrequestmetadata.md DELETED Viewed

@@ -1,9 +0,0 @@
-# CreateDatapointRequestMetadata
-Any additional metadata for the datapoint
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/createdatasetrequestmetadata.md DELETED Viewed

@@ -1,9 +0,0 @@
-# CreateDatasetRequestMetadata
-Any helpful metadata to track for the dataset
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/createeventrequestinputs.md DELETED Viewed

@@ -1,9 +0,0 @@
-# CreateEventRequestInputs
-Input JSON given to the event - prompt, chunks, etc
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/createeventrequestmetadata.md DELETED Viewed

@@ -1,9 +0,0 @@
-# CreateEventRequestMetadata
-Any system or application metadata associated with the event
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/createeventrequestuserproperties.md DELETED Viewed

@@ -1,9 +0,0 @@
-# CreateEventRequestUserProperties
-Any user properties associated with the event
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/createprojectrequesttype.md DELETED Viewed

@@ -1,9 +0,0 @@
-# CreateProjectRequestType
-## Values
-| Name          | Value         |
-| ------------- | ------------- |
-| `Completions` | completions   |
-| `Chat`        | chat          |

package/docs/models/components/datasetupdatemetadata.md DELETED Viewed

@@ -1,9 +0,0 @@
-# DatasetUpdateMetadata
-Updated metadata to track for the dataset
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/eventconfig.md DELETED Viewed

@@ -1,9 +0,0 @@
-# EventConfig
-Associated configuration for the event - model, provider, etc
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/eventfeedback.md DELETED Viewed

@@ -1,9 +0,0 @@
-# EventFeedback
-Any user feedback provided for the event output
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/eventinputs.md DELETED Viewed

@@ -1,9 +0,0 @@
-# EventInputs
-Input object passed to the event - user query, text blob, etc
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/eventmetadata.md DELETED Viewed

@@ -1,9 +0,0 @@
-# EventMetadata
-Any system or application metadata associated with the event
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/eventmetrics.md DELETED Viewed

@@ -1,9 +0,0 @@
-# EventMetrics
-Any values computed over the output of the event
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/eventoutputs.md DELETED Viewed

@@ -1,9 +0,0 @@
-# EventOutputs
-Final output of the event - completion, chunks, etc
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/eventuserproperties.md DELETED Viewed

@@ -1,9 +0,0 @@
-# EventUserProperties
-Any user properties associated with the event
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/feedback.md DELETED Viewed

@@ -1,9 +0,0 @@
-# Feedback
-Any user feedback provided for the event output
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/functioncallparams.md DELETED Viewed

@@ -1,12 +0,0 @@
-# FunctionCallParams
-Function calling mode - "none", "auto" or "force"
-## Values
-| Name    | Value   |
-| ------- | ------- |
-| `None`  | none    |
-| `Auto`  | auto    |
-| `Force` | force   |

package/docs/models/components/hyperparameters.md DELETED Viewed

@@ -1,9 +0,0 @@
-# Hyperparameters
-Model-specific hyperparameters
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/metadata.md DELETED Viewed

@@ -1,7 +0,0 @@
-# Metadata
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/metrics.md DELETED Viewed

@@ -1,9 +0,0 @@
-# Metrics
-Any values computed over the output of the event
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/outputs.md DELETED Viewed

@@ -1,9 +0,0 @@
-# Outputs
-Final output JSON of the event
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/parameterst.md DELETED Viewed

@@ -1,13 +0,0 @@
-# ParametersT
-## Fields
-| Field                                                                                | Type                                                                                 | Required                                                                             | Description                                                                          |
-| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
-| `callType`                                                                           | [components.CallType](../../models/components/calltype.md)                           | :heavy_check_mark:                                                                   | Type of API calling - "chat" or "completion"                                         |
-| `model`                                                                              | *string*                                                                             | :heavy_check_mark:                                                                   | Model unique name                                                                    |
-| `hyperparameters`                                                                    | [components.Hyperparameters](../../models/components/hyperparameters.md)             | :heavy_minus_sign:                                                                   | Model-specific hyperparameters                                                       |
-| `selectedFunctions`                                                                  | [components.SelectedFunctions](../../models/components/selectedfunctions.md)[]       | :heavy_minus_sign:                                                                   | List of functions to be called by the model, refer to OpenAI schema for more details |
-| `functionCallParams`                                                                 | [components.FunctionCallParams](../../models/components/functioncallparams.md)       | :heavy_minus_sign:                                                                   | Function calling mode - "none", "auto" or "force"                                    |
-| `forceFunction`                                                                      | Record<string, *any*>                                                                | :heavy_minus_sign:                                                                   | Force function-specific parameters                                                   |

package/docs/models/components/projecttype.md DELETED Viewed

@@ -1,9 +0,0 @@
-# ProjectType
-## Values
-| Name          | Value         |
-| ------------- | ------------- |
-| `Completions` | completions   |
-| `Chat`        | chat          |

package/docs/models/components/selectedfunctions.md DELETED Viewed

@@ -1,11 +0,0 @@
-# SelectedFunctions
-## Fields
-| Field                       | Type                        | Required                    | Description                 |
-| --------------------------- | --------------------------- | --------------------------- | --------------------------- |
-| `id`                        | *string*                    | :heavy_minus_sign:          | UUID of the function        |
-| `name`                      | *string*                    | :heavy_minus_sign:          | Name of the function        |
-| `description`               | *string*                    | :heavy_minus_sign:          | Description of the function |
-| `parameters`                | Record<string, *any*>       | :heavy_minus_sign:          | Parameters for the function |

package/docs/models/components/sessionstartrequestconfig.md DELETED Viewed

@@ -1,9 +0,0 @@
-# SessionStartRequestConfig
-Associated configuration for the session
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/sessionstartrequestfeedback.md DELETED Viewed

@@ -1,9 +0,0 @@
-# SessionStartRequestFeedback
-Any user feedback provided for the session output
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/sessionstartrequestinputs.md DELETED Viewed

@@ -1,9 +0,0 @@
-# SessionStartRequestInputs
-Input object passed to the session - user query, text blob, etc
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/sessionstartrequestmetadata.md DELETED Viewed

@@ -1,9 +0,0 @@
-# SessionStartRequestMetadata
-Any system or application metadata associated with the session
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/sessionstartrequestmetrics.md DELETED Viewed

@@ -1,9 +0,0 @@
-# SessionStartRequestMetrics
-Any values computed over the output of the session
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/sessionstartrequestoutputs.md DELETED Viewed

@@ -1,9 +0,0 @@
-# SessionStartRequestOutputs
-Final output of the session - completion, chunks, etc
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/sessionstartrequestuserproperties.md DELETED Viewed

@@ -1,9 +0,0 @@
-# SessionStartRequestUserProperties
-Any user properties associated with the session
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/toolparameters.md DELETED Viewed

@@ -1,9 +0,0 @@
-# ToolParameters
-These can be function call params or plugin call params
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/toolupdate.md DELETED Viewed

@@ -1,11 +0,0 @@
-# ToolUpdate
-## Fields
-| Field                                                                              | Type                                                                               | Required                                                                           | Description                                                                        |
-| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
-| `description`                                                                      | *string*                                                                           | :heavy_minus_sign:                                                                 | N/A                                                                                |
-| `id`                                                                               | *string*                                                                           | :heavy_check_mark:                                                                 | N/A                                                                                |
-| `name`                                                                             | *string*                                                                           | :heavy_minus_sign:                                                                 | N/A                                                                                |
-| `parameters`                                                                       | [components.ToolUpdateParameters](../../models/components/toolupdateparameters.md) | :heavy_minus_sign:                                                                 | N/A                                                                                |

package/docs/models/components/toolupdateparameters.md DELETED Viewed

@@ -1,7 +0,0 @@
-# ToolUpdateParameters
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/updatedatapointrequestinputs.md DELETED Viewed

@@ -1,9 +0,0 @@
-# UpdateDatapointRequestInputs
-Arbitrary JSON object containing the inputs for the datapoint
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/updatedatapointrequestmetadata.md DELETED Viewed

@@ -1,9 +0,0 @@
-# UpdateDatapointRequestMetadata
-Any additional metadata for the datapoint
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/components/userproperties.md DELETED Viewed

@@ -1,9 +0,0 @@
-# UserProperties
-Details of user who created the configuration
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/operations/deletedatasetsresponse.md DELETED Viewed

@@ -1,10 +0,0 @@
-# DeleteDatasetsResponse
-## Fields
-| Field                                                   | Type                                                    | Required                                                | Description                                             |
-| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
-| `contentType`                                           | *string*                                                | :heavy_check_mark:                                      | HTTP response content type for this operation           |
-| `statusCode`                                            | *number*                                                | :heavy_check_mark:                                      | HTTP response status code for this operation            |
-| `rawResponse`                                           | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark:                                      | Raw HTTP response; suitable for custom response parsing |

package/docs/models/operations/deleteeventseventidresponse.md DELETED Viewed

@@ -1,10 +0,0 @@
-# DeleteEventsEventIdResponse
-## Fields
-| Field                                                   | Type                                                    | Required                                                | Description                                             |
-| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
-| `contentType`                                           | *string*                                                | :heavy_check_mark:                                      | HTTP response content type for this operation           |
-| `statusCode`                                            | *number*                                                | :heavy_check_mark:                                      | HTTP response status code for this operation            |
-| `rawResponse`                                           | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark:                                      | Raw HTTP response; suitable for custom response parsing |

package/docs/models/operations/feedback.md DELETED Viewed

@@ -1,7 +0,0 @@
-# Feedback
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |

package/docs/models/operations/gettoolssecurity.md DELETED Viewed

@@ -1,8 +0,0 @@
-# GetToolsSecurity
-## Fields
-| Field              | Type               | Required           | Description        |
-| ------------------ | ------------------ | ------------------ | ------------------ |
-| `bearerAuth`       | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/operations/metadata.md DELETED Viewed

@@ -1,7 +0,0 @@
-# Metadata
-## Fields
-| Field       | Type        | Required    | Description |
-| ----------- | ----------- | ----------- | ----------- |