# @formio/uag-js 中文文档

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

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

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

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

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

- 包体积（解压后）：113 kB，7 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@formio/js \>=5
- 首次发布：2026-10-29T17:12:07.914Z
- 最新版本发布：2026-11-13T11:25:55.863Z
- 近 30 天下载量：2116（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 13 个）

## 中文简介

Formio.js应用程序的Form.io UAG:注册一次,并给"uag"打上标记,通过UAG保存并获得Agent Introduction,不覆盖用户输入的内容.

## 安装

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

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

## README

# @formio/uag-js (英语)

这个 [表格.io UAG](https://ai.form.io/developers) formio.js的应用程序。 登记一次,并标记表格 `uag` 除了通过UAG(所以他们的“代理:运行任务”动作运行),以及任务有输入者获得 **代理输入**,它从用户描述的内容中填入表格,而不覆盖输入的内容。 每种其他形式, 和任何其他请求, 都和以前一样,去Form.io。 任意 `uag` 形式也可以作为 [聊天](https://npmcn.com/package/%40formio/uag-js/#readme-chat)。 。 。 .

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

它与formio.js 5(英语:`@formio/js` 5.x),无附属关系.

```js
import { Formio } from '@formio/js';
import { UAG } from '@formio/uag-js';
import '@formio/uag-js/uag-js.css';

Formio.setProjectUrl('https://forms.example.com/myproject');
Formio.use(UAG('https://uag.example.com'));

Formio.createForm(document.getElementById('claim'), 'https://forms.example.com/myproject/claim');
```

没有捆绑,装上UAG自己的 `https://uag.example.com/uag-js/uag.use.js` (和 `uag-js.css`在formio.js之后:它用该UAG及其模块的组件进行注册。 见 [或者从UAG装入](https://ai.form.io/developers/renderer#or-load-it-from-the-uag)。 。 。 .

向UAG提出的请求带有用户的Form.io令牌(`x-jwt-token`由于formio.js将它发送给form.io;不需要其他标志。 在浏览器中行走不是一个安全边界:保护代理在服务器上拥有的、具有代理角色的字段,组成权限和 `uagAuthoritative`。 。 。 .

## AI 文件

这个 **AI 文件** 构成部分`uagdocument`)是来自 [`@formio/uag-extras`](https://www.npmjs.com/package/@formio/uag-extras) (单位:千美元)`npm install @formio/uag-extras@^1`),而不是从这个包裹。 使用模块的 UAG 将组件添加到其 `/uag-js/uag.use.js`; 带有捆绑器的应用程序在此包后注册:

```js
import aiDocument from '@formio/uag-extras/modules/ai-document/client';
Formio.use(UAG('https://uag.example.com'));
Formio.use(aiDocument);
```

见 [AI 文件](https://ai.form.io/developers/ai-document)。 。 。 .

## 对于组件: `client`

一旦UAG注册, `client` (另见: `Formio.uagClient`, (中文(简体) ), `FormioUAG.client` 财务报告和审定财务报表 `UAG.client`)是UAG模块组件所基于,在主要版本内稳定的浏览器API:UAG的URL,用户的令牌和信头,UAG上的窗体URL,已安装的插件, `stream()` 用于模块路由,和Markdown渲染.

```js
import { client } from '@formio/uag-js';
await client.ready;
const done = await client.stream(client.formUrl(form) + '/document/process', { path, files }, { onEvent: (name, data) => {} });
```

每个成员,如何 `stream()` 决定并拒绝: [模块组件: `client`](https://ai.form.io/developers/renderer#for-module-components-client)。 。 。 .

## 聊天

标记任何窗体 `uag` 也可以作为聊天的方式 `Formio.createForm` 把它变成一种形式。 一个人描述他们需要什么;聊天询问还缺少什么,并填充后面的表格,这些表格一旦确认就通过UAG验证并提交. 每个转弯就是形式 `{form}/agent/chat` 在UAG上,所以没有模型代码,也没有自己的服务器,它不需要代理格式流许可证(UAG需要代理引擎).

```js
Formio.use(UAG('https://uag.example.com'));

const chat = await Formio.createChat(document.getElementById('help'), 'https://forms.example.com/myproject/service-request', {
  suggestions: ['My internet is down'],
  markdown: (text) => marked.parse(text)   // optional; the output is sanitized
});
chat.on('submitDone', (submission) => console.log('Saved', submission._id));
```

`createChat` 也导出(和 `FormioUAG.createChat` 带有脚本标记). 聊天通过formio.js模板(`uagChat`, (中文(简体) ), `uagChatMessage`,.) 您可以替换每个框架或每个聊天, 翻译通过 `i18n`和以物配主者 `--uag-chat-*` CSS 属性在 `uag-js.css`。 。 。 .

联合国 [Java 脚本 (formio.js)](https://ai.form.io/developers/renderer) • 妇女 [聊天部件](https://ai.form.io/developers/chat)。 。 。 .

## 常见问题

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

Formio\.js应用程序的Form\.io UAG:注册一次,并给"uag"打上标记,通过UAG保存并获得Agent Introduction,不覆盖用户输入的内容\.

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

在项目目录运行 npm install @formio/uag-js，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@formio/js（\>=5）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

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

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

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

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

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

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

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

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

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

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