OpenAICompatible with Milvus 2.6.x

Используйте модель встраивания OpenAI с Milvus, выбрав модель и настроив Milvus с помощью вашего ключа API OpenAI.

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

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

Название модели	Размеры	Максимальное количество токенов	Описание
text-embedding-3-small	По умолчанию: 1 536 (может быть сокращено до размера менее 1 536)	8,191	Идеально подходит для чувствительного к затратам и масштабируемого семантического поиска - обеспечивает высокую производительность при низкой цене.
text-embedding-3-large	По умолчанию: 3 072 (может быть сокращено до размера менее 3 072)	8,191	Лучше всего подходит для приложений, требующих повышенной точности поиска и более богатых семантических представлений.
text-embedding-ada-002	Фиксированный: 1,536 (не может быть сокращен)	8,191	Модель предыдущего поколения, подходящая для устаревших конвейеров или сценариев, требующих обратной совместимости.

Модели встраивания третьего поколения(text-embedding-3) поддерживают уменьшение размера встраивания с помощью параметра dim. Как правило, большие вкрапления являются более дорогостоящими с точки зрения вычислений, памяти и хранения. Возможность регулировать количество измерений позволяет лучше контролировать общую стоимость и производительность. Более подробную информацию о каждой модели можно найти в разделе Модели встраивания и сообщение в блоге 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.

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

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

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

Переменная	Требуется	Описание
MILVUSAI_OPENAI_API_KEY	Да	Делает ключ OpenAI доступным внутри каждого контейнера Milvus (игнорируется, если ключ для OpenAI существует в milvus.yaml ).

В файле 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, оставляя вашу хостовую ОС нетронутой. Подробнее см. в разделе Настройка 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.
# For instance, OpenAI's text-embedding-3-small model outputs 1536-dimensional vectors.
schema.add_field("dense", DataType.FLOAT_VECTOR, dim=1536)

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

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

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

Определив функцию встраивания, добавьте ее в схему коллекции. Это даст указание 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)

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

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