运行MongoDB Vector Search 查询

Overview

在本指南中，您可以学习如何使用 Mongoid 运行 MongoDB 向量搜索查询。MongoDB 向量搜索允许您通过使用向量嵌入根据文档的语义含义查询文档。

Mongoid 提供 vector_search 方法，该方法可为您构建并运行 $vectorSearch 聚合阶段。要了解有关 $vectorSearch 聚合阶段的更多信息，请参阅 聚合操作指南。

要学习；了解有关MongoDB Vector Search 的更多信息，请参阅Atlas文档中的MongoDB Vector Search 概述。

先决条件

在运行 MongoDB 向量搜索查询之前，必须在模型上定义向量字段和向量搜索索引，然后在集合上创建索引。要了解如何声明和创建向量搜索索引，请参阅索引指南的 MongoDB 向量搜索索引部分。

本指南中的示例使用以下 Movie 模型，该模型映射到 sample_mflix 数据库中的 embedded_movies 集合。plot_embedding 字段存储每部电影情节的向量嵌入。

class Movie
  include Mongoid::Document
  store_in collection: "embedded_movies", database: "sample_mflix"
  field :title, type: String
  field :plot, type: String
  field :year, type: Integer
  field :plot_embedding, type: Array
  # Declare a vector search index on the `plot_embedding` field. The `_id`
  # and `year` filter fields enable instance-level and filtered queries.
  vector_search_index :plot_embedding_index,
    fields: [
      {
        type: "vector",
        path: "plot_embedding",
        numDimensions: 1536,
        similarity: "cosine"
      },
      {
        type: "filter",
        path: "_id"
      },
      {
        type: "filter",
        path: "year"
      }
    ]
end

运行向量搜索查询

要运行 MongoDB 向量搜索查询，请在模型上调用 vector_search 类方法，并将查询向量作为第一个参数传递。查询向量是表示搜索输入的向量嵌入。

以下代码示例在 plot_embedding 字段上运行 MongoDB 向量搜索查询，并打印每个匹配电影的标题。由于 Movie 模型只声明了一个向量搜索索引，因此 Mongoid 会自动选择要使用的索引和向量字段。

# The query vector must have the same number of dimensions as the
# vector search index (1536, in this example).
query_vector = [ -0.0016261312, -0.028070757, -0.011342932, ..., -0.009710136 ]
movies = Movie.vector_search(query_vector, limit: 5)
movies.each do |movie|
  puts movie.title
end

Thrill Seekers
About Time
The Time Machine
Timecop
Crusade in Jeans

vector_search 方法返回 Movie 文档的数组。默认情况下，它返回 10 个最相似的文档。要更改结果数量，请设置 limit 选项。上述示例指定了 5 个结果的限制。

movies = Movie.vector_search(query_vector, limit: 5)
movies.each do |movie|
  puts "#{movie.title}: #{movie.vector_search_score}"
end

Thrill Seekers: 0.9253387451171875
About Time: 0.9246978759765625
The Time Machine: 0.9229583740234375
Timecop: 0.9228057861328125
Crusade in Jeans: 0.9222259521484375

搜索类似文档

您还可以在文档实例上调用 vector_search 方法来查找与该文档类似的文档。当您在文档上调用 vector_search 时，Mongoid 会使用文档自身存储的向量作为查询向量，并从结果中排除文档本身。

以下代码可找到与现有 Movie 文档最相似的五部电影：

movie = Movie.find_by(title: "About Time")
neighbors = movie.vector_search(limit: 5)
neighbors.each do |neighbor|
  puts neighbor.title
end

Thrill Seekers
The Time Machine
Timecop
Crusade in Jeans
Frequency

向量搜索选项

您可以将以下关键字参数传递给 vector_search 方法以自定义查询：

以下代码运行 MongoDB 向量搜索查询，该查询考虑 150 个候选并仅返回在年份 2000 之后发布的电影：

movies = Movie.vector_search(
  query_vector,
  limit: 5,
  num_candidates: 150,
  filter: { year: { "$gt" => 2000 } }
)

To learn more about these options, see the Fields section of the $vectorSearch operator reference in the Atlas documentation.

更多信息

要了解如何声明和创建向量搜索索引，请参阅索引指南的 MongoDB 向量搜索索引部分。

要了解有关本指南中提到的概念的更多信息，请参阅 Atlas 文档中的以下页面：

• MongoDB Vector Search 概述

• 运行向量搜索查询

• 如何为向量搜索建立索引字段