@ai-sdk/anthropic 3.0.25 → 3.0.27

package/docs/05-anthropic.mdx

@@ -56,6 +56,13 @@ You can use the following optional settings to customize the Anthropic provider
 
   API key that is being sent using the `x-api-key` header.
   It defaults to the `ANTHROPIC_API_KEY` environment variable.
+  Only one of `apiKey` or `authToken` is required.
+
+- **authToken** _string_
+
+  Auth token that is being sent using the `Authorization: Bearer` header.
+  It defaults to the `ANTHROPIC_AUTH_TOKEN` environment variable.
+  Only one of `apiKey` or `authToken` is required.
 
 - **headers** _Record<string,string>_
 
@@ -78,6 +85,12 @@ Some models have multi-modal capabilities.
 const model = anthropic('claude-3-haiku-20240307');
 ```
 
+You can also use the following aliases for model creation:
+
+- `anthropic.languageModel('claude-3-haiku-20240307')` - Creates a language model
+- `anthropic.chat('claude-3-haiku-20240307')` - Alias for `languageModel`
+- `anthropic.messages('claude-3-haiku-20240307')` - Alias for `languageModel`
+
 You can use Anthropic language models to generate text with the `generateText` function:
 
 ```ts
@@ -317,7 +330,7 @@ import { generateText } from 'ai';
 const errorMessage = '... long error message ...';
 
 const result = await generateText({
-  model: anthropic('claude-3-5-sonnet-20240620'),
+  model: anthropic('claude-sonnet-4-5'),
   messages: [
     {
       role: 'user',
@@ -345,7 +358,7 @@ You can also use cache control on system messages by providing multiple system m
 
 ```ts highlight="3,7-9"
 const result = await generateText({
-  model: anthropic('claude-3-5-sonnet-20240620'),
+  model: anthropic('claude-sonnet-4-5'),
   messages: [
     {
       role: 'system',
@@ -444,7 +457,7 @@ For more on prompt caching with Anthropic, see [Anthropic's Cache Control docume
 The Bash Tool allows running bash commands. Here's how to create and use it:
 
 ```ts
-const bashTool = anthropic.tools.bash_20241022({
+const bashTool = anthropic.tools.bash_20250124({
   execute: async ({ command, restart }) => {
     // Implement your bash command execution logic here
     // Return the result of the command execution
@@ -457,7 +470,10 @@ Parameters:
 - `command` (string): The bash command to run. Required unless the tool is being restarted.
 - `restart` (boolean, optional): Specifying true will restart this tool.
 
-<Note>Only certain Claude versions are supported.</Note>
+<Note>
+  Two versions are available: `bash_20250124` (recommended) and `bash_20241022`.
+  Only certain Claude versions are supported.
+</Note>
 
 ### Memory Tool
 
@@ -491,8 +507,14 @@ const tools = {
 ```
 
 <Note>
-  Different models support different versions of the tool. For Claude Sonnet 3.5
-  and 3.7 you need to use older tool versions.
+  Different models support different versions of the tool:
+
+- `textEditor_20250728` - For Claude Sonnet 4, Opus 4, and Opus 4.1 (recommended)
+- `textEditor_20250124` - For Claude Sonnet 3.7
+- `textEditor_20241022` - For Claude Sonnet 3.5
+
+Note: `textEditor_20250429` is deprecated. Use `textEditor_20250728` instead.
+
 </Note>
 
 Parameters:
@@ -848,6 +870,12 @@ const result = await generateText({
 });
 ```
 
+<Note>
+  Two versions are available: `codeExecution_20250825` (recommended, supports
+  Python and Bash with enhanced file operations) and `codeExecution_20250522`
+  (supports Bash only).
+</Note>
+
 #### Error Handling
 
 Code execution errors are handled differently depending on whether you're using streaming or non-streaming:
@@ -1034,14 +1062,14 @@ const result = await generateText({
 
 ### PDF support
 
-Anthropic Sonnet `claude-3-5-sonnet-20241022` supports reading PDF files.
+Anthropic Claude models support reading PDF files.
 You can pass PDF files as part of the message content using the `file` type:
 
 Option 1: URL-based PDF document
 
 ```ts
 const result = await generateText({
-  model: anthropic('claude-3-5-sonnet-20241022'),
+  model: anthropic('claude-sonnet-4-5'),
   messages: [
     {
       role: 'user',
@@ -1067,7 +1095,7 @@ Option 2: Base64-encoded PDF document
 
 ```ts
 const result = await generateText({
-  model: anthropic('claude-3-5-sonnet-20241022'),
+  model: anthropic('claude-sonnet-4-5'),
   messages: [
     {
       role: 'user',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/anthropic",
-  "version": "3.0.25",
+  "version": "3.0.27",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",

package/src/anthropic-messages-language-model.ts

@@ -152,6 +152,16 @@ export class AnthropicMessagesLanguageModel implements LanguageModelV3 {
     return this.config.provider;
   }
 
+  /**
+   * Extracts the dynamic provider name from the config.provider string.
+   * e.g., 'my-custom-anthropic.messages' -> 'my-custom-anthropic'
+   */
+  private get providerOptionsName(): string {
+    const provider = this.config.provider;
+    const dotIndex = provider.indexOf('.');
+    return dotIndex === -1 ? provider : provider.substring(0, dotIndex);
+  }
+
   get supportedUrls() {
     return this.config.supportedUrls?.() ?? {};
   }
@@ -218,12 +228,34 @@ export class AnthropicMessagesLanguageModel implements LanguageModelV3 {
       }
     }
 
-    const anthropicOptions = await parseProviderOptions({
+    const providerOptionsName = this.providerOptionsName;
+
+    // Parse provider options from both canonical 'anthropic' key and custom key
+    const canonicalOptions = await parseProviderOptions({
       provider: 'anthropic',
       providerOptions,
       schema: anthropicProviderOptions,
     });
 
+    const customProviderOptions =
+      providerOptionsName !== 'anthropic'
+        ? await parseProviderOptions({
+            provider: providerOptionsName,
+            providerOptions,
+            schema: anthropicProviderOptions,
+          })
+        : null;
+
+    // Track if custom key was explicitly used
+    const usedCustomProviderKey = customProviderOptions != null;
+
+    // Merge options
+    const anthropicOptions = Object.assign(
+      {},
+      canonicalOptions ?? {},
+      customProviderOptions ?? {},
+    );
+
     const {
       maxOutputTokens: maxOutputTokensForModel,
       supportsStructuredOutput: modelSupportsStructuredOutput,
@@ -567,6 +599,8 @@ export class AnthropicMessagesLanguageModel implements LanguageModelV3 {
       betas: new Set([...betas, ...toolsBetas, ...userSuppliedBetas]),
       usesJsonResponseTool: jsonResponseTool != null,
       toolNameMapping,
+      providerOptionsName,
+      usedCustomProviderKey,
     };
   }
 
@@ -659,12 +693,19 @@ export class AnthropicMessagesLanguageModel implements LanguageModelV3 {
   async doGenerate(
     options: LanguageModelV3CallOptions,
   ): Promise<LanguageModelV3GenerateResult> {
-    const { args, warnings, betas, usesJsonResponseTool, toolNameMapping } =
-      await this.getArgs({
-        ...options,
-        stream: false,
-        userSuppliedBetas: await this.getBetasFromHeaders(options.headers),
-      });
+    const {
+      args,
+      warnings,
+      betas,
+      usesJsonResponseTool,
+      toolNameMapping,
+      providerOptionsName,
+      usedCustomProviderKey,
+    } = await this.getArgs({
+      ...options,
+      stream: false,
+      userSuppliedBetas: await this.getBetasFromHeaders(options.headers),
+    });
 
     // Extract citation documents for response processing
     const citationDocuments = [
@@ -1051,8 +1092,8 @@ export class AnthropicMessagesLanguageModel implements LanguageModelV3 {
         body: rawResponse,
       },
       warnings,
-      providerMetadata: {
-        anthropic: {
+      providerMetadata: (() => {
+        const anthropicMetadata = {
           usage: response.usage as JSONObject,
           cacheCreationInputTokens:
             response.usage.cache_creation_input_tokens ?? null,
@@ -1073,8 +1114,18 @@ export class AnthropicMessagesLanguageModel implements LanguageModelV3 {
             mapAnthropicResponseContextManagement(
               response.context_management,
             ) ?? null,
-        } satisfies AnthropicMessageMetadata,
-      },
+        } satisfies AnthropicMessageMetadata;
+
+        const providerMetadata: SharedV3ProviderMetadata = {
+          anthropic: anthropicMetadata,
+        };
+
+        if (usedCustomProviderKey && providerOptionsName !== 'anthropic') {
+          providerMetadata[providerOptionsName] = anthropicMetadata;
+        }
+
+        return providerMetadata;
+      })(),
     };
   }
 
@@ -1087,6 +1138,8 @@ export class AnthropicMessagesLanguageModel implements LanguageModelV3 {
       betas,
       usesJsonResponseTool,
       toolNameMapping,
+      providerOptionsName,
+      usedCustomProviderKey,
     } = await this.getArgs({
       ...options,
       stream: true,
@@ -1932,19 +1985,30 @@ export class AnthropicMessagesLanguageModel implements LanguageModelV3 {
             }
 
             case 'message_stop': {
+              const anthropicMetadata = {
+                usage: (rawUsage as JSONObject) ?? null,
+                cacheCreationInputTokens,
+                stopSequence,
+                container,
+                contextManagement,
+              } satisfies AnthropicMessageMetadata;
+
+              const providerMetadata: SharedV3ProviderMetadata = {
+                anthropic: anthropicMetadata,
+              };
+
+              if (
+                usedCustomProviderKey &&
+                providerOptionsName !== 'anthropic'
+              ) {
+                providerMetadata[providerOptionsName] = anthropicMetadata;
+              }
+
               controller.enqueue({
                 type: 'finish',
                 finishReason,
                 usage: convertAnthropicMessagesUsage(usage),
-                providerMetadata: {
-                  anthropic: {
-                    usage: (rawUsage as JSONObject) ?? null,
-                    cacheCreationInputTokens,
-                    stopSequence,
-                    container,
-                    contextManagement,
-                  } satisfies AnthropicMessageMetadata,
-                },
+                providerMetadata,
               });
               return;
             }

package/src/anthropic-provider.ts

@@ -19,13 +19,13 @@ import { anthropicTools } from './anthropic-tools';
 
 export interface AnthropicProvider extends ProviderV3 {
   /**
-Creates a model for text generation.
-*/
+   * Creates a model for text generation.
+   */
   (modelId: AnthropicMessagesModelId): LanguageModelV3;
 
   /**
-Creates a model for text generation.
-*/
+   * Creates a model for text generation.
+   */
   languageModel(modelId: AnthropicMessagesModelId): LanguageModelV3;
 
   chat(modelId: AnthropicMessagesModelId): LanguageModelV3;
@@ -38,41 +38,41 @@ Creates a model for text generation.
   textEmbeddingModel(modelId: string): never;
 
   /**
-Anthropic-specific computer use tool.
+   * Anthropic-specific computer use tool.
    */
   tools: typeof anthropicTools;
 }
 
 export interface AnthropicProviderSettings {
   /**
-Use a different URL prefix for API calls, e.g. to use proxy servers.
-The default prefix is `https://api.anthropic.com/v1`.
+   * Use a different URL prefix for API calls, e.g. to use proxy servers.
+   * The default prefix is `https://api.anthropic.com/v1`.
    */
   baseURL?: string;
 
   /**
-API key that is being send using the `x-api-key` header.
-It defaults to the `ANTHROPIC_API_KEY` environment variable.
-Only one of `apiKey` or `authToken` is required.
+   * API key that is being send using the `x-api-key` header.
+   * It defaults to the `ANTHROPIC_API_KEY` environment variable.
+   * Only one of `apiKey` or `authToken` is required.
    */
   apiKey?: string;
 
   /**
-Auth token that is being sent using the `Authorization: Bearer` header.
-It defaults to the `ANTHROPIC_AUTH_TOKEN` environment variable.
-Only one of `apiKey` or `authToken` is required.
+   * Auth token that is being sent using the `Authorization: Bearer` header.
+   * It defaults to the `ANTHROPIC_AUTH_TOKEN` environment variable.
+   * Only one of `apiKey` or `authToken` is required.
    */
   authToken?: string;
 
   /**
-Custom headers to include in the requests.
-     */
+   * Custom headers to include in the requests.
+   */
   headers?: Record<string, string>;
 
   /**
-Custom fetch implementation. You can use it as a middleware to intercept requests,
-or to provide a custom fetch implementation for e.g. testing.
-    */
+   * Custom fetch implementation. You can use it as a middleware to intercept requests,
+   * or to provide a custom fetch implementation for e.g. testing.
+   */
   fetch?: FetchFunction;
 
   generateId?: () => string;
@@ -85,7 +85,7 @@ or to provide a custom fetch implementation for e.g. testing.
 }
 
 /**
-Create an Anthropic provider instance.
+ * Create an Anthropic provider instance.
  */
 export function createAnthropic(
   options: AnthropicProviderSettings = {},
@@ -172,6 +172,6 @@ export function createAnthropic(
 }
 
 /**
-Default Anthropic provider instance.
+ * Default Anthropic provider instance.
  */
 export const anthropic = createAnthropic();