SiliconFLowCompatible with Milvus 2.6.x
本主题介绍如何在 Milvus 中配置和使用 SiliconFLow Embedding Function。
选择 Embedding 模型
Milvus 支持 SiliconFLow 提供的 Embedding 模型。以下是当前可用的 SiliconFLow Embedding 模型，供快速参考：
| 模型名称
|
尺寸
|
最大令牌数
|
描述
| | --- | --- | --- | --- | |
BAAI/bge-large-zh-v1.5
|
1,024
|
512
|
大型中文文本 Embedding 模型，属于 BGE（BAAI 通用嵌入）系列。
| |
BAAI/bge-large-en-v1.5
|
1,024
|
512
|
大型英文文本 Embedding 模型，是 BGE（BAAI 通用嵌入）系列的一部分。
| |
netease-youdao/bce-embedding-base_v1
|
768
|
512
|
网易有道开发的双语和跨语言 Embedding 模型。该模型在中英文语义表示和检索任务中表现出色，尤其在跨语言场景中表现突出。
| |
BAAI/bge-m3
|
1,024
|
8,192
|
多功能、多语言、多粒度文本 Embedding 模型。它支持三种常见的检索功能：稠密检索、多向量检索和稀疏检索。
| |
Pro/BAAI/bge-m3
|
1,024
|
8,192
|
多功能、多语言、多粒度文本 Embedding 模型。它支持三种常见的检索功能：稠密检索、多向量检索和稀疏检索。该模型可处理 100 多种语言的输入，并能处理不同粒度的输入。
|
配置证书
Milvus 必须知道您的 SiliconFlow API 密钥，才能请求嵌入。Milvus 提供两种配置凭据的方法：
-
**配置文件（推荐）：**将 API 密钥存储在
milvus.yaml中，这样每次重启和节点都会自动获取它。 -
**环境变量：**在部署时注入密钥--最适合 Docker Compose。
从以下两种方法中选择一种--配置文件在裸机和虚拟机上更易于维护，而环境变量方法适合容器工作流。
如果同一提供商的 API 密钥同时存在于配置文件和环境变量中，Milvus 将始终使用milvus.yaml 中的值，而忽略环境变量。
选项 1：配置文件
将 API 密钥保存在milvus.yaml 中；Milvus 会在启动时读取它们，并覆盖同一提供商的任何环境变量。
-
**在
credential:你可以列出一个或多个 API 密钥--给每个密钥贴上你自创的标签，以便日后参考。
# milvus.yaml
credential:
apikey_dev: # dev environment
apikey: <YOUR_DEV_KEY>
apikey_prod: # production environment
apikey: <YOUR_PROD_KEY>把 API 密钥放在这里，可以让它们在重启时保持不变，而且只需更改标签就能切换密钥。
-
告诉 Milvus 调用服务时使用哪个密钥
在同一文件中，将 SiliconFlow 提供程序指向您希望它使用的标签。
function:
textEmbedding:
providers:
siliconflow:
credential: apikey_dev # ← choose any label you defined above
# url: https://api.siliconflow.cn/v1/embeddings # (optional) custom url这样，Milvus 向 OpenAI Embedding 端点发送的每个请求都会绑定特定密钥。
方案 2：环境变量
当你使用 Docker Compose 运行 Milvus，并希望不对文件和映像保密时，请使用这种方法。
只有在milvus.yaml 中找不到提供程序的密钥时，Milvus 才会使用环境变量。
| 变量
|
需要
|
描述
| | --- | --- | --- | |
MILVUSAI_SILICONFLOW_API_KEY
|
是
|
有效的 SiliconFlow API 密钥。
|
在docker-compose.yaml文件中，设置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>
environment: 块只将密钥注入 Milvus 容器，而不会触及主机操作系统。有关详情，请参阅使用 Docker Compose 配置 Milvus。
使用 Embedding 功能
配置凭证后，请按照以下步骤定义和使用 Embedding Function。
步骤 1：定义 Schema 字段
要使用 Embedding Function，请创建一个具有特定 Schema 的 Collection。此 Schema 必须至少包含三个必要字段：
-
主字段，用于唯一标识 Collection 中的每个实体。
-
标量字段，用于存储要嵌入的原始数据。
-
一个向量字段，用于存储函数将为标量字段生成的 Embedding。
下面的示例定义了一个 Schema 模式，其中一个标量字段"document" 用于存储文本数据，一个向量字段"dense" 用于存储将由函数模块生成的嵌入。切记设置向量维数 (dim) 以匹配所选 Embedding 模型的输出。
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)
第 2 步：向 Schema 添加 Embedding Function
Milvus 中的 Function 模块会自动将标量字段中存储的原始数据转换为嵌入数据，并将其存储到明确定义的向量字段中。
下面的示例添加了一个 Function 模块 (siliconflow_embedding)，该模块将标量域"document" 转换为嵌入，将得到的向量存储到之前定义的"dense" 向量域中。
定义好 Embedding Function 后，将其添加到 Collection Schema 中。这将指示 Milvus 使用指定的 Embedding Function 来处理和存储文本数据中的嵌入。
# 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)
下一步
配置好 Embedding Function 后，请参阅 "功能概述"，了解有关索引配置、数据插入示例和语义搜索操作的更多指导。