@revenium/perplexity 1.0.11 → 1.0.14

package/README.md

@@ -55,11 +55,11 @@ Copy and paste the following into `.env`:
 
 ```bash
 # Perplexity AI Configuration
-PERPLEXITY_API_KEY=your_perplexity_api_key_here
+PERPLEXITY_API_KEY="your_perplexity_api_key_here"
 
 # Revenium Configuration
-REVENIUM_METERING_API_KEY=your_revenium_api_key_here
-REVENIUM_METERING_BASE_URL=https://api.revenium.io/meter
+REVENIUM_METERING_API_KEY="your_revenium_api_key_here"
+REVENIUM_METERING_BASE_URL="https://api.revenium.io/meter"
 
 ```
 
@@ -181,51 +181,6 @@ try {
 }
 ```
 
-#### Metadata Example
-
-Create `examples/metadata-perplexity.js`:
-
-```javascript
-// examples/metadata-perplexity.js
-import { createPerplexityClient } from "@revenium/perplexity";
-
-const client = createPerplexityClient();
-
-try {
-  const result = await client.createChatCompletion({
-    model: "sonar-pro",
-    messages: [
-      {
-        role: "user",
-        content: "Analyze this quarterly report",
-      },
-    ],
-    usageMetadata: {
-      // User tracking
-      traceId: "conv-28a7e9d4",
-      taskType: "document-analysis",
-      subscriberEmail: "user@example.com",
-      subscriberId: "user-123",
-      subscriberCredentialName: "api-key-1",
-
-      // Business context
-      organizationId: "acme-corp",
-      subscriptionId: "premium-plan",
-      productId: "business-intelligence",
-      agent: "analysis-assistant",
-      responseQualityScore: 0.95,
-    },
-  });
-
-  console.log("*** METADATA RESPONSE ***");
-  console.log("Response:", result.choices[0]?.message?.content);
-  console.log("✅ Metadata tracking with metering successful!");
-} catch (error) {
-  console.error("❌ Perplexity metadata example failed:", error);
-  process.exit(1);
-}
-```
-
 ### Step 8: Update package.json
 
 ```json
@@ -235,8 +190,7 @@ try {
   "type": "module",
   "scripts": {
     "test-perplexity": "node test-perplexity.js",
-    "test-perplexity-stream": "node examples/streaming-perplexity.js",
-    "test-perplexity-metadata": "node examples/metadata-perplexity.js"
+    "test-perplexity-stream": "node examples/streaming-perplexity.js"
   },
   "dependencies": {
     "@revenium/perplexity": "^1.0.0"
@@ -250,8 +204,6 @@ try {
 # Test streaming
 npm run test-perplexity-stream
 
-# Test metadata
-npm run test-perplexity-metadata
 ```
 
 ---
@@ -267,6 +219,7 @@ cd revenium-middleware-perplexity-node
 
 # Install dependencies
 npm install
+npm install @revenium/perplexity
 
 # Create your .env file
 cp .env.example .env
@@ -279,26 +232,28 @@ Edit your `.env` file:
 
 ```bash
 # For Perplexity AI SDK
-PERPLEXITY_API_KEY=your_perplexity_api_key_here
-REVENIUM_METERING_API_KEY=your_revenium_api_key_here
-REVENIUM_METERING_BASE_URL=https://api.revenium.io/meter
+PERPLEXITY_API_KEY="your_perplexity_api_key_here"
+REVENIUM_METERING_API_KEY="your_revenium_api_key_here"
+REVENIUM_METERING_BASE_URL="https://api.revenium.io/meter"
 ```
 
 ### Run Perplexity AI Examples
 
 ```bash
 # Perplexity AI examples
-npm run p-basic        # Basic chat completion
-npm run p-streaming    # Streaming response
-npm run p-metadata     # Rich metadata tracking
+
+npm run e-basic        # Basic chat completion
+npm run e-streaming    # Streaming response
+npm run e-enhanced     # Enhanced request
+npm run e-chat-completions     # Chat completions
 
 # Playground examples
 # Required build first
 npm run build
 # Then run any of the following
-npm run p-perplexity-basic
-npm run p-perplexity-streaming
-npm run p-perplexity-metadata
+npm run p-basic
+npm run p-streaming
+npm run p-enhanced
 ```
 
 ---
@@ -318,11 +273,9 @@ npm install @revenium/perplexity
 Add to your existing `.env` file:
 
 ```bash
-PERPLEXITY_API_KEY=your_perplexity_api_key_here
-REVENIUM_METERING_API_KEY=your_revenium_api_key_here
-REVENIUM_METERING_BASE_URL=https://api.revenium.io/meter
-# Optional: Enable debug logging
-REVENIUM_LOG_LEVEL=INFO
+PERPLEXITY_API_KEY="your_perplexity_api_key_here"
+REVENIUM_METERING_API_KEY="your_revenium_api_key_here"
+REVENIUM_METERING_BASE_URL="https://api.revenium.io/meter"
 ```
 
 ### Step 3. Replace Your Imports
@@ -336,14 +289,7 @@ import { OpenAI } from "openai";
 **After:**
 
 ```javascript
-import { createPerplexityClient } from "@revenium/perplexity";
-```
-
-**Or Use OpenAI Client (Alternative):**
-
-```javascript
-import { OpenAI } from "openai";
-import "@revenium/perplexity"; // Import middleware to activate tracking
+import { PerplexityReveniumMiddleware } from "@revenium/perplexity";
 ```
 
 ### Step 4. Update Your Code
@@ -351,37 +297,20 @@ import "@revenium/perplexity"; // Import middleware to activate tracking
 #### Revenium Client Example
 
 ```javascript
-import { createPerplexityClient } from "@revenium/perplexity";
+import { PerplexityReveniumMiddleware } from "@revenium/perplexity";
 
 // Initialize (API key from environment variable)
-const client = createPerplexityClient();
-
-// Make your request - metering happens automatically!
-const result = await client.createChatCompletion({
-  model: "sonar-pro",
-  messages: [{ role: "user", content: "What is artificial intelligence?" }],
-});
-console.log(result.choices[0]?.message?.content);
-```
-
-#### OpenAI Client Example
-
-```javascript
-import { OpenAI } from "openai";
-import "@revenium/perplexity"; // Import middleware for automatic tracking
-
-// Initialize OpenAI client for Perplexity
-const client = new OpenAI({
-  apiKey: process.env.PERPLEXITY_API_KEY,
-  baseURL: "https://api.perplexity.ai",
-});
-
-// Make your request - metering happens automatically!
-const result = await client.chat.completions.create({
-  model: "sonar-pro",
-  messages: [{ role: "user", content: "What is artificial intelligence?" }],
+const middleware = new PerplexityReveniumMiddleware();
+const model = middleware.getGenerativeModel("sonar-pro");
+const result = await model.createChatCompletion({
+  messages: [
+    {
+      role: "user",
+      content: "Hello world",
+    },
+  ],
 });
-console.log(result.choices[0]?.message?.content);
+console.log("[BASIC EXAMPLE]", result.choices[0].message.content);
 ```
 
 ---
@@ -393,75 +322,19 @@ console.log(result.choices[0]?.message?.content);
 #### Revenium Client Streaming
 
 ```javascript
-const stream = await client.createStreamingChatCompletion({
-  model: "sonar-pro",
-  messages: [{ role: "user", content: "Write a story about AI" }],
-});
-
-for await (const chunk of stream) {
-  const content = chunk.choices[0]?.delta?.content;
-  if (content) process.stdout.write(content);
-}
-```
-
-#### OpenAI Client Streaming
-
-```javascript
-import { OpenAI } from "openai";
-import "@revenium/perplexity";
-
-const client = new OpenAI({
-  apiKey: process.env.PERPLEXITY_API_KEY,
-  baseURL: "https://api.perplexity.ai",
-});
-
-const stream = await client.chat.completions.create({
-  model: "sonar-pro",
-  messages: [{ role: "user", content: "Write a story about AI" }],
-  stream: true,
-});
-
-for await (const chunk of stream) {
-  const content = chunk.choices[0]?.delta?.content;
-  if (content) process.stdout.write(content);
-}
-```
-
-### Rich Metadata Tracking
-
-```javascript
-import { createPerplexityClient } from "@revenium/perplexity";
-
-const client = createPerplexityClient();
-
-const response = await client.createChatCompletion({
-  model: "sonar-pro",
+const stream = await model.createChatCompletionStream({
   messages: [
     {
       role: "user",
-      content: "Analyze this quarterly report",
+      content: "Hello world",
     },
   ],
-  usageMetadata: {
-    // User tracking
-    traceId: "conv-28a7e9d4",
-    taskType: "document-analysis",
-    subscriberEmail: "user@example.com",
-    subscriberId: "user-123",
-    subscriberCredentialName: "api-key-1",
-
-    // Business context
-    organizationId: "acme-corp",
-    subscriptionId: "premium-plan",
-    productId: "business-intelligence",
-    agent: "analysis-assistant",
-    responseQualityScore: 0.95,
-  },
 });
+for await (const chunk of stream) {
+  process.stdout.write(chunk.choices[0]?.delta?.content || "");
+}
 ```
 
----
-
 ## 📊 What Gets Tracked
 
 - **Token Usage**: Input and output tokens for accurate billing
@@ -490,29 +363,11 @@ _Note: Model availability depends on your Perplexity AI account and API access l
 
 ### Environment Variables
 
-| Variable                     | Required | Description                                                     |
-| ---------------------------- | -------- | --------------------------------------------------------------- |
-| `PERPLEXITY_API_KEY`         | ✅       | Your Perplexity API key                                         |
-| `REVENIUM_METERING_API_KEY`  | ✅       | Your Revenium API key                                           |
-| `PERPLEXITY_BASE_URL`        | ❌       | Custom Perplexity base URL (default: https://api.perplexity.ai) |
-| `REVENIUM_METERING_BASE_URL` | ❌       | Revenium base URL (default: https://api.revenium.io/meter/v2)   |
-| `REVENIUM_LOG_LEVEL`         | ❌       | Log level: DEBUG, INFO, WARNING, ERROR                          |
-
-### Manual Configuration
-
-```javascript
-// Revenium client with custom configuration
-const client = createPerplexityClient(
-  "your-api-key",
-  "https://api.perplexity.ai"
-);
-
-// OpenAI client with custom base URL
-const openaiClient = new OpenAI({
-  apiKey: "your-api-key",
-  baseURL: "https://custom-perplexity-endpoint.com",
-});
-```
+| Variable                     | Required | Description                                                |
+| ---------------------------- | -------- | ---------------------------------------------------------- |
+| `PERPLEXITY_API_KEY`         | ✅       | Your Perplexity API key                                    |
+| `REVENIUM_METERING_API_KEY`  | ✅       | Your Revenium API key                                      |
+| `REVENIUM_METERING_BASE_URL` | ❌       | Revenium base URL (default: https://api.revenium.io/meter) |
 
 ---
 
@@ -542,16 +397,6 @@ export REVENIUM_LOG_LEVEL="DEBUG"  # Enable debug logging
 }
 ```
 
-### Debug Mode
-
-Enable detailed logging to troubleshoot issues:
-
-```bash
-export REVENIUM_LOG_LEVEL="DEBUG"
-export REVENIUM_VERBOSE_STARTUP="true"
-node your-script.js
-```
-
 This will show:
 
 - Request/response details
@@ -593,9 +438,9 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 ## 🤝 Support
 
-- 📖 [Documentation](https://docs.revenium.io)
-- 💬 [Community Support](https://community.revenium.io)
-- 📧 [Email Support](mailto:support@revenium.io)
+- 📖 [Documentation](https://docs.revenium.com)
+- 💬 [Community Support](https://community.revenium.com)
+- 📧 [Email Support](mailto:support@revenium.com)
 - 🐛 [Report Issues](https://github.com/revenium/revenium-middleware-perplexity-node/issues)
 
 ---

package/examples/chat-completions.ts

@@ -6,7 +6,6 @@ const chatCompletionsExample = async () => {
     const middleware = new PerplexityReveniumMiddleware();
     const model = middleware.getGenerativeModel("sonar-pro");
     const result = await model.createChatCompletion({
-      model: "sonar-pro",
       messages: [
         {
           role: "user",

package/examples/enhanced.ts

@@ -6,7 +6,6 @@ async function enhancedRequest() {
     const middleware = new PerplexityReveniumMiddleware();
     const model = middleware.getGenerativeModel("sonar-pro");
     const result = await model.createChatCompletion({
-      model: "sonar-pro",
       messages: [
         { role: "user", content: "Explain quantum computing in simple terms" },
       ],

package/examples/streaming.ts

@@ -6,7 +6,6 @@ const chatCompletionStreamingExample = async () => {
     const middleware = new PerplexityReveniumMiddleware();
     const model = middleware.getGenerativeModel("sonar-pro");
     const result = await model.createChatCompletionStream({
-      model: "sonar-pro",
       messages: [
         {
           role: "user",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revenium/perplexity",
-  "version": "1.0.11",
+  "version": "1.0.14",
   "description": "NodeJS middleware for perplexity's AI API",
   "homepage": "https://github.com/revenium/revenium-middleware-perplexity-node#readme",
   "bugs": {

package/playground/basic.js

@@ -5,7 +5,6 @@ const basicExample = async () => {
     const middleware = new PerplexityReveniumMiddleware();
     const model = middleware.getGenerativeModel("sonar-pro");
     const result = await model.createChatCompletion({
-      model: "sonar-pro",
       messages: [
         {
           role: "user",

package/playground/enhanced.js

@@ -5,7 +5,6 @@ const enhancedExample = async () => {
     const middleware = new PerplexityReveniumMiddleware();
     const model = middleware.getGenerativeModel("sonar-pro");
     const result = await model.createChatCompletion({
-      model: "sonar-pro",
       messages: [
         {
           role: "user",

package/playground/streaming.js

@@ -6,7 +6,6 @@ const streamingExample = async () => {
     const middleware = new PerplexityReveniumMiddleware();
     const model = middleware.getGenerativeModel("sonar-pro");
     const result = await model.createChatCompletionStream({
-      model: "sonar-pro",
       messages: [
         {
           role: "user",