@ai-sdk/gateway 4.0.131 → 4.0.133

package/docs/00-ai-gateway.mdx

@@ -1422,6 +1422,100 @@ for await (const part of result.stream) {
 }
 ```
 
+#### DeepSeek Search and Fetch
+
+Use `gateway.tools.deepseekSearch()` to search the web and
+`gateway.tools.deepseekFetch()` to retrieve a page as Markdown. Both tools call
+DeepSeek's standalone Search/Fetch APIs from AI Gateway and work with supported
+tool-calling models from any provider. They are separate from a model's built-in
+web search. No additional model provider package is required.
+
+```ts
+import { gateway, generateText } from 'ai';
+
+const result = await generateText({
+  model: 'openai/gpt-6-luna',
+  prompt: 'Search for DeepSeek API documentation and fetch a relevant page.',
+  tools: {
+    deepseek_search: gateway.tools.deepseekSearch({
+      count: 5,
+      needContent: true,
+    }),
+    deepseek_fetch: gateway.tools.deepseekFetch(),
+  },
+});
+
+console.log(result.text);
+console.log(result.toolResults);
+for (const part of result.content) {
+  if (part.type === 'tool-error') console.error('Tool error:', part.error);
+}
+```
+
+The Search tool supports the following optional configuration options:
+
+- **query** _string_
+
+  Pin the search query; otherwise the model chooses it. Queries contain 1–128 Unicode characters and cannot be all whitespace.
+
+- **count** _number_
+
+  Number of results, 1–50 (default: 10).
+
+- **needContent** _boolean_
+
+  Include available page content (default: false).
+
+- **oriQuestion** _string | null_
+
+  Original question, 1–128 Unicode characters. `null` means not provided.
+
+- **localization** _string_
+
+  IP address used to localize results; developer configuration only.
+
+The model-facing input uses `query`, `count`, `need_content`, and `ori_question`.
+Queries support search operators including `site:`, `-site:`, `lang:`, `after:`,
+`before:`, and quoted phrases. Search returns `{ results }`, containing ranked
+URLs, titles, snippets, summaries, optional page content, and nullable site/date
+metadata. An empty `results` array is a successful search with no matches.
+
+Fetch accepts an HTTP(S) `url` up to 8,192 characters, without a username or
+password, and returns `{ content, title? }`. The content is Markdown. You can
+pin the URL with `gateway.tools.deepseekFetch({ url: 'https://example.com' })`.
+The Fetch tool supports the following optional configuration option:
+
+- **url** _string_
+
+  Pin the HTTP(S) URL; otherwise the model chooses it.
+
+Tool failures appear as `tool-error` parts in `result.content` (for
+`generateText`) or `result.stream` (for `streamText`). Inspect `part.error`
+there; failures are not included in `result.toolResults`.
+
+The tools also work with `streamText`:
+
+```ts
+import { gateway, streamText } from 'ai';
+
+const result = streamText({
+  model: 'openai/gpt-6-luna',
+  prompt: 'Search for DeepSeek API documentation and fetch a relevant page.',
+  tools: {
+    deepseek_search: gateway.tools.deepseekSearch(),
+    deepseek_fetch: gateway.tools.deepseekFetch(),
+  },
+});
+
+for await (const part of result.stream) {
+  if (part.type === 'text-delta') process.stdout.write(part.text);
+  if (part.type === 'tool-error') console.error('Tool error:', part.error);
+}
+```
+
+See the [DeepSeek API guide](https://api-docs.deepseek.com/guides/search/) for the
+underlying APIs.
+
 ### Custom Reporting
 
 Track usage per end-user and categorize requests with tags, then query the data through the reporting API.
@@ -1527,7 +1621,7 @@ The AI Gateway provider accepts provider options that control routing behavior a
 
 ### Gateway Provider Options
 
-You can use the `gateway` key in `providerOptions` to control how AI Gateway routes requests:
+You can use the `gateway` key in `providerOptions` to control how AI Gateway routes requests. Without any routing options, AI Gateway picks providers based on recent uptime and latency and falls back to other providers that serve the same model, so most applications don't need to set them.
 
 ```ts
 import type { GatewayProviderOptions } from '@ai-sdk/gateway';
@@ -1538,8 +1632,7 @@ const { text } = await generateText({
   prompt: 'Explain quantum computing',
   providerOptions: {
     gateway: {
-      order: ['vertex', 'anthropic'], // Try Vertex AI first, then Anthropic
-      only: ['vertex', 'anthropic'], // Only use these providers
+      order: ['vertex', 'anthropic'], // Try Vertex AI first, then Anthropic, then other providers
     } satisfies GatewayProviderOptions,
   },
 });
@@ -1557,6 +1650,8 @@ The following gateway provider options are available:
 
   Restricts routing to only the specified providers. When set, the gateway will never route to providers not in this list, even if they would otherwise be available.
 
+  Because unlisted providers are never tried, the request fails instead of falling back when the listed providers are unavailable. When the requirement is about data handling or a model capability, `zeroDataRetention`, `disallowPromptTraining`, or `has` filter by that requirement while keeping every qualifying provider eligible.
+
   Example: `only: ['anthropic', 'vertex']` will only allow routing to Anthropic or Vertex AI.
 
 - **sort** _'cost' | 'ttft' | 'tps'_
@@ -1669,7 +1764,7 @@ The following gateway provider options are available:
   });
   ```
 
-You can combine these options to have fine-grained control over routing and tracking:
+You can combine these options to have fine-grained control over routing and tracking. For example, prefer Vertex AI while keeping fallbacks, and require zero data retention:
 
 ```ts
 import type { GatewayProviderOptions } from '@ai-sdk/gateway';
@@ -1681,7 +1776,7 @@ const { text } = await generateText({
   providerOptions: {
     gateway: {
       order: ['vertex'], // Prefer Vertex AI
-      only: ['anthropic', 'vertex'], // Only allow these providers
+      zeroDataRetention: true, // Only route to providers with zero data retention agreements
     } satisfies GatewayProviderOptions,
   },
 });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ai-sdk/gateway",
   "private": false,
-  "version": "4.0.131",
+  "version": "4.0.133",
   "type": "module",
   "license": "Apache-2.0",
   "sideEffects": false,

package/src/gateway-decision-model-settings.ts

@@ -1,8 +1,8 @@
 export type GatewayDecisionModelId =
   | 'baseten/elephant-1'
+  | 'baseten/joey-1'
   | 'baseten/mammoth-1'
   | 'convaiinnovations/laya'
-  | 'convaiinnovations/laya-free'
   | 'liquid/d1'
   | 'liquid/d1-ultra'
   | 'microsoft/microsoft-decision-1'

package/src/gateway-language-model-settings.ts

@@ -59,7 +59,6 @@ export type GatewayModelId =
   | 'anthropic/claude-sonnet-5-batch'
   | 'anthropic/claude-sonnet-5.5'
   | 'anthropic/claude-sonnet-5.5-batch'
-  | 'arcee-ai/trinity-large-thinking'
   | 'bytedance/seed-1.6'
   | 'bytedance/seed-1.8'
   | 'bytedance/seed-2.1-turbo'
@@ -120,11 +119,12 @@ export type GatewayModelId =
   | 'inclusionai/ling-3.0-flash-sante'
   | 'inclusionai/ling-3.0-flash-vl'
   | 'inclusionai/ling-3.1-flash'
+  | 'inclusionai/ling-3.1-flash-1019'
   | 'inference-net/schematron-v2-small'
   | 'inference-net/schematron-v2-turbo'
   | 'interfaze/interfaze-beta'
   | 'liquid/lfm2.5-24b-a2b'
-  | 'meituan/longcat-2.5-preview'
+  | 'meituan/longcat-2.5'
   | 'meta/llama-3.1-70b'
   | 'meta/llama-3.1-8b'
   | 'meta/llama-3.3-70b'
@@ -262,7 +262,6 @@ export type GatewayModelId =
   | 'particle/particle-1'
   | 'perplexity/sonar'
   | 'poolside/laguna-s-2.1'
-  | 'poolside/laguna-s-2.1-free'
   | 'quiverai/arrow-2'
   | 'quiverai/arrow-2-telos'
   | 'reflection/beam'
@@ -319,5 +318,6 @@ export type GatewayModelId =
   | 'zai/glm-5.3-fast'
   | 'zai/glm-5.3-flash'
   | 'zai/glm-5.3-flashx'
+  | 'zai/glm-5.3-flashx-legal'
   | 'zai/glm-5v-turbo'
   | (string & {});

package/src/gateway-tools.ts

@@ -1,5 +1,7 @@
 import { browserbaseFetch } from './tool/browserbase-fetch';
 import { browserbaseSearch } from './tool/browserbase-search';
+import { deepseekFetch } from './tool/deepseek-fetch';
+import { deepseekSearch } from './tool/deepseek-search';
 import { exaSearch } from './tool/exa-search';
 import { parallelSearch } from './tool/parallel-search';
 import { perplexitySearch } from './tool/perplexity-search';
@@ -25,6 +27,18 @@ export const gatewayTools = {
    */
   browserbaseSearch,
 
+  /**
+   * Fetch a page as Markdown through DeepSeek's standalone Fetch API.
+   * Executed by AI Gateway for any model, separate from native model web search.
+   */
+  deepseekFetch,
+
+  /**
+   * Search the web through DeepSeek's standalone Search API.
+   * Executed by AI Gateway for any model, separate from native model web search.
+   */
+  deepseekSearch,
+
   /**
    * Search the web using Exa for current information and token-efficient
    * excerpts optimized for agent workflows.

package/src/tool/deepseek-fetch.ts

@@ -0,0 +1,68 @@
+import {
+  createProviderExecutedToolFactory,
+  lazySchema,
+  zodSchema,
+} from '@ai-sdk/provider-utils';
+import { z } from '../zod';
+import {
+  gatewayToolErrorSchema,
+  type GatewayToolError,
+} from './gateway-tool-error';
+
+export interface DeepSeekFetchConfig {
+  /** Pin the target URL instead of allowing the model to choose it. */
+  url?: string;
+}
+
+export interface DeepSeekFetchInput {
+  url: string;
+}
+
+export interface DeepSeekFetchResponse {
+  title?: string | null;
+  /** Page content as Markdown. */
+  content: string;
+}
+
+export type DeepSeekFetchOutput = DeepSeekFetchResponse | GatewayToolError;
+
+const deepseekFetchInputSchema = lazySchema(() =>
+  zodSchema(
+    z.object({
+      url: z
+        .string()
+        .describe(
+          'URL to fetch, at most 8192 characters; HTTP(S) only, without a username or password.',
+        ),
+    }),
+  ),
+);
+
+const deepseekFetchOutputSchema = lazySchema(() =>
+  zodSchema(
+    z.union([
+      z
+        .object({
+          title: z.string().nullish(),
+          content: z.string(),
+        })
+        .passthrough(),
+      gatewayToolErrorSchema(),
+    ]),
+  ),
+);
+
+export const deepseekFetchToolFactory = createProviderExecutedToolFactory<
+  DeepSeekFetchInput,
+  DeepSeekFetchOutput,
+  DeepSeekFetchConfig
+>({
+  id: 'gateway.deepseek_fetch',
+  inputSchema: deepseekFetchInputSchema,
+  outputSchema: deepseekFetchOutputSchema,
+});
+
+export const deepseekFetch = (
+  config: DeepSeekFetchConfig = {},
+): ReturnType<typeof deepseekFetchToolFactory> =>
+  deepseekFetchToolFactory(config);

package/src/tool/deepseek-search.ts

@@ -0,0 +1,118 @@
+import {
+  createProviderExecutedToolFactory,
+  lazySchema,
+  zodSchema,
+} from '@ai-sdk/provider-utils';
+import { z } from '../zod';
+import {
+  gatewayToolErrorSchema,
+  type GatewayToolError,
+} from './gateway-tool-error';
+
+export interface DeepSeekSearchConfig {
+  /** Pin the query instead of allowing the model to choose it. */
+  query?: string;
+  /** Maximum number of results, 1–50 (default: 10). */
+  count?: number;
+  /** Include available page content (default: false). */
+  needContent?: boolean;
+  /** Original question, 1–128 Unicode characters; null means absent. */
+  oriQuestion?: string | null;
+  /** Developer-configured IP address for result localization. */
+  localization?: string;
+}
+
+export interface DeepSeekSearchInput {
+  query: string;
+  count?: number;
+  need_content?: boolean;
+  ori_question?: string | null;
+}
+
+export interface DeepSeekSearchResult {
+  authority?: number | null;
+  content?: string | null;
+  date?: string | null;
+  rerank_score?: number | null;
+  site_icon?: string | null;
+  site_name?: string | null;
+  snippet?: string | null;
+  summary?: string | null;
+  title?: string | null;
+  url?: string | null;
+}
+
+export interface DeepSeekSearchResponse {
+  results: DeepSeekSearchResult[];
+}
+
+export type DeepSeekSearchOutput = DeepSeekSearchResponse | GatewayToolError;
+
+const deepseekSearchInputSchema = lazySchema(() =>
+  zodSchema(
+    z.object({
+      query: z
+        .string()
+        .describe(
+          'Web search query, 1 to 128 Unicode characters. Supports site:, -site:, lang:, after:, before:, and quoted phrases.',
+        ),
+      count: z
+        .number()
+        .int()
+        .optional()
+        .describe('Number of results, 1 to 50 (default: 10).'),
+      need_content: z
+        .boolean()
+        .optional()
+        .describe('Include available page content (default: false).'),
+      ori_question: z
+        .string()
+        .nullable()
+        .optional()
+        .describe('Original user question, 1 to 128 Unicode characters.'),
+    }),
+  ),
+);
+
+const deepseekSearchOutputSchema = lazySchema(() =>
+  zodSchema(
+    z.union([
+      z
+        .object({
+          results: z.array(
+            z
+              .object({
+                authority: z.number().nullish(),
+                content: z.string().nullish(),
+                date: z.string().nullish(),
+                rerank_score: z.number().nullish(),
+                site_icon: z.string().nullish(),
+                site_name: z.string().nullish(),
+                snippet: z.string().nullish(),
+                summary: z.string().nullish(),
+                title: z.string().nullish(),
+                url: z.string().nullish(),
+              })
+              .passthrough(),
+          ),
+        })
+        .passthrough(),
+      gatewayToolErrorSchema(),
+    ]),
+  ),
+);
+
+export const deepseekSearchToolFactory = createProviderExecutedToolFactory<
+  DeepSeekSearchInput,
+  DeepSeekSearchOutput,
+  DeepSeekSearchConfig
+>({
+  id: 'gateway.deepseek_search',
+  inputSchema: deepseekSearchInputSchema,
+  outputSchema: deepseekSearchOutputSchema,
+});
+
+export const deepseekSearch = (
+  config: DeepSeekSearchConfig = {},
+): ReturnType<typeof deepseekSearchToolFactory> =>
+  deepseekSearchToolFactory(config);

package/src/tool/gateway-tool-error.ts

@@ -0,0 +1,39 @@
+import { z } from '../zod';
+
+export interface GatewayToolError {
+  error:
+    | 'api_error'
+    | 'configuration_error'
+    | 'execution_error'
+    | 'gateway_rate_limit'
+    | 'invalid_input'
+    | 'rate_limit'
+    | 'timeout'
+    | 'unknown'
+    | 'unknown_tool';
+  message: string;
+  statusCode?: number;
+  retryAfter?: string;
+  statusText?: string;
+}
+
+export const gatewayToolErrorSchema = () =>
+  z
+    .object({
+      error: z.enum([
+        'api_error',
+        'configuration_error',
+        'execution_error',
+        'gateway_rate_limit',
+        'invalid_input',
+        'rate_limit',
+        'timeout',
+        'unknown',
+        'unknown_tool',
+      ]),
+      message: z.string(),
+      statusCode: z.number().optional(),
+      retryAfter: z.string().optional(),
+      statusText: z.string().optional(),
+    })
+    .passthrough();

package/src/tool/parallel-search.ts

@@ -4,6 +4,10 @@ import {
   zodSchema,
 } from '@ai-sdk/provider-utils';
 import { z } from '../zod';
+import {
+  gatewayToolErrorSchema,
+  type GatewayToolError,
+} from './gateway-tool-error';
 
 const parallelSearchModes = [
   'turbo',
@@ -153,23 +157,7 @@ export interface ParallelSearchResponse {
   session_id?: string;
 }
 
-export interface ParallelSearchError {
-  /** Error type */
-  error:
-    | 'api_error'
-    | 'configuration_error'
-    | 'execution_error'
-    | 'gateway_rate_limit'
-    | 'invalid_input'
-    | 'rate_limit'
-    | 'timeout'
-    | 'unknown'
-    | 'unknown_tool';
-  /** HTTP status code if applicable */
-  statusCode?: number;
-  /** Human-readable error message */
-  message: string;
-}
+export type ParallelSearchError = GatewayToolError;
 
 export interface ParallelSearchInput {
   /**
@@ -375,21 +363,7 @@ const parallelSearchOutputSchema = lazySchema(() =>
         session_id: z.string().optional(),
       }),
       // Error response
-      z.object({
-        error: z.enum([
-          'api_error',
-          'configuration_error',
-          'execution_error',
-          'gateway_rate_limit',
-          'invalid_input',
-          'rate_limit',
-          'timeout',
-          'unknown',
-          'unknown_tool',
-        ]),
-        statusCode: z.number().optional(),
-        message: z.string(),
-      }),
+      gatewayToolErrorSchema(),
     ]),
   ),
 );

package/src/tool/tako-search.ts

@@ -4,6 +4,10 @@ import {
   zodSchema,
 } from '@ai-sdk/provider-utils';
 import { z } from '../zod';
+import {
+  gatewayToolErrorSchema,
+  type GatewayToolError,
+} from './gateway-tool-error';
 
 export type TakoSearchEffort = 'deep' | 'fast' | 'instant';
 
@@ -246,18 +250,7 @@ export interface TakoSearchResponse {
   related?: Array<Record<string, unknown>> | null;
 }
 
-export interface TakoSearchError {
-  error:
-    | 'api_error'
-    | 'configuration_error'
-    | 'execution_error'
-    | 'invalid_input'
-    | 'rate_limit'
-    | 'timeout'
-    | 'unknown_tool';
-  statusCode?: number;
-  message: string;
-}
+export type TakoSearchError = GatewayToolError;
 
 export type TakoSearchOutput = TakoSearchError | TakoSearchResponse;
 
@@ -570,19 +563,7 @@ const takoSearchOutputSchema = lazySchema(() =>
           related: z.array(z.object({}).passthrough()).nullish(),
         })
         .passthrough(),
-      z.object({
-        error: z.enum([
-          'api_error',
-          'configuration_error',
-          'execution_error',
-          'invalid_input',
-          'rate_limit',
-          'timeout',
-          'unknown_tool',
-        ]),
-        statusCode: z.number().optional(),
-        message: z.string(),
-      }),
+      gatewayToolErrorSchema(),
     ]),
   ),
 );