@posthog/ai 6.1.2 → 6.3.0

package/dist/openai/index.d.ts

@@ -22,6 +22,7 @@ interface CostOverride {
 declare const Chat: typeof OpenAI.Chat;
 declare const Completions: typeof OpenAI.Chat.Completions;
 declare const Responses: typeof OpenAI.Responses;
+declare const Embeddings: typeof OpenAI.Embeddings;
 type ChatCompletion = OpenAI.ChatCompletion;
 type ChatCompletionChunk = OpenAI.ChatCompletionChunk;
 type ChatCompletionCreateParamsBase = OpenAI.Chat.Completions.ChatCompletionCreateParams;
@@ -30,6 +31,8 @@ type ChatCompletionCreateParamsStreaming = OpenAI.Chat.Completions.ChatCompletio
 type ResponsesCreateParamsBase = OpenAI.Responses.ResponseCreateParams;
 type ResponsesCreateParamsNonStreaming = OpenAI.Responses.ResponseCreateParamsNonStreaming;
 type ResponsesCreateParamsStreaming = OpenAI.Responses.ResponseCreateParamsStreaming;
+type CreateEmbeddingResponse = OpenAI.CreateEmbeddingResponse;
+type EmbeddingCreateParams = OpenAI.EmbeddingCreateParams;
 interface MonitoringOpenAIConfig extends ClientOptions {
     apiKey: string;
     posthog: PostHog;
@@ -40,6 +43,7 @@ declare class PostHogOpenAI extends OpenAI {
     private readonly phClient;
     chat: WrappedChat;
     responses: WrappedResponses;
+    embeddings: WrappedEmbeddings;
     constructor(config: MonitoringOpenAIConfig);
 }
 declare class WrappedChat extends Chat {
@@ -48,6 +52,7 @@ declare class WrappedChat extends Chat {
 }
 declare class WrappedCompletions extends Completions {
     private readonly phClient;
+    private readonly baseURL;
     constructor(client: OpenAI, phClient: PostHog);
     create(body: ChatCompletionCreateParamsNonStreaming & MonitoringParams, options?: RequestOptions): APIPromise<ChatCompletion>;
     create(body: ChatCompletionCreateParamsStreaming & MonitoringParams, options?: RequestOptions): APIPromise<Stream<ChatCompletionChunk>>;
@@ -55,11 +60,18 @@ declare class WrappedCompletions extends Completions {
 }
 declare class WrappedResponses extends Responses {
     private readonly phClient;
+    private readonly baseURL;
     constructor(client: OpenAI, phClient: PostHog);
     create(body: ResponsesCreateParamsNonStreaming & MonitoringParams, options?: RequestOptions): APIPromise<OpenAI.Responses.Response>;
     create(body: ResponsesCreateParamsStreaming & MonitoringParams, options?: RequestOptions): APIPromise<Stream<OpenAI.Responses.ResponseStreamEvent>>;
     create(body: ResponsesCreateParamsBase & MonitoringParams, options?: RequestOptions): APIPromise<OpenAI.Responses.Response | Stream<OpenAI.Responses.ResponseStreamEvent>>;
     parse<Params extends ResponsesCreateParamsBase, ParsedT = any>(body: Params & MonitoringParams, options?: RequestOptions): APIPromise<ParsedResponse<ParsedT>>;
 }
+declare class WrappedEmbeddings extends Embeddings {
+    private readonly phClient;
+    private readonly baseURL;
+    constructor(client: OpenAI, phClient: PostHog);
+    create(body: EmbeddingCreateParams & MonitoringParams, options?: RequestOptions): APIPromise<CreateEmbeddingResponse>;
+}
 
-export { PostHogOpenAI as OpenAI, PostHogOpenAI, WrappedChat, WrappedCompletions, WrappedResponses, PostHogOpenAI as default };
+export { PostHogOpenAI as OpenAI, PostHogOpenAI, WrappedChat, WrappedCompletions, WrappedEmbeddings, WrappedResponses, PostHogOpenAI as default };

package/dist/openai/index.mjs

@@ -2,6 +2,8 @@ import { OpenAI } from 'openai';
 import { v4 } from 'uuid';
 import { Buffer } from 'buffer';
 
+var version = "6.3.0";
+
 const STRING_FORMAT = 'utf8';
 const getModelParams = params => {
   if (!params) {
@@ -122,6 +124,11 @@ const extractAvailableToolCalls = (provider, params) => {
     return null;
   }
 };
+let AIEvent = /*#__PURE__*/function (AIEvent) {
+  AIEvent["Generation"] = "$ai_generation";
+  AIEvent["Embedding"] = "$ai_embedding";
+  return AIEvent;
+}({});
 function sanitizeValues(obj) {
   if (obj === undefined || obj === null) {
     return obj;
@@ -138,6 +145,7 @@ function sanitizeValues(obj) {
 }
 const sendEventToPosthog = async ({
   client,
+  eventType = AIEvent.Generation,
   distinctId,
   traceId,
   model,
@@ -190,6 +198,8 @@ const sendEventToPosthog = async ({
     } : {})
   };
   const properties = {
+    $ai_lib: 'posthog-ai',
+    $ai_lib_version: version,
     $ai_provider: params.posthogProviderOverride ?? provider,
     $ai_model: params.posthogModelOverride ?? model,
     $ai_model_parameters: getModelParams(params),
@@ -197,7 +207,9 @@ const sendEventToPosthog = async ({
     $ai_output_choices: withPrivacyMode(client, params.posthogPrivacyMode ?? false, safeOutput),
     $ai_http_status: httpStatus,
     $ai_input_tokens: usage.inputTokens ?? 0,
-    $ai_output_tokens: usage.outputTokens ?? 0,
+    ...(usage.outputTokens !== undefined ? {
+      $ai_output_tokens: usage.outputTokens
+    } : {}),
     ...additionalTokenValues,
     $ai_latency: latency,
     $ai_trace_id: traceId,
@@ -214,7 +226,7 @@ const sendEventToPosthog = async ({
   };
   const event = {
     distinctId: distinctId ?? traceId,
-    event: '$ai_generation',
+    event: eventType,
     properties,
     groups: params.posthogGroups
   };
@@ -352,6 +364,7 @@ const sanitizeOpenAIResponse = data => {
 const Chat = OpenAI.Chat;
 const Completions = Chat.Completions;
 const Responses = OpenAI.Responses;
+const Embeddings = OpenAI.Embeddings;
 class PostHogOpenAI extends OpenAI {
   constructor(config) {
     const {
@@ -362,6 +375,7 @@ class PostHogOpenAI extends OpenAI {
     this.phClient = posthog;
     this.chat = new WrappedChat(this, this.phClient);
     this.responses = new WrappedResponses(this, this.phClient);
+    this.embeddings = new WrappedEmbeddings(this, this.phClient);
   }
 }
 class WrappedChat extends Chat {
@@ -374,6 +388,7 @@ class WrappedCompletions extends Completions {
   constructor(client, phClient) {
     super(client);
     this.phClient = phClient;
+    this.baseURL = client.baseURL;
   }
 
   // --- Overload #1: Non-streaming
@@ -387,10 +402,6 @@ class WrappedCompletions extends Completions {
     const {
       posthogDistinctId,
       posthogTraceId,
-      posthogProperties,
-      // eslint-disable-next-line @typescript-eslint/no-unused-vars
-      posthogPrivacyMode = false,
-      posthogGroups,
       posthogCaptureImmediate,
       ...openAIParams
     } = body;
@@ -507,7 +518,7 @@ class WrappedCompletions extends Completions {
                 input: sanitizeOpenAI(openAIParams.messages),
                 output: formattedOutput,
                 latency,
-                baseURL: this.baseURL ?? '',
+                baseURL: this.baseURL,
                 params: body,
                 httpStatus: 200,
                 usage,
@@ -525,7 +536,7 @@ class WrappedCompletions extends Completions {
                 input: sanitizeOpenAI(openAIParams.messages),
                 output: [],
                 latency: 0,
-                baseURL: this.baseURL ?? '',
+                baseURL: this.baseURL,
                 params: body,
                 httpStatus,
                 usage: {
@@ -558,7 +569,7 @@ class WrappedCompletions extends Completions {
             input: sanitizeOpenAI(openAIParams.messages),
             output: formatResponseOpenAI(result),
             latency,
-            baseURL: this.baseURL ?? '',
+            baseURL: this.baseURL,
             params: body,
             httpStatus: 200,
             usage: {
@@ -583,7 +594,7 @@ class WrappedCompletions extends Completions {
           input: sanitizeOpenAI(openAIParams.messages),
           output: [],
           latency: 0,
-          baseURL: this.baseURL ?? '',
+          baseURL: this.baseURL,
           params: body,
           httpStatus,
           usage: {
@@ -604,6 +615,7 @@ class WrappedResponses extends Responses {
   constructor(client, phClient) {
     super(client);
     this.phClient = phClient;
+    this.baseURL = client.baseURL;
   }
 
   // --- Overload #1: Non-streaming
@@ -617,10 +629,6 @@ class WrappedResponses extends Responses {
     const {
       posthogDistinctId,
       posthogTraceId,
-      posthogProperties,
-      // eslint-disable-next-line @typescript-eslint/no-unused-vars
-      posthogPrivacyMode = false,
-      posthogGroups,
       posthogCaptureImmediate,
       ...openAIParams
     } = body;
@@ -663,7 +671,7 @@ class WrappedResponses extends Responses {
                 input: sanitizeOpenAIResponse(openAIParams.input),
                 output: finalContent,
                 latency,
-                baseURL: this.baseURL ?? '',
+                baseURL: this.baseURL,
                 params: body,
                 httpStatus: 200,
                 usage,
@@ -682,7 +690,7 @@ class WrappedResponses extends Responses {
                 input: sanitizeOpenAIResponse(openAIParams.input),
                 output: [],
                 latency: 0,
-                baseURL: this.baseURL ?? '',
+                baseURL: this.baseURL,
                 params: body,
                 httpStatus,
                 usage: {
@@ -716,7 +724,7 @@ class WrappedResponses extends Responses {
               output: result.output
             }),
             latency,
-            baseURL: this.baseURL ?? '',
+            baseURL: this.baseURL,
             params: body,
             httpStatus: 200,
             usage: {
@@ -742,7 +750,7 @@ class WrappedResponses extends Responses {
           input: sanitizeOpenAIResponse(openAIParams.input),
           output: [],
           latency: 0,
-          baseURL: this.baseURL ?? '',
+          baseURL: this.baseURL,
           params: body,
           httpStatus,
           usage: {
@@ -762,10 +770,6 @@ class WrappedResponses extends Responses {
     const {
       posthogDistinctId,
       posthogTraceId,
-      posthogProperties,
-      // eslint-disable-next-line @typescript-eslint/no-unused-vars
-      posthogPrivacyMode = false,
-      posthogGroups,
       posthogCaptureImmediate,
       ...openAIParams
     } = body;
@@ -791,7 +795,7 @@ class WrappedResponses extends Responses {
           input: sanitizeOpenAIResponse(openAIParams.input),
           output: result.output,
           latency,
-          baseURL: this.baseURL ?? '',
+          baseURL: this.baseURL,
           params: body,
           httpStatus: 200,
           usage: {
@@ -815,7 +819,7 @@ class WrappedResponses extends Responses {
           input: sanitizeOpenAIResponse(openAIParams.input),
           output: [],
           latency: 0,
-          baseURL: this.baseURL ?? '',
+          baseURL: this.baseURL,
           params: body,
           httpStatus,
           usage: {
@@ -835,6 +839,73 @@ class WrappedResponses extends Responses {
     }
   }
 }
+class WrappedEmbeddings extends Embeddings {
+  constructor(client, phClient) {
+    super(client);
+    this.phClient = phClient;
+    this.baseURL = client.baseURL;
+  }
+  create(body, options) {
+    const {
+      posthogDistinctId,
+      posthogTraceId,
+      posthogPrivacyMode = false,
+      posthogCaptureImmediate,
+      ...openAIParams
+    } = body;
+    const traceId = posthogTraceId ?? v4();
+    const startTime = Date.now();
+    const parentPromise = super.create(openAIParams, options);
+    const wrappedPromise = parentPromise.then(async result => {
+      const latency = (Date.now() - startTime) / 1000;
+      await sendEventToPosthog({
+        client: this.phClient,
+        eventType: AIEvent.Embedding,
+        distinctId: posthogDistinctId,
+        traceId,
+        model: openAIParams.model,
+        provider: 'openai',
+        input: withPrivacyMode(this.phClient, posthogPrivacyMode, openAIParams.input),
+        output: null,
+        // Embeddings don't have output content
+        latency,
+        baseURL: this.baseURL,
+        params: body,
+        httpStatus: 200,
+        usage: {
+          inputTokens: result.usage?.prompt_tokens ?? 0
+        },
+        captureImmediate: posthogCaptureImmediate
+      });
+      return result;
+    }, async error => {
+      const httpStatus = error && typeof error === 'object' && 'status' in error ? error.status ?? 500 : 500;
+      await sendEventToPosthog({
+        client: this.phClient,
+        eventType: AIEvent.Embedding,
+        distinctId: posthogDistinctId,
+        traceId,
+        model: openAIParams.model,
+        provider: 'openai',
+        input: withPrivacyMode(this.phClient, posthogPrivacyMode, openAIParams.input),
+        output: null,
+        // Embeddings don't have output content
+        latency: 0,
+        baseURL: this.baseURL,
+        params: body,
+        httpStatus,
+        usage: {
+          inputTokens: 0
+        },
+        isError: true,
+        error: JSON.stringify(error),
+        captureImmediate: posthogCaptureImmediate
+      });
+      throw error;
+    });
+    return wrappedPromise;
+  }
+}
 
-export { PostHogOpenAI as OpenAI, PostHogOpenAI, WrappedChat, WrappedCompletions, WrappedResponses, PostHogOpenAI as default };
+export { PostHogOpenAI as OpenAI, PostHogOpenAI, WrappedChat, WrappedCompletions, WrappedEmbeddings, WrappedResponses, PostHogOpenAI as default };
 //# sourceMappingURL=index.mjs.map