@revenium/openai 1.0.11 → 1.0.12

package/examples/azure-basic.ts

@@ -1,8 +1,17 @@
 /**
- * ️ Azure OpenAI Basic Example
+ * Azure OpenAI Basic Example
  *
  * Shows how to use Revenium middleware with Azure OpenAI chat completions and embeddings.
  * Demonstrates seamless metadata integration with Azure - all metadata fields are optional!
+ *
+ * Metadata Options:
+ * - Start with basic usage (no metadata) - tracking works automatically
+ * - Add subscriber info for user tracking
+ * - Include organization/product IDs for business analytics
+ * - Use task type and trace ID for detailed analysis
+ *
+ * For complete metadata field reference, see:
+ * https://revenium.readme.io/reference/meter_ai_completion
  */
 
 import 'dotenv/config';
@@ -73,29 +82,31 @@ async function azureBasicExample() {
         },
       ],
 
-      //  All metadata fields are optional - add what you need for Azure analytics!
-      // Note: Nested subscriber structure for consistency across language implementations
+      // Optional metadata for advanced reporting, lineage tracking, and cost allocation
       usageMetadata: {
-        // User tracking (optional) - nested subscriber object
+        // User identification
         subscriber: {
           id: 'azure-user-789',
           email: 'azure-dev@company.com',
           credential: {
-            name: 'azure-key',
-            value: 'azure789',
+            name: 'api-key-prod',
+            value: 'key-jkl-012',
           },
         },
 
-        // Business context (optional)
+        // Organization & billing
         organizationId: 'enterprise-corp',
-        productId: 'azure-ai-platform',
+        subscriptionId: 'plan-azure-enterprise-2024',
 
-        // Task classification (optional)
+        // Product & task tracking
+        productId: 'azure-ai-platform',
         taskType: 'azure-comparison',
-        traceId: `azure-${Date.now()}`,
-
-        // Azure-specific fields (optional)
         agent: 'azure-basic-chat-node',
+
+        // Session tracking
+        traceId: 'azure-' + Date.now(),
+
+        // Quality metrics
         responseQualityScore: 0.92,
       },
     });
@@ -148,8 +159,9 @@ async function azureBasicExample() {
           },
         },
         organizationId: 'enterprise-corp',
-        taskType: 'enterprise-document-embedding',
         productId: 'azure-search-platform',
+        subscriptionId: 'sub-azure-premium-999',
+        taskType: 'enterprise-document-embedding',
         traceId: `azure-embed-${Date.now()}`,
         agent: 'azure-basic-embeddings-node',
       },

package/examples/azure-responses-basic.ts

@@ -5,7 +5,16 @@
  * The Responses API is a new stateful API that brings together capabilities from chat completions
  * and assistants API in one unified experience.
  *
- * Reference: https://learn.microsoft.com/en-us/azure/ai-foundry/openai/how-to/responses
+ * Metadata Options:
+ * - Start with basic usage (no metadata) - tracking works automatically
+ * - Add subscriber info for user tracking
+ * - Include organization/product IDs for business analytics
+ * - Use task type and trace ID for detailed analysis
+ *
+ * For complete metadata field reference, see:
+ * https://revenium.readme.io/reference/meter_ai_completion
+ *
+ * Responses API Reference: https://learn.microsoft.com/en-us/azure/ai-foundry/openai/how-to/responses
  */
 
 import 'dotenv/config';
@@ -89,19 +98,29 @@ async function main() {
         temperature: 0.6,
         max_output_tokens: 200,
         usageMetadata: {
+          // User identification
           subscriber: {
             id: 'azure-enterprise-user-123',
             email: 'enterprise@azurecorp.com',
             credential: {
-              name: 'azure-enterprise-key',
-              value: 'azure-key-...',
+              name: 'api-key-prod',
+              value: 'key-stu-901',
             },
           },
+
+          // Organization & billing
           organizationId: 'azure-enterprise-org-456',
+          subscriptionId: 'plan-azure-responses-2024',
+
+          // Product & task tracking
           productId: 'azure-ai-integration-assistant',
           taskType: 'enterprise-architecture-guidance',
-          traceId: 'azure-trace-789',
           agent: 'azure-ai-architect',
+
+          // Session tracking
+          traceId: 'azure-trace-789',
+
+          // Quality metrics
           responseQualityScore: 0.96,
         },
       } as ResponsesCreateParams);
@@ -167,19 +186,29 @@ async function main() {
         instructions:
           'You are an Azure AI solutions architect providing detailed technical guidance.',
         usageMetadata: {
+          // User identification
           subscriber: {
             id: 'azure-saas-architect-789',
             email: 'architect@azuresaas.com',
             credential: {
-              name: 'azure-saas-enterprise-key',
-              value: 'azure-saas-key-...',
+              name: 'api-key-prod',
+              value: 'key-vwx-234',
             },
           },
+
+          // Organization & billing
           organizationId: 'azure-saas-enterprise-012',
+          subscriptionId: 'plan-azure-saas-2024',
+
+          // Product & task tracking
           productId: 'azure-saas-ai-architect',
           taskType: 'multi-tenant-architecture-design',
-          traceId: 'azure-saas-trace-345',
           agent: 'azure-saas-solutions-architect',
+
+          // Session tracking
+          traceId: 'azure-saas-trace-345',
+
+          // Quality metrics
           responseQualityScore: 0.99,
         },
       } as ResponsesCreateParams);

package/examples/azure-responses-streaming.ts

@@ -5,7 +5,16 @@
  * using the Revenium middleware. The Responses API supports streaming for real-time
  * response generation in Azure environments.
  *
- * Reference: https://learn.microsoft.com/en-us/azure/ai-foundry/openai/how-to/responses
+ * Metadata Options:
+ * - Start with basic usage (no metadata) - tracking works automatically
+ * - Add subscriber info for user tracking
+ * - Include organization/product IDs for business analytics
+ * - Use task type and trace ID for detailed analysis
+ *
+ * For complete metadata field reference, see:
+ * https://revenium.readme.io/reference/meter_ai_completion
+ *
+ * Responses API Reference: https://learn.microsoft.com/en-us/azure/ai-foundry/openai/how-to/responses
  */
 
 import 'dotenv/config';
@@ -94,19 +103,29 @@ async function main() {
         temperature: 0.7,
         max_output_tokens: 250,
         usageMetadata: {
+          // User identification
           subscriber: {
             id: 'azure-security-expert-123',
             email: 'security@azureenterprise.com',
             credential: {
-              name: 'azure-security-key',
-              value: 'azure-sec-key-...',
+              name: 'api-key-prod',
+              value: 'key-yza-567',
             },
           },
+
+          // Organization & billing
           organizationId: 'azure-security-org-456',
+          subscriptionId: 'plan-azure-security-2024',
+
+          // Product & task tracking
           productId: 'azure-ai-security-advisor',
           taskType: 'enterprise-security-streaming',
-          traceId: 'azure-security-trace-789',
           agent: 'azure-security-architect',
+
+          // Session tracking
+          traceId: 'azure-security-trace-789',
+
+          // Quality metrics
           responseQualityScore: 0.94,
         },
       } as ResponsesCreateParams);
@@ -186,19 +205,29 @@ async function main() {
         instructions:
           'You are an Azure solutions architect specializing in scalable AI implementations with enterprise governance.',
         usageMetadata: {
+          // User identification
           subscriber: {
             id: 'azure-enterprise-architect-789',
             email: 'architect@azureenterprise.com',
             credential: {
-              name: 'azure-enterprise-streaming-key',
-              value: 'azure-ent-stream-key-...',
+              name: 'api-key-prod',
+              value: 'key-bcd-890',
             },
           },
+
+          // Organization & billing
           organizationId: 'azure-enterprise-streaming-012',
+          subscriptionId: 'plan-azure-scalable-2024',
+
+          // Product & task tracking
           productId: 'azure-scalable-ai-architect',
           taskType: 'enterprise-scalable-ai-streaming',
-          traceId: 'azure-scalable-trace-345',
           agent: 'azure-enterprise-solutions-architect',
+
+          // Session tracking
+          traceId: 'azure-scalable-trace-345',
+
+          // Quality metrics
           responseQualityScore: 0.98,
         },
       } as ResponsesCreateParams);

package/examples/azure-streaming.ts

@@ -1,8 +1,17 @@
 /**
- * ️ Azure OpenAI Streaming Example
+ * Azure OpenAI Streaming Example
  *
  * Shows how to use Revenium middleware with Azure OpenAI streaming responses.
  * Demonstrates seamless metadata integration with Azure streaming - all metadata fields are optional!
+ *
+ * Metadata Options:
+ * - Start with basic usage (no metadata) - tracking works automatically
+ * - Add subscriber info for user tracking
+ * - Include organization/product IDs for business analytics
+ * - Use task type and trace ID for detailed analysis
+ *
+ * For complete metadata field reference, see:
+ * https://revenium.readme.io/reference/meter_ai_completion
  */
 
 import 'dotenv/config';
@@ -83,29 +92,31 @@ async function azureStreamingExample() {
     ],
     stream: true,
 
-    //  All metadata fields are optional - add what you need for Azure enterprise analytics!
-    // Note: Nested subscriber structure matches Python middleware implementation
+    // Optional metadata for advanced reporting, lineage tracking, and cost allocation
     usageMetadata: {
-      // User tracking (optional) - nested subscriber object
+      // User identification
       subscriber: {
         id: 'azure-stream-user-789',
         email: 'enterprise@company.com',
         credential: {
-          name: 'azure-stream-key',
-          value: 'stream789',
+          name: 'api-key-prod',
+          value: 'key-mno-345',
         },
       },
 
-      // Business context (optional)
+      // Organization & billing
       organizationId: 'enterprise-corp',
-      productId: 'azure-ai-consultant',
+      subscriptionId: 'plan-azure-stream-2024',
 
-      // Task classification (optional)
+      // Product & task tracking
+      productId: 'azure-ai-consultant',
       taskType: 'enterprise-consultation',
-      traceId: `azure-stream-${Date.now()}`,
+      agent: 'azure-streaming-chat-node',
+
+      // Session tracking
+      traceId: 'azure-stream-' + Date.now(),
 
-      // Azure-specific fields (optional)
-      agent: 'azure-streaming-chat-metadata-node',
+      // Quality metrics
       responseQualityScore: 0.95,
     },
   });
@@ -148,22 +159,32 @@ async function azureStreamingExample() {
       'Enterprise document: Integration with Azure Active Directory',
     ],
 
-    //  All metadata fields are optional - perfect for Azure enterprise document processing!
-    // Note: Nested subscriber structure for consistency across language implementations
+    // Optional metadata for advanced reporting, lineage tracking, and cost allocation
     usageMetadata: {
+      // User identification
       subscriber: {
         id: 'azure-enterprise-processor',
         email: 'processor@enterprise-corp.com',
         credential: {
-          name: 'azure-enterprise-key',
-          value: 'enterprise789',
+          name: 'api-key-prod',
+          value: 'key-pqr-678',
         },
       },
+
+      // Organization & billing
       organizationId: 'enterprise-corp',
-      taskType: 'enterprise-document-processing',
+      subscriptionId: 'plan-azure-enterprise-2024',
+
+      // Product & task tracking
       productId: 'azure-document-intelligence',
-      traceId: `azure-enterprise-${Date.now()}`,
-      agent: 'azure-batch-embeddings-metadata-node',
+      taskType: 'enterprise-document-processing',
+      agent: 'azure-batch-embeddings-node',
+
+      // Session tracking
+      traceId: 'azure-enterprise-' + Date.now(),
+
+      // Quality metrics
+      responseQualityScore: 0.96,
     },
   });
 

package/examples/getting_started.ts

@@ -0,0 +1,54 @@
+import 'dotenv/config';
+import { initializeReveniumFromEnv, patchOpenAIInstance } from '@revenium/openai';
+import OpenAI from 'openai';
+
+async function main() {
+  const initResult = initializeReveniumFromEnv();
+  if (!initResult.success) {
+    console.error('Failed to initialize Revenium:', initResult.message);
+    process.exit(1);
+  }
+
+  const openai = patchOpenAIInstance(new OpenAI());
+
+  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.' }
+    ],
+
+    /* 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'
+        }
+      },
+
+      // 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
+    }
+    */
+  });
+
+  console.log('Response:', response.choices[0]?.message?.content);
+}
+
+main().catch(console.error);

package/examples/openai-basic.ts

@@ -3,6 +3,15 @@
  *
  * Shows how to use Revenium middleware with OpenAI chat completions and embeddings.
  * Demonstrates seamless metadata integration - all metadata fields are optional!
+ *
+ * Metadata Options:
+ * - Start with basic usage (no metadata) - tracking works automatically
+ * - Add subscriber info for user tracking
+ * - Include organization/product IDs for business analytics
+ * - Use task type and trace ID for detailed analysis
+ *
+ * For complete metadata field reference, see:
+ * https://revenium.readme.io/reference/meter_ai_completion
  */
 
 import 'dotenv/config';
@@ -45,29 +54,32 @@ async function openaiBasicExample() {
       { role: 'user', content: 'Explain the benefits of using middleware in 2 sentences.' },
     ],
 
-    //  All metadata fields are optional - add what you need!
-    // Note: Nested subscriber structure matches Python middleware for consistency
+    // Optional metadata for advanced reporting, lineage tracking, and cost allocation
     usageMetadata: {
-      // User tracking (optional) - nested subscriber object
+      // User identification
       subscriber: {
         id: 'user-12345',
         email: 'developer@company.com',
         credential: {
-          name: 'api-key',
-          value: 'key123',
+          name: 'api-key-prod',
+          value: 'key-abc-123',
         },
       },
 
-      // Business context (optional)
+      // Organization & billing
       organizationId: 'my-customer',
-      productId: 'ai-assistant',
+      subscriptionId: 'plan-premium-2024',
 
-      // Task classification (optional)
+      // Product & task tracking
+      productId: 'ai-assistant',
       taskType: 'explanation-request',
-      traceId: `session-${Date.now()}`,
-
-      // Custom fields (optional)
       agent: 'openai-basic-chat-node',
+
+      // Session tracking
+      traceId: 'session-' + Date.now(),
+
+      // Quality metrics
+      responseQualityScore: 0.95,
     },
   });
 
@@ -96,22 +108,32 @@ async function openaiBasicExample() {
     model: 'text-embedding-3-small',
     input: 'Advanced text embedding with comprehensive tracking metadata',
 
-    //  All metadata fields are optional - customize for your use case!
-    // Note: Nested subscriber structure for consistency across language implementations
+    // Optional metadata for advanced reporting, lineage tracking, and cost allocation
     usageMetadata: {
+      // User identification
       subscriber: {
         id: 'embedding-user-789',
         email: 'embeddings@company.com',
         credential: {
-          name: 'embed-key',
-          value: 'embed123',
+          name: 'api-key-prod',
+          value: 'key-def-456',
         },
       },
+
+      // Organization & billing
       organizationId: 'my-company',
-      taskType: 'document-embedding',
+      subscriptionId: 'plan-enterprise-2024',
+
+      // Product & task tracking
       productId: 'search-engine',
-      traceId: `embed-${Date.now()}`,
+      taskType: 'document-embedding',
       agent: 'openai-basic-embeddings-node',
+
+      // Session tracking
+      traceId: 'embed-' + Date.now(),
+
+      // Quality metrics
+      responseQualityScore: 0.98,
     },
   });