Fumadocs

Mixedbread

将 Mixedbread Search 与 Fumadocs 集成

介绍

Mixedbread 集成使用向量搜索为您的文档提供语义搜索功能。它将您的文档内容索引到向量存储中,使用户能够使用自然语言查询进行搜索,并基于含义而非仅关键词匹配找到相关内容。

设置

获取您的 API 密钥

  1. Mixedbread 注册
  2. 导航到 API Keys
  3. 创建一个新的 API 密钥并将其存储在您的环境变量中

创建向量存储

要同步您的文档,您需要创建一个向量存储:

  1. 在您的 Mixedbread 仪表板中转到 Vector Stores
  2. 为您的文档创建一个新的向量存储
  3. 复制向量存储 ID

同步文档

使用 Mixedbread CLI 同步您的文档:

安装 CLI:

npm install @mixedbread/cli -D

配置认证并同步您的文档:

# 配置认证
mxbai config keys add YOUR_API_KEY

# 同步您的文档
mxbai vs sync YOUR_VECTOR_STORE_ID "./content/docs"

CLI 将自动检测您的文档中的更改并相应更新向量存储。

工作流程

您可以通过将同步脚本添加到您的 package.json 来自动同步您的文档:

{
  "scripts": {
    "build": "... && mxbai vs sync YOUR_VECTOR_STORE_ID './content/docs' --ci"
  }
}

选项

标签过滤器

要按标签过滤搜索结果,请将标签字段添加到您的文档元数据中:

---
title: Mixedbread
description: 将 Mixedbread Search 与 Fumadocs 集成
url: /docs/headless/search/mixedbread
tag: docs
---

并更新您的搜索客户端:

  • Fumadocs UI:在搜索 UI 上启用 Tag Filter

  • Search Client:您可以像这样添加标签过滤器:

    import { useDocsSearch } from 'fumadocs-core/search/client';
    
    const { search, setSearch, query } = useDocsSearch({
      tag: '<your tag value>',
      // ...
    });

这允许您将搜索范围限定在文档的特定部分。

How is this guide?

Last updated on