SiliconFLowCompatible with Milvus 2.6.x

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

Escolher um modelo de incorporação

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

Nome do modelo	Dimensões	Tokens máximos	Descrição
BAAI/bge-large-zh-v1.5	1,024	512	Um modelo de incorporação de texto chinês de grandes dimensões, que faz parte da série BGE (BAAI General Embedding).
BAAI/bge-large-en-v1.5	1,024	512	Um modelo de incorporação de texto em inglês de grandes dimensões, que faz parte da série BGE (BAAI General Embedding).
netease-youdao/bce-embedding-base_v1	768	512	Um modelo de incorporação bilingue e multilingue desenvolvido pela NetEase Youdao. O modelo apresenta um excelente desempenho em tarefas de representação e recuperação semântica em chinês e inglês, destacando-se especialmente em cenários multilingues.
BAAI/bge-m3	1,024	8,192	Um modelo de incorporação de texto multifuncional, multilingue e multi-granular. Suporta três funções de recuperação comuns: recuperação densa, recuperação multi-vetorial e recuperação esparsa.
Pro/BAAI/bge-m3	1,024	8,192	Um modelo de incorporação de texto multifuncional, multilingue e multi-granular. Suporta três funções de recuperação comuns: recuperação densa, recuperação multi-vetorial e recuperação esparsa. O modelo pode processar entradas em mais de 100 idiomas e é capaz de lidar com diferentes granularidades.

Configurar credenciais

O Milvus tem de saber a sua chave da API do SiliconFlow antes de poder pedir incorporações. O Milvus fornece dois métodos para configurar as credenciais:

• Ficheiro de configuração (recomendado): Armazene a chave da 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

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 mudando uma etiqueta.

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

   No mesmo ficheiro, aponte o fornecedor SiliconFlow para a etiqueta que pretende utilizar.

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

   Isto associa uma chave específica a cada pedido que o Milvus envia para o ponto final de incorporação do OpenAI.

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 apenas se não for encontrada nenhuma chave para o fornecedor em milvus.yaml.

Variável	Necessária	Descrição
MILVUSAI_SILICONFLOW_API_KEY	Sim	A sua chave de API SiliconFlow válida.

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

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

O bloco environment: injecta a chave apenas no contentor 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 (siliconflow_embedding) 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="siliconflow_embedding",                        # 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": "siliconflow",                # Must be set to "siliconflow"
        "model_name": "BAAI/bge-large-en-v1.5",    # Specifies the SiliconFlow embedding model to use
        # Optional parameters:
        # "credential": "apikey_dev",          # Optional: Credential label specified in milvus.yaml
        # "url": "https://api.siliconflow.cn/v1/embeddings",  # Defaults to the official endpoint if omitted
    }
)

# 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.