IA do VoyageCompatible with Milvus 2.6.x

Este tópico descreve como configurar e usar as funções de incorporação do Voyage AI no Milvus.

Escolher um modelo de incorporação

O Milvus suporta modelos de incorporação fornecidos pelo Voyage AI. Abaixo estão os modelos de incorporação atualmente disponíveis para referência rápida:

Nome do modelo	Dimensões	Máximo de Tokens	Descrição
voyage-3-large	1.024 (predefinição), 256, 512, 2.048	32,000	A melhor qualidade de recuperação para fins gerais e multilingue.
voyage-3	1,024	32,000	Optimizado para fins gerais e qualidade de recuperação multilingue. Consulte a publicação no blogue para obter mais informações.
voyage-3-lite	512	32,000	Optimizado para latência e custo. Consulte a postagem do blog para obter detalhes.
voyage-code-3	1.024 (padrão), 256, 512, 2.048	32,000	Optimizado para recuperação de código. Consulte a publicação no blogue para obter mais informações.
voyage-finance-2	1,024	32,000	Optimizado para recuperação de finanças e RAG. Consulte a publicação no blogue para obter mais informações.
voyage-law-2	1,024	16,000	Optimizado para recuperação jurídica e RAG. Também melhorou o desempenho em todos os domínios. Consulte a publicação no blogue para obter mais informações.
código de viagem-2	1,536	16,000	Optimizado para recuperação de código (17% melhor do que as alternativas) / Geração anterior de código incorporado. Consulte a publicação no blogue para obter mais informações.

Para obter detalhes, consulte Modelos de incorporação de texto.

Configurar credenciais

O Milvus precisa saber sua chave da API do Voyage AI antes de solicitar embeddings. O Milvus fornece dois métodos para configurar credenciais:

• Arquivo de configuração (recomendado): Armazene a chave de API em milvus.yaml para que cada reinicialização e nó a pegue automaticamente.

• Variáveis de ambiente: Injetar a chave no momento da implantação - ideal para o Docker Compose.

Escolha um dos dois métodos abaixo - o arquivo de configuração é mais fácil de manter em bare-metal e VMs, enquanto a rota env-var se encaixa nos fluxos de trabalho do contêiner.

Opção 1: Ficheiro de configuração (recomendado e de maior prioridade)

Manter as suas chaves API em milvus.yaml; o Milvus lê-as no arranque e substitui qualquer variável de ambiente para o mesmo fornecedor.

1. **Declare as suas chaves em credential:

   Pode listar uma ou várias chaves API - dê a cada uma delas uma etiqueta que invente e que referenciará mais tarde.

   # milvus.yaml
   credential:
     apikey_dev:            # dev environment
       apikey: <YOUR_DEV_KEY>
     apikey_prod:           # production environment
       apikey: <YOUR_PROD_KEY>    
   

   Colocar as chaves da API aqui torna-as persistentes através de reinicializações e permite-lhe mudar de chave apenas alterando uma etiqueta.

2. Diga ao Milvus qual chave usar para chamadas de serviço

   No mesmo ficheiro, aponte o fornecedor do Voyage AI para a etiqueta que pretende utilizar.

   function:
     textEmbedding:
       providers:
         voyageai:
           credential: apikey_dev      # ← choose any label you defined above
           # url: https://api.voyageai.com/v1/embeddings   # (optional) custom url
   

   Isso vincula uma chave específica a cada solicitação que o Milvus envia ao ponto de extremidade de embeddings do Voyage AI.

Opção 2: Variável de ambiente

Utilize este método quando executar o Milvus com o Docker Compose e preferir manter os segredos fora dos ficheiros e imagens.

O Milvus recorre à variável de ambiente somente se nenhuma chave para o provedor for encontrada em milvus.yaml.

Variável	Necessária	Descrição
MILVUSAI_VOYAGEAI_API_KEY	Sim	Sua chave válida da API do Voyage AI.

No seu ficheiro docker-compose.yaml, defina a variável de ambiente MILVUSAI_VOYAGEAI_API_KEY.

# docker-compose.yaml (standalone service section)
standalone:
  # ... other configurations ...
  environment:
    # ... other environment variables ...
    # Set the environment variable pointing to the Voyage AI API key inside the container
    MILVUSAI_VOYAGEAI_API_KEY: <MILVUSAI_VOYAGEAI_API_KEY>

O bloco environment: injecta a chave apenas no contentor do Milvus, deixando o seu SO anfitrião intacto. Para obter detalhes, consulte Configurar o Milvus com o Docker Compose.

Usar a função de incorporação

Depois que as credenciais forem configuradas, siga estas etapas para definir e usar funções de incorporação.

Etapa 1: definir campos de esquema

Para usar uma função de incorporação, crie uma coleção com um esquema específico. Este esquema deve incluir pelo menos três campos necessários:

• O campo primário que identifica de forma exclusiva cada entidade numa coleção.

• Um campo escalar que armazena os dados brutos a serem incorporados.

• Um campo vetorial reservado para armazenar as incorporações vectoriais que a função irá gerar para o campo escalar.

O exemplo seguinte define um esquema com um campo escalar "document" para armazenar dados textuais e um campo vetorial "dense" para armazenar incrustações a serem geradas pelo módulo Function. Não se esqueça de definir a dimensão do vetor (dim) para corresponder ao resultado do modelo de incorporação escolhido.

from pymilvus import MilvusClient, DataType, Function, FunctionType

# Initialize Milvus client
client = MilvusClient(
    uri="http://localhost:19530",
)

# Create a new schema for the collection
schema = client.create_schema()

# Add primary field "id"
schema.add_field("id", DataType.INT64, is_primary=True, auto_id=False)

# Add scalar field "document" for storing textual data
schema.add_field("document", DataType.VARCHAR, max_length=9000)

# Add vector field "dense" for storing embeddings.
# IMPORTANT: Set dim to match the exact output dimension of the embedding model.
schema.add_field("dense", DataType.FLOAT_VECTOR, dim=1024)

Passo 2: Adicionar a função de incorporação ao esquema

O módulo Function em Milvus converte automaticamente os dados brutos armazenados num campo escalar em embeddings e armazena-os no campo vetorial explicitamente definido.

O exemplo abaixo adiciona um módulo Function (voya) que converte o campo escalar "document" em embeddings, armazenando os vectores resultantes no campo vetorial "dense" definido anteriormente.

Depois de ter definido a sua função de incorporação, adicione-a ao seu esquema de coleção. Isto instrui o Milvus a utilizar a função de incorporação especificada para processar e armazenar os embeddings dos seus dados de texto.

# Define embedding function specifically for embedding model provider
text_embedding_function = Function(
    name="voya",                                  # Unique identifier for this embedding function
    function_type=FunctionType.TEXTEMBEDDING,     # Indicates a text embedding function
    input_field_names=["document"],               # Scalar field(s) containing text data to embed
    output_field_names=["dense"],                 # Vector field(s) for storing embeddings
    params={                                      # Provider-specific embedding parameters (function-level)
        "provider": "voyageai",                   # Must be set to "voyageai"
        "model_name": "voyage-3-large",                 # Specifies the embedding model to use
        # Optional parameters:
        # "credential": "apikey_dev",      # Optional: Credential label specified in milvus.yaml
        # "url": "https://api.voyageai.com/v1/embeddings",     # Defaults to the official endpoint if omitted
        # "dim": "1024"                           # Output dimension of the vector embeddings after truncation
        # "truncation": "true"                    # Whether to truncate the input texts to fit within the context length. Defaults to true.
    }
)

# Add the configured embedding function to your existing collection schema
schema.add_function(text_embedding_function)

Próximos passos

Depois de configurar a função de incorporação, consulte a Visão geral da função para obter orientações adicionais sobre a configuração do índice, exemplos de inserção de dados e operações de pesquisa semântica.