# @formio/uag-claude 中文文档

规范地址：https://npmcn.com/package/%40formio/uag-claude/

版本：2\.0\.0
npm 元数据更新时间：2026-11-13T11:25:26.449Z
中文译文更新时间：2026-11-15T10:47:26.476Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：23.9 kB，4 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.0\.0
- 运行依赖：2 个
- 首次发布：2026-07-29T14:07:07.129Z
- 最新版本发布：2026-11-13T11:25:26.085Z
- 近 30 天下载量：2230（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 13 个）

## 中文简介

Claude agent engine for the Form.io Universal Agent Gateway(UAG):结构化取出,在只读工具上进行研究,为Agent API.

## 安装

```sh
npm install @formio/uag-claude
```

也可以使用：`pnpm add @formio/uag-claude`、`yarn add @formio/uag-claude`、`bun add @formio/uag-claude`

## README

# @formio/uag-claude (英语)

[表格.io UAG](https://ai.form.io/developers) › [发动机](https://ai.form.io/developers/engines) › 此页

这个 **克劳德** 用于 [UAG 代理 API](https://ai.form.io/developers/agent-api)。它提取并生成有结构输出的开放值(日期、数量、名称、自由文本)。 当任务列出只读工具时 `uagTools`先和他们一起研究.

列入 `formio/uag` 多克图像. 由 npm 安装 UAG 后, 在它旁边安装 :

```bash
npm install @formio/uag-claude
```

通过命名启用它,并设置它的密钥:

```
UAG_ENGINES=claude          # or jev,claude
CLAUDE_API_KEY=...
```

它的任务是Agentic Formflow,因此在自办项目上,UAG还需要一个 `LICENSE_KEY` 包括项目终点的 UAG(见 [许可证发放](https://ai.form.io/developers/deployment#licensing)Form.io的托管服务项目不需要。 表格的聊天不需要Form.io OpenSource或主机项目上的许可证.

## 设置

| 设置 | 变量 | 默认 |
| --- | --- | --- |
| `apiKey` | `UAG_ENGINE_<NAME>_API_KEY`, (中文(简体) ), `CLAUDE_API_KEY`, (中文(简体) ), `ANTHROPIC_API_KEY` | 要求(秘密) |
| `model` | `UAG_ENGINE_<NAME>_MODEL`, (中文(简体) ), `CLAUDE_MODEL` | `claude-opus-5-5` |
| `effort` | `UAG_ENGINE_<NAME>_EFFORT`, (中文(简体) ), `CLAUDE_EFFORT` | `low`,用于提取 |
| `researchEffort` | `UAG_ENGINE_<NAME>_RESEARCH_EFFORT`, (中文(简体) ), `CLAUDE_RESEARCH_EFFORT` | `medium`,用于工具研究 |
| `fallbacks` | `UAG_ENGINE_<NAME>_FALLBACKS`, (中文(简体) ), `CLAUDE_FALLBACKS` | `default`· ; `off` 禁用 |
| `maxTokens` | `UAG_ENGINE_<NAME>_MAX_TOKENS`, (中文(简体) ), `CLAUDE_MAX_TOKENS` | `16000`; 1至128,000 |

`maxTokens` 限制每个请求的输出。 长的值,例如一个被转录到丰富的文本字段的文档,需要比默认要多,需要更多的时间:提高实例的路由超时(`routing.timeouts`由于UAG在超时放弃了它生产的任何发动机.

`<NAME>` 是实例名称,大写为 `-` 作为 `_`。一个案例本身的变量胜过共享的变量. `effort` 财务报告和审定财务报表 `researchEffort` 带 `low`, (中文(简体) ), `medium`, (中文(简体) ), `high`, (中文(简体) ), `xhigh` 或者说 `max`。 。 。 .

## 实例

运行一个简单字段的快模型和一个更深字段,共享一个密钥:

```
UAG_ENGINES=jev,fast:claude,deep:claude
CLAUDE_API_KEY=...
UAG_ENGINE_FAST_MODEL=claude-haiku-5-5
UAG_ENGINE_DEEP_MODEL=claude-opus-5-5
UAG_ENGINE_DEEP_RESEARCH_EFFORT=high
```

运行列表,一个字段 `uagEngine` 属性,例如命名实例 `routing.value: ["fast", "deep"]`。 。 。 .

## 选择模型

设定 `model` 以特定模式标识,而不是依赖默认。 新的 UAG 发布可能会改变默认值,而答案会因模型的不同而不同,因此在修改前在您自己标注的示例上进行对比(`uag-eval` (仅限决策引擎).

每个请求都会发出 `effort` (或 `researchEffort`),所以模型必须接受:

-   目前的型号都取出所有五个等级:克洛德·奥普斯 5.5,奥普斯 5.5,索内特 5.5,索内特 5.5,海库 5.5,奥普斯 4.8和奥普斯 4.7.
-   Claude Opus 4.6 和 Sonnet 4.6 分了每个级别,除了 `xhigh`。 。 。 .
-   克劳德·海库·4.5和索内·4.5拒绝 `effort`,所以所有的要求都失败了。 使用当前模型 .

## 如何运作

-   **采掘业** 使用结构化产出(`output_config.format`有了JSON计划,UAG来源于形式。 答案对请求的字段是有效的 JSON 。 此引擎的值总是报告为 `suggested`。 。 。 .
-   **研究:** 当任务列出只读工具时,克洛德可以先调用它们,直到 `agentApi.research.maxIterations` 转身 每通通通通通通通通通通通通通通通通通通通通通通通通通通通通通通通通通通通通通通通通通通. 克劳德随后以相同的结构化输出来回答,工具被关闭. 它从不写: UAG 验证这些值并保存它们本身.
-   **拒绝:** 与 `fallbacks` 时间 `default`,API在倒置型号服务器侧面重新运行了一个被拒绝的请求,用于拥有一个的型号(如克洛德·奥普斯·5.5和索内·5.5). Claude Haiku 5.5没有,所以拒绝有效。 站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站位被报告为发动机故障,UAG站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站站位.
-   **流线 :** 每一个请求流,所以一个长的答案不需要自己的请求超时;UAG的超时仍然通过它的信号中止.
-   **文 件 (续)`generate`:** 克劳德阅读了文本和PDFs(`accepts: ['text', 'pdf']`。文档插件请求将每个 PDF 发送为基准64 `document` 块和每个文本作为文本 `document` 块,标题为标签;最后文档标记 `cache_control: ephemeral`,所以一个插件的重试用相同的文档从快取缓存读取. 进展报告为答案流,在输出限值被切断的答案随同返回 `stopReason: 'max_tokens'`,将UAG的文档限制控制在克洛德范围内(每个请求32 MB,及其目前的PDF页面限制).
-   **脚本限制 :** 每个答复可能使用最多 `maxTokens` (16,000 默认). 研究转弯或在该极限被切断的取出是引擎故障,而UAG倒回了下一个引擎.
-   **终止 :** (用于研究, `agentApi.research.timeout`)中止请求,研究在下一次呼叫前停止.

## 从1.x升级

`@formio/uag-claude` 1.x是一个不同的程序:克洛德集成,一个独立的服务器(英语:`uag-claude`,则 `formio/uag-claude` image),运行了自己的MCP客户端来对抗UAG. 2.0是一个引擎:UAG载荷的库,没有服务器,也没有运行的命令. 安装 2. 0 , 其中 1. x 运行时会给出一个包, 包会自己无所作为 .

-   **为了保持1.x整合,** 针 `@formio/uag-claude@^1` (或 `formio/uag-claude:1.3` 图片). 1.3.x继续针对UAG 2.0工作,只获得安全修复.
-   **移动到2.0,** 在 UAG 中打开引擎(`UAG_ENGINES=claude`, (中文(简体) ), `CLAUDE_API_KEY`)或在一个 `formio/uag-engines` ,并取出集成容器。 见 [移动到 2. 0](https://github.com/formio/uag/blob/main/MIGRATING-2.0.md#the-claude-integration-is-retired) 用来代替它的网络和命令.

| 1.x 设置 | 2.0 数据 |
| --- | --- |
| `CLAUDE_API_KEY` | 未改变; `ANTHROPIC_API_KEY` 还行. |
| `CLAUDE_MODEL` | 没有改变,但模型必须接受 `effort` (见 [选择模型](https://npmcn.com/package/%40formio/uag-claude/#readme-choosing-a-model)) (中文(简体) ). |
| `CLAUDE_MAX_TOKENS` | 未更改: `maxTokens` 设置( 默认 16,000; 见 [设置](https://npmcn.com/package/%40formio/uag-claude/#readme-settings)) (中文(简体) ). `CLAUDE_EFFORT` 财务报告和审定财务报表 `CLAUDE_RESEARCH_EFFORT` 成本交易深度. |
| `CLAUDE_MAX_ITERATIONS` | 无人机 `agentApi.research.maxIterations`。 。 。 . |
| `PROJECT`, (中文(简体) ), `PROJECT_KEY`, (中文(简体) ), `ADMIN_KEY`, (中文(简体) ), `BASE_URL`, (中文(简体) ), `PORT` | 不是引擎设置:引擎运行在UAG内部(或在引擎服务器上),而UAG称它. |
| `UAG_SERVER` | 也没有引擎设置 在引擎服务器上,是UAG的URL,研究唤起回(`/mcp`),在UAG内部不需要. |
| 一个网游到 `/agent/claude/agent_provide_data` | 表格上的"特工:运行任务"动作. |
| `POST /agent/claude/collect_field_data` | `POST {form}/agent/extract` 在UAG上. |
| `POST /agent/claude` (免费格式命令) | 无代理 API 等同:一个引擎会回答一个窗体的任务. 连接 MCP 客户端到 UAG `/mcp` 相反,Form.io权限适用于每个工具调用的地方. |

## 在自己的服务器上使用

将其命名为配置而非 `UAG_ENGINES`,具有优先于环境的选项:

```js
const server = new UAGServer({
    engines: [{ name: 'deep', type: 'claude', options: { model: 'claude-opus-5-5', researchEffort: 'high' } }],
});
```

驾照:麻省理工.

## 常见问题

### @formio/uag-claude 是什么？

Claude agent engine for the Form\.io Universal Agent Gateway\(UAG\):结构化取出,在只读工具上进行研究,为Agent API\.

### 如何安装 @formio/uag-claude？

在项目目录运行 npm install @formio/uag-claude，或使用 pnpm add / yarn add / bun add。

### @formio/uag-claude 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/formio\_\_uag-claude 是否存在。

### @formio/uag-claude 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @formio/uag-claude 需要什么版本的 Node\.js？

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

### @formio/uag-claude 可以商用吗？

@formio/uag-claude 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @formio/uag-claude 的下载量有多少？

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

### @formio/uag-claude 还在维护吗？

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