Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.
Menu Docs

Configurar embedding automatizado para pesquisa vetorial

Observação

A incorporação automatizada está em visualização para mongot no cluster Kubernetes. O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para saber mais, consulte Visualizar recursos.

Esta página descreve como configurar o embedding automatizado na sua implantação Kubernetes da pesquisa vetorial. A funcionalidade de embedding automatizado na pesquisa vetorial gera embedding vetorial para os seus dados de texto no momento do índice e para o texto da query no momento da query. Portanto, você não precisa manter um pipeline de embedding separado no seu aplicativo.

Este tutorial é para desenvolvedores que estão criando recursos de pesquisa semântica ou RAG e desejam que mongot gerencie embeddings.

Sem o embedding automatizado, seu aplicativo deve:

  1. Gere um embedding para cada documento que você inserir ou atualizar.

  2. Armazene esse embedding junto com o documento em sua coleção.

  3. Gere um embedding para cada query, usando o mesmo modelo, no momento da query.

  4. Envie o embedding de query para $vectorSearch.

Com o embedding automatizado, o processo mongot lida com as etapas 1, 2 e 3. Seu aplicativo:

  1. Configura um índice de pesquisa vetorial com o tipo de campo autoEmbed para o campo de texto.

  2. Insere e atualiza documentos normalmente. Em seguida, mongot lê o campo de texto, gera o embedding por meio do modelo de embedding configurado e o armazena.

  3. Emite $vectorSearch query com o texto da query, não um embedding pré-calculado. Em seguida, mongot gera o embedding para o texto da query.

O embedding automatizado do mongot autogerenciado se integra aos modelos de embedding do Voyage AI.

Modelo
Descrição

voyage-4-lite

Aplicativos de alto volume e sensíveis ao custo.

voyage-4

Recomendado. Desempenho balanceado para pesquisa geral de texto.

voyage-4-large

Máxima precisão para relacionamentos semânticos complexos.

voyage-code-3

Especificamente para pesquisa de código e documentação técnica.

Você incorre em custos para a geração de incorporação. Para saber mais, consulte Gerenciar o faturamento da incorporação automatizada.

  • mongot 1.70.1 ou posterior em sua implantação do Kubernetes.

  • MongoDB 8.3 ou posterior.

  • Duas chaves de API do Voyage AI.

    Use duas chaves separadas, uma para geração de incorporação em tempo de índice e outra para tempo de query. Chaves separadas isolam o volume de trabalho de query do volume de trabalho de indexação e permitem uma contabilização independente do limite de taxa. Para saber mais, consulte Limites de taxa.

  • Acesso de rede de saída de mongot para o ponto de extremidade de embedding.

    O endpoint padrão é https://ai.mongodb.com/v1/embeddings, que procura a Voyage AI com o faturamento gerenciado MongoDB, para chaves geradas usando a UI do Atlas . Você também pode usar https://api.voyageai.com/v1/embeddings para acesso direto à Voyage AI se tiver gerado a chave de API diretamente da Voyage AI.

Você pode gerar chaves de API do Voyage AI por meio de um dos seguintes caminhos:

  • (Recomendado) Por meio de sua conta Atlas . O Atlas oferece gerenciamento de chaves de API com configuração integrada de limite de taxa. As chaves não estão vinculadas a um Atlas cluster. Para saber mais, consulte Gerenciar chaves de API.

  • Por meio da Voyage AI diretamente em routeai.com.

Gere duas chaves e nomeie-as claramente, por exemplo, mongot-prod-index e mongot-prod-query. Armazene as chaves em armazenamento secreto seguro.

Crie um secret do Kubernetes com ambas as chaves:

kubectl create secret generic voyage-api-keys \
--from-literal=indexing-key=<your-index-key> \
--from-literal=query-key=<your-query-key> \
--namespace=<your-namespace>

Referencie-o a partir do recurso personalizado do MongoDBSearch:

apiVersion: mongodb.com/v1
kind: MongoDBSearch
metadata:
name: mdbs
spec:
# ...
autoEmbedding:
embeddingModelAPIKeySecret:
name: voyage-api-keys

Opcionalmente, defina spec.autoEmbedding.providerEndpoint para substituir o ponto de extremidade de embedding que mongot usa. Quando você omite este campo, mongot usa seu ponto de extremidade padrão integrado, https://ai.mongodb.com/v1/embeddings. Para saber mais, consulte Especificação de recurso do MongoDBSearch.

Depois de configurar o mongot com as chaves da API do Voyage AI, defina um índice do Vector Search que use o tipo de campo autoEmbed. A definição de índice especifica qual campo de texto mongot incorpora, qual modelo ele usa, o método de indexação, a quantização e outros parâmetros. Para saber mais sobre a definição do índice autoEmbed, consulte Campos do índice de Vector Search do MongoDB .

kubectl exec --context "${K8S_CTX}" -n "${MDB_NS}" mongodb-tools-pod -- \
mongosh --quiet "${MDB_CONNECTION_STRING}" \
--eval "use sample_mflix" \
--eval 'db.movies.createSearchIndex("vector_auto_embed_index", "vectorSearch",
{ "fields": [ {
"type": "autoEmbed",
"modality": "text",
"path": "plot",
"model": "'"${EMBEDDING_MODEL}"'",
"numDimensions": 1024,
"similarity": "cosine",
"quantization": "scalar",
"indexingMethod": "hnsw",
"hnswOptions": {
"maxEdges": 16,
"numEdgeCandidates": 200
}
} ] });'

A tabela a seguir descreve os campos de definição de índice autoEmbed:

Campo
Propósito

type: "autoEmbed"

Marca o campo para embedding automático.

modality: "text"

A modalidade de dados. text é a única modalidade suportada.

path

O campo em sua coleção para embedding.

model

O nome do modelo da Voyage AI. O modelo deve ser aquele ao qual sua chave de API tenha acesso.

numDimensions

O número de dimensões para o vetor de embedding. O modelo determina as dimensões suportadas.

similarity

A função de similaridade a ser usada para pesquisa vetorial. As funções compatíveis são cosine, dotProduct e euclidean.

indexingMethod

O método de indexação a ser usado. Os métodos suportados são flat e hnsw.

hnswOptions

(Opcional) As opções de índice HNSW. Obrigatório se indexingMethod for hnsw.

quantization

(Opcional) O tipo de quantização a ser usado. Os tipos suportados são float, scalar, binary e binaryNoRescore.

Você pode misturar campos autoEmbed com campos filter no mesmo índice. Você não pode misturar autoEmbed com campos vetoriais brutos no mesmo caminho.

Envie texto de query, não um embedding pré-computado. mongot gera o embedding de query para você.

kubectl exec --context "${K8S_CTX}" -n "${MDB_NS}" mongodb-tools-pod -- \
mongosh --quiet "${MDB_CONNECTION_STRING}" \
--eval "use sample_mflix" \
--eval 'db.movies.aggregate([ {
$vectorSearch: {
index: "vector_auto_embed_index",
path: "plot",
query: "spy thriller",
numCandidates: 150,
limit: 10
}
}, {
$project: {
_id: 0,
plot: 1,
title: 1,
score: { $meta: "vectorSearchScore" }
}
}]);'

Para saber mais, consulte Executar queries ANN e ENN do Vector Search .

mongot persiste embedding em um banco de dados interno dedicado no cluster do Kubernetes. 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 incorporação, nas dimensões de saída ou na quantização acionam uma nova incorporação completa do índice afetado. Você incorre em cobranças pela recuperação. Para saber mais, consulte Quando mongot Regenera Incorporações.

Para saber mais, consulte Coleção de incorporações geradas.

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. mongot detecta 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.

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 Voyage AI que você criou usando sua conta do Atlas , poderá visualizar o uso da chave de API e os limites de taxa na UI do Atlas . Para saber mais, consulte Gerenciar faturamento para a API de incorporação e reclassificação. Se você usar chaves criadas diretamente da Voyage AI, deverá monitorar seu uso e limites de taxa no dashboard da 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.

Problema
Provável Causa

O índice permanece no status PENDING por alguns minutos.

mongot não é possível alcançar o endpoint de incorporação ou a chave de API é inválida. Verifique os logs mongot em busca de erros de HTTP em relação ao endpoint de incorporação.

Atrasos na indexação aparecem intermitentemente.

Limitação de taxa do lado da IA da Voyage. Aumente o 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 de API de query é inválida ou expirou. Verifique o conteúdo de queryKeyFile.

Todas as query em relação ao índice retornam resultados vazios.

O índice pode ter sido reconstruído e ainda está re-embedding o corpus. Verifique o status do índice com db.collection.getSearchIndexes().

  • **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.