@ai-sdk/gateway 4.0.0-beta.45 → 4.0.0-beta.47

package/docs/00-ai-gateway.mdx

@@ -778,6 +778,20 @@ The following gateway provider options are available:
 
   Example: `only: ['anthropic', 'vertex']` will only allow routing to Anthropic or Vertex AI.
 
+- **sort** _'cost' | 'ttft' | 'tps'_
+
+  Sorts available providers by a performance or cost metric before routing. The gateway will try the best-scoring provider first and fall back through the rest in sorted order. If unspecified, providers are ordered using the gateway's default system ranking.
+
+  - `'cost'` — lowest input cost per token first
+  - `'ttft'` — lowest time-to-first-token first
+  - `'tps'` — highest tokens-per-second first
+
+  When combined with `order`, the user-specified providers are promoted to the front while remaining providers follow the sorted order.
+
+  Example: `sort: 'ttft'` will route to the provider with the fastest time-to-first-token.
+
+  When `sort` is active, the response's `providerMetadata.gateway.routing.sort` object contains the sort option used, the resulting execution order, per-provider metric values, and any providers that were deprioritized.
+
 - **models** _string[]_
 
   Specifies fallback models to use when the primary model fails or is unavailable. The gateway will try the primary model first (specified in the `model` parameter), then try each model in this array in order until one succeeds.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ai-sdk/gateway",
   "private": false,
-  "version": "4.0.0-beta.45",
+  "version": "4.0.0-beta.47",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -32,7 +32,7 @@
   "dependencies": {
     "@vercel/oidc": "3.2.0",
     "@ai-sdk/provider": "4.0.0-beta.10",
-    "@ai-sdk/provider-utils": "5.0.0-beta.17"
+    "@ai-sdk/provider-utils": "5.0.0-beta.18"
   },
   "devDependencies": {
     "@types/node": "18.15.11",

package/src/errors/create-gateway-error.ts

@@ -13,7 +13,6 @@ import {
   InferSchema,
   lazySchema,
   safeValidateTypes,
-  validateTypes,
   zodSchema,
 } from '@ai-sdk/provider-utils';
 

package/src/errors/gateway-authentication-error.ts

@@ -37,7 +37,6 @@ export class GatewayAuthenticationError extends GatewayError {
   static createContextualError({
     apiKeyProvided,
     oidcTokenProvided,
-    message = 'Authentication failed',
     statusCode = 401,
     cause,
     generationId,

package/src/gateway-image-model.ts

@@ -50,11 +50,7 @@ export class GatewayImageModel implements ImageModelV4 {
   > {
     const resolvedHeaders = await resolve(this.config.headers());
     try {
-      const {
-        responseHeaders,
-        value: responseBody,
-        rawValue,
-      } = await postJsonToApi({
+      const { responseHeaders, value: responseBody } = await postJsonToApi({
         url: this.getUrl(),
         headers: combineHeaders(
           resolvedHeaders,

package/src/gateway-language-model.ts

@@ -1,7 +1,6 @@
 import type {
   LanguageModelV4,
   LanguageModelV4CallOptions,
-  SharedV4Warning,
   LanguageModelV4FilePart,
   LanguageModelV4StreamPart,
   LanguageModelV4GenerateResult,

package/src/gateway-provider-options.ts

@@ -17,6 +17,14 @@ const gatewayProviderOptions = lazySchema(() =>
        * Example: `['bedrock', 'anthropic']` will try Amazon Bedrock first, then Anthropic as fallback.
        */
       order: z.array(z.string()).optional(),
+      /**
+       * Sort providers by a performance or cost metric before routing.
+       *
+       * - `'cost'`: lowest input cost first
+       * - `'ttft'`: lowest time-to-first-token first
+       * - `'tps'`: highest tokens-per-second first
+       */
+      sort: z.enum(['cost', 'ttft', 'tps']).optional(),
       /**
        * The unique identifier for the end user on behalf of whom the request was made.
        *