@revenium/perplexity 1.0.19 → 1.0.20

package/README.md

@@ -187,6 +187,58 @@ const streamingExample = async () => {
 streamingExample();
 ```
 
+#### METADATA Example
+
+Create `examples/metadata-perplexity.js`:
+
+```javascript
+// examples/metadata-perplexity.js
+import { PerplexityReveniumMiddleware } from "@revenium/perplexity";
+
+const metadataExample = async () => {
+  try {
+    const middleware = new PerplexityReveniumMiddleware();
+    const model = middleware.getGenerativeModel("sonar-pro");
+    const result = await model.createChatCompletion({
+      model: "sonar-pro",
+      messages: [{ role: "user", content: "What is the capital of France?" }],
+      usageMetadata: {
+        taskType: "test",
+        subscriberEmail: "test@revenium.ai",
+        subscriberId: "123456",
+        subscriberCredentialName: "apiKey",
+        subscriberCredential: "keyValue",
+        organizationId: "123456",
+        subscriptionId: "123456",
+        productId: "free-trial",
+        agent: "perplexity",
+        responseQualityScore: 100,
+        transactionId: "123456",
+        timeToFirstToken: 1000,
+        requestTime: new Date(),
+        completionStartTime: new Date(),
+        operationType: "CHAT",
+        inputTokenCount: 10,
+        outputTokenCount: 10,
+        reasoningTokenCount: 20,
+        cacheCreationTokenCount: 0,
+        cacheReadTokenCount: 0,
+        totalTokenCount: 40,
+        responseTime: new Date(),
+        requestDuration: 1000,
+        stopReason: "END",
+      },
+    });
+    console.log("[BASIC REQUEST]", result.choices[0].message);
+  } catch (error) {
+    console.error("❌ Perplexity streaming example failed:", error);
+    process.exit(1);
+  }
+};
+
+metadataExample();
+```
+
 ### Step 8: Update package.json
 
 ```json
@@ -196,7 +248,8 @@ streamingExample();
   "type": "module",
   "scripts": {
     "test-perplexity": "node test-perplexity.js",
-    "test-perplexity-stream": "node examples/streaming-perplexity.js"
+    "test-perplexity-stream": "node examples/streaming-perplexity.js",
+    "test-perplexity-metadata": "node examples/metadata-perplexity.js"
   },
   "dependencies": {
     "@revenium/perplexity": "^1.0.0"
@@ -210,6 +263,9 @@ streamingExample();
 # Test streaming
 npm run test-perplexity-stream
 
+# Test metadata
+npm run test-perplexity-metadata
+
 ```
 
 ---
@@ -252,6 +308,7 @@ 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
+npm run e-metadata     # Metadata request
 
 # Playground examples
 # Required build first
@@ -260,6 +317,7 @@ npm run build
 npm run p-basic
 npm run p-streaming
 npm run p-enhanced
+npm run p-metadata
 ```
 
 ---

package/examples/metadata.ts

@@ -0,0 +1,43 @@
+import { PerplexityReveniumMiddleware } from "../src";
+
+async function metadataRequest() {
+  console.log("=".repeat(50));
+  try {
+    const middleware = new PerplexityReveniumMiddleware();
+    const model = middleware.getGenerativeModel("sonar-pro");
+    const result = await model.createChatCompletion({
+      model: "sonar-pro",
+      messages: [{ role: "user", content: "What is the capital of France?" }],
+      usageMetadata: {
+        taskType: "test",
+        subscriberEmail: "test@revenium.ai",
+        subscriberId: "123456",
+        subscriberCredentialName: "apiKey",
+        subscriberCredential: "keyValue",
+        organizationId: "123456",
+        subscriptionId: "123456",
+        productId: "free-trial",
+        agent: "perplexity",
+        responseQualityScore: 100,
+        transactionId: "123456",
+        timeToFirstToken: 1000,
+        requestTime: new Date(),
+        completionStartTime: new Date(),
+        operationType: "CHAT",
+        inputTokenCount: 10,
+        outputTokenCount: 10,
+        reasoningTokenCount: 20,
+        cacheCreationTokenCount: 0,
+        cacheReadTokenCount: 0,
+        totalTokenCount: 40,
+        responseTime: new Date(),
+        requestDuration: 1000,
+        stopReason: "END",
+      },
+    });
+    console.log("[METADATA REQUEST]", result.choices[0].message);
+  } catch (error) {
+    console.log(error);
+  }
+}
+metadataRequest();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revenium/perplexity",
-  "version": "1.0.19",
+  "version": "1.0.20",
   "description": "NodeJS middleware for perplexity's AI API",
   "homepage": "https://github.com/revenium/revenium-middleware-perplexity-node#readme",
   "bugs": {
@@ -20,7 +20,8 @@
     "e-basic": "npx ts-node examples/basic.ts",
     "e-streaming": "npx ts-node examples/streaming.ts",
     "e-chat-completions": "npx ts-node examples/chat-completions.ts",
-    "e-enhanced": "npx ts-node examples/enhanced.ts"
+    "e-enhanced": "npx ts-node examples/enhanced.ts",
+    "e-metadata": "npx ts-node examples/metadata.ts"
   },
   "keywords": [
     "revenium",

package/playground/metadata.js

@@ -0,0 +1,43 @@
+import { PerplexityReveniumMiddleware } from "@revenium/perplexity";
+
+async function metadataRequest() {
+  console.log("=".repeat(50));
+  try {
+    const middleware = new PerplexityReveniumMiddleware();
+    const model = middleware.getGenerativeModel("sonar-pro");
+    const result = await model.createChatCompletion({
+      model: "sonar-pro",
+      messages: [{ role: "user", content: "What is the capital of France?" }],
+      usageMetadata: {
+        taskType: "test",
+        subscriberEmail: "test@revenium.ai",
+        subscriberId: "123456",
+        subscriberCredentialName: "apiKey",
+        subscriberCredential: "keyValue",
+        organizationId: "123456",
+        subscriptionId: "123456",
+        productId: "free-trial",
+        agent: "perplexity",
+        responseQualityScore: 100,
+        transactionId: "123456",
+        timeToFirstToken: 1000,
+        requestTime: new Date(),
+        completionStartTime: new Date(),
+        operationType: "CHAT",
+        inputTokenCount: 10,
+        outputTokenCount: 10,
+        reasoningTokenCount: 20,
+        cacheCreationTokenCount: 0,
+        cacheReadTokenCount: 0,
+        totalTokenCount: 40,
+        responseTime: new Date(),
+        requestDuration: 1000,
+        stopReason: "END",
+      },
+    });
+    console.log("[METADATA REQUEST]", result.choices[0].message);
+  } catch (error) {
+    console.log(error);
+  }
+}
+metadataRequest();

package/src/interfaces/chatCompletionRequest.ts

@@ -1,9 +1,10 @@
 import { ChatCompletionMessageParam } from "openai/resources/index";
+import { IUsageMetadata } from "./usageMetadata";
 
 export interface IChatCompletionRequest {
   model?: string;
   messages: ChatCompletionMessageParam[];
   stream?: boolean;
-  usageMetadata?: any;
+  usageMetadata?: IUsageMetadata;
   [key: string]: any;
 }

package/src/interfaces/usageMetadata.ts

@@ -10,4 +10,18 @@ export interface IUsageMetadata {
   productId?: string;
   agent?: string;
   responseQualityScore?: number;
+  transactionId?: string;
+  timeToFirstToken?: number;
+  requestTime?: Date;
+  completionStartTime?: Date;
+  operationType?: string;
+  inputTokenCount?: number;
+  outputTokenCount?: number;
+  reasoningTokenCount?: number;
+  cacheCreationTokenCount?: number;
+  cacheReadTokenCount?: number;
+  totalTokenCount?: number;
+  responseTime?: Date;
+  requestDuration?: number;
+  stopReason?: string;
 }

package/src/middleware.ts

@@ -70,15 +70,18 @@ export class PerplexityReveniumMiddleware {
         REVENIUM_METERING_API_KEY ?? "",
         REVENIUM_METERING_BASE_URL ?? ""
       );
-      const getMetering = metering.createMetering({
-        modelName: this.modelName,
-        endTime,
-        startTime,
-        operationType: IOperationType.CHAT,
-        stopReason: "END",
-        tokenCounts,
-        usageMetadata,
-      });
+      const getMetering = metering.createMetering(
+        {
+          modelName: this.modelName,
+          endTime,
+          startTime,
+          operationType: IOperationType.CHAT,
+          stopReason: "END",
+          tokenCounts,
+          usageMetadata,
+        },
+        true
+      );
       await metering.sendMeteringData(getMetering);
       return result;
     } catch (error) {
@@ -111,15 +114,18 @@ export class PerplexityReveniumMiddleware {
         REVENIUM_METERING_API_KEY ?? "",
         REVENIUM_METERING_BASE_URL ?? ""
       );
-      const getMetering = metering.createMetering({
-        modelName: this.modelName,
-        endTime,
-        startTime,
-        operationType: IOperationType.CHAT,
-        stopReason: "END",
-        tokenCounts,
-        usageMetadata,
-      });
+      const getMetering = metering.createMetering(
+        {
+          modelName: this.modelName,
+          endTime,
+          startTime,
+          operationType: IOperationType.CHAT,
+          stopReason: "END",
+          tokenCounts,
+          usageMetadata,
+        },
+        false
+      );
       await metering.sendMeteringData(getMetering);
       return result;
     } catch (error) {

package/src/models/Metering.ts

@@ -21,39 +21,67 @@ export class Metering {
     this.endpoint = clientEndpoint;
   }
 
-  public createMetering(metering: IMeteringRequest): IMeteringResponse {
+  public createMetering(
+    metering: IMeteringRequest,
+    isStreamed: boolean
+  ): IMeteringResponse {
+    const usageMetadata = metering.usageMetadata;
     const agent: string = "perplexity";
     return {
-      stopReason: metering.stopReason,
+      stopReason: usageMetadata?.stopReason ?? metering.stopReason,
       costType: COST_TYPE,
-      isStreamed: false,
+      isStreamed,
       taskType: COST_TYPE,
-      agent,
-      operationType: metering.operationType.toString(),
-      inputTokenCount: metering.tokenCounts.inputTokens,
-      outputTokenCount: metering.tokenCounts.outputTokens,
-      reasoningTokenCount: metering.tokenCounts.reasoningTokens || 0,
-      cacheCreationTokenCount: metering.tokenCounts.cachedTokens || 0,
-      cacheReadTokenCount: 0,
-      totalTokenCount: metering.tokenCounts.totalTokens,
-      organizationId: `my-customer-name-${generateTransactionId()}`,
-      productId: PRODUCT_ID_FREE,
+      agent: usageMetadata?.agent ?? agent,
+      operationType:
+        usageMetadata?.operationType ?? metering.operationType.toString(),
+      inputTokenCount:
+        usageMetadata?.inputTokenCount ?? metering.tokenCounts.inputTokens,
+      outputTokenCount:
+        usageMetadata?.outputTokenCount ?? metering.tokenCounts.outputTokens,
+      reasoningTokenCount:
+        usageMetadata?.reasoningTokenCount ??
+        metering.tokenCounts.reasoningTokens ??
+        0,
+      cacheCreationTokenCount:
+        usageMetadata?.cacheCreationTokenCount ??
+        metering.tokenCounts.cachedTokens ??
+        0,
+      cacheReadTokenCount: usageMetadata?.cacheReadTokenCount ?? 0,
+      totalTokenCount:
+        usageMetadata?.totalTokenCount ?? metering.tokenCounts.totalTokens,
+      organizationId:
+        usageMetadata?.organizationId ??
+        `my-customer-name-${generateTransactionId()}`,
+      productId: usageMetadata?.productId ?? PRODUCT_ID_FREE,
       subscriber: {
-        id: `user-${generateTransactionId()}`,
-        email: `user-@${agent.toLowerCase()}.ai`,
-        credential: CURRENT_CREDENTIAL,
+        id: usageMetadata?.subscriberId ?? `user-${generateTransactionId()}`,
+        email:
+          usageMetadata?.subscriberEmail ?? `user-@${agent.toLowerCase()}.ai`,
+        credential:
+          usageMetadata?.subscriberCredentialName &&
+          usageMetadata?.subscriberCredential
+            ? {
+                name: usageMetadata.subscriberCredentialName,
+                value: usageMetadata.subscriberCredential,
+              }
+            : CURRENT_CREDENTIAL,
       },
       model: metering.modelName,
-      transactionId: generateTransactionId(),
+      transactionId: usageMetadata?.transactionId ?? generateTransactionId(),
       responseTime: formatTimestamp(metering.endTime),
       requestDuration: calculateDurationMs(
         metering.startTime,
         metering.endTime
       ),
       provider: agent,
-      requestTime: formatTimestamp(metering.startTime),
-      completionStartTime: formatTimestamp(metering.endTime),
-      timeToFirstToken: 0,
+      requestTime:
+        usageMetadata?.requestTime?.toString() ??
+        formatTimestamp(metering.startTime),
+      completionStartTime:
+        usageMetadata?.completionStartTime?.toString() ??
+        formatTimestamp(metering.endTime),
+      timeToFirstToken: usageMetadata?.timeToFirstToken ?? 0,
       middleware_source: MIDDLEWARE_SOURCE,
     };
   }