@ai-sdk/anthropic 2.0.0-alpha.8 → 2.0.0-alpha.9

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @ai-sdk/anthropic
 
+## 2.0.0-alpha.9
+
+### Patch Changes
+
+- 362b048: add web search tool support
+- Updated dependencies [811dff3]
+  - @ai-sdk/provider@2.0.0-alpha.9
+  - @ai-sdk/provider-utils@3.0.0-alpha.9
+
 ## 2.0.0-alpha.8
 
 ### Patch Changes

package/dist/index.d.mts

@@ -20,18 +20,107 @@ declare const anthropicProviderOptions: z.ZodObject<{
         type: "enabled" | "disabled";
         budgetTokens?: number | undefined;
     }>>;
+    /**
+     * Web search tool configuration for Claude models that support it.
+     * When provided, automatically adds the web search tool to the request.
+     */
+    webSearch: z.ZodOptional<z.ZodObject<{
+        /**
+         * Limit the number of searches per request (optional)
+         * Defaults to 5 if not specified
+         */
+        maxUses: z.ZodOptional<z.ZodNumber>;
+        /**
+         * Only include results from these domains (optional)
+         * Cannot be used with blockedDomains
+         */
+        allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        /**
+         * Never include results from these domains (optional)
+         * Cannot be used with allowedDomains
+         */
+        blockedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        /**
+         * Localize search results based on user location (optional)
+         */
+        userLocation: z.ZodOptional<z.ZodObject<{
+            type: z.ZodLiteral<"approximate">;
+            city: z.ZodOptional<z.ZodString>;
+            region: z.ZodOptional<z.ZodString>;
+            country: z.ZodString;
+            timezone: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            type: "approximate";
+            country: string;
+            city?: string | undefined;
+            region?: string | undefined;
+            timezone?: string | undefined;
+        }, {
+            type: "approximate";
+            country: string;
+            city?: string | undefined;
+            region?: string | undefined;
+            timezone?: string | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        maxUses?: number | undefined;
+        allowedDomains?: string[] | undefined;
+        blockedDomains?: string[] | undefined;
+        userLocation?: {
+            type: "approximate";
+            country: string;
+            city?: string | undefined;
+            region?: string | undefined;
+            timezone?: string | undefined;
+        } | undefined;
+    }, {
+        maxUses?: number | undefined;
+        allowedDomains?: string[] | undefined;
+        blockedDomains?: string[] | undefined;
+        userLocation?: {
+            type: "approximate";
+            country: string;
+            city?: string | undefined;
+            region?: string | undefined;
+            timezone?: string | undefined;
+        } | undefined;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     sendReasoning?: boolean | undefined;
     thinking?: {
         type: "enabled" | "disabled";
         budgetTokens?: number | undefined;
     } | undefined;
+    webSearch?: {
+        maxUses?: number | undefined;
+        allowedDomains?: string[] | undefined;
+        blockedDomains?: string[] | undefined;
+        userLocation?: {
+            type: "approximate";
+            country: string;
+            city?: string | undefined;
+            region?: string | undefined;
+            timezone?: string | undefined;
+        } | undefined;
+    } | undefined;
 }, {
     sendReasoning?: boolean | undefined;
     thinking?: {
         type: "enabled" | "disabled";
         budgetTokens?: number | undefined;
     } | undefined;
+    webSearch?: {
+        maxUses?: number | undefined;
+        allowedDomains?: string[] | undefined;
+        blockedDomains?: string[] | undefined;
+        userLocation?: {
+            type: "approximate";
+            country: string;
+            city?: string | undefined;
+            region?: string | undefined;
+            timezone?: string | undefined;
+        } | undefined;
+    } | undefined;
 }>;
 type AnthropicProviderOptions = z.infer<typeof anthropicProviderOptions>;
 

package/dist/index.d.ts

@@ -20,18 +20,107 @@ declare const anthropicProviderOptions: z.ZodObject<{
         type: "enabled" | "disabled";
         budgetTokens?: number | undefined;
     }>>;
+    /**
+     * Web search tool configuration for Claude models that support it.
+     * When provided, automatically adds the web search tool to the request.
+     */
+    webSearch: z.ZodOptional<z.ZodObject<{
+        /**
+         * Limit the number of searches per request (optional)
+         * Defaults to 5 if not specified
+         */
+        maxUses: z.ZodOptional<z.ZodNumber>;
+        /**
+         * Only include results from these domains (optional)
+         * Cannot be used with blockedDomains
+         */
+        allowedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        /**
+         * Never include results from these domains (optional)
+         * Cannot be used with allowedDomains
+         */
+        blockedDomains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        /**
+         * Localize search results based on user location (optional)
+         */
+        userLocation: z.ZodOptional<z.ZodObject<{
+            type: z.ZodLiteral<"approximate">;
+            city: z.ZodOptional<z.ZodString>;
+            region: z.ZodOptional<z.ZodString>;
+            country: z.ZodString;
+            timezone: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            type: "approximate";
+            country: string;
+            city?: string | undefined;
+            region?: string | undefined;
+            timezone?: string | undefined;
+        }, {
+            type: "approximate";
+            country: string;
+            city?: string | undefined;
+            region?: string | undefined;
+            timezone?: string | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        maxUses?: number | undefined;
+        allowedDomains?: string[] | undefined;
+        blockedDomains?: string[] | undefined;
+        userLocation?: {
+            type: "approximate";
+            country: string;
+            city?: string | undefined;
+            region?: string | undefined;
+            timezone?: string | undefined;
+        } | undefined;
+    }, {
+        maxUses?: number | undefined;
+        allowedDomains?: string[] | undefined;
+        blockedDomains?: string[] | undefined;
+        userLocation?: {
+            type: "approximate";
+            country: string;
+            city?: string | undefined;
+            region?: string | undefined;
+            timezone?: string | undefined;
+        } | undefined;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     sendReasoning?: boolean | undefined;
     thinking?: {
         type: "enabled" | "disabled";
         budgetTokens?: number | undefined;
     } | undefined;
+    webSearch?: {
+        maxUses?: number | undefined;
+        allowedDomains?: string[] | undefined;
+        blockedDomains?: string[] | undefined;
+        userLocation?: {
+            type: "approximate";
+            country: string;
+            city?: string | undefined;
+            region?: string | undefined;
+            timezone?: string | undefined;
+        } | undefined;
+    } | undefined;
 }, {
     sendReasoning?: boolean | undefined;
     thinking?: {
         type: "enabled" | "disabled";
         budgetTokens?: number | undefined;
     } | undefined;
+    webSearch?: {
+        maxUses?: number | undefined;
+        allowedDomains?: string[] | undefined;
+        blockedDomains?: string[] | undefined;
+        userLocation?: {
+            type: "approximate";
+            country: string;
+            city?: string | undefined;
+            region?: string | undefined;
+            timezone?: string | undefined;
+        } | undefined;
+    } | undefined;
 }>;
 type AnthropicProviderOptions = z.infer<typeof anthropicProviderOptions>;
 

package/dist/index.js

@@ -51,6 +51,13 @@ var anthropicFailedResponseHandler = (0, import_provider_utils.createJsonErrorRe
 
 // src/anthropic-messages-options.ts
 var import_zod2 = require("zod");
+var webSearchLocationSchema = import_zod2.z.object({
+  type: import_zod2.z.literal("approximate"),
+  city: import_zod2.z.string().optional(),
+  region: import_zod2.z.string().optional(),
+  country: import_zod2.z.string(),
+  timezone: import_zod2.z.string().optional()
+});
 var anthropicProviderOptions = import_zod2.z.object({
   /**
   Include reasoning content in requests sent to the model. Defaults to `true`.
@@ -61,11 +68,39 @@ var anthropicProviderOptions = import_zod2.z.object({
   thinking: import_zod2.z.object({
     type: import_zod2.z.union([import_zod2.z.literal("enabled"), import_zod2.z.literal("disabled")]),
     budgetTokens: import_zod2.z.number().optional()
+  }).optional(),
+  /**
+   * Web search tool configuration for Claude models that support it.
+   * When provided, automatically adds the web search tool to the request.
+   */
+  webSearch: import_zod2.z.object({
+    /**
+     * Limit the number of searches per request (optional)
+     * Defaults to 5 if not specified
+     */
+    maxUses: import_zod2.z.number().min(1).max(20).optional(),
+    /**
+     * Only include results from these domains (optional)
+     * Cannot be used with blockedDomains
+     */
+    allowedDomains: import_zod2.z.array(import_zod2.z.string()).optional(),
+    /**
+     * Never include results from these domains (optional)
+     * Cannot be used with allowedDomains
+     */
+    blockedDomains: import_zod2.z.array(import_zod2.z.string()).optional(),
+    /**
+     * Localize search results based on user location (optional)
+     */
+    userLocation: webSearchLocationSchema.optional()
   }).optional()
 });
 
 // src/anthropic-prepare-tools.ts
 var import_provider = require("@ai-sdk/provider");
+function isWebSearchTool(tool) {
+  return typeof tool === "object" && tool !== null && "type" in tool && tool.type === "web_search_20250305";
+}
 function prepareTools({
   tools,
   toolChoice
@@ -78,6 +113,10 @@ function prepareTools({
   }
   const anthropicTools2 = [];
   for (const tool of tools) {
+    if (isWebSearchTool(tool)) {
+      anthropicTools2.push(tool);
+      continue;
+    }
     switch (tool.type) {
       case "function":
         anthropicTools2.push({
@@ -489,8 +528,10 @@ function mapAnthropicStopReason({
 var AnthropicMessagesLanguageModel = class {
   constructor(modelId, config) {
     this.specificationVersion = "v2";
+    var _a;
     this.modelId = modelId;
     this.config = config;
+    this.generateId = (_a = config.generateId) != null ? _a : import_provider_utils3.generateId;
   }
   supportsUrl(url) {
     return url.protocol === "https:";
@@ -620,6 +661,27 @@ var AnthropicMessagesLanguageModel = class {
       }
       baseArgs.max_tokens = maxOutputTokens + thinkingBudget;
     }
+    let modifiedTools = tools;
+    let modifiedToolChoice = toolChoice;
+    if (anthropicOptions == null ? void 0 : anthropicOptions.webSearch) {
+      const webSearchTool = {
+        type: "web_search_20250305",
+        name: "web_search",
+        max_uses: anthropicOptions.webSearch.maxUses,
+        allowed_domains: anthropicOptions.webSearch.allowedDomains,
+        blocked_domains: anthropicOptions.webSearch.blockedDomains,
+        ...anthropicOptions.webSearch.userLocation && {
+          user_location: {
+            type: anthropicOptions.webSearch.userLocation.type,
+            country: anthropicOptions.webSearch.userLocation.country,
+            city: anthropicOptions.webSearch.userLocation.city,
+            region: anthropicOptions.webSearch.userLocation.region,
+            timezone: anthropicOptions.webSearch.userLocation.timezone
+          }
+        }
+      };
+      modifiedTools = tools ? [...tools, webSearchTool] : [webSearchTool];
+    }
     const {
       tools: anthropicTools2,
       toolChoice: anthropicToolChoice,
@@ -629,7 +691,7 @@ var AnthropicMessagesLanguageModel = class {
       jsonResponseTool != null ? {
         tools: [jsonResponseTool],
         toolChoice: { type: "tool", toolName: jsonResponseTool.name }
-      } : { tools, toolChoice }
+      } : { tools: modifiedTools, toolChoice: modifiedToolChoice }
     );
     return {
       args: {
@@ -661,7 +723,7 @@ var AnthropicMessagesLanguageModel = class {
     return (_c = (_b = (_a = this.config).transformRequestBody) == null ? void 0 : _b.call(_a, args)) != null ? _c : args;
   }
   async doGenerate(options) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e;
     const { args, warnings, betas, jsonResponseTool } = await this.getArgs(options);
     const {
       responseHeaders,
@@ -727,6 +789,38 @@ var AnthropicMessagesLanguageModel = class {
           );
           break;
         }
+        case "server_tool_use": {
+          continue;
+        }
+        case "web_search_tool_result": {
+          if (Array.isArray(part.content)) {
+            for (const result of part.content) {
+              if (result.type === "web_search_result") {
+                content.push({
+                  type: "source",
+                  sourceType: "url",
+                  id: this.generateId(),
+                  url: result.url,
+                  title: result.title,
+                  providerMetadata: {
+                    anthropic: {
+                      encryptedContent: result.encrypted_content,
+                      pageAge: (_a = result.page_age) != null ? _a : null
+                    }
+                  }
+                });
+              }
+            }
+          } else if (part.content.type === "web_search_tool_result_error") {
+            throw new import_provider3.APICallError({
+              message: `Web search failed: ${part.content.error_code}`,
+              url: "web_search_api",
+              requestBodyValues: { tool_use_id: part.tool_use_id },
+              data: { error_code: part.content.error_code }
+            });
+          }
+          break;
+        }
       }
     }
     return {
@@ -739,19 +833,19 @@ var AnthropicMessagesLanguageModel = class {
         inputTokens: response.usage.input_tokens,
         outputTokens: response.usage.output_tokens,
         totalTokens: response.usage.input_tokens + response.usage.output_tokens,
-        cachedInputTokens: (_a = response.usage.cache_read_input_tokens) != null ? _a : void 0
+        cachedInputTokens: (_b = response.usage.cache_read_input_tokens) != null ? _b : void 0
       },
       request: { body: args },
       response: {
-        id: (_b = response.id) != null ? _b : void 0,
-        modelId: (_c = response.model) != null ? _c : void 0,
+        id: (_c = response.id) != null ? _c : void 0,
+        modelId: (_d = response.model) != null ? _d : void 0,
         headers: responseHeaders,
         body: rawResponse
       },
       warnings,
       providerMetadata: {
         anthropic: {
-          cacheCreationInputTokens: (_d = response.usage.cache_creation_input_tokens) != null ? _d : null
+          cacheCreationInputTokens: (_e = response.usage.cache_creation_input_tokens) != null ? _e : null
         }
       }
     };
@@ -779,6 +873,8 @@ var AnthropicMessagesLanguageModel = class {
     const toolCallContentBlocks = {};
     let providerMetadata = void 0;
     let blockType = void 0;
+    const config = this.config;
+    const generateId3 = this.generateId;
     return {
       stream: response.pipeThrough(
         new TransformStream({
@@ -786,7 +882,7 @@ var AnthropicMessagesLanguageModel = class {
             controller.enqueue({ type: "stream-start", warnings });
           },
           transform(chunk, controller) {
-            var _a, _b, _c, _d, _e, _f;
+            var _a, _b, _c, _d, _e, _f, _g;
             if (!chunk.success) {
               controller.enqueue({ type: "error", error: chunk.error });
               return;
@@ -825,6 +921,40 @@ var AnthropicMessagesLanguageModel = class {
                     };
                     return;
                   }
+                  case "server_tool_use": {
+                    return;
+                  }
+                  case "web_search_tool_result": {
+                    if (Array.isArray(value.content_block.content)) {
+                      for (const result of value.content_block.content) {
+                        if (result.type === "web_search_result") {
+                          controller.enqueue({
+                            type: "source",
+                            sourceType: "url",
+                            id: generateId3(),
+                            url: result.url,
+                            title: result.title,
+                            providerMetadata: {
+                              anthropic: {
+                                encryptedContent: result.encrypted_content,
+                                pageAge: (_a = result.page_age) != null ? _a : null
+                              }
+                            }
+                          });
+                        }
+                      }
+                    } else if (value.content_block.content.type === "web_search_tool_result_error") {
+                      controller.enqueue({
+                        type: "error",
+                        error: {
+                          type: "web-search-error",
+                          message: `Web search failed: ${value.content_block.content.error_code}`,
+                          code: value.content_block.content.error_code
+                        }
+                      });
+                    }
+                    return;
+                  }
                   default: {
                     const _exhaustiveCheck = contentBlockType;
                     throw new Error(
@@ -887,6 +1017,9 @@ var AnthropicMessagesLanguageModel = class {
                   }
                   case "input_json_delta": {
                     const contentBlock = toolCallContentBlocks[value.index];
+                    if (!contentBlock) {
+                      return;
+                    }
                     controller.enqueue(
                       jsonResponseTool != null ? {
                         type: "text",
@@ -902,6 +1035,9 @@ var AnthropicMessagesLanguageModel = class {
                     contentBlock.jsonText += value.delta.partial_json;
                     return;
                   }
+                  case "citations_delta": {
+                    return;
+                  }
                   default: {
                     const _exhaustiveCheck = deltaType;
                     throw new Error(
@@ -912,22 +1048,22 @@ var AnthropicMessagesLanguageModel = class {
               }
               case "message_start": {
                 usage.inputTokens = value.message.usage.input_tokens;
-                usage.cachedInputTokens = (_a = value.message.usage.cache_read_input_tokens) != null ? _a : void 0;
+                usage.cachedInputTokens = (_b = value.message.usage.cache_read_input_tokens) != null ? _b : void 0;
                 providerMetadata = {
                   anthropic: {
-                    cacheCreationInputTokens: (_b = value.message.usage.cache_creation_input_tokens) != null ? _b : null
+                    cacheCreationInputTokens: (_c = value.message.usage.cache_creation_input_tokens) != null ? _c : null
                   }
                 };
                 controller.enqueue({
                   type: "response-metadata",
-                  id: (_c = value.message.id) != null ? _c : void 0,
-                  modelId: (_d = value.message.model) != null ? _d : void 0
+                  id: (_d = value.message.id) != null ? _d : void 0,
+                  modelId: (_e = value.message.model) != null ? _e : void 0
                 });
                 return;
               }
               case "message_delta": {
                 usage.outputTokens = value.usage.output_tokens;
-                usage.totalTokens = ((_e = usage.inputTokens) != null ? _e : 0) + ((_f = value.usage.output_tokens) != null ? _f : 0);
+                usage.totalTokens = ((_f = usage.inputTokens) != null ? _f : 0) + ((_g = value.usage.output_tokens) != null ? _g : 0);
                 finishReason = mapAnthropicStopReason({
                   finishReason: value.delta.stop_reason,
                   isJsonResponseFromTool: jsonResponseTool != null
@@ -984,6 +1120,31 @@ var anthropicMessagesResponseSchema = import_zod3.z.object({
         id: import_zod3.z.string(),
         name: import_zod3.z.string(),
         input: import_zod3.z.unknown()
+      }),
+      import_zod3.z.object({
+        type: import_zod3.z.literal("server_tool_use"),
+        id: import_zod3.z.string(),
+        name: import_zod3.z.string(),
+        input: import_zod3.z.record(import_zod3.z.unknown()).nullish()
+      }),
+      import_zod3.z.object({
+        type: import_zod3.z.literal("web_search_tool_result"),
+        tool_use_id: import_zod3.z.string(),
+        content: import_zod3.z.union([
+          import_zod3.z.array(
+            import_zod3.z.object({
+              type: import_zod3.z.literal("web_search_result"),
+              url: import_zod3.z.string(),
+              title: import_zod3.z.string(),
+              encrypted_content: import_zod3.z.string(),
+              page_age: import_zod3.z.string().nullish()
+            })
+          ),
+          import_zod3.z.object({
+            type: import_zod3.z.literal("web_search_tool_result_error"),
+            error_code: import_zod3.z.string()
+          })
+        ])
       })
     ])
   ),
@@ -992,7 +1153,10 @@ var anthropicMessagesResponseSchema = import_zod3.z.object({
     input_tokens: import_zod3.z.number(),
     output_tokens: import_zod3.z.number(),
     cache_creation_input_tokens: import_zod3.z.number().nullish(),
-    cache_read_input_tokens: import_zod3.z.number().nullish()
+    cache_read_input_tokens: import_zod3.z.number().nullish(),
+    server_tool_use: import_zod3.z.object({
+      web_search_requests: import_zod3.z.number()
+    }).nullish()
   })
 });
 var anthropicMessagesChunkSchema = import_zod3.z.discriminatedUnion("type", [
@@ -1029,6 +1193,31 @@ var anthropicMessagesChunkSchema = import_zod3.z.discriminatedUnion("type", [
       import_zod3.z.object({
         type: import_zod3.z.literal("redacted_thinking"),
         data: import_zod3.z.string()
+      }),
+      import_zod3.z.object({
+        type: import_zod3.z.literal("server_tool_use"),
+        id: import_zod3.z.string(),
+        name: import_zod3.z.string(),
+        input: import_zod3.z.record(import_zod3.z.unknown()).nullish()
+      }),
+      import_zod3.z.object({
+        type: import_zod3.z.literal("web_search_tool_result"),
+        tool_use_id: import_zod3.z.string(),
+        content: import_zod3.z.union([
+          import_zod3.z.array(
+            import_zod3.z.object({
+              type: import_zod3.z.literal("web_search_result"),
+              url: import_zod3.z.string(),
+              title: import_zod3.z.string(),
+              encrypted_content: import_zod3.z.string(),
+              page_age: import_zod3.z.string().nullish()
+            })
+          ),
+          import_zod3.z.object({
+            type: import_zod3.z.literal("web_search_tool_result_error"),
+            error_code: import_zod3.z.string()
+          })
+        ])
       })
     ])
   }),
@@ -1051,6 +1240,16 @@ var anthropicMessagesChunkSchema = import_zod3.z.discriminatedUnion("type", [
       import_zod3.z.object({
         type: import_zod3.z.literal("signature_delta"),
         signature: import_zod3.z.string()
+      }),
+      import_zod3.z.object({
+        type: import_zod3.z.literal("citations_delta"),
+        citation: import_zod3.z.object({
+          type: import_zod3.z.literal("web_search_result_location"),
+          cited_text: import_zod3.z.string(),
+          url: import_zod3.z.string(),
+          title: import_zod3.z.string(),
+          encrypted_index: import_zod3.z.string()
+        })
       })
     ])
   }),
@@ -1242,15 +1441,19 @@ function createAnthropic(options = {}) {
     }),
     ...options.headers
   });
-  const createChatModel = (modelId) => new AnthropicMessagesLanguageModel(modelId, {
-    provider: "anthropic.messages",
-    baseURL,
-    headers: getHeaders,
-    fetch: options.fetch,
-    supportedUrls: () => ({
-      "image/*": [/^https?:\/\/.*$/]
-    })
-  });
+  const createChatModel = (modelId) => {
+    var _a2;
+    return new AnthropicMessagesLanguageModel(modelId, {
+      provider: "anthropic.messages",
+      baseURL,
+      headers: getHeaders,
+      fetch: options.fetch,
+      generateId: (_a2 = options.generateId) != null ? _a2 : import_provider_utils4.generateId,
+      supportedUrls: () => ({
+        "image/*": [/^https?:\/\/.*$/]
+      })
+    });
+  };
   const provider = function(modelId) {
     if (new.target) {
       throw new Error(