ai/core: anthropic tool call support (#1279)

lgrammel · web-flow · commit 4f4c7f5da6ab · 2024-04-05T13:44:09.000+02:00
diff --git a/.changeset/breezy-kangaroos-fly.md b/.changeset/breezy-kangaroos-fly.md
@@ -0,0 +1,5 @@
+---
+'ai': patch
+---
+
+ai/core: Anthropic tool call support
diff --git a/docs/pages/docs/ai-core/anthropic.mdx b/docs/pages/docs/ai-core/anthropic.mdx
@@ -6,7 +6,7 @@ import { Callout } from 'nextra-theme-docs';
 
 # Anthropic Provider
 
-<Callout>The Anthropic provider does not support tool calling yet.</Callout>
+<Callout>The Anthropic API does not support streaming tool calls yet.</Callout>
 
 The Anthropic provider contains language model support for the [Anthropic Messages API](https://docs.anthropic.com/claude/reference/messages_post).
 It creates language model objects that can be used with the `generateText` and `streamText`AI functions.
diff --git a/examples/ai-core/src/generate-object/anthropic.ts b/examples/ai-core/src/generate-object/anthropic.ts
@@ -0,0 +1,32 @@
+import { experimental_generateObject } from 'ai';
+import { anthropic } from 'ai/anthropic';
+import dotenv from 'dotenv';
+import { z } from 'zod';
+
+dotenv.config();
+
+async function main() {
+  const result = await experimental_generateObject({
+    model: anthropic.messages('claude-3-opus-20240229'),
+    schema: z.object({
+      recipe: z.object({
+        name: z.string(),
+        ingredients: z.array(
+          z.object({
+            name: z.string(),
+            amount: z.string(),
+          }),
+        ),
+        steps: z.array(z.string()),
+      }),
+    }),
+    prompt: 'Generate a lasagna recipe.',
+  });
+
+  console.log(JSON.stringify(result.object, null, 2));
+  console.log();
+  console.log('Token usage:', result.usage);
+  console.log('Finish reason:', result.finishReason);
+}
+
+main().catch(console.error);
diff --git a/examples/ai-core/src/generate-object/mistral-json.ts b/examples/ai-core/src/generate-object/mistral-json.ts
@@ -29,4 +29,4 @@ async function main() {
   console.log(JSON.stringify(result.object, null, 2));
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/generate-object/mistral-tool.ts b/examples/ai-core/src/generate-object/mistral-tool.ts
@@ -29,4 +29,4 @@ async function main() {
   console.log(JSON.stringify(result.object, null, 2));
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/generate-object/mistral.ts b/examples/ai-core/src/generate-object/mistral.ts
@@ -31,4 +31,4 @@ async function main() {
   console.log('Finish reason:', result.finishReason);
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/generate-object/openai-json.ts b/examples/ai-core/src/generate-object/openai-json.ts
@@ -29,4 +29,4 @@ async function main() {
   console.log(JSON.stringify(result.object, null, 2));
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/generate-object/openai-tool.ts b/examples/ai-core/src/generate-object/openai-tool.ts
@@ -30,4 +30,4 @@ async function main() {
   console.log(JSON.stringify(result.object, null, 2));
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/generate-object/openai.ts b/examples/ai-core/src/generate-object/openai.ts
@@ -31,4 +31,4 @@ async function main() {
   console.log('Finish reason:', result.finishReason);
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/generate-text/anthropic-chatbot-with-tools.ts b/examples/ai-core/src/generate-text/anthropic-chatbot-with-tools.ts
@@ -0,0 +1,65 @@
+import { ExperimentalMessage, experimental_generateText } from 'ai';
+import { anthropic } from 'ai/anthropic';
+import dotenv from 'dotenv';
+import * as readline from 'node:readline/promises';
+import { weatherTool } from '../tools/weather-tool';
+
+dotenv.config();
+
+const terminal = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout,
+});
+
+const messages: ExperimentalMessage[] = [];
+
+async function main() {
+  let toolResponseAvailable = false;
+
+  while (true) {
+    if (!toolResponseAvailable) {
+      const userInput = await terminal.question('You: ');
+      messages.push({ role: 'user', content: userInput });
+    }
+
+    const { text, toolCalls, toolResults } = await experimental_generateText({
+      model: anthropic.messages('claude-3-opus-20240229'),
+      tools: { weatherTool },
+      system: `You are a helpful, respectful and honest assistant.`,
+      messages,
+    });
+
+    toolResponseAvailable = false;
+
+    if (text) {
+      process.stdout.write(`\nAssistant: ${text}`);
+    }
+
+    for (const { toolName, args } of toolCalls) {
+      process.stdout.write(
+        `\nTool call: '${toolName}' ${JSON.stringify(args)}`,
+      );
+    }
+
+    for (const { toolName, result } of toolResults) {
+      process.stdout.write(
+        `\nTool response: '${toolName}' ${JSON.stringify(result)}`,
+      );
+    }
+
+    process.stdout.write('\n\n');
+
+    messages.push({
+      role: 'assistant',
+      content: [{ type: 'text', text }, ...(toolCalls ?? [])],
+    });
+
+    if (toolResults.length > 0) {
+      messages.push({ role: 'tool', content: toolResults });
+    }
+
+    toolResponseAvailable = toolCalls.length > 0;
+  }
+}
+
+main().catch(console.error);
diff --git a/examples/ai-core/src/generate-text/anthropic-multimodal.ts b/examples/ai-core/src/generate-text/anthropic-multimodal.ts
@@ -23,4 +23,4 @@ async function main() {
   console.log(result.text);
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/generate-text/anthropic-tool-call.ts b/examples/ai-core/src/generate-text/anthropic-tool-call.ts
@@ -0,0 +1,60 @@
+import { experimental_generateText, tool } from 'ai';
+import { anthropic } from 'ai/anthropic';
+import dotenv from 'dotenv';
+import { z } from 'zod';
+import { weatherTool } from '../tools/weather-tool';
+
+dotenv.config();
+
+async function main() {
+  const result = await experimental_generateText({
+    model: anthropic.messages('claude-3-opus-20240229'),
+    maxTokens: 512,
+    tools: {
+      weather: weatherTool,
+      cityAttractions: tool({
+        parameters: z.object({ city: z.string() }),
+      }),
+    },
+    prompt:
+      'What is the weather in San Francisco and what attractions should I visit?',
+  });
+
+  // typed tool calls:
+  for (const toolCall of result.toolCalls) {
+    switch (toolCall.toolName) {
+      case 'cityAttractions': {
+        toolCall.args.city; // string
+        break;
+      }
+
+      case 'weather': {
+        toolCall.args.location; // string
+        break;
+      }
+    }
+  }
+
+  // typed tool results for tools with execute method:
+  for (const toolResult of result.toolResults) {
+    switch (toolResult.toolName) {
+      // NOT AVAILABLE (NO EXECUTE METHOD)
+      // case 'cityAttractions': {
+      //   toolResult.args.city; // string
+      //   toolResult.result;
+      //   break;
+      // }
+
+      case 'weather': {
+        toolResult.args.location; // string
+        toolResult.result.location; // string
+        toolResult.result.temperature; // number
+        break;
+      }
+    }
+  }
+
+  console.log(JSON.stringify(result, null, 2));
+}
+
+main().catch(console.error);
diff --git a/examples/ai-core/src/generate-text/anthropic.ts b/examples/ai-core/src/generate-text/anthropic.ts
@@ -16,4 +16,4 @@ async function main() {
   console.log('Finish reason:', result.finishReason);
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/generate-text/google-multimodal.ts b/examples/ai-core/src/generate-text/google-multimodal.ts
@@ -23,4 +23,4 @@ async function main() {
   console.log(result.text);
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/generate-text/google-tool-call.ts b/examples/ai-core/src/generate-text/google-tool-call.ts
@@ -57,4 +57,4 @@ async function main() {
   console.log(JSON.stringify(result, null, 2));
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/generate-text/google.ts b/examples/ai-core/src/generate-text/google.ts
@@ -16,4 +16,4 @@ async function main() {
   console.log('Finish reason:', result.finishReason);
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/generate-text/mistral-tool-call.ts b/examples/ai-core/src/generate-text/mistral-tool-call.ts
@@ -59,4 +59,4 @@ async function main() {
   console.log(JSON.stringify(result, null, 2));
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/generate-text/mistral.ts b/examples/ai-core/src/generate-text/mistral.ts
@@ -18,4 +18,4 @@ async function main() {
   console.log('Finish reason:', result.finishReason);
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/generate-text/openai-completion-chat.ts b/examples/ai-core/src/generate-text/openai-completion-chat.ts
@@ -30,4 +30,4 @@ async function main() {
   console.log(result.text);
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/generate-text/openai-completion.ts b/examples/ai-core/src/generate-text/openai-completion.ts
@@ -16,4 +16,4 @@ async function main() {
   console.log(result.text);
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/generate-text/openai-multimodal-url.ts b/examples/ai-core/src/generate-text/openai-multimodal-url.ts
@@ -29,4 +29,4 @@ async function main() {
   console.log(result.text);
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/generate-text/openai-multimodal.ts b/examples/ai-core/src/generate-text/openai-multimodal.ts
@@ -25,4 +25,4 @@ async function main() {
   console.log(result.text);
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/generate-text/openai-tool-call.ts b/examples/ai-core/src/generate-text/openai-tool-call.ts
@@ -59,4 +59,4 @@ async function main() {
   console.log(JSON.stringify(result, null, 2));
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/generate-text/openai.ts b/examples/ai-core/src/generate-text/openai.ts
@@ -18,4 +18,4 @@ async function main() {
   console.log('Finish reason:', result.finishReason);
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/stream-object/mistral-json.ts b/examples/ai-core/src/stream-object/mistral-json.ts
@@ -33,4 +33,4 @@ async function main() {
   }
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/stream-object/mistral-tool.ts b/examples/ai-core/src/stream-object/mistral-tool.ts
@@ -33,4 +33,4 @@ async function main() {
   }
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/stream-object/mistral.ts b/examples/ai-core/src/stream-object/mistral.ts
@@ -32,4 +32,4 @@ async function main() {
   }
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/stream-object/openai-json.ts b/examples/ai-core/src/stream-object/openai-json.ts
@@ -33,4 +33,4 @@ async function main() {
   }
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/stream-object/openai-tool.ts b/examples/ai-core/src/stream-object/openai-tool.ts
@@ -33,4 +33,4 @@ async function main() {
   }
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/stream-object/openai.ts b/examples/ai-core/src/stream-object/openai.ts
@@ -32,4 +32,4 @@ async function main() {
   }
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/stream-text/anthropic-multimodal.ts b/examples/ai-core/src/stream-text/anthropic-multimodal.ts
@@ -25,4 +25,4 @@ async function main() {
   }
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/stream-text/anthropic.ts b/examples/ai-core/src/stream-text/anthropic.ts
@@ -15,4 +15,4 @@ async function main() {
   }
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/stream-text/google-fullstream.ts b/examples/ai-core/src/stream-text/google-fullstream.ts
@@ -77,4 +77,4 @@ async function main() {
   }
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/stream-text/google.ts b/examples/ai-core/src/stream-text/google.ts
@@ -15,4 +15,4 @@ async function main() {
   }
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/stream-text/mistral-fullstream.ts b/examples/ai-core/src/stream-text/mistral-fullstream.ts
@@ -73,4 +73,4 @@ async function main() {
   }
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/stream-text/mistral.ts b/examples/ai-core/src/stream-text/mistral.ts
@@ -20,4 +20,4 @@ async function main() {
   }
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/stream-text/openai-completion-chat.ts b/examples/ai-core/src/stream-text/openai-completion-chat.ts
@@ -32,4 +32,4 @@ async function main() {
   }
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/stream-text/openai-completion.ts b/examples/ai-core/src/stream-text/openai-completion.ts
@@ -19,4 +19,4 @@ async function main() {
   }
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/stream-text/openai-fullstream.ts b/examples/ai-core/src/stream-text/openai-fullstream.ts
@@ -79,4 +79,4 @@ async function main() {
   }
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/stream-text/openai-reader.ts b/examples/ai-core/src/stream-text/openai-reader.ts
@@ -25,4 +25,4 @@ async function main() {
   }
 }
 
-main();
+main().catch(console.error);
diff --git a/examples/ai-core/src/stream-text/openai.ts b/examples/ai-core/src/stream-text/openai.ts
@@ -20,4 +20,4 @@ async function main() {
   }
 }
 
-main();
+main().catch(console.error);
diff --git a/packages/core/anthropic/anthropic-facade.ts b/packages/core/anthropic/anthropic-facade.ts
diff --git a/packages/core/anthropic/anthropic-messages-language-model.test.ts b/packages/core/anthropic/anthropic-messages-language-model.test.ts
diff --git a/packages/core/anthropic/anthropic-messages-language-model.ts b/packages/core/anthropic/anthropic-messages-language-model.ts
diff --git a/packages/core/anthropic/anthropic-messages-prompt.ts b/packages/core/anthropic/anthropic-messages-prompt.ts
diff --git a/packages/core/anthropic/convert-to-anthropic-messages-prompt.ts b/packages/core/anthropic/convert-to-anthropic-messages-prompt.ts
diff --git a/packages/core/anthropic/map-anthropic-stop-reason.ts b/packages/core/anthropic/map-anthropic-stop-reason.ts
