standardize providers to offer .chat() method (#1383)

vercel · Apr 18, 2024 · 587240b · 587240b
1 parent e94fb32
commit 587240b
Show file tree

Hide file tree

Showing 23 changed files with 59 additions and 33 deletions.
diff --git a/.changeset/empty-houses-kick.md b/.changeset/empty-houses-kick.md
@@ -0,0 +1,6 @@
+---
+'@ai-sdk/anthropic': patch
+'@ai-sdk/google': patch
+---
+
+Standardize providers to offer .chat() method
diff --git a/docs/pages/docs/ai-core/anthropic.mdx b/docs/pages/docs/ai-core/anthropic.mdx
@@ -60,19 +60,19 @@ import { anthropic } from '@ai-sdk/anthropic';
 
 ## Messages Models
 
-You can create models that call the [Anthropic Messages API](https://docs.anthropic.com/claude/reference/messages_post) using the `.messages()` factory method.
+You can create models that call the [Anthropic Messages API](https://docs.anthropic.com/claude/reference/messages_post) using the `.chat()` factory method.
 The first argument is the model id, e.g. `claude-3-haiku-20240307`.
 Some models have multi-modal capabilities.
 
 ```ts
-const model = anthropic.messages('claude-3-haiku-20240307');
+const model = anthropic.chat('claude-3-haiku-20240307');
 ```
 
 Anthropic Messages` models support also some model specific settings that are not part of the [standard call settings](/docs/ai-core/settings).
 You can pass them as an options argument:
 
 ```ts
-const model = anthropic.messages('claude-3-haiku-20240307', {
+const model = anthropic.chat('claude-3-haiku-20240307', {
   topK: 0.2,
 });
 ```
diff --git a/docs/pages/docs/ai-core/google.mdx b/docs/pages/docs/ai-core/google.mdx
@@ -58,19 +58,19 @@ import { google } from '@ai-sdk/google';
 
 ## Generative AI Models
 
-You can create models that call the [Google Generative AI API](https://ai.google.dev/api/rest) using the `.generativeAI()` factory method.
+You can create models that call the [Google Generative AI API](https://ai.google.dev/api/rest) using the `.chat()` factory method.
 The first argument is the model id, e.g. `models/gemini-pro`.
 The models support tool calls and some have multi-modal capabilities.
 
 ```ts
-const model = google.generativeAI('models/gemini-pro');
+const model = google.chat('models/gemini-pro');
 ```
 
 Google Generative AI models support also some model specific settings that are not part of the [standard call settings](/docs/ai-core/settings).
 You can pass them as an options argument:
 
 ```ts
-const model = google.generativeAI('models/gemini-pro', {
+const model = google.chat('models/gemini-pro', {
   topK: 0.2,
 });
 ```
diff --git a/examples/ai-core/src/generate-object/anthropic.ts b/examples/ai-core/src/generate-object/anthropic.ts
@@ -7,7 +7,7 @@ dotenv.config();
 
 async function main() {
   const result = await experimental_generateObject({
-    model: anthropic.messages('claude-3-opus-20240229'),
+    model: anthropic.chat('claude-3-opus-20240229'),
     schema: z.object({
       recipe: z.object({
         name: z.string(),

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
@@ -23,7 +23,7 @@ async function main() {
     }
 
     const { text, toolCalls, toolResults } = await experimental_generateText({
-      model: anthropic.messages('claude-3-opus-20240229'),
+      model: anthropic.chat('claude-3-opus-20240229'),
       tools: { weatherTool },
       system: `You are a helpful, respectful and honest assistant.`,
       messages,

diff --git a/examples/ai-core/src/generate-text/anthropic-multimodal.ts b/examples/ai-core/src/generate-text/anthropic-multimodal.ts
@@ -7,7 +7,7 @@ dotenv.config();
 
 async function main() {
   const result = await experimental_generateText({
-    model: anthropic.messages('claude-3-haiku-20240307'),
+    model: anthropic.chat('claude-3-haiku-20240307'),
     maxTokens: 512,
     messages: [
       {

diff --git a/examples/ai-core/src/generate-text/anthropic-tool-call.ts b/examples/ai-core/src/generate-text/anthropic-tool-call.ts
@@ -8,7 +8,7 @@ dotenv.config();
 
 async function main() {
   const result = await experimental_generateText({
-    model: anthropic.messages('claude-3-opus-20240229'),
+    model: anthropic.chat('claude-3-opus-20240229'),
     maxTokens: 512,
     tools: {
       weather: weatherTool,

diff --git a/examples/ai-core/src/generate-text/anthropic.ts b/examples/ai-core/src/generate-text/anthropic.ts
@@ -6,7 +6,7 @@ dotenv.config();
 
 async function main() {
   const result = await experimental_generateText({
-    model: anthropic.messages('claude-3-haiku-20240307'),
+    model: anthropic.chat('claude-3-haiku-20240307'),
     prompt: 'Invent a new holiday and describe its traditions.',
   });
 

diff --git a/examples/ai-core/src/generate-text/google-multimodal.ts b/examples/ai-core/src/generate-text/google-multimodal.ts
@@ -7,7 +7,7 @@ dotenv.config();
 
 async function main() {
   const result = await experimental_generateText({
-    model: google.generativeAI('models/gemini-pro-vision'),
+    model: google.chat('models/gemini-pro-vision'),
     maxTokens: 512,
     messages: [
       {

diff --git a/examples/ai-core/src/generate-text/google-tool-call.ts b/examples/ai-core/src/generate-text/google-tool-call.ts
@@ -8,7 +8,7 @@ dotenv.config();
 
 async function main() {
   const result = await experimental_generateText({
-    model: google.generativeAI('models/gemini-pro'),
+    model: google.chat('models/gemini-pro'),
     maxTokens: 512,
     tools: {
       weather: weatherTool,

diff --git a/examples/ai-core/src/generate-text/google.ts b/examples/ai-core/src/generate-text/google.ts
@@ -6,7 +6,7 @@ dotenv.config();
 
 async function main() {
   const result = await experimental_generateText({
-    model: google.generativeAI('models/gemini-pro'),
+    model: google.chat('models/gemini-pro'),
     prompt: 'Invent a new holiday and describe its traditions.',
   });
 

diff --git a/examples/ai-core/src/stream-text/anthropic-multimodal.ts b/examples/ai-core/src/stream-text/anthropic-multimodal.ts
@@ -7,7 +7,7 @@ dotenv.config();
 
 async function main() {
   const result = await experimental_streamText({
-    model: anthropic.messages('claude-3-haiku-20240307'),
+    model: anthropic.chat('claude-3-haiku-20240307'),
     maxTokens: 512,
     messages: [
       {

diff --git a/examples/ai-core/src/stream-text/anthropic.ts b/examples/ai-core/src/stream-text/anthropic.ts
@@ -6,7 +6,7 @@ dotenv.config();
 
 async function main() {
   const result = await experimental_streamText({
-    model: anthropic.messages('claude-3-haiku-20240307'),
+    model: anthropic.chat('claude-3-haiku-20240307'),
     prompt: 'Invent a new holiday and describe its traditions.',
   });
 

diff --git a/examples/ai-core/src/stream-text/google-chatbot-with-tools.ts b/examples/ai-core/src/stream-text/google-chatbot-with-tools.ts
@@ -28,7 +28,7 @@ async function main() {
     }
 
     const result = await experimental_streamText({
-      model: google.generativeAI('models/gemini-pro'),
+      model: google.chat('models/gemini-pro'),
       tools: { weatherTool },
       system: `You are a helpful, respectful and honest assistant.`,
       messages,

diff --git a/examples/ai-core/src/stream-text/google-chatbot.ts b/examples/ai-core/src/stream-text/google-chatbot.ts
@@ -19,7 +19,7 @@ async function main() {
     messages.push({ role: 'user', content: userInput });
 
     const result = await experimental_streamText({
-      model: google.generativeAI('models/gemini-pro'),
+      model: google.chat('models/gemini-pro'),
       system: `You are a helpful, respectful and honest assistant.`,
       messages,
     });

diff --git a/examples/ai-core/src/stream-text/google-fullstream.ts b/examples/ai-core/src/stream-text/google-fullstream.ts
@@ -8,7 +8,7 @@ dotenv.config();
 
 async function main() {
   const result = await experimental_streamText({
-    model: google.generativeAI('models/gemini-pro'),
+    model: google.chat('models/gemini-pro'),
     tools: {
       weather: weatherTool,
       cityAttractions: {

diff --git a/examples/ai-core/src/stream-text/google.ts b/examples/ai-core/src/stream-text/google.ts
@@ -6,7 +6,7 @@ dotenv.config();
 
 async function main() {
   const result = await experimental_streamText({
-    model: google.generativeAI('models/gemini-pro'),
+    model: google.chat('models/gemini-pro'),
     prompt: 'Invent a new holiday and describe its traditions.',
   });
 

diff --git a/packages/anthropic/README.md b/packages/anthropic/README.md
@@ -34,19 +34,19 @@ import { anthropic } from '@ai-sdk/anthropic';
 
 ## Messages Models
 
-You can create models that call the [Anthropic Messages API](https://docs.anthropic.com/claude/reference/messages_post) using the `.messages()` factory method.
+You can create models that call the [Anthropic Messages API](https://docs.anthropic.com/claude/reference/messages_post) using the `.chat()` factory method.
 The first argument is the model id, e.g. `claude-3-haiku-20240307`.
 Some models have multi-modal capabilities.
 
 ```ts
-const model = anthropic.messages('claude-3-haiku-20240307');
+const model = anthropic.chat('claude-3-haiku-20240307');
 ```
 
 Anthropic Messages` models support also some model specific settings that are not part of the [standard call settings](/docs/ai-core/settings).
 You can pass them as an options argument:
 
 ```ts
-const model = anthropic.messages('claude-3-haiku-20240307', {
+const model = anthropic.chat('claude-3-haiku-20240307', {
   topK: 0.2,
 });
 ```
diff --git a/packages/anthropic/src/anthropic-facade.ts b/packages/anthropic/src/anthropic-facade.ts
@@ -60,9 +60,19 @@ export class Anthropic {
     };
   }
 
+  /**
+   * @deprecated Use `chat()` instead.
+   */
   messages(
     modelId: AnthropicMessagesModelId,
     settings: AnthropicMessagesSettings = {},
+  ) {
+    return this.chat(modelId, settings);
+  }
+
+  chat(
+    modelId: AnthropicMessagesModelId,
+    settings: AnthropicMessagesSettings = {},
   ) {
     return new AnthropicMessagesLanguageModel(modelId, settings, {
       provider: 'anthropic.messages',

diff --git a/packages/anthropic/src/anthropic-messages-language-model.test.ts b/packages/anthropic/src/anthropic-messages-language-model.test.ts
@@ -15,7 +15,7 @@ const anthropic = new Anthropic({
   apiKey: 'test-api-key',
 });
 
-const model = anthropic.messages('claude-3-haiku-20240307');
+const model = anthropic.chat('claude-3-haiku-20240307');
 
 describe('doGenerate', () => {
   const server = new JsonTestServer('https://api.anthropic.com/v1/messages');
@@ -52,7 +52,7 @@ describe('doGenerate', () => {
   it('should extract text response', async () => {
     prepareJsonResponse({ content: [{ type: 'text', text: 'Hello, World!' }] });
 
-    const { text } = await anthropic.messages('gpt-3.5-turbo').doGenerate({
+    const { text } = await anthropic.chat('gpt-3.5-turbo').doGenerate({
       inputFormat: 'prompt',
       mode: { type: 'regular' },
       prompt: TEST_PROMPT,
@@ -204,7 +204,7 @@ describe('doGenerate', () => {
       apiKey: 'test-api-key',
     });
 
-    await anthropic.messages('claude-3-haiku-20240307').doGenerate({
+    await anthropic.chat('claude-3-haiku-20240307').doGenerate({
       inputFormat: 'prompt',
       mode: { type: 'regular' },
       prompt: TEST_PROMPT,
@@ -283,7 +283,7 @@ describe('doStream', () => {
       apiKey: 'test-api-key',
     });
 
-    await anthropic.messages('claude-3-haiku-2024').doStream({
+    await anthropic.chat('claude-3-haiku-2024').doStream({
       inputFormat: 'prompt',
       mode: { type: 'regular' },
       prompt: TEST_PROMPT,

diff --git a/packages/google/README.md b/packages/google/README.md
@@ -30,19 +30,19 @@ import { google } from '@ai-sdk/google';
 
 ## Generative AI Models
 
-You can create models that call the [Google Generative AI API](https://ai.google.dev/api/rest) using the `.generativeAI()` factory method.
+You can create models that call the [Google Generative AI API](https://ai.google.dev/api/rest) using the `.chat()` factory method.
 The first argument is the model id, e.g. `models/gemini-pro`.
 The models support tool calls and some have multi-modal capabilities.
 
 ```ts
-const model = google.generativeAI('models/gemini-pro');
+const model = google.chat('models/gemini-pro');
 ```
 
 Google Generative AI models support also some model specific settings that are not part of the [standard call settings](/docs/ai-core/settings).
 You can pass them as an options argument:
 
 ```ts
-const model = google.generativeAI('models/gemini-pro', {
+const model = google.chat('models/gemini-pro', {
   topK: 0.2,
 });
 ```
diff --git a/packages/google/src/google-facade.ts b/packages/google/src/google-facade.ts
@@ -65,9 +65,19 @@ export class Google {
     };
   }
 
+  /**
+   * @deprecated Use `chat()` instead.
+   */
   generativeAI(
     modelId: GoogleGenerativeAIModelId,
     settings: GoogleGenerativeAISettings = {},
+  ) {
+    return this.chat(modelId, settings);
+  }
+
+  chat(
+    modelId: GoogleGenerativeAIModelId,
+    settings: GoogleGenerativeAISettings = {},
   ) {
     return new GoogleGenerativeAILanguageModel(modelId, settings, {
       provider: 'google.generative-ai',

diff --git a/packages/google/src/google-generative-ai-language-model.test.ts b/packages/google/src/google-generative-ai-language-model.test.ts
@@ -33,7 +33,7 @@ const google = new Google({
   apiKey: 'test-api-key',
   generateId: () => 'test-id',
 });
-const model = google.generativeAI('models/gemini-pro');
+const model = google.chat('models/gemini-pro');
 
 describe('doGenerate', () => {
   const server = new JsonTestServer(
@@ -151,7 +151,7 @@ describe('doGenerate', () => {
     prepareJsonResponse({ content: '' });
 
     const google = new Google({ apiKey: 'test-api-key' });
-    const model = google.generativeAI('models/gemini-pro');
+    const model = google.chat('models/gemini-pro');
 
     await model.doGenerate({
       inputFormat: 'prompt',
@@ -230,7 +230,7 @@ describe('doStream', () => {
 
     const google = new Google({ apiKey: 'test-api-key' });
 
-    await google.generativeAI('models/gemini-pro').doStream({
+    await google.chat('models/gemini-pro').doStream({
       inputFormat: 'prompt',
       mode: { type: 'regular' },
       prompt: TEST_PROMPT,