@revenium/perplexity 1.0.19 → 1.0.21

package/playground/streaming.js

@@ -1,6 +1,6 @@
 import { PerplexityReveniumMiddleware } from "@revenium/perplexity";
 
-const streamingExample = async () => {
+const chatCompletionStreamingExample = async () => {
   console.log("=".repeat(50));
   try {
     const middleware = new PerplexityReveniumMiddleware();
@@ -21,4 +21,4 @@ const streamingExample = async () => {
   }
 };
 
-streamingExample();
+chatCompletionStreamingExample();

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,
     };
   }