@usagetap/sdk 1.0.0 → 1.2.0

package/dist/adapters/openai.d.cts

@@ -1,5 +1,5 @@
 import OpenAI from 'openai';
-import { B as BeginCallRequest, U as UsageTapClient, W as WithUsageOptions, V as VendorHints, a as UsageTapSuccessResponse, b as BeginCallResponseBody, E as EndCallRequest } from '../client-BHNMYvlO.cjs';
+import { B as BeginCallRequest, P as PromptCompressionProvider, U as UsageTapClient, W as WithUsageOptions, a as PromptCompressionTelemetry, V as VendorHints, b as UsageTapSuccessResponse, c as BeginCallResponseBody, E as EndCallRequest } from '../client-EMXt9_fA.cjs';
 
 interface OpenAIAdapterInit {
     client: OpenAI;
@@ -41,9 +41,67 @@ interface OpenAIAdapter {
 }
 type ReplaceProperty<T, K extends keyof T, V> = Omit<T, K> & Record<K, V>;
 type WrapOpenAIContext = BeginCallRequest;
+type OpenAIPromptCompressionRole = "system" | "user" | "tool" | "assistant";
+interface OpenAIPromptCompressionRoleOptions {
+    enabled?: boolean;
+    provider?: PromptCompressionProvider;
+    minTokens?: number;
+    aggressiveness?: number;
+    /** @deprecated Use aggressiveness instead. */
+    tokenCompanyAggressiveness?: number;
+    /** @deprecated Use aggressiveness instead. */
+    usageTapCompressionAggressiveness?: number;
+}
+type OpenAIPromptCompressionRoleSetting = boolean | OpenAIPromptCompressionRoleOptions;
+interface OpenAIPromptCompressionOptions {
+    enabled?: boolean;
+    provider?: PromptCompressionProvider;
+    roles?: Partial<Record<OpenAIPromptCompressionRole, OpenAIPromptCompressionRoleSetting>>;
+    minTokens?: number;
+    failOpen?: boolean;
+    tokenCompanyModel?: string;
+    aggressiveness?: number | Partial<Record<OpenAIPromptCompressionRole, number>>;
+    /** @deprecated Use aggressiveness instead. */
+    tokenCompanyAggressiveness?: number | Partial<Record<OpenAIPromptCompressionRole, number>>;
+    tokenCompanyAppId?: string;
+    usageTapCompressionModel?: string;
+    /** @deprecated Use aggressiveness instead. */
+    usageTapCompressionAggressiveness?: number | Partial<Record<OpenAIPromptCompressionRole, number>>;
+}
+interface OpenAIPromptCompressionTurnStats extends PromptCompressionTelemetry {
+    callId: string;
+    operation: "chat.completions.create" | "chat.completions.stream" | "responses.create";
+    messagesCompressed: number;
+    timestamp: number;
+}
+interface OpenAIPromptCompressionFailure {
+    callId: string;
+    operation: OpenAIPromptCompressionTurnStats["operation"];
+    stage: "telemetry";
+    message: string;
+    timestamp: number;
+}
+declare class OpenAIPromptCompressionStats {
+    history: OpenAIPromptCompressionTurnStats[];
+    failures: OpenAIPromptCompressionFailure[];
+    _record(turn: OpenAIPromptCompressionTurnStats): void;
+    _recordFailure(failure: OpenAIPromptCompressionFailure): void;
+    get totalOriginalTokens(): number;
+    get totalCompressedTokens(): number;
+    get totalTokensSaved(): number;
+    get totalOriginalCharacters(): number;
+    get totalCompressedCharacters(): number;
+    get totalCharactersSaved(): number;
+    get calls(): number;
+    get telemetryFailures(): number;
+    get failOpenEvents(): number;
+    get tokenSavingsRatio(): number;
+    get savingsRatio(): number;
+}
 interface WrapOpenAIOptions {
     defaultContext?: Partial<WrapOpenAIContext>;
     applyVendorHints?: boolean;
+    promptCompression?: boolean | OpenAIPromptCompressionOptions;
 }
 type ChatCompletionsResource = OpenAI["chat"]["completions"];
 type ChatCompletionCreate = ChatCompletionsResource["create"];
@@ -53,9 +111,11 @@ type ChatCompletionCreateReturn = ReturnType<ChatCompletionCreate>;
 type WrapOpenAICallOptions = (ChatCompletionCreateOptions extends undefined ? {
     usageTap?: Partial<WrapOpenAIContext>;
     withUsage?: WithUsageOptions;
+    promptCompression?: boolean | OpenAIPromptCompressionOptions;
 } : ChatCompletionCreateOptions & {
     usageTap?: Partial<WrapOpenAIContext>;
     withUsage?: WithUsageOptions;
+    promptCompression?: boolean | OpenAIPromptCompressionOptions;
 });
 interface WrappedChatCompletions extends Omit<ChatCompletionsResource, "create"> {
     create: (params: ChatCompletionCreateParams, options?: WrapOpenAICallOptions) => ChatCompletionCreateReturn;
@@ -72,9 +132,11 @@ type ResponsesCreateReturn = ResponsesCreate extends (...args: unknown[]) => inf
 type WrapOpenAIResponseCallOptions = (ResponsesCreateOptions extends undefined ? {
     usageTap?: Partial<WrapOpenAIContext>;
     withUsage?: WithUsageOptions;
+    promptCompression?: boolean | OpenAIPromptCompressionOptions;
 } : ResponsesCreateOptions & {
     usageTap?: Partial<WrapOpenAIContext>;
     withUsage?: WithUsageOptions;
+    promptCompression?: boolean | OpenAIPromptCompressionOptions;
 });
 type WrappedResponses = ResponsesResource extends undefined ? undefined : Omit<NonNullable<ResponsesResource>, "create"> & {
     create: (params: ResponsesCreateParams, options?: WrapOpenAIResponseCallOptions) => ResponsesCreateReturn;
@@ -88,6 +150,7 @@ type WrappedOpenAI = OpenAI & {
 }) & {
     toNextResponse: typeof toNextResponse;
     pipeToResponse: typeof pipeToResponse;
+    promptCompression: OpenAIPromptCompressionStats;
     unwrap: () => OpenAI;
 };
 interface StreamOpenAIRouteOptions {
@@ -95,6 +158,7 @@ interface StreamOpenAIRouteOptions {
         params: ChatCompletionCreateParams;
         usageTap?: Partial<WrapOpenAIContext>;
         withUsage?: WithUsageOptions;
+        promptCompression?: boolean | OpenAIPromptCompressionOptions;
     }>;
     wrapOptions?: WrapOpenAIOptions;
     defaultContext?: Partial<WrapOpenAIContext>;
@@ -132,4 +196,4 @@ interface NodeResponseLike {
     flush?(): void;
 }
 
-export { type NodeResponseLike, type OpenAIAdapter, type OpenAIAdapterInit, type OpenAIInvokeParams, type OpenAIInvokeResult, type OpenAIRequestContext, type OpenAIStreamCallResult, type OpenAIStreamParams, type OpenAIStreamResult, type StreamMode, type StreamOpenAIRouteOptions, type StreamToResponseOptions, type UsageTapStream, type WrapOpenAICallOptions, type WrapOpenAIContext, type WrapOpenAIOptions, type WrapOpenAIResponseCallOptions, type WrappedOpenAI, createOpenAIAdapter, pipeToResponse, streamOpenAIRoute, toNextResponse, wrapOpenAI };
+export { type NodeResponseLike, type OpenAIAdapter, type OpenAIAdapterInit, type OpenAIInvokeParams, type OpenAIInvokeResult, type OpenAIPromptCompressionFailure, type OpenAIPromptCompressionOptions, type OpenAIPromptCompressionRole, type OpenAIPromptCompressionRoleOptions, type OpenAIPromptCompressionRoleSetting, OpenAIPromptCompressionStats, type OpenAIPromptCompressionTurnStats, type OpenAIRequestContext, type OpenAIStreamCallResult, type OpenAIStreamParams, type OpenAIStreamResult, type StreamMode, type StreamOpenAIRouteOptions, type StreamToResponseOptions, type UsageTapStream, type WrapOpenAICallOptions, type WrapOpenAIContext, type WrapOpenAIOptions, type WrapOpenAIResponseCallOptions, type WrappedOpenAI, createOpenAIAdapter, pipeToResponse, streamOpenAIRoute, toNextResponse, wrapOpenAI };

package/dist/adapters/openai.d.ts

@@ -1,5 +1,5 @@
 import OpenAI from 'openai';
-import { B as BeginCallRequest, U as UsageTapClient, W as WithUsageOptions, V as VendorHints, a as UsageTapSuccessResponse, b as BeginCallResponseBody, E as EndCallRequest } from '../client-BHNMYvlO.js';
+import { B as BeginCallRequest, P as PromptCompressionProvider, U as UsageTapClient, W as WithUsageOptions, a as PromptCompressionTelemetry, V as VendorHints, b as UsageTapSuccessResponse, c as BeginCallResponseBody, E as EndCallRequest } from '../client-EMXt9_fA.js';
 
 interface OpenAIAdapterInit {
     client: OpenAI;
@@ -41,9 +41,67 @@ interface OpenAIAdapter {
 }
 type ReplaceProperty<T, K extends keyof T, V> = Omit<T, K> & Record<K, V>;
 type WrapOpenAIContext = BeginCallRequest;
+type OpenAIPromptCompressionRole = "system" | "user" | "tool" | "assistant";
+interface OpenAIPromptCompressionRoleOptions {
+    enabled?: boolean;
+    provider?: PromptCompressionProvider;
+    minTokens?: number;
+    aggressiveness?: number;
+    /** @deprecated Use aggressiveness instead. */
+    tokenCompanyAggressiveness?: number;
+    /** @deprecated Use aggressiveness instead. */
+    usageTapCompressionAggressiveness?: number;
+}
+type OpenAIPromptCompressionRoleSetting = boolean | OpenAIPromptCompressionRoleOptions;
+interface OpenAIPromptCompressionOptions {
+    enabled?: boolean;
+    provider?: PromptCompressionProvider;
+    roles?: Partial<Record<OpenAIPromptCompressionRole, OpenAIPromptCompressionRoleSetting>>;
+    minTokens?: number;
+    failOpen?: boolean;
+    tokenCompanyModel?: string;
+    aggressiveness?: number | Partial<Record<OpenAIPromptCompressionRole, number>>;
+    /** @deprecated Use aggressiveness instead. */
+    tokenCompanyAggressiveness?: number | Partial<Record<OpenAIPromptCompressionRole, number>>;
+    tokenCompanyAppId?: string;
+    usageTapCompressionModel?: string;
+    /** @deprecated Use aggressiveness instead. */
+    usageTapCompressionAggressiveness?: number | Partial<Record<OpenAIPromptCompressionRole, number>>;
+}
+interface OpenAIPromptCompressionTurnStats extends PromptCompressionTelemetry {
+    callId: string;
+    operation: "chat.completions.create" | "chat.completions.stream" | "responses.create";
+    messagesCompressed: number;
+    timestamp: number;
+}
+interface OpenAIPromptCompressionFailure {
+    callId: string;
+    operation: OpenAIPromptCompressionTurnStats["operation"];
+    stage: "telemetry";
+    message: string;
+    timestamp: number;
+}
+declare class OpenAIPromptCompressionStats {
+    history: OpenAIPromptCompressionTurnStats[];
+    failures: OpenAIPromptCompressionFailure[];
+    _record(turn: OpenAIPromptCompressionTurnStats): void;
+    _recordFailure(failure: OpenAIPromptCompressionFailure): void;
+    get totalOriginalTokens(): number;
+    get totalCompressedTokens(): number;
+    get totalTokensSaved(): number;
+    get totalOriginalCharacters(): number;
+    get totalCompressedCharacters(): number;
+    get totalCharactersSaved(): number;
+    get calls(): number;
+    get telemetryFailures(): number;
+    get failOpenEvents(): number;
+    get tokenSavingsRatio(): number;
+    get savingsRatio(): number;
+}
 interface WrapOpenAIOptions {
     defaultContext?: Partial<WrapOpenAIContext>;
     applyVendorHints?: boolean;
+    promptCompression?: boolean | OpenAIPromptCompressionOptions;
 }
 type ChatCompletionsResource = OpenAI["chat"]["completions"];
 type ChatCompletionCreate = ChatCompletionsResource["create"];
@@ -53,9 +111,11 @@ type ChatCompletionCreateReturn = ReturnType<ChatCompletionCreate>;
 type WrapOpenAICallOptions = (ChatCompletionCreateOptions extends undefined ? {
     usageTap?: Partial<WrapOpenAIContext>;
     withUsage?: WithUsageOptions;
+    promptCompression?: boolean | OpenAIPromptCompressionOptions;
 } : ChatCompletionCreateOptions & {
     usageTap?: Partial<WrapOpenAIContext>;
     withUsage?: WithUsageOptions;
+    promptCompression?: boolean | OpenAIPromptCompressionOptions;
 });
 interface WrappedChatCompletions extends Omit<ChatCompletionsResource, "create"> {
     create: (params: ChatCompletionCreateParams, options?: WrapOpenAICallOptions) => ChatCompletionCreateReturn;
@@ -72,9 +132,11 @@ type ResponsesCreateReturn = ResponsesCreate extends (...args: unknown[]) => inf
 type WrapOpenAIResponseCallOptions = (ResponsesCreateOptions extends undefined ? {
     usageTap?: Partial<WrapOpenAIContext>;
     withUsage?: WithUsageOptions;
+    promptCompression?: boolean | OpenAIPromptCompressionOptions;
 } : ResponsesCreateOptions & {
     usageTap?: Partial<WrapOpenAIContext>;
     withUsage?: WithUsageOptions;
+    promptCompression?: boolean | OpenAIPromptCompressionOptions;
 });
 type WrappedResponses = ResponsesResource extends undefined ? undefined : Omit<NonNullable<ResponsesResource>, "create"> & {
     create: (params: ResponsesCreateParams, options?: WrapOpenAIResponseCallOptions) => ResponsesCreateReturn;
@@ -88,6 +150,7 @@ type WrappedOpenAI = OpenAI & {
 }) & {
     toNextResponse: typeof toNextResponse;
     pipeToResponse: typeof pipeToResponse;
+    promptCompression: OpenAIPromptCompressionStats;
     unwrap: () => OpenAI;
 };
 interface StreamOpenAIRouteOptions {
@@ -95,6 +158,7 @@ interface StreamOpenAIRouteOptions {
         params: ChatCompletionCreateParams;
         usageTap?: Partial<WrapOpenAIContext>;
         withUsage?: WithUsageOptions;
+        promptCompression?: boolean | OpenAIPromptCompressionOptions;
     }>;
     wrapOptions?: WrapOpenAIOptions;
     defaultContext?: Partial<WrapOpenAIContext>;
@@ -132,4 +196,4 @@ interface NodeResponseLike {
     flush?(): void;
 }
 
-export { type NodeResponseLike, type OpenAIAdapter, type OpenAIAdapterInit, type OpenAIInvokeParams, type OpenAIInvokeResult, type OpenAIRequestContext, type OpenAIStreamCallResult, type OpenAIStreamParams, type OpenAIStreamResult, type StreamMode, type StreamOpenAIRouteOptions, type StreamToResponseOptions, type UsageTapStream, type WrapOpenAICallOptions, type WrapOpenAIContext, type WrapOpenAIOptions, type WrapOpenAIResponseCallOptions, type WrappedOpenAI, createOpenAIAdapter, pipeToResponse, streamOpenAIRoute, toNextResponse, wrapOpenAI };
+export { type NodeResponseLike, type OpenAIAdapter, type OpenAIAdapterInit, type OpenAIInvokeParams, type OpenAIInvokeResult, type OpenAIPromptCompressionFailure, type OpenAIPromptCompressionOptions, type OpenAIPromptCompressionRole, type OpenAIPromptCompressionRoleOptions, type OpenAIPromptCompressionRoleSetting, OpenAIPromptCompressionStats, type OpenAIPromptCompressionTurnStats, type OpenAIRequestContext, type OpenAIStreamCallResult, type OpenAIStreamParams, type OpenAIStreamResult, type StreamMode, type StreamOpenAIRouteOptions, type StreamToResponseOptions, type UsageTapStream, type WrapOpenAICallOptions, type WrapOpenAIContext, type WrapOpenAIOptions, type WrapOpenAIResponseCallOptions, type WrappedOpenAI, createOpenAIAdapter, pipeToResponse, streamOpenAIRoute, toNextResponse, wrapOpenAI };