# @eventcatalog/generator-ai 中文文档

规范地址：https://npmcn.com/package/%40eventcatalog/generator-ai/

版本：1\.2\.3
npm 元数据更新时间：2025-12-12T10:46:07.266Z
中文译文更新时间：2026-11-14T01:11:12.807Z
软件包许可：ISC

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

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

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

- 包体积（解压后）：426 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：7 个
- 首次发布：2025-02-25T15:50:14.768Z
- 最新版本发布：2025-12-12T10:46:06.835Z
- 近 30 天下载量：3418（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：17（近 12 个月 2 个）

## 中文简介

在您的工程中添加事件Catalog AI 助手

## 安装

```sh
npm install @eventcatalog/generator-ai
```

也可以使用：`pnpm add @eventcatalog/generator-ai`、`yarn add @eventcatalog/generator-ai`、`bun add @eventcatalog/generator-ai`

## README

# QQ 事件Catalog 聊天 - 生成器

用事件Catalog聊天与您的架构交谈

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com/) ![](https://img.shields.io/github/actions/workflow/status/event-catalog/generator-eventbridge/verify-build.yml) [![](https://dcbadge.limes.pink/api/server/https://discord.gg/3rjaZMmrAm?style=flat)](https://discord.gg/3rjaZMmrAm) [![](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/david-boyne/) [![blog](https://img.shields.io/badge/blog-EDA--Visuals-brightgreen)](https://eda-visuals.boyney.io/?utm_source=event-catalog-gihub) [![blog](https://img.shields.io/badge/license-Dual--License-brightgreen)](https://github.com/event-catalog/generator-eventbridge/blob/main/LICENSE.md)

![header](https://github.com/event-catalog/generators/blob/main/images/ai.png?raw=true)

#### 特性: 使用自然语言询问关于您的事件Catalog的问题, 使用 Chat 获取答案 。 本地第一,没有数据离开你的电脑.

[阅读文档](https://eventcatalog.dev/) | [编辑文档](https://github.com/event-catalog/docs) | [查看演示](https://demo.eventcatalog.dev/docs)

* * *

# 核心特征

-   QQ 使用自然语言询问您的事件Catalog
-   选择您的嵌入模式
-   \* 缩短学习和理解建筑所需的时间
-   还有更多...

# 如何运作

[事件目录](https://www.eventcatalog.dev/) 技术是不可知论的,意思是它可以融入任何计划,规格或经纪人.

事件Catalog 支持 [发电机](https://www.eventcatalog.dev/docs/development/plugins/generators)。 。 。 . 生成器是运行到预建的脚本,以便在您的目录中生成内容 。 发电机可以使用 [事件Catalog SDK](https://www.eventcatalog.dev/docs/sdk)。 。 。 .

使用此 EventCatalog 插件嵌入基于您的 EventCatalog 生成 。 你可以使用拥抱相或Openai来生成嵌入相.

这些嵌入物被 EventCatalog 存储和使用, 这些嵌入物都存在于您的项目和计算机中 。 一旦您用这个生成器生成嵌入, 并配置您的 EventCatalog 项目, 您可以使用 Chat 来询问您的目录 .

事件Catalog 集成到 [OpenAI 模型](https://www.eventcatalog.dev/docs/development/guides/eventcatlaog-chat/using-openai-models) 或者你可以利用我们 [基于浏览器的模型](https://www.eventcatalog.dev/docs/development/guides/eventcatlaog-chat/using-browser-models)。 。 。 .

这些模型将使用这个生成器生成的嵌入.

您可以选择您想要使用的模型和嵌入提供者, EventCatalog 将会下载该模型, 允许您使用 Chat .

```js
...
generators: [
    [
      '@eventcatalog/generator-ai',
      {
        // This will split the markdown files into smaller chunks, this is optional and defaults to false
        // This uses MarkdownTextSplitter under the hood
        splitMarkdownFiles: false,


        // Set this to true if you want to include users and teams in the embeddings for your AI Assistant
        // This can bloat the embeddings and may effect the results you get back, false by default
        includeUsersAndTeams: false,

        // Should the schemas for the messages also be embedded?
        // Default value is true. (You must specify the schemaPath in your message for the schema to be embedded)
        includeSchemas: true,

        embedding: {
          // defaults to huggingface
          provider: 'openai' | 'huggingface',
          //  pick your model (optional, defaults to text-embedding-3-large for openai and all-MiniLM-L6-v2 for huggingface)
          model: 'text-embedding-3-large' | 'Xenova/all-MiniLM-L6-v2',
        },

        // optional similarity results to use, defaults to 30
        similarityResults: 40,

        // optional max tokens to use, defaults to 4096, map to your model
        maxTokens: 4096,

      },
    ]
  ],
...
```

在这个例子中,我们安装和设置了发电机。 这将分析我们的所有目录文件并创建一个名为的新文件夹 `/generated-ai` 带有以下文件:

-   `documents.json` - 在EventCatalog中包含LLM模型的已处理文档及其元数据
-   `embeddings.json` - 包含文档的向量嵌入。 这些被 EventCatalog 用于进行向量搜索 .
-   `README.md` - 这个文件只是告诉你这些文件是生成的,而不是编辑它们

# 开始

## 安装和配置

_请确定您在 EventCatalog 的最新版本中_。 。 。 .

1.  安装软件包

```sh
@eventcatalog/generator-ai
```

2.  配置您的 `eventcatalog.config.js` 文件 [(见实例)](https://github.com/event-catalog/eventcatalog-ai-example/blob/main/eventcatalog.config.js)
    
3.  运行生成命令
    

```sh
npm run generate
```

4.  配置您的 EventCatalog 项目, 打开聊天功能 .

```js
{
    chat: {
        enabled: true,
    }
}
```

5.  启动您的项目并前往 `/chat` 或使用侧边栏的链接.

```sh
npm run dev
```

## 有问题吗?

在这个项目上提出一个 GitHub 问题, 或者联系我们 [我们的 Discord 服务器](https://discord.gg/3rjaZMmrAm)。 。 。 .

# 发起人

谢谢你的项目赞助商.

## 黄金赞助商

![gravitee](https://npmcn.com/package/images/sponsors/gravitee-logo-black.svg)

管理、保障和管理你们组织的每个API

[学多点](https://gravitee.io/?utm_source=eventcatalog&utm_medium=web&utm_campaign=sponsorship)

* * *

![oso](https://npmcn.com/package/images/sponsors/oso-logo-green.png)

向您的企业提供Apache Kafka专业服务

[学多点](https://oso.sh/?utm_source=eventcatalog&utm_medium=web&utm_campaign=sponsorship)

* * *

_赞助者帮助使事件Catalog可持续,想要帮助项目吗? 保持联络! 或者说 [访问赞助者网页](https://www.eventcatalog.dev/support)。 。 。 ._

# 企业支助

有兴趣和我们合作吗? 我们的提议包括专门支助、优先援助、特色发展、定制一体化等等.

找到更多关于我们的细节 [服务页面](https://eventcatalog.dev/services)。 。 。 .

# 捐款

如果您有任何问题,特征或问题,请提出任何问题或拉动请求。 我们尽力再联系你.

你可以找到那个 [此处提供指南](https://eventcatalog.dev/docs/contributing/overview)。 。 。 .

## 本地运行项目

1.  清除还原
2.  安装所需的依赖关系 `pnpm i`
3.  运行测试 `pnpm run tests`

# 商业用途

这个项目由下列机构管理: [双许可证](https://npmcn.com/package/%40eventcatalog/generator-ai/LICENSE.md)。为了确保项目的可持续性,如果您的项目是开放源代码,您可以自由使用此软件。 否则,对于专有系统,您必须获得 [商业执照](https://npmcn.com/package/%40eventcatalog/generator-ai/LICENSE-COMMERCIAL.md)。 。 。 .

如果您想获得商业执照,可在下列地点购买执照: [https://eventcatalog.cloud (中文(简体) )](https://eventcatalog.cloud/) 或者给我们发邮件 `hello@eventcatalog.dev`

## 常见问题

### @eventcatalog/generator-ai 是什么？

在您的工程中添加事件Catalog AI 助手

### 如何安装 @eventcatalog/generator-ai？

在项目目录运行 npm install @eventcatalog/generator-ai，或使用 pnpm add / yarn add / bun add。

### @eventcatalog/generator-ai 支持 TypeScript 吗？

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

### @eventcatalog/generator-ai 支持 ESM 还是 CommonJS？

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

### @eventcatalog/generator-ai 可以商用吗？

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

### @eventcatalog/generator-ai 的下载量有多少？

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

### @eventcatalog/generator-ai 还在维护吗？

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