@ai-sdk/gateway 4.0.0-beta.110 → 4.0.0-beta.111

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/gateway
 
+## 4.0.0-beta.111
+
+### Patch Changes
+
+- 8e990ff: feat (provider/gateway): add Exa search tool support
+
 ## 4.0.0-beta.110
 
 ### Patch Changes

package/dist/index.d.ts

@@ -491,10 +491,145 @@ interface ParallelSearchInput {
 type ParallelSearchOutput = ParallelSearchResponse | ParallelSearchError;
 declare const parallelSearchToolFactory: _ai_sdk_provider_utils.ProviderExecutedToolFactory<ParallelSearchInput, ParallelSearchOutput, ParallelSearchConfig, {}>;
 
+type ExaSearchType = 'auto' | 'fast' | 'instant';
+type ExaSearchCategory = 'company' | 'people' | 'research paper' | 'news' | 'personal site' | 'financial report';
+type ExaTextSection = 'header' | 'navigation' | 'banner' | 'body' | 'sidebar' | 'footer' | 'metadata';
+interface ExaSearchTextConfig {
+    maxCharacters?: number;
+    includeHtmlTags?: boolean;
+    verbosity?: 'compact' | 'standard' | 'full';
+    includeSections?: ExaTextSection[];
+    excludeSections?: ExaTextSection[];
+}
+interface ExaSearchHighlightsConfig {
+    query?: string;
+    maxCharacters?: number;
+}
+interface ExaSearchExtrasConfig {
+    links?: number;
+    imageLinks?: number;
+}
+interface ExaSearchContentsConfig {
+    text?: boolean | ExaSearchTextConfig;
+    highlights?: boolean | ExaSearchHighlightsConfig;
+    maxAgeHours?: number;
+    livecrawlTimeout?: number;
+    subpages?: number;
+    subpageTarget?: string | string[];
+    extras?: ExaSearchExtrasConfig;
+}
+interface ExaSearchConfig {
+    /**
+     * Default search method. Exa defaults to auto when omitted.
+     */
+    type?: ExaSearchType;
+    /**
+     * Default maximum number of results to return (1-100, default: 10).
+     */
+    numResults?: number;
+    /**
+     * Default category filter for result types.
+     */
+    category?: ExaSearchCategory;
+    /**
+     * Default two-letter ISO country code for location-aware search.
+     */
+    userLocation?: string;
+    /**
+     * Default domains to include or exclude.
+     */
+    includeDomains?: string[];
+    excludeDomains?: string[];
+    /**
+     * Default published date filters in ISO 8601 format.
+     */
+    startPublishedDate?: string;
+    endPublishedDate?: string;
+    /**
+     * Default content extraction controls.
+     */
+    contents?: ExaSearchContentsConfig;
+}
+interface ExaSearchResult {
+    title: string;
+    url: string;
+    id: string;
+    publishedDate?: string | null;
+    author?: string | null;
+    image?: string | null;
+    favicon?: string | null;
+    text?: string;
+    highlights?: string[];
+    highlightScores?: number[];
+    summary?: string;
+    subpages?: ExaSearchResult[];
+    extras?: {
+        links?: string[];
+        imageLinks?: string[];
+    };
+}
+interface ExaSearchResponse {
+    requestId: string;
+    searchType?: string;
+    resolvedSearchType?: string;
+    results: ExaSearchResult[];
+    costDollars?: {
+        total?: number;
+        search?: Record<string, number>;
+    };
+}
+interface ExaSearchError {
+    error: 'api_error' | 'rate_limit' | 'timeout' | 'invalid_input' | 'configuration_error' | 'execution_error' | 'unknown';
+    statusCode?: number;
+    message: string;
+}
+interface ExaSearchInput {
+    query: string;
+    type?: ExaSearchType;
+    num_results?: number;
+    category?: ExaSearchCategory;
+    user_location?: string;
+    include_domains?: string[];
+    exclude_domains?: string[];
+    start_published_date?: string;
+    end_published_date?: string;
+    contents?: {
+        text?: boolean | {
+            max_characters?: number;
+            include_html_tags?: boolean;
+            verbosity?: 'compact' | 'standard' | 'full';
+            include_sections?: ExaTextSection[];
+            exclude_sections?: ExaTextSection[];
+        };
+        highlights?: boolean | {
+            query?: string;
+            max_characters?: number;
+        };
+        max_age_hours?: number;
+        livecrawl_timeout?: number;
+        subpages?: number;
+        subpage_target?: string | string[];
+        extras?: {
+            links?: number;
+            image_links?: number;
+        };
+    };
+}
+type ExaSearchOutput = ExaSearchResponse | ExaSearchError;
+declare const exaSearchToolFactory: _ai_sdk_provider_utils.ProviderExecutedToolFactory<ExaSearchInput, ExaSearchOutput, ExaSearchConfig, {}>;
+
 /**
  * Gateway-specific provider-defined tools.
  */
 declare const gatewayTools: {
+    /**
+     * Search the web using Exa for current information and token-efficient
+     * excerpts optimized for agent workflows.
+     *
+     * Supports search type, category, domain, date, location, and content
+     * extraction controls.
+     */
+    exaSearch: (config?: ExaSearchConfig) => ReturnType<typeof exaSearchToolFactory>;
     /**
      * Search the web using Parallel AI's Search API for LLM-optimized excerpts.
      *

package/dist/index.js

@@ -61,7 +61,7 @@ import {
   withoutTrailingSlash,
   withUserAgentSuffix
 } from "@ai-sdk/provider-utils";
-import { z as z16 } from "zod/v4";
+import { z as z17 } from "zod/v4";
 
 // src/errors/as-gateway-error.ts
 import { APICallError } from "@ai-sdk/provider";
@@ -2009,68 +2009,201 @@ function toGatewayRealtimeUrl(baseURL, modelId) {
   return url.toString();
 }
 
-// src/tool/parallel-search.ts
+// src/tool/exa-search.ts
 import {
   createProviderExecutedToolFactory,
   lazySchema as lazySchema9,
   zodSchema as zodSchema9
 } from "@ai-sdk/provider-utils";
 import { z as z14 } from "zod";
-var parallelSearchInputSchema = lazySchema9(
+var exaSearchInputSchema = lazySchema9(
   () => zodSchema9(
     z14.object({
-      objective: z14.string().describe(
+      query: z14.string().describe("Natural-language web search query. This is required."),
+      type: z14.enum(["auto", "fast", "instant"]).optional().describe(
+        "Search method. Use auto for the default balance of speed and quality."
+      ),
+      num_results: z14.number().optional().describe("Maximum number of results to return (1-100, default: 10)."),
+      category: z14.enum([
+        "company",
+        "people",
+        "research paper",
+        "news",
+        "personal site",
+        "financial report"
+      ]).optional().describe("Optional content category to focus results."),
+      user_location: z14.string().optional().describe("Two-letter ISO country code such as 'US'."),
+      include_domains: z14.array(z14.string()).optional().describe("Only return results from these domains."),
+      exclude_domains: z14.array(z14.string()).optional().describe("Exclude results from these domains."),
+      start_published_date: z14.string().optional().describe("Only return links published after this ISO 8601 date."),
+      end_published_date: z14.string().optional().describe("Only return links published before this ISO 8601 date."),
+      contents: z14.object({
+        text: z14.union([
+          z14.boolean(),
+          z14.object({
+            max_characters: z14.number().optional(),
+            include_html_tags: z14.boolean().optional(),
+            verbosity: z14.enum(["compact", "standard", "full"]).optional(),
+            include_sections: z14.array(
+              z14.enum([
+                "header",
+                "navigation",
+                "banner",
+                "body",
+                "sidebar",
+                "footer",
+                "metadata"
+              ])
+            ).optional(),
+            exclude_sections: z14.array(
+              z14.enum([
+                "header",
+                "navigation",
+                "banner",
+                "body",
+                "sidebar",
+                "footer",
+                "metadata"
+              ])
+            ).optional()
+          })
+        ]).optional(),
+        highlights: z14.union([
+          z14.boolean(),
+          z14.object({
+            query: z14.string().optional(),
+            max_characters: z14.number().optional()
+          })
+        ]).optional(),
+        max_age_hours: z14.number().optional(),
+        livecrawl_timeout: z14.number().optional(),
+        subpages: z14.number().optional(),
+        subpage_target: z14.union([z14.string(), z14.array(z14.string())]).optional(),
+        extras: z14.object({
+          links: z14.number().optional(),
+          image_links: z14.number().optional()
+        }).optional()
+      }).optional().describe("Controls extracted page content and freshness.")
+    })
+  )
+);
+var exaSearchOutputSchema = lazySchema9(
+  () => zodSchema9(
+    z14.union([
+      z14.object({
+        requestId: z14.string(),
+        searchType: z14.string().optional(),
+        resolvedSearchType: z14.string().optional(),
+        results: z14.array(
+          z14.object({
+            title: z14.string(),
+            url: z14.string(),
+            id: z14.string(),
+            publishedDate: z14.string().nullable().optional(),
+            author: z14.string().nullable().optional(),
+            image: z14.string().nullable().optional(),
+            favicon: z14.string().nullable().optional(),
+            text: z14.string().optional(),
+            highlights: z14.array(z14.string()).optional(),
+            highlightScores: z14.array(z14.number()).optional(),
+            summary: z14.string().optional(),
+            subpages: z14.array(z14.any()).optional(),
+            extras: z14.object({
+              links: z14.array(z14.string()).optional(),
+              imageLinks: z14.array(z14.string()).optional()
+            }).optional()
+          })
+        ),
+        costDollars: z14.object({
+          total: z14.number().optional(),
+          search: z14.record(z14.number()).optional()
+        }).optional()
+      }),
+      z14.object({
+        error: z14.enum([
+          "api_error",
+          "rate_limit",
+          "timeout",
+          "invalid_input",
+          "configuration_error",
+          "execution_error",
+          "unknown"
+        ]),
+        statusCode: z14.number().optional(),
+        message: z14.string()
+      })
+    ])
+  )
+);
+var exaSearchToolFactory = createProviderExecutedToolFactory({
+  id: "gateway.exa_search",
+  inputSchema: exaSearchInputSchema,
+  outputSchema: exaSearchOutputSchema
+});
+var exaSearch = (config = {}) => exaSearchToolFactory(config);
+
+// src/tool/parallel-search.ts
+import {
+  createProviderExecutedToolFactory as createProviderExecutedToolFactory2,
+  lazySchema as lazySchema10,
+  zodSchema as zodSchema10
+} from "@ai-sdk/provider-utils";
+import { z as z15 } from "zod";
+var parallelSearchInputSchema = lazySchema10(
+  () => zodSchema10(
+    z15.object({
+      objective: z15.string().describe(
         "Natural-language description of the web research goal, including source or freshness guidance and broader context from the task. Maximum 5000 characters."
       ),
-      search_queries: z14.array(z14.string()).optional().describe(
+      search_queries: z15.array(z15.string()).optional().describe(
         "Optional search queries to supplement the objective. Maximum 200 characters per query."
       ),
-      mode: z14.enum(["one-shot", "agentic"]).optional().describe(
+      mode: z15.enum(["one-shot", "agentic"]).optional().describe(
         'Mode preset: "one-shot" for comprehensive results with longer excerpts (default), "agentic" for concise, token-efficient results for multi-step workflows.'
       ),
-      max_results: z14.number().optional().describe(
+      max_results: z15.number().optional().describe(
         "Maximum number of results to return (1-20). Defaults to 10 if not specified."
       ),
-      source_policy: z14.object({
-        include_domains: z14.array(z14.string()).optional().describe("List of domains to include in search results."),
-        exclude_domains: z14.array(z14.string()).optional().describe("List of domains to exclude from search results."),
-        after_date: z14.string().optional().describe(
+      source_policy: z15.object({
+        include_domains: z15.array(z15.string()).optional().describe("List of domains to include in search results."),
+        exclude_domains: z15.array(z15.string()).optional().describe("List of domains to exclude from search results."),
+        after_date: z15.string().optional().describe(
           "Only include results published after this date (ISO 8601 format)."
         )
       }).optional().describe(
         "Source policy for controlling which domains to include/exclude and freshness."
       ),
-      excerpts: z14.object({
-        max_chars_per_result: z14.number().optional().describe("Maximum characters per result."),
-        max_chars_total: z14.number().optional().describe("Maximum total characters across all results.")
+      excerpts: z15.object({
+        max_chars_per_result: z15.number().optional().describe("Maximum characters per result."),
+        max_chars_total: z15.number().optional().describe("Maximum total characters across all results.")
       }).optional().describe("Excerpt configuration for controlling result length."),
-      fetch_policy: z14.object({
-        max_age_seconds: z14.number().optional().describe(
+      fetch_policy: z15.object({
+        max_age_seconds: z15.number().optional().describe(
           "Maximum age in seconds for cached content. Set to 0 to always fetch fresh content."
         )
       }).optional().describe("Fetch policy for controlling content freshness.")
     })
   )
 );
-var parallelSearchOutputSchema = lazySchema9(
-  () => zodSchema9(
-    z14.union([
+var parallelSearchOutputSchema = lazySchema10(
+  () => zodSchema10(
+    z15.union([
       // Success response
-      z14.object({
-        searchId: z14.string(),
-        results: z14.array(
-          z14.object({
-            url: z14.string(),
-            title: z14.string(),
-            excerpt: z14.string(),
-            publishDate: z14.string().nullable().optional(),
-            relevanceScore: z14.number().optional()
+      z15.object({
+        searchId: z15.string(),
+        results: z15.array(
+          z15.object({
+            url: z15.string(),
+            title: z15.string(),
+            excerpt: z15.string(),
+            publishDate: z15.string().nullable().optional(),
+            relevanceScore: z15.number().optional()
           })
         )
       }),
       // Error response
-      z14.object({
-        error: z14.enum([
+      z15.object({
+        error: z15.enum([
           "api_error",
           "rate_limit",
           "timeout",
@@ -2078,13 +2211,13 @@ var parallelSearchOutputSchema = lazySchema9(
           "configuration_error",
           "unknown"
         ]),
-        statusCode: z14.number().optional(),
-        message: z14.string()
+        statusCode: z15.number().optional(),
+        message: z15.string()
       })
     ])
   )
 );
-var parallelSearchToolFactory = createProviderExecutedToolFactory({
+var parallelSearchToolFactory = createProviderExecutedToolFactory2({
   id: "gateway.parallel_search",
   inputSchema: parallelSearchInputSchema,
   outputSchema: parallelSearchOutputSchema
@@ -2093,85 +2226,85 @@ var parallelSearch = (config = {}) => parallelSearchToolFactory(config);
 
 // src/tool/perplexity-search.ts
 import {
-  createProviderExecutedToolFactory as createProviderExecutedToolFactory2,
-  lazySchema as lazySchema10,
-  zodSchema as zodSchema10
+  createProviderExecutedToolFactory as createProviderExecutedToolFactory3,
+  lazySchema as lazySchema11,
+  zodSchema as zodSchema11
 } from "@ai-sdk/provider-utils";
-import { z as z15 } from "zod";
-var perplexitySearchInputSchema = lazySchema10(
-  () => zodSchema10(
-    z15.object({
-      query: z15.union([z15.string(), z15.array(z15.string())]).describe(
+import { z as z16 } from "zod";
+var perplexitySearchInputSchema = lazySchema11(
+  () => zodSchema11(
+    z16.object({
+      query: z16.union([z16.string(), z16.array(z16.string())]).describe(
         "Search query (string) or multiple queries (array of up to 5 strings). Multi-query searches return combined results from all queries."
       ),
-      max_results: z15.number().optional().describe(
+      max_results: z16.number().optional().describe(
         "Maximum number of search results to return (1-20, default: 10)"
       ),
-      max_tokens_per_page: z15.number().optional().describe(
+      max_tokens_per_page: z16.number().optional().describe(
         "Maximum number of tokens to extract per search result page (256-2048, default: 2048)"
       ),
-      max_tokens: z15.number().optional().describe(
+      max_tokens: z16.number().optional().describe(
         "Maximum total tokens across all search results (default: 25000, max: 1000000)"
       ),
-      country: z15.string().optional().describe(
+      country: z16.string().optional().describe(
         "Two-letter ISO 3166-1 alpha-2 country code for regional search results (e.g., 'US', 'GB', 'FR')"
       ),
-      search_domain_filter: z15.array(z15.string()).optional().describe(
+      search_domain_filter: z16.array(z16.string()).optional().describe(
         "List of domains to include or exclude from search results (max 20). To include: ['nature.com', 'science.org']. To exclude: ['-example.com', '-spam.net']"
       ),
-      search_language_filter: z15.array(z15.string()).optional().describe(
+      search_language_filter: z16.array(z16.string()).optional().describe(
         "List of ISO 639-1 language codes to filter results (max 10, lowercase). Examples: ['en', 'fr', 'de']"
       ),
-      search_after_date: z15.string().optional().describe(
+      search_after_date: z16.string().optional().describe(
         "Include only results published after this date. Format: 'MM/DD/YYYY' (e.g., '3/1/2025'). Cannot be used with search_recency_filter."
       ),
-      search_before_date: z15.string().optional().describe(
+      search_before_date: z16.string().optional().describe(
         "Include only results published before this date. Format: 'MM/DD/YYYY' (e.g., '3/15/2025'). Cannot be used with search_recency_filter."
       ),
-      last_updated_after_filter: z15.string().optional().describe(
+      last_updated_after_filter: z16.string().optional().describe(
         "Include only results last updated after this date. Format: 'MM/DD/YYYY' (e.g., '3/1/2025'). Cannot be used with search_recency_filter."
       ),
-      last_updated_before_filter: z15.string().optional().describe(
+      last_updated_before_filter: z16.string().optional().describe(
         "Include only results last updated before this date. Format: 'MM/DD/YYYY' (e.g., '3/15/2025'). Cannot be used with search_recency_filter."
       ),
-      search_recency_filter: z15.enum(["day", "week", "month", "year"]).optional().describe(
+      search_recency_filter: z16.enum(["day", "week", "month", "year"]).optional().describe(
         "Filter results by relative time period. Cannot be used with search_after_date or search_before_date."
       )
     })
   )
 );
-var perplexitySearchOutputSchema = lazySchema10(
-  () => zodSchema10(
-    z15.union([
+var perplexitySearchOutputSchema = lazySchema11(
+  () => zodSchema11(
+    z16.union([
       // Success response
-      z15.object({
-        results: z15.array(
-          z15.object({
-            title: z15.string(),
-            url: z15.string(),
-            snippet: z15.string(),
-            date: z15.string().optional(),
-            lastUpdated: z15.string().optional()
+      z16.object({
+        results: z16.array(
+          z16.object({
+            title: z16.string(),
+            url: z16.string(),
+            snippet: z16.string(),
+            date: z16.string().optional(),
+            lastUpdated: z16.string().optional()
           })
         ),
-        id: z15.string()
+        id: z16.string()
       }),
       // Error response
-      z15.object({
-        error: z15.enum([
+      z16.object({
+        error: z16.enum([
           "api_error",
           "rate_limit",
           "timeout",
           "invalid_input",
           "unknown"
         ]),
-        statusCode: z15.number().optional(),
-        message: z15.string()
+        statusCode: z16.number().optional(),
+        message: z16.string()
       })
     ])
   )
 );
-var perplexitySearchToolFactory = createProviderExecutedToolFactory2({
+var perplexitySearchToolFactory = createProviderExecutedToolFactory3({
   id: "gateway.perplexity_search",
   inputSchema: perplexitySearchInputSchema,
   outputSchema: perplexitySearchOutputSchema
@@ -2180,6 +2313,14 @@ var perplexitySearch = (config = {}) => perplexitySearchToolFactory(config);
 
 // src/gateway-tools.ts
 var gatewayTools = {
+  /**
+   * Search the web using Exa for current information and token-efficient
+   * excerpts optimized for agent workflows.
+   *
+   * Supports search type, category, domain, date, location, and content
+   * extraction controls.
+   */
+  exaSearch,
   /**
    * Search the web using Parallel AI's Search API for LLM-optimized excerpts.
    *
@@ -2208,13 +2349,13 @@ async function getVercelRequestId() {
 }
 
 // src/version.ts
-var VERSION = true ? "4.0.0-beta.110" : "0.0.0-test";
+var VERSION = true ? "4.0.0-beta.111" : "0.0.0-test";
 
 // src/gateway-provider.ts
 var AI_GATEWAY_PROTOCOL_VERSION = "0.0.1";
-var gatewayClientSecretResponseSchema = z16.object({
-  token: z16.string(),
-  expiresAt: z16.number().nullish()
+var gatewayClientSecretResponseSchema = z17.object({
+  token: z17.string(),
+  expiresAt: z17.number().nullish()
 });
 function createGateway(options = {}) {
   var _a11, _b11;
@@ -2276,7 +2417,7 @@ function createGateway(options = {}) {
           gatewayClientSecretResponseSchema
         ),
         failedResponseHandler: createJsonErrorResponseHandler11({
-          errorSchema: z16.any(),
+          errorSchema: z17.any(),
           errorToMessage: (data) => data
         }),
         fetch: options.fetch