@ai-sdk/openai-compatible 1.0.0-beta.1 → 1.0.0-beta.11

package/CHANGELOG.md

@@ -1,5 +1,78 @@
 # @ai-sdk/openai-compatible
 
+## 1.0.0-beta.11
+
+### Patch Changes
+
+- Updated dependencies [dd5fd43]
+  - @ai-sdk/provider-utils@3.0.0-beta.8
+
+## 1.0.0-beta.10
+
+### Patch Changes
+
+- Updated dependencies [e7fcc86]
+  - @ai-sdk/provider-utils@3.0.0-beta.7
+
+## 1.0.0-beta.9
+
+### Patch Changes
+
+- 737f1e2: Add (optional) includeUsage option to createOpenAICompatible
+- Updated dependencies [ac34802]
+  - @ai-sdk/provider-utils@3.0.0-beta.6
+
+## 1.0.0-beta.8
+
+### Patch Changes
+
+- Updated dependencies [57edfcb]
+- Updated dependencies [383cbfa]
+  - @ai-sdk/provider-utils@3.0.0-beta.5
+
+## 1.0.0-beta.7
+
+### Patch Changes
+
+- 205077b: fix: improve Zod compatibility
+- Updated dependencies [205077b]
+  - @ai-sdk/provider-utils@3.0.0-beta.4
+
+## 1.0.0-beta.6
+
+### Patch Changes
+
+- 281bb1c: fix (provider/openai-incompatible): support empty tool calls
+
+## 1.0.0-beta.5
+
+### Patch Changes
+
+- Updated dependencies [05d2819]
+  - @ai-sdk/provider-utils@3.0.0-beta.3
+
+## 1.0.0-beta.4
+
+### Patch Changes
+
+- 1b101e1: feat (provider/openai-compatible): allow providers that do not specify function type
+
+## 1.0.0-beta.3
+
+### Patch Changes
+
+- 7b069ed: allow any string as reasoningEffort
+
+## 1.0.0-beta.2
+
+### Patch Changes
+
+- d1a034f: feature: using Zod 4 for internal stuff
+- Updated dependencies [0571b98]
+- Updated dependencies [39a4fab]
+- Updated dependencies [d1a034f]
+  - @ai-sdk/provider-utils@3.0.0-beta.2
+
 ## 1.0.0-beta.1
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,25 +1,12 @@
 import { SharedV2ProviderMetadata, LanguageModelV2, EmbeddingModelV2, ImageModelV2, ProviderV2 } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
-import { z, ZodSchema } from 'zod';
+import { z, ZodType } from 'zod/v4';
 
 type OpenAICompatibleChatModelId = string;
 declare const openaiCompatibleProviderOptions: z.ZodObject<{
-    /**
-     * A unique identifier representing your end-user, which can help the provider to
-     * monitor and detect abuse.
-     */
     user: z.ZodOptional<z.ZodString>;
-    /**
-     * Reasoning effort for reasoning models. Defaults to `medium`.
-     */
-    reasoningEffort: z.ZodOptional<z.ZodEnum<["low", "medium", "high"]>>;
-}, "strip", z.ZodTypeAny, {
-    user?: string | undefined;
-    reasoningEffort?: "low" | "medium" | "high" | undefined;
-}, {
-    user?: string | undefined;
-    reasoningEffort?: "low" | "medium" | "high" | undefined;
-}>;
+    reasoningEffort: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
 type OpenAICompatibleProviderOptions = z.infer<typeof openaiCompatibleProviderOptions>;
 
 declare const openaiCompatibleErrorDataSchema: z.ZodObject<{
@@ -27,36 +14,12 @@ declare const openaiCompatibleErrorDataSchema: z.ZodObject<{
         message: z.ZodString;
         type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         param: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
-        code: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodNumber]>>>;
-    }, "strip", z.ZodTypeAny, {
-        message: string;
-        type?: string | null | undefined;
-        code?: string | number | null | undefined;
-        param?: any;
-    }, {
-        message: string;
-        type?: string | null | undefined;
-        code?: string | number | null | undefined;
-        param?: any;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    error: {
-        message: string;
-        type?: string | null | undefined;
-        code?: string | number | null | undefined;
-        param?: any;
-    };
-}, {
-    error: {
-        message: string;
-        type?: string | null | undefined;
-        code?: string | number | null | undefined;
-        param?: any;
-    };
-}>;
+        code: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
 type OpenAICompatibleErrorData = z.infer<typeof openaiCompatibleErrorDataSchema>;
 type ProviderErrorStructure<T> = {
-    errorSchema: ZodSchema<T>;
+    errorSchema: ZodType<T>;
     errorToMessage: (error: T) => string;
     isRetryable?: (response: Response, error?: T) => boolean;
 };
@@ -142,37 +105,11 @@ declare class OpenAICompatibleChatLanguageModel implements LanguageModelV2 {
 
 type OpenAICompatibleCompletionModelId = string;
 declare const openaiCompatibleCompletionProviderOptions: z.ZodObject<{
-    /**
-     * Echo back the prompt in addition to the completion.
-     */
     echo: z.ZodOptional<z.ZodBoolean>;
-    /**
-     * 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.
-     */
     logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
-    /**
-     * The suffix that comes after a completion of inserted text.
-     */
     suffix: z.ZodOptional<z.ZodString>;
-    /**
-     * A unique identifier representing your end-user, which can help providers to
-     * monitor and detect abuse.
-     */
     user: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    user?: string | undefined;
-    echo?: boolean | undefined;
-    logitBias?: Record<string, number> | undefined;
-    suffix?: string | undefined;
-}, {
-    user?: string | undefined;
-    echo?: boolean | undefined;
-    logitBias?: Record<string, number> | undefined;
-    suffix?: string | undefined;
-}>;
+}, z.core.$strip>;
 type OpenAICompatibleCompletionProviderOptions = z.infer<typeof openaiCompatibleCompletionProviderOptions>;
 
 type OpenAICompatibleCompletionConfig = {
@@ -207,23 +144,9 @@ declare class OpenAICompatibleCompletionLanguageModel implements LanguageModelV2
 
 type OpenAICompatibleEmbeddingModelId = string;
 declare const openaiCompatibleEmbeddingProviderOptions: z.ZodObject<{
-    /**
-     * The number of dimensions the resulting output embeddings should have.
-     * Only supported in text-embedding-3 and later models.
-     */
     dimensions: z.ZodOptional<z.ZodNumber>;
-    /**
-     * A unique identifier representing your end-user, which can help providers to
-     * monitor and detect abuse.
-     */
     user: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    user?: string | undefined;
-    dimensions?: number | undefined;
-}, {
-    user?: string | undefined;
-    dimensions?: number | undefined;
-}>;
+}, z.core.$strip>;
 type OpenAICompatibleEmbeddingProviderOptions = z.infer<typeof openaiCompatibleEmbeddingProviderOptions>;
 
 type OpenAICompatibleEmbeddingConfig = {
@@ -318,6 +241,10 @@ interface OpenAICompatibleProviderSettings {
   or to provide a custom fetch implementation for e.g. testing.
      */
     fetch?: FetchFunction;
+    /**
+  Include usage information in streaming responses.
+     */
+    includeUsage?: boolean;
 }
 /**
 Create an OpenAICompatible provider instance.

package/dist/index.d.ts

@@ -1,25 +1,12 @@
 import { SharedV2ProviderMetadata, LanguageModelV2, EmbeddingModelV2, ImageModelV2, ProviderV2 } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
-import { z, ZodSchema } from 'zod';
+import { z, ZodType } from 'zod/v4';
 
 type OpenAICompatibleChatModelId = string;
 declare const openaiCompatibleProviderOptions: z.ZodObject<{
-    /**
-     * A unique identifier representing your end-user, which can help the provider to
-     * monitor and detect abuse.
-     */
     user: z.ZodOptional<z.ZodString>;
-    /**
-     * Reasoning effort for reasoning models. Defaults to `medium`.
-     */
-    reasoningEffort: z.ZodOptional<z.ZodEnum<["low", "medium", "high"]>>;
-}, "strip", z.ZodTypeAny, {
-    user?: string | undefined;
-    reasoningEffort?: "low" | "medium" | "high" | undefined;
-}, {
-    user?: string | undefined;
-    reasoningEffort?: "low" | "medium" | "high" | undefined;
-}>;
+    reasoningEffort: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
 type OpenAICompatibleProviderOptions = z.infer<typeof openaiCompatibleProviderOptions>;
 
 declare const openaiCompatibleErrorDataSchema: z.ZodObject<{
@@ -27,36 +14,12 @@ declare const openaiCompatibleErrorDataSchema: z.ZodObject<{
         message: z.ZodString;
         type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         param: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
-        code: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodNumber]>>>;
-    }, "strip", z.ZodTypeAny, {
-        message: string;
-        type?: string | null | undefined;
-        code?: string | number | null | undefined;
-        param?: any;
-    }, {
-        message: string;
-        type?: string | null | undefined;
-        code?: string | number | null | undefined;
-        param?: any;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    error: {
-        message: string;
-        type?: string | null | undefined;
-        code?: string | number | null | undefined;
-        param?: any;
-    };
-}, {
-    error: {
-        message: string;
-        type?: string | null | undefined;
-        code?: string | number | null | undefined;
-        param?: any;
-    };
-}>;
+        code: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
 type OpenAICompatibleErrorData = z.infer<typeof openaiCompatibleErrorDataSchema>;
 type ProviderErrorStructure<T> = {
-    errorSchema: ZodSchema<T>;
+    errorSchema: ZodType<T>;
     errorToMessage: (error: T) => string;
     isRetryable?: (response: Response, error?: T) => boolean;
 };
@@ -142,37 +105,11 @@ declare class OpenAICompatibleChatLanguageModel implements LanguageModelV2 {
 
 type OpenAICompatibleCompletionModelId = string;
 declare const openaiCompatibleCompletionProviderOptions: z.ZodObject<{
-    /**
-     * Echo back the prompt in addition to the completion.
-     */
     echo: z.ZodOptional<z.ZodBoolean>;
-    /**
-     * 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.
-     */
     logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
-    /**
-     * The suffix that comes after a completion of inserted text.
-     */
     suffix: z.ZodOptional<z.ZodString>;
-    /**
-     * A unique identifier representing your end-user, which can help providers to
-     * monitor and detect abuse.
-     */
     user: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    user?: string | undefined;
-    echo?: boolean | undefined;
-    logitBias?: Record<string, number> | undefined;
-    suffix?: string | undefined;
-}, {
-    user?: string | undefined;
-    echo?: boolean | undefined;
-    logitBias?: Record<string, number> | undefined;
-    suffix?: string | undefined;
-}>;
+}, z.core.$strip>;
 type OpenAICompatibleCompletionProviderOptions = z.infer<typeof openaiCompatibleCompletionProviderOptions>;
 
 type OpenAICompatibleCompletionConfig = {
@@ -207,23 +144,9 @@ declare class OpenAICompatibleCompletionLanguageModel implements LanguageModelV2
 
 type OpenAICompatibleEmbeddingModelId = string;
 declare const openaiCompatibleEmbeddingProviderOptions: z.ZodObject<{
-    /**
-     * The number of dimensions the resulting output embeddings should have.
-     * Only supported in text-embedding-3 and later models.
-     */
     dimensions: z.ZodOptional<z.ZodNumber>;
-    /**
-     * A unique identifier representing your end-user, which can help providers to
-     * monitor and detect abuse.
-     */
     user: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    user?: string | undefined;
-    dimensions?: number | undefined;
-}, {
-    user?: string | undefined;
-    dimensions?: number | undefined;
-}>;
+}, z.core.$strip>;
 type OpenAICompatibleEmbeddingProviderOptions = z.infer<typeof openaiCompatibleEmbeddingProviderOptions>;
 
 type OpenAICompatibleEmbeddingConfig = {
@@ -318,6 +241,10 @@ interface OpenAICompatibleProviderSettings {
   or to provide a custom fetch implementation for e.g. testing.
      */
     fetch?: FetchFunction;
+    /**
+  Include usage information in streaming responses.
+     */
+    includeUsage?: boolean;
 }
 /**
 Create an OpenAICompatible provider instance.