Índices de Pesquisa do MongoDB e Índices de Pesquisa Vetorial do MongoDB

Modelo de MongoDB Search índice

Para criar um índice do MongoDB Search, você deve construir uma instância do CreateSearchIndexModel que defina suas especificações de índice.

A classe CreateSearchIndexModel tem as seguintes propriedades:

O exemplo seguinte cria uma instância CreateSearchIndexModel para fornecer especificações para um índice denominado search_idx. O código especifica mapeamentos estáticos dos campos title e released:

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
);

Para saber mais sobre mapeamentos de campo do MongoDB pesquisa, veja Definir mapeamentos de campo na documentação do Atlas.

Modelo de índice de MongoDB Vector Search

Para criar um índice do MongoDB Vector Search, você deve construir uma instância do CreateVectorSearchIndexModel que defina suas especificações de índice.

A classe CreateVectorSearchIndexModel herda da classe CreateSearchIndexModel e tem as seguintes propriedades adicionais:

O exemplo seguinte cria uma instância CreateVectorSearchIndexModel para fornecer especificações para um índice denominado vs_idx. O código especifica o caminho de incorporação como PlotEmbedding, uma propriedade de classe que corresponde ao campo plot_embedding em MongoDB. Ele também indexa 1536 dimensões e usa a função de similaridade vetorial Euclidean.

var model = new CreateVectorSearchIndexModel<Movie> (
  model => model.PlotEmbedding,
  "vs_idx",
  VectorSimilarity.Euclidean,
  1536);

Para saber mais sobre como definir índices de pesquisa vetorial do MongoDB, consulte Como indexar campos para pesquisa vetorial na documentação do Atlas.

Modelo de índice de pesquisa com incorporação automática do MongoDB

Você pode utilizar um modelo de índice CreateAutoEmbeddingVectorSearchIndexModel para criar um índice MongoDB Vector Search que gera automaticamente incorporações vetoriais para campos de texto.

O CreateAutoEmbeddingVectorSearchIndexModel tem as seguintes propriedades, além das propriedades herdadas de CreateVectorSearchIndexModelBase<TDocument>:

O exemplo seguinte cria uma instância do CreateAutoEmbeddingVectorSearchIndexModel que fornece especificações para um índice denominado auto_embedded_index. Esse índice usa o modelo de incorporação "voyage-4" para gerar automaticamente incorporações vetoriais para o campo plot e também inclui filtros opcionais para os campos runtime e year:

var model = new CreateAutoEmbeddingVectorSearchIndexModel<EmbeddedMovie>(
  m => m.Plot,
  "auto_embedding_index",
  "voyage-4",
  m => m.Runtime, m => m.Year  // Optional filter fields
);

Exemplo

O exemplo a seguir cria um índice de pesquisa MongoDB na coleção embedded_movies. O código cria um CreateSearchIndexModel que define o nome do índice e habilita o mapeamento dinâmico. Em seguida, o código passa a instância CreateSearchIndexModel para o método SearchIndexes.CreateOne() para criar o índice de pesquisa MongoDB :

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

Created MongoDB Search index:
"example_index"

Exemplo

Este exemplo executa as seguintes ações:

1. Cria uma instância CreateSearchIndexModel que especifica um índice de pesquisa chamado as_idx

2. Cria uma instância CreateVectorSearchIndexModel que especifica um índice do MongoDB pesquisa vetorial chamado vs_idx

3. Passa um List das instâncias CreateSearchIndexModel e CreateVectorSearchIndexModel para o método SearchIndexes.CreateMany()

4. Cria os índices de pesquisa MongoDB Search e MongoDB Vector Search na coleção embedded_movies

var searchModel = new CreateSearchIndexModel(
  "as_idx",
  SearchIndexType.Search,
  new BsonDocument {
    { "mappings", new BsonDocument {
      { "dynamic", true },
    } }
  }
);
var vectorModel = new CreateVectorSearchIndexModel<Movie>(
  m => m.PlotEmbedding,
  "vs_idx",
  VectorSimilarity.Euclidean,
  1536);
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

Exemplo

O exemplo a seguir acessa informações sobre os índices de pesquisa MongoDB e os índices de pesquisa vetorial MongoDB criados na Criar vários índices de pesquisa desta página. O código chama o método SearchIndexes.List() e imprime uma lista dos índices de pesquisa MongoDB pesquisa e MongoDB Vector pesquisa 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": [...] }

Exemplo

O exemplo a seguir atualiza o índice do Vector Search denominado vs_index criado na seção Criar vários índices de pesquisa desta página. O código cria um novo documento de definição de índice que instrui o índice a usar "dotProduct" como a função de similaridade vetorial. Em seguida, o código chama o método SearchIndexes.Update() para atualizar o índice:

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

Exemplo

O exemplo seguinte excluir o índice de pesquisa do MongoDB denominado example_index criado na seção Criar um Índice de Pesquisa desta página. O código passa o nome do índice para o método SearchIndexes.DropOne() para excluir o índice:

movieCollection.SearchIndexes.DropOne("example_index");

Documentação da API

Para saber mais sobre os métodos e tipos mencionados neste guia, consulte a documentação da API abaixo:

• CriarModelodeÍndice de Pesquisa

• SearchIndexType

• CreateOne()

• CreateMany()

• List()

• Update()

• DropOne()