👩🏻‍🍳 Haystack 烹饪书

🧑‍🍳🍳 在 这里 发现 Haystack 烹饪书

这是一系列使用 Haystack 的示例笔记本 💚

这些示例可以作为使用不同模型提供商、向量数据库、检索技术、新实验性功能等与 Haystack 配合使用的指南。大多数示例都展示了一个具体的小型演示。

如需了解更多关于 如何 使用 Haystack 的信息，请访问我们的 文档 和官方 教程。

此外，您也可以参考我们的 博客，那里还有更多示例。

参与贡献 Haystack 烹饪书

如果您有一个使用 Haystack 的示例，可以通过创建 PR 将其添加到此仓库中。

您也可以直接从 Colab 创建 PR：先 Fork 此仓库，然后在 Colab 中选择“保存副本到 GitHub”。将您的示例添加到您的 Fork 后，即可在此仓库中创建 PR。

1. 将您的笔记本添加到 /notebooks 文件夹
2. 为文件命名时，请使用具有描述性的名称，包含（如果适用）所用的模型提供商、数据库、技术以及示例中完成的任务等信息。
3. 务必将其添加到 index.toml 文件中，包括标题和主题。如果笔记本使用了实验性功能，还需添加讨论链接，并设置 experimental = true 字段。

Haystack Cookbook 快速上手指南

Haystack Cookbook 是 deepset 官方维护的示例代码库，汇集了使用 Haystack 构建的各种实用 Notebook。这些示例涵盖了不同的模型提供商、向量数据库、检索技术及实验性功能，是开发者学习如何组合组件构建生产级 AI 应用的绝佳参考。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux, macOS 或 Windows (推荐 WSL2)
• Python 版本：3.8 及以上 (推荐 3.9 - 3.11)
• 前置依赖：
  • pip 包管理工具
  • git (用于克隆仓库)
  • jupyter 或 jupyterlab (用于运行 Notebook)

提示：建议创建独立的虚拟环境（如使用 venv 或 conda）以避免依赖冲突。

安装步骤

1. 克隆仓库

首先，将 Haystack Cookbook 仓库克隆到本地：

git clone https://github.com/deepset-ai/haystack-cookbook.git
cd haystack-cookbook

国内加速方案：如果访问 GitHub 较慢，可使用国内镜像源克隆：

git clone https://gitee.com/mirrors/haystack-cookbook.git
# 注意：需确认 Gitee 镜像是否同步最新，若不同步建议使用官方源配合代理

2. 安装核心依赖

进入目录后，安装运行示例所需的基础依赖。由于不同 Notebook 可能依赖不同的模型后端（如 Transformers, OpenAI, Cohere 等），建议先安装 Haystack 核心库及 Jupyter 环境：

pip install jupyterlab
pip install farm-haystack[all]

国内镜像加速：推荐使用清华或阿里镜像源加速安装：

pip install jupyterlab -i https://pypi.tuna.tsinghua.edu.cn/simple
pip install farm-haystack[all] -i https://pypi.tuna.tsinghua.edu.cn/simple

注：具体某个 Notebook 可能需要额外的特定库（如 pinecone-client, elasticsearch 等），请在运行对应文件前查看该 Notebook 顶部的安装说明单元格。

基本使用

Cookbook 中的每个文件都是一个独立的 Jupyter Notebook，展示了特定的功能场景。以下是运行最简单示例的流程：

1. 启动 Jupyter Lab

在项目根目录下启动服务：

jupyter lab

2. 选择并运行示例

浏览器会自动打开 Jupyter 界面。导航至 /notebooks 文件夹，选择一个感兴趣的示例（例如 rag_with_transformers.ipynb 或涉及特定数据库的示例）。

3. 执行代码

打开 Notebook 后：

1. 阅读开头的介绍性 Markdown 单元格，了解该示例的目标。
2. 依次点击代码单元格左侧的 Play 按钮（或按 Shift + Enter）执行代码。
3. 大多数示例包含数据加载、管道构建（Pipeline）、索引创建和查询执行的完整流程。

最小化代码示例逻辑（参考典型 RAG 示例）：

from haystack import Pipeline
from haystack.components.generators import HuggingFaceLocalGenerator
from haystack.components.retrievers.in_memory import InMemoryEmbeddingRetriever
# ... 其他组件导入

# 构建简单的生成式检索管道
pipe = Pipeline()
# 添加组件逻辑...

# 运行查询
result = pipe.run({"query": "Haystack 是什么？"})
print(result)

通过修改这些 Notebook 中的参数或替换组件（例如将本地模型替换为 OpenAI API），您可以快速验证不同技术栈在您业务场景下的表现。