@formio/uag-grok

中文文档
2.0.0发布于 2026/11/13MITCommonJS构建来源已验证近 30 天下载 2098

Form.io Universal Agent Gateway(UAG):xAI的模型的Grok引擎,用于在只读工具上进行结构化提取的研究.

中文使用文档
文档目录5 节
  1. 设置
  2. 实例
  3. 选择模型
  4. 如何运作
  5. 在自己的服务器上使用

@formio/uag-grok (英语)

表格.io UAG › 发动机 › 此页

这个 格鲁克 用于 UAG 代理 API:xAI的型号,通过xAI的OpenAI相容API. 它提取并生成有结构输出的开放值(日期,数量,名称,自由文本). 当任务列出只读工具时 uagTools先和他们一起研究.

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

npm install @formio/uag-grok

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

UAG_ENGINES=grok
XAI_API_KEY=...
XAI_MODEL=<a Grok model ID>

它的任务是Agentic Formflow,因此在自办项目上,UAG还需要一个 LICENSE_KEY 包括项目终点的 UAG(见 许可证发放Form.io的托管服务项目不需要。 表格的聊天不需要Form.io OpenSource或主机项目上的许可证.

设置

设置变量默认
apiKeyUAG_ENGINE_<NAME>_API_KEY, (中文(简体) ), XAI_API_KEY要求(秘密)
modelUAG_ENGINE_<NAME>_MODEL, (中文(简体) ), XAI_MODEL需要; 没有默认
baseURLUAG_ENGINE_<NAME>_BASE_URLhttps://api.x.ai/v1
structuredOutputUAG_ENGINE_<NAME>_STRUCTURED_OUTPUTjson_schema· ; json_object 或者说 prompt 如果一个模型拒绝严格的计划

<NAME> 是实例名称,大写为 - 作为 _。一个案例本身的变量胜过共享的变量.

实例

用于 Claude 旁边常规值的快速 Grok 模型 :

UAG_ENGINES=jev,fast:grok,claude
XAI_API_KEY=...
UAG_ENGINE_FAST_MODEL=<a fast Grok model ID>
CLAUDE_API_KEY=...

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

选择模型

没有默认模式: 设置 model 转换为xAI文档中的特定型号ID,而不是移动的别名. 不同模型的答案不同,因此在切换前在自己标注的例子上进行比较(uag-eval (仅限决策引擎).

如何运作

这是 OpenAI 引擎'具有xAI端点和密钥所构建的代理类型:一次聊天完成,每分取一个严格的JSON schema,以及一个函数调用循环,凌驾于任务只读研究工具之上,以相同的结构化答案收尾. 拒绝,短接的回答或回答不是JSON是引擎故障,而UAG倒回了下一个引擎.

每个字段的格式( 如 date)和图案被写入其描述中,而不是作为计划限制发送. Grok严格执行限制,每个字段都需要严格的方案,否则它就会创造出一个符合输入没有说明的字段模式的值. UAG对每个值都进行验证.

Grok没有决定API,而目前的Grok模型不会返回任何符号概率,因此这只是一个代理引擎. 通往决策区的回复为提取并报告 calibrated: false。 。 。 .

数据居住: 每个请求都会发送xAI任务的标准,其输入(或者,没有输入,整个提交,但被回答的字段除外),其 uagContext 价值和今天的日期, 并且,对于一项研究任务, 它的工具返回.

在自己的服务器上使用

const server = new UAGServer({ engines: [{ name: 'grok', type: 'grok', options: { model: '<a Grok model ID>' } }] });

驾照:麻省理工.

版本与发布记录

@formio/uag-grok 共发布 13 个版本,首次发布于 2026/10/30;过去 12 个月发布了 13 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.0.0latest2026/11/132 天前
2.0.0-rc.11rc2026/11/105 天前
2.0.0-rc.102026/11/087 天前
2.0.0-rc.92026/11/079 天前
2.0.0-rc.82026/11/069 天前
2.0.0-rc.72026/11/0610 天前

关于 @formio/uag-grok 的常见问题

@formio/uag-grok 是什么?

Form.io Universal Agent Gateway(UAG):xAI的模型的Grok引擎,用于在只读工具上进行结构化提取的研究.

如何安装 @formio/uag-grok?

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

@formio/uag-grok 支持 TypeScript 吗?

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

@formio/uag-grok 支持 ESM 还是 CommonJS?

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

@formio/uag-grok 需要什么版本的 Node.js?

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

@formio/uag-grok 可以商用吗?

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

@formio/uag-grok 的下载量有多少?

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

@formio/uag-grok 还在维护吗?

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