@ai-sdk/openai-compatible 0.1.0 → 0.1.2

package/internal/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { JSONValue, LanguageModelV1Prompt, LanguageModelV1FinishReason, LanguageModelV1ObjectGenerationMode } from '@ai-sdk/provider';
+import { JSONValue, LanguageModelV1Prompt, LanguageModelV1FinishReason, LanguageModelV1ProviderMetadata, LanguageModelV1ObjectGenerationMode } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 import { ZodSchema } from 'zod';
 
@@ -63,6 +63,48 @@ 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 a streaming metadata processor that can accumulate and process chunks
+     * of a streaming response. Used to build metadata progressively during streaming.
+     *
+     * @returns A new StreamingMetadataProcessor instance
+     */
+    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>;
@@ -72,6 +114,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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/openai-compatible",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -26,8 +26,8 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/provider": "1.0.4",
-    "@ai-sdk/provider-utils": "2.1.0"
+    "@ai-sdk/provider": "1.0.6",
+    "@ai-sdk/provider-utils": "2.1.2"
   },
   "devDependencies": {
     "@types/node": "^18",