/ /

Indexes

Página inicial do Docs

/ /

Driver C#/ .NET

Indexes

Página inicial do Docs

Bibliotecas do cliente

Driver C#/ .NET

Indexes

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

Visão geral

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

MongoDB pesquisa: realize pesquisas rápidas e de texto completo
pesquisa vetorial MongoDB: Executa pesquisas semânticas (semelhança) em incorporações vetoriais

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

Observação

Os métodos de gerenciamento de índice de pesquisa do MongoDB Search são executados de forma assíncrona. Os métodos do driver podem retornar um resultado antes que a ação desejada seja concluída no servidor.

Este guia explica como executar as seguintes ações para gerenciar seus índices de pesquisa MongoDB e índices de pesquisa vetorial MongoDB:

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

Observação

Dados de amostra

Os exemplos deste guia usam a coleção embedded_movies no banco de dados sample_mflix , que é um dos conjuntos de dados de amostra do Atlas . Para obter instruções sobre como importar os dados de amostra do Atlas, consulte Carregar dados de amostra na documentação do Atlas.

Crie um modelo de índice de pesquisa

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

O CreateSearchIndexModel tem as seguintes propriedades:

Propriedade	Tipo	Descrição
`definition`	`BsonDocument`	Especifica a definição do índice. Se você omitir essa configuração, o driver criará um índice de pesquisa com mapeamentos dinâmicos.
`name`	`string`	Define o nome do índice. Se você omitir esta configuração, o driver definirá o nome para `default`.
`type`	`SearchIndexType`	Define o tipo de índice. Se você omitir essa configuração, o driver criará um índice de pesquisa por padrão.

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

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

Modelos de exemplo

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

O exemplo a seguir cria uma instância de CreateSearchIndexModel para fornecer especificações para um índice chamado vs_idx. O código especifica o caminho de incorporação como plot_embedding, indexa 1536 dimensões e utiliza a função de similaridade vetorial "euclidean":

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

You can create a MongoDB Search or MongoDB Vector Search index on a collection by calling the SearchIndexes.CreateOne() method on an IMongoCollection instance. This method accepts an index model as a parameter, specified in a CreateSearchIndexModel instance.

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"

Criar múltiplos índices de pesquisa

Você pode criar vários índices de pesquisa MongoDB e índices de pesquisa vetorial MongoDB 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.

Exemplo

Este exemplo executa as seguintes ações:

Cria uma instância CreateSearchIndexModel que especifica um índice de pesquisa chamado as_idx
Cria uma instância CreateSearchIndexModel que especifica um índice do MongoDB pesquisa vetorial chamado vs_idx
Passa um List de ambas as instâncias do CreateSearchIndexModel para o método SearchIndexes.CreateMany()
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 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 de pesquisa MongoDB e MongoDB Vector Search existentes de uma coleção chamando o método SearchIndexes.List() na coleção.

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": [...] }

Atualizar um Índice de Pesquisa

You can update a MongoDB Search or MongoDB Vector Search index by calling the SearchIndexes.Update() method on an IMongoCollection instance. This method accepts the following parameters:

Nome do índice a ser atualizado
Documento de definição de índice modificado

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

Excluir um índice de pesquisa

Você pode excluir um índice da MongoDB pesquisa ou da MongoDB pesquisa vetorial 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.

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

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 aprender mais sobre a pesquisa MongoDB, consulte a seguinte documentação do Atlas:

Para saber mais sobre MongoDB pesquisa vetorial, consulte a seguinte documentação do Atlas:

Documentação da API

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

Voltar

Indexes

Executar um comando de banco de dados