Voyage AI RankerCompatible with Milvus 2.6.x

Voyage AI Ranker 利用Voyage AI 的專門 rerankers，透過語義重排（semantic reranking）增強搜尋相關性。它提供高性能的重排功能，針對檢索增強生成（RAG）和搜尋應用進行了優化。

Voyage AI Ranker 對需要下列功能的應用程式特別有價值：

• 先進的語意理解能力，具備專門針對 Reranking 任務所訓練的模型

• 高效能處理，針對生產工作負載進行最佳化推論

• 靈活的截斷控制，可處理不同長度的文件

• 針對不同的模型變異（reank-2、reank-lite 等）進行性能微調

先決條件

在 Milvus 中實作 Voyage AI Ranker 之前，請確保您擁有

• 具有VARCHAR 欄位的 Milvus 套件，其中包含要進行 rerank 的文字

• 有效的 Voyage AI API 金鑰，可存取 reranker。在Voyage AI 的平台註冊以取得您的 API 認證。您可以

  • 設定VOYAGE_API_KEY 環境變數，或

  • 直接在ranker配置中指定API key

建立 Voyage AI Ranker 功能

要在您的 Milvus 應用程式中使用 Voyage AI Ranker，請建立一個 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 ranker 特有的參數：

參數	需要嗎？	說明	值/範例
reranker	是	必須設定為"model" ，才能啟用模型重排。	"model"
provider	是	用於重排的模型服務提供者。	"voyageai"
model_name	是	從 Voyage AI 平台支援的模型中使用的 Voyage AI reranker。 有關可用的 reranker 清單，請參閱Voyage AI 文件。	"rerank-2.5"
queries	是	rerank 模型用來計算相關性分數的查詢字串清單。查詢字串的數量必須與您搜尋作業中的查詢字串數量完全相同（即使是使用查詢向量來取代文字），否則會報錯。	[「搜尋查詢」]
max_client_batch_size	否	由於模型服務可能無法一次處理所有資料，因此這會設定在多次請求中存取模型服務的批次大小。	128 (預設值)
truncation	否	是否截斷輸入，以滿足查詢和文件的「上下文長度限制」。 如果True ，查詢和文件將被截斷以符合上下文長度限制，然後才由 reranker 模型處理。 如果是False ，當rerank-2.5 和rerank-2.5-lite 的查詢超過 8,000 個字元；rerank-2 的查詢超過 4,000 個字元；rerank-2-lite 和rerank-1 的查詢超過 2,000 個字元；rerank-lite-1 的查詢超過 1,000 個字元，或rerank-2 的查詢字元數與任何單一文件的字元數之和超過 16,000 個字元；rerank-2-lite 和rerank-1 的查詢字元數超過 8,000 個字元；rerank-lite-1 的查詢字元數超過 4,000 個字元時，就會發生錯誤。	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