feat(knowledge): add ClearKnowledgeBaseContents API to delete all entries in a knowledge base

- Implemented ClearKnowledgeBaseContents function in the Client to asynchronously delete all knowledge entries while preserving the knowledge base.
- Added corresponding ClearKnowledgeBaseContents handler in the KnowledgeHandler to validate access and enqueue deletion tasks.
- Updated router to include a new DELETE endpoint for clearing knowledge base contents.
This commit is contained in:
wizardchen
2026-03-24 16:29:55 +08:00
committed by lyingbug
parent 2b56c4fbac
commit b980d4619d
3 changed files with 113 additions and 0 deletions
+27
View File
@@ -282,6 +282,33 @@ func (c *Client) DeleteKnowledgeBase(ctx context.Context, knowledgeBaseID string
return parseResponse(resp, &response)
}
// ClearKnowledgeBaseContentsResponse represents the response from clear knowledge base contents API
type ClearKnowledgeBaseContentsResponse struct {
DeletedCount int `json:"deleted_count"`
}
// ClearKnowledgeBaseContents deletes all knowledge entries in a knowledge base (async).
// The knowledge base itself is preserved; only its contents are removed.
func (c *Client) ClearKnowledgeBaseContents(ctx context.Context, knowledgeBaseID string) (*ClearKnowledgeBaseContentsResponse, error) {
path := fmt.Sprintf("/api/v1/knowledge-bases/%s/knowledge", knowledgeBaseID)
resp, err := c.doRequest(ctx, http.MethodDelete, path, nil, nil)
if err != nil {
return nil, err
}
var response struct {
Success bool `json:"success"`
Message string `json:"message"`
Data ClearKnowledgeBaseContentsResponse `json:"data"`
}
if err := parseResponse(resp, &response); err != nil {
return nil, err
}
return &response.Data, nil
}
// SearchParams represents the search parameters for hybrid search
type SearchParams struct {
QueryText string `json:"query_text"`
+84
View File
@@ -624,6 +624,90 @@ func (h *KnowledgeHandler) DeleteKnowledge(c *gin.Context) {
})
}
// ClearKnowledgeBaseContents godoc
// @Summary 清空知识库内容
// @Description 删除知识库下的所有知识条目(异步任务)。知识库本身保留,仅清空其中的内容
// @Tags 知识管理
// @Accept json
// @Produce json
// @Param id path string true "知识库ID"
// @Success 200 {object} map[string]interface{} "清空任务已提交"
// @Failure 400 {object} errors.AppError "请求参数错误"
// @Failure 403 {object} errors.AppError "权限不足"
// @Security Bearer
// @Security ApiKeyAuth
// @Router /knowledge-bases/{id}/knowledge [delete]
func (h *KnowledgeHandler) ClearKnowledgeBaseContents(c *gin.Context) {
ctx := c.Request.Context()
logger.Info(ctx, "Start clearing knowledge base contents")
kb, kbID, effectiveTenantID, permission, err := h.validateKnowledgeBaseAccess(c)
if err != nil {
c.Error(err)
return
}
// Only owner (admin with matching tenant) can clear knowledge base contents
tenantID := c.GetUint64(types.TenantIDContextKey.String())
if kb.TenantID != tenantID || permission != types.OrgRoleAdmin {
c.Error(errors.NewForbiddenError("Only knowledge base owner can clear contents"))
return
}
ctx = context.WithValue(ctx, types.TenantIDContextKey, effectiveTenantID)
knowledgeList, err := h.kgService.ListKnowledgeByKnowledgeBaseID(ctx, kbID)
if err != nil {
logger.ErrorWithFields(ctx, err, nil)
c.Error(errors.NewInternalServerError("Failed to list knowledge entries").WithDetails(err.Error()))
return
}
if len(knowledgeList) == 0 {
logger.Infof(ctx, "Knowledge base %s is already empty", secutils.SanitizeForLog(kbID))
c.JSON(http.StatusOK, gin.H{
"success": true,
"message": "Knowledge base is already empty",
"data": gin.H{"deleted_count": 0},
})
return
}
knowledgeIDs := make([]string, 0, len(knowledgeList))
for _, knowledge := range knowledgeList {
knowledgeIDs = append(knowledgeIDs, knowledge.ID)
}
payload := types.KnowledgeListDeletePayload{
TenantID: effectiveTenantID,
KnowledgeIDs: knowledgeIDs,
}
payloadBytes, err := json.Marshal(payload)
if err != nil {
logger.Errorf(ctx, "Failed to marshal knowledge list delete payload: %v", err)
c.Error(errors.NewInternalServerError("Failed to create cleanup task"))
return
}
task := asynq.NewTask(types.TypeKnowledgeListDelete, payloadBytes,
asynq.Queue("low"), asynq.MaxRetry(3))
info, err := h.asynqClient.Enqueue(task)
if err != nil {
logger.Errorf(ctx, "Failed to enqueue knowledge list delete task: %v", err)
c.Error(errors.NewInternalServerError("Failed to enqueue cleanup task"))
return
}
logger.Infof(ctx, "Knowledge base contents clear task enqueued: %s, kb_id: %s, count: %d",
info.ID, secutils.SanitizeForLog(kbID), len(knowledgeIDs))
c.JSON(http.StatusOK, gin.H{
"success": true,
"message": "Knowledge base contents clear task submitted",
"data": gin.H{"deleted_count": len(knowledgeIDs)},
})
}
// DownloadKnowledgeFile godoc
// @Summary 下载知识文件
// @Description 下载知识条目关联的原始文件
+2
View File
@@ -178,6 +178,8 @@ func RegisterKnowledgeRoutes(r *gin.RouterGroup, handler *handler.KnowledgeHandl
kb.POST("/manual", handler.CreateManualKnowledge)
// 获取知识库下的知识列表
kb.GET("", handler.ListKnowledge)
// 清空知识库下的所有知识
kb.DELETE("", handler.ClearKnowledgeBaseContents)
}
// 知识路由组