Importante
O embedding automatizado está em pré-visualização para mongot autogerenciado. O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de pré-visualização. Para **aprender** mais, consulte Recursos de pré-visualização.
Este tutorial descreve como configurar o embedding automatizado em uma implantação mongot autogerenciada. Com o embedding automatizado, o mongot gera embedding de vetor para seus dados de texto no momento do índice e para texto de query no momento da query. Você não precisa manter um pipeline de embedding separado em seu aplicativo.
Este tutorial é para desenvolvedores que estão criando recursos de pesquisa semântica ou RAG e desejam mongot gerenciar embedding. Para implantações do MongoDB Controllers for Kubernetes operador, consulte Automated embedding.
O que o embedding automatizado faz
Sem o embedding automatizado, seu aplicativo deve:
Gere um embedding para cada documento que você inserir ou atualizar.
Armazene esse embedding junto com o documento em sua coleção.
Gere um embedding para cada query, usando o mesmo modelo, no momento da query.
Envie o embedding de query para
$vectorSearch.
Com o embedding automatizado, mongot lida com as etapas 1, 2 e 3. Seu aplicativo:
Configura um índice de pesquisa vetorial do MongoDB com o tipo de campo
autoEmbedpara o campo de texto.Insere e atualiza documentos normalmente.
mongotlê o campo de texto, gera o embedding por meio do modelo de embedding configurado e o armazena.Emite query
$vectorSearchcom o texto da query, não um embedding pré-computado.mongotgera o embedding para o texto da query.
Provedores de embedding suportados
O embedding automatizado do mongot autogerenciado se integra aos modelos de embedding do Voyage AI.
Modelo | Descrição |
|---|---|
| Recomendado. Desempenho balanceado para pesquisa geral de texto. |
| Aplicativos de alto volume e sensíveis ao custo. |
| Máxima precisão para relacionamentos semânticos complexos. |
| Especificamente para pesquisa de código e documentação técnica. |
Você incorre em custos para geração de embedding. Para aprender mais, consulte Gerenciar Faturamento para embedding automatizado.
Pré-requisitos
Você deve ter os seguintes pré-requisitos para usar o embedding automatizado:
mongot1.70.1 ou posterior em uma implantação autogerenciada (tarball ou contêiner da Community, Desenvolvimento local e Enterprise Edition por meio do Kubernetes operador).MongoDB 8.2 ou posterior para implantações autônomas, ou MongoDB 8.3 ou posterior para implantações gerenciadas pelo Kubernetes operador. Para aprender mais, consulte Compatibilidade e requisitos para
mongot.Duas chaves de API do Voyage AI API.
Use duas chaves separadas, uma para geração de embedding em tempo de índice e outra para tempo de query. Chaves separadas isolam a carga de trabalho de query da carga de trabalho de indexação e permitem a contabilidade independente do limite de taxa. Para aprender mais, consulte Limites de taxa.
Acesso de rede de saída de
mongotpara o ponto de extremidade de embedding.O ponto de extremidade padrão é
https://ai.mongodb.com/v1/embeddings. Este ponto de extremidade proxy Voyage AI com faturamento gerenciado pelo MongoDB, para chaves geradas usando a IU do Atlas. Você também pode usarhttps://api.voyageai.com/v1/embeddingspara acesso direto ao Voyage AI se tiver gerado a chave API diretamente do Voyage AI.
Procedimento
Gerar chaves de API do Voyage AI.
Você pode gerar chaves de API do Voyage AI por meio de um dos seguintes métodos:
(Recomendado) Por meio de sua conta Atlas. O Atlas fornece gerenciamento de chaves de API com configuração de limite de taxa integrada. As chaves não estão vinculadas a um cluster Atlas. Para saber mais, consulte Gerenciar chaves de API.
Através do Voyage AI diretamente em voyageai.com.
Gere duas chaves e nomeie-as claramente, por exemplo, mongot-prod-index e mongot-prod-query. Armazene as chaves em armazenamento secreto seguro.
Configure mongot para embedding automatizado.
A configuração depende do seu caminho de implantação. Selecione a aba para sua implantação.
O embedding automatizado requer a imagem de Desenvolvimento local preview (mongodb/mongodb-atlas-local:preview). A imagem preview agrupa a criação da Community de mongot, que inclui a integração de embedding automatizado.
Se você iniciar o contêiner diretamente com docker run, passe a chave da API do Voyage AI com a variável de ambiente VOYAGE_API_KEY e use a tag :preview:
docker run \ -e VOYAGE_API_KEY=<your-voyage-api-key> \ -p 27017:27017 \ mongodb/mongodb-atlas-local:preview
Se você emitiu sua chave Voyage AI diretamente por meio do Voyage AI em vez do Atlas, substitua o ponto de extremidade padrão:
docker run \ -e VOYAGE_API_KEY=<your-voyage-api-key> \ -e EMBEDDING_PROVIDER_ENDPOINT=https://api.voyageai.com/v1/embeddings \ -p 27017:27017 \ mongodb/mongodb-atlas-local:preview
Observação
O Desenvolvimento local aceita apenas uma chave de API Voyage AI e a usa para geração de embedding no tempo de índice e no tempo de query. Uma única chave é aceitável para desenvolvimento. Para implantações de produção que precisam de chaves separadas no tempo de índice e no tempo de query, use o caminho de implantação Community Edition ou Kubernetes Operator.
Adicione o bloco embedding ao seu arquivo de configuração mongot:
embedding: queryKeyFile: /etc/mongot/secrets/voyage-api-query-key indexingKeyFile: /etc/mongot/secrets/voyage-api-indexing-key providerEndpoint: https://ai.mongodb.com/v1/embeddings
Cada arquivo de chave contém a chave API como seu único conteúdo. Defina as permissões do arquivo como 0600 e defina o proprietário do arquivo como o usuário que executa o processo mongot.
Crie um índice de embedding automatizado.
Depois de configurar o mongot com suas chaves de API Voyage AI , defina um índice de pesquisa vetorial MongoDB que usa o tipo de campo autoEmbed. A definição do índice especifica qual campo de texto mongot incorpora e qual modelo ele usa. Ele também especifica o método de indexação, quantização e outros parâmetros.
db.movies.createSearchIndex( "movie-semantic-index", "vectorSearch", { "fields": [ { "type": "autoEmbed", "modality": "text", "path": "plot", "model": "voyage-4", "numDimensions": 1024, "similarity": "cosine", "indexingMethod": "hnsw", "hnswOptions": { "maxEdges": 16, "numEdgeCandidates": 50 }, "quantization": "scalar" }, { "type": "filter", "path": "genre" } ] } )
A tabela a seguir descreve os campos de definição de índice autoEmbed:
Campo | Propósito |
|---|---|
| Marca o campo para embedding automático. |
| A modalidade de dados. |
| O campo em sua coleção para embedding. |
| O nome do modelo Voyage AI. O modelo deve ser um ao qual sua chave de API tenha acesso. |
| O número de dimensões para o vetor de embedding. O modelo determina as dimensões suportadas. |
| A função de similaridade a ser usada para pesquisa vetorial. As funções compatíveis são |
| O método de indexação a ser usado. Os métodos suportados são |
| (Opcional) As opções de índice HNSW. Obrigatório se |
| (Opcional) O tipo de quantização a ser usado. Os tipos suportados são |
Você pode misturar campos autoEmbed com campos filter no mesmo índice. Você não pode misturar autoEmbed com campos vetoriais brutos no mesmo caminho. Escolha uma abordagem por campo.
Executar uma query de embedding automatizada.
Envie texto de query, não um embedding pré-computado. mongot gera o embedding de query para você.
db.movies.aggregate([ { "$vectorSearch": { "index": "movie-semantic-index", "path": "plot", "query": "a heist gone wrong in a rainy city", "model": "voyage-4", "numCandidates": 100, "limit": 10 } }, { "$project": { "_id": 0, "title": 1, "score": { $meta: "vectorSearchScore" } } } ])
To learn more, see Run Vector Search ANN and ENN Queries.
Armazenamento de embedding
mongot persiste embedding em um banco de dados interno dedicado no cluster. mongot não armazena embedding em sua coleção de origem. mongot pode regenerar embedding do texto de origem, e você incorre em cobranças pela geração de embedding.
Alterações no modelo de embedding, dimensões de saída ou quantização trigger um re-embedding completo do índice afetado, para o qual você incorre em cobranças pela geração de embedding. Consulte Quando mongot regenera embeddings.
Para aprender mais, consulte Coleção de embedding gerado.
Quando mongot regenera embeddings
mongot regenera embedding para um campo autoEmbed quando ocorre qualquer um dos seguintes:
Você insere um documento.
Você altera o campo incorporado em um documento.
mongotdetecta a alteração por meio de fluxos de alteração.Você altera o modelo de embedding na definição do índice.
Você altera a dimensão de saída do embedding ou o tipo de dados.
Você altera o caminho do campo de texto.
Se você alterar qualquer um dos três últimos itens, mongot reconstrói todo o índice do zero. A reconstrução pode ser cara para grandes coleções. Planeje as alterações do modelo deliberadamente.
Custo e limitação de taxa
O MongoDB cobra por milhão de tokens em taxas específicas do modelo. O custo de indexação é proporcional ao volume total de texto do campo indexado em toda a coleção. O custo da query é proporcional ao volume de texto da query.
Se você usar a chave de API do Voyage AI que você criou usando sua conta do Atlas, poderá visualizar o uso da chave de API e os limites de taxa na IU do Atlas. Para saber mais, consulte Gerenciar faturamento para a Embedding and Reranking API. Se você usar chaves criadas diretamente do Voyage AI, deverá monitorar seu uso e limites de taxa no dashboard do Voyage AI.
Os erros de limite de taxa do lado do Voyage AI aparecem nos logs do mongot e como indicadores de documento com falha no índice afetado. Esses erros não desativam o índice, mas podem atrasar a indexação de novos documentos.
Modos de falha
Problema | Provável Causa | em ação |
|---|---|---|
O índice permanece no status |
| Verifique os logs |
Atrasos na indexação aparecem intermitentemente. | Limitação de taxa do lado da Voyage IA. | Aumente seu limite de taxa ou reduza a carga de embedding no tempo de indexação. |
As query contra o índice retornam um erro que menciona embedding. | A chave API da query é inválida ou expirou. | Verifique o conteúdo de |
Todas as query em relação ao índice retornam resultados vazios. | O índice pode ter sido recriado e ainda está re-embedding o corpus. | Verifique o status do índice com |
Limitações
As seguintes limitações se aplicam ao embedding automatizado:
**Status de pré-visualização.** O formato da configuração, os modelos compatíveis e os pontos de extremidade padrão podem mudar antes que o Automated Embedding esteja geralmente disponível.
Um modelo de embedding por campo. Índices de modelo misto não são suportados.
Sem failover de modelo de embedding. Se o ponto de extremidade do Voyage AI estiver inacessível, a indexação de novos documentos será interrompida.
Próximos passos
Visão geral do embedding automatizado para a visão geral conceitual entre plataformas.
Configure o mongot para a referência de configuração
mongotcompleta.