@ai-sdk/gateway 4.0.92 → 4.0.95

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @ai-sdk/gateway
 
+## 4.0.95
+
+### Patch Changes
+
+- b67b1b7: feat(provider/gateway): type conditional evaluation fallbacks
+
+## 4.0.94
+
+### Patch Changes
+
+- Updated dependencies [af9597b]
+- Updated dependencies [bc49f78]
+  - @ai-sdk/provider-utils@5.0.49
+
+## 4.0.93
+
+### Patch Changes
+
+- 80b9100: feat (provider/gateway): add Browserbase Search and Fetch tool support
+- d3cc6ae: feat(provider/gateway): accept structured-output in the has provider option
+- Updated dependencies [be877ff]
+  - @ai-sdk/provider-utils@5.0.48
+
 ## 4.0.92
 
 ### Patch Changes

package/dist/index.d.ts

@@ -868,10 +868,130 @@ interface ExaSearchInput {
 type ExaSearchOutput = ExaSearchResponse | ExaSearchError;
 declare const exaSearchToolFactory: _ai_sdk_provider_utils.ProviderExecutedToolFactory<ExaSearchInput, ExaSearchOutput, ExaSearchConfig, {}>;
 
+interface BrowserbaseSearchConfig {
+    /**
+     * Default maximum number of results to return (1-25, default: 10).
+     */
+    numResults?: number;
+}
+interface BrowserbaseSearchInput {
+    /**
+     * Web search query (1-200 characters).
+     */
+    query: string;
+    /**
+     * Maximum number of results to return (1-25, default: 10).
+     */
+    num_results?: number;
+}
+interface BrowserbaseSearchResult {
+    /** Unique identifier for the result. */
+    id: string;
+    /** Title of the search result. */
+    title: string;
+    /** URL of the search result. */
+    url: string;
+    /** Author of the content, when available. */
+    author?: string;
+    /** Favicon URL, when available. */
+    favicon?: string;
+    /** Image URL, when available. */
+    image?: string;
+    /** Publication date in ISO 8601 format, when available. */
+    publishedDate?: string;
+}
+interface BrowserbaseSearchResponse {
+    /** The search query that was executed. */
+    query: string;
+    /** Unique identifier for the request. */
+    requestId: string;
+    /** Search results. */
+    results: BrowserbaseSearchResult[];
+}
+interface BrowserbaseSearchError {
+    error: 'api_error' | 'configuration_error' | 'execution_error' | 'invalid_input' | 'rate_limit' | 'timeout' | 'unknown';
+    statusCode?: number;
+    message: string;
+}
+type BrowserbaseSearchOutput = BrowserbaseSearchError | BrowserbaseSearchResponse;
+declare const browserbaseSearchToolFactory: _ai_sdk_provider_utils.ProviderExecutedToolFactory<BrowserbaseSearchInput, BrowserbaseSearchOutput, BrowserbaseSearchConfig, {}>;
+
+type BrowserbaseFetchFormat = 'raw' | 'json' | 'markdown';
+interface BrowserbaseFetchConfig {
+    /** Whether to follow HTTP redirects (default: false). */
+    allowRedirects?: boolean;
+    /** Whether to bypass TLS certificate verification (default: false). */
+    allowInsecureSsl?: boolean;
+    /** Whether to route the request through Browserbase proxies (default: false). */
+    proxies?: boolean;
+    /** Output format for the response content (default: raw). */
+    format?: BrowserbaseFetchFormat;
+    /**
+     * JSON Schema describing the desired response content. Only used when format
+     * is json.
+     */
+    schema?: Record<string, unknown>;
+}
+interface BrowserbaseFetchInput {
+    /** URL of the page to fetch. */
+    url: string;
+    /** Whether to follow HTTP redirects. */
+    allow_redirects?: boolean;
+    /** Whether to bypass TLS certificate verification. */
+    allow_insecure_ssl?: boolean;
+    /** Whether to route the request through Browserbase proxies. */
+    proxies?: boolean;
+    /** Output format for the response content. */
+    format?: BrowserbaseFetchFormat;
+    /**
+     * JSON Schema describing the desired response content. Only used when format
+     * is json.
+     */
+    schema?: Record<string, unknown>;
+}
+interface BrowserbaseFetchResponse {
+    /** Unique identifier for the fetch request. */
+    id: string;
+    /**
+     * Response body. Raw and markdown responses return strings; JSON extraction
+     * returns an object matching the requested schema.
+     */
+    content: string | Record<string, unknown>;
+    /** MIME type of the response. */
+    contentType: string;
+    /** Character encoding of the response. */
+    encoding: string;
+    /** Response headers from the fetched page. */
+    headers: Record<string, string>;
+    /** HTTP status code returned by the fetched page. */
+    statusCode: number;
+}
+interface BrowserbaseFetchError {
+    error: 'api_error' | 'configuration_error' | 'execution_error' | 'invalid_input' | 'rate_limit' | 'timeout' | 'unknown';
+    statusCode?: number;
+    message: string;
+}
+type BrowserbaseFetchOutput = BrowserbaseFetchError | BrowserbaseFetchResponse;
+declare const browserbaseFetchToolFactory: _ai_sdk_provider_utils.ProviderExecutedToolFactory<BrowserbaseFetchInput, BrowserbaseFetchOutput, BrowserbaseFetchConfig, {}>;
+
 /**
  * Gateway-specific provider-defined tools.
  */
 declare const gatewayTools: {
+    /**
+     * Fetch page content using Browserbase's lightweight Fetch API.
+     *
+     * Supports raw, Markdown, and schema-driven JSON output as well as redirects,
+     * proxy routing, and TLS controls.
+     */
+    browserbaseFetch: (config?: BrowserbaseFetchConfig) => ReturnType<typeof browserbaseFetchToolFactory>;
+    /**
+     * Search the web using Browserbase's Search API for fast, structured results.
+     *
+     * Returns titles, URLs, and available publication metadata without requiring
+     * a browser session.
+     */
+    browserbaseSearch: (config?: BrowserbaseSearchConfig) => ReturnType<typeof browserbaseSearchToolFactory>;
     /**
      * Search the web using Exa for current information and token-efficient
      * excerpts optimized for agent workflows.
@@ -1107,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
@@ -1123,20 +1268,25 @@ type GatewayProviderOptions = {
      * Restrict routing to provider models that satisfy every given entry.
      *
      * Entries are capability tags (`'implicit-caching'`, `'reasoning'`,
-     * `'tool-use'`, `'vision'`) or weight-format conditions: `'quantization:fp8'`
-     * requires the serving provider to report that weight format,
-     * `'!quantization:fp8'` excludes it (providers with no recorded format still
-     * pass an exclusion). Format values are an open space but must match
-     * `[a-zA-Z0-9._-]{1,32}` and compare case-insensitively; unknown capability
-     * names are rejected by the Gateway with a 400.
+     * `'tool-use'`, `'vision'` (image input), `'structured-output'`
+     * (schema-constrained output)) or weight-format conditions:
+     * `'quantization:fp8'` requires the serving provider to report that weight
+     * format, `'!quantization:fp8'` excludes it (providers with no recorded
+     * format still pass an exclusion). Format values are an open space but must
+     * match `[a-zA-Z0-9._-]{1,32}` and compare case-insensitively. Unknown
+     * capability names are rejected by the Gateway with a 400.
      */
-    has?: Array<'implicit-caching' | 'reasoning' | 'tool-use' | 'vision' | `quantization:${string}` | `!quantization:${string}`>;
+    has?: Array<'implicit-caching' | 'reasoning' | 'structured-output' | 'tool-use' | 'vision' | `quantization:${string}` | `!quantization:${string}`>;
     /**
      * Idempotency key for `experimental_startBatch`: retries with the same
      * 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[];
@@ -1159,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 {
@@ -1376,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 };