QQ 事件Catalog 聊天 - 生成器
用事件Catalog聊天与您的架构交谈
特性: 使用自然语言询问关于您的事件Catalog的问题, 使用 Chat 获取答案 。 本地第一,没有数据离开你的电脑.
核心特征
- QQ 使用自然语言询问您的事件Catalog
- 选择您的嵌入模式
- * 缩短学习和理解建筑所需的时间
- 还有更多...
如何运作
事件目录 技术是不可知论的,意思是它可以融入任何计划,规格或经纪人.
事件Catalog 支持 发电机。 。 。 . 生成器是运行到预建的脚本,以便在您的目录中生成内容 。 发电机可以使用 事件Catalog SDK。 。 。 .
使用此 EventCatalog 插件嵌入基于您的 EventCatalog 生成 。 你可以使用拥抱相或Openai来生成嵌入相.
这些嵌入物被 EventCatalog 存储和使用, 这些嵌入物都存在于您的项目和计算机中 。 一旦您用这个生成器生成嵌入, 并配置您的 EventCatalog 项目, 您可以使用 Chat 来询问您的目录 .
事件Catalog 集成到 OpenAI 模型 或者你可以利用我们 基于浏览器的模型。 。 。 .
这些模型将使用这个生成器生成的嵌入.
您可以选择您想要使用的模型和嵌入提供者, EventCatalog 将会下载该模型, 允许您使用 Chat .
...
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 的最新版本中。 。 。 .
- 安装软件包
@eventcatalog/generator-ai
-
配置您的
eventcatalog.config.js文件 (见实例) -
运行生成命令
npm run generate
- 配置您的 EventCatalog 项目, 打开聊天功能 .
{
chat: {
enabled: true,
}
}
- 启动您的项目并前往
/chat或使用侧边栏的链接.
npm run dev
有问题吗?
在这个项目上提出一个 GitHub 问题, 或者联系我们 我们的 Discord 服务器。 。 。 .
发起人
谢谢你的项目赞助商.
黄金赞助商
赞助者帮助使事件Catalog可持续,想要帮助项目吗? 保持联络! 或者说 访问赞助者网页。 。 。 .
企业支助
有兴趣和我们合作吗? 我们的提议包括专门支助、优先援助、特色发展、定制一体化等等.
找到更多关于我们的细节 服务页面。 。 。 .
捐款
如果您有任何问题,特征或问题,请提出任何问题或拉动请求。 我们尽力再联系你.
你可以找到那个 此处提供指南。 。 。 .
本地运行项目
- 清除还原
- 安装所需的依赖关系
pnpm i - 运行测试
pnpm run tests
商业用途
这个项目由下列机构管理: 双许可证。为了确保项目的可持续性,如果您的项目是开放源代码,您可以自由使用此软件。 否则,对于专有系统,您必须获得 商业执照。 。 。 .
如果您想获得商业执照,可在下列地点购买执照: https://eventcatalog.cloud (中文(简体) ) 或者给我们发邮件 [email protected]