Voyage AICompatible with Milvus 2.6.x

В этой теме описывается, как настраивать и использовать функции встраивания Voyage AI в Milvus.

Выбор модели встраивания

Milvus поддерживает модели встраивания, предоставляемые Voyage AI. Ниже приведены доступные в настоящее время модели встраивания для быстрого ознакомления:

Название модели	Размеры	Максимальное количество токенов	Описание
voyage-3-large	1,024 (по умолчанию), 256, 512, 2,048	32,000	Наилучшее качество поиска для общего назначения и многоязычного использования.
voyage-3	1,024	32,000	Оптимизировано для общего назначения и качества многоязычного поиска. Подробности см. в блоге.
voyage-3-lite	512	32,000	Оптимизирована по задержкам и стоимости. Подробности см. в блоге.
voyage-code-3	1,024 (по умолчанию), 256, 512, 2,048	32,000	Оптимизировано для поиска кодов. Подробности см. в блоге.
voyage-finance-2	1,024	32,000	Оптимизировано для поиска финансов и RAG. Подробности см. в блоге.
voyage-law-2	1,024	16,000	Оптимизирован для поиска по юридическим вопросам и RAG. Также улучшена производительность во всех доменах. Подробности см. в блоге.
voyage-code-2	1,536	16,000	Оптимизирован для поиска кода (на 17 % лучше, чем у альтернативных вариантов) / Предыдущее поколение вкраплений кода. Подробности см. в блоге.

Подробности см. в разделе Модели встраивания текста.

Настройка учетных данных

Milvus должен знать ваш ключ Voyage AI 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, какой ключ использовать для вызовов служб

   В том же файле укажите провайдеру Voyage AI на метку, которую вы хотите использовать.

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

   Это свяжет определенный ключ с каждым запросом, который Milvus отправляет на конечную точку встраивания Voyage AI.

Вариант 2: Переменная среды

Используйте этот метод, если вы запускаете Milvus с Docker Compose и предпочитаете хранить секреты вне файлов и образов.

Milvus возвращается к переменной окружения только в том случае, если ключ для провайдера не найден в milvus.yaml.

Переменная	Требуется	Описание
MILVUSAI_VOYAGEAI_API_KEY	Да	Ваш действительный ключ API Voyage AI.

В файле docker-compose.yaml установите переменную окружения 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>

Блок environment: вводит ключ только в контейнер Milvus, оставляя вашу хостовую ОС нетронутой. Подробнее см. в разделе Настройка Milvus с помощью Docker Compose.

Использование функции встраивания

После настройки учетных данных выполните следующие шаги, чтобы определить и использовать функции встраивания.

Шаг 1: Определите поля схемы

Чтобы использовать функцию встраивания, создайте коллекцию с определенной схемой. Эта схема должна включать как минимум три необходимых поля:

• Первичное поле, которое уникально идентифицирует каждую сущность в коллекции.

• Скалярное поле, в котором хранятся исходные данные для встраивания.

• Векторное поле, зарезервированное для хранения векторных вкраплений, которые функция будет генерировать для скалярного поля.

Следующий пример определяет схему с одним скалярным полем "document" для хранения текстовых данных и одним векторным полем "dense" для хранения вкраплений, которые будут сгенерированы модулем Function. Не забудьте задать размерность вектора (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.
schema.add_field("dense", DataType.FLOAT_VECTOR, dim=1024)

Шаг 2: Добавьте функцию встраивания в схему

Модуль Function в Milvus автоматически преобразует исходные данные, хранящиеся в скалярном поле, во вкрапления и сохраняет их в явно определенном векторном поле.

В примере ниже добавлен модуль Function (voya), который преобразует скалярное поле "document" в эмбеддинги, сохраняя полученные векторы в векторном поле "dense", определенном ранее.

Определив функцию встраивания, добавьте ее в схему коллекции. Это даст указание Milvus использовать указанную функцию встраивания для обработки и хранения вкраплений из ваших текстовых данных.

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

Следующие шаги

После настройки функции встраивания обратитесь к обзору функций для получения дополнительных указаний по настройке индекса, примеров вставки данных и операций семантического поиска.