# @ax-llm/ax 中文文档

规范地址：https://npmcn.com/package/%40ax-llm/ax/

版本：25\.4\.9
npm 元数据更新时间：2026-11-06T20:42:30.566Z
中文译文更新时间：2026-11-07T10:58:35.548Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40ax-llm/ax
原文对照：https://npmcn.com/package/%40ax-llm/ax/?lang=original
项目主页：https://github.com/ax-llm/ax#readme
源码仓库：https://github.com/ax-llm/ax

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：22.4 MB，34 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：zod ^3\.24\.0 \|\| ^4\.0\.0
- 首次发布：2024-06-15T23:26:07.114Z
- 最新版本发布：2026-11-06T20:42:30.203Z
- 近 30 天下载量：213589（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：457（近 12 个月 217 个）

## 中文简介

与 LLMS 合作的最佳库

## 安装

```sh
npm install @ax-llm/ax
```

也可以使用：`pnpm add @ax-llm/ax`、`yarn add @ax-llm/ax`、`bun add @ax-llm/ax`

## README

# Ax: 在类型脚本中构建可靠的AI Apps

**别再用急件摔跤了 开始运输AI功能.**

Ax 带来了 DSPy 对 TypeScript 的革命性方法 – 描述一下您想要的 想要,而让框架处理其余。 生产准备、类型安全、 与所有主要法学硕士合作.

[![NPM Package](https://img.shields.io/npm/v/@ax-llm/ax?style=for-the-badge&color=green)](https://www.npmjs.com/package/@ax-llm/ax) [![Twitter](https://img.shields.io/twitter/follow/dosco?style=for-the-badge&color=red)](https://twitter.com/dosco) [![Discord Chat](https://img.shields.io/discord/1078454354849304667?style=for-the-badge&color=green)](https://discord.gg/DSHg3dU7dW)

## 在30秒内转变你的AI开发

```typescript
import { ai, ax } from "@ax-llm/ax";

// 1. Pick any LLM
const llm = ai({ name: "openai", apiKey: process.env.OPENAI_APIKEY! });

// 2. Say what you want
const classifier = ax(
  'review:string -> sentiment:class "positive, negative, neutral"',
);

// 3. Get type-safe results
const result = await classifier.forward(llm, {
  review: "This product is amazing!",
});
console.log(result.sentiment); // "positive" ✨
```

**就是这样.** 没有快速工程。 没有试验和错误。 它和GPT-4合作过, 克劳德 双子座 或任何LLM.

## 裁决证据和重排

通过正常的Ax签名和AxGen使用Jev或OpenAI决定. 添加 `(evidence)` 或流畅 `.withEvidence()` 以布尔/类字段,并声明 命令的数值 `score`本地概率、选定值、, 连续得分,可选信心保留在结果中; 轴附加 供应商/模式来源。 基因模型使用相同的签名与 标出估计数 `elicited`没有本地人的信任 共享结果形状 并不意味着对各种模型的可比较信心进行校正.

```typescript
const judge = ax(
  'query:string, document:string -> relevant:boolean(evidence, threshold 0.7), relevance:score "Irrelevant, Related, Partial answer, Direct answer"(evidence)',
);
const decisions = ai({ name: 'openai-decisions', apiKey: process.env.OPENAI_APIKEY! });
const result = await judge.forward(decisions, {
  query: 'How do I request a refund?',
  document: 'Request a refund through your account billing page.',
});
console.log(result.relevance.value, result.relevant.probability);
```

重新排序时,请将候选身份识别码保存在应用程序代码中,并按 `relevance.value`。见 [签字和裁决证据](https://axllm.dev/typescript/concepts/signatures/) 对于阈值,结果形状和拒绝处理.

## 为什么成千上万的开发者选择 Ax

### 🎯 **定义一次, 随地运行**

写你的逻辑一次。 在 OpenAI、Anthropic、Google 或 15+ 之间切换 一行提供商。 不需要重写 .

### ⚡ **10号舰更快**

停止微调提示。 界定投入-产出。 框架产生最佳效果 自动提示.

### ⚡ **供应商-本地速度**

Ax 与直接提供者通话时保持相同的空档级,同时添加打字 产出、验证、重试、追踪和工具。 流是默认的 Ax 能够解析到达时的字段, 早期在流媒体断言中失败, 取消错误 输出,并在完成时开始更正,而不浪费符号 已经无效.

对照自己的供应商制定当前代码基准:

```bash
AX_STREAM_BENCH_PROVIDER=anthropic AX_STREAM_BENCH_MODEL=claude-sonnet-4-5-20250929 AX_STREAM_BENCH_RUNS=2 AX_STREAM_BENCH_WARMUP_RUNS=0 npm run tsx src/examples/streaming-latency.ts
AX_STREAM_BENCH_PROVIDER=google-gemini AX_STREAM_BENCH_MODEL=gemini-3.5-flash AX_STREAM_BENCH_RUNS=2 AX_STREAM_BENCH_WARMUP_RUNS=0 npm run tsx src/examples/streaming-latency.ts
```

### 🛡️ **生产 - 从第一天开始准备**

建成通流,验证,处理出错,可观察. 初创企业使用 在生产中处理数以百万的要求.

### 🚀 **越久越聪明**

以实例训练您的程序 。 观察精度自动提高。 没有ML 需要专门知识.

## 真实 Apps, 真实简单

### 从客户邮件提取结构化数据

```typescript
const extractor = ax(`
  customerEmail:string, currentDate:datetime -> 
  priority:class "high, normal, low",
  sentiment:class "positive, negative, neutral",
  ticketNumber?:number,
  nextSteps:string[],
  estimatedResponseTime:string
`);

const result = await extractor.forward(ai, {
  customerEmail: "Order #12345 hasn't arrived. Need this resolved immediately!",
  currentDate: new Date(),
});
// Automatically extracts all fields with proper types and validation
```

### 构建使用工具的代理( React 模式)

```typescript
const assistant = ax(
  "question:string -> answer:string",
  {
    functions: [
      { name: "getCurrentWeather", func: weatherAPI },
      { name: "searchNews", func: newsAPI },
    ],
  },
);

const result = await assistant.forward(ai, {
  question: "What's the weather in Tokyo and any news about it?",
});
// AI automatically calls both functions and combines results
```

### 带有图像的多模态分析

```typescript
const analyzer = ax(`
  image:image, question:string ->
  description:string,
  mainColors:string[],
  category:class "electronics, clothing, food, other",
  estimatedPrice:string
`);
// Process images and text together seamlessly
```

## 快速启动

### 安装

```bash
npm install @ax-llm/ax
```

在CI之外,安装 设置一个克洛德代码技能, `ax-llm`,带有契约 索引和捆绑引导您的代理阅读 。 要禁用未来的自动 设置、 运行 `npx @ax-llm/ax skills-auto-install off` 从您的项目根。 这个 保存 `ax.skills.autoInstall: false` 在您的项目中 `package.json`; 执行 和你的团队分享 使用 `skills-auto-install on` 重新启用 未来安装的自动设置。 设定 `AX_SKIP_SKILL_INSTALL=1` 跳过设置 单项安装; CI 和环境变量优先于 保存的设置.

您也可以在首次安装 Ax 之前设置首选 :

```json
{
  "ax": {
    "skills": {
      "autoInstall": false
    }
  }
}
```

将此字段合并到您已有的 `package.json`手册 `npx @ax-llm/ax setup-claude` 即使在自动设置被禁用时也能工作; 添加 `--all` 注册每个专家或 `--skill ax-ai` 只安装一个. 改变偏好让已安装的技能到位,手动设置或 删除保留了保存的偏好. 现有专家仍在安装;使用 `remove-claude` 接下来是 `setup-claude` 将旧的全装设备切换到压缩包.

### 您的第一个 AI 特性(2分)

```typescript
import { ai, ax } from "@ax-llm/ax";

const llm = ai({ name: "openai", apiKey: process.env.OPENAI_APIKEY! });

const translator = ax(`
  text:string, 
  language:string -> 
  translation:string
`);

const result = await translator.forward(llm, {
  text: "Hello world",
  language: "Spanish",
});
console.log(result.translation); // "Hola mundo"
```

## 强大的地物,零复杂度

-   ✅ **示范实验室供应商** - OpenAI、Anthropic、Google、Mistral、DeepSeek, Grok/xAI, 以及更多
-   ✅ **所有安全类型** - 自动完成的全类型脚本支持
-   ✅ **第一流线** - 经验证的实时答复
-   ✅ **多边形** - 图像、音频、文本在同一签名中
-   ✅ **智能优化** - 与GEPA和拖带演示自动快速调试
-   ✅ **生产可观察性** - OpenTeleometry 内置追踪
-   ✅ **高级工作流程** - 用AxFlow制造复杂的管道
-   ✅ **代理框架** - 能够使用工具并呼叫其他特工的特工
-   ✅ **无依赖** - 轻、快、可靠

## 学习更多

### QQ 快赢

-   [**获取启动指南**](https://github.com/ax-llm/ax/blob/main/docs/QUICKSTART.md) - 说吧 5分钟后准备
-   [**实例指南**](https://github.com/ax-llm/ax/blob/main/docs/EXAMPLES.md) - 说吧 附有解释的综合实例
-   [**DSPy 概念**](https://github.com/ax-llm/ax/blob/main/docs/DSPY.md) - 说吧 理解革命方针

### 深潜

-   [**轴向工作流程**](https://github.com/ax-llm/ax/blob/main/docs/AXFLOW.md) - 说吧 构建复杂的AI系统
-   [**优化指南**](https://github.com/ax-llm/ax/blob/main/docs/OPTIMIZE.md) - 说吧 让你的程序更聪明
-   [**高级RAG**](https://github.com/ax-llm/ax/blob/main/docs/AXRAG.md) - 说吧 生产搜索和检索
-   [**API 参考**](https://github.com/ax-llm/ax/blob/main/docs/API.md) - 说吧 完整文档

## 实例

运行任意示例 :

```bash
OPENAI_APIKEY=your-key npm run tsx ./src/examples/[example-name].ts
```

### 核心实例

-   [摘录( t)](https://npmcn.com/package/%40ax-llm/ax/src/examples/extract.ts) - 从文本中提取结构化数据
-   [反应.ts](https://npmcn.com/package/%40ax-llm/ax/src/examples/react.ts) - 有函数调用的新动作模式
-   [代理人.ts](https://npmcn.com/package/%40ax-llm/ax/src/examples/agent.ts) - 多代理人合作
-   [流线式1.ts](https://npmcn.com/package/%40ax-llm/ax/src/examples/streaming1.ts) - 实时流出反应
-   [多式联运.t](https://npmcn.com/package/%40ax-llm/ax/src/examples/multi-modal.ts) - 图像+文本处理

### 生产模式

-   [客户支持.ts](https://npmcn.com/package/%40ax-llm/ax/src/examples/customer-support.ts) - 完整的支助系统
-   [食物搜索(ts)](https://npmcn.com/package/%40ax-llm/ax/src/examples/food-search.ts) - 有工具的餐厅建议
-   [优化.ts](https://npmcn.com/package/%40ax-llm/ax/src/examples/optimize.ts) - 自动优化
-   [axagent-gepa-优化.ts](https://npmcn.com/package/%40ax-llm/ax/src/examples/axagent-gepa-optimization.ts) - GEPA的代理优化
-   [ax-flow-hanced-demo.ts (英语)](https://npmcn.com/package/%40ax-llm/ax/src/examples/ax-flow-enhanced-demo.ts) - 复杂的工作流程

[📚 **查看完整示例指南** →](https://npmcn.com/package/%40ax-llm/ax/docs/EXAMPLES.md)  
[查看全部 70+ 实例 ∗](https://npmcn.com/package/%40ax-llm/ax/src/examples/)

## 加入社区

-   🐦 [追踪微博](https://twitter.com/dosco) - 最新消息
-   💬 [迪斯科德社区](https://discord.gg/DSHg3dU7dW) - 找人帮忙,分享想法
-   ⭐ [恒星在 GitHub](https://github.com/ax-llm/ax) - 支持该项目
-   📖 [询问 DeepWiki](https://deepwiki.com/ax-llm/ax) - 人工智能文件

## 生产准备

-   ✅ **作战测试** - 初创企业用于生产
-   ✅ **没有中断更改** - 稳定小版本
-   ✅ **综合测试** - 大型试验范围
-   ✅ **打开几何** - 建造可观察性
-   ✅ **先输入脚本** - 设计时的型号安全

## 许可证

Apache 2 - 随地使用,制造任何东西.

* * *

**准备好建设未来了吗?** 别再用急件打架了 开始运输 签名.

```bash
npm install @ax-llm/ax
```

_由开发者与QQ一起为开发者所建._

## 常见问题

### @ax-llm/ax 是什么？

与 LLMS 合作的最佳库

### 如何安装 @ax-llm/ax？

在项目目录运行 npm install @ax-llm/ax，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 ax，可以用 npx ax 直接运行。

### @ax-llm/ax 支持 TypeScript 吗？

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

### @ax-llm/ax 支持 ESM 还是 CommonJS？

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

### @ax-llm/ax 可以商用吗？

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

### @ax-llm/ax 的下载量有多少？

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

### @ax-llm/ax 还在维护吗？

最新版本 25\.4\.9 发布于 2026/11/07（今天）；至今共发布 457 个版本，其中过去 12 个月发布了 217 个；首次发布于 2024/06/16。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。