@ai-sdk/openai-compatible 2.0.43 → 2.0.45

package/dist/internal/index.d.ts

@@ -1,6 +1,6 @@
 import { JSONValue, LanguageModelV3Prompt, LanguageModelV3Usage, LanguageModelV3FinishReason, LanguageModelV3CallOptions, SharedV3Warning, SharedV3ProviderMetadata, LanguageModelV3 } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
-import { ZodType } from 'zod/v4';
+import { ZodType, z } from 'zod/v4';
 
 type OpenAICompatibleChatPrompt = Array<OpenAICompatibleMessage>;
 type OpenAICompatibleMessage = OpenAICompatibleSystemMessage | OpenAICompatibleUserMessage | OpenAICompatibleAssistantMessage | OpenAICompatibleToolMessage;
@@ -188,6 +188,24 @@ type OpenAICompatibleChatConfig = {
      * than the official OpenAI API.
      */
     transformRequestBody?: (args: Record<string, any>) => Record<string, any>;
+    /**
+     * Optional usage converter for OpenAI-compatible providers with different
+     * token accounting semantics.
+     */
+    convertUsage?: (usage: z.infer<typeof openaiCompatibleTokenUsageSchema>) => LanguageModelV3Usage;
 };
+declare const openaiCompatibleTokenUsageSchema: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+    prompt_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    completion_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    total_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    prompt_tokens_details: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        cached_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>>;
+    completion_tokens_details: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        reasoning_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        accepted_prediction_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        rejected_prediction_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>>;
+}, z.core.$loose>>>;
 
 export { type OpenAICompatibleChatConfig, convertOpenAICompatibleChatUsage, convertToOpenAICompatibleChatMessages, getResponseMetadata, mapOpenAICompatibleFinishReason, prepareTools };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/openai-compatible",
-  "version": "2.0.43",
+  "version": "2.0.45",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -37,7 +37,7 @@
   },
   "dependencies": {
     "@ai-sdk/provider": "3.0.10",
-    "@ai-sdk/provider-utils": "4.0.25"
+    "@ai-sdk/provider-utils": "4.0.26"
   },
   "devDependencies": {
     "@types/node": "20.17.24",

package/src/chat/openai-compatible-chat-language-model.ts

@@ -8,6 +8,7 @@ import {
   type LanguageModelV3GenerateResult,
   type LanguageModelV3StreamPart,
   type LanguageModelV3StreamResult,
+  type LanguageModelV3Usage,
   type SharedV3ProviderMetadata,
   type SharedV3Warning,
 } from '@ai-sdk/provider';
@@ -66,6 +67,14 @@ export type OpenAICompatibleChatConfig = {
    * than the official OpenAI API.
    */
   transformRequestBody?: (args: Record<string, any>) => Record<string, any>;
+
+  /**
+   * Optional usage converter for OpenAI-compatible providers with different
+   * token accounting semantics.
+   */
+  convertUsage?: (
+    usage: z.infer<typeof openaiCompatibleTokenUsageSchema>,
+  ) => LanguageModelV3Usage;
 };
 
 export class OpenAICompatibleChatLanguageModel implements LanguageModelV3 {
@@ -112,6 +121,15 @@ export class OpenAICompatibleChatLanguageModel implements LanguageModelV3 {
     return this.config.transformRequestBody?.(args) ?? args;
   }
 
+  private convertUsage(
+    usage: z.infer<typeof openaiCompatibleTokenUsageSchema>,
+  ): LanguageModelV3Usage {
+    return (
+      this.config.convertUsage?.(usage) ??
+      convertOpenAICompatibleChatUsage(usage)
+    );
+  }
+
   private async getArgs({
     prompt,
     maxOutputTokens,
@@ -345,7 +363,7 @@ export class OpenAICompatibleChatLanguageModel implements LanguageModelV3 {
         unified: mapOpenAICompatibleFinishReason(choice.finish_reason),
         raw: choice.finish_reason ?? undefined,
       },
-      usage: convertOpenAICompatibleChatUsage(responseBody.usage),
+      usage: this.convertUsage(responseBody.usage),
       providerMetadata,
       request: { body },
       response: {
@@ -411,6 +429,9 @@ export class OpenAICompatibleChatLanguageModel implements LanguageModelV3 {
     const providerOptionsName = metadataKey;
     let isActiveReasoning = false;
     let isActiveText = false;
+    const convertUsage = (
+      usage: z.infer<typeof openaiCompatibleTokenUsageSchema>,
+    ) => this.convertUsage(usage);
 
     return {
       stream: response.pipeThrough(
@@ -719,7 +740,7 @@ export class OpenAICompatibleChatLanguageModel implements LanguageModelV3 {
             controller.enqueue({
               type: 'finish',
               finishReason,
-              usage: convertOpenAICompatibleChatUsage(usage),
+              usage: convertUsage(usage),
               providerMetadata,
             });
           },

package/src/openai-compatible-provider.ts

@@ -104,6 +104,17 @@ export interface OpenAICompatibleProviderSettings {
    * or provider-specific metrics from both streaming and non-streaming responses.
    */
   metadataExtractor?: MetadataExtractor;
+
+  /**
+   * The supported URLs for chat models.
+   */
+  supportedUrls?: OpenAICompatibleChatConfig['supportedUrls'];
+
+  /**
+   * Optional usage converter for providers with token accounting semantics that
+   * differ from the default OpenAI-compatible shape.
+   */
+  convertUsage?: OpenAICompatibleChatConfig['convertUsage'];
 }
 
 /**
@@ -161,8 +172,10 @@ export function createOpenAICompatible<
       ...getCommonModelConfig('chat'),
       includeUsage: options.includeUsage,
       supportsStructuredOutputs: options.supportsStructuredOutputs,
+      supportedUrls: options.supportedUrls,
       transformRequestBody: options.transformRequestBody,
       metadataExtractor: options.metadataExtractor,
+      convertUsage: options.convertUsage,
     });
 
   const createCompletionModel = (modelId: COMPLETION_MODEL_IDS) =>