@ax-llm/ax-ai-aws-bedrock

中文文档
25.4.9发布于 2026/11/07Apache-2.0TypeScriptESM + CJS构建来源已验证近 30 天下载 5171

AWS Bedrock Provider for AX - supports Claude, GPT OSS, and Titan Embed models

原始使用文档
文档目录8 节
  1. Features
  2. Installation
  3. Authentication
  4. Quick start
  5. Streaming, tools, caching, and thinking
  6. Native image and document input
  7. Models
  8. Verification

AWS Bedrock Provider for Ax

Native Amazon Bedrock integration for Ax using the AWS SDK Converse, ConverseStream, and Titan embedding APIs. It ships separately so @ax-llm/ax remains free of AWS SDK dependencies.

Features

  • Claude, GPT-6, and GPT OSS chat models, plus Titan Embed V2
  • Native streaming with cancellation and pre-output regional failover
  • Claude tool use and tool-result round trips
  • Claude image and document inputs, including inline base64 and s3:// documents
  • Bedrock prompt-cache checkpoints with verified 5-minute and 1-hour TTLs
  • Budget and adaptive Claude thinking, including signed reasoning round trips
  • Model-specific native structured output and service tiers
  • Token, cache-token, request ID, finish-reason, and applied-tier mapping

Capabilities differ by model. Use ai.getFeatures(model) before requiring a feature; unsupported capabilities are deliberately not advertised.

Installation

npm install @ax-llm/ax @ax-llm/ax-ai-aws-bedrock

The Bedrock package installs @aws-sdk/client-bedrock-runtime as its own runtime dependency. Applications do not need to add the SDK separately.

Authentication

The client uses the standard AWS SDK credential chain. Configure credentials through your environment, shared AWS config, workload role, or another SDK- supported credential source.

Quick start

import {
  AxAIBedrock,
  AxAIBedrockModel,
} from '@ax-llm/ax-ai-aws-bedrock';

const ai = new AxAIBedrock({
  region: process.env.AWS_REGION ?? 'us-east-2',
  fallbackRegions: ['us-west-2', 'us-east-1'],
  config: {
    model: AxAIBedrockModel.ClaudeSonnet5,
    maxTokens: 4096,
  },
});

const response = await ai.chat({
  chatPrompt: [{ role: 'user', content: 'What is Amazon Bedrock?' }],
});

if (response instanceof ReadableStream) {
  throw new Error('Expected a non-streaming response.');
}

console.log(response.results[0]?.content);

Streaming, tools, caching, and thinking

const weatherTool = {
  name: 'weather',
  description: 'Read the current weather for a city',
  parameters: {
    type: 'object',
    properties: {
      city: { type: 'string', description: 'City name' },
    },
    required: ['city'],
  },
} as const;

const stream = await ai.chat(
  {
    chatPrompt: [
      { role: 'system', content: 'Use tools for live facts.', cache: true },
      { role: 'user', content: 'What is the weather in Vancouver?' },
    ],
    functions: [weatherTool],
  },
  {
    stream: true,
    contextCache: { ttlSeconds: 3600 },
    thinkingTokenBudget: 'medium',
  }
);

Cache checkpoints can be set on system messages, content blocks, messages, and functions with cache: true. Bedrock accepts at most four checkpoints per request; the provider validates that combined limit before sending.

Claude Sonnet 5 and Opus 5.5 always use adaptive thinking, so thinkingTokenBudget: 'none' is rejected for those models. Claude Opus 5 allows adaptive thinking to be disabled. Opus 5.5 also rejects forced tool choice and output_config.format on Converse, so its structured output uses the json_object mode.

On GPT-6 Sol, Luna, and Astra, thinkingTokenBudget sets the reasoning effort: minimal maps to low, highest to max, and none turns reasoning off. Astra cannot turn reasoning off, so 'none' is rejected before a request is sent. These models do not accept temperature or topP, so the provider leaves them out of the request.

Native image and document input

const response = await ai.chat({
  chatPrompt: [
    {
      role: 'user',
      content: [
        { type: 'text', text: 'Compare these inputs.' },
        { type: 'image', image: imageBase64, mimeType: 'image/png' },
        {
          type: 'file',
          fileUri: 's3://my-bucket/policy.pdf',
          filename: 'policy.pdf',
          mimeType: 'application/pdf',
        },
      ],
    },
  ],
});

Supported document formats are CSV, DOC, DOCX, HTML, Markdown, PDF, TXT, XLS, and XLSX. Image formats are GIF, JPEG, PNG, and WebP.

Models

Current Claude enum members include Sonnet 5, Opus 5.5, Opus 5, Opus 4.8, Sonnet 4.6, Haiku 4.5, Opus 4.5, Sonnet 4, and retained 3.x compatibility models. OpenAI GPT-6 Sol, Luna, and Astra use their us. cross-Region inference profiles and support tools, image input, and native or function structured output on the standard tier. Like GPT OSS 120B and 20B, they are sent to gptRegion (default us-west-2) and then gptFallbackRegions (default us-east-1). Titan Embed V2 remains available.

Verification

From the repository root:

npm test --workspace=@ax-llm/ax-ai-aws-bedrock

版本与发布记录

@ax-llm/ax-ai-aws-bedrock 共发布 222 个版本,首次发布于 2025/10/19;过去 12 个月发布了 217 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
25.4.9latest2026/11/071 天前
25.4.82026/11/034 天前
25.4.72026/10/299 天前
25.4.62026/10/2612 天前
25.4.52026/10/2117 天前
25.4.42026/10/2118 天前

关于 @ax-llm/ax-ai-aws-bedrock 的常见问题

@ax-llm/ax-ai-aws-bedrock 是什么?

AWS Bedrock Provider for AX - supports Claude, GPT OSS, and Titan Embed models

如何安装 @ax-llm/ax-ai-aws-bedrock?

在项目目录运行 npm install @ax-llm/ax-ai-aws-bedrock,或使用 pnpm add / yarn add / bun add。

@ax-llm/ax-ai-aws-bedrock 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@ax-llm/ax-ai-aws-bedrock 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@ax-llm/ax-ai-aws-bedrock 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@ax-llm/ax-ai-aws-bedrock 可以商用吗?

@ax-llm/ax-ai-aws-bedrock 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@ax-llm/ax-ai-aws-bedrock 的下载量有多少?

根据 npm 官方下载统计,@ax-llm/ax-ai-aws-bedrock 在 2026/10/08 – 2026/11/06 这 30 天内被下载 5,171 次,日均约 172 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@ax-llm/ax-ai-aws-bedrock 还在维护吗?

最新版本 25.4.9 发布于 2026/11/07(1 天前);至今共发布 222 个版本,其中过去 12 个月发布了 217 个;首次发布于 2025/10/19。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。