@ai-sdk/gateway 4.0.94 → 4.0.95

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/gateway
 
+## 4.0.95
+
+### Patch Changes
+
+- b67b1b7: feat(provider/gateway): type conditional evaluation fallbacks
+
 ## 4.0.94
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1227,6 +1227,31 @@ type GatewayProviderMetadata = {
     readonly [key: string]: JSONValue | undefined;
 };
 
+/**
+ * A condition on the primary model's answers. `QUESTION_ID` narrows
+ * `question` to your question IDs. Groups nest at most five levels deep,
+ * which the SDK checks at runtime.
+ */
+type EvaluationFallbackCondition<QUESTION_ID extends string = string> = ExclusiveCondition<{
+    question: QUESTION_ID;
+    confidenceBelow: number;
+}> | ExclusiveCondition<{
+    question: QUESTION_ID;
+    probabilityBetween: [number, number];
+}> | ExclusiveCondition<{
+    any: EvaluationFallbackConditionList<QUESTION_ID>;
+}> | ExclusiveCondition<{
+    all: EvaluationFallbackConditionList<QUESTION_ID>;
+}> | ExclusiveCondition<{
+    atLeast: {
+        count: number;
+        conditions: EvaluationFallbackConditionList<QUESTION_ID>;
+    };
+}>;
+type GatewayModelFallback<QUESTION_ID extends string = string> = string | {
+    model: string;
+    when: EvaluationFallbackCondition<QUESTION_ID>;
+};
 type GatewayProviderOptions = {
     /**
      * Service-owned options may be added by the Gateway without requiring an SDK
@@ -1257,7 +1282,11 @@ type GatewayProviderOptions = {
      * key replay the original batch instead of creating a duplicate.
      */
     idempotencyKey?: string;
-    /** Array of model slugs specifying fallback models to use in order. */
+    /**
+     * Array of model slugs specifying fallback models to use in order.
+     * Conditional entries are only valid on evaluation requests, see
+     * `GatewayEvaluationProviderOptions`.
+     */
     models?: string[];
     /** Array of provider slugs that are the only ones allowed to be used. */
     only?: string[];
@@ -1280,6 +1309,30 @@ type GatewayProviderOptions = {
     /** Filter to providers with zero data retention agreements. */
     zeroDataRetention?: boolean;
 };
+/**
+ * Gateway provider options for evaluation requests. Same as
+ * `GatewayProviderOptions`, except `models` may start with one conditional
+ * `{ model, when }` entry followed by string error fallbacks.
+ *
+ * The SDK validates `models` strictly before sending the request, so new
+ * condition shapes need an SDK release. Other keys pass through unchanged.
+ */
+type GatewayEvaluationProviderOptions<QUESTION_ID extends string = string> = GatewayProviderOptionsWithoutModels & {
+    models?: GatewayModelFallbackList<QUESTION_ID>;
+};
+type EvaluationFallbackConditionList<QUESTION_ID extends string> = [
+    EvaluationFallbackCondition<QUESTION_ID>,
+    ...EvaluationFallbackCondition<QUESTION_ID>[]
+];
+type ConditionKey = 'question' | 'confidenceBelow' | 'probabilityBetween' | 'any' | 'all' | 'atLeast';
+type ExclusiveCondition<CONDITION> = CONDITION & {
+    [KEY in Exclude<ConditionKey, keyof CONDITION>]?: never;
+};
+type GatewayProviderOptionsWithoutModels = {
+    [KEY in keyof GatewayProviderOptions as KEY extends 'models' ? never : KEY]: GatewayProviderOptions[KEY];
+};
+type ConditionalGatewayModelFallback<QUESTION_ID extends string> = Exclude<GatewayModelFallback<QUESTION_ID>, string>;
+type GatewayModelFallbackList<QUESTION_ID extends string> = string[] | [ConditionalGatewayModelFallback<QUESTION_ID>, ...string[]];
 
 declare const symbol$9: unique symbol;
 declare abstract class GatewayError extends Error {
@@ -1497,4 +1550,4 @@ declare class GatewayResponseError extends GatewayError {
 
 declare const VERSION: string;
 
-export { GATEWAY_AUTH_SUBPROTOCOL_PREFIX, GATEWAY_REALTIME_SUBPROTOCOL, GATEWAY_TEAM_SUBPROTOCOL_PREFIX, GATEWAY_TRANSCRIPTION_SUBPROTOCOL, type GatewayAsyncJobMetadata, GatewayAuthenticationError, type GatewayCreditsResponse, type GatewayEmbeddingModelId, GatewayError, type GatewayErrorResponse, type GatewayEvaluationModelId, GatewayFailedDependencyError, GatewayForbiddenError, type GatewayGenerationInfo, type GatewayGenerationInfoParams, type GatewayImageModelId, GatewayInternalServerError, GatewayInvalidRequestError, type GatewayLanguageModelEntry, type GatewayProviderOptions as GatewayLanguageModelOptions, type GatewayLanguageModelSpecification, type GatewayLanguageModelEntry as GatewayModelEntry, type GatewayModelId, GatewayModelNotFoundError, GatewayNotFoundError, type GatewayProvider, type GatewayProviderMetadata, type GatewayProviderOptions, type GatewayProviderSettings, GatewayRateLimitError, type GatewayRealtimeModelId, type GatewayRerankingModelId, GatewayResponseError, type GatewaySpeechModelId, type GatewaySpendReportParams, type GatewaySpendReportResponse, type GatewaySpendReportRow, type GatewayTranscriptionModelId, type GatewayVideoModelId, VERSION, createGateway, createGateway as createGatewayProvider, gateway, getGatewayRealtimeAuthToken, getGatewayRealtimeProtocols, getGatewayRealtimeTeamIdOrSlug, getGatewayTranscriptionProtocols };
+export { type EvaluationFallbackCondition, GATEWAY_AUTH_SUBPROTOCOL_PREFIX, GATEWAY_REALTIME_SUBPROTOCOL, GATEWAY_TEAM_SUBPROTOCOL_PREFIX, GATEWAY_TRANSCRIPTION_SUBPROTOCOL, type GatewayAsyncJobMetadata, GatewayAuthenticationError, type GatewayCreditsResponse, type GatewayEmbeddingModelId, GatewayError, type GatewayErrorResponse, type GatewayEvaluationModelId, type GatewayEvaluationProviderOptions, GatewayFailedDependencyError, GatewayForbiddenError, type GatewayGenerationInfo, type GatewayGenerationInfoParams, type GatewayImageModelId, GatewayInternalServerError, GatewayInvalidRequestError, type GatewayLanguageModelEntry, type GatewayProviderOptions as GatewayLanguageModelOptions, type GatewayLanguageModelSpecification, type GatewayLanguageModelEntry as GatewayModelEntry, type GatewayModelFallback, type GatewayModelId, GatewayModelNotFoundError, GatewayNotFoundError, type GatewayProvider, type GatewayProviderMetadata, type GatewayProviderOptions, type GatewayProviderSettings, GatewayRateLimitError, type GatewayRealtimeModelId, type GatewayRerankingModelId, GatewayResponseError, type GatewaySpeechModelId, type GatewaySpendReportParams, type GatewaySpendReportResponse, type GatewaySpendReportRow, type GatewayTranscriptionModelId, type GatewayVideoModelId, VERSION, createGateway, createGateway as createGatewayProvider, gateway, getGatewayRealtimeAuthToken, getGatewayRealtimeProtocols, getGatewayRealtimeTeamIdOrSlug, getGatewayTranscriptionProtocols };

package/dist/index.js

@@ -2247,11 +2247,98 @@ import {
   createJsonErrorResponseHandler as createJsonErrorResponseHandler9,
   createJsonResponseHandler as createJsonResponseHandler9,
   getErrorMessage as getErrorMessage9,
-  lazySchema as lazySchema9,
+  lazySchema as lazySchema10,
+  parseProviderOptions,
   postJsonToApi as postJsonToApi6,
   resolve as resolve9,
-  zodSchema as zodSchema9
+  zodSchema as zodSchema10
 } from "@ai-sdk/provider-utils";
+
+// src/gateway-provider-options.ts
+import { lazySchema as lazySchema9, zodSchema as zodSchema9 } from "@ai-sdk/provider-utils";
+var EVALUATION_FALLBACK_MAX_CONDITION_DEPTH = 5;
+var EVALUATION_FALLBACK_MAX_CONDITIONS_PER_LIST = 20;
+var EVALUATION_FALLBACK_MAX_QUESTION_LENGTH = 256;
+var EVALUATION_FALLBACK_MAX_MODEL_LENGTH = 256;
+var gatewayEvaluationProviderOptionsSchema = lazySchema9(
+  () => zodSchema9(
+    z.object({
+      models: gatewayModelFallbacksSchema.optional()
+    }).catchall(z.unknown())
+  )
+);
+var probabilitySchema = z.number().finite().min(0).max(1);
+var questionSchema = z.string().min(1).max(EVALUATION_FALLBACK_MAX_QUESTION_LENGTH);
+var directConditionSchema = z.union([
+  z.object({
+    question: questionSchema,
+    confidenceBelow: probabilitySchema
+  }).strict(),
+  z.object({
+    question: questionSchema,
+    probabilityBetween: z.array(probabilitySchema).length(2).refine(([minimum, maximum]) => minimum <= maximum, {
+      message: "probabilityBetween minimum must be less than or equal to maximum"
+    })
+  }).strict()
+]);
+var groupBeyondMaxDepthSchema = z.union([
+  z.object({ any: z.unknown() }),
+  z.object({ all: z.unknown() }),
+  z.object({ atLeast: z.unknown() })
+]).superRefine((_, context) => {
+  context.addIssue({
+    code: "custom",
+    message: `conditions can be nested at most ${EVALUATION_FALLBACK_MAX_CONDITION_DEPTH} levels deep`
+  });
+});
+var conditionalModelFallbackSchema = z.object({
+  model: z.string().min(1).max(EVALUATION_FALLBACK_MAX_MODEL_LENGTH),
+  when: conditionSchema(1)
+}).strict();
+var gatewayModelFallbacksSchema = z.array(z.union([z.string(), conditionalModelFallbackSchema])).superRefine((entries, context) => {
+  const conditionalIndexes = entries.flatMap(
+    (entry, index) => typeof entry === "string" ? [] : [index]
+  );
+  if (conditionalIndexes.length > 1) {
+    context.addIssue({
+      code: "custom",
+      message: "models supports at most one conditional evaluation fallback"
+    });
+  }
+  if (conditionalIndexes[0] !== void 0 && conditionalIndexes[0] !== 0) {
+    context.addIssue({
+      code: "custom",
+      message: "a conditional evaluation fallback must be the first models entry",
+      path: [conditionalIndexes[0]]
+    });
+  }
+});
+function conditionSchema(depth) {
+  if (depth === EVALUATION_FALLBACK_MAX_CONDITION_DEPTH) {
+    return z.union([
+      directConditionSchema,
+      groupBeyondMaxDepthSchema
+    ]);
+  }
+  const childConditionSchema = conditionSchema(depth + 1);
+  const conditionListSchema = z.array(childConditionSchema).min(1).max(EVALUATION_FALLBACK_MAX_CONDITIONS_PER_LIST);
+  return z.union([
+    directConditionSchema,
+    z.object({ any: conditionListSchema }).strict(),
+    z.object({ all: conditionListSchema }).strict(),
+    z.object({
+      atLeast: z.object({
+        count: z.number().int().min(1),
+        conditions: conditionListSchema
+      }).strict().refine(({ count, conditions }) => count <= conditions.length, {
+        message: "atLeast count cannot exceed the number of conditions",
+        path: ["count"]
+      })
+    }).strict()
+  ]);
+}
+
+// src/gateway-evaluation-model.ts
 var GatewayEvaluationModel = class {
   constructor(modelId, config) {
     this.modelId = modelId;
@@ -2269,6 +2356,12 @@ var GatewayEvaluationModel = class {
     abortSignal,
     providerOptions
   }) {
+    const gatewayOptions = await parseProviderOptions({
+      provider: "gateway",
+      providerOptions,
+      schema: gatewayEvaluationProviderOptionsSchema
+    });
+    const validatedProviderOptions = gatewayOptions == null ? providerOptions : { ...providerOptions, gateway: gatewayOptions };
     const resolvedHeaders = this.config.headers ? await resolve9(this.config.headers) : void 0;
     try {
       const {
@@ -2286,7 +2379,7 @@ var GatewayEvaluationModel = class {
         body: {
           state,
           questions,
-          ...providerOptions ? { providerOptions } : {}
+          ...validatedProviderOptions ? { providerOptions: validatedProviderOptions } : {}
         },
         successfulResponseHandler: createJsonResponseHandler9(
           gatewayEvaluationResponseSchema
@@ -2305,7 +2398,7 @@ var GatewayEvaluationModel = class {
         warnings: responseBody.warnings ?? [],
         providerMetadata: responseBody.providerMetadata,
         response: {
-          modelId: this.modelId,
+          modelId: responseBody.model ?? this.modelId,
           headers: responseHeaders,
           body: rawValue
         }
@@ -2364,10 +2457,11 @@ var gatewayEvaluationWarningSchema = z.discriminatedUnion("type", [
     message: z.string()
   })
 ]);
-var gatewayEvaluationResponseSchema = lazySchema9(
-  () => zodSchema9(
+var gatewayEvaluationResponseSchema = lazySchema10(
+  () => zodSchema10(
     z.object({
       answers: z.record(z.string(), gatewayEvaluationAnswerSchema),
+      model: z.string().optional(),
       rounding: z.object({
         probabilityDecimals: z.number().optional(),
         scoreDecimals: z.number().optional()
@@ -2388,10 +2482,10 @@ import {
   createJsonErrorResponseHandler as createJsonErrorResponseHandler10,
   createJsonResponseHandler as createJsonResponseHandler10,
   getErrorMessage as getErrorMessage10,
-  lazySchema as lazySchema10,
+  lazySchema as lazySchema11,
   postJsonToApi as postJsonToApi7,
   resolve as resolve10,
-  zodSchema as zodSchema10
+  zodSchema as zodSchema11
 } from "@ai-sdk/provider-utils";
 var GatewayRerankingModel = class {
   constructor(modelId, config) {
@@ -2484,8 +2578,8 @@ var gatewayRerankingWarningSchema = z.discriminatedUnion("type", [
     message: z.string()
   })
 ]);
-var gatewayRerankingResponseSchema = lazySchema10(
-  () => zodSchema10(
+var gatewayRerankingResponseSchema = lazySchema11(
+  () => zodSchema11(
     z.object({
       ranking: z.array(
         z.object({
@@ -3028,12 +3122,12 @@ function toGatewayRealtimeUrl(baseURL, modelId) {
 // src/tool/browserbase-fetch.ts
 import {
   createProviderExecutedToolFactory,
-  lazySchema as lazySchema11,
-  zodSchema as zodSchema11
+  lazySchema as lazySchema12,
+  zodSchema as zodSchema12
 } from "@ai-sdk/provider-utils";
 var jsonObjectSchema = z.record(z.string(), z.unknown());
-var browserbaseFetchInputSchema = lazySchema11(
-  () => zodSchema11(
+var browserbaseFetchInputSchema = lazySchema12(
+  () => zodSchema12(
     z.object({
       url: z.string().url().describe("URL of the page to fetch."),
       allow_redirects: z.boolean().optional().describe("Whether to follow HTTP redirects (default: false)."),
@@ -3052,8 +3146,8 @@ var browserbaseFetchInputSchema = lazySchema11(
     })
   )
 );
-var browserbaseFetchOutputSchema = lazySchema11(
-  () => zodSchema11(
+var browserbaseFetchOutputSchema = lazySchema12(
+  () => zodSchema12(
     z.union([
       z.object({
         id: z.string(),
@@ -3089,19 +3183,19 @@ var browserbaseFetch = (config = {}) => browserbaseFetchToolFactory(config);
 // src/tool/browserbase-search.ts
 import {
   createProviderExecutedToolFactory as createProviderExecutedToolFactory2,
-  lazySchema as lazySchema12,
-  zodSchema as zodSchema12
+  lazySchema as lazySchema13,
+  zodSchema as zodSchema13
 } from "@ai-sdk/provider-utils";
-var browserbaseSearchInputSchema = lazySchema12(
-  () => zodSchema12(
+var browserbaseSearchInputSchema = lazySchema13(
+  () => zodSchema13(
     z.object({
       query: z.string().min(1).max(200).describe("Web search query. Must be between 1 and 200 characters."),
       num_results: z.number().int().min(1).max(25).optional().describe("Maximum number of results to return (1-25, default: 10).")
     })
   )
 );
-var browserbaseSearchOutputSchema = lazySchema12(
-  () => zodSchema12(
+var browserbaseSearchOutputSchema = lazySchema13(
+  () => zodSchema13(
     z.union([
       z.object({
         query: z.string(),
@@ -3144,11 +3238,11 @@ var browserbaseSearch = (config = {}) => browserbaseSearchToolFactory(config);
 // src/tool/exa-search.ts
 import {
   createProviderExecutedToolFactory as createProviderExecutedToolFactory3,
-  lazySchema as lazySchema13,
-  zodSchema as zodSchema13
+  lazySchema as lazySchema14,
+  zodSchema as zodSchema14
 } from "@ai-sdk/provider-utils";
-var exaSearchInputSchema = lazySchema13(
-  () => zodSchema13(
+var exaSearchInputSchema = lazySchema14(
+  () => zodSchema14(
     z.object({
       query: z.string().describe("Natural-language web search query. This is required."),
       type: z.enum(["auto", "fast", "instant"]).optional().describe(
@@ -3218,8 +3312,8 @@ var exaSearchInputSchema = lazySchema13(
     })
   )
 );
-var exaSearchOutputSchema = lazySchema13(
-  () => zodSchema13(
+var exaSearchOutputSchema = lazySchema14(
+  () => zodSchema14(
     z.union([
       z.object({
         requestId: z.string(),
@@ -3276,11 +3370,11 @@ var exaSearch = (config = {}) => exaSearchToolFactory(config);
 // src/tool/parallel-search.ts
 import {
   createProviderExecutedToolFactory as createProviderExecutedToolFactory4,
-  lazySchema as lazySchema14,
-  zodSchema as zodSchema14
+  lazySchema as lazySchema15,
+  zodSchema as zodSchema15
 } from "@ai-sdk/provider-utils";
-var parallelSearchInputSchema = lazySchema14(
-  () => zodSchema14(
+var parallelSearchInputSchema = lazySchema15(
+  () => zodSchema15(
     z.object({
       objective: z.string().describe(
         "Natural-language description of the web research goal, including source or freshness guidance and broader context from the task. Maximum 5000 characters."
@@ -3319,8 +3413,8 @@ var parallelSearchInputSchema = lazySchema14(
     })
   )
 );
-var parallelSearchOutputSchema = lazySchema14(
-  () => zodSchema14(
+var parallelSearchOutputSchema = lazySchema15(
+  () => zodSchema15(
     z.union([
       // Success response
       z.object({
@@ -3361,11 +3455,11 @@ var parallelSearch = (config = {}) => parallelSearchToolFactory(config);
 // src/tool/perplexity-search.ts
 import {
   createProviderExecutedToolFactory as createProviderExecutedToolFactory5,
-  lazySchema as lazySchema15,
-  zodSchema as zodSchema15
+  lazySchema as lazySchema16,
+  zodSchema as zodSchema16
 } from "@ai-sdk/provider-utils";
-var perplexitySearchInputSchema = lazySchema15(
-  () => zodSchema15(
+var perplexitySearchInputSchema = lazySchema16(
+  () => zodSchema16(
     z.object({
       query: z.union([z.string(), z.array(z.string())]).describe(
         "Search query (string) or multiple queries (array of up to 5 strings). Multi-query searches return combined results from all queries."
@@ -3406,8 +3500,8 @@ var perplexitySearchInputSchema = lazySchema15(
     })
   )
 );
-var perplexitySearchOutputSchema = lazySchema15(
-  () => zodSchema15(
+var perplexitySearchOutputSchema = lazySchema16(
+  () => zodSchema16(
     z.union([
       // Success response
       z.object({
@@ -3447,8 +3541,8 @@ var perplexitySearch = (config = {}) => perplexitySearchToolFactory(config);
 // src/tool/tako-search.ts
 import {
   createProviderExecutedToolFactory as createProviderExecutedToolFactory6,
-  lazySchema as lazySchema16,
-  zodSchema as zodSchema16
+  lazySchema as lazySchema17,
+  zodSchema as zodSchema17
 } from "@ai-sdk/provider-utils";
 var takoDataSourceInputSchema = z.object({
   count: z.number().optional().describe(
@@ -3487,8 +3581,8 @@ var takoWebSourceInputSchema = z.object({
     "Keep results published on or before this ISO date (YYYY-MM-DD)."
   )
 });
-var takoSearchInputSchema = lazySchema16(
-  () => zodSchema16(
+var takoSearchInputSchema = lazySchema17(
+  () => zodSchema17(
     z.object({
       query: z.string().describe(
         'Natural-language search query. Include the entity, metric, and time period. Quote a phrase to force it to one entity, for example "Tesla":PRODUCT price.'
@@ -3618,8 +3712,8 @@ var takoWebResultSchema = z.object({
   publish_date: z.string().nullish(),
   content: takoResultContentSchema.nullish()
 }).passthrough();
-var takoSearchOutputSchema = lazySchema16(
-  () => zodSchema16(
+var takoSearchOutputSchema = lazySchema17(
+  () => zodSchema17(
     z.union([
       z.object({
         request_id: z.string(),
@@ -3715,7 +3809,7 @@ async function getVercelRequestId() {
 }
 
 // src/version.ts
-var VERSION = true ? "4.0.94" : "0.0.0-test";
+var VERSION = true ? "4.0.95" : "0.0.0-test";
 
 // src/gateway-provider.ts
 var AI_GATEWAY_PROTOCOL_VERSION = "0.0.1";