injectlib/WeKnora
1
0
Fork 0
mirror of https://github.com/Tencent/WeKnora.git synced 2025-11-25 19:37:45 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: Updated API documentation, added examples and fields, and adjusted responses and parameters.

Browse Source
This commit is contained in:
begoniezhao
2025-08-12 15:35:24 +08:00
committed by lyingbug
parent a347abf829
commit 705ea7a52c
3 changed files with 1488 additions and 803 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2275
docs/API.md
View File

File diff suppressed because it is too large Load Diff

14
internal/handler/evaluation.go
View File

@@ -22,10 +22,10 @@ func NewEvaluationHandler(evaluationService interfaces.EvaluationService) *Evalu
// EvaluationRequest contains parameters for evaluation request // EvaluationRequest contains parameters for evaluation request
type EvaluationRequest struct { type EvaluationRequest struct {
DatasetID string `json:"dataset_id"` // ID of dataset to evaluate DatasetID string `json:"dataset_id"` // ID of dataset to evaluate
EmbeddingModelID string `json:"embedding_id"` // ID of embedding model to use KnowledgeBaseID string `json:"knowledge_base_id"` // ID of knowledge base to use
ChatModelID string `json:"chat_id"` // ID of chat model to use ChatModelID string `json:"chat_id"` // ID of chat model to use
RerankModelID string `json:"rerank_id"` // ID of rerank model to use RerankModelID string `json:"rerank_id"` // ID of rerank model to use
} }
// Evaluation handles evaluation request // Evaluation handles evaluation request
@@ -48,12 +48,12 @@ func (e *EvaluationHandler) Evaluation(c *gin.Context) {
return return
} }
logger.Infof(ctx, "Executing evaluation, tenant: %v, dataset: %s, embedding: %s, chat: %s, rerank: %s", logger.Infof(ctx, "Executing evaluation, tenant: %v, dataset: %s, knowledge_base: %s, chat: %s, rerank: %s",
tenantID, request.DatasetID, request.EmbeddingModelID, request.ChatModelID, request.RerankModelID) tenantID, request.DatasetID, request.KnowledgeBaseID, request.ChatModelID, request.RerankModelID)
task, err := e.evaluationService.Evaluation(ctx, task, err := e.evaluationService.Evaluation(ctx,
request.DatasetID, request.DatasetID,
request.EmbeddingModelID, request.KnowledgeBaseID,
request.ChatModelID, request.ChatModelID,
request.RerankModelID, request.RerankModelID,
) )

2
internal/types/interfaces/evaluation.go
View File

@@ -9,7 +9,7 @@ import (
// EvaluationService defines operations for evaluation tasks // EvaluationService defines operations for evaluation tasks
type EvaluationService interface { type EvaluationService interface {
// Evaluation starts a new evaluation task // Evaluation starts a new evaluation task
Evaluation(ctx context.Context, datasetID string, embeddingModelID string, Evaluation(ctx context.Context, datasetID string, knowledgeBaseID string,
chatModelID string, rerankModelID string, chatModelID string, rerankModelID string,
) (*types.EvaluationDetail, error) ) (*types.EvaluationDetail, error)
// EvaluationResult retrieves evaluation result by task ID // EvaluationResult retrieves evaluation result by task ID