@ai-sdk/gateway 3.0.100 → 3.0.101

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/gateway
 
+## 3.0.101
+
+### Patch Changes
+
+- 83434a9: feat (provider/gateway): add sort options
+
 ## 3.0.100
 
 ### Patch Changes

package/dist/index.d.mts

@@ -556,6 +556,7 @@ declare const gateway: GatewayProvider;
 declare const gatewayProviderOptions: _ai_sdk_provider_utils.LazySchema<{
     only?: string[] | undefined;
     order?: string[] | undefined;
+    sort?: "cost" | "ttft" | "tps" | undefined;
     user?: string | undefined;
     tags?: string[] | undefined;
     models?: string[] | undefined;

package/dist/index.d.ts

@@ -556,6 +556,7 @@ declare const gateway: GatewayProvider;
 declare const gatewayProviderOptions: _ai_sdk_provider_utils.LazySchema<{
     only?: string[] | undefined;
     order?: string[] | undefined;
+    sort?: "cost" | "ttft" | "tps" | undefined;
     user?: string | undefined;
     tags?: string[] | undefined;
     models?: string[] | undefined;

package/dist/index.js

@@ -1624,7 +1624,7 @@ async function getVercelRequestId() {
 var import_provider_utils15 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "3.0.100" : "0.0.0-test";
+var VERSION = true ? "3.0.101" : "0.0.0-test";
 
 // src/gateway-provider.ts
 var AI_GATEWAY_PROTOCOL_VERSION = "0.0.1";

package/dist/index.mjs

@@ -1666,7 +1666,7 @@ async function getVercelRequestId() {
 import { withUserAgentSuffix } from "@ai-sdk/provider-utils";
 
 // src/version.ts
-var VERSION = true ? "3.0.100" : "0.0.0-test";
+var VERSION = true ? "3.0.101" : "0.0.0-test";
 
 // src/gateway-provider.ts
 var AI_GATEWAY_PROTOCOL_VERSION = "0.0.1";

package/docs/00-ai-gateway.mdx

@@ -776,6 +776,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 cost 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": "3.0.100",
+  "version": "3.0.101",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",

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 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.
        *