honeyhive 1.0.21 → 1.0.25

package/codeSamples.yaml

@@ -0,0 +1,1570 @@
+overlay: 1.0.0
+info:
+  title: CodeSamples overlay for typescript target
+  version: 0.0.0
+actions:
+  - target: $["paths"]["/configurations"]["get"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: getConfigurations
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.configurations.getConfigurations("<value>");
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/configurations"]["post"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: createConfiguration
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              await honeyHive.configurations.createConfiguration({
+                project: "660d7ba7995cacccce4d299e",
+                name: "function-v0",
+                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>",
+                    ],
+                  },
+                  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 }}",
+                      },
+                    ],
+                  },
+                },
+                env: [
+                  "staging",
+                ],
+                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",
+                },
+              });
+
+
+            }
+
+            run();
+  - target: $["paths"]["/configurations/{id}"]["delete"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: deleteConfiguration
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              await honeyHive.configurations.deleteConfiguration("<id>");
+
+
+            }
+
+            run();
+  - target: $["paths"]["/configurations/{id}"]["put"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: updateConfiguration
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              await honeyHive.configurations.updateConfiguration({
+                project: "New Project",
+                name: "function-v0",
+                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>",
+                    ],
+                  },
+                  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 }}",
+                      },
+                    ],
+                  },
+                },
+                env: [
+                  "staging",
+                ],
+                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",
+                },
+              }, "<id>");
+
+
+            }
+
+            run();
+  - target: $["paths"]["/datapoints"]["get"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: getDatapoints
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.datapoints.getDatapoints("<value>");
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/datapoints"]["post"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: createDatapoint
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.datapoints.createDatapoint({
+                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,
+                },
+              });
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/datapoints/{id}"]["delete"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: deleteDatapoint
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.datapoints.deleteDatapoint("<id>");
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/datapoints/{id}"]["get"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: getDatapoint
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.datapoints.getDatapoint("<id>");
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/datapoints/{id}"]["put"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: updateDatapoint
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              await honeyHive.datapoints.updateDatapoint({
+                inputs: {
+                  "query": "what's the temperature in Reykjavik?",
+                },
+                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 Reykjavik?\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.",
+                },
+                linkedEvals: [
+                  "<value>",
+                ],
+                linkedDatasets: [
+                  "<value>",
+                ],
+                metadata: {
+                  "question_type": "capital-weather",
+                  "random_field": 0,
+                },
+              }, "<id>");
+
+
+            }
+
+            run();
+  - target: $["paths"]["/datasets"]["delete"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: deleteDataset
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              await honeyHive.datasets.deleteDataset("<id>");
+
+
+            }
+
+            run();
+  - target: $["paths"]["/datasets"]["get"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: getDatasets
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.datasets.getDatasets("<value>");
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/datasets"]["post"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: createDataset
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.datasets.createDataset({
+                project: "New Project",
+                name: "test-dataset",
+                description: "A test dataset",
+                type: "evaluation",
+                datapoints: [
+                  "66369748b5773befbdc661e2",
+                ],
+                linkedEvals: [
+                  "<value>",
+                ],
+                saved: false,
+                pipelineType: "event",
+                metadata: {
+                  "source": "dev",
+                },
+              });
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/datasets"]["put"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: updateDataset
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              await honeyHive.datasets.updateDataset({
+                datasetId: "663876ec4611c47f4970f0c3",
+                name: "new-dataset-name",
+                description: "An updated dataset description",
+                datapoints: [
+                  "66369748b5773befbdc661e",
+                ],
+                linkedEvals: [
+                  "66369748b5773befbdasdk1",
+                ],
+                metadata: {
+                  "updated": true,
+                  "source": "prod",
+                },
+              });
+
+
+            }
+
+            run();
+  - target: $["paths"]["/datasets/{dataset_id}/datapoints"]["post"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: addDatapoints
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.datasets.addDatapoints({
+                project: "<value>",
+                data: [
+                  {
+                    "key": "<value>",
+                    "key1": "<value>",
+                    "key2": "<value>",
+                  },
+                ],
+                mapping: {
+                  inputs: [
+                    "<value>",
+                  ],
+                  groundTruth: [
+                    "<value>",
+                    "<value>",
+                  ],
+                  history: [
+                    "<value>",
+                  ],
+                },
+              }, "<id>");
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/events"]["post"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: createEvent
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.events.createEvent({
+                event: {
+                  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: "<value>",
+                  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",
+                  },
+                },
+              });
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/events"]["put"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: updateEvent
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              await honeyHive.events.updateEvent({
+                eventId: "7f22137a-6911-4ed3-bc36-110f1dde6b66",
+                metadata: {
+                  "cost": 0.00008,
+                  "completion_tokens": 23,
+                  "prompt_tokens": 35,
+                  "total_tokens": 58,
+                },
+                feedback: {
+                  "rating": 5,
+                },
+                metrics: {
+                  "num_words": 2,
+                },
+                outputs: {
+                  "role": "assistant",
+                  "content": "Hello world",
+                },
+                config: {
+                  "template": [
+                    {
+                      "role": "system",
+                      "content": "Hello, {{ name }}!",
+                    },
+                  ],
+                },
+                userProperties: {
+                  "user_id": "691b1f94-d38c-4e92-b051-5e03fee9ff86",
+                },
+                duration: 42,
+              });
+
+
+            }
+
+            run();
+  - target: $["paths"]["/events/batch"]["post"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: createEventBatch
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.events.createEventBatch({
+                events: [
+                  {
+                    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: "<value>",
+                    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",
+                    },
+                  },
+                ],
+                sessionProperties: {
+                  sessionName: "Playground Session",
+                  source: "playground",
+                  sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
+                  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>",
+                  userProperties: {
+                    "user": "google-oauth2|111840237613341303366",
+                  },
+                  metrics: {
+
+                  },
+                  feedback: {
+
+                  },
+                  metadata: {
+
+                  },
+                },
+              });
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/events/export"]["post"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: getEvents
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.events.getEvents({
+                project: "<value>",
+                filters: [
+                  {
+                    field: "event_type",
+                    value: "model",
+                    operator: "is",
+                    type: "string",
+                  },
+                ],
+              });
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/events/model"]["post"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: createModelEvent
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.events.createModelEvent({
+                modelEvent: {
+                  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: "<value>",
+                  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",
+                  },
+                },
+              });
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/events/model/batch"]["post"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: createModelEventBatch
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.events.createModelEventBatch({
+                modelEvents: [
+                  {
+                    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: "<value>",
+                    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",
+                    },
+                  },
+                ],
+                sessionProperties: {
+                  sessionName: "Playground Session",
+                  source: "playground",
+                  sessionId: "caf77ace-3417-4da4-944d-f4a0688f3c23",
+                  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>",
+                  userProperties: {
+                    "user": "google-oauth2|111840237613341303366",
+                  },
+                  metrics: {
+
+                  },
+                  feedback: {
+
+                  },
+                  metadata: {
+
+                  },
+                },
+              });
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/metrics"]["delete"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: deleteMetric
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              await honeyHive.metrics.deleteMetric("<id>");
+
+
+            }
+
+            run();
+  - target: $["paths"]["/metrics"]["get"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: getMetrics
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.metrics.getMetrics("<value>");
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/metrics"]["post"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: createMetric
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              await honeyHive.metrics.createMetric({
+                name: "<value>",
+                task: "<value>",
+                type: "model",
+                description: "ack oh faithfully annually bloom ha because instead",
+                returnType: "boolean",
+              });
+
+
+            }
+
+            run();
+  - target: $["paths"]["/metrics"]["put"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: updateMetric
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              await honeyHive.metrics.updateMetric({
+                metricId: "<id>",
+              });
+
+
+            }
+
+            run();
+  - target: $["paths"]["/projects"]["delete"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: deleteProject
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              await honeyHive.projects.deleteProject("<value>");
+
+
+            }
+
+            run();
+  - target: $["paths"]["/projects"]["get"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: getProjects
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.projects.getProjects();
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/projects"]["post"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: createProject
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.projects.createProject({
+                name: "<value>",
+              });
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/projects"]["put"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: updateProject
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              await honeyHive.projects.updateProject({
+                projectId: "<id>",
+              });
+
+
+            }
+
+            run();
+  - target: $["paths"]["/runs"]["get"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: getRuns
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.experiments.getRuns();
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/runs"]["post"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: createRun
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.experiments.createRun({
+                project: "<value>",
+                name: "<value>",
+                eventIds: [
+                  "1504f40b-8865-40f9-b343-513d7da481bd",
+                ],
+              });
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/runs/{run_id_1}/compare-with/{run_id_2}"]["get"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: getExperimentComparison
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.experiments.getExperimentComparison("<value>", "<value>", "<id>");
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/runs/{run_id}"]["delete"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: deleteRun
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.experiments.deleteRun("<id>");
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/runs/{run_id}"]["get"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: getRun
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.experiments.getRun("<id>");
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/runs/{run_id}"]["put"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: updateRun
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.experiments.updateRun({}, "<id>");
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/runs/{run_id}/result"]["get"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: getExperimentResult
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.experiments.getExperimentResult("<id>", "<id>");
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/session/start"]["post"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: startSession
+          source: |-
+            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();
+  - target: $["paths"]["/session/{session_id}"]["get"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: getSession
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.session.getSession("<id>");
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/tools"]["delete"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: deleteTool
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              await honeyHive.tools.deleteTool("<id>");
+
+
+            }
+
+            run();
+  - target: $["paths"]["/tools"]["get"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: getTools
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.tools.getTools();
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/tools"]["post"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: createTool
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              const result = await honeyHive.tools.createTool({
+                task: "<value>",
+                name: "<value>",
+                parameters: {
+                  "key": "<value>",
+                  "key1": "<value>",
+                },
+                type: "function",
+              });
+
+              // Handle the result
+              console.log(result);
+            }
+
+            run();
+  - target: $["paths"]["/tools"]["put"]
+    update:
+      x-codeSamples:
+        - lang: typescript
+          label: updateTool
+          source: |-
+            import { HoneyHive } from "honeyhive";
+
+            const honeyHive = new HoneyHive({
+              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+            });
+
+            async function run() {
+              await honeyHive.tools.updateTool({
+                id: "<id>",
+                name: "<value>",
+                parameters: {
+
+                },
+              });
+
+
+            }
+
+            run();