Cohere RankerCompatible with Milvus 2.6.x

Cohere Ranker использует мощные модели ранжирования Cohere для повышения релевантности поиска путем семантического ранжирования. Он предоставляет возможности ранжирования корпоративного уровня с надежной инфраструктурой API и оптимизированной производительностью для производственных сред.

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

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

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

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

• Постоянная производительность API со встроенным ограничением скорости и обработкой ошибок.

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

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

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

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

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

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

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

Чтобы использовать Cohere 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 Cohere Ranker
cohere_ranker = Function(
    name="cohere_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": "cohere",               # Specifies Cohere as the service provider
        "model_name": "rerank-english-v3.0", # Cohere rerank model 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)
        "max_tokens_per_doc": 4096,         # Optional: max tokens per document (default: 4096)
        # "credential": "your-cohere-api-key" # Optional: authentication credential for Cohere API
    }
)

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("cohere_semantic_ranker")
                       .inputFieldNames(Collections.singletonList("document"))
                       .param("reranker", "model")
                       .param("provider", "cohere")
                       .param("model_name", "rerank-english-v3.0")
                       .param("queries", "[\"renewable energy developments\"]")
                       .param("endpoint", "http://localhost:8080")
                       .param("max_client_batch_size", "128")
                       .param("max_tokens_per_doc", "4096")
                       .build();

// nodejs

// go

# restful

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

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

Параметр	Требуемый?	Описание	Значение / Пример
reranker	Да	Должно быть установлено значение "model", чтобы включить повторное ранжирование моделей.	"model"
provider	Да	Поставщик услуг модели, который будет использоваться для повторного ранжирования.	"cohere"
model_name	Да	Модель рерайтинга Cohere, которую следует использовать из поддерживаемых моделей на платформе Cohere. Список доступных моделей реранкинга см. в документации Cohere.	"rerank-english-v3.0", "rerank-multilingual-v3.0"
queries	Да	Список строк запросов, используемых моделью ранжирования для расчета баллов релевантности. Количество строк запросов должно точно соответствовать количеству запросов в вашей поисковой операции (даже при использовании векторов запросов вместо текста), иначе будет выдана ошибка.	["поисковый запрос"].
max_client_batch_size	Нет	Поскольку сервисы моделей могут обрабатывать не все данные сразу, здесь задается размер пакета для обращения к сервису модели при нескольких запросах.	128 (по умолчанию)
max_tokens_per_doc	Нет	Максимальное количество лексем в одном документе. Длинные документы будут автоматически усекаться до указанного количества лексем.	4096 (по умолчанию)
credential	Нет	Учетные данные для аутентификации при доступе к сервисам Cohere API. Если не указано, система будет искать переменную окружения COHERE_API_KEY.	"your-cohere-api-key"

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

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

# Execute search with Cohere reranking
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=cohere_ranker,                       # Apply Cohere reranking
    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(COLLECTION_NAME)
        .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