版本：v3.0.x

DashScopeCompatible with Milvus 2.6.x

本主题介绍如何在 Milvus 中配置和使用 DashScope Embedding Function。

选择 Embedding 模型

以下是当前可用的 DashScope Embedding 模型，供快速参考：

| 模型名称

尺寸

每行最大标记数

支持的语言

| | --- | --- | --- | --- | |

text-Embedding-v3

1,024（默认）、768 或 512

8,192

中文、英文、西班牙文、法文、葡萄牙文、印尼文、日文、韩文、德文、俄文和其他 50 多种语言

| |

text-embedding-v2

1,536

2,048

中文、英文、西班牙文、法文、葡萄牙文、印尼文、日文、韩文、德文、俄文

| |

text-embedding-v1

1,536

2,048

中文、英文、西班牙文、法文、葡萄牙文、印尼文、日文、韩文、德文、俄文

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

配置凭证

Milvus 必须知道您的 DashScope 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 在调用 DashScope 时使用哪个密钥

在同一个文件中，将 DashScope 提供程序指向您希望它使用的标签。

function:
  textEmbedding:
    providers:
      dashscope:
        credential: apikey_dev      # ← choose any label you defined above
        # url: https://dashscope-intl.aliyuncs.com/compatible-mode/v1   # (optional) custom url

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

选项 2：环境变量

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

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

| 变量

需要

描述

| | --- | --- | --- | |

MILVUSAI_DASHSCOPE_API_KEY

是

使 DashScope 密钥在每个 Milvus 容器中可用*（当milvus.yaml 中存在 DashScope 密钥时，忽略该变量）。*

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

# docker-compose.yaml (standalone service section)
standalone:
  # ... other configurations ...
  environment:
    # ... other environment variables ...
    # Set the environment variable pointing to the DashScope API key inside the container
    MILVUSAI_DASHSCOPE_API_KEY: <MILVUSAI_DASHSCOPE_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 模块 (ali)，该模块将标量域"document" 转换为嵌入，将得到的向量存储到之前定义的"dense" 向量域中。

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

# Define embedding function specifically for model provider
text_embedding_function = Function(
    name="ali",                                     # 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
        "provider": "dashscope",                    # Embedding provider name (must be "dashscope")
        "model_name": "text-embedding-v3",          # Specific embedding model used
        # Optional parameters:
        # "credential": "apikey_dev"                # Optional: Credential label specified in milvus.yaml
        # "dim": "1024",                            # Optional: Shorten the output vector dimension
    }
)

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

下一步

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

选择 Embedding 模型​

配置凭证​

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

选项 2：环境变量​

使用 Embedding 功能​

步骤 1：定义 Schema 字段​

第 2 步：向 Schema 添加 Embedding Function​

下一步​