@revenium/perplexity 2.0.6 → 2.0.8

package/examples/advanced.ts

@@ -1,123 +1,123 @@
-/**
- * Advanced Example
- * Demonstrates advanced features like system prompts, conversation history,
- * and different model parameters with Revenium Perplexity middleware.
- */
-
-import { Initialize, GetClient, UsageMetadata } from "@revenium/perplexity";
-
-async function main() {
-  // Initialize middleware
-  Initialize();
-
-  // Get client
-  const client = GetClient();
-
-  // Metadata for tracking
-  const metadata: UsageMetadata = {
-    organizationId: "org-advanced-demo",
-    productId: "prod-perplexity-advanced",
-    taskType: "multi-turn-conversation",
-    subscriber: {
-      id: "user-advanced-001",
-      email: "advanced@example.com",
-    },
-  };
-
-  console.log("=== Advanced Perplexity Example ===\n");
-
-  // Example 1: Using system prompt and conversation history
-  console.log("1. Multi-turn conversation with system prompt:\n");
-
-  const response1 = await client
-    .chat()
-    .completions()
-    .create(
-      {
-        model: "sonar-pro",
-        messages: [
-          {
-            role: "system",
-            content:
-              "You are a helpful AI assistant that provides concise, accurate answers.",
-          },
-          {
-            role: "user",
-            content: "What is the capital of France?",
-          },
-          {
-            role: "assistant",
-            content: "The capital of France is Paris.",
-          },
-          {
-            role: "user",
-            content: "What is its population?",
-          },
-        ],
-        max_tokens: 500,
-        temperature: 0.7,
-      },
-      metadata
-    );
-
-  console.log(`Assistant: ${response1.choices[0].message.content}\n`);
-  console.log(`Tokens used: ${response1.usage?.total_tokens}\n`);
-
-  // Example 2: Using different temperature for creative responses
-  console.log("2. Creative response with higher temperature:\n");
-
-  const response2 = await client
-    .chat()
-    .completions()
-    .create(
-      {
-        model: "sonar-pro",
-        messages: [
-          {
-            role: "user",
-            content:
-              "Write a creative tagline for an AI company in 10 words or less.",
-          },
-        ],
-        max_tokens: 100,
-        temperature: 1.0, // Higher temperature for more creativity
-      },
-      {
-        ...metadata,
-        taskType: "creative-generation",
-      }
-    );
-
-  console.log(`Assistant: ${response2.choices[0].message.content}\n`);
-
-  // Example 3: Using sonar-reasoning for complex reasoning tasks
-  console.log("3. Complex reasoning with sonar-reasoning model:\n");
-
-  const response3 = await client
-    .chat()
-    .completions()
-    .create(
-      {
-        model: "sonar-reasoning",
-        messages: [
-          {
-            role: "user",
-            content:
-              "If a train travels 120 km in 2 hours, and then 180 km in 3 hours, what is its average speed for the entire journey?",
-          },
-        ],
-        max_tokens: 500,
-      },
-      {
-        ...metadata,
-        taskType: "reasoning",
-      }
-    );
-
-  console.log(`Assistant: ${response3.choices[0].message.content}\n`);
-  console.log(`Tokens used: ${response3.usage?.total_tokens}\n`);
-
-  console.log("\nAll usage data sent to Revenium! Check your dashboard");
-}
-
-main().catch(console.error);
+/**
+ * Advanced Example
+ * Demonstrates advanced features like system prompts, conversation history,
+ * and different model parameters with Revenium Perplexity middleware.
+ */
+
+import { Initialize, GetClient, UsageMetadata } from "@revenium/perplexity";
+
+async function main() {
+  // Initialize middleware
+  Initialize();
+
+  // Get client
+  const client = GetClient();
+
+  // Metadata for tracking
+  const metadata: UsageMetadata = {
+    organizationId: "org-advanced-demo",
+    productId: "prod-perplexity-advanced",
+    taskType: "multi-turn-conversation",
+    subscriber: {
+      id: "user-advanced-001",
+      email: "advanced@example.com",
+    },
+  };
+
+  console.log("=== Advanced Perplexity Example ===\n");
+
+  // Example 1: Using system prompt and conversation history
+  console.log("1. Multi-turn conversation with system prompt:\n");
+
+  const response1 = await client
+    .chat()
+    .completions()
+    .create(
+      {
+        model: "sonar-pro",
+        messages: [
+          {
+            role: "system",
+            content:
+              "You are a helpful AI assistant that provides concise, accurate answers.",
+          },
+          {
+            role: "user",
+            content: "What is the capital of France?",
+          },
+          {
+            role: "assistant",
+            content: "The capital of France is Paris.",
+          },
+          {
+            role: "user",
+            content: "What is its population?",
+          },
+        ],
+        max_tokens: 500,
+        temperature: 0.7,
+      },
+      metadata
+    );
+
+  console.log(`Assistant: ${response1.choices[0].message.content}\n`);
+  console.log(`Tokens used: ${response1.usage?.total_tokens}\n`);
+
+  // Example 2: Using different temperature for creative responses
+  console.log("2. Creative response with higher temperature:\n");
+
+  const response2 = await client
+    .chat()
+    .completions()
+    .create(
+      {
+        model: "sonar-pro",
+        messages: [
+          {
+            role: "user",
+            content:
+              "Write a creative tagline for an AI company in 10 words or less.",
+          },
+        ],
+        max_tokens: 100,
+        temperature: 1.0, // Higher temperature for more creativity
+      },
+      {
+        ...metadata,
+        taskType: "creative-generation",
+      }
+    );
+
+  console.log(`Assistant: ${response2.choices[0].message.content}\n`);
+
+  // Example 3: Using sonar-reasoning for complex reasoning tasks
+  console.log("3. Complex reasoning with sonar-reasoning model:\n");
+
+  const response3 = await client
+    .chat()
+    .completions()
+    .create(
+      {
+        model: "sonar-reasoning",
+        messages: [
+          {
+            role: "user",
+            content:
+              "If a train travels 120 km in 2 hours, and then 180 km in 3 hours, what is its average speed for the entire journey?",
+          },
+        ],
+        max_tokens: 500,
+      },
+      {
+        ...metadata,
+        taskType: "reasoning",
+      }
+    );
+
+  console.log(`Assistant: ${response3.choices[0].message.content}\n`);
+  console.log(`Tokens used: ${response3.usage?.total_tokens}\n`);
+
+  console.log("\nAll usage data sent to Revenium! Check your dashboard");
+}
+
+main().catch(console.error);

package/examples/basic.ts

@@ -1,45 +1,45 @@
-/**
- * Basic Example
- * Demonstrates basic usage of Revenium Perplexity middleware.
- */
-
-import { Initialize, GetClient, UsageMetadata } from "@revenium/perplexity";
-
-async function main() {
-  // Initialize middleware
-  Initialize();
-
-  // Get client
-  const client = GetClient();
-  const metadata: UsageMetadata = {
-    organizationId: "org-basic-demo",
-    productId: "prod-perplexity-basic",
-  };
-
-  // Create chat completion
-  const response = await client
-    .chat()
-    .completions()
-    .create(
-      {
-        model: "sonar-pro",
-        messages: [
-          {
-            role: "user",
-            content:
-              "Say hello in Spanish and explain why Spanish is a beautiful language in 2-3 sentences.",
-          },
-        ],
-        max_tokens: 1000,
-      },
-      metadata
-    );
-
-  // Display response
-  if (response.choices.length > 0) {
-    console.log(`Assistant: ${response.choices[0].message.content}`);
-  }
-  console.log("\nUsage data sent to Revenium! Check your dashboard");
-}
-
-main().catch(console.error);
+/**
+ * Basic Example
+ * Demonstrates basic usage of Revenium Perplexity middleware.
+ */
+
+import { Initialize, GetClient, UsageMetadata } from "@revenium/perplexity";
+
+async function main() {
+  // Initialize middleware
+  Initialize();
+
+  // Get client
+  const client = GetClient();
+  const metadata: UsageMetadata = {
+    organizationId: "org-basic-demo",
+    productId: "prod-perplexity-basic",
+  };
+
+  // Create chat completion
+  const response = await client
+    .chat()
+    .completions()
+    .create(
+      {
+        model: "sonar-pro",
+        messages: [
+          {
+            role: "user",
+            content:
+              "Say hello in Spanish and explain why Spanish is a beautiful language in 2-3 sentences.",
+          },
+        ],
+        max_tokens: 1000,
+      },
+      metadata
+    );
+
+  // Display response
+  if (response.choices.length > 0) {
+    console.log(`Assistant: ${response.choices[0].message.content}`);
+  }
+  console.log("\nUsage data sent to Revenium! Check your dashboard");
+}
+
+main().catch(console.error);

package/examples/getting_started.ts

@@ -1,41 +1,41 @@
-/**
- * Getting Started with Revenium Perplexity Middleware
- *
- * This example shows the new Initialize/GetClient pattern.
- */
-
-import { Initialize, GetClient, UsageMetadata } from "@revenium/perplexity";
-
-async function main() {
-  Initialize();
-
-  // Get client
-  const client = GetClient();
-  const metadata: UsageMetadata = {
-    organizationId: "org-getting-started",
-    productId: "prod-perplexity-getting-started",
-  };
-
-  // Create a simple chat completion
-  const response = await client
-    .chat()
-    .completions()
-    .create(
-      {
-        model: "sonar-pro",
-        messages: [
-          {
-            role: "user",
-            content: "What is artificial intelligence?",
-          },
-        ],
-        max_tokens: 500,
-      },
-      metadata
-    );
-
-  console.log("Assistant:", response.choices[0]?.message?.content);
-  console.log("\nUsage:", response.usage);
-}
-
-main().catch(console.error);
+/**
+ * Getting Started with Revenium Perplexity Middleware
+ *
+ * This example shows the new Initialize/GetClient pattern.
+ */
+
+import { Initialize, GetClient, UsageMetadata } from "@revenium/perplexity";
+
+async function main() {
+  Initialize();
+
+  // Get client
+  const client = GetClient();
+  const metadata: UsageMetadata = {
+    organizationId: "org-getting-started",
+    productId: "prod-perplexity-getting-started",
+  };
+
+  // Create a simple chat completion
+  const response = await client
+    .chat()
+    .completions()
+    .create(
+      {
+        model: "sonar-pro",
+        messages: [
+          {
+            role: "user",
+            content: "What is artificial intelligence?",
+          },
+        ],
+        max_tokens: 500,
+      },
+      metadata
+    );
+
+  console.log("Assistant:", response.choices[0]?.message?.content);
+  console.log("\nUsage:", response.usage);
+}
+
+main().catch(console.error);

package/examples/metadata.ts

@@ -1,68 +1,68 @@
-/**
- * Metadata Example
- * Demonstrates advanced metadata usage with Revenium Perplexity middleware.
- */
-
-import { Initialize, GetClient, UsageMetadata } from "@revenium/perplexity";
-
-async function main() {
-  // Initialize middleware
-  Initialize();
-
-  // Get client
-  const client = GetClient();
-
-  // Optional metadata for advanced reporting, lineage tracking, and cost allocation
-  const metadata: UsageMetadata = {
-    // Organization & billing
-    organizationId: "org-metadata-demo",
-    subscriptionId: "plan-premium-2025",
-
-    // Product & task tracking
-    productId: "ai-assistant",
-    taskType: "explanation-request",
-    agent: "perplexity-metadata-chat-node",
-
-    // Session tracking
-    traceId: "session-" + Date.now(),
-
-    // Quality metrics
-    responseQualityScore: 0.95, // 0.0-1.0 scale
-
-    // User tracking
-    subscriber: {
-      id: "user-12345",
-      email: "developer@company.com",
-      credential: {
-        name: "api-key-prod",
-        value: "key-abc-123",
-      },
-    },
-  };
-
-  const response = await client
-    .chat()
-    .completions()
-    .create(
-      {
-        model: "sonar-pro",
-        messages: [
-          {
-            role: "user",
-            content:
-              "Say hello in Spanish and explain why Spanish is a beautiful language in 2-3 sentences.",
-          },
-        ],
-        max_tokens: 1000,
-      },
-      metadata
-    );
-
-  // Display response
-  if (response.choices.length > 0) {
-    console.log(`Assistant: ${response.choices[0].message.content}`);
-  }
-  console.log("\nUsage data sent to Revenium! Check your dashboard");
-}
-
-main().catch(console.error);
+/**
+ * Metadata Example
+ * Demonstrates advanced metadata usage with Revenium Perplexity middleware.
+ */
+
+import { Initialize, GetClient, UsageMetadata } from "@revenium/perplexity";
+
+async function main() {
+  // Initialize middleware
+  Initialize();
+
+  // Get client
+  const client = GetClient();
+
+  // Optional metadata for advanced reporting, lineage tracking, and cost allocation
+  const metadata: UsageMetadata = {
+    // Organization & billing
+    organizationId: "org-metadata-demo",
+    subscriptionId: "plan-premium-2025",
+
+    // Product & task tracking
+    productId: "ai-assistant",
+    taskType: "explanation-request",
+    agent: "perplexity-metadata-chat-node",
+
+    // Session tracking
+    traceId: "session-" + Date.now(),
+
+    // Quality metrics
+    responseQualityScore: 0.95, // 0.0-1.0 scale
+
+    // User tracking
+    subscriber: {
+      id: "user-12345",
+      email: "developer@company.com",
+      credential: {
+        name: "api-key-prod",
+        value: "key-abc-123",
+      },
+    },
+  };
+
+  const response = await client
+    .chat()
+    .completions()
+    .create(
+      {
+        model: "sonar-pro",
+        messages: [
+          {
+            role: "user",
+            content:
+              "Say hello in Spanish and explain why Spanish is a beautiful language in 2-3 sentences.",
+          },
+        ],
+        max_tokens: 1000,
+      },
+      metadata
+    );
+
+  // Display response
+  if (response.choices.length > 0) {
+    console.log(`Assistant: ${response.choices[0].message.content}`);
+  }
+  console.log("\nUsage data sent to Revenium! Check your dashboard");
+}
+
+main().catch(console.error);

package/examples/stream.ts

@@ -1,53 +1,53 @@
-/**
- * Streaming Example with Revenium Perplexity Middleware (New Go-Aligned API)
- *
- * This example shows how to use streaming with the new API.
- */
-
-import { Initialize, GetClient } from "@revenium/perplexity";
-
-async function main() {
-  // Initialize from environment variables
-  Initialize();
-
-  // Get client
-  const client = GetClient();
-
-  console.log("Streaming response:\n");
-
-  // Create a streaming chat completion
-  const stream = await client
-    .chat()
-    .completions()
-    .createStreaming(
-      {
-        model: "sonar-pro",
-        messages: [
-          {
-            role: "user",
-            content: "Write a short poem about AI",
-          },
-        ],
-        max_tokens: 200,
-      },
-      {
-        // Optional metadata
-        organizationId: "my-customers-name",
-        productId: "my-product",
-        subscriber: {
-          id: "user-123",
-          email: "user@example.com",
-        },
-      }
-    );
-
-  // Process stream
-  for await (const chunk of stream) {
-    const content = chunk.choices[0]?.delta?.content || "";
-    process.stdout.write(content);
-  }
-
-  console.log("\n\nUsage data sent to Revenium! Check your dashboard");
-}
-
-main().catch(console.error);
+/**
+ * Streaming Example with Revenium Perplexity Middleware
+ *
+ * This example shows how to use streaming with the new API.
+ */
+
+import { Initialize, GetClient } from "@revenium/perplexity";
+
+async function main() {
+  // Initialize from environment variables
+  Initialize();
+
+  // Get client
+  const client = GetClient();
+
+  console.log("Streaming response:\n");
+
+  // Create a streaming chat completion
+  const stream = await client
+    .chat()
+    .completions()
+    .createStreaming(
+      {
+        model: "sonar-pro",
+        messages: [
+          {
+            role: "user",
+            content: "Write a short poem about AI",
+          },
+        ],
+        max_tokens: 200,
+      },
+      {
+        // Optional metadata
+        organizationId: "my-customers-name",
+        productId: "my-product",
+        subscriber: {
+          id: "user-123",
+          email: "user@example.com",
+        },
+      }
+    );
+
+  // Process stream
+  for await (const chunk of stream) {
+    const content = chunk.choices[0]?.delta?.content || "";
+    process.stdout.write(content);
+  }
+
+  console.log("\n\nUsage data sent to Revenium! Check your dashboard");
+}
+
+main().catch(console.error);