Atlas Search e índices de Vector Search

Visão geral

Neste guia, você pode aprender como criar e gerenciar índices Atlas Search e Vector Search. Esses índices permitem usar as seguintes funcionalidades:

• Atlas Search: realize pesquisas rápidas de texto completo

• Atlas Vector Search: Executar pesquisas semânticas (semelhança) em incorporações vetoriais

Os índices do Atlas Search e Vector Search especificam quais campos indexar, especificam como esses campos são indexados e definem outras configurações opcionais.

Este guia explica como executar as seguintes ações para gerenciar seus índices do Atlas Search e Vector Search :

• Crie um modelo de índice de pesquisa

• Criar um índice de pesquisa

• Criar múltiplos índices de pesquisa

• Listar índices de pesquisa

• Atualizar um Índice de Pesquisa

• Excluir um índice de pesquisa

Crie um modelo de índice de pesquisa

Para criar um índice do Atlas Search ou Vector Search , você deve primeiro construir uma instância do CreateSearchIndexModel que define suas especificações de índice.

O CreateSearchIndexModel tem as seguintes propriedades:

Para saber mais sobre mapeamentos de campo do Atlas Search, consulte Definir mapeamentos de campo na documentação do Atlas.

Para saber mais sobre como definir índices do Atlas Vector Search, consulte Como indexar campos para o Vector Search na documentação do Atlas.

var def = new BsonDocument {
  { "mappings", new BsonDocument {
      { "dynamic", false },
      { "fields", new BsonDocument {
        { "title", new BsonDocument { {"type", "string" } } },
        { "released", new BsonDocument { { "type", "date" } } } } }
  } }
};
var indexModel = new CreateSearchIndexModel(
  "search_idx",
  SearchIndexType.Search,
  def
);

var def = new BsonDocument
{
    { "fields", new BsonArray
        {
            new BsonDocument
            {
                { "type", "vector" },
                { "path", "plot_embedding" },
                { "numDimensions", 1536 },
                { "similarity", "euclidean" }
            }
        }
    }
};
var indexModel = new CreateSearchIndexModel(
  "vs_idx",
  SearchIndexType.VectorSearch,
  def
);

Criar um índice de pesquisa

Você pode criar um índice do Atlas Search ou Vector Search em uma coleção chamando o método SearchIndexes.CreateOne() em uma instância IMongoCollection . Este método aceita um modelo de índice como um parâmetro, especificado em uma instância do CreateSearchIndexModel.

var indexModel = new CreateSearchIndexModel(
  "example_index",
  SearchIndexType.Search,
  new BsonDocument {
    { "mappings", new BsonDocument {
      { "dynamic", true },
    } }
  }
);
var result = movieCollection.SearchIndexes.CreateOne(indexModel);
Console.WriteLine("Created Atlas Search index:\n{0}", result);

Created Atlas Search index:
"example_index"

Criar múltiplos índices de pesquisa

Você pode criar vários índices do Atlas Search e Vector Search chamando o método SearchIndexes.CreateMany() em uma instância IMongoCollection. Este método aceita um IEnumerable de CreateSearchIndexModel instâncias como um parâmetro.

var searchModel = new CreateSearchIndexModel(
  "as_idx",
  SearchIndexType.Search,
  new BsonDocument {
    { "mappings", new BsonDocument {
      { "dynamic", true },
    } }
  }
);
var vectorModel = new CreateSearchIndexModel(
  "vs_idx",
  SearchIndexType.VectorSearch,
  new BsonDocument
  {
      { "fields", new BsonArray
          {
              new BsonDocument
              {
                  { "type", "vector" },
                  { "path", "plot_embedding" },
                  { "numDimensions", 1536 },
                  { "similarity", "euclidean" }
              }
          }
      }
  }
);
var models = new List<CreateSearchIndexModel> { searchModel, vectorModel };
var indexes = movieCollection.SearchIndexes.CreateMany(models);
Console.WriteLine("Created Search indexes:\n{0} {1}", indexes.ToArray());

Created Search indexes:
as_idx vs_idx

Listar índices de pesquisa

Você pode acessar informações sobre os índices existentes do Atlas Search e do Vector Search de uma coleção chamando o método SearchIndexes.List() na coleção.

var indexesList = movieCollection.SearchIndexes.List().ToList();
foreach (var i in indexesList)
{
  Console.WriteLine(i);
}

{ "id": "...", "name": "as_idx", "status": "READY", "queryable":
true, "latestDefinitionVersion": {...}, "latestDefinition": {
"mappings": { "dynamic": true } }, "statusDetail": [...] }
{ "id": "...", "name": "vs_idx", "type": "vectorSearch", "status":
"READY", "queryable": true, ..., "latestDefinition": { "fields": [{
"type": "vector", "path": "plot_embedding", "numDimensions": 1536,
"similarity": "euclidean" }] }, "statusDetail": [...] }

Atualizar um Índice de Pesquisa

Você pode atualizar um índice do Atlas Search ou Vector Search chamando o método SearchIndexes.Update() em uma instância IMongoCollection. Este método aceita os seguintes parâmetros:

• Nome do índice a ser atualizado

• Documento de definição de índice modificado

var updatedDef = new BsonDocument
{
    { "fields", new BsonArray
        {
            new BsonDocument
            {
                { "type", "vector" },
                { "path", "plot_embedding" },
                { "numDimensions", 1536 },
                { "similarity", "dotProduct" }
            }
        }
    }
};
movieCollection.SearchIndexes.Update("vs_index", updatedDef);

Excluir um índice de pesquisa

Você pode excluir um índice do Atlas Search ou Vector Search chamando o método SearchIndexes.DropOne() em uma instância IMongoCollection. Este método aceita o nome do índice a ser excluído como um parâmetro.

movieCollection.SearchIndexes.DropOne("example_index");

Informações adicionais

Para saber mais sobre outros índices que você pode criar usando o driver .NET/C#, consulte o guia Criar e gerenciar índices.

Para saber mais sobre o Atlas Search, consulte a seguinte documentação do Atlas:

• Práticas recomendadas do Atlas Search

• Ajustar o desempenho do Atlas Search

• Limitações do Atlas Search M0, M2 e M5

• FAQ: Atlas Search

Para aprender mais sobre o Atlas Vector Search, consulte a seguinte documentação do Atlas:

• Melhorar o desempenho da pesquisa vetorial

• Início rápido do Atlas Vector Search

• Como medir a precisão dos resultados da sua query