Índices de Vector Search do MongoDB

Visão geral

A Vector Search do MongoDB permite realizar pesquisas semânticas em incorporações vetoriais armazenadas no MongoDB Atlas. Antes de executar queries do MongoDB Vector Search , você deve criar índices que especifiquem quais campos indexar e como eles são indexados.

Para saber mais sobre a Vector Search do MongoDB , consulte a Visão geral da Vector Search do MongoDB na documentação da Vector Search do MongoDB .

auto db = client["sample_mflix"];
auto collection = db["movies"];

auto siv = collection.search_indexes();

Crie um índice de Vector Search do MongoDB

Para criar um único índice do MongoDB Vector Search em uma collection, chame o método create_one() em um objeto mongocxx::search_index_view e passe um objeto mongocxx::search_index_model especificando o índice que você deseja criar.

O construtor mongocxx::search_index_model exige os seguintes argumentos:

• name: string especificando o nome do seu índice

• definition: Documento especificando como configurar campos em seu índice

O exemplo a seguir mostra como criar um único índice do MongoDB Vector Search :

// Define the index model with an index name and a definition document
auto model = mongocxx::search_index_model(
  "<vectorSearchIndexName>",
  make_document(
      kvp("fields",
          make_array(make_document(
              kvp("type", "vector"),
              kvp("path", "<fieldName>"),
              kvp("numDimensions", 2048),
              kvp("similarity", "dotProduct"),
              kvp("quantization", "scalar"))))));
model.type("vectorSearch");
// Creates the vector search index
auto result = siv.create_one(model);
std::cout << "New vector search index name: " << result << std::endl;

New vector search index name: vector_search

O índice de pesquisa vetorial tem a seguinte definição:

• type: o tipo do índice é vectorSearch.

• path: O índice está no campo plot_embedding_voyage_3_large .

• numDimensions: o número de dimensões nas incorporações vetoriais é 2048.

• similarity: o índice mede a similaridade usando dotProduct similaridade.

• quantization: o índice usa quantização scalar.

Listar índices de Vector Search do MongoDB

Para listar todos os índices de pesquisa em uma coleção, chame o método list() em um objeto mongocxx::search_index_view. Este método retorna um objeto mongocxx::cursor que você pode usar para iterar sobre os índices MongoDB Vector Search e MongoDB Search da coleção.

O exemplo a seguir imprime uma lista de índices de pesquisa disponíveis na coleção especificada:

auto cursor = siv.list(); 
for (auto const& doc : siv.list()) {
    std::cout << bsoncxx::to_json(doc) << std::endl;
}

{ "id" : ..., "name" : "vector_index", "type" : "vectorSearch", ...,
  "latestDefinition" : {  "fields" : [ { "type" : "vector", "path" : "plot_embedding_voyage_3_large", "numDimensions" : 2048, ...}

Como alternativa, você pode listar um índice individual do MongoDB Vector Search passando um nome de índice para o método list(). Retorna um objeto mongocxx::cursor que aponta para um conjunto de resultados que contém apenas o índice especificado.

O exemplo a seguir utiliza o método list() para retornar o índice com o nome vector_index:

for (auto const& doc : siv.list("vector_index")) {
    std::cout << bsoncxx::to_json(doc) << std::endl;
}

{ "id" : ..., "name" : "vector_index", "type" : "vectorSearch", ...,
  "latestDefinition" : {  "fields" : [ { "type" : "vector", "path" : "plot_embedding_voyage_3_large", "numDimensions" : 2048, ...}

Atualizar um índice de Vector Search do MongoDB

Para atualizar um índice do MongoDB Vector Search , chame o método update_one() em um objeto mongocxx::search_index_view e passe o nome do índice que você deseja atualizar e a definição para a qual atualizar o índice.

O exemplo a seguir mostra como atualizar o índice MongoDB Vector Search existente do exemplo anterior Criar um índice de Vector Search para usar em euclidean vez de dotProduct similaridade e binary em vez de scalar quantização:

auto definition = make_document(
  kvp("fields",
      make_array(make_document(
          kvp("type", "vector"), kvp("path", "plot_embedding_voyage_3_large"),
          kvp("numDimensions", 2048), kvp("similarity", "euclidean"), 
          kvp("quantization", "binary")))));
siv.update_one("vector_index", definition.view());

Remover um índice do Vector Search do MongoDB

Para remover um índice do MongoDB Vector Search de uma coleção, chame o método drop_one() em um objeto mongocxx::search_index_view e passe o nome do índice que você deseja remover.

O exemplo seguinte mostra como remover um índice do MongoDB Vector Search denominado vector_index:

siv.drop_one("vector_index");

Informações adicionais

Para obter um aplicação de amostra que demonstra como gerenciar índices no driver C++ , consulte o guia Índices do .

Para obter guias mais detalhados sobre como usar o recurso MongoDB Vector Search e definir índices do MongoDB Vector Search , consulte as seguintes páginas de documentação do MongoDB Vector Search :

• Visão geral da Vector Search do MongoDB

• Início rápido da Vector Search do MongoDB