feat (provider/amazon-bedrock): remove dependence on AWS SDK Bedrock library

.changeset/wicked-yaks-reply.md

@@ -0,0 +1,5 @@
+---
+'@ai-sdk/amazon-bedrock': major
+---
+
+feat (provider/amazon-bedrock): remove dependence on AWS SDK Bedrock client library

content/providers/01-ai-sdk-providers/08-amazon-bedrock.mdx

@@ -90,26 +90,15 @@ const bedrock = createAmazonBedrock({
   secretAccessKey: 'xxxxxxxxx',
   sessionToken: 'xxxxxxxxx',
 });
-
-// or with bedrockOptions
-const bedrock = createAmazonBedrock({
-  bedrockOptions: {
-    region: 'us-east-1',
-    credentials: {
-      // ...
-    },
-  },
-});
 ```
 
 <Note>
-  The top level credentials settings below fall back to environment variable
-  defaults. These may be set by your serverless environment without your
-  awareness, which can lead to merged/conflicting credential values and provider
-  errors around failed authentication. If you're experiencing issues try (1)
-  using the `bedrockOptions` object as it will take precedence over the other
-  settings and does not inherit environment variable values, or (2) explicitly
-  specifying all settings (even if `undefined`) to avoid any defaults.
+  The credentials settings fall back to environment variable defaults described
+  below. These may be set by your serverless environment without your awareness,
+  which can lead to merged/conflicting credential values and provider errors
+  around failed authentication. If you're experiencing issues be sure you are
+  explicitly specifying all settings (even if `undefined`) to avoid any
+  defaults.
 </Note>
 
 You can use the following optional settings to customize the Amazon Bedrock provider instance:
@@ -134,19 +123,6 @@ You can use the following optional settings to customize the Amazon Bedrock prov
   Optional. The AWS session token that you want to use for the API calls.
   It uses the `AWS_SESSION_TOKEN` environment variable by default.
 
-- **bedrockOptions** _object_
-
-  Optional. The configuration options used by the [Amazon Bedrock Library](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-runtime/)
-  (`BedrockRuntimeClientConfig`), including:
-
-  - **region** _string_
-    The AWS region that you want to use for the API calls.
-
-  - **credentials** _object_
-    The AWS credentials that you want to use for the API calls.
-
-  When `bedrockOptions` are provided, the `region`, `accessKeyId`, and `secretAccessKey` settings are ignored.
-
 ## Language Models
 
 You can create models that call the Bedrock API using the provider instance.
@@ -316,3 +292,76 @@ The following optional settings are available for Bedrock Titan embedding models
 | ------------------------------ | ------------------ | ------------------- |
 | `amazon.titan-embed-text-v1`   | 1536               | <Cross size={18} /> |
 | `amazon.titan-embed-text-v2:0` | 1024               | <Check size={18} /> |
+
+## Response Headers
+
+The Amazon Bedrock provider will return the response headers associated with
+network requests made of the Bedrock servers.
+
+```ts
+import { bedrock } from '@ai-sdk/amazon-bedrock';
+import { generateText } from 'ai';
+
+const { text } = await generateText({
+  model: bedrock('meta.llama3-70b-instruct-v1:0'),
+  prompt: 'Write a vegetarian lasagna recipe for 4 people.',
+});
+
+console.log(result.response.headers);
+```
+
+Below is sample output where you can see the `x-amzn-requestid` header. This can
+be useful for correlating Bedrock API calls with requests made by the AI SDK:
+
+```js highlight="6"
+{
+  connection: 'keep-alive',
+  'content-length': '2399',
+  'content-type': 'application/json',
+  date: 'Fri, 07 Feb 2025 04:28:30 GMT',
+  'x-amzn-requestid': 'c9f3ace4-dd5d-49e5-9807-39aedfa47c8e'
+}
+```
+
+This information is also available with `streamText`:
+
+```ts
+import { bedrock } from '@ai-sdk/amazon-bedrock';
+import { streamText } from 'ai';
+
+const result = streamText({
+  model: bedrock('meta.llama3-70b-instruct-v1:0'),
+  prompt: 'Write a vegetarian lasagna recipe for 4 people.',
+});
+for await (const textPart of result.textStream) {
+  process.stdout.write(textPart);
+}
+console.log('Response headers:', (await result.response).headers);
+```
+
+With sample output as:
+
+```js highlight="6"
+{
+  connection: 'keep-alive',
+  'content-type': 'application/vnd.amazon.eventstream',
+  date: 'Fri, 07 Feb 2025 04:33:37 GMT',
+  'transfer-encoding': 'chunked',
+  'x-amzn-requestid': 'a976e3fc-0e45-4241-9954-b9bdd80ab407'
+}
+```
+
+## Migrating from `@ai-sdk/amazon-bedrock` pre-v2.x
+
+The Amazon Bedrock provider was rewritten in version 2.x to remove the
+dependency on the `@aws-sdk/client-bedrock-runtime` package.
+
+The `bedrockOptions` provider setting previously available has been removed. If
+you were using the `bedrockOptions` object, you should now use the `region`,
+`accessKeyId`, `secretAccessKey`, and `sessionToken` settings directly instead.
+
+Note that you may need to set all of these explicitly, e.g. even if you're not
+using `sessionToken`, set it to `undefined`. If you're running in a serverless
+environment, there may be default environment variables set by your containing
+environment that the Amazon Bedrock provider will then pick up and could
+conflict with the ones you're intending to use.

examples/ai-core/.env.example

@@ -1,5 +1,6 @@
 ANTHROPIC_API_KEY=""
 AWS_ACCESS_KEY_ID=""
+AWS_ACCOUNT_ID=""
 AWS_SECRET_ACCESS_KEY=""
 AWS_REGION=""
 AZURE_API_KEY=""

examples/ai-core/src/generate-object/amazon-bedrock.ts

@@ -5,7 +5,9 @@ import { z } from 'zod';
 
 async function main() {
   const result = await generateObject({
-    model: bedrock('anthropic.claude-3-5-sonnet-20240620-v1:0'),
+    model: bedrock(
+      `arn:aws:bedrock:${process.env.AWS_REGION}:${process.env.AWS_ACCOUNT_ID}:inference-profile/us.anthropic.claude-3-5-sonnet-20240620-v1:0`,
+    ),
     schema: z.object({
       recipe: z.object({
         name: z.string(),

examples/ai-core/src/generate-text/amazon-bedrock-chatbot.ts

@@ -21,7 +21,9 @@ async function main() {
     }
 
     const { text, toolCalls, toolResults, response } = await generateText({
-      model: bedrock('anthropic.claude-3-haiku-20240307-v1:0'),
+      model: bedrock(
+        `arn:aws:bedrock:${process.env.AWS_REGION}:${process.env.AWS_ACCOUNT_ID}:inference-profile/us.anthropic.claude-3-5-sonnet-20240620-v1:0`,
+      ),
       tools: { weatherTool },
       system: `You are a helpful, respectful and honest assistant. If the weather is requested use the `,
       messages,

examples/ai-core/src/generate-text/amazon-bedrock-guardrails.ts

@@ -4,7 +4,9 @@ import 'dotenv/config';
 
 async function main() {
   const result = await generateText({
-    model: bedrock('anthropic.claude-3-haiku-20240307-v1:0'),
+    model: bedrock(
+      `arn:aws:bedrock:${process.env.AWS_REGION}:${process.env.AWS_ACCOUNT_ID}:inference-profile/us.anthropic.claude-3-5-sonnet-20240620-v1:0`,
+    ),
     prompt:
       'Invent a new fake holiday and describe its traditions. ' +
       'You are a comedian and should insult the audience as much as possible.',

examples/ai-core/src/generate-text/amazon-bedrock-image-url.ts

@@ -4,7 +4,9 @@ import 'dotenv/config';
 
 async function main() {
   const result = await generateText({
-    model: bedrock('anthropic.claude-3-haiku-20240307-v1:0'),
+    model: bedrock(
+      `arn:aws:bedrock:${process.env.AWS_REGION}:${process.env.AWS_ACCOUNT_ID}:inference-profile/us.anthropic.claude-3-5-sonnet-20240620-v1:0`,
+    ),
     maxTokens: 512,
     messages: [
       {

examples/ai-core/src/generate-text/amazon-bedrock-image.ts

@@ -5,7 +5,9 @@ import fs from 'node:fs';
 
 async function main() {
   const result = await generateText({
-    model: bedrock('anthropic.claude-3-haiku-20240307-v1:0'),
+    model: bedrock(
+      `arn:aws:bedrock:${process.env.AWS_REGION}:${process.env.AWS_ACCOUNT_ID}:inference-profile/us.anthropic.claude-3-5-sonnet-20240620-v1:0`,
+    ),
     maxTokens: 512,
     messages: [
       {

examples/ai-core/src/generate-text/amazon-bedrock-prefilled-assistant-message.ts

@@ -4,7 +4,9 @@ import 'dotenv/config';
 
 async function main() {
   const result = await generateText({
-    model: bedrock('anthropic.claude-3-haiku-20240307-v1:0'),
+    model: bedrock(
+      `arn:aws:bedrock:${process.env.AWS_REGION}:${process.env.AWS_ACCOUNT_ID}:inference-profile/us.anthropic.claude-3-5-sonnet-20240620-v1:0`,
+    ),
     messages: [
       {
         role: 'user',

examples/ai-core/src/generate-text/amazon-bedrock-tool-call.ts

@@ -6,7 +6,9 @@ import { bedrock } from '@ai-sdk/amazon-bedrock';
 
 async function main() {
   const result = await generateText({
-    model: bedrock('anthropic.claude-3-5-sonnet-20240620-v1:0'),
+    model: bedrock(
+      `arn:aws:bedrock:${process.env.AWS_REGION}:${process.env.AWS_ACCOUNT_ID}:inference-profile/us.anthropic.claude-3-5-sonnet-20240620-v1:0`,
+    ),
     tools: {
       weather: weatherTool,
       cityAttractions: tool({

examples/ai-core/src/generate-text/amazon-bedrock-tool-choice.ts

@@ -6,7 +6,9 @@ import { bedrock } from '@ai-sdk/amazon-bedrock';
 
 async function main() {
   const result = await generateText({
-    model: bedrock('anthropic.claude-3-haiku-20240307-v1:0'),
+    model: bedrock(
+      `arn:aws:bedrock:${process.env.AWS_REGION}:${process.env.AWS_ACCOUNT_ID}:inference-profile/us.anthropic.claude-3-5-sonnet-20240620-v1:0`,
+    ),
     maxTokens: 512,
     tools: {
       weather: weatherTool,

examples/ai-core/src/generate-text/amazon-bedrock.ts

@@ -4,14 +4,17 @@ import 'dotenv/config';
 
 async function main() {
   const result = await generateText({
-    model: bedrock('anthropic.claude-3-haiku-20240307-v1:0'),
-    prompt: 'Invent a new holiday and describe its traditions.',
+    model: bedrock(
+      `arn:aws:bedrock:${process.env.AWS_REGION}:${process.env.AWS_ACCOUNT_ID}:inference-profile/us.anthropic.claude-3-5-sonnet-20240620-v1:0`,
+    ),
+    prompt: 'Give me an overview of the New Zealand Fiordland National Park.',
   });
 
   console.log(result.text);
   console.log();
   console.log('Token usage:', result.usage);
   console.log('Finish reason:', result.finishReason);
+  console.log('Response headers:', result.response.headers);
 }
 
 main().catch(console.error);

examples/ai-core/src/stream-object/amazon-bedrock.ts

@@ -5,7 +5,9 @@ import { z } from 'zod';
 
 async function main() {
   const result = streamObject({
-    model: bedrock('anthropic.claude-3-5-sonnet-20240620-v1:0'),
+    model: bedrock(
+      `arn:aws:bedrock:${process.env.AWS_REGION}:${process.env.AWS_ACCOUNT_ID}:inference-profile/us.anthropic.claude-3-5-sonnet-20240620-v1:0`,
+    ),
     schema: z.object({
       characters: z.array(
         z.object({

examples/ai-core/src/stream-text/amazon-bedrock-chatbot.ts

@@ -18,7 +18,9 @@ async function main() {
     messages.push({ role: 'user', content: userInput });
 
     const result = streamText({
-      model: bedrock('anthropic.claude-3-haiku-20240307-v1:0'),
+      model: bedrock(
+        `arn:aws:bedrock:${process.env.AWS_REGION}:${process.env.AWS_ACCOUNT_ID}:inference-profile/us.anthropic.claude-3-5-sonnet-20240620-v1:0`,
+      ),
       tools: {
         weather: tool({
           description: 'Get the weather in a location',

examples/ai-core/src/stream-text/amazon-bedrock-fullstream.ts

@@ -6,7 +6,9 @@ import { weatherTool } from '../tools/weather-tool';
 
 async function main() {
   const result = streamText({
-    model: bedrock('anthropic.claude-3-haiku-20240307-v1:0'),
+    model: bedrock(
+      `arn:aws:bedrock:${process.env.AWS_REGION}:${process.env.AWS_ACCOUNT_ID}:inference-profile/us.anthropic.claude-3-5-sonnet-20240620-v1:0`,
+    ),
     tools: {
       weather: weatherTool,
       cityAttractions: {

examples/ai-core/src/stream-text/amazon-bedrock-image.ts

@@ -5,7 +5,9 @@ import fs from 'node:fs';
 
 async function main() {
   const result = streamText({
-    model: bedrock('anthropic.claude-3-haiku-20240307-v1:0'),
+    model: bedrock(
+      `arn:aws:bedrock:${process.env.AWS_REGION}:${process.env.AWS_ACCOUNT_ID}:inference-profile/us.anthropic.claude-3-5-sonnet-20240620-v1:0`,
+    ),
     maxTokens: 512,
     messages: [
       {

examples/ai-core/src/stream-text/amazon-bedrock-multi-step-continue.ts

@@ -4,7 +4,9 @@ import 'dotenv/config';
 
 async function main() {
   const result = streamText({
-    model: bedrock('anthropic.claude-3-haiku-20240307-v1:0'),
+    model: bedrock(
+      `arn:aws:bedrock:${process.env.AWS_REGION}:${process.env.AWS_ACCOUNT_ID}:inference-profile/us.anthropic.claude-3-5-sonnet-20240620-v1:0`,
+    ),
     maxTokens: 512, // artificial limit for demo purposes
     maxSteps: 5,
     experimental_continueSteps: true,

examples/ai-core/src/stream-text/amazon-bedrock-pdf.ts

@@ -5,7 +5,9 @@ import fs from 'node:fs';
 
 async function main() {
   const result = streamText({
-    model: bedrock('anthropic.claude-3-haiku-20240307-v1:0'),
+    model: bedrock(
+      `arn:aws:bedrock:${process.env.AWS_REGION}:${process.env.AWS_ACCOUNT_ID}:inference-profile/us.anthropic.claude-3-5-sonnet-20240620-v1:0`,
+    ),
     messages: [
       {
         role: 'user',

examples/ai-core/src/stream-text/amazon-bedrock.ts

@@ -4,8 +4,10 @@ import 'dotenv/config';
 
 async function main() {
   const result = streamText({
-    model: bedrock('anthropic.claude-3-haiku-20240307-v1:0'),
-    prompt: 'Invent a new holiday and describe its traditions.',
+    model: bedrock(
+      `arn:aws:bedrock:${process.env.AWS_REGION}:${process.env.AWS_ACCOUNT_ID}:inference-profile/us.anthropic.claude-3-5-sonnet-20240620-v1:0`,
+    ),
+    prompt: 'Give me an overview of the New Zealand Fiordland National Park.',
   });
 
   for await (const textPart of result.textStream) {
@@ -15,6 +17,7 @@ async function main() {
   console.log();
   console.log('Token usage:', await result.usage);
   console.log('Finish reason:', await result.finishReason);
+  console.log('Response headers:', (await result.response).headers);
 }
 
 main().catch(console.error);

packages/amazon-bedrock/package.json

@@ -32,13 +32,13 @@
   "dependencies": {
     "@ai-sdk/provider": "1.0.7",
     "@ai-sdk/provider-utils": "2.1.6",
-    "@aws-sdk/client-bedrock-runtime": "^3.663.0"
+    "@smithy/eventstream-codec": "^4.0.1",
+    "@smithy/util-utf8": "^4.0.0",
+    "aws4fetch": "^1.0.20"
   },
   "devDependencies": {
-    "@smithy/types": "^3.5.0",
     "@types/node": "^18.19.54",
     "@vercel/ai-tsconfig": "workspace:*",
-    "aws-sdk-client-mock": "^4.0.2",
     "tsup": "^8.3.0",
     "typescript": "5.6.3",
     "zod": "3.23.8"