对于 AI 代理:可在 https://www.mongodb.com/zh-cn/docs/llms.txt 获取文档索引—通过在任何 URL 路径后添加 .md 可获取所有页面的 Markdown 版本。
Docs 菜单

为 MongoDB 向量搜索 自动嵌入配置 mongot

重要

自动嵌入功能在自管理mongot中处于预览阶段。在预览期间,该功能和相应文档可能会随时更改。要了解更多信息,请参阅预览功能。

本教程介绍如何在自管理 mongot 部署上配置自动嵌入。借助自动嵌入,mongot 可在索引时间为文本数据生成向量嵌入,在查询时间为查询文本生成向量嵌入。您无需在应用程序中维护独立的嵌入管道。

本教程适用于构建语义搜索或 RAG 功能并希望 mongot 管理嵌入的开发人员。关于 Kubernetes 操作符 的 MongoDB 控制器部署,请参阅 自动嵌入。

无自动嵌入,您的应用程序必须:

  1. 为插入或更新的每个文档生成嵌入。

  2. 将该嵌入与集合中的文档一起存储。

  3. 在查询时间使用相同模型为每个查询生成嵌入。

  4. $vectorSearch 提交查询嵌入。

借助自动嵌入,mongot 可以处理步骤 1、2 和 3。您的应用程序:

  1. 为文本字段配置具有 autoEmbed 字段类型的 MongoDB 向量搜索索引。

  2. 正常插入和更新文档。

    mongot 读取文本字段,通过配置的嵌入模型生成嵌入,并将其存储。

  3. 使用查询文本而非预计算嵌入来发出 $vectorSearch 查询。

    mongot 为查询文本生成嵌入。

自管理 mongot 自动嵌入与 Voyage AI 嵌入模型集成。

模型
说明

voyage-4

推荐。平衡一般文本搜索的性能。

voyage-4-lite

大容量、成本敏感的应用程序。

voyage-4-large

复杂语义关系的最高准确性。

voyage-code-3

专门用于代码搜索和技术文档。

您需要支付嵌入生成的费用。要学习更多信息,请参阅管理自动嵌入的计费。

要使用自动嵌入,您必须具备以下先决条件:

  • mongot 在自管理部署(Community tarball 或容器、本地开发和通过 Kubernetes 操作符的企业版)上使用 1.70.1 或更高版本。

  • 独立运行的实例部署的 MongoDB 8.2 或更高版本,或 Kubernetes 操作符托管部署的 MongoDB 8.3 或更高版本。要了解更多信息,请参阅 mongot 的兼容性和要求。

  • 两个 Voyage AI API 密钥。

    使用两个独立的密钥,一个用于索引时间嵌入生成,一个用于查询时间。独立密钥可以将查询工作负载与索引工作负载隔离,并允许独立的速率限制计费。要学习;了解更多信息,请参阅 速率限制。

  • mongot 到嵌入终结点的出站网络访问。

    默认终结点是 https://ai.mongodb.com/v1/embeddings。此终结点使用 MongoDB 托管的计费代理 Voyage AI,用于使用 Atlas 用户界面生成的密钥。如果您直接从 Voyage AI 生成了 API 密钥,也可以使用 https://api.voyageai.com/v1/embeddings 直接访问 Voyage AI。

1

您可以通过以下任一种方法生成 Voyage AI API 密钥:

  • (推荐)通过 Atlas 账户。Atlas 提供具有内置限速配置的 API 密钥管理。密钥不与 Atlas 集群绑定。要了解更多信息,请参阅 管理 API 密钥。

  • 通过 voyageai.com 直接访问 Voyage AI。

生成两个密钥并清楚命名,例如 mongot-prod-indexmongot-prod-query。将密钥存储在安全的秘密存储中。

2

配置取决于您的部署路径。选择部署的标签页

自动嵌入需要 preview 本地开发图像 (mongodb/mongodb-atlas-local:preview)。preview 图像包含 mongot 的 Community 构建,其中包括自动嵌入集成。

如果使用 docker run 直接启动容器,请使用 VOYAGE_API_KEY 环境变量传递 Voyage AI API 密钥,并使用 :preview 标签:

docker run \
-e VOYAGE_API_KEY=<your-voyage-api-key> \
-p 27017:27017 \
mongodb/mongodb-atlas-local:preview

如果您通过 Voyage AI 而非 Atlas 直接颁发了 Voyage AI 密钥,请覆盖默认终结点:

docker run \
-e VOYAGE_API_KEY=<your-voyage-api-key> \
-e EMBEDDING_PROVIDER_ENDPOINT=https://api.voyageai.com/v1/embeddings \
-p 27017:27017 \
mongodb/mongodb-atlas-local:preview

注意

本地开发只接受单个 Voyage AI API 密钥,并将其用于索引时和查询时的嵌入生成。单个密钥可用于开发。对于需要独立索引时和查询时密钥的生产部署,请使用 Community Edition 或 Kubernetes 操作符 部署路径。

embedding 块添加到 mongot 配置文件:

embedding:
queryKeyFile: /etc/mongot/secrets/voyage-api-query-key
indexingKeyFile: /etc/mongot/secrets/voyage-api-indexing-key
providerEndpoint: https://ai.mongodb.com/v1/embeddings

每个密钥文件只包含 API 密钥。将文件权限设置为 0600,并将文件所有者设置为运行 mongot 进程的用户。

3

使用 Voyage AI API 密钥配置 mongot后,定义使用 autoEmbed 字段类型的 MongoDB 向量搜索索引。索引定义指定哪些文本字段 mongot 嵌入和使用的模型。它还指定索引方法、量化和其他参数。

db.movies.createSearchIndex(
"movie-semantic-index",
"vectorSearch",
{
"fields": [
{
"type": "autoEmbed",
"modality": "text",
"path": "plot",
"model": "voyage-4",
"numDimensions": 1024,
"similarity": "cosine",
"indexingMethod": "hnsw",
"hnswOptions": {
"maxEdges": 16,
"numEdgeCandidates": 50
},
"quantization": "scalar"
},
{
"type": "filter",
"path": "genre"
}
]
}
)

下表描述了 autoEmbed 索引定义字段:

字段
用途

type: "autoEmbed"

将字段标记为自动嵌入。

modality: "text"

数据模态。text 是唯一支持的模态。

path

要嵌入的集合中的字段。

model

Voyage AI 模型名称。该模型必须是您的 API 密钥可以访问的模型。

numDimensions

嵌入向量的维数。该模型确定支持的维数。

similarity

用于向量搜索的相似度函数。支持的函数是 cosinedotProducteuclidean

indexingMethod

要使用的索引方法。支持的方法是 flathnsw

hnswOptions

(可选)HNSW 索引选项。如果 indexingMethodhnsw,则为必选。

quantization

(可选)要使用的量化类型。支持的类型有 floatscalarbinarybinaryNoRescore

您可以在同一索引中混合 autoEmbed 字段和 filter 字段。不能在同一路径上将 autoEmbed 与原始向量字段混合使用。每个字段选择一种方法。

4

提交查询文本,而不是预计算的嵌入。mongot 为您生成查询嵌入。

db.movies.aggregate([
{
"$vectorSearch": {
"index": "movie-semantic-index",
"path": "plot",
"query": "a heist gone wrong in a rainy city",
"model": "voyage-4",
"numCandidates": 100,
"limit": 10
}
},
{
"$project": {
"_id": 0,
"title": 1,
"score": { $meta: "vectorSearchScore" }
}
}
])

To learn more, see Run Vector Search ANN and ENN Queries.

mongot 将嵌入持久存储在集群上的专用内部数据库中。mongot 不会在源集合中存储嵌入。mongot 可以从源文本重新生成嵌入,并且您需要支付嵌入生成费用。

对嵌入模型、输出维度或量化的更改 trigger 受影响索引的完全重新嵌入,因此,您需支付嵌入生成费用。请参阅 mongot 重新生成嵌入时。

要了解更多,请参阅 生成的嵌入集合。

mongot 在发生以下任何情况时,会重新生成 autoEmbed 字段的嵌入:

  • 您插入一个文档。

  • 您更改文档中的嵌入字段。mongot 通过变更流检测到更改。

  • 您在索引定义中更改嵌入模型。

  • 您更改嵌入输出维度或数据类型。

  • 您更改了字段路径(Field Path)。

如果您更改任何后三个项,mongot 将从头开始重建整个索引。对于大型集合,重建成本可能很高。计划模型变更。

MongoDB 按模型特定费率按百万个令牌收费。索引费用与集合中索引字段的总文本量成正比。查询费用与查询文本量成正比。

如果您使用通过 Atlas 账户创建的 Voyage AI API 密钥,则可以在 Atlas 用户界面中查看 API 密钥使用情况和速率限制。要学习;了解更多信息,请参阅 管理 Embedding and Reranking API 的计费。如果您使用直接从 Voyage AI 创建的密钥,则必须在 Voyage AI 仪表盘中监控使用情况和速率限制。

Voyage AI 侧的速率限制错误会出现在 mongot 日志中,并作为受影响索引上的失败文档指示符。这些错误不会禁用索引,但会延迟新文档的索引。

症状
可能的原因
操作

索引在 PENDING 状态下保持几分钟。

mongot 无法访问嵌入终结点,或 API 密钥无效。

检查mongot日志中针对嵌入终结点的HTTP错误。

索引延迟会间歇性地出现。

Voyage AI 侧速率限制。

增加速率限制或减少索引时间嵌入负载。

针对索引的查询返回一个提及嵌入的错误。

查询 API 密钥无效或已过期。

验证 queryKeyFile 的内容。

对索引的所有查询都返回空结果。

索引可能已经重建,并仍在重新嵌入语料。

使用 db.collection.getSearchIndexes() 检查索引状态。

自动嵌入应用以下限制:

  • 预览状态。在自动嵌入普遍可用之前,配置形状、支持的模型和默认终结点可能会发生变化。

  • 每个字段一个嵌入模型。不支持混合模型索引。

  • 无嵌入模型故障转移。如果 Voyage AI 终结点无法访问,则新文档的索引将停滞。