feat(lkeap): integrate Tencent Cloud LKEAP Rerank support
- Added support for Tencent Cloud LKEAP Rerank, including new configuration options for SecretId and SecretKey. - Updated frontend components to handle LKEAP-specific fields and enhance user experience with appropriate labels and placeholders. - Enhanced backend logic to manage LKEAP credentials and integrate with the new rerank API. - Improved localization for LKEAP-related terms across multiple languages, ensuring clarity and consistency in user-facing messages. - Introduced tests for LKEAP Reranker functionality to ensure reliability and correctness in handling requests.
This commit is contained in:
@@ -10,6 +10,8 @@ import (
|
||||
const (
|
||||
// LKEAPBaseURL 腾讯云知识引擎原子能力 (LKEAP) 兼容 OpenAI 协议的 BaseURL
|
||||
LKEAPBaseURL = "https://api.lkeap.cloud.tencent.com/v1"
|
||||
// LKEAPRerankBaseURL 腾讯云知识引擎原子能力 Rerank API 域名(TC3 签名)
|
||||
LKEAPRerankBaseURL = "https://lkeap.tencentcloudapi.com"
|
||||
)
|
||||
|
||||
// LKEAPProvider 实现腾讯云 LKEAP 的 Provider 接口
|
||||
@@ -25,12 +27,14 @@ func (p *LKEAPProvider) Info() ProviderInfo {
|
||||
return ProviderInfo{
|
||||
Name: ProviderLKEAP,
|
||||
DisplayName: "腾讯云 LKEAP",
|
||||
Description: "DeepSeek-R1, DeepSeek-V3 系列模型,支持思维链",
|
||||
Description: "DeepSeek-R1, DeepSeek-V3, lke-reranker-base 等",
|
||||
DefaultURLs: map[types.ModelType]string{
|
||||
types.ModelTypeKnowledgeQA: LKEAPBaseURL,
|
||||
types.ModelTypeRerank: LKEAPRerankBaseURL,
|
||||
},
|
||||
ModelTypes: []types.ModelType{
|
||||
types.ModelTypeKnowledgeQA,
|
||||
types.ModelTypeRerank,
|
||||
},
|
||||
RequiresAuth: true,
|
||||
}
|
||||
|
||||
@@ -258,7 +258,7 @@ func DetectProvider(baseURL string) ProviderName {
|
||||
return ProviderQianfan
|
||||
case containsAny(baseURL, "longcat.chat"):
|
||||
return ProviderLongCat
|
||||
case containsAny(baseURL, "lkeap.cloud.tencent.com", "api.lkeap"):
|
||||
case containsAny(baseURL, "lkeap.cloud.tencent.com", "api.lkeap", "lkeap.tencentcloudapi.com"):
|
||||
return ProviderLKEAP
|
||||
case containsAny(baseURL, "nvidia.com"):
|
||||
return ProviderNvidia
|
||||
|
||||
@@ -231,14 +231,19 @@ func TestListByModelType(t *testing.T) {
|
||||
providers := ListByModelType(types.ModelTypeRerank)
|
||||
assert.NotEmpty(t, providers)
|
||||
// Check that Aliyun supports rerank
|
||||
found := false
|
||||
foundAliyun := false
|
||||
foundLKEAP := false
|
||||
for _, p := range providers {
|
||||
if p.Name == ProviderAliyun {
|
||||
found = true
|
||||
break
|
||||
foundAliyun = true
|
||||
}
|
||||
if p.Name == ProviderLKEAP {
|
||||
foundLKEAP = true
|
||||
assert.Equal(t, LKEAPRerankBaseURL, p.GetDefaultURL(types.ModelTypeRerank))
|
||||
}
|
||||
}
|
||||
assert.True(t, found, "Aliyun should support rerank")
|
||||
assert.True(t, foundAliyun, "Aliyun should support rerank")
|
||||
assert.True(t, foundLKEAP, "LKEAP should support rerank")
|
||||
})
|
||||
|
||||
t.Run("embedding models include openrouter", func(t *testing.T) {
|
||||
|
||||
@@ -0,0 +1,124 @@
|
||||
package rerank
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"github.com/Tencent/WeKnora/internal/logger"
|
||||
"github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common"
|
||||
"github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/profile"
|
||||
lkeap "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/lkeap/v20240522"
|
||||
)
|
||||
|
||||
const (
|
||||
// LKEAPRerankEndpoint 腾讯云知识引擎原子能力 Rerank API 域名
|
||||
LKEAPRerankEndpoint = "lkeap.tencentcloudapi.com"
|
||||
// LKEAPDefaultRegion RunRerank 支持的地域,默认广州
|
||||
LKEAPDefaultRegion = "ap-guangzhou"
|
||||
// LKEAPDefaultRerankModel 默认 rerank 模型名
|
||||
LKEAPDefaultRerankModel = "lke-reranker-base"
|
||||
)
|
||||
|
||||
// LKEAPReranker 使用腾讯云知识引擎原子能力 RunRerank 接口进行重排序。
|
||||
// 鉴权使用腾讯云 API 密钥:APIKey 为 SecretId,AppSecret 为 SecretKey。
|
||||
type LKEAPReranker struct {
|
||||
modelName string
|
||||
modelID string
|
||||
client *lkeap.Client
|
||||
}
|
||||
|
||||
// NewLKEAPReranker 创建 LKEAP rerank 客户端。
|
||||
func NewLKEAPReranker(config *RerankerConfig) (*LKEAPReranker, error) {
|
||||
secretID := strings.TrimSpace(config.APIKey)
|
||||
secretKey := strings.TrimSpace(config.AppSecret)
|
||||
if secretKey == "" && config.ExtraConfig != nil {
|
||||
secretKey = strings.TrimSpace(config.ExtraConfig["secret_key"])
|
||||
}
|
||||
if secretID == "" || secretKey == "" {
|
||||
return nil, fmt.Errorf("secret_id and secret_key are required for LKEAP rerank (set API Key and Secret Key)")
|
||||
}
|
||||
|
||||
region := LKEAPDefaultRegion
|
||||
if config.ExtraConfig != nil {
|
||||
if r := strings.TrimSpace(config.ExtraConfig["region"]); r != "" {
|
||||
region = r
|
||||
}
|
||||
}
|
||||
|
||||
credential := common.NewCredential(secretID, secretKey)
|
||||
cpf := profile.NewClientProfile()
|
||||
cpf.HttpProfile.Endpoint = LKEAPRerankEndpoint
|
||||
|
||||
client, err := lkeap.NewClient(credential, region, cpf)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("create LKEAP client: %w", err)
|
||||
}
|
||||
|
||||
modelName := strings.TrimSpace(config.ModelName)
|
||||
if modelName == "" {
|
||||
modelName = LKEAPDefaultRerankModel
|
||||
}
|
||||
|
||||
return &LKEAPReranker{
|
||||
modelName: modelName,
|
||||
modelID: config.ModelID,
|
||||
client: client,
|
||||
}, nil
|
||||
}
|
||||
|
||||
// Rerank 调用 RunRerank 对文档按与 query 的相关性打分。
|
||||
func (r *LKEAPReranker) Rerank(ctx context.Context, query string, documents []string) ([]RankResult, error) {
|
||||
if len(documents) == 0 {
|
||||
return []RankResult{}, nil
|
||||
}
|
||||
if len(documents) > 60 {
|
||||
return nil, fmt.Errorf("LKEAP rerank supports at most 60 documents, got %d", len(documents))
|
||||
}
|
||||
|
||||
req := lkeap.NewRunRerankRequest()
|
||||
req.Query = common.StringPtr(query)
|
||||
req.Docs = common.StringPtrs(documents)
|
||||
req.Model = common.StringPtr(r.modelName)
|
||||
|
||||
logger.Debugf(ctx, "%s", buildRerankRequestDebug(r.modelName, LKEAPRerankEndpoint, query, documents))
|
||||
|
||||
resp, err := r.client.RunRerankWithContext(ctx, req)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("LKEAP RunRerank: %w", err)
|
||||
}
|
||||
if resp == nil || resp.Response == nil || len(resp.Response.ScoreList) == 0 {
|
||||
return nil, fmt.Errorf("LKEAP rerank API returned empty score list")
|
||||
}
|
||||
|
||||
scores := resp.Response.ScoreList
|
||||
if len(scores) != len(documents) {
|
||||
return nil, fmt.Errorf("LKEAP rerank score count mismatch: got %d scores for %d documents",
|
||||
len(scores), len(documents))
|
||||
}
|
||||
|
||||
results := make([]RankResult, len(documents))
|
||||
for i, score := range scores {
|
||||
if score == nil {
|
||||
continue
|
||||
}
|
||||
results[i] = RankResult{
|
||||
Index: i,
|
||||
Document: DocumentInfo{
|
||||
Text: documents[i],
|
||||
},
|
||||
RelevanceScore: *score,
|
||||
}
|
||||
}
|
||||
return results, nil
|
||||
}
|
||||
|
||||
// GetModelName returns the rerank model name.
|
||||
func (r *LKEAPReranker) GetModelName() string {
|
||||
return r.modelName
|
||||
}
|
||||
|
||||
// GetModelID returns the model ID.
|
||||
func (r *LKEAPReranker) GetModelID() string {
|
||||
return r.modelID
|
||||
}
|
||||
@@ -0,0 +1,67 @@
|
||||
package rerank
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestNewLKEAPReranker_requiresCredentials(t *testing.T) {
|
||||
_, err := NewLKEAPReranker(&RerankerConfig{
|
||||
ModelName: "lke-reranker-base",
|
||||
})
|
||||
require.Error(t, err)
|
||||
assert.Contains(t, err.Error(), "secret_id")
|
||||
}
|
||||
|
||||
func TestNewLKEAPReranker_secretKeyFromExtraConfig(t *testing.T) {
|
||||
r, err := NewLKEAPReranker(&RerankerConfig{
|
||||
APIKey: "AKIDtest",
|
||||
ModelName: "lke-reranker-base",
|
||||
ExtraConfig: map[string]string{
|
||||
"secret_key": "sk-test",
|
||||
"region": "ap-beijing",
|
||||
},
|
||||
})
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, r)
|
||||
assert.Equal(t, "lke-reranker-base", r.GetModelName())
|
||||
}
|
||||
|
||||
func TestNewLKEAPReranker_defaultModelName(t *testing.T) {
|
||||
r, err := NewLKEAPReranker(&RerankerConfig{
|
||||
APIKey: "AKIDtest",
|
||||
AppSecret: "sk-test",
|
||||
})
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, LKEAPDefaultRerankModel, r.GetModelName())
|
||||
}
|
||||
|
||||
func TestLKEAPReranker_Rerank_emptyDocuments(t *testing.T) {
|
||||
r, err := NewLKEAPReranker(&RerankerConfig{
|
||||
APIKey: "AKIDtest",
|
||||
AppSecret: "sk-test",
|
||||
})
|
||||
require.NoError(t, err)
|
||||
|
||||
results, err := r.Rerank(t.Context(), "query", nil)
|
||||
require.NoError(t, err)
|
||||
assert.Empty(t, results)
|
||||
}
|
||||
|
||||
func TestLKEAPReranker_Rerank_tooManyDocuments(t *testing.T) {
|
||||
r, err := NewLKEAPReranker(&RerankerConfig{
|
||||
APIKey: "AKIDtest",
|
||||
AppSecret: "sk-test",
|
||||
})
|
||||
require.NoError(t, err)
|
||||
|
||||
docs := make([]string, 61)
|
||||
for i := range docs {
|
||||
docs[i] = "doc"
|
||||
}
|
||||
_, err = r.Rerank(t.Context(), "query", docs)
|
||||
require.Error(t, err)
|
||||
assert.Contains(t, err.Error(), "60")
|
||||
}
|
||||
@@ -152,6 +152,8 @@ func newReranker(config *RerankerConfig) (Reranker, error) {
|
||||
reranker, err = NewNvidiaReranker(config)
|
||||
case provider.ProviderWeKnoraCloud:
|
||||
reranker, err = NewWeKnoraCloudReranker(config)
|
||||
case provider.ProviderLKEAP:
|
||||
reranker, err = NewLKEAPReranker(config)
|
||||
default:
|
||||
reranker, err = NewOpenAIReranker(config)
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user