From 4214e6782bad5421a2fbaae1fb24021ef8673365 Mon Sep 17 00:00:00 2001 From: wizardchen Date: Tue, 9 Sep 2025 17:40:14 +0800 Subject: [PATCH] feat: add aliyun rerank model --- frontend/src/api/initialization/index.ts | 2 + .../initialization/InitializationConfig.vue | 29 +++- internal/models/rerank/aliyun_reranker.go | 146 ++++++++++++++++++ .../models/rerank/aliyun_reranker_test.go | 80 ++++++++++ internal/models/rerank/reranker.go | 2 + internal/types/model.go | 1 + 6 files changed, 257 insertions(+), 3 deletions(-) create mode 100644 internal/models/rerank/aliyun_reranker.go create mode 100644 internal/models/rerank/aliyun_reranker_test.go diff --git a/frontend/src/api/initialization/index.ts b/frontend/src/api/initialization/index.ts index fb5718ba..cc55eb34 100644 --- a/frontend/src/api/initialization/index.ts +++ b/frontend/src/api/initialization/index.ts @@ -16,6 +16,7 @@ export interface InitializationConfig { dimension?: number; // 添加embedding维度字段 }; rerank: { + source: string; modelName: string; baseUrl: string; apiKey?: string; @@ -235,6 +236,7 @@ export function testEmbeddingModel(modelConfig: { export function checkRerankModel(modelConfig: { + source: string; modelName: string; baseUrl: string; apiKey?: string; diff --git a/frontend/src/views/initialization/InitializationConfig.vue b/frontend/src/views/initialization/InitializationConfig.vue index 3bc0a097..09c5ec20 100644 --- a/frontend/src/views/initialization/InitializationConfig.vue +++ b/frontend/src/views/initialization/InitializationConfig.vue @@ -334,10 +334,20 @@
+
+ + + Remote API (远程) + Aliyun DashScope (阿里云) + + +
+
-
@@ -361,7 +371,8 @@
-
@@ -868,6 +879,7 @@ const formData = reactive({ }, rerank: { enabled: false, + source: 'remote', modelName: '', baseUrl: '', apiKey: '' @@ -1344,7 +1356,7 @@ onUnmounted(() => { }); // 事件处理 -const onModelSourceChange = async (type: 'llm' | 'embedding') => { +const onModelSourceChange = async (type: 'llm' | 'embedding' | 'rerank') => { // 重置模型状态 modelStatus[type].checked = false; modelStatus[type].available = false; @@ -1354,6 +1366,15 @@ const onModelSourceChange = async (type: 'llm' | 'embedding') => { if (formData[type].source === 'local' && !ollamaStatus.checked) { await checkOllama(); } + + // 对于rerank,根据source设置默认的baseUrl + if (type === 'rerank') { + if (formData.rerank.source === 'aliyun') { + formData.rerank.baseUrl = 'https://dashscope.aliyuncs.com/api/v1/services/rerank/text-rerank'; + } else if (formData.rerank.source === 'remote') { + formData.rerank.baseUrl = ''; + } + } }; const onModelNameChange = async (type: 'llm' | 'embedding' | 'vlm') => { @@ -1754,6 +1775,7 @@ const handleSubmit = async () => { // 监听表单变化 watch(() => formData.llm.source, () => onModelSourceChange('llm')); watch(() => formData.embedding.source, () => onModelSourceChange('embedding')); +watch(() => formData.rerank.source, () => onModelSourceChange('rerank')); // 组件挂载时检查Ollama状态 onMounted(async () => { @@ -1826,6 +1848,7 @@ const checkRerankModelStatus = async () => { modelStatus.rerank.message = ''; const result = await checkRerankModel({ + source: formData.rerank.source, modelName: formData.rerank.modelName, baseUrl: formData.rerank.baseUrl, apiKey: formData.rerank.apiKey diff --git a/internal/models/rerank/aliyun_reranker.go b/internal/models/rerank/aliyun_reranker.go new file mode 100644 index 00000000..fa47b589 --- /dev/null +++ b/internal/models/rerank/aliyun_reranker.go @@ -0,0 +1,146 @@ +package rerank + +import ( + "bytes" + "context" + "encoding/json" + "fmt" + "io" + "net/http" + + "github.com/Tencent/WeKnora/internal/logger" +) + +// AliyunReranker implements a reranking system based on Aliyun DashScope models +type AliyunReranker struct { + modelName string // Name of the model used for reranking + modelID string // Unique identifier of the model + apiKey string // API key for authentication + baseURL string // Base URL for API requests + client *http.Client // HTTP client for making API requests +} + +// AliyunRerankRequest represents a request to rerank documents using Aliyun DashScope API +type AliyunRerankRequest struct { + Model string `json:"model"` // Model to use for reranking + Query string `json:"query"` // Query text to compare documents against + Documents []string `json:"documents"` // List of document texts to rerank +} + +// AliyunRerankResponse represents the response from Aliyun DashScope reranking request +type AliyunRerankResponse struct { + Output AliyunOutput `json:"output"` // Output containing results + Usage AliyunUsage `json:"usage"` // Token usage information +} + +// AliyunOutput contains the reranking results +type AliyunOutput struct { + Results []AliyunRankResult `json:"results"` // Ranked results with relevance scores +} + +// AliyunRankResult represents a single reranking result from Aliyun +type AliyunRankResult struct { + Document AliyunDocument `json:"document"` // Document information + Index int `json:"index"` // Original index of the document + RelevanceScore float64 `json:"relevance_score"` // Relevance score +} + +// AliyunDocument represents document information in Aliyun response +type AliyunDocument struct { + Text string `json:"text"` // Document text +} + +// AliyunUsage contains information about token usage in the Aliyun API request +type AliyunUsage struct { + TotalTokens int `json:"total_tokens"` // Total tokens consumed +} + +// NewAliyunReranker creates a new instance of Aliyun reranker with the provided configuration +func NewAliyunReranker(config *RerankerConfig) (*AliyunReranker, error) { + apiKey := config.APIKey + baseURL := "https://dashscope.aliyuncs.com/api/v1/services/rerank/text-rerank" + if url := config.BaseURL; url != "" { + baseURL = url + } + + return &AliyunReranker{ + modelName: config.ModelName, + modelID: config.ModelID, + apiKey: apiKey, + baseURL: baseURL, + client: &http.Client{}, + }, nil +} + +// Rerank performs document reranking based on relevance to the query using Aliyun DashScope API +func (r *AliyunReranker) Rerank(ctx context.Context, query string, documents []string) ([]RankResult, error) { + // Build the request body + requestBody := &AliyunRerankRequest{ + Model: r.modelName, + Query: query, + Documents: documents, + } + + jsonData, err := json.Marshal(requestBody) + if err != nil { + return nil, fmt.Errorf("marshal request body: %w", err) + } + + // Send the request + req, err := http.NewRequestWithContext(ctx, "POST", r.baseURL, bytes.NewBuffer(jsonData)) + if err != nil { + return nil, fmt.Errorf("create request: %w", err) + } + req.Header.Set("Content-Type", "application/json") + req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", r.apiKey)) + + // Log the curl equivalent for debugging + logger.Debugf(ctx, "curl -X POST %s -H \"Content-Type: application/json\" -H \"Authorization: Bearer %s\" -d '%s'", + r.baseURL, r.apiKey, string(jsonData), + ) + + resp, err := r.client.Do(req) + if err != nil { + return nil, fmt.Errorf("do request: %w", err) + } + defer resp.Body.Close() + + // Read the response + body, err := io.ReadAll(resp.Body) + if err != nil { + return nil, fmt.Errorf("read response body: %w", err) + } + + if resp.StatusCode != http.StatusOK { + return nil, fmt.Errorf("aliyun rerank API error: Http Status: %s, Body: %s", resp.Status, string(body)) + } + + var response AliyunRerankResponse + if err := json.Unmarshal(body, &response); err != nil { + return nil, fmt.Errorf("unmarshal response: %w", err) + } + + // Convert Aliyun results to standard RankResult format + results := make([]RankResult, len(response.Output.Results)) + for i, aliyunResult := range response.Output.Results { + results[i] = RankResult{ + Index: aliyunResult.Index, + Document: DocumentInfo{ + Text: aliyunResult.Document.Text, + }, + RelevanceScore: aliyunResult.RelevanceScore, + } + } + + return results, nil +} + +// GetModelName returns the name of the reranking model +func (r *AliyunReranker) GetModelName() string { + return r.modelName +} + +// GetModelID returns the unique identifier of the reranking model +func (r *AliyunReranker) GetModelID() string { + return r.modelID +} diff --git a/internal/models/rerank/aliyun_reranker_test.go b/internal/models/rerank/aliyun_reranker_test.go new file mode 100644 index 00000000..9990b03b --- /dev/null +++ b/internal/models/rerank/aliyun_reranker_test.go @@ -0,0 +1,80 @@ +package rerank + +import ( + "testing" +) + +// TestAliyunRerankerCreation tests creating an Aliyun reranker +func TestAliyunRerankerCreation(t *testing.T) { + config := &RerankerConfig{ + APIKey: "test-api-key", + BaseURL: "https://dashscope.aliyuncs.com/api/v1/services/rerank/text-rerank", + ModelName: "text-rerank", + Source: "aliyun", + ModelID: "aliyun-text-rerank", + } + + reranker, err := NewAliyunReranker(config) + if err != nil { + t.Fatalf("Failed to create Aliyun reranker: %v", err) + } + + if reranker.GetModelName() != config.ModelName { + t.Errorf("Expected model name %s, got %s", config.ModelName, reranker.GetModelName()) + } + + if reranker.GetModelID() != config.ModelID { + t.Errorf("Expected model ID %s, got %s", config.ModelID, reranker.GetModelID()) + } +} + +// TestAliyunRerankerViaNewReranker tests creating an Aliyun reranker through NewReranker +func TestAliyunRerankerViaNewReranker(t *testing.T) { + config := &RerankerConfig{ + APIKey: "test-api-key", + BaseURL: "https://dashscope.aliyuncs.com/api/v1/services/rerank/text-rerank", + ModelName: "text-rerank", + Source: "aliyun", + ModelID: "aliyun-text-rerank", + } + + reranker, err := NewReranker(config) + if err != nil { + t.Fatalf("Failed to create reranker: %v", err) + } + + // Verify it's an AliyunReranker + _, ok := reranker.(*AliyunReranker) + if !ok { + t.Errorf("Expected AliyunReranker, got %T", reranker) + } + + if reranker.GetModelName() != config.ModelName { + t.Errorf("Expected model name %s, got %s", config.ModelName, reranker.GetModelName()) + } + + if reranker.GetModelID() != config.ModelID { + t.Errorf("Expected model ID %s, got %s", config.ModelID, reranker.GetModelID()) + } +} + +// TestAliyunRerankerUnsupportedSource tests error handling for unsupported sources +func TestAliyunRerankerUnsupportedSource(t *testing.T) { + config := &RerankerConfig{ + APIKey: "test-api-key", + BaseURL: "https://dashscope.aliyuncs.com/api/v1/services/rerank/text-rerank", + ModelName: "text-rerank", + Source: "unsupported", + ModelID: "aliyun-text-rerank", + } + + _, err := NewReranker(config) + if err == nil { + t.Error("Expected error for unsupported source, got nil") + } + + expectedError := "unsupported rerank model source: unsupported" + if err.Error() != expectedError { + t.Errorf("Expected error %s, got %s", expectedError, err.Error()) + } +} diff --git a/internal/models/rerank/reranker.go b/internal/models/rerank/reranker.go index 01f9b078..bf8283aa 100644 --- a/internal/models/rerank/reranker.go +++ b/internal/models/rerank/reranker.go @@ -91,6 +91,8 @@ func NewReranker(config *RerankerConfig) (Reranker, error) { switch strings.ToLower(string(config.Source)) { case string(types.ModelSourceRemote): return NewOpenAIReranker(config) + case string(types.ModelSourceAliyun): + return NewAliyunReranker(config) default: return nil, fmt.Errorf("unsupported rerank model source: %s", config.Source) } diff --git a/internal/types/model.go b/internal/types/model.go index 433665eb..d70fada0 100644 --- a/internal/types/model.go +++ b/internal/types/model.go @@ -33,6 +33,7 @@ type ModelSource string const ( ModelSourceLocal ModelSource = "local" // Local model ModelSourceRemote ModelSource = "remote" // Remote model + ModelSourceAliyun ModelSource = "aliyun" // Aliyun DashScope model ) type EmbeddingParameters struct {