Files
Enterprise-Knowledge-Base/internal/models/rerank/lkeap_reranker.go
T
wizardchen dda16436d0 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.
2026-06-04 17:22:18 +08:00

125 lines
3.6 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
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
}