honeyhive 0.5.1 → 0.6.1

package/README.md

@@ -25,49 +25,67 @@ yarn add https://github.com/honeyhiveai/typescript-sdk
 import { HoneyHive } from "honeyhive";
 
 async function run() {
-    const sdk = new HoneyHive({
-        bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-    });
-
-    const res = await sdk.session.startSession({
-        session: {
-            project: "Simple RAG Project",
-            sessionName: "Playground Session",
-            source: "playground",
-            sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
-            childrenIds: ["7f22137a-6911-4ed3-bc36-110f1dde6b66"],
-            config: {
-                key: "<value>",
-            },
-            inputs: {
-                context: "Hello world",
-                question: "What is in the context?",
-                chat_history: "<value>",
-            },
-            outputs: {
-                role: "assistant",
-                content: "Hello world",
-            },
-            error: null,
-            duration: 824.8056,
-            userProperties: {
-                user: "google-oauth2|111840237613341303366",
-            },
-            metrics: {},
-            feedback: {},
-            metadata: {},
-            startTime: 1712025501605,
-            endTime: 1712025499832,
-        },
-    });
-
-    if (res.statusCode == 200) {
-        // handle response
-    }
+  const sdk = new HoneyHive({
+    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const res = await sdk.session.startSession({
+    session: {
+      project: "Simple RAG Project",
+      sessionName: "Playground Session",
+      source: "playground",
+      sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
+      childrenIds: [
+        "7f22137a-6911-4ed3-bc36-110f1dde6b66",
+      ],
+      config: {
+        "key": "<value>",
+      },
+      inputs: {
+        "context": "Hello world",
+        "question": "What is in the context?",
+        "chat_history": [
+          {
+            "role": "system",
+            "content": "Answer the user's question only using provided context.
+
+            Context: Hello world",
+          },
+          {
+            "role": "user",
+            "content": "What is in the context?",
+          },
+        ],
+      },
+      outputs: {
+        "role": "assistant",
+        "content": "Hello world",
+      },
+      error: null,
+      duration: 824.8056,
+      userProperties: {
+        "user": "google-oauth2|111840237613341303366",
+      },
+      metrics: {
+
+      },
+      feedback: {
+
+      },
+      metadata: {
+
+      },
+      startTime: 1712025501605,
+      endTime: 1712025499832,
+    },
+  });
+
+  if (res.statusCode == 200) {
+    // handle response
+  }
 }
 
 run();
-
 ```
 <!-- End SDK Example Usage [usage] -->
 
@@ -84,6 +102,9 @@ run();
 * [createEvent](docs/sdks/events/README.md#createevent) - Create a new event
 * [updateEvent](docs/sdks/events/README.md#updateevent) - Update an event
 * [getEvents](docs/sdks/events/README.md#getevents) - Retrieve events based on filters
+* [createModelEvent](docs/sdks/events/README.md#createmodelevent) - Create a new model event
+* [createEventBatch](docs/sdks/events/README.md#createeventbatch) - Create a batch of events
+* [createModelEventBatch](docs/sdks/events/README.md#createmodeleventbatch) - Create a batch of model events
 
 ### [metrics](docs/sdks/metrics/README.md)
 
@@ -113,6 +134,7 @@ run();
 * [createDataset](docs/sdks/datasets/README.md#createdataset) - Create a dataset
 * [updateDataset](docs/sdks/datasets/README.md#updatedataset) - Update a dataset
 * [deleteDataset](docs/sdks/datasets/README.md#deletedataset) - Delete a dataset
+* [addDatapoints](docs/sdks/datasets/README.md#adddatapoints) - Add datapoints to a dataset
 
 ### [projects](docs/sdks/projects/README.md)
 
@@ -121,6 +143,14 @@ run();
 * [updateProject](docs/sdks/projects/README.md#updateproject) - Update an existing project
 * [deleteProject](docs/sdks/projects/README.md#deleteproject) - Delete a project
 
+### [runs](docs/sdks/runs/README.md)
+
+* [createRun](docs/sdks/runs/README.md#createrun) - Create a new evaluation run
+* [getRuns](docs/sdks/runs/README.md#getruns) - Get a list of evaluation runs
+* [getRun](docs/sdks/runs/README.md#getrun) - Get details of an evaluation run
+* [updateRun](docs/sdks/runs/README.md#updaterun) - Update an evaluation run
+* [deleteRun](docs/sdks/runs/README.md#deleterun) - Delete an evaluation run
+
 ### [configurations](docs/sdks/configurations/README.md)
 
 * [getConfigurations](docs/sdks/configurations/README.md#getconfigurations) - Retrieve a list of configurations
@@ -134,67 +164,128 @@ run();
 
 Handling errors in this SDK should largely match your expectations.  All operations return a response object or throw an error.  If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
 
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| Error Object                        | Status Code                         | Content Type                        |
+| ----------------------------------- | ----------------------------------- | ----------------------------------- |
+| errors.CreateEventBatchResponseBody | 500                                 | application/json                    |
+| errors.SDKError                     | 4xx-5xx                             | */*                                 |
 
 Example
 
 ```typescript
 import { HoneyHive } from "honeyhive";
+import { CreateEventRequestEventType } from "honeyhive/dist/models/components";
 
 async function run() {
-    const sdk = new HoneyHive({
-        bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-    });
-
-    let res;
-    try {
-        res = await sdk.session.startSession({
-            session: {
-                project: "Simple RAG Project",
-                sessionName: "Playground Session",
-                source: "playground",
-                sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
-                childrenIds: ["7f22137a-6911-4ed3-bc36-110f1dde6b66"],
-                config: {
-                    key: "<value>",
-                },
-                inputs: {
-                    context: "Hello world",
-                    question: "What is in the context?",
-                    chat_history: "<value>",
-                },
-                outputs: {
-                    role: "assistant",
-                    content: "Hello world",
-                },
-                error: null,
-                duration: 824.8056,
-                userProperties: {
-                    user: "google-oauth2|111840237613341303366",
-                },
-                metrics: {},
-                feedback: {},
-                metadata: {},
-                startTime: 1712025501605,
-                endTime: 1712025499832,
+  const sdk = new HoneyHive({
+    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  
+  let res;
+  try {
+    res = await sdk.events.createEventBatch({
+    events: [
+      {
+        project: "Simple RAG",
+        source: "playground",
+        eventName: "Model Completion",
+        eventType: CreateEventRequestEventType.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.
+
+              Context: {{ context }}",
             },
-        });
-    } catch (err) {
-        if (err instanceof errors.SDKError) {
-            console.error(err); // handle exception
-            throw err;
-        }
-    }
+            {
+              "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.
+
+              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: {
 
-    if (res.statusCode == 200) {
-        // handle response
+        },
+        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",
+        },
+      },
+    ],
+  });
+  } catch (err) { 
+    if (err instanceof errors.CreateEventBatchResponseBody) {
+      console.error(err) // handle exception
+      throw err;
     }
+    else if (err instanceof errors.SDKError) {
+     console.error(err) // handle exception
+     throw err;
+    }
+  }
+
+  if (res.statusCode == 200) {
+    // handle response
+  }
 }
 
 run();
-
 ```
 <!-- End Error Handling [errors] -->
 
@@ -215,50 +306,68 @@ You can override the default server globally by passing a server index to the `s
 import { HoneyHive } from "honeyhive";
 
 async function run() {
-    const sdk = new HoneyHive({
-        serverIdx: 0,
-        bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-    });
-
-    const res = await sdk.session.startSession({
-        session: {
-            project: "Simple RAG Project",
-            sessionName: "Playground Session",
-            source: "playground",
-            sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
-            childrenIds: ["7f22137a-6911-4ed3-bc36-110f1dde6b66"],
-            config: {
-                key: "<value>",
-            },
-            inputs: {
-                context: "Hello world",
-                question: "What is in the context?",
-                chat_history: "<value>",
-            },
-            outputs: {
-                role: "assistant",
-                content: "Hello world",
-            },
-            error: null,
-            duration: 824.8056,
-            userProperties: {
-                user: "google-oauth2|111840237613341303366",
-            },
-            metrics: {},
-            feedback: {},
-            metadata: {},
-            startTime: 1712025501605,
-            endTime: 1712025499832,
-        },
-    });
-
-    if (res.statusCode == 200) {
-        // handle response
-    }
+  const sdk = new HoneyHive({
+    serverIdx: 0,
+    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const res = await sdk.session.startSession({
+    session: {
+      project: "Simple RAG Project",
+      sessionName: "Playground Session",
+      source: "playground",
+      sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
+      childrenIds: [
+        "7f22137a-6911-4ed3-bc36-110f1dde6b66",
+      ],
+      config: {
+        "key": "<value>",
+      },
+      inputs: {
+        "context": "Hello world",
+        "question": "What is in the context?",
+        "chat_history": [
+          {
+            "role": "system",
+            "content": "Answer the user's question only using provided context.
+
+            Context: Hello world",
+          },
+          {
+            "role": "user",
+            "content": "What is in the context?",
+          },
+        ],
+      },
+      outputs: {
+        "role": "assistant",
+        "content": "Hello world",
+      },
+      error: null,
+      duration: 824.8056,
+      userProperties: {
+        "user": "google-oauth2|111840237613341303366",
+      },
+      metrics: {
+
+      },
+      feedback: {
+
+      },
+      metadata: {
+
+      },
+      startTime: 1712025501605,
+      endTime: 1712025499832,
+    },
+  });
+
+  if (res.statusCode == 200) {
+    // handle response
+  }
 }
 
 run();
-
 ```
 
 
@@ -269,50 +378,68 @@ The default server can also be overridden globally by passing a URL to the `serv
 import { HoneyHive } from "honeyhive";
 
 async function run() {
-    const sdk = new HoneyHive({
-        serverURL: "https://api.honeyhive.ai",
-        bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-    });
-
-    const res = await sdk.session.startSession({
-        session: {
-            project: "Simple RAG Project",
-            sessionName: "Playground Session",
-            source: "playground",
-            sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
-            childrenIds: ["7f22137a-6911-4ed3-bc36-110f1dde6b66"],
-            config: {
-                key: "<value>",
-            },
-            inputs: {
-                context: "Hello world",
-                question: "What is in the context?",
-                chat_history: "<value>",
-            },
-            outputs: {
-                role: "assistant",
-                content: "Hello world",
-            },
-            error: null,
-            duration: 824.8056,
-            userProperties: {
-                user: "google-oauth2|111840237613341303366",
-            },
-            metrics: {},
-            feedback: {},
-            metadata: {},
-            startTime: 1712025501605,
-            endTime: 1712025499832,
-        },
-    });
-
-    if (res.statusCode == 200) {
-        // handle response
-    }
+  const sdk = new HoneyHive({
+    serverURL: "https://api.honeyhive.ai",
+    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const res = await sdk.session.startSession({
+    session: {
+      project: "Simple RAG Project",
+      sessionName: "Playground Session",
+      source: "playground",
+      sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
+      childrenIds: [
+        "7f22137a-6911-4ed3-bc36-110f1dde6b66",
+      ],
+      config: {
+        "key": "<value>",
+      },
+      inputs: {
+        "context": "Hello world",
+        "question": "What is in the context?",
+        "chat_history": [
+          {
+            "role": "system",
+            "content": "Answer the user's question only using provided context.
+
+            Context: Hello world",
+          },
+          {
+            "role": "user",
+            "content": "What is in the context?",
+          },
+        ],
+      },
+      outputs: {
+        "role": "assistant",
+        "content": "Hello world",
+      },
+      error: null,
+      duration: 824.8056,
+      userProperties: {
+        "user": "google-oauth2|111840237613341303366",
+      },
+      metrics: {
+
+      },
+      feedback: {
+
+      },
+      metadata: {
+
+      },
+      startTime: 1712025501605,
+      endTime: 1712025499832,
+    },
+  });
+
+  if (res.statusCode == 200) {
+    // handle response
+  }
 }
 
 run();
-
 ```
 <!-- End Server Selection [server] -->
 
@@ -351,49 +478,67 @@ To authenticate with the API the `bearerAuth` parameter must be set when initial
 import { HoneyHive } from "honeyhive";
 
 async function run() {
-    const sdk = new HoneyHive({
-        bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-    });
-
-    const res = await sdk.session.startSession({
-        session: {
-            project: "Simple RAG Project",
-            sessionName: "Playground Session",
-            source: "playground",
-            sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
-            childrenIds: ["7f22137a-6911-4ed3-bc36-110f1dde6b66"],
-            config: {
-                key: "<value>",
-            },
-            inputs: {
-                context: "Hello world",
-                question: "What is in the context?",
-                chat_history: "<value>",
-            },
-            outputs: {
-                role: "assistant",
-                content: "Hello world",
-            },
-            error: null,
-            duration: 824.8056,
-            userProperties: {
-                user: "google-oauth2|111840237613341303366",
-            },
-            metrics: {},
-            feedback: {},
-            metadata: {},
-            startTime: 1712025501605,
-            endTime: 1712025499832,
-        },
-    });
-
-    if (res.statusCode == 200) {
-        // handle response
-    }
+  const sdk = new HoneyHive({
+    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  const res = await sdk.session.startSession({
+    session: {
+      project: "Simple RAG Project",
+      sessionName: "Playground Session",
+      source: "playground",
+      sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
+      childrenIds: [
+        "7f22137a-6911-4ed3-bc36-110f1dde6b66",
+      ],
+      config: {
+        "key": "<value>",
+      },
+      inputs: {
+        "context": "Hello world",
+        "question": "What is in the context?",
+        "chat_history": [
+          {
+            "role": "system",
+            "content": "Answer the user's question only using provided context.
+
+            Context: Hello world",
+          },
+          {
+            "role": "user",
+            "content": "What is in the context?",
+          },
+        ],
+      },
+      outputs: {
+        "role": "assistant",
+        "content": "Hello world",
+      },
+      error: null,
+      duration: 824.8056,
+      userProperties: {
+        "user": "google-oauth2|111840237613341303366",
+      },
+      metrics: {
+
+      },
+      feedback: {
+
+      },
+      metadata: {
+
+      },
+      startTime: 1712025501605,
+      endTime: 1712025499832,
+    },
+  });
+
+  if (res.statusCode == 200) {
+    // handle response
+  }
 }
 
 run();
-
 ```
 <!-- End Authentication [security] -->
 

package/dist/models/components/chatcompletionrequest.d.ts

@@ -0,0 +1,37 @@
+import { SpeakeasyBase } from "../../internal/utils";
+export declare class ChatCompletionRequest extends SpeakeasyBase {
+    /**
+     * The project ID
+     */
+    project: string;
+    /**
+     * The version of the chat
+     */
+    version?: string;
+    /**
+     * The chat history
+     */
+    messages: Record<string, any>[];
+    /**
+     * The model to use
+     */
+    model: string;
+    /**
+     * The provider
+     */
+    provider?: string;
+    hyperparameters?: Record<string, any>;
+    functions?: Record<string, any>[];
+    /**
+     * The function call method
+     */
+    functionCall?: string;
+    /**
+     * The number of samples
+     */
+    numSamples?: number;
+    /**
+     * Whether to stream output
+     */
+    stream?: boolean;
+}