@ai-sdk/openai-compatible 0.1.1 → 0.1.3

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @ai-sdk/openai-compatible
 
+## 0.1.3
+
+### Patch Changes
+
+- 361fd08: chore: update a few add'l processor references to extractor
+
+## 0.1.2
+
+### Patch Changes
+
+- ed012d2: feat (provider): add metadata extraction mechanism to openai-compatible providers
+- Updated dependencies [ed012d2]
+- Updated dependencies [3a58a2e]
+  - @ai-sdk/provider-utils@2.1.2
+  - @ai-sdk/provider@1.0.6
+
 ## 0.1.1
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { ProviderV1, LanguageModelV1, EmbeddingModelV1, LanguageModelV1ObjectGenerationMode } from '@ai-sdk/provider';
+import { LanguageModelV1ProviderMetadata, LanguageModelV1, LanguageModelV1ObjectGenerationMode, EmbeddingModelV1, ProviderV1 } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 import { z, ZodSchema } from 'zod';
 
@@ -18,94 +18,6 @@ interface OpenAICompatibleChatSettings {
     simulateStreaming?: boolean;
 }
 
-type OpenAICompatibleCompletionModelId = string;
-interface OpenAICompatibleCompletionSettings {
-    /**
-  Echo back the prompt in addition to the completion.
-     */
-    echo?: boolean;
-    /**
-  Modify the likelihood of specified tokens appearing in the completion.
-  
-  Accepts a JSON object that maps tokens (specified by their token ID in
-  the GPT tokenizer) to an associated bias value from -100 to 100. You
-  can use this tokenizer tool to convert text to token IDs. Mathematically,
-  the bias is added to the logits generated by the model prior to sampling.
-  The exact effect will vary per model, but values between -1 and 1 should
-  decrease or increase likelihood of selection; values like -100 or 100
-  should result in a ban or exclusive selection of the relevant token.
-  
-  As an example, you can pass {"50256": -100} to prevent the <|endoftext|>
-  token from being generated.
-     */
-    logitBias?: Record<number, number>;
-    /**
-  The suffix that comes after a completion of inserted text.
-     */
-    suffix?: string;
-    /**
-  A unique identifier representing your end-user, which can help OpenAI to
-  monitor and detect abuse. Learn more.
-     */
-    user?: string;
-}
-
-type OpenAICompatibleEmbeddingModelId = string;
-interface OpenAICompatibleEmbeddingSettings {
-    /**
-  The number of dimensions the resulting output embeddings should have.
-  Only supported in text-embedding-3 and later models.
-     */
-    dimensions?: number;
-    /**
-  A unique identifier representing your end-user, which can help OpenAI to
-  monitor and detect abuse. Learn more.
-  */
-    user?: string;
-}
-
-interface OpenAICompatibleProvider<CHAT_MODEL_IDS extends string = string, COMPLETION_MODEL_IDS extends string = string, EMBEDDING_MODEL_IDS extends string = string> extends ProviderV1 {
-    (modelId: CHAT_MODEL_IDS, settings?: OpenAICompatibleChatSettings): LanguageModelV1;
-    languageModel(modelId: CHAT_MODEL_IDS, settings?: OpenAICompatibleChatSettings): LanguageModelV1;
-    chatModel(modelId: CHAT_MODEL_IDS, settings?: OpenAICompatibleChatSettings): LanguageModelV1;
-    completionModel(modelId: COMPLETION_MODEL_IDS, settings?: OpenAICompatibleCompletionSettings): LanguageModelV1;
-    textEmbeddingModel(modelId: EMBEDDING_MODEL_IDS, settings?: OpenAICompatibleEmbeddingSettings): EmbeddingModelV1<string>;
-}
-interface OpenAICompatibleProviderSettings {
-    /**
-  Base URL for the API calls.
-     */
-    baseURL?: string;
-    /**
-  API key for authenticating requests. If specified, adds an `Authorization`
-  header to request headers with the value `Bearer <apiKey>`. This will be added
-  before any headers potentially specified in the `headers` option.
-     */
-    apiKey?: string;
-    /**
-  Optional custom headers to include in requests. These will be added to request headers
-  after any headers potentially added by use of the `apiKey` option.
-     */
-    headers?: Record<string, string>;
-    /**
-  Optional custom url query parameters to include in request urls.
-     */
-    queryParams?: Record<string, string>;
-    /**
-  Custom fetch implementation. You can use it as a middleware to intercept requests,
-  or to provide a custom fetch implementation for e.g. testing.
-     */
-    fetch?: FetchFunction;
-    /**
-  Provider name.
-     */
-    name?: string;
-}
-/**
-Create an OpenAICompatible provider instance.
- */
-declare function createOpenAICompatible<CHAT_MODEL_IDS extends string, COMPLETION_MODEL_IDS extends string, EMBEDDING_MODEL_IDS extends string>(options: OpenAICompatibleProviderSettings): OpenAICompatibleProvider<CHAT_MODEL_IDS, COMPLETION_MODEL_IDS, EMBEDDING_MODEL_IDS>;
-
 declare const openaiCompatibleErrorDataSchema: z.ZodObject<{
     error: z.ZodObject<{
         message: z.ZodString;
@@ -145,6 +57,49 @@ type ProviderErrorStructure<T> = {
     isRetryable?: (response: Response, error?: T) => boolean;
 };
 
+/**
+Extracts provider-specific metadata from API responses.
+Used to standardize metadata handling across different LLM providers while allowing
+provider-specific metadata to be captured.
+*/
+type MetadataExtractor = {
+    /**
+     * Extracts provider metadata from a complete, non-streaming response.
+     *
+     * @param parsedBody - The parsed response JSON body from the provider's API.
+     *
+     * @returns Provider-specific metadata or undefined if no metadata is available.
+     *          The metadata should be under a key indicating the provider id.
+     */
+    extractMetadata: ({ parsedBody, }: {
+        parsedBody: unknown;
+    }) => LanguageModelV1ProviderMetadata | undefined;
+    /**
+     * Creates an extractor for handling streaming responses. The returned object provides
+     * methods to process individual chunks and build the final metadata from the accumulated
+     * stream data.
+     *
+     * @returns An object with methods to process chunks and build metadata from a stream
+     */
+    createStreamExtractor: () => {
+        /**
+         * Process an individual chunk from the stream. Called for each chunk in the response stream
+         * to accumulate metadata throughout the streaming process.
+         *
+         * @param parsedChunk - The parsed JSON response chunk from the provider's API
+         */
+        processChunk(parsedChunk: unknown): void;
+        /**
+         * Builds the metadata object after all chunks have been processed.
+         * Called at the end of the stream to generate the complete provider metadata.
+         *
+         * @returns Provider-specific metadata or undefined if no metadata is available.
+         *          The metadata should be under a key indicating the provider id.
+         */
+        buildMetadata(): LanguageModelV1ProviderMetadata | undefined;
+    };
+};
+
 type OpenAICompatibleChatConfig = {
     provider: string;
     headers: () => Record<string, string | undefined>;
@@ -154,6 +109,7 @@ type OpenAICompatibleChatConfig = {
     }) => string;
     fetch?: FetchFunction;
     errorStructure?: ProviderErrorStructure<any>;
+    metadataExtractor?: MetadataExtractor;
     /**
   Default object generation mode that should be used with this model when
   no mode is specified. Should be the mode with the best results for this
@@ -181,6 +137,38 @@ declare class OpenAICompatibleChatLanguageModel implements LanguageModelV1 {
     doStream(options: Parameters<LanguageModelV1['doStream']>[0]): Promise<Awaited<ReturnType<LanguageModelV1['doStream']>>>;
 }
 
+type OpenAICompatibleCompletionModelId = string;
+interface OpenAICompatibleCompletionSettings {
+    /**
+  Echo back the prompt in addition to the completion.
+     */
+    echo?: boolean;
+    /**
+  Modify the likelihood of specified tokens appearing in the completion.
+  
+  Accepts a JSON object that maps tokens (specified by their token ID in
+  the GPT tokenizer) to an associated bias value from -100 to 100. You
+  can use this tokenizer tool to convert text to token IDs. Mathematically,
+  the bias is added to the logits generated by the model prior to sampling.
+  The exact effect will vary per model, but values between -1 and 1 should
+  decrease or increase likelihood of selection; values like -100 or 100
+  should result in a ban or exclusive selection of the relevant token.
+  
+  As an example, you can pass {"50256": -100} to prevent the <|endoftext|>
+  token from being generated.
+     */
+    logitBias?: Record<number, number>;
+    /**
+  The suffix that comes after a completion of inserted text.
+     */
+    suffix?: string;
+    /**
+  A unique identifier representing your end-user, which can help OpenAI to
+  monitor and detect abuse. Learn more.
+     */
+    user?: string;
+}
+
 type OpenAICompatibleCompletionConfig = {
     provider: string;
     headers: () => Record<string, string | undefined>;
@@ -206,6 +194,20 @@ declare class OpenAICompatibleCompletionLanguageModel implements LanguageModelV1
     doStream(options: Parameters<LanguageModelV1['doStream']>[0]): Promise<Awaited<ReturnType<LanguageModelV1['doStream']>>>;
 }
 
+type OpenAICompatibleEmbeddingModelId = string;
+interface OpenAICompatibleEmbeddingSettings {
+    /**
+  The number of dimensions the resulting output embeddings should have.
+  Only supported in text-embedding-3 and later models.
+     */
+    dimensions?: number;
+    /**
+  A unique identifier representing your end-user, which can help OpenAI to
+  monitor and detect abuse. Learn more.
+  */
+    user?: string;
+}
+
 type OpenAICompatibleEmbeddingConfig = {
     /**
   Override the maximum number of embeddings per call.
@@ -236,4 +238,46 @@ declare class OpenAICompatibleEmbeddingModel implements EmbeddingModelV1<string>
     doEmbed({ values, headers, abortSignal, }: Parameters<EmbeddingModelV1<string>['doEmbed']>[0]): Promise<Awaited<ReturnType<EmbeddingModelV1<string>['doEmbed']>>>;
 }
 
-export { OpenAICompatibleChatLanguageModel, type OpenAICompatibleChatSettings, OpenAICompatibleCompletionLanguageModel, type OpenAICompatibleCompletionSettings, OpenAICompatibleEmbeddingModel, type OpenAICompatibleEmbeddingSettings, type OpenAICompatibleErrorData, type OpenAICompatibleProvider, type OpenAICompatibleProviderSettings, type ProviderErrorStructure, createOpenAICompatible };
+interface OpenAICompatibleProvider<CHAT_MODEL_IDS extends string = string, COMPLETION_MODEL_IDS extends string = string, EMBEDDING_MODEL_IDS extends string = string> extends ProviderV1 {
+    (modelId: CHAT_MODEL_IDS, settings?: OpenAICompatibleChatSettings): LanguageModelV1;
+    languageModel(modelId: CHAT_MODEL_IDS, settings?: OpenAICompatibleChatSettings): LanguageModelV1;
+    chatModel(modelId: CHAT_MODEL_IDS, settings?: OpenAICompatibleChatSettings): LanguageModelV1;
+    completionModel(modelId: COMPLETION_MODEL_IDS, settings?: OpenAICompatibleCompletionSettings): LanguageModelV1;
+    textEmbeddingModel(modelId: EMBEDDING_MODEL_IDS, settings?: OpenAICompatibleEmbeddingSettings): EmbeddingModelV1<string>;
+}
+interface OpenAICompatibleProviderSettings {
+    /**
+  Base URL for the API calls.
+     */
+    baseURL?: string;
+    /**
+  API key for authenticating requests. If specified, adds an `Authorization`
+  header to request headers with the value `Bearer <apiKey>`. This will be added
+  before any headers potentially specified in the `headers` option.
+     */
+    apiKey?: string;
+    /**
+  Optional custom headers to include in requests. These will be added to request headers
+  after any headers potentially added by use of the `apiKey` option.
+     */
+    headers?: Record<string, string>;
+    /**
+  Optional custom url query parameters to include in request urls.
+     */
+    queryParams?: Record<string, string>;
+    /**
+  Custom fetch implementation. You can use it as a middleware to intercept requests,
+  or to provide a custom fetch implementation for e.g. testing.
+     */
+    fetch?: FetchFunction;
+    /**
+  Provider name.
+     */
+    name?: string;
+}
+/**
+Create an OpenAICompatible provider instance.
+ */
+declare function createOpenAICompatible<CHAT_MODEL_IDS extends string, COMPLETION_MODEL_IDS extends string, EMBEDDING_MODEL_IDS extends string>(options: OpenAICompatibleProviderSettings): OpenAICompatibleProvider<CHAT_MODEL_IDS, COMPLETION_MODEL_IDS, EMBEDDING_MODEL_IDS>;
+
+export { type MetadataExtractor, OpenAICompatibleChatLanguageModel, type OpenAICompatibleChatSettings, OpenAICompatibleCompletionLanguageModel, type OpenAICompatibleCompletionSettings, OpenAICompatibleEmbeddingModel, type OpenAICompatibleEmbeddingSettings, type OpenAICompatibleErrorData, type OpenAICompatibleProvider, type OpenAICompatibleProviderSettings, type ProviderErrorStructure, createOpenAICompatible };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ProviderV1, LanguageModelV1, EmbeddingModelV1, LanguageModelV1ObjectGenerationMode } from '@ai-sdk/provider';
+import { LanguageModelV1ProviderMetadata, LanguageModelV1, LanguageModelV1ObjectGenerationMode, EmbeddingModelV1, ProviderV1 } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 import { z, ZodSchema } from 'zod';
 
@@ -18,94 +18,6 @@ interface OpenAICompatibleChatSettings {
     simulateStreaming?: boolean;
 }
 
-type OpenAICompatibleCompletionModelId = string;
-interface OpenAICompatibleCompletionSettings {
-    /**
-  Echo back the prompt in addition to the completion.
-     */
-    echo?: boolean;
-    /**
-  Modify the likelihood of specified tokens appearing in the completion.
-  
-  Accepts a JSON object that maps tokens (specified by their token ID in
-  the GPT tokenizer) to an associated bias value from -100 to 100. You
-  can use this tokenizer tool to convert text to token IDs. Mathematically,
-  the bias is added to the logits generated by the model prior to sampling.
-  The exact effect will vary per model, but values between -1 and 1 should
-  decrease or increase likelihood of selection; values like -100 or 100
-  should result in a ban or exclusive selection of the relevant token.
-  
-  As an example, you can pass {"50256": -100} to prevent the <|endoftext|>
-  token from being generated.
-     */
-    logitBias?: Record<number, number>;
-    /**
-  The suffix that comes after a completion of inserted text.
-     */
-    suffix?: string;
-    /**
-  A unique identifier representing your end-user, which can help OpenAI to
-  monitor and detect abuse. Learn more.
-     */
-    user?: string;
-}
-
-type OpenAICompatibleEmbeddingModelId = string;
-interface OpenAICompatibleEmbeddingSettings {
-    /**
-  The number of dimensions the resulting output embeddings should have.
-  Only supported in text-embedding-3 and later models.
-     */
-    dimensions?: number;
-    /**
-  A unique identifier representing your end-user, which can help OpenAI to
-  monitor and detect abuse. Learn more.
-  */
-    user?: string;
-}
-
-interface OpenAICompatibleProvider<CHAT_MODEL_IDS extends string = string, COMPLETION_MODEL_IDS extends string = string, EMBEDDING_MODEL_IDS extends string = string> extends ProviderV1 {
-    (modelId: CHAT_MODEL_IDS, settings?: OpenAICompatibleChatSettings): LanguageModelV1;
-    languageModel(modelId: CHAT_MODEL_IDS, settings?: OpenAICompatibleChatSettings): LanguageModelV1;
-    chatModel(modelId: CHAT_MODEL_IDS, settings?: OpenAICompatibleChatSettings): LanguageModelV1;
-    completionModel(modelId: COMPLETION_MODEL_IDS, settings?: OpenAICompatibleCompletionSettings): LanguageModelV1;
-    textEmbeddingModel(modelId: EMBEDDING_MODEL_IDS, settings?: OpenAICompatibleEmbeddingSettings): EmbeddingModelV1<string>;
-}
-interface OpenAICompatibleProviderSettings {
-    /**
-  Base URL for the API calls.
-     */
-    baseURL?: string;
-    /**
-  API key for authenticating requests. If specified, adds an `Authorization`
-  header to request headers with the value `Bearer <apiKey>`. This will be added
-  before any headers potentially specified in the `headers` option.
-     */
-    apiKey?: string;
-    /**
-  Optional custom headers to include in requests. These will be added to request headers
-  after any headers potentially added by use of the `apiKey` option.
-     */
-    headers?: Record<string, string>;
-    /**
-  Optional custom url query parameters to include in request urls.
-     */
-    queryParams?: Record<string, string>;
-    /**
-  Custom fetch implementation. You can use it as a middleware to intercept requests,
-  or to provide a custom fetch implementation for e.g. testing.
-     */
-    fetch?: FetchFunction;
-    /**
-  Provider name.
-     */
-    name?: string;
-}
-/**
-Create an OpenAICompatible provider instance.
- */
-declare function createOpenAICompatible<CHAT_MODEL_IDS extends string, COMPLETION_MODEL_IDS extends string, EMBEDDING_MODEL_IDS extends string>(options: OpenAICompatibleProviderSettings): OpenAICompatibleProvider<CHAT_MODEL_IDS, COMPLETION_MODEL_IDS, EMBEDDING_MODEL_IDS>;
-
 declare const openaiCompatibleErrorDataSchema: z.ZodObject<{
     error: z.ZodObject<{
         message: z.ZodString;
@@ -145,6 +57,49 @@ type ProviderErrorStructure<T> = {
     isRetryable?: (response: Response, error?: T) => boolean;
 };
 
+/**
+Extracts provider-specific metadata from API responses.
+Used to standardize metadata handling across different LLM providers while allowing
+provider-specific metadata to be captured.
+*/
+type MetadataExtractor = {
+    /**
+     * Extracts provider metadata from a complete, non-streaming response.
+     *
+     * @param parsedBody - The parsed response JSON body from the provider's API.
+     *
+     * @returns Provider-specific metadata or undefined if no metadata is available.
+     *          The metadata should be under a key indicating the provider id.
+     */
+    extractMetadata: ({ parsedBody, }: {
+        parsedBody: unknown;
+    }) => LanguageModelV1ProviderMetadata | undefined;
+    /**
+     * Creates an extractor for handling streaming responses. The returned object provides
+     * methods to process individual chunks and build the final metadata from the accumulated
+     * stream data.
+     *
+     * @returns An object with methods to process chunks and build metadata from a stream
+     */
+    createStreamExtractor: () => {
+        /**
+         * Process an individual chunk from the stream. Called for each chunk in the response stream
+         * to accumulate metadata throughout the streaming process.
+         *
+         * @param parsedChunk - The parsed JSON response chunk from the provider's API
+         */
+        processChunk(parsedChunk: unknown): void;
+        /**
+         * Builds the metadata object after all chunks have been processed.
+         * Called at the end of the stream to generate the complete provider metadata.
+         *
+         * @returns Provider-specific metadata or undefined if no metadata is available.
+         *          The metadata should be under a key indicating the provider id.
+         */
+        buildMetadata(): LanguageModelV1ProviderMetadata | undefined;
+    };
+};
+
 type OpenAICompatibleChatConfig = {
     provider: string;
     headers: () => Record<string, string | undefined>;
@@ -154,6 +109,7 @@ type OpenAICompatibleChatConfig = {
     }) => string;
     fetch?: FetchFunction;
     errorStructure?: ProviderErrorStructure<any>;
+    metadataExtractor?: MetadataExtractor;
     /**
   Default object generation mode that should be used with this model when
   no mode is specified. Should be the mode with the best results for this
@@ -181,6 +137,38 @@ declare class OpenAICompatibleChatLanguageModel implements LanguageModelV1 {
     doStream(options: Parameters<LanguageModelV1['doStream']>[0]): Promise<Awaited<ReturnType<LanguageModelV1['doStream']>>>;
 }
 
+type OpenAICompatibleCompletionModelId = string;
+interface OpenAICompatibleCompletionSettings {
+    /**
+  Echo back the prompt in addition to the completion.
+     */
+    echo?: boolean;
+    /**
+  Modify the likelihood of specified tokens appearing in the completion.
+  
+  Accepts a JSON object that maps tokens (specified by their token ID in
+  the GPT tokenizer) to an associated bias value from -100 to 100. You
+  can use this tokenizer tool to convert text to token IDs. Mathematically,
+  the bias is added to the logits generated by the model prior to sampling.
+  The exact effect will vary per model, but values between -1 and 1 should
+  decrease or increase likelihood of selection; values like -100 or 100
+  should result in a ban or exclusive selection of the relevant token.
+  
+  As an example, you can pass {"50256": -100} to prevent the <|endoftext|>
+  token from being generated.
+     */
+    logitBias?: Record<number, number>;
+    /**
+  The suffix that comes after a completion of inserted text.
+     */
+    suffix?: string;
+    /**
+  A unique identifier representing your end-user, which can help OpenAI to
+  monitor and detect abuse. Learn more.
+     */
+    user?: string;
+}
+
 type OpenAICompatibleCompletionConfig = {
     provider: string;
     headers: () => Record<string, string | undefined>;
@@ -206,6 +194,20 @@ declare class OpenAICompatibleCompletionLanguageModel implements LanguageModelV1
     doStream(options: Parameters<LanguageModelV1['doStream']>[0]): Promise<Awaited<ReturnType<LanguageModelV1['doStream']>>>;
 }
 
+type OpenAICompatibleEmbeddingModelId = string;
+interface OpenAICompatibleEmbeddingSettings {
+    /**
+  The number of dimensions the resulting output embeddings should have.
+  Only supported in text-embedding-3 and later models.
+     */
+    dimensions?: number;
+    /**
+  A unique identifier representing your end-user, which can help OpenAI to
+  monitor and detect abuse. Learn more.
+  */
+    user?: string;
+}
+
 type OpenAICompatibleEmbeddingConfig = {
     /**
   Override the maximum number of embeddings per call.
@@ -236,4 +238,46 @@ declare class OpenAICompatibleEmbeddingModel implements EmbeddingModelV1<string>
     doEmbed({ values, headers, abortSignal, }: Parameters<EmbeddingModelV1<string>['doEmbed']>[0]): Promise<Awaited<ReturnType<EmbeddingModelV1<string>['doEmbed']>>>;
 }
 
-export { OpenAICompatibleChatLanguageModel, type OpenAICompatibleChatSettings, OpenAICompatibleCompletionLanguageModel, type OpenAICompatibleCompletionSettings, OpenAICompatibleEmbeddingModel, type OpenAICompatibleEmbeddingSettings, type OpenAICompatibleErrorData, type OpenAICompatibleProvider, type OpenAICompatibleProviderSettings, type ProviderErrorStructure, createOpenAICompatible };
+interface OpenAICompatibleProvider<CHAT_MODEL_IDS extends string = string, COMPLETION_MODEL_IDS extends string = string, EMBEDDING_MODEL_IDS extends string = string> extends ProviderV1 {
+    (modelId: CHAT_MODEL_IDS, settings?: OpenAICompatibleChatSettings): LanguageModelV1;
+    languageModel(modelId: CHAT_MODEL_IDS, settings?: OpenAICompatibleChatSettings): LanguageModelV1;
+    chatModel(modelId: CHAT_MODEL_IDS, settings?: OpenAICompatibleChatSettings): LanguageModelV1;
+    completionModel(modelId: COMPLETION_MODEL_IDS, settings?: OpenAICompatibleCompletionSettings): LanguageModelV1;
+    textEmbeddingModel(modelId: EMBEDDING_MODEL_IDS, settings?: OpenAICompatibleEmbeddingSettings): EmbeddingModelV1<string>;
+}
+interface OpenAICompatibleProviderSettings {
+    /**
+  Base URL for the API calls.
+     */
+    baseURL?: string;
+    /**
+  API key for authenticating requests. If specified, adds an `Authorization`
+  header to request headers with the value `Bearer <apiKey>`. This will be added
+  before any headers potentially specified in the `headers` option.
+     */
+    apiKey?: string;
+    /**
+  Optional custom headers to include in requests. These will be added to request headers
+  after any headers potentially added by use of the `apiKey` option.
+     */
+    headers?: Record<string, string>;
+    /**
+  Optional custom url query parameters to include in request urls.
+     */
+    queryParams?: Record<string, string>;
+    /**
+  Custom fetch implementation. You can use it as a middleware to intercept requests,
+  or to provide a custom fetch implementation for e.g. testing.
+     */
+    fetch?: FetchFunction;
+    /**
+  Provider name.
+     */
+    name?: string;
+}
+/**
+Create an OpenAICompatible provider instance.
+ */
+declare function createOpenAICompatible<CHAT_MODEL_IDS extends string, COMPLETION_MODEL_IDS extends string, EMBEDDING_MODEL_IDS extends string>(options: OpenAICompatibleProviderSettings): OpenAICompatibleProvider<CHAT_MODEL_IDS, COMPLETION_MODEL_IDS, EMBEDDING_MODEL_IDS>;
+
+export { type MetadataExtractor, OpenAICompatibleChatLanguageModel, type OpenAICompatibleChatSettings, OpenAICompatibleCompletionLanguageModel, type OpenAICompatibleCompletionSettings, OpenAICompatibleEmbeddingModel, type OpenAICompatibleEmbeddingSettings, type OpenAICompatibleErrorData, type OpenAICompatibleProvider, type OpenAICompatibleProviderSettings, type ProviderErrorStructure, createOpenAICompatible };

package/dist/index.js

@@ -27,9 +27,6 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
-// src/openai-compatible-provider.ts
-var import_provider_utils5 = require("@ai-sdk/provider-utils");
-
 // src/openai-compatible-chat-language-model.ts
 var import_provider3 = require("@ai-sdk/provider");
 var import_provider_utils2 = require("@ai-sdk/provider-utils");
@@ -382,10 +379,14 @@ var OpenAICompatibleChatLanguageModel = class {
     }
   }
   async doGenerate(options) {
-    var _a, _b, _c, _d, _e, _f, _g;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i;
     const { args, warnings } = this.getArgs({ ...options });
     const body = JSON.stringify(args);
-    const { responseHeaders, value: response } = await (0, import_provider_utils2.postJsonToApi)({
+    const {
+      responseHeaders,
+      value: responseBody,
+      rawValue: parsedBody
+    } = await (0, import_provider_utils2.postJsonToApi)({
       url: this.config.url({
         path: "/chat/completions",
         modelId: this.modelId
@@ -400,11 +401,14 @@ var OpenAICompatibleChatLanguageModel = class {
       fetch: this.config.fetch
     });
     const { messages: rawPrompt, ...rawSettings } = args;
-    const choice = response.choices[0];
+    const choice = responseBody.choices[0];
+    const providerMetadata = (_b = (_a = this.config.metadataExtractor) == null ? void 0 : _a.extractMetadata) == null ? void 0 : _b.call(_a, {
+      parsedBody
+    });
     return {
-      text: (_a = choice.message.content) != null ? _a : void 0,
-      reasoning: (_b = choice.message.reasoning_content) != null ? _b : void 0,
-      toolCalls: (_c = choice.message.tool_calls) == null ? void 0 : _c.map((toolCall) => {
+      text: (_c = choice.message.content) != null ? _c : void 0,
+      reasoning: (_d = choice.message.reasoning_content) != null ? _d : void 0,
+      toolCalls: (_e = choice.message.tool_calls) == null ? void 0 : _e.map((toolCall) => {
         var _a2;
         return {
           toolCallType: "function",
@@ -415,17 +419,19 @@ var OpenAICompatibleChatLanguageModel = class {
       }),
       finishReason: mapOpenAICompatibleFinishReason(choice.finish_reason),
       usage: {
-        promptTokens: (_e = (_d = response.usage) == null ? void 0 : _d.prompt_tokens) != null ? _e : NaN,
-        completionTokens: (_g = (_f = response.usage) == null ? void 0 : _f.completion_tokens) != null ? _g : NaN
+        promptTokens: (_g = (_f = responseBody.usage) == null ? void 0 : _f.prompt_tokens) != null ? _g : NaN,
+        completionTokens: (_i = (_h = responseBody.usage) == null ? void 0 : _h.completion_tokens) != null ? _i : NaN
       },
+      ...providerMetadata && { providerMetadata },
       rawCall: { rawPrompt, rawSettings },
       rawResponse: { headers: responseHeaders },
-      response: getResponseMetadata(response),
+      response: getResponseMetadata(responseBody),
       warnings,
       request: { body }
     };
   }
   async doStream(options) {
+    var _a;
     if (this.settings.simulateStreaming) {
       const result = await this.doGenerate(options);
       const simulatedStream = new ReadableStream({
@@ -470,6 +476,7 @@ var OpenAICompatibleChatLanguageModel = class {
     }
     const { args, warnings } = this.getArgs({ ...options });
     const body = JSON.stringify({ ...args, stream: true });
+    const metadataExtractor = (_a = this.config.metadataExtractor) == null ? void 0 : _a.createStreamExtractor();
     const { responseHeaders, value: response } = await (0, import_provider_utils2.postJsonToApi)({
       url: this.config.url({
         path: "/chat/completions",
@@ -495,19 +502,19 @@ var OpenAICompatibleChatLanguageModel = class {
       completionTokens: void 0
     };
     let isFirstChunk = true;
-    let providerMetadata;
     return {
       stream: response.pipeThrough(
         new TransformStream({
           // TODO we lost type safety on Chunk, most likely due to the error schema. MUST FIX
           transform(chunk, controller) {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n;
+            var _a2, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n;
             if (!chunk.success) {
               finishReason = "error";
               controller.enqueue({ type: "error", error: chunk.error });
               return;
             }
             const value = chunk.value;
+            metadataExtractor == null ? void 0 : metadataExtractor.processChunk(chunk.rawValue);
             if ("error" in value) {
               finishReason = "error";
               controller.enqueue({ type: "error", error: value.error.message });
@@ -522,7 +529,7 @@ var OpenAICompatibleChatLanguageModel = class {
             }
             if (value.usage != null) {
               usage = {
-                promptTokens: (_a = value.usage.prompt_tokens) != null ? _a : void 0,
+                promptTokens: (_a2 = value.usage.prompt_tokens) != null ? _a2 : void 0,
                 completionTokens: (_b = value.usage.completion_tokens) != null ? _b : void 0
               };
             }
@@ -631,15 +638,16 @@ var OpenAICompatibleChatLanguageModel = class {
             }
           },
           flush(controller) {
-            var _a, _b;
+            var _a2, _b;
+            const metadata = metadataExtractor == null ? void 0 : metadataExtractor.buildMetadata();
             controller.enqueue({
               type: "finish",
               finishReason,
               usage: {
-                promptTokens: (_a = usage.promptTokens) != null ? _a : NaN,
+                promptTokens: (_a2 = usage.promptTokens) != null ? _a2 : NaN,
                 completionTokens: (_b = usage.completionTokens) != null ? _b : NaN
               },
-              ...providerMetadata != null ? { providerMetadata } : {}
+              ...metadata && { providerMetadata: metadata }
             });
           }
         })
@@ -1127,6 +1135,7 @@ var openaiTextEmbeddingResponseSchema = import_zod4.z.object({
 });
 
 // src/openai-compatible-provider.ts
+var import_provider_utils5 = require("@ai-sdk/provider-utils");
 function createOpenAICompatible(options) {
   if (!options.baseURL) {
     throw new Error("Base URL is required");