@ai-sdk/openai-compatible 0.0.6 → 0.0.7

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/openai-compatible
 
+## 0.0.7
+
+### Patch Changes
+
+- ad2bf11: feat (provider/fireworks): Add Fireworks provider.
+
 ## 0.0.6
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,5 +1,6 @@
 import { ProviderV1, LanguageModelV1, EmbeddingModelV1, LanguageModelV1ObjectGenerationMode } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
+import { ZodSchema } from 'zod';
 
 type OpenAICompatibleChatModelId = string;
 interface OpenAICompatibleChatSettings {
@@ -87,6 +88,12 @@ 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>;
 
+type ProviderErrorStructure<T> = {
+    errorSchema: ZodSchema<T>;
+    errorToMessage: (error: T) => string;
+    isRetryable?: (response: Response, error?: T) => boolean;
+};
+
 type OpenAICompatibleChatConfig = {
     provider: string;
     headers: () => Record<string, string | undefined>;
@@ -95,6 +102,7 @@ type OpenAICompatibleChatConfig = {
         path: string;
     }) => string;
     fetch?: FetchFunction;
+    errorStructure?: ProviderErrorStructure<any>;
     /**
   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
@@ -112,6 +120,8 @@ declare class OpenAICompatibleChatLanguageModel implements LanguageModelV1 {
     readonly modelId: OpenAICompatibleChatModelId;
     readonly settings: OpenAICompatibleChatSettings;
     private readonly config;
+    private readonly failedResponseHandler;
+    private readonly chunkSchema;
     constructor(modelId: OpenAICompatibleChatModelId, settings: OpenAICompatibleChatSettings, config: OpenAICompatibleChatConfig);
     get defaultObjectGenerationMode(): 'json' | 'tool' | undefined;
     get provider(): string;
@@ -128,6 +138,7 @@ type OpenAICompatibleCompletionConfig = {
         path: string;
     }) => string;
     fetch?: FetchFunction;
+    errorStructure?: ProviderErrorStructure<any>;
 };
 declare class OpenAICompatibleCompletionLanguageModel implements LanguageModelV1 {
     readonly specificationVersion = "v1";
@@ -135,6 +146,8 @@ declare class OpenAICompatibleCompletionLanguageModel implements LanguageModelV1
     readonly modelId: OpenAICompatibleCompletionModelId;
     readonly settings: OpenAICompatibleCompletionSettings;
     private readonly config;
+    private readonly failedResponseHandler;
+    private readonly chunkSchema;
     constructor(modelId: OpenAICompatibleCompletionModelId, settings: OpenAICompatibleCompletionSettings, config: OpenAICompatibleCompletionConfig);
     get provider(): string;
     private getArgs;
@@ -158,6 +171,7 @@ type OpenAICompatibleEmbeddingConfig = {
     }) => string;
     headers: () => Record<string, string | undefined>;
     fetch?: FetchFunction;
+    errorStructure?: ProviderErrorStructure<any>;
 };
 declare class OpenAICompatibleEmbeddingModel implements EmbeddingModelV1<string> {
     readonly specificationVersion = "v1";
@@ -171,4 +185,4 @@ 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 OpenAICompatibleProvider, type OpenAICompatibleProviderSettings, createOpenAICompatible };
+export { OpenAICompatibleChatLanguageModel, type OpenAICompatibleChatSettings, OpenAICompatibleCompletionLanguageModel, type OpenAICompatibleCompletionSettings, OpenAICompatibleEmbeddingModel, type OpenAICompatibleEmbeddingSettings, type OpenAICompatibleProvider, type OpenAICompatibleProviderSettings, type ProviderErrorStructure, createOpenAICompatible };

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { ProviderV1, LanguageModelV1, EmbeddingModelV1, LanguageModelV1ObjectGenerationMode } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
+import { ZodSchema } from 'zod';
 
 type OpenAICompatibleChatModelId = string;
 interface OpenAICompatibleChatSettings {
@@ -87,6 +88,12 @@ 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>;
 
+type ProviderErrorStructure<T> = {
+    errorSchema: ZodSchema<T>;
+    errorToMessage: (error: T) => string;
+    isRetryable?: (response: Response, error?: T) => boolean;
+};
+
 type OpenAICompatibleChatConfig = {
     provider: string;
     headers: () => Record<string, string | undefined>;
@@ -95,6 +102,7 @@ type OpenAICompatibleChatConfig = {
         path: string;
     }) => string;
     fetch?: FetchFunction;
+    errorStructure?: ProviderErrorStructure<any>;
     /**
   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
@@ -112,6 +120,8 @@ declare class OpenAICompatibleChatLanguageModel implements LanguageModelV1 {
     readonly modelId: OpenAICompatibleChatModelId;
     readonly settings: OpenAICompatibleChatSettings;
     private readonly config;
+    private readonly failedResponseHandler;
+    private readonly chunkSchema;
     constructor(modelId: OpenAICompatibleChatModelId, settings: OpenAICompatibleChatSettings, config: OpenAICompatibleChatConfig);
     get defaultObjectGenerationMode(): 'json' | 'tool' | undefined;
     get provider(): string;
@@ -128,6 +138,7 @@ type OpenAICompatibleCompletionConfig = {
         path: string;
     }) => string;
     fetch?: FetchFunction;
+    errorStructure?: ProviderErrorStructure<any>;
 };
 declare class OpenAICompatibleCompletionLanguageModel implements LanguageModelV1 {
     readonly specificationVersion = "v1";
@@ -135,6 +146,8 @@ declare class OpenAICompatibleCompletionLanguageModel implements LanguageModelV1
     readonly modelId: OpenAICompatibleCompletionModelId;
     readonly settings: OpenAICompatibleCompletionSettings;
     private readonly config;
+    private readonly failedResponseHandler;
+    private readonly chunkSchema;
     constructor(modelId: OpenAICompatibleCompletionModelId, settings: OpenAICompatibleCompletionSettings, config: OpenAICompatibleCompletionConfig);
     get provider(): string;
     private getArgs;
@@ -158,6 +171,7 @@ type OpenAICompatibleEmbeddingConfig = {
     }) => string;
     headers: () => Record<string, string | undefined>;
     fetch?: FetchFunction;
+    errorStructure?: ProviderErrorStructure<any>;
 };
 declare class OpenAICompatibleEmbeddingModel implements EmbeddingModelV1<string> {
     readonly specificationVersion = "v1";
@@ -171,4 +185,4 @@ 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 OpenAICompatibleProvider, type OpenAICompatibleProviderSettings, createOpenAICompatible };
+export { OpenAICompatibleChatLanguageModel, type OpenAICompatibleChatSettings, OpenAICompatibleCompletionLanguageModel, type OpenAICompatibleCompletionSettings, OpenAICompatibleEmbeddingModel, type OpenAICompatibleEmbeddingSettings, type OpenAICompatibleProvider, type OpenAICompatibleProviderSettings, type ProviderErrorStructure, createOpenAICompatible };

package/dist/index.js

@@ -28,11 +28,11 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 
 // src/openai-compatible-provider.ts
-var import_provider_utils6 = require("@ai-sdk/provider-utils");
+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_utils3 = require("@ai-sdk/provider-utils");
+var import_provider_utils2 = require("@ai-sdk/provider-utils");
 var import_zod2 = require("zod");
 
 // src/convert-to-openai-compatible-chat-messages.ts
@@ -142,9 +142,25 @@ function getResponseMetadata({
   };
 }
 
+// src/map-openai-compatible-finish-reason.ts
+function mapOpenAICompatibleFinishReason(finishReason) {
+  switch (finishReason) {
+    case "stop":
+      return "stop";
+    case "length":
+      return "length";
+    case "content_filter":
+      return "content-filter";
+    case "function_call":
+    case "tool_calls":
+      return "tool-calls";
+    default:
+      return "unknown";
+  }
+}
+
 // src/openai-compatible-error.ts
 var import_zod = require("zod");
-var import_provider_utils2 = require("@ai-sdk/provider-utils");
 var openaiCompatibleErrorDataSchema = import_zod.z.object({
   error: import_zod.z.object({
     message: import_zod.z.string(),
@@ -156,10 +172,10 @@ var openaiCompatibleErrorDataSchema = import_zod.z.object({
     code: import_zod.z.union([import_zod.z.string(), import_zod.z.number()]).nullish()
   })
 });
-var openaiCompatibleFailedResponseHandler = (0, import_provider_utils2.createJsonErrorResponseHandler)({
+var defaultOpenAICompatibleErrorStructure = {
   errorSchema: openaiCompatibleErrorDataSchema,
   errorToMessage: (data) => data.error.message
-});
+};
 
 // src/openai-compatible-prepare-tools.ts
 var import_provider2 = require("@ai-sdk/provider");
@@ -219,32 +235,21 @@ function prepareTools({
   }
 }
 
-// src/map-openai-compatible-finish-reason.ts
-function mapOpenAICompatibleFinishReason(finishReason) {
-  switch (finishReason) {
-    case "stop":
-      return "stop";
-    case "length":
-      return "length";
-    case "content_filter":
-      return "content-filter";
-    case "function_call":
-    case "tool_calls":
-      return "tool-calls";
-    default:
-      return "unknown";
-  }
-}
-
 // src/openai-compatible-chat-language-model.ts
 var OpenAICompatibleChatLanguageModel = class {
+  // type inferred via constructor
   constructor(modelId, settings, config) {
     this.specificationVersion = "v1";
-    var _a;
+    var _a, _b;
     this.modelId = modelId;
     this.settings = settings;
     this.config = config;
-    this.supportsStructuredOutputs = (_a = config.supportsStructuredOutputs) != null ? _a : false;
+    const errorStructure = (_a = config.errorStructure) != null ? _a : defaultOpenAICompatibleErrorStructure;
+    this.chunkSchema = createOpenAICompatibleChatChunkSchema(
+      errorStructure.errorSchema
+    );
+    this.failedResponseHandler = (0, import_provider_utils2.createJsonErrorResponseHandler)(errorStructure);
+    this.supportsStructuredOutputs = (_b = config.supportsStructuredOutputs) != null ? _b : false;
   }
   get defaultObjectGenerationMode() {
     return this.config.defaultObjectGenerationMode;
@@ -367,15 +372,15 @@ var OpenAICompatibleChatLanguageModel = class {
     var _a, _b, _c, _d, _e, _f;
     const { args, warnings } = this.getArgs({ ...options });
     const body = JSON.stringify(args);
-    const { responseHeaders, value: response } = await (0, import_provider_utils3.postJsonToApi)({
+    const { responseHeaders, value: response } = await (0, import_provider_utils2.postJsonToApi)({
       url: this.config.url({
         path: "/chat/completions",
         modelId: this.modelId
       }),
-      headers: (0, import_provider_utils3.combineHeaders)(this.config.headers(), options.headers),
+      headers: (0, import_provider_utils2.combineHeaders)(this.config.headers(), options.headers),
       body: args,
-      failedResponseHandler: openaiCompatibleFailedResponseHandler,
-      successfulResponseHandler: (0, import_provider_utils3.createJsonResponseHandler)(
+      failedResponseHandler: this.failedResponseHandler,
+      successfulResponseHandler: (0, import_provider_utils2.createJsonResponseHandler)(
         OpenAICompatibleChatResponseSchema
       ),
       abortSignal: options.abortSignal,
@@ -389,7 +394,7 @@ var OpenAICompatibleChatLanguageModel = class {
         var _a2;
         return {
           toolCallType: "function",
-          toolCallId: (_a2 = toolCall.id) != null ? _a2 : (0, import_provider_utils3.generateId)(),
+          toolCallId: (_a2 = toolCall.id) != null ? _a2 : (0, import_provider_utils2.generateId)(),
           toolName: toolCall.function.name,
           args: toolCall.function.arguments
         };
@@ -409,19 +414,19 @@ var OpenAICompatibleChatLanguageModel = class {
   async doStream(options) {
     const { args, warnings } = this.getArgs({ ...options });
     const body = JSON.stringify({ ...args, stream: true });
-    const { responseHeaders, value: response } = await (0, import_provider_utils3.postJsonToApi)({
+    const { responseHeaders, value: response } = await (0, import_provider_utils2.postJsonToApi)({
       url: this.config.url({
         path: "/chat/completions",
         modelId: this.modelId
       }),
-      headers: (0, import_provider_utils3.combineHeaders)(this.config.headers(), options.headers),
+      headers: (0, import_provider_utils2.combineHeaders)(this.config.headers(), options.headers),
       body: {
         ...args,
         stream: true
       },
-      failedResponseHandler: openaiCompatibleFailedResponseHandler,
-      successfulResponseHandler: (0, import_provider_utils3.createEventSourceResponseHandler)(
-        OpenAICompatibleChatChunkSchema
+      failedResponseHandler: this.failedResponseHandler,
+      successfulResponseHandler: (0, import_provider_utils2.createEventSourceResponseHandler)(
+        this.chunkSchema
       ),
       abortSignal: options.abortSignal,
       fetch: this.config.fetch
@@ -522,11 +527,11 @@ var OpenAICompatibleChatLanguageModel = class {
                         argsTextDelta: toolCall2.function.arguments
                       });
                     }
-                    if ((0, import_provider_utils3.isParsableJson)(toolCall2.function.arguments)) {
+                    if ((0, import_provider_utils2.isParsableJson)(toolCall2.function.arguments)) {
                       controller.enqueue({
                         type: "tool-call",
                         toolCallType: "function",
-                        toolCallId: (_g = toolCall2.id) != null ? _g : (0, import_provider_utils3.generateId)(),
+                        toolCallId: (_g = toolCall2.id) != null ? _g : (0, import_provider_utils2.generateId)(),
                         toolName: toolCall2.function.name,
                         args: toolCall2.function.arguments
                       });
@@ -549,11 +554,11 @@ var OpenAICompatibleChatLanguageModel = class {
                   toolName: toolCall.function.name,
                   argsTextDelta: (_k = toolCallDelta.function.arguments) != null ? _k : ""
                 });
-                if (((_l = toolCall.function) == null ? void 0 : _l.name) != null && ((_m = toolCall.function) == null ? void 0 : _m.arguments) != null && (0, import_provider_utils3.isParsableJson)(toolCall.function.arguments)) {
+                if (((_l = toolCall.function) == null ? void 0 : _l.name) != null && ((_m = toolCall.function) == null ? void 0 : _m.arguments) != null && (0, import_provider_utils2.isParsableJson)(toolCall.function.arguments)) {
                   controller.enqueue({
                     type: "tool-call",
                     toolCallType: "function",
-                    toolCallId: (_n = toolCall.id) != null ? _n : (0, import_provider_utils3.generateId)(),
+                    toolCallId: (_n = toolCall.id) != null ? _n : (0, import_provider_utils2.generateId)(),
                     toolName: toolCall.function.name,
                     args: toolCall.function.arguments
                   });
@@ -611,7 +616,7 @@ var OpenAICompatibleChatResponseSchema = import_zod2.z.object({
     completion_tokens: import_zod2.z.number().nullish()
   }).nullish()
 });
-var OpenAICompatibleChatChunkSchema = import_zod2.z.union([
+var createOpenAICompatibleChatChunkSchema = (errorSchema) => import_zod2.z.union([
   import_zod2.z.object({
     id: import_zod2.z.string().nullish(),
     created: import_zod2.z.number().nullish(),
@@ -641,12 +646,12 @@ var OpenAICompatibleChatChunkSchema = import_zod2.z.union([
       completion_tokens: import_zod2.z.number().nullish()
     }).nullish()
   }),
-  openaiCompatibleErrorDataSchema
+  errorSchema
 ]);
 
 // src/openai-compatible-completion-language-model.ts
 var import_provider5 = require("@ai-sdk/provider");
-var import_provider_utils4 = require("@ai-sdk/provider-utils");
+var import_provider_utils3 = require("@ai-sdk/provider-utils");
 var import_zod3 = require("zod");
 
 // src/convert-to-openai-compatible-completion-prompt.ts
@@ -735,12 +740,19 @@ ${user}:`]
 
 // src/openai-compatible-completion-language-model.ts
 var OpenAICompatibleCompletionLanguageModel = class {
+  // type inferred via constructor
   constructor(modelId, settings, config) {
     this.specificationVersion = "v1";
     this.defaultObjectGenerationMode = void 0;
+    var _a;
     this.modelId = modelId;
     this.settings = settings;
     this.config = config;
+    const errorStructure = (_a = config.errorStructure) != null ? _a : defaultOpenAICompatibleErrorStructure;
+    this.chunkSchema = createOpenAICompatibleCompletionChunkSchema(
+      errorStructure.errorSchema
+    );
+    this.failedResponseHandler = (0, import_provider_utils3.createJsonErrorResponseHandler)(errorStructure);
   }
   get provider() {
     return this.config.provider;
@@ -830,15 +842,15 @@ var OpenAICompatibleCompletionLanguageModel = class {
   async doGenerate(options) {
     var _a, _b, _c, _d;
     const { args, warnings } = this.getArgs(options);
-    const { responseHeaders, value: response } = await (0, import_provider_utils4.postJsonToApi)({
+    const { responseHeaders, value: response } = await (0, import_provider_utils3.postJsonToApi)({
       url: this.config.url({
         path: "/completions",
         modelId: this.modelId
       }),
-      headers: (0, import_provider_utils4.combineHeaders)(this.config.headers(), options.headers),
+      headers: (0, import_provider_utils3.combineHeaders)(this.config.headers(), options.headers),
       body: args,
-      failedResponseHandler: openaiCompatibleFailedResponseHandler,
-      successfulResponseHandler: (0, import_provider_utils4.createJsonResponseHandler)(
+      failedResponseHandler: this.failedResponseHandler,
+      successfulResponseHandler: (0, import_provider_utils3.createJsonResponseHandler)(
         openaiCompatibleCompletionResponseSchema
       ),
       abortSignal: options.abortSignal,
@@ -866,16 +878,16 @@ var OpenAICompatibleCompletionLanguageModel = class {
       ...args,
       stream: true
     };
-    const { responseHeaders, value: response } = await (0, import_provider_utils4.postJsonToApi)({
+    const { responseHeaders, value: response } = await (0, import_provider_utils3.postJsonToApi)({
       url: this.config.url({
         path: "/completions",
         modelId: this.modelId
       }),
-      headers: (0, import_provider_utils4.combineHeaders)(this.config.headers(), options.headers),
+      headers: (0, import_provider_utils3.combineHeaders)(this.config.headers(), options.headers),
       body,
-      failedResponseHandler: openaiCompatibleFailedResponseHandler,
-      successfulResponseHandler: (0, import_provider_utils4.createEventSourceResponseHandler)(
-        openaiCompatibleCompletionChunkSchema
+      failedResponseHandler: this.failedResponseHandler,
+      successfulResponseHandler: (0, import_provider_utils3.createEventSourceResponseHandler)(
+        this.chunkSchema
       ),
       abortSignal: options.abortSignal,
       fetch: this.config.fetch
@@ -959,7 +971,7 @@ var openaiCompatibleCompletionResponseSchema = import_zod3.z.object({
     completion_tokens: import_zod3.z.number()
   }).nullish()
 });
-var openaiCompatibleCompletionChunkSchema = import_zod3.z.union([
+var createOpenAICompatibleCompletionChunkSchema = (errorSchema) => import_zod3.z.union([
   import_zod3.z.object({
     id: import_zod3.z.string().nullish(),
     created: import_zod3.z.number().nullish(),
@@ -976,12 +988,12 @@ var openaiCompatibleCompletionChunkSchema = import_zod3.z.union([
       completion_tokens: import_zod3.z.number()
     }).nullish()
   }),
-  openaiCompatibleErrorDataSchema
+  errorSchema
 ]);
 
 // src/openai-compatible-embedding-model.ts
 var import_provider6 = require("@ai-sdk/provider");
-var import_provider_utils5 = require("@ai-sdk/provider-utils");
+var import_provider_utils4 = require("@ai-sdk/provider-utils");
 var import_zod4 = require("zod");
 var OpenAICompatibleEmbeddingModel = class {
   constructor(modelId, settings, config) {
@@ -1006,6 +1018,7 @@ var OpenAICompatibleEmbeddingModel = class {
     headers,
     abortSignal
   }) {
+    var _a;
     if (values.length > this.maxEmbeddingsPerCall) {
       throw new import_provider6.TooManyEmbeddingValuesForCallError({
         provider: this.provider,
@@ -1014,12 +1027,12 @@ var OpenAICompatibleEmbeddingModel = class {
         values
       });
     }
-    const { responseHeaders, value: response } = await (0, import_provider_utils5.postJsonToApi)({
+    const { responseHeaders, value: response } = await (0, import_provider_utils4.postJsonToApi)({
       url: this.config.url({
         path: "/embeddings",
         modelId: this.modelId
       }),
-      headers: (0, import_provider_utils5.combineHeaders)(this.config.headers(), headers),
+      headers: (0, import_provider_utils4.combineHeaders)(this.config.headers(), headers),
       body: {
         model: this.modelId,
         input: values,
@@ -1027,8 +1040,10 @@ var OpenAICompatibleEmbeddingModel = class {
         dimensions: this.settings.dimensions,
         user: this.settings.user
       },
-      failedResponseHandler: openaiCompatibleFailedResponseHandler,
-      successfulResponseHandler: (0, import_provider_utils5.createJsonResponseHandler)(
+      failedResponseHandler: (0, import_provider_utils4.createJsonErrorResponseHandler)(
+        (_a = this.config.errorStructure) != null ? _a : defaultOpenAICompatibleErrorStructure
+      ),
+      successfulResponseHandler: (0, import_provider_utils4.createJsonResponseHandler)(
         openaiTextEmbeddingResponseSchema
       ),
       abortSignal,
@@ -1051,7 +1066,7 @@ function createOpenAICompatible(options) {
   if (!options.baseURL) {
     throw new Error("Base URL is required");
   }
-  const baseURL = (0, import_provider_utils6.withoutTrailingSlash)(options.baseURL);
+  const baseURL = (0, import_provider_utils5.withoutTrailingSlash)(options.baseURL);
   if (!options.name) {
     throw new Error("Provider name is required");
   }