@revenium/openai 1.0.16 → 1.1.1

package/examples/openai/metadata.ts

@@ -15,11 +15,11 @@ async function main() {
   // Optional metadata for advanced reporting, lineage tracking, and cost allocation
   const metadata: UsageMetadata = {
     // Organization & billing
-    organizationId: "org-metadata-demo",
+    organizationName: "org-metadata-demo",
     subscriptionId: "plan-premium-2025",
 
     // Product & task tracking
-    productId: "ai-assistant",
+    productName: "ai-assistant",
     taskType: "explanation-request",
     agent: "openai-metadata-chat-node",
 
@@ -27,7 +27,7 @@ async function main() {
     traceId: "session-" + Date.now(),
 
     // Quality metrics
-    responseQualityScore: 0.95, // 0.0-1.0 scale
+    responseQualityScore: 0.95,
 
     // User tracking
     subscriber: {
@@ -54,7 +54,7 @@ async function main() {
         ],
         max_tokens: 1000,
       },
-      metadata
+      metadata,
     );
 
   // Display response

package/examples/openai/prompt-capture.ts

@@ -0,0 +1,95 @@
+import OpenAI from "openai";
+import { configure } from "../../src/index.js";
+
+async function main() {
+  console.log("=== OpenAI Prompt Capture Example ===\n");
+
+  configure({
+    reveniumApiKey: process.env.REVENIUM_METERING_API_KEY || "test-key",
+    reveniumBaseUrl: process.env.REVENIUM_METERING_BASE_URL,
+    capturePrompts: true,
+  });
+
+  const openai = new OpenAI({
+    apiKey: process.env.OPENAI_API_KEY,
+  });
+
+  console.log("Example 1: Prompt capture enabled via config");
+  console.log("Making request with prompt capture enabled...\n");
+
+  try {
+    const response = await openai.chat.completions.create({
+      model: "gpt-4o-mini",
+      max_tokens: 100,
+      messages: [
+        {
+          role: "system",
+          content: "You are a helpful assistant that provides concise answers.",
+        },
+        {
+          role: "user",
+          content: "What is the capital of France?",
+        },
+      ],
+      usageMetadata: {
+        organizationName: "org-prompt-capture-demo",
+        productName: "prod-openai-prompt-capture",
+      },
+    });
+
+    console.log("Response:", response.choices[0]?.message?.content);
+    console.log("\nPrompts captured and sent to Revenium API!");
+  } catch (error) {
+    console.error(
+      "Error:",
+      error instanceof Error ? error.message : String(error),
+    );
+  }
+
+  console.log("\n" + "=".repeat(50) + "\n");
+  console.log("Example 2: Prompt capture disabled via metadata override");
+  console.log("Making request with prompt capture disabled...\n");
+
+  try {
+    const response2 = await openai.chat.completions.create({
+      model: "gpt-4o-mini",
+      max_tokens: 100,
+      messages: [
+        {
+          role: "system",
+          content: "You are a helpful assistant.",
+        },
+        {
+          role: "user",
+          content: "What is 2+2?",
+        },
+      ],
+      usageMetadata: {
+        organizationName: "org-prompt-capture-demo",
+        productName: "prod-openai-prompt-capture",
+        capturePrompts: false,
+      },
+    });
+
+    console.log("Response:", response2.choices[0]?.message?.content);
+    console.log("\nPrompts NOT captured (overridden via metadata)!");
+  } catch (error) {
+    console.error(
+      "Error:",
+      error instanceof Error ? error.message : String(error),
+    );
+  }
+
+  console.log("\n" + "=".repeat(50) + "\n");
+  console.log("Example 3: Prompt capture with environment variable");
+  console.log("Set REVENIUM_CAPTURE_PROMPTS=true in your .env file\n");
+
+  console.log("Prompt capture examples completed!");
+  console.log("\nConfiguration hierarchy:");
+  console.log("1. Per-call metadata (highest priority)");
+  console.log("2. Global config");
+  console.log("3. Environment variable REVENIUM_CAPTURE_PROMPTS");
+  console.log("4. Default: false (lowest priority)");
+}
+
+main().catch(console.error);

package/examples/openai/responses-basic.ts

@@ -17,8 +17,8 @@ async function main() {
 
   // Create with metadata
   const metadata: UsageMetadata = {
-    organizationId: "org-responses-basic-demo",
-    productId: "prod-openai-responses-basic",
+    organizationName: "org-responses-basic-demo",
+    productName: "prod-openai-responses-basic",
   };
 
   try {
@@ -27,7 +27,7 @@ async function main() {
         model: "gpt-4",
         input: "What is the capital of France?",
       },
-      metadata
+      metadata,
     );
 
     // Display response
@@ -36,7 +36,7 @@ async function main() {
   } catch (error) {
     console.error("Error:", (error as Error).message);
     console.log(
-      "\nNote: Responses API is experimental and may not be available in all OpenAI SDK versions"
+      "\nNote: Responses API is experimental and may not be available in all OpenAI SDK versions",
     );
   }
 }

package/examples/openai/responses-embed.ts

@@ -13,8 +13,8 @@ async function main() {
 
   // Create with metadata
   const metadata: UsageMetadata = {
-    organizationId: "org-responses-embed-demo",
-    productId: "prod-openai-responses-embed",
+    organizationName: "org-responses-embed-demo",
+    productName: "prod-openai-responses-embed",
   };
 
   const embedding = await client.embeddings().create(
@@ -22,7 +22,7 @@ async function main() {
       model: "text-embedding-3-small",
       input: "Hello world",
     },
-    metadata
+    metadata,
   );
 
   console.log("Model:", embedding.model);

package/examples/openai/responses-streaming.ts

@@ -18,8 +18,8 @@ async function main() {
 
   // Create a metadata
   const metadata: UsageMetadata = {
-    organizationId: "org-responses-streaming-demo",
-    productId: "prod-openai-responses",
+    organizationName: "org-responses-streaming-demo",
+    productName: "prod-openai-responses",
     taskType: "creative-writing",
   };
 
@@ -31,7 +31,7 @@ async function main() {
         input: "Write a short poem about the ocean.",
         stream: true as const,
       },
-      metadata
+      metadata,
     );
 
     // Process the stream
@@ -55,7 +55,7 @@ async function main() {
     console.error("Error:", (error as Error).message);
     console.error("Stack:", (error as Error).stack);
     console.log(
-      "\nNote: Responses API is experimental and may not be available in all OpenAI SDK versions"
+      "\nNote: Responses API is experimental and may not be available in all OpenAI SDK versions",
     );
   }
 }

package/examples/openai/streaming.ts

@@ -15,8 +15,8 @@ async function main() {
 
   // Create a metadata
   const metadata: UsageMetadata = {
-    organizationId: "org-streaming-demo",
-    productId: "prod-openai-streaming",
+    organizationName: "org-streaming-demo",
+    productName: "prod-openai-streaming",
     taskType: "creative-writing",
     agent: "story-generator",
   };
@@ -41,7 +41,7 @@ async function main() {
         max_tokens: 1000,
         stream: true as const,
       },
-      metadata
+      metadata,
     );
 
   // Process the stream

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revenium/openai",
-  "version": "1.0.16",
+  "version": "1.1.1",
   "description": "Transparent TypeScript middleware for automatic Revenium usage tracking with OpenAI",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",