OpenAICompatible with Milvus 2.6.x

通过选择一个模型并用你的 OpenAI API 密钥配置 Milvus，使用 Milvus 的 OpenAI 嵌入模型。

选择嵌入模型

Milvus 支持 OpenAI 提供的所有嵌入模型。以下是当前可用的 OpenAI 嵌入模型，供快速参考：

模型名称	尺寸	最大令牌数	描述
text-embedding-3-small	默认：1,536（可缩短至低于 1,536 的尺寸大小）	8,191	成本敏感型和可扩展语义搜索的理想选择--以较低的价格提供较强的性能。
文本-Embeddings-3-大号	默认：3,072（可缩短至尺寸小于 3,072）	8,191	最适合要求提高检索准确性和丰富语义表述的应用。
text-embedding-ada-002	固定：1,536（无法缩短）	8,191	上一代模型，适合需要向后兼容的传统管道或场景。

第三代嵌入模型（text-embedding-3）支持通过dim 参数减小嵌入的大小。通常情况下，从计算、内存和存储的角度来看，较大的嵌入会更加昂贵。通过调整维数，可以更好地控制总体成本和性能。有关每种模型的更多详情，请参阅Embeddings 模型和OpenAI 公告博文。

配置证书

Milvus 必须知道您的 OpenAI API 密钥，才能请求嵌入。Milvus 提供两种配置凭据的方法：

• 配置文件（推荐）：将 API 密钥存储在milvus.yaml 中，以便每次重启和节点都能自动获取。

• 环境变量：在部署时注入密钥--最适合 Docker Compose。

从以下两种方法中选择一种--配置文件在裸机和虚拟机上更易于维护，而环境变量方法适合容器工作流。

选项 1：配置文件（推荐且优先级更高）

将 API 密钥保存在milvus.yaml 中；Milvus 会在启动时读取它们，并覆盖同一提供商的任何环境变量。

1. **在credential:

   你可以列出一个或多个 API 密钥--给每个密钥贴上你自创的标签，以便日后参考。

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

   把 API 密钥放在这里，可以让它们在重启时保持不变，而且只需更改标签就能切换密钥。

2. 告诉 Milvus 调用 OpenAI 时使用哪个密钥

   在同一文件中，将 OpenAI 提供者指向你希望它使用的标签。

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

   这样，Milvus 向 OpenAI Embeddings 端点发送的每个请求都会绑定特定密钥。

方案 2：环境变量

当你使用 Docker Compose 运行 Milvus，并希望不对文件和映像保密时，请使用这种方法。

只有在milvus.yaml 中找不到提供程序的密钥时，Milvus 才会使用环境变量。

变量	需要	描述
MILVUSAI_OPENAI_API_KEY	是	使 OpenAI 密钥在每个 Milvus 容器中可用（当milvus.yaml 中存在 OpenAI 密钥时忽略）。

在docker-compose.yaml文件中，设置MILVUSAI_OPENAI_API_KEY 环境变量。

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

environment: 块只将密钥注入 Milvus 容器，而不会触及主机操作系统。有关详情，请参阅使用 Docker Compose 配置 Milvus。

使用 Embeddings 功能

配置凭证后，请按照以下步骤定义和使用嵌入函数。

步骤 1：定义 Schema 字段

要使用嵌入函数，请创建一个具有特定 Schema 的 Collections。此 Schema 必须至少包含三个必要字段：

• 主字段，用于唯一标识 Collections 中的每个实体。

• 标量字段，用于存储要嵌入的原始数据。

• 一个向量字段，用于存储函数将为标量字段生成的向量嵌入。

下面的示例定义了一个 Schema 模式，其中一个标量字段"document" 用于存储文本数据，一个向量字段"dense" 用于存储将由函数模块生成的嵌入。切记要设置向量维数 (dim) 以匹配所选嵌入模型的输出。

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.
# For instance, OpenAI's text-embedding-3-small model outputs 1536-dimensional vectors.
schema.add_field("dense", DataType.FLOAT_VECTOR, dim=1536)

第 2 步：向 Schema 添加嵌入函数

Milvus 中的 Function 模块会自动将标量字段中存储的原始数据转换为嵌入数据，并将其存储到明确定义的向量字段中。

下面的示例添加了一个 Function 模块 (openai_embedding)，该模块将标量域"document" 转换为嵌入，将得到的向量存储到之前定义的"dense" 向量域中。

定义好嵌入函数后，将其添加到 Collections Schema 中。这将指示 Milvus 使用指定的嵌入函数来处理和存储文本数据中的嵌入。

# Define embedding function (example: OpenAI provider)
text_embedding_function = Function(
    name="openai_embedding",                        # Unique identifier for this embedding function
    function_type=FunctionType.TEXTEMBEDDING,       # Type of embedding function
    input_field_names=["document"],                 # Scalar field to embed
    output_field_names=["dense"],                   # Vector field to store embeddings
    params={                                        # Provider-specific configuration (highest priority)
        "provider": "openai",                       # Embedding model provider
        "model_name": "text-embedding-3-small",     # Embedding model
        # Optional parameters:
        # "credential": "apikey_dev",               # Optional: Credential label specified in milvus.yaml
        # "dim": "1536",                            # Optional: Shorten the output vector dimension
        # "user": "user123"                         # Optional: identifier for API tracking
    }
)

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

下一步

配置好嵌入函数后，请参阅 "功能概述"，了解有关索引配置、数据插入示例和语义搜索操作的更多指导。