@ai-sdk/gateway 4.0.0-beta.49 → 4.0.0-beta.50

package/docs/00-ai-gateway.mdx

@@ -159,6 +159,8 @@ You can connect your own provider credentials to use with Vercel AI Gateway. Thi
 
 To set up BYOK, add your provider credentials in your Vercel team's AI Gateway settings. Once configured, AI Gateway automatically uses your credentials. No code changes are needed.
 
+For providers like Azure where you can use custom deployment names, you can configure model mappings to map gateway model slugs to your deployment names. See [model mappings](https://vercel.com/docs/ai-gateway/byok#model-mappings) for details.
+
 Learn more in the [BYOK documentation](https://vercel.com/docs/ai-gateway/byok).
 
 ## Language Models
@@ -816,11 +818,14 @@ The following gateway provider options are available:
 
   Each provider can have multiple credentials (tried in order). The structure is a record where keys are provider slugs and values are arrays of credential objects.
 
+  Each credential can optionally include a `modelMappings` array to map AI Gateway model slugs to your deployment names (for example, custom Azure deployment names). If a BYOK request fails, the gateway falls back to system credentials using the default model name.
+
   Examples:
 
   - Single provider: `byok: { 'anthropic': [{ apiKey: 'sk-ant-...' }] }`
   - Multiple credentials: `byok: { 'vertex': [{ project: 'proj-1', googleCredentials: { privateKey: '...', clientEmail: '...' } }, { project: 'proj-2', googleCredentials: { privateKey: '...', clientEmail: '...' } }] }`
   - Multiple providers: `byok: { 'anthropic': [{ apiKey: '...' }], 'bedrock': [{ accessKeyId: '...', secretAccessKey: '...' }] }`
+  - With model mappings: `byok: { 'azure': [{ apiKey: '...', resourceName: '...', modelMappings: [{ gatewayModelSlug: 'openai/gpt-5.4-nano', customModelId: 'my-deployment' }] }] }`
 
 - **zeroDataRetention** _boolean_
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ai-sdk/gateway",
   "private": false,
-  "version": "4.0.0-beta.49",
+  "version": "4.0.0-beta.50",
   "type": "module",
   "license": "Apache-2.0",
   "sideEffects": false,
@@ -31,8 +31,8 @@
   },
   "dependencies": {
     "@vercel/oidc": "3.2.0",
-    "@ai-sdk/provider": "4.0.0-beta.11",
-    "@ai-sdk/provider-utils": "5.0.0-beta.19"
+    "@ai-sdk/provider": "4.0.0-beta.12",
+    "@ai-sdk/provider-utils": "5.0.0-beta.20"
   },
   "devDependencies": {
     "@types/node": "18.15.11",

package/src/gateway-config.ts

@@ -2,6 +2,6 @@ import type { FetchFunction, Resolvable } from '@ai-sdk/provider-utils';
 
 export type GatewayConfig = {
   baseURL: string;
-  headers: () => Resolvable<Record<string, string | undefined>>;
+  headers?: Resolvable<Record<string, string | undefined>>;
   fetch?: FetchFunction;
 };

package/src/gateway-embedding-model.ts

@@ -9,6 +9,9 @@ import {
   lazySchema,
   postJsonToApi,
   resolve,
+  serializeModelOptions,
+  WORKFLOW_SERIALIZE,
+  WORKFLOW_DESERIALIZE,
   zodSchema,
   type Resolvable,
 } from '@ai-sdk/provider-utils';
@@ -17,17 +20,33 @@ import { asGatewayError } from './errors';
 import { parseAuthMethod } from './errors/parse-auth-method';
 import type { GatewayConfig } from './gateway-config';
 
+type GatewayEmbeddingConfig = GatewayConfig & {
+  provider: string;
+  o11yHeaders: Resolvable<Record<string, string>>;
+};
+
 export class GatewayEmbeddingModel implements EmbeddingModelV4 {
   readonly specificationVersion = 'v4';
   readonly maxEmbeddingsPerCall = 2048;
   readonly supportsParallelCalls = true;
 
+  static [WORKFLOW_SERIALIZE](model: GatewayEmbeddingModel) {
+    return serializeModelOptions({
+      modelId: model.modelId,
+      config: model.config,
+    });
+  }
+
+  static [WORKFLOW_DESERIALIZE](options: {
+    modelId: string;
+    config: GatewayEmbeddingConfig;
+  }) {
+    return new GatewayEmbeddingModel(options.modelId, options.config);
+  }
+
   constructor(
     readonly modelId: string,
-    private readonly config: GatewayConfig & {
-      provider: string;
-      o11yHeaders: Resolvable<Record<string, string>>;
-    },
+    private readonly config: GatewayEmbeddingConfig,
   ) {}
 
   get provider(): string {
@@ -42,7 +61,9 @@ export class GatewayEmbeddingModel implements EmbeddingModelV4 {
   }: Parameters<EmbeddingModelV4['doEmbed']>[0]): Promise<
     Awaited<ReturnType<EmbeddingModelV4['doEmbed']>>
   > {
-    const resolvedHeaders = await resolve(this.config.headers());
+    const resolvedHeaders = this.config.headers
+      ? await resolve(this.config.headers)
+      : undefined;
     try {
       const {
         responseHeaders,
@@ -80,7 +101,10 @@ export class GatewayEmbeddingModel implements EmbeddingModelV4 {
         warnings: [],
       };
     } catch (error) {
-      throw await asGatewayError(error, await parseAuthMethod(resolvedHeaders));
+      throw await asGatewayError(
+        error,
+        await parseAuthMethod(resolvedHeaders ?? {}),
+      );
     }
   }
 

package/src/gateway-fetch-metadata.ts

@@ -31,7 +31,9 @@ export class GatewayFetchMetadata {
     try {
       const { value } = await getFromApi({
         url: `${this.config.baseURL}/config`,
-        headers: await resolve(this.config.headers()),
+        headers: this.config.headers
+          ? await resolve(this.config.headers)
+          : undefined,
         successfulResponseHandler: createJsonResponseHandler(
           gatewayAvailableModelsResponseSchema,
         ),
@@ -54,7 +56,9 @@ export class GatewayFetchMetadata {
 
       const { value } = await getFromApi({
         url: `${baseUrl.origin}/v1/credits`,
-        headers: await resolve(this.config.headers()),
+        headers: this.config.headers
+          ? await resolve(this.config.headers)
+          : undefined,
         successfulResponseHandler: createJsonResponseHandler(
           gatewayCreditsResponseSchema,
         ),

package/src/gateway-generation-info.ts

@@ -65,7 +65,9 @@ export class GatewayGenerationInfoFetcher {
 
       const { value } = await getFromApi({
         url: `${baseUrl.origin}/v1/generation?id=${encodeURIComponent(params.id)}`,
-        headers: await resolve(this.config.headers()),
+        headers: this.config.headers
+          ? await resolve(this.config.headers)
+          : undefined,
         successfulResponseHandler: createJsonResponseHandler(
           gatewayGenerationInfoResponseSchema,
         ),

package/src/gateway-image-model.ts

@@ -10,6 +10,9 @@ import {
   createJsonErrorResponseHandler,
   postJsonToApi,
   resolve,
+  serializeModelOptions,
+  WORKFLOW_SERIALIZE,
+  WORKFLOW_DESERIALIZE,
   type Resolvable,
 } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
@@ -17,17 +20,33 @@ import type { GatewayConfig } from './gateway-config';
 import { asGatewayError } from './errors';
 import { parseAuthMethod } from './errors/parse-auth-method';
 
+type GatewayImageConfig = GatewayConfig & {
+  provider: string;
+  o11yHeaders: Resolvable<Record<string, string>>;
+};
+
 export class GatewayImageModel implements ImageModelV4 {
   readonly specificationVersion = 'v4' as const;
   // Set a very large number to prevent client-side splitting of requests
   readonly maxImagesPerCall = Number.MAX_SAFE_INTEGER;
 
+  static [WORKFLOW_SERIALIZE](model: GatewayImageModel) {
+    return serializeModelOptions({
+      modelId: model.modelId,
+      config: model.config,
+    });
+  }
+
+  static [WORKFLOW_DESERIALIZE](options: {
+    modelId: string;
+    config: GatewayImageConfig;
+  }) {
+    return new GatewayImageModel(options.modelId, options.config);
+  }
+
   constructor(
     readonly modelId: string,
-    private readonly config: GatewayConfig & {
-      provider: string;
-      o11yHeaders: Resolvable<Record<string, string>>;
-    },
+    private readonly config: GatewayImageConfig,
   ) {}
 
   get provider(): string {
@@ -48,7 +67,9 @@ export class GatewayImageModel implements ImageModelV4 {
   }: Parameters<ImageModelV4['doGenerate']>[0]): Promise<
     Awaited<ReturnType<ImageModelV4['doGenerate']>>
   > {
-    const resolvedHeaders = await resolve(this.config.headers());
+    const resolvedHeaders = this.config.headers
+      ? await resolve(this.config.headers)
+      : undefined;
     try {
       const { responseHeaders, value: responseBody } = await postJsonToApi({
         url: this.getUrl(),
@@ -100,7 +121,10 @@ export class GatewayImageModel implements ImageModelV4 {
         }),
       };
     } catch (error) {
-      throw await asGatewayError(error, await parseAuthMethod(resolvedHeaders));
+      throw await asGatewayError(
+        error,
+        await parseAuthMethod(resolvedHeaders ?? {}),
+      );
     }
   }
 

package/src/gateway-language-model.ts

@@ -13,6 +13,9 @@ import {
   createJsonResponseHandler,
   postJsonToApi,
   resolve,
+  serializeModelOptions,
+  WORKFLOW_SERIALIZE,
+  WORKFLOW_DESERIALIZE,
   type ParseResult,
   type Resolvable,
 } from '@ai-sdk/provider-utils';
@@ -31,6 +34,20 @@ export class GatewayLanguageModel implements LanguageModelV4 {
   readonly specificationVersion = 'v4';
   readonly supportedUrls = { '*/*': [/.*/] };
 
+  static [WORKFLOW_SERIALIZE](model: GatewayLanguageModel) {
+    return serializeModelOptions({
+      modelId: model.modelId,
+      config: model.config,
+    });
+  }
+
+  static [WORKFLOW_DESERIALIZE](options: {
+    modelId: GatewayModelId;
+    config: GatewayChatConfig;
+  }) {
+    return new GatewayLanguageModel(options.modelId, options.config);
+  }
+
   constructor(
     readonly modelId: GatewayModelId,
     private readonly config: GatewayChatConfig,
@@ -55,7 +72,9 @@ export class GatewayLanguageModel implements LanguageModelV4 {
     const { args, warnings } = await this.getArgs(options);
     const { abortSignal } = options;
 
-    const resolvedHeaders = await resolve(this.config.headers());
+    const resolvedHeaders = this.config.headers
+      ? await resolve(this.config.headers)
+      : undefined;
 
     try {
       const {
@@ -87,7 +106,10 @@ export class GatewayLanguageModel implements LanguageModelV4 {
         warnings,
       };
     } catch (error) {
-      throw await asGatewayError(error, await parseAuthMethod(resolvedHeaders));
+      throw await asGatewayError(
+        error,
+        await parseAuthMethod(resolvedHeaders ?? {}),
+      );
     }
   }
 
@@ -97,7 +119,9 @@ export class GatewayLanguageModel implements LanguageModelV4 {
     const { args, warnings } = await this.getArgs(options);
     const { abortSignal } = options;
 
-    const resolvedHeaders = await resolve(this.config.headers());
+    const resolvedHeaders = this.config.headers
+      ? await resolve(this.config.headers)
+      : undefined;
 
     try {
       const { value: response, responseHeaders } = await postJsonToApi({
@@ -160,7 +184,10 @@ export class GatewayLanguageModel implements LanguageModelV4 {
         response: { headers: responseHeaders },
       };
     } catch (error) {
-      throw await asGatewayError(error, await parseAuthMethod(resolvedHeaders));
+      throw await asGatewayError(
+        error,
+        await parseAuthMethod(resolvedHeaders ?? {}),
+      );
     }
   }
 

package/src/gateway-reranking-model.ts

@@ -42,7 +42,9 @@ export class GatewayRerankingModel implements RerankingModelV4 {
   }: Parameters<RerankingModelV4['doRerank']>[0]): Promise<
     Awaited<ReturnType<RerankingModelV4['doRerank']>>
   > {
-    const resolvedHeaders = await resolve(this.config.headers());
+    const resolvedHeaders = this.config.headers
+      ? await resolve(this.config.headers)
+      : undefined;
     try {
       const {
         responseHeaders,
@@ -81,7 +83,10 @@ export class GatewayRerankingModel implements RerankingModelV4 {
         warnings: [],
       };
     } catch (error) {
-      throw await asGatewayError(error, await parseAuthMethod(resolvedHeaders));
+      throw await asGatewayError(
+        error,
+        await parseAuthMethod(resolvedHeaders ?? {}),
+      );
     }
   }
 

package/src/gateway-spend-report.ts

@@ -106,7 +106,9 @@ export class GatewaySpendReport {
 
       const { value } = await getFromApi({
         url: `${baseUrl.origin}/v1/report?${searchParams.toString()}`,
-        headers: await resolve(this.config.headers()),
+        headers: this.config.headers
+          ? await resolve(this.config.headers)
+          : undefined,
         successfulResponseHandler: createJsonResponseHandler(
           gatewaySpendReportResponseSchema,
         ),

package/src/gateway-video-model.ts

@@ -60,7 +60,9 @@ export class GatewayVideoModel implements Experimental_VideoModelV4 {
       headers: Record<string, string> | undefined;
     };
   }> {
-    const resolvedHeaders = await resolve(this.config.headers());
+    const resolvedHeaders = this.config.headers
+      ? await resolve(this.config.headers)
+      : undefined;
     try {
       const { responseHeaders, value: responseBody } = await postJsonToApi({
         url: this.getUrl(),
@@ -178,7 +180,10 @@ export class GatewayVideoModel implements Experimental_VideoModelV4 {
         },
       };
     } catch (error) {
-      throw await asGatewayError(error, await parseAuthMethod(resolvedHeaders));
+      throw await asGatewayError(
+        error,
+        await parseAuthMethod(resolvedHeaders ?? {}),
+      );
     }
   }