Voyage AI RankerCompatible with Milvus 2.6.x

Voyage AI Ranker использует специализированные реранкеры Voyage AI для повышения релевантности поиска путем семантического реранкинга. Он обеспечивает высокопроизводительные возможности ранжирования, оптимизированные для генерации с расширением поиска (RAG) и поисковых приложений.

Voyage AI Ranker особенно ценен для приложений, требующих:

• Расширенное понимание семантики с помощью моделей, специально обученных для задач ранжирования

• Высокопроизводительная обработка с оптимизированными выводами для производственных рабочих нагрузок

• Гибкие элементы управления усечением для работы с документами различной длины

• Тонкая настройка производительности для различных вариантов моделей (rerank-2, rerank-lite и т.д.).

Предварительные условия

Перед внедрением Voyage AI Ranker в Milvus убедитесь, что у вас есть:

• Коллекция Milvus с полем VARCHAR, содержащим текст для ранжирования.

• Действительный API-ключ Voyage AI с доступом к ранжировщикам. Зарегистрируйтесь на платформе Voyage AI, чтобы получить учетные данные API. Вы можете либо:

  • Задать переменную окружения VOYAGE_API_KEY, либо

  • Указать API-ключ непосредственно в конфигурации ранкера.

Создание функции ранжирования Voyage AI

Чтобы использовать Voyage AI Ranker в вашем приложении Milvus, создайте объект Function, который определяет, как должно работать ранжирование. Эта функция будет передаваться в поисковые операции Milvus для улучшения ранжирования результатов.

from pymilvus import MilvusClient, Function, FunctionType

# Connect to your Milvus server
client = MilvusClient(
    uri="http://localhost:19530"  # Replace with your Milvus server URI
)

# Configure Voyage AI Ranker
voyageai_ranker = Function(
    name="voyageai_semantic_ranker",        # Unique identifier for your ranker
    input_field_names=["document"],         # VARCHAR field containing text to rerank
    function_type=FunctionType.RERANK,      # Must be RERANK for reranking functions
    params={
        "reranker": "model",                # Enables model-based reranking
        "provider": "voyageai",             # Specifies Voyage AI as the service provider
        "model_name": "rerank-2.5",           # Voyage AI reranker to use
        "queries": ["renewable energy developments"], # Query text for relevance evaluation
        "max_client_batch_size": 128,       # Optional: batch size for model service requests (default: 128)
        "truncation": True,                 # Optional: enable input truncation (default: True)
        # "credential": "your-voyage-api-key" # Optional: if not set, uses VOYAGE_API_KEY env var
    }
)

import io.milvus.v2.client.ConnectConfig;
import io.milvus.v2.client.MilvusClientV2;
import io.milvus.common.clientenum.FunctionType;
import io.milvus.v2.service.collection.request.CreateCollectionReq;

MilvusClientV2 client = new MilvusClientV2(ConnectConfig.builder()
        .uri("http://localhost:19530")
        .build());

CreateCollectionReq.Function ranker = CreateCollectionReq.Function.builder()
                       .functionType(FunctionType.RERANK)
                       .name("voyageai_semantic_ranker")
                       .inputFieldNames(Collections.singletonList("document"))
                       .param("reranker", "model")
                       .param("provider", "voyageai")
                       .param("model_name", "rerank-2.5")
                       .param("queries", "[\"renewable energy developments\"]")
                       .param("endpoint", "http://localhost:8080")
                       .param("max_client_batch_size", "128")
                       .param("truncation", "true")
                       .build();

// nodejs

// go

# restful

Специфические параметры ранжировщика Voyage AI

Следующие параметры специфичны для ранжировщика Voyage AI:

Параметр	Требуемый?	Описание	Значение / Пример
reranker	Да	Должно быть установлено значение "model", чтобы включить повторное ранжирование моделей.	"model"
provider	Да	Поставщик услуг модели, который будет использоваться для повторного ранжирования.	"voyageai"
model_name	Да	Реранкер Voyage AI для использования из поддерживаемых моделей на платформе Voyage AI. Список доступных реранкеров см. в документации Voyage AI.	"rerank-2.5"
queries	Да	Список строк запросов, используемых моделью ранжирования для расчета баллов релевантности. Количество строк запросов должно точно соответствовать количеству запросов в вашей поисковой операции (даже при использовании векторов запросов вместо текста), иначе будет выдано сообщение об ошибке.	["поисковый запрос"].
max_client_batch_size	Нет	Поскольку сервисы моделей могут обрабатывать не все данные сразу, здесь задается размер пакета для обращения к сервису моделей при нескольких запросах.	128 (по умолчанию)
truncation	Нет	Нужно ли усекать входные данные, чтобы удовлетворить "ограничение длины контекста" для запроса и документов. Если True, то запрос и документы будут усечены, чтобы уложиться в ограничение длины контекста, перед обработкой моделью реранкера. Если False, то будет выдана ошибка, если запрос превышает 8 000 лексем для rerank-2.5 и rerank-2.5-lite; 4 000 лексем для rerank-2; 2 000 лексем rerank-2-lite и rerank-1; и 1 000 лексем для rerank-lite-1, или сумма количества лексем в запросе и количества лексем в любом отдельном документе превышает 16 000 для rerank-2; 8 000 для rerank-2-lite и rerank-1; и 4 000 для rerank-lite-1.	True (по умолчанию) или False
credential	Нет	Учетные данные для аутентификации при доступе к службам Voyage AI API. Если не указано, система будет искать переменную окружения VOYAGE_API_KEY.	"your-voyage-api-key"

Применение к стандартному векторному поиску

Чтобы применить Voyage AI Ranker к стандартному векторному поиску:

# Execute search with Voyage AI reranker
results = client.search(
    collection_name="your_collection",
    data=[your_query_vector],  # Replace with your query vector
    anns_field="dense_vector",                   # Vector field to search
    limit=5,                                     # Number of results to return
    output_fields=["document"],                  # Include text field for reranking
    ranker=voyageai_ranker,                     # Apply Voyage AI reranker
    consistency_level="Bounded"
)

import io.milvus.v2.common.ConsistencyLevel;
import io.milvus.v2.service.vector.request.SearchReq;
import io.milvus.v2.service.vector.response.SearchResp;
import io.milvus.v2.service.vector.request.data.EmbeddedText;

SearchReq searchReq = SearchReq.builder()
        .collectionName("your_collection")
        .data(Arrays.asList(new EmbeddedText("AI Research Progress"), new EmbeddedText("What is AI")))
        .annsField("vector_field")
        .limit(10)
        .outputFields(Collections.singletonList("document"))
        .functionScore(FunctionScore.builder()
                .addFunction(ranker)
                .build())
        .consistencyLevel(ConsistencyLevel.BOUNDED)
        .build();
SearchResp searchResp = client.search(searchReq);

// nodejs

// go

# restful