使用 Hugging Face Inference Endpoints 进行语义搜索

本指南将引导你完成使用 Meilisearch REST embedder 和 Hugging Face Inference Endpoints 设置以启用语义搜索功能的过程。

要遵循本指南，你需要：

• 一个运行版本 >=1.13 的 Meilisearch Cloud 项目
• 一个拥有已部署 inference endpoint 的 Hugging Face 帐户
• 你的 Hugging Face 帐户上已部署模型的 endpoint URL 和 API 密钥

使用 update settings endpoint 设置 embedder

{
  "hf-inference": {
    "source": "rest",
    "url": "ENDPOINT_URL",
    "apiKey": "API_KEY",
    "dimensions": 384,
    "documentTemplate": "CUSTOM_LIQUID_TEMPLATE",
    "request": {
      "inputs": ["{{text}}", "{{..}}"],
      "model": "baai/bge-small-en-v1.5"
    },
    "response": ["{{embedding}}", "{{..}}"]
  }
}

在此配置中：

• source：声明 Meilisearch 应通过其 REST API 连接到此 embedder
• url：将 ENDPOINT_URL 替换为你的 Hugging Face 模型 endpoint 的地址
• apiKey：将 API_KEY 替换为你的 Hugging Face API 密钥
• dimensions：指定嵌入的维度，对于 baai/bge-small-en-v1.5 为 384
• documentTemplate：一个可选但推荐的 模板，用于你将发送给 embedder 的数据
• request：定义 Meilisearch 将发送给 embedder 的请求的结构和参数
• response：定义 embedder 响应的结构

配置 embedder 后，Meilisearch 将自动为你的文档生成嵌入。使用 Cloud UI 或 get task endpoint 监控任务。

设置 embedder 后，你现在可以执行语义搜索。使用 hybrid 搜索参数发出搜索请求，并将 semanticRatio 设置为 1

{
  "q": "QUERY_TERMS",
  "hybrid": {
    "semanticRatio": 1,
    "embedder": "hf-inference"
  }
}

在此请求中：

• q：搜索查询
• hybrid：启用 AI 驱动的搜索功能
  • semanticRatio：控制语义搜索和全文搜索之间的平衡。将其设置为 1 意味着你将仅收到语义搜索结果
  • embedder：用于生成嵌入的 embedder 的名称

你已使用 Hugging Face Inference Endpoints 设置了 embedder。这使你可以在你的应用程序中使用纯语义搜索功能。

有关其他 embedder 配置选项的更多信息，请查阅 embedder 设置文档。