@revenium/openai 1.0.12 → 1.0.13

package/.env.example

@@ -4,17 +4,17 @@
 # Required: Your Revenium API key (starts with hak_)
 REVENIUM_METERING_API_KEY=hak_your_revenium_api_key_here
 
-# Optional: Revenium API base URL (defaults to https://api.revenium.io)
-#REVENIUM_METERING_BASE_URL=https://api.revenium.io
+# Optional: Revenium API base URL (defaults to https://api.revenium.ai)
+#REVENIUM_METERING_BASE_URL=https://api.revenium.ai
 
 # Required: Your OpenAI API key (starts with sk-)
 OPENAI_API_KEY=sk_your_openai_api_key_here
 
-# Optional: Your Azure OpenAI configuration (for Azure testing)
-AZURE_OPENAI_ENDPOINT=https://your-resource-name.openai.azure.com/
-AZURE_OPENAI_API_KEY=your-azure-openai-api-key-here
-AZURE_OPENAI_DEPLOYMENT=your-deployment-name-here
-AZURE_OPENAI_API_VERSION=2024-12-01-preview
+# Optional: Azure OpenAI configuration (uncomment if using Azure)
+#AZURE_OPENAI_ENDPOINT=https://your-resource-name.openai.azure.com/
+#AZURE_OPENAI_API_KEY=your-azure-openai-api-key-here
+#AZURE_OPENAI_DEPLOYMENT=your-deployment-name-here
+#AZURE_OPENAI_API_VERSION=2024-12-01-preview
 
 # Optional: Enable debug logging
-REVENIUM_DEBUG=false
+#REVENIUM_DEBUG=true

package/CHANGELOG.md

@@ -5,6 +5,31 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.13] - 2025-11-06
+
+### Added
+- configure() function for manual configuration (simpler alias for initializeRevenium)
+- Support for COST_LIMIT and COMPLETION_LIMIT stop reasons
+- Support for all 7 operationType enum values (CHAT, GENERATE, EMBED, CLASSIFY, SUMMARIZE, TRANSLATE, OTHER)
+
+### Changed
+- **BREAKING:** responseQualityScore now uses 0.0-1.0 scale (was 0-100) per updated API specification
+- API endpoint updated from api.revenium.io to api.revenium.ai (new production domain)
+- Improved API compliance with proper enum values and field casing
+- Enhanced token counting accuracy for cache operations
+- Email addresses now masked in debug logs for PII protection
+- All examples updated to use 0.0-1.0 scale for responseQualityScore
+
+### Fixed
+- Improved documentation accuracy and removed deprecated configuration options
+- config.debug property now properly enables debug logging
+- Manual configuration example now includes required patchOpenAIInstance call
+- Updated OpenAI version requirement to match peer dependency (v5.0.0+)
+- Enhanced metadata validation for responseQualityScore scale
+- Improved provider detection fallback handling
+- Fixed cache token reporting for embeddings API
+- reasoningTokenCount now correctly optional based on provider support
+
 ## [1.0.12] - 2025-10-30
 
 ### Changed
@@ -45,6 +70,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Azure OpenAI support
 - TypeScript support with native type integration
 
+[1.0.13]: https://github.com/revenium/revenium-middleware-openai-node/releases/tag/v1.0.13
 [1.0.12]: https://github.com/revenium/revenium-middleware-openai-node/releases/tag/v1.0.12
 [1.0.11]: https://github.com/revenium/revenium-middleware-openai-node/releases/tag/v1.0.11
 [1.0.10]: https://github.com/revenium/revenium-middleware-openai-node/releases/tag/v1.0.10

package/README.md

@@ -3,6 +3,7 @@
 [![npm version](https://img.shields.io/npm/v/@revenium/openai.svg)](https://www.npmjs.com/package/@revenium/openai)
 [![Node.js](https://img.shields.io/badge/Node.js-16%2B-green)](https://nodejs.org/)
 [![Documentation](https://img.shields.io/badge/docs-revenium.io-blue)](https://docs.revenium.io)
+[![Website](https://img.shields.io/badge/website-revenium.ai-blue)](https://www.revenium.ai)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 **Transparent TypeScript middleware for automatic Revenium usage tracking with OpenAI**
@@ -12,8 +13,8 @@ A professional-grade Node.js middleware that seamlessly integrates with OpenAI a
 ## Features
 
 - **Seamless Integration** - Native TypeScript support, no type casting required
-- **Optional Metadata** - Track users, organizations, and custom metadata (all fields optional)
-- **Dual API Support** - Chat Completions API + new Responses API (OpenAI SDK 5.8+)
+- **Optional Metadata** - Track users, organizations, and business context (12 predefined fields, all optional)
+- **Dual API Support** - Chat Completions API + Responses API
 - **Azure OpenAI Support** - Full Azure OpenAI integration with automatic detection
 - **Type Safety** - Complete TypeScript support with IntelliSense
 - **Streaming Support** - Handles regular and streaming requests seamlessly
@@ -44,7 +45,7 @@ Create a `.env` file:
 **NOTE: YOU MUST REPLACE THE PLACEHOLDERS WITH YOUR OWN API KEYS**
 
 ```env
-REVENIUM_METERING_BASE_URL=https://api.revenium.io
+REVENIUM_METERING_BASE_URL=https://api.revenium.ai
 REVENIUM_METERING_API_KEY=hak_your_revenium_api_key_here
 OPENAI_API_KEY=sk_your_openai_api_key_here
 ```
@@ -74,7 +75,7 @@ $env:REVENIUM_DEBUG="true"; npx tsx node_modules/@revenium/openai/examples/getti
 ## Requirements
 
 - Node.js 16+
-- OpenAI package v4.0+
+- OpenAI package v5.0.0 or later
 - TypeScript 5.0+ (for TypeScript projects)
 
 ---
@@ -95,7 +96,7 @@ The middleware automatically captures comprehensive usage data:
 - **User Tracking** - Subscriber ID, email, credentials
 - **Organization Data** - Organization ID, subscription ID, product ID
 - **Task Classification** - Task type, agent identifier, trace ID
-- **Quality Metrics** - Response quality scores, custom metadata
+- **Quality Metrics** - Response quality scores, task identifiers
 
 ### **Technical Details**
 
@@ -104,226 +105,6 @@ The middleware automatically captures comprehensive usage data:
 - **Error Tracking** - Failed requests, error types, retry attempts
 - **Environment Info** - Development vs production usage
 
-## OpenAI Responses API Support
-
-This middleware includes **full support** for OpenAI's new Responses API, which is designed to replace the traditional Chat Completions API with enhanced capabilities for agent-like applications.
-
-### What is the Responses API?
-
-The Responses API is OpenAI's new stateful API that:
-
-- Uses `input` instead of `messages` parameter for simplified interaction
-- Provides unified experience combining chat completions and assistants capabilities
-- Supports advanced features like background tasks, function calling, and code interpreter
-- Offers better streaming and real-time response generation
-- Works with GPT-5 and other advanced models
-
-### API Comparison
-
-**Traditional Chat Completions:**
-
-```javascript
-const response = await openai.chat.completions.create({
-  model: 'gpt-4o',
-  messages: [{ role: 'user', content: 'Hello' }],
-});
-```
-
-**New Responses API:**
-
-```javascript
-const response = await openai.responses.create({
-  model: 'gpt-5',
-  input: 'Hello', // Simplified input parameter
-});
-```
-
-### Key Differences
-
-| Feature                | Chat Completions             | Responses API                       |
-| ---------------------- | ---------------------------- | ----------------------------------- |
-| **Input Format**       | `messages: [...]`            | `input: "string"` or `input: [...]` |
-| **Models**             | GPT-4, GPT-4o, etc.          | GPT-5, GPT-4o, etc.                 |
-| **Response Structure** | `choices[0].message.content` | `output_text`                       |
-| **Stateful**           | No                           | Yes (with `store: true`)            |
-| **Advanced Features**  | Limited                      | Built-in tools, reasoning, etc.     |
-| **Temperature**        | Supported                    | Not supported with GPT-5            |
-
-### Requirements & Installation
-
-**OpenAI SDK Version:**
-
-- **Minimum:** `5.8.0` (when Responses API was officially released)
-- **Recommended:** `5.8.2` or later (tested and verified)
-- **Current:** `6.2.0` (latest available)
-
-**Installation:**
-
-```bash
-# Install latest version with Responses API support
-npm install openai@^5.8.0
-
-# Or install specific tested version
-npm install openai@5.8.2
-```
-
-### Current Status
-
- **The Responses API is officially available in OpenAI SDK 5.8+**
-
-**Official Release:**
-
--  Released by OpenAI in SDK version 5.8.0
--  Fully documented in official OpenAI documentation
--  Production-ready with GPT-5 and other supported models
--  Complete middleware support with Revenium integration
-
-**Middleware Features:**
-
--  Full Responses API support (streaming & non-streaming)
--  Seamless metadata tracking identical to Chat Completions
--  Type-safe TypeScript integration
--  Complete token tracking including reasoning tokens
--  Azure OpenAI compatibility
-
-**References:**
-
-- [OpenAI Responses API Documentation](https://platform.openai.com/docs/guides/migrate-to-responses)
-- [Azure OpenAI Responses API Documentation](https://learn.microsoft.com/en-us/azure/ai-foundry/openai/how-to/responses)
-
-### Working Examples
-
-Complete working examples are included with this package. Each example is fully documented and ready to run.
-
-#### Available Examples
-
-**OpenAI Chat Completions API:**
-- `openai-basic.ts` - Basic chat + embeddings with optional metadata
-- `openai-streaming.ts` - Streaming responses + batch embeddings
-
-**OpenAI Responses API (SDK 5.8+):**
-- `openai-responses-basic.ts` - New Responses API with string input
-- `openai-responses-streaming.ts` - Streaming with Responses API
-
-**Azure OpenAI:**
-- `azure-basic.ts` - Azure chat completions + embeddings
-- `azure-streaming.ts` - Azure streaming responses
-- `azure-responses-basic.ts` - Azure Responses API
-- `azure-responses-streaming.ts` - Azure streaming Responses API
-
-**Detailed Guide:**
-- `examples/README.md` - Complete setup guide with TypeScript and JavaScript patterns
-
-#### Running Examples
-
-**Installed via npm?**
-```bash
-# Try these in order:
-npx tsx node_modules/@revenium/openai/examples/openai-basic.ts
-npx tsx node_modules/@revenium/openai/examples/openai-streaming.ts
-npx tsx node_modules/@revenium/openai/examples/openai-responses-basic.ts
-
-# View all examples:
-ls node_modules/@revenium/openai/examples/
-```
-
-**Cloned from GitHub?**
-```bash
-npm install
-npm run example:openai-basic
-npm run example:openai-streaming
-npm run example:openai-responses-basic
-
-# See all example scripts:
-npm run
-```
-
-**Browse online:** [`examples/` directory on GitHub](https://github.com/revenium/revenium-middleware-openai-node/tree/HEAD/examples)
-
-### Temporarily Disabling Tracking
-
-If you need to disable Revenium tracking temporarily, you can unpatch the OpenAI client:
-
-```javascript
-import { unpatchOpenAI, patchOpenAI } from '@revenium/openai-middleware';
-
-// Disable tracking
-unpatchOpenAI();
-
-// Your OpenAI calls now bypass Revenium tracking
-await openai.chat.completions.create({...});
-
-// Re-enable tracking
-patchOpenAI();
-```
-
-**Common use cases:**
-
-- **Debugging**: Isolate whether issues are caused by the middleware
-- **Testing**: Compare behavior with/without tracking
-- **Conditional tracking**: Enable/disable based on environment
-- **Troubleshooting**: Temporary bypass during incident response
-
-**Note**: This affects all OpenAI instances globally since we patch the prototype methods.
-
-## Azure OpenAI Integration
-
-**Azure OpenAI support** The middleware automatically detects Azure OpenAI clients and provides accurate usage tracking and cost calculation.
-
-### Quick Start with Azure OpenAI
-
-**Use case:** Automatic Azure OpenAI client detection with deployment name mapping and accurate usage tracking.
-
-See complete Azure examples:
-- `examples/azure-basic.ts` - Azure chat completions with environment variable setup
-- `examples/azure-streaming.ts` - Azure streaming responses
-- `examples/azure-responses-basic.ts` - Azure Responses API integration
-
-**Environment variables needed:**
-```bash
-# Azure OpenAI configuration
-AZURE_OPENAI_ENDPOINT="https://your-resource.openai.azure.com/"
-AZURE_OPENAI_API_KEY="your-azure-api-key"
-AZURE_OPENAI_DEPLOYMENT="gpt-4o"
-AZURE_OPENAI_API_VERSION="2024-12-01-preview"
-
-# Revenium configuration
-REVENIUM_METERING_API_KEY="hak_your_revenium_api_key"
-REVENIUM_METERING_BASE_URL="https://api.revenium.io"
-```
-
-### Azure Features
-
-- **Automatic Detection**: Detects Azure OpenAI clients automatically
-- **Model Name Resolution**: Maps Azure deployment names to standard model names for accurate pricing
-- **Provider Metadata**: Correctly tags requests with `provider: "Azure"` and `modelSource: "OPENAI"`
-- **Deployment Support**: Works with any Azure deployment name (simple or complex)
-- **Endpoint Flexibility**: Supports all Azure OpenAI endpoint formats
-- **Zero Code Changes**: Existing Azure OpenAI code works without modification
-
-### Azure Environment Variables
-
-| Variable                   | Required | Description                                    | Example                              |
-| -------------------------- | -------- | ---------------------------------------------- | ------------------------------------ |
-| `AZURE_OPENAI_ENDPOINT`    | Yes      | Your Azure OpenAI endpoint URL                 | `https://acme.openai.azure.com/`     |
-| `AZURE_OPENAI_API_KEY`     | Yes      | Your Azure OpenAI API key                      | `abc123...`                          |
-| `AZURE_OPENAI_DEPLOYMENT`  | No       | Default deployment name                        | `gpt-4o` or `text-embedding-3-large` |
-| `AZURE_OPENAI_API_VERSION` | No       | API version (defaults to `2024-12-01-preview`) | `2024-12-01-preview`                 |
-
-### Azure Model Name Resolution
-
-The middleware automatically maps Azure deployment names to standard model names for accurate pricing:
-
-```typescript
-// Azure deployment names → Standard model names for pricing
-"gpt-4o-2024-11-20"     → "gpt-4o"
-"gpt4o-prod"            → "gpt-4o"
-"o4-mini"               → "gpt-4o-mini"
-"gpt-35-turbo-dev"      → "gpt-3.5-turbo"
-"text-embedding-3-large" → "text-embedding-3-large"  // Direct match
-"embedding-3-large"     → "text-embedding-3-large"
-```
-
 ## Advanced Usage
 
 ### Initialization Options
@@ -361,13 +142,13 @@ For detailed examples of all initialization patterns, see [`examples/`](https://
 
 ### Streaming Responses
 
-Streaming is fully supported with real-time token tracking and time-to-first-token metrics. The middleware automatically tracks streaming responses without any additional configuration.
+Streaming is fully supported with real-time token tracking. The middleware automatically tracks streaming responses without any additional configuration.
 
 See [`examples/openai-streaming.ts`](https://github.com/revenium/revenium-middleware-openai-node/blob/HEAD/examples/openai-streaming.ts) and [`examples/azure-streaming.ts`](https://github.com/revenium/revenium-middleware-openai-node/blob/HEAD/examples/azure-streaming.ts) for working streaming examples.
 
 ### Custom Metadata Tracking
 
-Add business context to track usage by organization, user, task type, or custom fields. Pass a `usageMetadata` object with any of these optional fields:
+Add business context to track usage by organization, user, task type, or custom identifiers. Pass a `usageMetadata` object with any of these optional fields:
 
 | Field | Description | Use Case |
 |-------|-------------|----------|
@@ -387,7 +168,7 @@ Add business context to track usage by organization, user, task type, or custom
 - [API Reference](https://revenium.readme.io/reference/meter_ai_completion) - Complete metadata field documentation
 
 ### OpenAI Responses API
-**Use case:** Using OpenAI's new Responses API with string inputs and simplified interface (SDK 5.8+).
+**Use case:** Using OpenAI's Responses API with string inputs and simplified interface.
 
 See working examples:
 - `examples/openai-responses-basic.ts` - Basic Responses API usage
@@ -412,15 +193,16 @@ Embeddings examples are included in:
 For advanced use cases, configure the middleware manually:
 
 ```typescript
-import { configure } from '@revenium/openai';
+import { configure, patchOpenAIInstance } from '@revenium/openai';
+import OpenAI from 'openai';
 
 configure({
   reveniumApiKey: 'hak_your_api_key',
-  reveniumBaseUrl: 'https://api.revenium.io',
-  apiTimeout: 5000,
-  failSilent: true,
-  maxRetries: 3,
+  reveniumBaseUrl: 'https://api.revenium.ai',
+  debug: true,
 });
+
+const openai = patchOpenAIInstance(new OpenAI());
 ```
 
 ## Configuration Options
@@ -431,7 +213,7 @@ configure({
 | ------------------------------ | -------- | ------------------------------- | ---------------------------------------------- |
 | `REVENIUM_METERING_API_KEY`    | true     | -                               | Your Revenium API key (starts with `hak_`)     |
 | `OPENAI_API_KEY`               | true     | -                               | Your OpenAI API key (starts with `sk-`)        |
-| `REVENIUM_METERING_BASE_URL`   | false    | `https://api.revenium.io` | Revenium metering API base URL                 |
+| `REVENIUM_METERING_BASE_URL`   | false    | `https://api.revenium.ai` | Revenium metering API base URL                 |
 | `REVENIUM_DEBUG`               | false    | `false`                         | Enable debug logging (`true`/`false`)          |
 | `AZURE_OPENAI_ENDPOINT`        | false    | -                               | Azure OpenAI endpoint URL (for Azure testing)  |
 | `AZURE_OPENAI_API_KEY`         | false    | -                               | Azure OpenAI API key (for Azure testing)       |
@@ -440,65 +222,34 @@ configure({
 
 **Important Note about `REVENIUM_METERING_BASE_URL`:**
 
-- This variable is **optional** and defaults to the production URL (`https://api.revenium.io`)
+- This variable is **optional** and defaults to the production URL (`https://api.revenium.ai`)
 - If you don't set it explicitly, the middleware will use the default production endpoint
 - However, you may see console warnings or errors if the middleware cannot determine the correct environment
 - **Best practice:** Always set this variable explicitly to match your environment:
 
   ```bash
   # Default production URL (recommended)
-  REVENIUM_METERING_BASE_URL=https://api.revenium.io
+  REVENIUM_METERING_BASE_URL=https://api.revenium.ai
   ```
 
 - **Remember:** Your `REVENIUM_METERING_API_KEY` must match your base URL environment
 
-### Usage Metadata Options
-
-All metadata fields are optional and help provide better analytics:
-
-```typescript
-interface UsageMetadata {
-  traceId?: string; // Session or conversation ID
-  taskType?: string; // Type of AI task (e.g., "chat", "summary")
-  subscriber?: {
-    // User information (nested structure)
-    id?: string; // User ID from your system
-    email?: string; // User's email address
-    credential?: {
-      // User credentials
-      name?: string; // Credential name
-      value?: string; // Credential value
-    };
-  };
-  organizationId?: string; // Organization/company ID
-  subscriptionId?: string; // Billing plan ID
-  productId?: string; // Your product/feature ID
-  agent?: string; // AI agent identifier
-  responseQualityScore?: number; // Quality score (0-1)
-}
-```
-
 ## Included Examples
 
-The package includes 8 comprehensive example files in your installation:
-
-**OpenAI Examples:**
-- **openai-basic.ts**: Basic chat completions with metadata tracking
-- **openai-streaming.ts**: Streaming responses with real-time output
-- **openai-responses-basic.ts**: New Responses API usage (OpenAI SDK 5.8+)
-- **openai-responses-streaming.ts**: Streaming with Responses API
-
-**Azure OpenAI Examples:**
-- **azure-basic.ts**: Azure OpenAI chat completions
-- **azure-streaming.ts**: Azure streaming responses
-- **azure-responses-basic.ts**: Azure Responses API
-- **azure-responses-streaming.ts**: Azure streaming Responses API
+The package includes comprehensive example files covering:
 
-**For npm users:** Examples are installed in `node_modules/@revenium/openai/examples/`
+- **Getting Started** - Simple entry point with all metadata fields documented
+- **Chat Completions** - Basic and streaming usage patterns
+- **Responses API** - OpenAI's new API with simplified interface
+- **Azure OpenAI** - Automatic Azure detection and integration
+- **Embeddings** - Text embedding generation with tracking
 
-**For GitHub users:** Examples are in the repository's `examples/` directory
+Run the getting started example:
+```bash
+npx tsx node_modules/@revenium/openai/examples/getting_started.ts
+```
 
-For detailed setup instructions and usage patterns, see [examples/README.md](https://github.com/revenium/revenium-middleware-openai-node/blob/HEAD/examples/README.md).
+For complete example documentation, setup instructions, and all available examples, see [examples/README.md](https://github.com/revenium/revenium-middleware-openai-node/blob/HEAD/examples/README.md).
 
 ## How It Works
 
@@ -517,121 +268,76 @@ The middleware never blocks your application - if Revenium tracking fails, your
 
 ### Common Issues
 
-#### 1. **No tracking data in dashboard**
+#### No tracking data appears
 
-**Symptoms**: OpenAI calls work but no data appears in Revenium dashboard
-
-**Solution**: Enable debug logging to check middleware status:
+Ensure environment variables are set and enable debug logging:
 
 ```bash
+export REVENIUM_METERING_API_KEY="hak_your_key"
+export OPENAI_API_KEY="sk_your_key"
 export REVENIUM_DEBUG=true
 ```
 
-**Expected output for successful tracking**:
-
-```bash
+Look for these log messages:
+```
 [Revenium Debug] OpenAI chat.completions.create intercepted
 [Revenium Debug] Revenium tracking successful
-
-# For Responses API:
-[Revenium Debug] OpenAI responses.create intercepted
-[Revenium Debug] Revenium tracking successful
 ```
 
-#### 2. **Environment mismatch errors**
+#### TypeScript errors with usageMetadata
 
-**Symptoms**: Authentication errors or 401/403 responses
-
-**Solution**: Ensure your API key matches your base URL environment:
-
-```bash
-#  Correct - Key and URL from same environment
-REVENIUM_METERING_API_KEY=hak_your_api_key_here
-REVENIUM_METERING_BASE_URL=https://api.revenium.io
-
-#  Wrong - Key and URL from different environments
-REVENIUM_METERING_API_KEY=hak_wrong_environment_key
-REVENIUM_METERING_BASE_URL=https://api.revenium.io
-```
-
-#### 3. **TypeScript type errors**
-
-**Symptoms**: TypeScript errors about `usageMetadata` property
-
-**Solution**: Ensure you're importing the middleware before OpenAI:
+Import the middleware before OpenAI to enable type augmentation:
 
 ```typescript
-//  Correct order
 import { initializeReveniumFromEnv, patchOpenAIInstance } from '@revenium/openai';
 import OpenAI from 'openai';
-
-//  Wrong order
-import OpenAI from 'openai';
-import { initializeReveniumFromEnv, patchOpenAIInstance } from '@revenium/openai';
 ```
 
-#### 4. **Azure OpenAI not working**
+#### Azure OpenAI not tracking
 
-**Symptoms**: Azure OpenAI calls not being tracked
-
-**Solution**: Ensure you're using `patchOpenAIInstance()` with your Azure client:
+Ensure you patch the Azure client:
 
 ```typescript
 import { AzureOpenAI } from 'openai';
 import { patchOpenAIInstance } from '@revenium/openai';
 
-//  Correct
 const azure = patchOpenAIInstance(new AzureOpenAI({...}));
-
-//  Wrong - not patched
-const azure = new AzureOpenAI({...});
-```
-
-#### 5. **Responses API not available**
-
-**Symptoms**: `openai.responses.create` is undefined
-
-**Solution**: Upgrade to OpenAI SDK 5.8+ for Responses API support:
-
-```bash
-npm install openai@^5.8.0
 ```
 
 ### Debug Mode
 
-Enable comprehensive debug logging:
+Enable detailed logging:
 
 ```bash
 export REVENIUM_DEBUG=true
 ```
 
-This will show:
+### Getting Help
 
--  Middleware initialization status
--  Request interception confirmations
--  Metadata extraction details
--  Tracking success/failure messages
--  Error details and stack traces
+If issues persist:
 
-### Getting Help
+1. Check logs with `REVENIUM_DEBUG=true`
+2. Verify environment variables are set
+3. Test with `examples/getting_started.ts`
+4. Contact support@revenium.io with debug logs
 
-If you're still experiencing issues:
+## Supported Models
 
-1. **Check the logs** with `REVENIUM_DEBUG=true`
-2. **Verify environment variables** are set correctly
-3. **Test with minimal example** from our documentation
-4. **Contact support** with debug logs and error details
+This middleware works with any OpenAI model. Examples in this package include:
 
-For detailed troubleshooting guides, visit [docs.revenium.io](https://docs.revenium.io)
+**Chat Completions:**
+- `gpt-4o-mini`, `gpt-4o` (GPT-4 family)
+- `gpt-5`, `gpt-5-mini`, `gpt-5-nano` (GPT-5 family)
 
-## Supported Models
+**Embeddings:**
+- `text-embedding-3-small`, `text-embedding-3-large`
 
-This middleware works with all OpenAI chat completion and embedding models, including those available through Azure OpenAI.
+**Azure OpenAI:**
+- Works with any Azure deployment (deployment names automatically resolved)
 
-**For the current list of supported models, pricing, and capabilities:**
-- [Revenium AI Models API](https://revenium.readme.io/v2.0.0/reference/get_ai_model)
+For the complete model list and latest specifications, see the [OpenAI Models Documentation](https://platform.openai.com/docs/models).
 
-Models are continuously updated as new versions are released by OpenAI and Azure OpenAI. The middleware automatically handles model detection and pricing for accurate usage tracking.
+For cost tracking across providers, see the [Revenium Model Catalog](https://revenium.readme.io/v2.0.0/reference/get_ai_model).
 
 ### API Support Matrix
 

package/dist/cjs/core/config/loader.js

@@ -12,7 +12,7 @@ exports.hasAzureConfigInEnv = hasAzureConfigInEnv;
 /**
  * Default Revenium base URL for consistency with other middleware
  */
-const DEFAULT_REVENIUM_BASE_URL = 'https://api.revenium.io';
+const DEFAULT_REVENIUM_BASE_URL = 'https://api.revenium.ai';
 /**
  * Load configuration from environment variables
  */

package/dist/cjs/core/config/manager.js

@@ -19,7 +19,8 @@ const validator_js_1 = require("./validator.js");
  */
 exports.defaultLogger = {
     debug: (message, ...args) => {
-        if (process.env.REVENIUM_DEBUG === 'true') {
+        // Check both config.debug and environment variable
+        if (globalConfig?.debug || process.env.REVENIUM_DEBUG === 'true') {
             console.debug(`[Revenium Debug] ${message}`, ...args);
         }
     },

package/dist/cjs/core/config/manager.js.map

@@ -1 +1 @@
-{"version":3,"file":"manager.js","sourceRoot":"","sources":["../../../../src/core/config/manager.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAmCH,8BAEC;AAKD,8BAQC;AAKD,8BAEC;AAKD,8BAEC;AAKD,4CAmBC;AArFD,2CAAqE;AACrE,iDAAgD;AAEhD;;GAEG;AACU,QAAA,aAAa,GAAW;IACnC,KAAK,EAAE,CAAC,OAAe,EAAE,GAAG,IAAe,EAAE,EAAE;QAC7C,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,KAAK,MAAM,EAAE,CAAC;YAC1C,OAAO,CAAC,KAAK,CAAC,oBAAoB,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;IACD,IAAI,EAAE,CAAC,OAAe,EAAE,GAAG,IAAe,EAAE,EAAE;QAC5C,OAAO,CAAC,IAAI,CAAC,cAAc,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IACjD,CAAC;IACD,IAAI,EAAE,CAAC,OAAe,EAAE,GAAG,IAAe,EAAE,EAAE;QAC5C,OAAO,CAAC,IAAI,CAAC,sBAAsB,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IACzD,CAAC;IACD,KAAK,EAAE,CAAC,OAAe,EAAE,GAAG,IAAe,EAAE,EAAE;QAC7C,OAAO,CAAC,KAAK,CAAC,oBAAoB,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IACxD,CAAC;CACF,CAAC;AAEF;;GAEG;AACH,IAAI,YAAY,GAA0B,IAAI,CAAC;AAC/C,IAAI,YAAY,GAAW,qBAAa,CAAC;AAEzC;;GAEG;AACH,SAAgB,SAAS;IACvB,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;GAEG;AACH,SAAgB,SAAS,CAAC,MAAsB;IAC9C,IAAA,6BAAc,EAAC,MAAM,CAAC,CAAC;IACvB,YAAY,GAAG,MAAM,CAAC;IACtB,YAAY,CAAC,KAAK,CAAC,gCAAgC,EAAE;QACnD,OAAO,EAAE,MAAM,CAAC,eAAe;QAC/B,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,cAAc;QAClC,YAAY,EAAE,CAAC,CAAC,MAAM,CAAC,YAAY;KACpC,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAgB,SAAS;IACvB,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;GAEG;AACH,SAAgB,SAAS,CAAC,MAAc;IACtC,YAAY,GAAG,MAAM,CAAC;AACxB,CAAC;AAED;;GAEG;AACH,SAAgB,gBAAgB;IAC9B,MAAM,SAAS,GAAG,IAAA,6BAAiB,GAAE,CAAC;IACtC,IAAI,SAAS,EAAE,CAAC;QACd,IAAI,CAAC;YACH,SAAS,CAAC,SAAS,CAAC,CAAC;YACrB,YAAY,CAAC,KAAK,CAAC,4DAA4D,CAAC,CAAC;YAEjF,8CAA8C;YAC9C,IAAI,IAAA,+BAAmB,GAAE,EAAE,CAAC;gBAC1B,YAAY,CAAC,KAAK,CAAC,oDAAoD,CAAC,CAAC;YAC3E,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,YAAY,CAAC,KAAK,CAAC,8CAA8C,EAAE,KAAK,CAAC,CAAC;YAC1E,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}
+{"version":3,"file":"manager.js","sourceRoot":"","sources":["../../../../src/core/config/manager.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAoCH,8BAEC;AAKD,8BAQC;AAKD,8BAEC;AAKD,8BAEC;AAKD,4CAmBC;AAtFD,2CAAqE;AACrE,iDAAgD;AAEhD;;GAEG;AACU,QAAA,aAAa,GAAW;IACnC,KAAK,EAAE,CAAC,OAAe,EAAE,GAAG,IAAe,EAAE,EAAE;QAC7C,mDAAmD;QACnD,IAAI,YAAY,EAAE,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,KAAK,MAAM,EAAE,CAAC;YACjE,OAAO,CAAC,KAAK,CAAC,oBAAoB,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;IACD,IAAI,EAAE,CAAC,OAAe,EAAE,GAAG,IAAe,EAAE,EAAE;QAC5C,OAAO,CAAC,IAAI,CAAC,cAAc,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IACjD,CAAC;IACD,IAAI,EAAE,CAAC,OAAe,EAAE,GAAG,IAAe,EAAE,EAAE;QAC5C,OAAO,CAAC,IAAI,CAAC,sBAAsB,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IACzD,CAAC;IACD,KAAK,EAAE,CAAC,OAAe,EAAE,GAAG,IAAe,EAAE,EAAE;QAC7C,OAAO,CAAC,KAAK,CAAC,oBAAoB,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IACxD,CAAC;CACF,CAAC;AAEF;;GAEG;AACH,IAAI,YAAY,GAA0B,IAAI,CAAC;AAC/C,IAAI,YAAY,GAAW,qBAAa,CAAC;AAEzC;;GAEG;AACH,SAAgB,SAAS;IACvB,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;GAEG;AACH,SAAgB,SAAS,CAAC,MAAsB;IAC9C,IAAA,6BAAc,EAAC,MAAM,CAAC,CAAC;IACvB,YAAY,GAAG,MAAM,CAAC;IACtB,YAAY,CAAC,KAAK,CAAC,gCAAgC,EAAE;QACnD,OAAO,EAAE,MAAM,CAAC,eAAe;QAC/B,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,cAAc;QAClC,YAAY,EAAE,CAAC,CAAC,MAAM,CAAC,YAAY;KACpC,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAgB,SAAS;IACvB,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;GAEG;AACH,SAAgB,SAAS,CAAC,MAAc;IACtC,YAAY,GAAG,MAAM,CAAC;AACxB,CAAC;AAED;;GAEG;AACH,SAAgB,gBAAgB;IAC9B,MAAM,SAAS,GAAG,IAAA,6BAAiB,GAAE,CAAC;IACtC,IAAI,SAAS,EAAE,CAAC;QACd,IAAI,CAAC;YACH,SAAS,CAAC,SAAS,CAAC,CAAC;YACrB,YAAY,CAAC,KAAK,CAAC,4DAA4D,CAAC,CAAC;YAEjF,8CAA8C;YAC9C,IAAI,IAAA,+BAAmB,GAAE,EAAE,CAAC;gBAC1B,YAAY,CAAC,KAAK,CAAC,oDAAoD,CAAC,CAAC;YAC3E,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,YAAY,CAAC,KAAK,CAAC,8CAA8C,EAAE,KAAK,CAAC,CAAC;YAC1E,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/cjs/core/providers/detector.js

@@ -129,12 +129,12 @@ function getProviderMetadata(providerInfo) {
     if (providerInfo.isAzure) {
         return {
             provider: 'Azure',
-            modelSource: 'OPENAI',
+            modelSource: 'AZURE_OPENAI',
         };
     }
     return {
-        provider: 'OPENAI',
-        modelSource: 'OPENAI',
+        provider: 'OpenAI',
+        modelSource: 'OPENAI', // Provider name when calling directly per spec
     };
 }
 //# sourceMappingURL=detector.js.map