@revenium/openai 1.0.12 → 1.0.14

package/examples/azure/basic.ts

@@ -0,0 +1,62 @@
+/**
+ * Azure OpenAI Example
+ * Demonstrates usage with Azure OpenAI.
+ */
+
+import { Initialize, GetClient, UsageMetadata } from "@revenium/openai";
+
+async function main() {
+  // Initialize the middleware
+  Initialize();
+
+  // Get the client
+  const client = GetClient();
+
+  // Create a metadata
+  const metadata: UsageMetadata = {
+    organizationId: "org-azure-demo",
+    productId: "prod-azure-integration",
+    taskType: "question-answering",
+    agent: "azure-assistant",
+  };
+
+  // Create a chat completion
+  // IMPORTANT: For Azure OpenAI, the Model parameter must be your DEPLOYMENT NAME
+  // This is the name you gave to your deployment in Azure Portal, NOT the OpenAI model name
+  // Example: If you created a deployment called "gpt-5-mini-2" in Azure, use that name here
+  //
+
+  const response = await client
+    .chat()
+    .completions()
+    .create(
+      {
+        // NOTE: Make sure REVENIUM_AZURE_DISABLE=0 in your .env file to enable Azure
+        // If Azure is disabled, this will fail because "gpt-5-mini-2" is not a valid OpenAI model name
+        model: "gpt-5-mini-2", // Your Azure deployment name (requires REVENIUM_AZURE_DISABLE=0)
+        messages: [
+          {
+            role: "system" as const,
+            content:
+              "You are a helpful assistant that explains cloud computing concepts.",
+          },
+          {
+            role: "user" as const,
+            content:
+              "Explain the difference between Azure OpenAI and OpenAI native API in 2-3 sentences.",
+          },
+        ],
+        max_completion_tokens: 2000, // Increased for reasoning models (gpt-5-mini uses reasoning tokens)
+        // Note: Reasoning models like gpt-5-mini only support default temperature (1.0)
+      },
+      metadata
+    );
+
+  // Display the response
+  if (response.choices.length > 0) {
+    console.log(`Assistant: ${response.choices[0].message.content}`);
+  }
+  console.log("\nUsage data sent to Revenium! Check your dashboard");
+}
+
+main().catch(console.error);

package/examples/azure/responses-basic.ts

@@ -0,0 +1,45 @@
+/**
+ * Azure Responses  API Basic Example
+ *
+ * Demonstrates usage of the OpenAI Responses API with Azure OpenAI (stateful API).
+ * The Responses API is experimental and may not be available in all SDK versions.
+ *
+ * Reference: https://platform.openai.com/docs/api-reference/responses
+ */
+
+import { Initialize, GetClient, UsageMetadata } from "@revenium/openai";
+
+async function main() {
+  // Initialize middleware
+  Initialize();
+
+  // Get client
+  const client = GetClient();
+
+  // Create a metadata
+  const metadata: UsageMetadata = {
+    organizationId: "org-azure-responses",
+    productId: "prod-azure-responses",
+  };
+
+  try {
+    const response = await client.responses().create(
+      {
+        model: "gpt-5-mini-2", // Your Azure deployment name
+        input: "What is the capital of France?",
+      },
+      metadata
+    );
+
+    // Display response
+    console.log("Assistant:", response.output_text);
+    console.log("\nUsage data sent to Revenium! Check your dashboard");
+  } 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"
+    );
+  }
+}
+
+main().catch(console.error);

package/examples/azure/responses-stream.ts

@@ -0,0 +1,61 @@
+/**
+ * Azure Responses API Streaming Example
+ *
+ * Demonstrates streaming usage of the OpenAI Responses API with Azure OpenAI (stateful API).
+ * The Responses API is experimental and may not be available in all SDK versions.
+ *
+ * Reference: https://platform.openai.com/docs/api-reference/responses
+ */
+
+import { Initialize, GetClient, UsageMetadata } from "@revenium/openai";
+
+async function main() {
+  // Initialize middleware
+  Initialize();
+
+  // Get client
+  const client = GetClient();
+
+  // Create a metadata
+  const metadata: UsageMetadata = {
+    organizationId: "org-azure-responses-streaming-demo",
+    productId: "prod-azure-responses",
+    taskType: "creative-writing",
+  };
+
+  try {
+    const wrapper = await client.responses().createStreaming(
+      {
+        // Create a streaming response using the Responses API
+        model: "gpt-5-mini-2", // Your Azure deployment name
+        input: "Write a short poem about the ocean.",
+        stream: true as const,
+      },
+      metadata
+    );
+
+    // Process the stream
+    process.stdout.write("Assistant: ");
+    let hasContent = false;
+    for await (const chunk of wrapper) {
+      // Responses API streaming uses ResponseTextDeltaEvent
+      if (chunk.type === "response.output_text.delta" && chunk.delta) {
+        hasContent = true;
+        process.stdout.write(chunk.delta);
+      }
+    }
+    if (!hasContent) {
+      console.log("(no content received)");
+    }
+
+    console.log("\n");
+    console.log("\nUsage data sent to Revenium! Check your dashboard");
+  } 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"
+    );
+  }
+}
+
+main().catch(console.error);

package/examples/azure/stream.ts

@@ -0,0 +1,56 @@
+/**
+ * Azure Streaming Example
+ * Demonstrates streaming chat completions with Azure OpenAI and Revenium tracking.
+ */
+
+import { Initialize, GetClient, UsageMetadata } from "@revenium/openai";
+
+async function main() {
+  // Initialize middleware
+  Initialize();
+
+  // Get client
+  const client = GetClient();
+
+  // Create a metadata
+  const metadata: UsageMetadata = {
+    organizationId: "org-azure-streaming",
+    productId: "prod-azure-integration",
+    taskType: "creative-writing",
+    agent: "azure-poet",
+  };
+  const wrapper = await client
+    .chat()
+    .completions()
+    .createStreaming(
+      {
+        model: "gpt-5-mini-2", // Your Azure deployment name
+        messages: [
+          {
+            role: "system" as const,
+            content: "You are a creative poet.",
+          },
+          {
+            role: "user" as const,
+            content:
+              "Write a short poem about artificial intelligence and its impact on humanity.",
+          },
+        ],
+        max_completion_tokens: 2000,
+        stream: true as const,
+      },
+      metadata
+    );
+
+  // Process the stream
+  process.stdout.write("Assistant: ");
+  for await (const chunk of wrapper) {
+    if (chunk.choices.length > 0 && chunk.choices[0].delta.content) {
+      process.stdout.write(chunk.choices[0].delta.content);
+    }
+  }
+  console.log("\n");
+  console.log("\nUsage data sent to Revenium! Check your dashboard");
+}
+
+main().catch(console.error);

package/examples/getting_started.ts

@@ -1,54 +1,42 @@
-import 'dotenv/config';
-import { initializeReveniumFromEnv, patchOpenAIInstance } from '@revenium/openai';
-import OpenAI from 'openai';
+/**
+ * Getting Started Example
+ *
+ * This is the simplest way to get started with Revenium OpenAI middleware.
+ * Just initialize and start making requests!
+ * Note: .env files are loaded automatically by the middleware.
+ */
+
+import { Initialize, GetClient } from "@revenium/openai";
 
 async function main() {
-  const initResult = initializeReveniumFromEnv();
-  if (!initResult.success) {
-    console.error('Failed to initialize Revenium:', initResult.message);
-    process.exit(1);
-  }
+  // Initialize middleware
+  Initialize();
 
-  const openai = patchOpenAIInstance(new OpenAI());
+  // Get client
+  const client = GetClient();
 
-  const response = await openai.chat.completions.create({
-    model: 'gpt-4o-mini',
-    messages: [
-      { role: 'system', content: 'You are a helpful assistant.' },
-      { role: 'user', content: 'Please verify you are ready to assist me.' }
-    ],
+  // Create metadata
+  const metadata = {
+    organizationId: "org-getting-started-demo",
+    productId: "prod-getting-started",
+  };
 
-    /* Optional metadata for advanced reporting, lineage tracking, and cost allocation
-    usageMetadata: {
-      // User identification
-      subscriber: {
-        id: 'user-123',
-        email: 'user@example.com',
-        credential: {
-          name: 'api-key-prod',
-          value: 'key-abc-123'
-        }
+  // Make request
+  const params = {
+    model: "gpt-4",
+    messages: [
+      {
+        role: "user" as const,
+        content: "Hello! Introduce yourself in one sentence.",
       },
+    ],
+  };
 
-      // Organization & billing
-      organizationId: 'my-customers-name',
-      subscriptionId: 'plan-enterprise-2024',
-
-      // Product & task tracking
-      productId: 'my-product',
-      taskType: 'doc-summary',
-      agent: 'customer-support',
-
-      // Session tracking
-      traceId: 'session-' + Date.now(),
-
-      // Quality metrics
-      responseQualityScore: 0.95
-    }
-    */
-  });
+  const response = await client.chat().completions().create(params, metadata);
 
-  console.log('Response:', response.choices[0]?.message?.content);
+  // Display response
+  console.log(response.choices[0].message.content);
+  console.log("\nUsage data sent to Revenium!");
 }
 
 main().catch(console.error);

package/examples/openai/basic.ts

@@ -0,0 +1,45 @@
+/**
+ * Basic Example
+ * Demonstrates basic usage of Revenium OpenAI middleware.
+ */
+
+import { Initialize, GetClient, UsageMetadata } from "@revenium/openai";
+
+async function main() {
+  // Initialize middleware
+  Initialize();
+
+  // Get client
+  const client = GetClient();
+  const metadata: UsageMetadata = {
+    organizationId: "org-basic-demo",
+    productId: "prod-openai-basic",
+  };
+
+  // Create chat completion
+  const response = await client
+    .chat()
+    .completions()
+    .create(
+      {
+        model: "gpt-4",
+        messages: [
+          {
+            role: "user" as const,
+            content:
+              "Say hello in Spanish and explain why Spanish is a beautiful language in 2-3 sentences.",
+          },
+        ],
+        max_tokens: 1000,
+      },
+      metadata
+    );
+
+  // Display response
+  if (response.choices.length > 0) {
+    console.log(`Assistant: ${response.choices[0].message.content}`);
+  }
+  console.log("\nUsage data sent to Revenium! Check your dashboard");
+}
+
+main().catch(console.error);

package/examples/openai/metadata.ts

@@ -0,0 +1,67 @@
+/**
+ * Metadata Example
+ * Demonstrates basic usage of Revenium OpenAI middleware.
+ */
+
+import { Initialize, GetClient, UsageMetadata } from "@revenium/openai";
+
+async function main() {
+  // Initialize middleware
+  Initialize();
+
+  // Get client
+  const client = GetClient();
+
+  // Optional metadata for advanced reporting, lineage tracking, and cost allocation
+  const metadata: UsageMetadata = {
+    // Organization & billing
+    organizationId: "org-metadata-demo",
+    subscriptionId: "plan-premium-2025",
+
+    // Product & task tracking
+    productId: "ai-assistant",
+    taskType: "explanation-request",
+    agent: "openai-metadata-chat-node",
+
+    // Session tracking
+    traceId: "session-" + Date.now(),
+
+    // Quality metrics
+    responseQualityScore: 0.95, // 0.0-1.0 scale
+
+    // User tracking
+    subscriber: {
+      id: "user-12345",
+      email: "developer@company.com",
+      credential: {
+        name: "api-key-prod",
+        value: "key-abc-123",
+      },
+    },
+  };
+  const response = await client
+    .chat()
+    .completions()
+    .create(
+      {
+        model: "gpt-4",
+        messages: [
+          {
+            role: "user" as const,
+            content:
+              "Say hello in Spanish and explain why Spanish is a beautiful language in 2-3 sentences.",
+          },
+        ],
+        max_tokens: 1000,
+      },
+      metadata
+    );
+
+  // Display response
+  if (response.choices.length > 0) {
+    console.log(`Assistant: ${response.choices[0].message.content}`);
+  }
+  console.log("\nUsage data sent to Revenium! Check your dashboard");
+}
+
+main().catch(console.error);

package/examples/openai/responses-basic.ts

@@ -0,0 +1,44 @@
+/**
+ * Responses API + Basic Example
+ *
+ * Demonstrates usage of the OpenAI Responses API (stateful API).
+ * The Responses API is experimental and may not be available in all SDK versions.
+ * Reference: https://platform.openai.com/docs/api-reference/responses
+ */
+
+import { Initialize, GetClient, UsageMetadata } from "@revenium/openai";
+
+async function main() {
+  // Initialize middleware
+  Initialize();
+
+  // Get client
+  const client = GetClient();
+
+  // Create with metadata
+  const metadata: UsageMetadata = {
+    organizationId: "org-responses-basic-demo",
+    productId: "prod-openai-responses-basic",
+  };
+
+  try {
+    const response = await client.responses().create(
+      {
+        model: "gpt-4",
+        input: "What is the capital of France?",
+      },
+      metadata
+    );
+
+    // Display response
+    console.log("Assistant:", response.output_text);
+    console.log("\nUsage data sent to Revenium! Check your dashboard");
+  } 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"
+    );
+  }
+}
+
+main().catch(console.error);

package/examples/openai/responses-embed.ts

@@ -0,0 +1,34 @@
+/**
+ * Responses API + Embeddings Example
+ * Demonstrates basic embeddings usage with Revenium OpenAI middleware.
+ */
+
+import { Initialize, GetClient, UsageMetadata } from "@revenium/openai";
+async function main() {
+  // Initialize middleware
+  Initialize();
+
+  // Get client
+  const client = GetClient();
+
+  // Create with metadata
+  const metadata: UsageMetadata = {
+    organizationId: "org-responses-embed-demo",
+    productId: "prod-openai-responses-embed",
+  };
+
+  const embedding = await client.embeddings().create(
+    {
+      model: "text-embedding-3-small",
+      input: "Hello world",
+    },
+    metadata
+  );
+
+  console.log("Model:", embedding.model);
+  console.log("Usage:", embedding.usage);
+  console.log("Embedding dimensions:", embedding.data[0]?.embedding.length);
+  console.log("\nUsage data sent to Revenium! Check your dashboard");
+}
+
+main().catch(console.error);

package/examples/openai/responses-streaming.ts

@@ -0,0 +1,63 @@
+/**
+ * Responses API + Streaming Example
+ *
+ * Demonstrates streaming usage of the OpenAI Responses API (stateful API).
+ * The Responses API is experimental and may not be available in all SDK versions.
+ *
+ * Reference: https://platform.openai.com/docs/api-reference/responses
+ */
+
+import { Initialize, GetClient, UsageMetadata } from "@revenium/openai";
+
+async function main() {
+  // Initialize middleware
+  Initialize();
+
+  // Get client
+  const client = GetClient();
+
+  // Create a metadata
+  const metadata: UsageMetadata = {
+    organizationId: "org-responses-streaming-demo",
+    productId: "prod-openai-responses",
+    taskType: "creative-writing",
+  };
+
+  try {
+    console.log("Creating streaming response with Responses API...");
+    const wrapper = await client.responses().createStreaming(
+      {
+        model: "gpt-4",
+        input: "Write a short poem about the ocean.",
+        stream: true as const,
+      },
+      metadata
+    );
+
+    // Process the stream
+    process.stdout.write("Assistant: ");
+    let hasContent = false;
+    for await (const chunk of wrapper) {
+      // Responses API streaming uses ResponseTextDeltaEvent
+      if (chunk.type === "response.output_text.delta" && chunk.delta) {
+        hasContent = true;
+        process.stdout.write(chunk.delta);
+      }
+    }
+
+    if (!hasContent) {
+      console.log("\nNo content received from stream");
+    }
+
+    console.log("\n");
+    console.log("\nUsage data sent to Revenium! Check your dashboard");
+  } catch (error) {
+    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"
+    );
+  }
+}
+
+main().catch(console.error);

package/examples/openai/streaming.ts

@@ -0,0 +1,59 @@
+/**
+ * Streaming Example
+ *
+ * Demonstrates streaming chat completions with Revenium tracking.
+ */
+
+import { Initialize, GetClient, UsageMetadata } from "@revenium/openai";
+
+async function main() {
+  // Initialize middleware
+  Initialize();
+
+  // Get client
+  const client = GetClient();
+
+  // Create a metadata
+  const metadata: UsageMetadata = {
+    organizationId: "org-streaming-demo",
+    productId: "prod-openai-streaming",
+    taskType: "creative-writing",
+    agent: "story-generator",
+  };
+
+  const wrapper = await client
+    .chat()
+    .completions()
+    .createStreaming(
+      {
+        model: "gpt-4",
+        messages: [
+          {
+            role: "system" as const,
+            content: "You are a creative poet.",
+          },
+          {
+            role: "user" as const,
+            content:
+              "Write a short poem about artificial intelligence and its impact on humanity.",
+          },
+        ],
+        max_tokens: 1000,
+        stream: true as const,
+      },
+      metadata
+    );
+
+  // Process the stream
+  process.stdout.write("Assistant: ");
+  for await (const chunk of wrapper) {
+    if (chunk.choices.length > 0 && chunk.choices[0].delta.content) {
+      process.stdout.write(chunk.choices[0].delta.content);
+    }
+  }
+
+  console.log("\n");
+  console.log("\nUsage data sent to Revenium! Check your dashboard");
+}
+
+main().catch(console.error);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revenium/openai",
-  "version": "1.0.12",
+  "version": "1.0.14",
   "description": "Transparent TypeScript middleware for automatic Revenium usage tracking with OpenAI",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -25,15 +25,18 @@
     "dev": "tsc --watch",
     "clean": "node -e \"const fs = require('fs'); if (fs.existsSync('dist')) fs.rmSync('dist', {recursive: true, force: true})\"",
     "prepublishOnly": "npm run clean && npm run build",
-    "example:openai-basic": "npm run build && npx ts-node examples/openai-basic.ts",
-    "example:openai-streaming": "npm run build && npx ts-node examples/openai-streaming.ts",
-    "example:azure-basic": "npm run build && npx ts-node examples/azure-basic.ts",
-    "example:azure-streaming": "npm run build && npx ts-node examples/azure-streaming.ts",
-    "example": "npm run example:openai-basic",
-    "example:openai-responses-basic": "npm run build && npx ts-node examples/openai-responses-basic.ts",
-    "example:openai-responses-streaming": "npm run build && npx ts-node examples/openai-responses-streaming.ts",
-    "example:azure-responses-basic": "npm run build && npx ts-node examples/azure-responses-basic.ts",
-    "example:azure-responses-streaming": "npm run build && npx ts-node examples/azure-responses-streaming.ts"
+    "example:getting-started": "npm run build && npx tsx examples/getting_started.ts",
+    "example:openai-basic": "npm run build && npx tsx examples/openai/basic.ts",
+    "example:openai-metadata": "npm run build && npx tsx examples/openai/metadata.ts",
+    "example:openai-stream": "npm run build && npx tsx examples/openai/streaming.ts",
+    "example:openai-res-basic": "npm run build && npx tsx examples/openai/responses-basic.ts",
+    "example:openai-res-embed": "npm run build && npx tsx examples/openai/responses-embed.ts",
+    "example:openai-res-stream": "npm run build && npx tsx examples/openai/responses-streaming.ts",
+    "example:azure-basic": "npm run build && npx tsx examples/azure/basic.ts",
+    "example:azure-stream": "npm run build && npx tsx examples/azure/stream.ts",
+    "example:azure-res-basic": "npm run build && npx tsx examples/azure/responses-basic.ts",
+    "example:azure-res-stream": "npm run build && npx tsx examples/azure/responses-stream.ts",
+    "example": "npm run example:getting-started"
   },
   "keywords": [
     "openai",
@@ -68,14 +71,18 @@
   },
   "files": [
     "dist/**/*",
-    "src/**/*",
     "examples/**/*",
+    "!examples/.claude/**",
+    "!examples/**/*.log",
     ".env.example",
     "README.md",
     "CHANGELOG.md",
-    "LICENSE"
+    "LICENSE",
+    "CONTRIBUTING.md",
+    "SECURITY.md",
+    "CODE_OF_CONDUCT.md"
   ],
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.0.0"
   }
 }