@ai-sdk/amazon-bedrock 5.0.0-beta.7 → 5.0.0-beta.85

package/src/mantle/bedrock-mantle-provider.ts

@@ -0,0 +1,283 @@
+import {
+  OpenAIChatLanguageModel,
+  OpenAIResponsesLanguageModel,
+} from '@ai-sdk/openai/internal';
+import {
+  NoSuchModelError,
+  type LanguageModelV4,
+  type ProviderV4,
+} from '@ai-sdk/provider';
+import {
+  loadOptionalSetting,
+  loadSetting,
+  withoutTrailingSlash,
+  withUserAgentSuffix,
+  type FetchFunction,
+} from '@ai-sdk/provider-utils';
+import {
+  createApiKeyFetchFunction,
+  createSigV4FetchFunction,
+  type AmazonBedrockCredentials,
+} from '../amazon-bedrock-sigv4-fetch';
+import type {
+  BedrockMantleChatModelId,
+  BedrockMantleResponsesModelId,
+} from './bedrock-mantle-options';
+import { VERSION } from '../version';
+
+export interface BedrockMantleProvider extends ProviderV4 {
+  /**
+   * Creates a model for text generation using the Chat Completions API.
+   * Chat Completions has the broadest model support on Mantle.
+   */
+  (modelId: BedrockMantleChatModelId): LanguageModelV4;
+
+  /**
+   * Creates a model for text generation using the Chat Completions API.
+   */
+  languageModel(modelId: BedrockMantleChatModelId): LanguageModelV4;
+
+  /**
+   * Creates a model for text generation using the Chat Completions API.
+   */
+  chat(modelId: BedrockMantleChatModelId): LanguageModelV4;
+
+  /**
+   * Creates a model for text generation using the Responses API.
+   * Not all Mantle models support this API. Notably, gpt-oss-safeguard models
+   * are Chat-only.
+   */
+  responses(modelId: BedrockMantleResponsesModelId): LanguageModelV4;
+
+  /**
+   * @deprecated Mantle does not support embedding models.
+   */
+  textEmbeddingModel(modelId: string): never;
+}
+
+export interface BedrockMantleProviderSettings {
+  /**
+   * The AWS region to use for the Bedrock Mantle endpoint. Defaults to the value of the
+   * `AWS_REGION` environment variable.
+   */
+  region?: string;
+
+  /**
+   * API key for authenticating requests using Bearer token authentication.
+   * When provided, this will be used instead of AWS SigV4 authentication.
+   * Defaults to the value of the `AWS_BEARER_TOKEN_BEDROCK` environment variable.
+   */
+  apiKey?: string;
+
+  /**
+   * The AWS access key ID to use for SigV4 authentication. Defaults to the value of the
+   * `AWS_ACCESS_KEY_ID` environment variable.
+   */
+  accessKeyId?: string;
+
+  /**
+   * The AWS secret access key to use for SigV4 authentication. Defaults to the value of the
+   * `AWS_SECRET_ACCESS_KEY` environment variable.
+   */
+  secretAccessKey?: string;
+
+  /**
+   * The AWS session token to use for SigV4 authentication. Defaults to the value of the
+   * `AWS_SESSION_TOKEN` environment variable.
+   */
+  sessionToken?: string;
+
+  /**
+   * Base URL for the Bedrock Mantle API calls.
+   */
+  baseURL?: string;
+
+  /**
+   * Custom headers to include in the requests.
+   */
+  headers?: Record<string, string | undefined>;
+
+  /**
+   * 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;
+
+  /**
+   * The AWS credential provider to use for SigV4 authentication to get dynamic
+   * credentials similar to the AWS SDK. Setting a provider here will cause its
+   * credential values to be used instead of the `accessKeyId`, `secretAccessKey`,
+   * and `sessionToken` settings.
+   */
+  credentialProvider?: () => PromiseLike<
+    Omit<AmazonBedrockCredentials, 'region'>
+  >;
+}
+
+/**
+ * Create an Amazon Bedrock Mantle provider instance.
+ * This provider uses the OpenAI-compatible Mantle API for models that are
+ * only available through the Mantle endpoint (e.g. openai.gpt-oss-20b).
+ */
+export function createBedrockMantle(
+  options: BedrockMantleProviderSettings = {},
+): BedrockMantleProvider {
+  // Check for API key authentication first
+  const rawApiKey = loadOptionalSetting({
+    settingValue: options.apiKey,
+    environmentVariableName: 'AWS_BEARER_TOKEN_BEDROCK',
+  });
+
+  // Only use API key if it's a non-empty, non-whitespace string
+  const apiKey =
+    rawApiKey && rawApiKey.trim().length > 0 ? rawApiKey.trim() : undefined;
+
+  // Use API key authentication if available, otherwise fall back to SigV4
+  const fetchFunction = apiKey
+    ? createApiKeyFetchFunction(apiKey, options.fetch)
+    : createSigV4FetchFunction(
+        async () => {
+          const region = loadSetting({
+            settingValue: options.region,
+            settingName: 'region',
+            environmentVariableName: 'AWS_REGION',
+            description: 'AWS region',
+          });
+
+          // If a credential provider is provided, use it to get the credentials.
+          if (options.credentialProvider) {
+            try {
+              return {
+                ...(await options.credentialProvider()),
+                region,
+              };
+            } catch (error) {
+              const errorMessage =
+                error instanceof Error ? error.message : String(error);
+              throw new Error(
+                `AWS credential provider failed: ${errorMessage}. ` +
+                  'Please ensure your credential provider returns valid AWS credentials ' +
+                  'with accessKeyId and secretAccessKey properties.',
+              );
+            }
+          }
+
+          try {
+            return {
+              region,
+              accessKeyId: loadSetting({
+                settingValue: options.accessKeyId,
+                settingName: 'accessKeyId',
+                environmentVariableName: 'AWS_ACCESS_KEY_ID',
+                description: 'AWS access key ID',
+              }),
+              secretAccessKey: loadSetting({
+                settingValue: options.secretAccessKey,
+                settingName: 'secretAccessKey',
+                environmentVariableName: 'AWS_SECRET_ACCESS_KEY',
+                description: 'AWS secret access key',
+              }),
+              sessionToken: loadOptionalSetting({
+                settingValue: options.sessionToken,
+                environmentVariableName: 'AWS_SESSION_TOKEN',
+              }),
+            };
+          } catch (error) {
+            const errorMessage =
+              error instanceof Error ? error.message : String(error);
+            if (
+              errorMessage.includes('AWS_ACCESS_KEY_ID') ||
+              errorMessage.includes('accessKeyId')
+            ) {
+              throw new Error(
+                'AWS SigV4 authentication requires AWS credentials. Please provide either:\n' +
+                  '1. Set AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables\n' +
+                  '2. Provide accessKeyId and secretAccessKey in options\n' +
+                  '3. Use a credentialProvider function\n' +
+                  '4. Use API key authentication with AWS_BEARER_TOKEN_BEDROCK or apiKey option\n' +
+                  `Original error: ${errorMessage}`,
+              );
+            }
+            if (
+              errorMessage.includes('AWS_SECRET_ACCESS_KEY') ||
+              errorMessage.includes('secretAccessKey')
+            ) {
+              throw new Error(
+                'AWS SigV4 authentication requires both AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY. ' +
+                  'Please ensure both credentials are provided.\n' +
+                  `Original error: ${errorMessage}`,
+              );
+            }
+            throw error;
+          }
+        },
+        options.fetch,
+        'bedrock-mantle',
+      );
+
+  const getBaseURL = (): string =>
+    withoutTrailingSlash(
+      options.baseURL ??
+        `https://bedrock-mantle.${loadSetting({
+          settingValue: options.region,
+          settingName: 'region',
+          environmentVariableName: 'AWS_REGION',
+          description: 'AWS region',
+        })}.api.aws/v1`,
+    ) ?? 'https://bedrock-mantle.us-east-1.api.aws/v1';
+
+  const getHeaders = (): Record<string, string | undefined> =>
+    withUserAgentSuffix(
+      options.headers ?? {},
+      `ai-sdk/amazon-bedrock/${VERSION}`,
+    );
+
+  const url = ({ path }: { path: string; modelId: string }): string =>
+    `${getBaseURL()}${path}`;
+
+  const createChatModel = (modelId: BedrockMantleChatModelId) =>
+    new OpenAIChatLanguageModel(modelId, {
+      provider: 'bedrock-mantle.chat',
+      url,
+      headers: getHeaders,
+      fetch: fetchFunction,
+    });
+
+  const createResponsesModel = (modelId: BedrockMantleResponsesModelId) =>
+    new OpenAIResponsesLanguageModel(modelId, {
+      provider: 'bedrock-mantle.responses',
+      url,
+      headers: getHeaders,
+      fetch: fetchFunction,
+    });
+
+  const provider = function (modelId: BedrockMantleChatModelId) {
+    if (new.target) {
+      throw new Error(
+        'The Bedrock Mantle model function cannot be called with the new keyword.',
+      );
+    }
+
+    return createChatModel(modelId);
+  };
+
+  provider.specificationVersion = 'v4' as const;
+  provider.languageModel = createChatModel;
+  provider.chat = createChatModel;
+  provider.responses = createResponsesModel;
+
+  provider.embeddingModel = (modelId: string) => {
+    throw new NoSuchModelError({ modelId, modelType: 'embeddingModel' });
+  };
+  provider.textEmbeddingModel = provider.embeddingModel;
+  provider.imageModel = (modelId: string) => {
+    throw new NoSuchModelError({ modelId, modelType: 'imageModel' });
+  };
+
+  return provider as BedrockMantleProvider;
+}
+
+/**
+ * Default Bedrock Mantle provider instance.
+ */
+export const bedrockMantle = createBedrockMantle();

package/src/mantle/index.ts

@@ -0,0 +1,6 @@
+export { bedrockMantle, createBedrockMantle } from './bedrock-mantle-provider';
+export type {
+  BedrockMantleProvider,
+  BedrockMantleProviderSettings,
+} from './bedrock-mantle-provider';
+export type { BedrockMantleModelId } from './bedrock-mantle-options';

package/src/{map-bedrock-finish-reason.ts → map-amazon-bedrock-finish-reason.ts}

@@ -1,8 +1,8 @@
-import { LanguageModelV4FinishReason } from '@ai-sdk/provider';
-import { BedrockStopReason } from './bedrock-api-types';
+import type { LanguageModelV4FinishReason } from '@ai-sdk/provider';
+import type { AmazonBedrockStopReason } from './amazon-bedrock-api-types';
 
-export function mapBedrockFinishReason(
-  finishReason: BedrockStopReason,
+export function mapAmazonBedrockFinishReason(
+  finishReason: AmazonBedrockStopReason,
   isJsonResponseFromTool?: boolean,
 ): LanguageModelV4FinishReason['unified'] {
   switch (finishReason) {

package/src/reranking/{bedrock-reranking-api.ts → amazon-bedrock-reranking-api.ts}

@@ -2,12 +2,12 @@ import { lazySchema, zodSchema } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
 
 // https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Rerank.html
-export type BedrockRerankingInput = {
+export type AmazonBedrockRerankingInput = {
   nextToken?: string;
   queries: [{ type: 'TEXT'; textQuery: { text: string } }];
   rerankingConfiguration: {
     type: 'BEDROCK_RERANKING_MODEL';
-    bedrockRerankingConfiguration: {
+    amazonBedrockRerankingConfiguration: {
       modelConfiguration: {
         modelArn: string;
         additionalModelRequestFields?: Record<string, unknown>;
@@ -29,7 +29,7 @@ export type BedrockRerankingInput = {
   }[];
 };
 
-export const bedrockRerankingResponseSchema = lazySchema(() =>
+export const amazonBedrockRerankingResponseSchema = lazySchema(() =>
   zodSchema(
     z.object({
       results: z.array(

package/src/reranking/{bedrock-reranking-options.ts → amazon-bedrock-reranking-model-options.ts}

@@ -2,7 +2,7 @@ import { lazySchema, zodSchema } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
 
 // https://docs.aws.amazon.com/bedrock/latest/userguide/rerank-supported.html
-export type BedrockRerankingModelId =
+export type AmazonBedrockRerankingModelId =
   | 'amazon.rerank-v1:0'
   | 'cohere.rerank-v3-5:0'
   | (string & {});

package/src/reranking/{bedrock-reranking-model.ts → amazon-bedrock-reranking-model.ts}

@@ -1,25 +1,24 @@
-import { RerankingModelV4 } from '@ai-sdk/provider';
+import type { RerankingModelV4 } from '@ai-sdk/provider';
 import {
-  FetchFunction,
-  Resolvable,
   combineHeaders,
   createJsonErrorResponseHandler,
   createJsonResponseHandler,
   parseProviderOptions,
   postJsonToApi,
   resolve,
+  type FetchFunction,
+  type Resolvable,
 } from '@ai-sdk/provider-utils';
-import { BedrockErrorSchema } from '../bedrock-error';
+import { AmazonBedrockErrorSchema } from '../amazon-bedrock-error';
 import {
-  BedrockRerankingInput,
-  bedrockRerankingResponseSchema,
-} from './bedrock-reranking-api';
+  amazonBedrockRerankingResponseSchema,
+  type AmazonBedrockRerankingInput,
+} from './amazon-bedrock-reranking-api';
 import {
-  BedrockRerankingModelId,
   amazonBedrockRerankingModelOptionsSchema,
-} from './bedrock-reranking-options';
-
-type BedrockRerankingConfig = {
+  type AmazonBedrockRerankingModelId,
+} from './amazon-bedrock-reranking-model-options';
+type AmazonBedrockRerankingConfig = {
   baseUrl: () => string;
   region: string;
   headers: Resolvable<Record<string, string | undefined>>;
@@ -28,13 +27,13 @@ type BedrockRerankingConfig = {
 
 type DoRerankResponse = Awaited<ReturnType<RerankingModelV4['doRerank']>>;
 
-export class BedrockRerankingModel implements RerankingModelV4 {
+export class AmazonBedrockRerankingModel implements RerankingModelV4 {
   readonly specificationVersion = 'v4';
   readonly provider = 'amazon-bedrock';
 
   constructor(
-    readonly modelId: BedrockRerankingModelId,
-    private readonly config: BedrockRerankingConfig,
+    readonly modelId: AmazonBedrockRerankingModelId,
+    private readonly config: AmazonBedrockRerankingConfig,
   ) {}
 
   async doRerank({
@@ -45,11 +44,19 @@ export class BedrockRerankingModel implements RerankingModelV4 {
     abortSignal,
     providerOptions,
   }: Parameters<RerankingModelV4['doRerank']>[0]): Promise<DoRerankResponse> {
-    const bedrockOptions = await parseProviderOptions({
-      provider: 'bedrock',
-      providerOptions,
-      schema: amazonBedrockRerankingModelOptionsSchema,
-    });
+    // Prefer `amazonBedrock`; fall back to legacy `bedrock` for backward
+    // compatibility.
+    const amazonBedrockOptions =
+      (await parseProviderOptions({
+        provider: 'amazonBedrock',
+        providerOptions,
+        schema: amazonBedrockRerankingModelOptionsSchema,
+      })) ??
+      (await parseProviderOptions({
+        provider: 'bedrock',
+        providerOptions,
+        schema: amazonBedrockRerankingModelOptionsSchema,
+      }));
 
     const {
       value: response,
@@ -61,7 +68,7 @@ export class BedrockRerankingModel implements RerankingModelV4 {
         combineHeaders(await resolve(this.config.headers), headers),
       ),
       body: {
-        nextToken: bedrockOptions?.nextToken,
+        nextToken: amazonBedrockOptions?.nextToken,
         queries: [
           {
             textQuery: { text: query },
@@ -69,11 +76,11 @@ export class BedrockRerankingModel implements RerankingModelV4 {
           },
         ],
         rerankingConfiguration: {
-          bedrockRerankingConfiguration: {
+          amazonBedrockRerankingConfiguration: {
             modelConfiguration: {
               modelArn: `arn:aws:bedrock:${this.config.region}::foundation-model/${this.modelId}`,
               additionalModelRequestFields:
-                bedrockOptions?.additionalModelRequestFields,
+                amazonBedrockOptions?.additionalModelRequestFields,
             },
             numberOfResults: topN,
           },
@@ -92,13 +99,13 @@ export class BedrockRerankingModel implements RerankingModelV4 {
                   jsonDocument: value,
                 },
         })),
-      } satisfies BedrockRerankingInput,
+      } satisfies AmazonBedrockRerankingInput,
       failedResponseHandler: createJsonErrorResponseHandler({
-        errorSchema: BedrockErrorSchema,
+        errorSchema: AmazonBedrockErrorSchema,
         errorToMessage: error => `${error.type}: ${error.message}`,
       }),
       successfulResponseHandler: createJsonResponseHandler(
-        bedrockRerankingResponseSchema,
+        amazonBedrockRerankingResponseSchema,
       ),
       fetch: this.config.fetch,
       abortSignal,

package/dist/anthropic/index.d.mts

@@ -1,91 +0,0 @@
-import { ProviderV4, LanguageModelV4 } from '@ai-sdk/provider';
-import { Resolvable, FetchFunction } from '@ai-sdk/provider-utils';
-import { anthropicTools } from '@ai-sdk/anthropic/internal';
-
-interface BedrockCredentials {
-    region: string;
-    accessKeyId: string;
-    secretAccessKey: string;
-    sessionToken?: string;
-}
-
-type BedrockAnthropicModelId = 'anthropic.claude-opus-4-6-v1' | 'anthropic.claude-sonnet-4-6-v1' | 'anthropic.claude-opus-4-5-20251101-v1:0' | 'anthropic.claude-sonnet-4-5-20250929-v1:0' | 'anthropic.claude-opus-4-20250514-v1:0' | 'anthropic.claude-sonnet-4-20250514-v1:0' | 'anthropic.claude-opus-4-1-20250805-v1:0' | 'anthropic.claude-haiku-4-5-20251001-v1:0' | 'anthropic.claude-3-7-sonnet-20250219-v1:0' | 'anthropic.claude-3-5-sonnet-20241022-v2:0' | 'anthropic.claude-3-5-sonnet-20240620-v1:0' | 'anthropic.claude-3-5-haiku-20241022-v1:0' | 'anthropic.claude-3-opus-20240229-v1:0' | 'anthropic.claude-3-sonnet-20240229-v1:0' | 'anthropic.claude-3-haiku-20240307-v1:0' | 'us.anthropic.claude-opus-4-6-v1' | 'us.anthropic.claude-sonnet-4-6-v1' | 'us.anthropic.claude-opus-4-5-20251101-v1:0' | 'us.anthropic.claude-sonnet-4-5-20250929-v1:0' | 'us.anthropic.claude-opus-4-20250514-v1:0' | 'us.anthropic.claude-sonnet-4-20250514-v1:0' | 'us.anthropic.claude-opus-4-1-20250805-v1:0' | 'us.anthropic.claude-haiku-4-5-20251001-v1:0' | 'us.anthropic.claude-3-7-sonnet-20250219-v1:0' | 'us.anthropic.claude-3-5-sonnet-20241022-v2:0' | 'us.anthropic.claude-3-5-sonnet-20240620-v1:0' | 'us.anthropic.claude-3-5-haiku-20241022-v1:0' | 'us.anthropic.claude-3-opus-20240229-v1:0' | 'us.anthropic.claude-3-sonnet-20240229-v1:0' | 'us.anthropic.claude-3-haiku-20240307-v1:0' | (string & {});
-
-interface BedrockAnthropicProvider extends ProviderV4 {
-    /**
-     * Creates a model for text generation.
-     */
-    (modelId: BedrockAnthropicModelId): LanguageModelV4;
-    /**
-     * Creates a model for text generation.
-     */
-    languageModel(modelId: BedrockAnthropicModelId): LanguageModelV4;
-    /**
-     * Anthropic-specific computer use tool.
-     */
-    tools: typeof anthropicTools;
-    /**
-     * @deprecated Use `embeddingModel` instead.
-     */
-    textEmbeddingModel(modelId: string): never;
-}
-interface BedrockAnthropicProviderSettings {
-    /**
-     * The AWS region to use for the Bedrock provider. Defaults to the value of the
-     * `AWS_REGION` environment variable.
-     */
-    region?: string;
-    /**
-     * API key for authenticating requests using Bearer token authentication.
-     * When provided, this will be used instead of AWS SigV4 authentication.
-     * Defaults to the value of the `AWS_BEARER_TOKEN_BEDROCK` environment variable.
-     */
-    apiKey?: string;
-    /**
-     * The AWS access key ID to use for the Bedrock provider. Defaults to the value of the
-     * `AWS_ACCESS_KEY_ID` environment variable.
-     */
-    accessKeyId?: string;
-    /**
-     * The AWS secret access key to use for the Bedrock provider. Defaults to the value of the
-     * `AWS_SECRET_ACCESS_KEY` environment variable.
-     */
-    secretAccessKey?: string;
-    /**
-     * The AWS session token to use for the Bedrock provider. Defaults to the value of the
-     * `AWS_SESSION_TOKEN` environment variable.
-     */
-    sessionToken?: string;
-    /**
-     * Base URL for the Bedrock API calls.
-     */
-    baseURL?: string;
-    /**
-     * Custom headers to include in the requests.
-     */
-    headers?: Resolvable<Record<string, string | undefined>>;
-    /**
-     * 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;
-    /**
-     * The AWS credential provider to use for the Bedrock provider to get dynamic
-     * credentials similar to the AWS SDK. Setting a provider here will cause its
-     * credential values to be used instead of the `accessKeyId`, `secretAccessKey`,
-     * and `sessionToken` settings.
-     */
-    credentialProvider?: () => PromiseLike<Omit<BedrockCredentials, 'region'>>;
-}
-/**
- * Create an Amazon Bedrock Anthropic provider instance.
- * This provider uses the native Anthropic API through Bedrock's InvokeModel endpoint,
- * bypassing the Converse API for better feature compatibility.
- */
-declare function createBedrockAnthropic(options?: BedrockAnthropicProviderSettings): BedrockAnthropicProvider;
-/**
- * Default Bedrock Anthropic provider instance.
- */
-declare const bedrockAnthropic: BedrockAnthropicProvider;
-
-export { type BedrockAnthropicModelId, type BedrockAnthropicProvider, type BedrockAnthropicProviderSettings, bedrockAnthropic, createBedrockAnthropic };