本仓库是可与 Haystack 流水线或智能体配合使用的 Haystack 集成索引。
这些集成由其各自的所有者或作者维护。您可以在 Haystack 集成 页面浏览它们,其中包含每个工具的作者、安装和使用信息。
Haystack 集成是指可与 Haystack 配合使用的外部软件包或附加技术,它们可以是文档存储、模型提供商、自定义组件、监控工具或评估框架。部分集成由 deepset 团队维护,其他则是社区贡献,由集成的作者所有。更多关于 Haystack 集成的信息,请阅读 集成介绍。
要贡献集成,请创建一个 PR,在 integrations/ 目录下添加一个 .md 文件。
👉 您可以从 集成草案页面 开始
文件中需要包含以下几点 👇
前置元数据必须包含以下内容:
---
layout: integration (必填)
name: 您的集成名称 (必填)
description: 简短描述(这将显示在网站集成页面的前端元素上)(必填)
authors:
- name: 作者 1 的姓名 (必填)
socials:
github: 如有需要可填写
twitter: 如有需要可填写
linkedin: 如有需要可填写(完整 URL)
- name: 作者 2 的姓名
socials:
github: 如有需要可填写
twitter: 如有需要可填写
linkedin: 如有需要可填写(完整 URL)
pypi: 如果存在,填写 PyPI 包 URL
repo: 如果存在,填写 GitHub 仓库 URL
report_issue: 用户报告集成问题的链接
type: 文档存储 OR 模型提供商 OR 数据摄取 OR 监控工具 OR 评估框架 OR 自定义组件 OR 工具集成 OR 新类型!(必填)
toc: true (可选)
logo: /logos/your-logo.png (可选)
version: Haystack 2.0
---
请注意,pypi 或 repo 字段中至少需要填写一项,我们才会合并该集成。
然后,请在您的 .md 文件正文中尽可能详细地添加关于您集成的信息和说明。
提交一个 Pull Request,如果一切顺利,恭喜您,您的集成很快就会出现在集成页面上 🥳