@byline/ai

中文文档
6.13.0发布于 2026/11/04MPL-2.0TypeScriptES Module近 30 天下载 2233

Byline CMS AI子系统.

中文使用文档
文档目录5 节
  1. 它提供的东西
  2. 浏览器/ 服务器分割
  3. 配置
  4. 文档
  5. 许可证

@byline/ai (英语)

AI子系统用于 线性CMS ——提供-不可知文本生成和管理员结构化编辑 编辑器,带有文本和 Lexical 丰富的文本字段的内置编辑器插件.

这个软件包是 Byline CMS 的一部分——一个开发者友好的开源 无头 CMS 有版本、编辑工作流程和内容翻译为 头等舱问题.

它提供的东西

  • 提供者不可知处决 - 单身 ExecuteInstruction 合同终止 OpenAI, Google (Gemini), 和 Anthropic, 非流和流 变体(executeInstruction 编号 : executeInstructionStreaming) (中文(简体) ).
  • 结构化生成 —— 说 generateStructured 编号 : generateStructuredStreaming 用于图密节制输出.
  • 补丁生成 —— 说 patch 编号 : patchStreaming,用于编辑命令数组 的文本节点(被richtext字段的 AI 抽屉所使用).
  • 编辑器插件 ——两个编辑器表面的滴入插件: @byline/ai/plugins/text (单位:千美元)AiPluginText和 @byline/ai/plugins/lexical (单位:千美元)AiPluginLexical, (中文(简体) ), AiLexicalExtension, (中文(简体) ), TOGGLE_AI_DRAWER_COMMAND) (中文(简体) ).
  • 浏览器安全配置 • 公共配置提供者和提供者/模式帮助者 没有服务器 SDK 依赖性 .

浏览器/ 服务器分割

根项是浏览器安全; SDK 支持的执行代码生活在一个 单独的服务器条目。 从右侧导入 :

条目从表面
@byline/ai浏览器 财务报告和审定财务报表 服务器类型, AiPublicConfigProvider 编号 : useAiPublicConfig、提供者/模式帮助者(PROVIDERS, (中文(简体) ), DEFAULT_MODELS, (中文(简体) ), getDefaultModel,(......), INSTRUCTION_MODES
@byline/ai/server只有服务器executeInstruction(Streaming), (中文(简体) ), generateStructured(Streaming), (中文(简体) ), patch(Streaming), (中文(简体) ), getAiServerConfig
@byline/ai/plugins/text浏览器AiPluginText
@byline/ai/plugins/lexical浏览器AiPluginLexical, (中文(简体) ), AiLexicalExtension, (中文(简体) ), TOGGLE_AI_DRAWER_COMMAND

导入 @byline/ai/server 在浏览器中会崩溃——它拉入 Anthropic/OpenAI/Google SDKs和皮诺. 主机适配器挂载执行终点 在服务器和插件 POST 上 ExecuteInstruction 其载荷 主机集成于 @byline/host-tanstack-start (单位:千美元)integrations/byline-ai.tsx, (中文(简体) ), server-fns/ai/*) (中文(简体) ).

配置

从环境读取服务器配置 getAiServerConfig()数字 :

变量目的默认
AI_DEFAULT_PROVIDERopenai | google | anthropicopenai
OPENAI_API_KEY 编号 : OPENAI_BASE_URLOpenAI 证书—— 说
GOOGLE_API_KEY 编号 : GOOGLE_BASE_URLGoogle (Gemini) 证书—— 说
ANTHROPIC_API_KEY 编号 : ANTHROPIC_BASE_URL道德证书—— 说
BYLINE_AI_ENDPOINT结束点编辑器插件 POST/admin/api/ai/execute
LOG_LEVEL 编号 : LOG_PRETTY日志info

由提供商整理的列表 src/config/ai-config.ts (单位:千美元)PROVIDER_MODELS 编号 : DEFAULT_MODELS) (中文(简体) ). 运行 pnpm list:models 以发现 模型一个提供者目前暴露.

文档

关于完整的架构概览、丰富文本/AI集成和获得 启动指令, 请见主仓库 : https://github.com/Byline-CMS/bylinecms.dev. 互联网档案馆的存檔,存档日期2013-12-22相关文件: docs/04-collections/07-rich-text.md, (中文(简体) ), docs/04-collections/01-fields.md,以及 docs/05-reading-and-delivery/05-mcp-server.md。 。 。 .

许可证

MPL - 2.0 导弹

版本与发布记录

@byline/ai 共发布 146 个版本,首次发布于 2026/05/11;过去 12 个月发布了 146 个版本。

版本发布日期距今
6.13.0latest2026/11/044 天前
6.12.12026/11/026 天前
6.12.02026/10/318 天前
6.11.02026/10/2514 天前
6.10.12026/10/2217 天前
6.10.02026/10/2217 天前

关于 @byline/ai 的常见问题

@byline/ai 是什么?

Byline CMS AI子系统.

如何安装 @byline/ai?

在项目目录运行 npm install @byline/ai,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^19.0.0)、react-dom(^19.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@byline/ai 支持 TypeScript 吗?

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

@byline/ai 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@byline/ai 需要什么版本的 Node.js?

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

@byline/ai 可以商用吗?

@byline/ai 使用 MPL-2.0 许可。弱 Copyleft:可以商用,也可以和闭源代码一起使用;但如果分发时修改了 MPL 授权的文件,这些文件的修改需以 MPL 开源。以上为概括,不构成法律意见,请以许可原文为准。

@byline/ai 的下载量有多少?

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

@byline/ai 还在维护吗?

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