honeyhive 1.0.21 → 1.0.23

package/README.md

@@ -30,25 +30,25 @@ The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https
 ### NPM
 
 ```bash
-npm add https://github.com/honeyhiveai/typescript-sdk
+npm add honeyhive
 ```
 
 ### PNPM
 
 ```bash
-pnpm add https://github.com/honeyhiveai/typescript-sdk
+pnpm add honeyhive
 ```
 
 ### Bun
 
 ```bash
-bun add https://github.com/honeyhiveai/typescript-sdk
+bun add honeyhive
 ```
 
 ### Yarn
 
 ```bash
-yarn add https://github.com/honeyhiveai/typescript-sdk zod
+yarn add honeyhive zod
 
 # Note that Yarn does not install peer dependencies automatically. You will need
 # to install zod as shown above.
@@ -78,6 +78,8 @@ async function run() {
         "7f22137a-6911-4ed3-bc36-110f1dde6b66",
       ],
       inputs: {
+        "context": "Hello world",
+        "question": "What is in the context?",
         "chat_history": [
           {
             "role": "system",
@@ -91,12 +93,10 @@ async function run() {
             "content": "What is in the context?",
           },
         ],
-        "context": "Hello world",
-        "question": "What is in the context?",
       },
       outputs: {
-        "content": "Hello world",
         "role": "assistant",
+        "content": "Hello world",
       },
       error: "<value>",
       duration: 824.8056,
@@ -215,10 +215,10 @@ If a HTTP request fails, an operation my also throw an error from the `models/er
 
 In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `createEventBatch` method may throw the following errors:
 
-| Error Type                          | Status Code | Content Type     |
-| ----------------------------------- | ----------- | ---------------- |
-| errors.CreateEventBatchResponseBody | 500         | application/json |
-| errors.SDKError                     | 4XX, 5XX    | \*/\*            |
+| Error Type                          | Status Code                         | Content Type                        |
+| ----------------------------------- | ----------------------------------- | ----------------------------------- |
+| errors.CreateEventBatchResponseBody | 500                                 | application/json                    |
+| errors.SDKError                     | 4XX, 5XX                            | \*/\*                               |
 
 ```typescript
 import { HoneyHive } from "honeyhive";
@@ -388,14 +388,19 @@ Validation errors can also occur when either method arguments or data returned f
 <!-- Start Server Selection [server] -->
 ## Server Selection
 
-### Override Server URL Per-Client
+### Select Server by Index
+
+You can override the default server globally by passing a server index to the `serverIdx` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
+
+| # | Server | Variables |
+| - | ------ | --------- |
+| 0 | `https://api.honeyhive.ai` | None |
 
-The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
 ```typescript
 import { HoneyHive } from "honeyhive";
 
 const honeyHive = new HoneyHive({
-  serverURL: "https://api.honeyhive.ai",
+  serverIdx: 0,
   bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
@@ -410,6 +415,8 @@ async function run() {
         "7f22137a-6911-4ed3-bc36-110f1dde6b66",
       ],
       inputs: {
+        "context": "Hello world",
+        "question": "What is in the context?",
         "chat_history": [
           {
             "role": "system",
@@ -423,12 +430,75 @@ async function run() {
             "content": "What is in the context?",
           },
         ],
+      },
+      outputs: {
+        "role": "assistant",
+        "content": "Hello world",
+      },
+      error: "<value>",
+      duration: 824.8056,
+      userProperties: {
+        "user": "google-oauth2|111840237613341303366",
+      },
+      metrics: {},
+      feedback: {},
+      metadata: {},
+      startTime: 1712025501605,
+      endTime: 1712025499832,
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+
+```
+
+
+### Override Server URL Per-Client
+
+The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example:
+
+```typescript
+import { HoneyHive } from "honeyhive";
+
+const honeyHive = new HoneyHive({
+  serverURL: "https://api.honeyhive.ai",
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const result = await honeyHive.session.startSession({
+    session: {
+      project: "Simple RAG Project",
+      sessionName: "Playground Session",
+      source: "playground",
+      sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
+      childrenIds: [
+        "7f22137a-6911-4ed3-bc36-110f1dde6b66",
+      ],
+      inputs: {
         "context": "Hello world",
         "question": "What is in the context?",
+        "chat_history": [
+          {
+            "role": "system",
+            "content":
+              "Answer the user's question only using provided context.\n"
+              + "\n"
+              + "Context: Hello world",
+          },
+          {
+            "role": "user",
+            "content": "What is in the context?",
+          },
+        ],
       },
       outputs: {
-        "content": "Hello world",
         "role": "assistant",
+        "content": "Hello world",
       },
       error: "<value>",
       duration: 824.8056,
@@ -508,9 +578,9 @@ const sdk = new HoneyHive({ httpClient });
 
 This SDK supports the following security scheme globally:
 
-| Name         | Type | Scheme      |
-| ------------ | ---- | ----------- |
-| `bearerAuth` | http | HTTP Bearer |
+| Name         | Type         | Scheme       |
+| ------------ | ------------ | ------------ |
+| `bearerAuth` | http         | HTTP Bearer  |
 
 To authenticate with the API the `bearerAuth` parameter must be set when initializing the SDK client instance. For example:
 ```typescript
@@ -531,6 +601,8 @@ async function run() {
         "7f22137a-6911-4ed3-bc36-110f1dde6b66",
       ],
       inputs: {
+        "context": "Hello world",
+        "question": "What is in the context?",
         "chat_history": [
           {
             "role": "system",
@@ -544,12 +616,10 @@ async function run() {
             "content": "What is in the context?",
           },
         ],
-        "context": "Hello world",
-        "question": "What is in the context?",
       },
       outputs: {
-        "content": "Hello world",
         "role": "assistant",
+        "content": "Hello world",
       },
       error: "<value>",
       duration: 824.8056,
@@ -594,47 +664,48 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 <summary>Available standalone functions</summary>
 
-- [`configurationsCreateConfiguration`](docs/sdks/configurations/README.md#createconfiguration) - Create a new configuration
-- [`configurationsDeleteConfiguration`](docs/sdks/configurations/README.md#deleteconfiguration) - Delete a configuration
-- [`configurationsGetConfigurations`](docs/sdks/configurations/README.md#getconfigurations) - Retrieve a list of configurations
-- [`configurationsUpdateConfiguration`](docs/sdks/configurations/README.md#updateconfiguration) - Update an existing configuration
-- [`datapointsCreateDatapoint`](docs/sdks/datapoints/README.md#createdatapoint) - Create a new datapoint
-- [`datapointsDeleteDatapoint`](docs/sdks/datapoints/README.md#deletedatapoint) - Delete a specific datapoint
-- [`datapointsGetDatapoint`](docs/sdks/datapoints/README.md#getdatapoint) - Retrieve a specific datapoint
-- [`datapointsGetDatapoints`](docs/sdks/datapoints/README.md#getdatapoints) - Retrieve a list of datapoints
-- [`datapointsUpdateDatapoint`](docs/sdks/datapoints/README.md#updatedatapoint) - Update a specific datapoint
-- [`datasetsAddDatapoints`](docs/sdks/datasets/README.md#adddatapoints) - Add datapoints to a dataset
-- [`datasetsCreateDataset`](docs/sdks/datasets/README.md#createdataset) - Create a dataset
-- [`datasetsDeleteDataset`](docs/sdks/datasets/README.md#deletedataset) - Delete a dataset
-- [`datasetsGetDatasets`](docs/sdks/datasets/README.md#getdatasets) - Get datasets
-- [`datasetsUpdateDataset`](docs/sdks/datasets/README.md#updatedataset) - Update a dataset
-- [`eventsCreateEvent`](docs/sdks/events/README.md#createevent) - Create a new event
-- [`eventsCreateEventBatch`](docs/sdks/events/README.md#createeventbatch) - Create a batch of events
-- [`eventsCreateModelEvent`](docs/sdks/events/README.md#createmodelevent) - Create a new model event
-- [`eventsCreateModelEventBatch`](docs/sdks/events/README.md#createmodeleventbatch) - Create a batch of model events
-- [`eventsGetEvents`](docs/sdks/events/README.md#getevents) - Retrieve events based on filters
-- [`eventsUpdateEvent`](docs/sdks/events/README.md#updateevent) - Update an event
-- [`experimentsCreateRun`](docs/sdks/experiments/README.md#createrun) - Create a new evaluation run
-- [`experimentsDeleteRun`](docs/sdks/experiments/README.md#deleterun) - Delete an evaluation run
-- [`experimentsGetExperimentComparison`](docs/sdks/experiments/README.md#getexperimentcomparison) - Retrieve experiment comparison
-- [`experimentsGetExperimentResult`](docs/sdks/experiments/README.md#getexperimentresult) - Retrieve experiment result
-- [`experimentsGetRun`](docs/sdks/experiments/README.md#getrun) - Get details of an evaluation run
-- [`experimentsGetRuns`](docs/sdks/experiments/README.md#getruns) - Get a list of evaluation runs
-- [`experimentsUpdateRun`](docs/sdks/experiments/README.md#updaterun) - Update an evaluation run
-- [`metricsCreateMetric`](docs/sdks/metrics/README.md#createmetric) - Create a new metric
-- [`metricsDeleteMetric`](docs/sdks/metrics/README.md#deletemetric) - Delete a metric
-- [`metricsGetMetrics`](docs/sdks/metrics/README.md#getmetrics) - Get all metrics
-- [`metricsUpdateMetric`](docs/sdks/metrics/README.md#updatemetric) - Update an existing metric
-- [`projectsCreateProject`](docs/sdks/projects/README.md#createproject) - Create a new project
-- [`projectsDeleteProject`](docs/sdks/projects/README.md#deleteproject) - Delete a project
-- [`projectsGetProjects`](docs/sdks/projects/README.md#getprojects) - Get a list of projects
-- [`projectsUpdateProject`](docs/sdks/projects/README.md#updateproject) - Update an existing project
-- [`sessionGetSession`](docs/sdks/session/README.md#getsession) - Retrieve a session
-- [`sessionStartSession`](docs/sdks/session/README.md#startsession) - Start a new session
-- [`toolsCreateTool`](docs/sdks/tools/README.md#createtool) - Create a new tool
-- [`toolsDeleteTool`](docs/sdks/tools/README.md#deletetool) - Delete a tool
-- [`toolsGetTools`](docs/sdks/tools/README.md#gettools) - Retrieve a list of tools
-- [`toolsUpdateTool`](docs/sdks/tools/README.md#updatetool) - Update an existing tool
+- [configurationsCreateConfiguration](docs/sdks/configurations/README.md#createconfiguration)
+- [configurationsDeleteConfiguration](docs/sdks/configurations/README.md#deleteconfiguration)
+- [configurationsGetConfigurations](docs/sdks/configurations/README.md#getconfigurations)
+- [configurationsUpdateConfiguration](docs/sdks/configurations/README.md#updateconfiguration)
+- [datapointsCreateDatapoint](docs/sdks/datapoints/README.md#createdatapoint)
+- [datapointsDeleteDatapoint](docs/sdks/datapoints/README.md#deletedatapoint)
+- [datapointsGetDatapoint](docs/sdks/datapoints/README.md#getdatapoint)
+- [datapointsGetDatapoints](docs/sdks/datapoints/README.md#getdatapoints)
+- [datapointsUpdateDatapoint](docs/sdks/datapoints/README.md#updatedatapoint)
+- [datasetsAddDatapoints](docs/sdks/datasets/README.md#adddatapoints)
+- [datasetsCreateDataset](docs/sdks/datasets/README.md#createdataset)
+- [datasetsDeleteDataset](docs/sdks/datasets/README.md#deletedataset)
+- [datasetsGetDatasets](docs/sdks/datasets/README.md#getdatasets)
+- [datasetsUpdateDataset](docs/sdks/datasets/README.md#updatedataset)
+- [eventsCreateEventBatch](docs/sdks/events/README.md#createeventbatch)
+- [eventsCreateEvent](docs/sdks/events/README.md#createevent)
+- [eventsCreateModelEventBatch](docs/sdks/events/README.md#createmodeleventbatch)
+- [eventsCreateModelEvent](docs/sdks/events/README.md#createmodelevent)
+- [eventsGetEvents](docs/sdks/events/README.md#getevents)
+- [eventsUpdateEvent](docs/sdks/events/README.md#updateevent)
+- [experimentsCreateRun](docs/sdks/experiments/README.md#createrun)
+- [experimentsDeleteRun](docs/sdks/experiments/README.md#deleterun)
+- [experimentsGetExperimentComparison](docs/sdks/experiments/README.md#getexperimentcomparison)
+- [experimentsGetExperimentResult](docs/sdks/experiments/README.md#getexperimentresult)
+- [experimentsGetRun](docs/sdks/experiments/README.md#getrun)
+- [experimentsGetRuns](docs/sdks/experiments/README.md#getruns)
+- [experimentsUpdateRun](docs/sdks/experiments/README.md#updaterun)
+- [metricsCreateMetric](docs/sdks/metrics/README.md#createmetric)
+- [metricsDeleteMetric](docs/sdks/metrics/README.md#deletemetric)
+- [metricsGetMetrics](docs/sdks/metrics/README.md#getmetrics)
+- [metricsUpdateMetric](docs/sdks/metrics/README.md#updatemetric)
+- [projectsCreateProject](docs/sdks/projects/README.md#createproject)
+- [projectsDeleteProject](docs/sdks/projects/README.md#deleteproject)
+- [projectsGetProjects](docs/sdks/projects/README.md#getprojects)
+- [projectsUpdateProject](docs/sdks/projects/README.md#updateproject)
+- [sessionGetSession](docs/sdks/session/README.md#getsession)
+- [sessionStartSession](docs/sdks/session/README.md#startsession)
+- [toolsCreateTool](docs/sdks/tools/README.md#createtool)
+- [toolsDeleteTool](docs/sdks/tools/README.md#deletetool)
+- [toolsGetTools](docs/sdks/tools/README.md#gettools)
+- [toolsUpdateTool](docs/sdks/tools/README.md#updatetool)
+
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
@@ -663,6 +734,8 @@ async function run() {
         "7f22137a-6911-4ed3-bc36-110f1dde6b66",
       ],
       inputs: {
+        "context": "Hello world",
+        "question": "What is in the context?",
         "chat_history": [
           {
             "role": "system",
@@ -676,12 +749,10 @@ async function run() {
             "content": "What is in the context?",
           },
         ],
-        "context": "Hello world",
-        "question": "What is in the context?",
       },
       outputs: {
-        "content": "Hello world",
         "role": "assistant",
+        "content": "Hello world",
       },
       error: "<value>",
       duration: 824.8056,
@@ -744,6 +815,8 @@ async function run() {
         "7f22137a-6911-4ed3-bc36-110f1dde6b66",
       ],
       inputs: {
+        "context": "Hello world",
+        "question": "What is in the context?",
         "chat_history": [
           {
             "role": "system",
@@ -757,12 +830,10 @@ async function run() {
             "content": "What is in the context?",
           },
         ],
-        "context": "Hello world",
-        "question": "What is in the context?",
       },
       outputs: {
-        "content": "Hello world",
         "role": "assistant",
+        "content": "Hello world",
       },
       error: "<value>",
       duration: 824.8056,

package/RELEASES.md

@@ -0,0 +1,153 @@
+
+
+## 2023-11-16 16:18:31
+### Changes
+Based on:
+- OpenAPI Doc 1.0.1 
+- Speakeasy CLI 1.120.3 (2.192.1) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.1.0] .
+
+## 2023-11-22 00:09:11
+### Changes
+Based on:
+- OpenAPI Doc 1.0.1 
+- Speakeasy CLI 1.121.3 (2.195.2) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.1.1] .
+
+## 2023-12-12 00:09:00
+### Changes
+Based on:
+- OpenAPI Doc 1.0.1 
+- Speakeasy CLI 1.126.0 (2.213.3) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.2.0] .
+
+## 2023-12-19 00:09:01
+### Changes
+Based on:
+- OpenAPI Doc 1.0.1 
+- Speakeasy CLI 1.127.0 (2.220.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.2.1] .
+
+## 2024-01-05 00:09:00
+### Changes
+Based on:
+- OpenAPI Doc 1.0.1 
+- Speakeasy CLI 1.130.1 (2.225.2) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.2.1] .
+
+## 2024-02-15 00:08:47
+### Changes
+Based on:
+- OpenAPI Doc 1.0.1 
+- Speakeasy CLI 1.180.0 (2.258.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.2.2] .
+
+## 2024-02-20 23:44:23
+### Changes
+Based on:
+- OpenAPI Doc 1.0.1 
+- Speakeasy CLI 1.185.0 (2.263.3) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.2.3] .
+
+## 2024-02-21 01:17:55
+### Changes
+Based on:
+- OpenAPI Doc 1.0.1 
+- Speakeasy CLI 1.185.0 (2.263.3) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.2.4] .
+
+## 2024-03-07 19:41:50
+### Changes
+Based on:
+- OpenAPI Doc 1.0.1 
+- Speakeasy CLI 1.204.1 (2.279.1) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.3.0] .
+
+## 2024-03-07 20:16:52
+### Changes
+Based on:
+- OpenAPI Doc 1.0.1 
+- Speakeasy CLI 1.204.1 (2.279.1) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.3.1] .
+
+## 2024-03-14 00:19:35
+### Changes
+Based on:
+- OpenAPI Doc 1.0.1 
+- Speakeasy CLI 1.209.2 (2.281.2) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.3.2] .
+
+## 2024-03-20 00:08:18
+### Changes
+Based on:
+- OpenAPI Doc 1.0.1 
+- Speakeasy CLI 1.213.0 (2.283.1) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.4.0] .
+
+## 2024-05-02 17:47:46
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.277.8 (2.319.10) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.4.1] .
+
+## 2024-05-10 18:08:09
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.285.6 (2.326.3) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.4.2] .
+
+## 2024-05-17 00:11:44
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.293.0 (2.332.4) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.4.4] .
+
+## 2024-06-03 16:42:58
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.299.6 (2.338.12) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.4.5] .
+
+## 2024-06-04 16:53:48
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.299.6 (2.338.12) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.4.5] .
+
+## 2024-06-20 05:58:23
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.310.0 (2.347.4) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.4.6] .
+
+## 2024-09-26 11:55:48
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.402.14 (2.422.22) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v1.0.8] .

package/RUNTIMES.md

@@ -0,0 +1,22 @@
+# Supported JavaScript runtimes
+
+This SDK is intended to be used in JavaScript runtimes that support the following features:
+
+* [Web Fetch API][web-fetch]
+* [Web Streams API][web-streams] and in particular `ReadableStream`
+* [Async iterables][async-iter] using `Symbol.asyncIterator`
+
+[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
+[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
+[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
+
+Runtime environments that are explicitly supported are:
+
+- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
+- Node.js active and maintenance LTS releases
+  - Currently, this is v18 and v20
+- Bun v1 and above
+- Deno v1.39
+  - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
+
+[deno-file-streaming]: https://github.com/denoland/deno/issues/11018

package/USAGE.md

@@ -0,0 +1,60 @@
+<!-- Start SDK Example Usage [usage] -->
+```typescript
+import { HoneyHive } from "honeyhive";
+
+const honeyHive = new HoneyHive({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const result = await honeyHive.session.startSession({
+    session: {
+      project: "Simple RAG Project",
+      sessionName: "Playground Session",
+      source: "playground",
+      sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
+      childrenIds: [
+        "7f22137a-6911-4ed3-bc36-110f1dde6b66",
+      ],
+      inputs: {
+        "context": "Hello world",
+        "question": "What is in the context?",
+        "chat_history": [
+          {
+            "role": "system",
+            "content":
+              "Answer the user's question only using provided context.\n"
+              + "\n"
+              + "Context: Hello world",
+          },
+          {
+            "role": "user",
+            "content": "What is in the context?",
+          },
+        ],
+      },
+      outputs: {
+        "role": "assistant",
+        "content": "Hello world",
+      },
+      error: "<value>",
+      duration: 824.8056,
+      userProperties: {
+        "user": "google-oauth2|111840237613341303366",
+      },
+      metrics: {},
+      feedback: {},
+      metadata: {},
+      startTime: 1712025501605,
+      endTime: 1712025499832,
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End SDK Example Usage [usage] -->