@carbon-js/sdk 0.0.4 → 0.0.6

package/README.md

@@ -1,26 +1,32 @@
-# SDK
+# Carbon SDK
 
-Native Carbon ingestion SDK for capturing canonical AI events and sending them to the Carbon ingest API.
+A typescript SDK for capturing and ingesting events from AI application into [Carbon](https://oncarbon.site) for analytics and observability. For more details, see the [Carbon docs](https://docs.oncarbon.site)
 
-## Usage
+## Installation
+
+Install the SDK:
+
+```bash
+npm install @carbon-js/sdk
+```
+
+## Quick Start
+
+Using Carbon SDK to instrument an OpenAI SDK application:
 
 ```ts
+import OpenAI from "openai";
 import { Carbon } from "@carbon-js/sdk";
 import { wrapOpenAISdk } from "@carbon-js/sdk/ai";
 
-const carbon = new Carbon({ apiKey: process.env.CARBON_API_KEY! });
-const openai = wrapOpenAISdk(client, carbon);
-```
+const carbon = new Carbon();
+const openai = wrapOpenAISdk(new OpenAI(), carbon);
 
-## Development
+const completion = await openai.chat.completions.create({
+  model: "gpt-5.4-nano",
+  messages: [{ role: "user", content: "What is the capital of France?" }],
+});
 
-```bash
-bun install
-bunx tsc --noEmit -p packages/sdk/tsconfig.json
-bun test packages/sdk/tests
-```
-## Smoke Test
-
-```bash
-bun run --cwd packages/sdk example:vercel
+// Flush: only needed in serverless and other short-lived environments.
+await carbon.flushPendingEvents();
 ```

package/dist/ai/openai/fns/chat-completions-run-tools.mjs

@@ -7,13 +7,17 @@ function createWrappedChatCompletionRunTools(args) {
   const runTools = args.client.chat.completions.runTools.bind(args.client.chat.completions);
   return ((body, requestOptions) => {
     const { carbon: carbonObject, ...openAiBody } = body;
+    const tracedCarbonObject = {
+      ...carbonObject,
+      traceId: carbonObject?.traceId ?? args.carbon.createTraceId()
+    };
     const bodyWithInternalCapture = {
       ...openAiBody,
-      carbon: carbonObject,
+      carbon: tracedCarbonObject,
       [SKIP_CAPTURE_FIELD]: true
     };
     const factory = new OpenAIEventFactory({
-      carbonObject
+      carbonObject: tracedCarbonObject
     });
     const startTimeMs = Date.now();
     let runner;
@@ -38,7 +42,7 @@ function createWrappedChatCompletionRunTools(args) {
     attachRunToolsCapture({
       body: openAiBody,
       carbon: args.carbon,
-      carbonObject,
+      carbonObject: tracedCarbonObject,
       factory,
       mode: openAiBody.stream ? "stream" : "generate",
       runner

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@carbon-js/sdk",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "license": "MIT",
   "type": "module",
   "exports": {