集成简介
Haystack 生态系统与许多其他技术集成,例如向量数据库、模型提供商,甚至是社区制作的自定义组件。您可以在这里探索我们的集成,这些集成可能由 deepset 维护,也可能由其他人提交。
Haystack 与许多其他技术和工具集成。例如,您可以使用 Haystack 的多种不同模型提供商或数据库。
集成主要有两种类型
- 由 deepset 维护: 我们维护的所有集成都托管在 haystack-core-integrations 仓库中。
- 由我们的合作伙伴或社区维护: 这些集成由您、我们的合作伙伴或任何人自行构建和维护。只要它们符合我们的一些要求,我们也会在我们的网站上展示这些集成。
什么是集成?
集成是指可以用来扩展 Haystack 框架功能的任何类型的外部技术。一些集成示例包括提供 OpenAI 或 Cohere 等模型提供商访问的集成,提供 Weaviate 和 Qdrant 等数据库的集成,甚至是 Traceloop 等监控工具的集成。它们可以是组件、文档存储(Document Stores)或任何可以与 Haystack 一起使用的其他功能。
我们在 Haystack 集成页面维护了一份可用集成的列表,您可以在其中看到我们维护的集成或社区贡献的集成。
集成页面专注于解释 Haystack 如何与该技术集成。例如,OpenAI 集成页面将提供 Haystack 和 OpenAI 如何协同工作的各种方式的摘要。
目前您可以选择的集成类型有:
- 模型提供商: 您可以看到我们如何与不同的模型提供商集成以及通过这些集成可用的组件。
- 文档存储: 这些是您可以在 Haystack 管道中使用的数据库和向量存储。
- 评估框架: Haystack 支持的、可用于评估 Haystack 管道的评估框架。
- 监控工具: 这些工具(如 Chainlit 和 Traceloop)与 Haystack 集成,并提供监控和可观察性功能。
- 数据摄取: 这些集成允许您从不同资源(如 Notion、Mastodon 等)摄取和使用数据。
- 自定义组件: 一些涵盖非常独特用例的集成通常由我们的社区成员贡献和维护。我们将这些集成列在“自定义组件”标签下。
如何使用集成?
每个集成页面都包含安装说明和基本使用说明。例如,OpenAI 集成页面提供了与 OpenAI 交互的不同方式的概述。
如何创建集成?
最常见的集成类型是自定义组件和文档存储。模型提供商之类的集成甚至可能包含多个自定义组件。请查看这些文档页面,它们将指导您完成每种集成类型的要求。
如何展示我的集成?
为了让您的集成对 Haystack 社区可见,请将其贡献到我们的 haystack-integrations GitHub 仓库。您需要遵循几项要求:
- 确保您的贡献已 打包、可安装且可运行。我们建议为此目的使用 hatch。
- 提供 GitHub 仓库和 issue 链接。
- 通过遵循 draft-integration.md,在 haystack-integrations 仓库中创建一个 Pull Request,并附上对您的集成是什么的清晰解释。此页面应包含:
- 安装说明
- 集成的组件列表
- 如何使用它的示例,包括清晰/可运行的代码
- 许可信息
- (可选)您为存储库生成的文档和/或 API 文档
更新于 7 个月前
