@ai-sdk/gateway 3.0.143 → 3.0.145

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
@@ -935,15 +937,18 @@ 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_
 
-  Restricts routing requests to providers that have zero data retention agreements with Vercel for AI Gateway. If there are no providers available for the model with zero data retention, the request will fail. BYOK credentials are skipped when `zeroDataRetention` is set to `true` to ensure that requests are only routed to providers that support ZDR compliance. Request-level ZDR is only available for Vercel Pro and Enterprise plans.
+  Restricts routing to providers with zero data retention agreements with Vercel for AI Gateway. BYOK credentials are skipped by default, since your provider agreements differ from Vercel's. When this filter is on, AI Gateway routes only to providers Vercel has ZDR agreements with for the model. If you have BYOK keys marked as ZDR, those keys are tried first, then AI Gateway falls back to its system credentials. You are responsible for the accuracy of that marking. Applies to both account-wide and request-level ZDR. The request fails if no ZDR-eligible credentials are available. Request-level ZDR is only available for Vercel Pro and Enterprise plans.
 
 - **disallowPromptTraining** _boolean_
 
@@ -1036,7 +1041,7 @@ const { text } = await generateText({
 
 #### Zero Data Retention Example
 
-Set `zeroDataRetention` to true to route requests to providers that have zero data retention agreements with Vercel for AI Gateway. If there are no providers available for the model with zero data retention, the request will fail. When `zeroDataRetention` is `false` or not specified, there is no enforcement of restricting routing. BYOK credentials are skipped when `zeroDataRetention` is set to `true` to ensure that requests are only routed to providers that support ZDR compliance. Request-level ZDR is only available for Vercel Pro and Enterprise plans.
+Set `zeroDataRetention` to true to route requests to providers with zero data retention agreements with Vercel for AI Gateway. BYOK credentials are skipped by default, since your provider agreements differ from Vercel's. When this filter is on, AI Gateway routes only to providers Vercel has ZDR agreements with for the model. If you have BYOK keys marked as ZDR, those keys are tried first, then AI Gateway falls back to its system credentials. You are responsible for the accuracy of that marking. Applies to both account-wide and request-level ZDR. The request fails if no ZDR-eligible credentials are available. When `zeroDataRetention` is `false` or not specified, there is no enforcement of restricting routing. Request-level ZDR is only available for Vercel Pro and Enterprise plans.
 
 ```ts
 import type { GatewayProviderOptions } from "@ai-sdk/gateway";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ai-sdk/gateway",
   "private": false,
-  "version": "3.0.143",
+  "version": "3.0.145",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -32,7 +32,7 @@
   "dependencies": {
     "@vercel/oidc": "3.2.0",
     "@ai-sdk/provider": "3.0.13",
-    "@ai-sdk/provider-utils": "4.0.35"
+    "@ai-sdk/provider-utils": "4.0.37"
   },
   "devDependencies": {
     "@types/node": "18.15.11",

package/src/errors/extract-api-call-response.ts

@@ -1,4 +1,5 @@
 import type { APICallError } from '@ai-sdk/provider';
+import { secureJsonParse } from '@ai-sdk/provider-utils';
 
 export function extractApiCallResponse(error: APICallError): unknown {
   if (error.data !== undefined) {
@@ -6,7 +7,7 @@ export function extractApiCallResponse(error: APICallError): unknown {
   }
   if (error.responseBody != null) {
     try {
-      return JSON.parse(error.responseBody);
+      return secureJsonParse(error.responseBody);
     } catch {
       return error.responseBody;
     }

package/src/gateway-image-model.ts

@@ -13,6 +13,7 @@ import {
   type Resolvable,
 } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
+import { mapGatewayWarnings } from './map-gateway-warnings';
 import type { GatewayConfig } from './gateway-config';
 import { asGatewayError } from './errors';
 import { parseAuthMethod } from './errors/parse-auth-method';
@@ -87,7 +88,7 @@ export class GatewayImageModel implements ImageModelV3 {
 
       return {
         images: responseBody.images, // Always base64 strings from server
-        warnings: responseBody.warnings ?? [],
+        warnings: mapGatewayWarnings(responseBody.warnings),
         providerMetadata:
           responseBody.providerMetadata as ImageModelV3ProviderMetadata,
         response: {
@@ -147,6 +148,11 @@ const gatewayImageWarningSchema = z.discriminatedUnion('type', [
     feature: z.string(),
     details: z.string().optional(),
   }),
+  z.object({
+    type: z.literal('deprecated'),
+    setting: z.string(),
+    message: z.string(),
+  }),
   z.object({
     type: z.literal('other'),
     message: z.string(),

package/src/gateway-speech-model.ts

@@ -1,8 +1,4 @@
-import type {
-  SharedV3ProviderMetadata,
-  SharedV3Warning,
-  SpeechModelV3,
-} from '@ai-sdk/provider';
+import type { SharedV3ProviderMetadata, SpeechModelV3 } from '@ai-sdk/provider';
 import {
   combineHeaders,
   createJsonErrorResponseHandler,
@@ -12,6 +8,7 @@ import {
   type Resolvable,
 } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
+import { mapGatewayWarnings } from './map-gateway-warnings';
 import { asGatewayError } from './errors';
 import { parseAuthMethod } from './errors/parse-auth-method';
 import type { GatewayConfig } from './gateway-config';
@@ -80,7 +77,7 @@ export class GatewaySpeechModel implements SpeechModelV3 {
 
       return {
         audio: responseBody.audio,
-        warnings: (responseBody.warnings ?? []) as Array<SharedV3Warning>,
+        warnings: mapGatewayWarnings(responseBody.warnings),
         providerMetadata:
           responseBody.providerMetadata as SharedV3ProviderMetadata,
         response: {
@@ -123,6 +120,11 @@ const gatewaySpeechWarningSchema = z.discriminatedUnion('type', [
     feature: z.string(),
     details: z.string().optional(),
   }),
+  z.object({
+    type: z.literal('deprecated'),
+    setting: z.string(),
+    message: z.string(),
+  }),
   z.object({
     type: z.literal('other'),
     message: z.string(),

package/src/gateway-transcription-model.ts

@@ -1,6 +1,5 @@
 import type {
   SharedV3ProviderMetadata,
-  SharedV3Warning,
   TranscriptionModelV3,
 } from '@ai-sdk/provider';
 import {
@@ -13,6 +12,7 @@ import {
   type Resolvable,
 } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
+import { mapGatewayWarnings } from './map-gateway-warnings';
 import { asGatewayError } from './errors';
 import { parseAuthMethod } from './errors/parse-auth-method';
 import type { GatewayConfig } from './gateway-config';
@@ -79,7 +79,7 @@ export class GatewayTranscriptionModel implements TranscriptionModelV3 {
         segments: responseBody.segments ?? [],
         language: responseBody.language ?? undefined,
         durationInSeconds: responseBody.durationInSeconds ?? undefined,
-        warnings: (responseBody.warnings ?? []) as Array<SharedV3Warning>,
+        warnings: mapGatewayWarnings(responseBody.warnings),
         providerMetadata:
           responseBody.providerMetadata as SharedV3ProviderMetadata,
         response: {
@@ -122,6 +122,11 @@ const gatewayTranscriptionWarningSchema = z.discriminatedUnion('type', [
     feature: z.string(),
     details: z.string().optional(),
   }),
+  z.object({
+    type: z.literal('deprecated'),
+    setting: z.string(),
+    message: z.string(),
+  }),
   z.object({
     type: z.literal('other'),
     message: z.string(),

package/src/gateway-video-model-settings.ts

@@ -5,6 +5,8 @@ export type GatewayVideoModelId =
   | 'alibaba/wan-v2.6-r2v'
   | 'alibaba/wan-v2.6-r2v-flash'
   | 'alibaba/wan-v2.6-t2v'
+  | 'alibaba/wan-v2.7-r2v'
+  | 'alibaba/wan-v2.7-t2v'
   | 'bytedance/seedance-2.0'
   | 'bytedance/seedance-2.0-fast'
   | 'bytedance/seedance-v1.0-pro'

package/src/gateway-video-model.ts

@@ -17,6 +17,7 @@ import {
   type Resolvable,
 } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
+import { mapGatewayWarnings } from './map-gateway-warnings';
 import type { GatewayConfig } from './gateway-config';
 import { asGatewayError } from './errors';
 import { parseAuthMethod } from './errors/parse-auth-method';
@@ -183,7 +184,7 @@ export class GatewayVideoModel implements Experimental_VideoModelV3 {
 
       return {
         videos: responseBody.videos,
-        warnings: responseBody.warnings ?? [],
+        warnings: mapGatewayWarnings(responseBody.warnings),
         providerMetadata:
           responseBody.providerMetadata as SharedV3ProviderMetadata,
         response: {
@@ -249,6 +250,11 @@ const gatewayVideoWarningSchema = z.discriminatedUnion('type', [
     feature: z.string(),
     details: z.string().optional(),
   }),
+  z.object({
+    type: z.literal('deprecated'),
+    setting: z.string(),
+    message: z.string(),
+  }),
   z.object({
     type: z.literal('other'),
     message: z.string(),

package/src/map-gateway-warnings.ts

@@ -0,0 +1,21 @@
+import type { SharedV3Warning } from '@ai-sdk/provider';
+
+type GatewayResponseWarning =
+  | SharedV3Warning
+  | { type: 'deprecated'; setting: string; message: string };
+
+/**
+ * Maps warnings from gateway responses to `SharedV3Warning`.
+ *
+ * The gateway backend can emit `deprecated` warnings, which the v3
+ * specification cannot represent — they are mapped to `other` warnings.
+ */
+export function mapGatewayWarnings(
+  warnings: Array<GatewayResponseWarning> | undefined,
+): Array<SharedV3Warning> {
+  return (warnings ?? []).map(warning =>
+    warning.type === 'deprecated'
+      ? { type: 'other', message: warning.message }
+      : warning,
+  );
+}