mirror of
https://github.com/infiniflow/ragflow.git
synced 2026-08-02 05:47:31 +08:00
### Summary Aligns Go and Python error codes/messages so both backends honor the same RESTful API contract, removing implementation-specific error leaks (MySQL errors, `ValueError`, `AttributeError`, Gin validator format) in favor of clean business error codes. **Chat list** — invalid `orderby` now returns code 101 (was: raw Python `AttributeError` code 100); invalid `page`/`page_size` values fall back to defaults (was: raw `ValueError`/`ProgrammingError` code 100). **Dataset create/update/delete** — adds UUID validation (101), extra-field rejection (101), duplicate-id detection (101), content-type / JSON-syntax / object-shape checks (101), and "lacks permission" for nonexistent datasets (IDOR). Create auto-deduplicates dataset names. Pagerank updates tolerate a missing ES index. List response includes `parser_config` and `pagerank`. **Session list/update** — adds filtering, sorting, and pagination support. Empty payloads are valid no-ops. Authorization errors map to code 109. **Chunk list** — doc object uses Python key names (`chunk_count`, `dataset_id`, `chunk_method`, run text status). Add validates list element types. **Document update** — adds `chunk_method` alias, pydantic-style Field error messages, metadata index auto-create with refresh, and "These documents do not belong to dataset" messages. List validates `metadata_condition` and reports ownership errors for unmatched name/id filters. **Search completion** — `kb_ids` ownership failure returns code 102 instead of 109. Released 31 contract tests from `GO_ONLY_SKIPS` (all verified passing on both Go and Python backends with real LLM keys).
479 lines
14 KiB
Go
479 lines
14 KiB
Go
//
|
|
// Copyright 2026 The InfiniFlow Authors. All Rights Reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//
|
|
|
|
package handler
|
|
|
|
import (
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"ragflow/internal/common"
|
|
"strconv"
|
|
"strings"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
|
|
"ragflow/internal/service"
|
|
)
|
|
|
|
// ChatSessionHandler chat session (conversation) handler
|
|
type ChatSessionHandler struct {
|
|
chatSessionService *service.ChatSessionService
|
|
userService *service.UserService
|
|
}
|
|
|
|
// NewChatSessionHandler create chat session handler
|
|
func NewChatSessionHandler(chatSessionService *service.ChatSessionService, userService *service.UserService) *ChatSessionHandler {
|
|
return &ChatSessionHandler{
|
|
chatSessionService: chatSessionService,
|
|
userService: userService,
|
|
}
|
|
}
|
|
|
|
// ListChatSessions list chat sessions for a dialog
|
|
// @Summary List Chat Sessions
|
|
// @Description Get list of chat sessions for a specific dialog
|
|
// @Tags chat_session
|
|
// @Accept json
|
|
// @Produce json
|
|
// @Param chat_id query string true "chat ID"
|
|
// @Success 200 {object} service.ListChatSessionsResponse
|
|
// @Router /api/v1/chats/<chat_id>/sessions [get]
|
|
func (h *ChatSessionHandler) ListChatSessions(c *gin.Context) {
|
|
user, errorCode, errorMessage := GetUser(c)
|
|
if errorCode != common.CodeSuccess {
|
|
common.ErrorWithCode(c, errorCode, errorMessage)
|
|
return
|
|
}
|
|
userID := user.ID
|
|
|
|
// Get chat_id from query parameter
|
|
chatID := c.Param("chat_id")
|
|
if chatID == "" {
|
|
common.ResponseWithHttpCodeData(c, http.StatusBadRequest, 400, nil, "chat_id is required")
|
|
return
|
|
}
|
|
|
|
// Mirror Python's list_sessions query handling: invalid/negative page
|
|
// values fall back to the default; page_size 0 yields an empty list and a
|
|
// negative page_size disables pagination.
|
|
page := 1
|
|
if pageStr := c.Query("page"); pageStr != "" {
|
|
if p, err := strconv.Atoi(pageStr); err == nil && p > 0 {
|
|
page = p
|
|
}
|
|
}
|
|
pageSize := 30
|
|
if pageSizeStr := c.Query("page_size"); pageSizeStr != "" {
|
|
if ps, err := strconv.Atoi(pageSizeStr); err == nil {
|
|
pageSize = ps
|
|
}
|
|
}
|
|
|
|
orderby := "create_time"
|
|
if queryOrderby := c.Query("orderby"); queryOrderby != "" {
|
|
switch queryOrderby {
|
|
case "create_time", "update_time", "name":
|
|
orderby = queryOrderby
|
|
default:
|
|
common.ResponseWithCodeData(c, common.CodeArgumentError, nil, fmt.Sprintf("invalid orderby field: %s", queryOrderby))
|
|
return
|
|
}
|
|
}
|
|
|
|
desc := true
|
|
if descStr := c.Query("desc"); descStr != "" {
|
|
desc = !strings.EqualFold(descStr, "false")
|
|
}
|
|
|
|
// Call service to list chat sessions
|
|
ctx := c.Request.Context()
|
|
result, err := h.chatSessionService.ListChatSessions(ctx, userID, chatID, c.Query("id"), c.Query("name"), orderby, desc, page, pageSize)
|
|
if err != nil {
|
|
// Mirror Python: ownership failures return code 109 "No authorization."
|
|
if strings.Contains(err.Error(), "No authorization") {
|
|
common.ResponseWithCodeData(c, common.CodeAuthenticationError, false, "No authorization.")
|
|
return
|
|
}
|
|
common.ResponseWithHttpCodeData(c, http.StatusInternalServerError, 500, nil, err.Error())
|
|
return
|
|
}
|
|
|
|
common.SuccessWithData(c, result.Sessions, "success")
|
|
}
|
|
|
|
type ChatCompletionsRequest struct {
|
|
ChatID string `json:"chat_id,omitempty"`
|
|
SessionID string `json:"session_id,omitempty"`
|
|
ConversationID string `json:"conversation_id,omitempty"`
|
|
Messages []map[string]interface{} `json:"messages,omitempty"`
|
|
Question string `json:"question,omitempty"`
|
|
Files []interface{} `json:"files,omitempty"`
|
|
LLMID string `json:"llm_id,omitempty"`
|
|
PassAllHistoryMessages *bool `json:"pass_all_history_messages,omitempty"`
|
|
PassAllHistory *bool `json:"pass_all_history,omitempty"`
|
|
Legacy bool `json:"legacy,omitempty"`
|
|
Stream *bool `json:"stream"`
|
|
Temperature *float64 `json:"temperature,omitempty"`
|
|
TopP *float64 `json:"top_p,omitempty"`
|
|
FrequencyPenalty *float64 `json:"frequency_penalty,omitempty"`
|
|
PresencePenalty *float64 `json:"presence_penalty,omitempty"`
|
|
MaxTokens *int `json:"max_tokens,omitempty"`
|
|
}
|
|
|
|
// ChatCompletions chat completion
|
|
// @Summary Chat Completion
|
|
// @Description Send messages to the chat model and get a response.
|
|
// @Description Default is streaming (text/event-stream); set stream:false for JSON.
|
|
// @Tags chat_session
|
|
// @Accept json
|
|
// @Produce json, text/event-stream
|
|
// @Param request body ChatCompletionsRequest true "chat completion request"
|
|
// @Success 200 {object} map[string]interface{} "Non-streaming JSON response"
|
|
// @Success 200 {string} text/event-stream "Streaming SSE response"
|
|
// @Router /api/v1/chat/completions [post]
|
|
func (h *ChatSessionHandler) ChatCompletions(c *gin.Context) {
|
|
user, errorCode, errorMessage := GetUser(c)
|
|
if errorCode != common.CodeSuccess {
|
|
common.ErrorWithCode(c, errorCode, errorMessage)
|
|
return
|
|
}
|
|
userID := user.ID
|
|
|
|
var rawBody map[string]interface{}
|
|
if err := c.ShouldBindJSON(&rawBody); err != nil {
|
|
common.ErrorWithCode(c, common.CodeBadRequest, err.Error())
|
|
return
|
|
}
|
|
|
|
var req ChatCompletionsRequest
|
|
b, err := json.Marshal(rawBody)
|
|
if err != nil {
|
|
common.ErrorWithCode(c, common.CodeBadRequest, err.Error())
|
|
return
|
|
}
|
|
if err = json.Unmarshal(b, &req); err != nil {
|
|
common.ErrorWithCode(c, common.CodeBadRequest, err.Error())
|
|
return
|
|
}
|
|
|
|
// Normalize session_id / conversation_id
|
|
sessionID := req.SessionID
|
|
if sessionID == "" {
|
|
sessionID = req.ConversationID
|
|
}
|
|
|
|
// Build generation config
|
|
genConfig := make(map[string]interface{})
|
|
if req.Temperature != nil {
|
|
genConfig["temperature"] = *req.Temperature
|
|
}
|
|
if req.TopP != nil {
|
|
genConfig["top_p"] = *req.TopP
|
|
}
|
|
if req.FrequencyPenalty != nil {
|
|
genConfig["frequency_penalty"] = *req.FrequencyPenalty
|
|
}
|
|
if req.PresencePenalty != nil {
|
|
genConfig["presence_penalty"] = *req.PresencePenalty
|
|
}
|
|
if req.MaxTokens != nil {
|
|
genConfig["max_tokens"] = *req.MaxTokens
|
|
}
|
|
|
|
// Resolve pass_all_history from either alias
|
|
passAllHistory := false
|
|
if req.PassAllHistory != nil {
|
|
passAllHistory = *req.PassAllHistory
|
|
}
|
|
if req.PassAllHistoryMessages != nil {
|
|
passAllHistory = *req.PassAllHistoryMessages
|
|
}
|
|
|
|
// Remove known keys from rawBody; what remains is passthrough kwargs
|
|
knownKeys := []string{
|
|
"chat_id", "session_id", "conversation_id",
|
|
"messages", "question", "files",
|
|
"llm_id",
|
|
"pass_all_history_messages", "pass_all_history",
|
|
"legacy", "stream",
|
|
"temperature", "top_p", "frequency_penalty", "presence_penalty", "max_tokens",
|
|
}
|
|
for _, key := range knownKeys {
|
|
delete(rawBody, key)
|
|
}
|
|
kwargs := rawBody
|
|
|
|
// Determine stream mode
|
|
streamMode := true
|
|
if req.Stream != nil {
|
|
streamMode = *req.Stream
|
|
}
|
|
|
|
if streamMode {
|
|
disableWriteDeadlineForSSE(c)
|
|
c.Header("Content-Type", "text/event-stream")
|
|
c.Header("Cache-Control", "no-cache")
|
|
c.Header("Connection", "keep-alive")
|
|
c.Header("X-Accel-Buffering", "no")
|
|
|
|
streamChan := make(chan string, 32)
|
|
reqCtx := c.Request.Context()
|
|
go func() {
|
|
defer close(streamChan)
|
|
_, _ = h.chatSessionService.ChatCompletions(
|
|
reqCtx, userID,
|
|
req.ChatID, sessionID,
|
|
req.Messages, req.Question, req.Files,
|
|
req.LLMID, genConfig, kwargs,
|
|
passAllHistory, req.Legacy,
|
|
true, streamChan,
|
|
)
|
|
}()
|
|
|
|
c.Stream(func(w io.Writer) bool {
|
|
data, ok := <-streamChan
|
|
if !ok {
|
|
return false
|
|
}
|
|
c.Writer.Write([]byte(data))
|
|
return true
|
|
})
|
|
} else {
|
|
var result map[string]interface{}
|
|
result, err = h.chatSessionService.ChatCompletions(
|
|
c.Request.Context(), userID,
|
|
req.ChatID, sessionID,
|
|
req.Messages, req.Question, req.Files,
|
|
req.LLMID, genConfig, kwargs,
|
|
passAllHistory, req.Legacy,
|
|
false, nil,
|
|
)
|
|
if err != nil {
|
|
var codedErr *common.CodedError
|
|
if errors.As(err, &codedErr) {
|
|
common.ErrorWithCode(c, codedErr.Code, codedErr.Message)
|
|
return
|
|
}
|
|
common.ResponseWithHttpCodeData(c, http.StatusInternalServerError, 500, nil, err.Error())
|
|
return
|
|
}
|
|
common.SuccessWithData(c, result, "")
|
|
}
|
|
}
|
|
|
|
func (h *ChatSessionHandler) GetSession(c *gin.Context) {
|
|
user, errorCode, errorMessage := GetUser(c)
|
|
if errorCode != common.CodeSuccess {
|
|
common.ErrorWithCode(c, errorCode, errorMessage)
|
|
return
|
|
}
|
|
|
|
userID := user.ID
|
|
chatID, sessionID := c.Param("chat_id"), c.Param("session_id")
|
|
|
|
ctx := c.Request.Context()
|
|
result, code, err := h.chatSessionService.GetSession(ctx, userID, chatID, sessionID)
|
|
if err != nil {
|
|
common.ErrorWithCode(c, code, err.Error())
|
|
return
|
|
}
|
|
common.SuccessWithData(c, result, "success")
|
|
}
|
|
|
|
// CreateSession create a session in a dialog
|
|
func (h *ChatSessionHandler) CreateSession(c *gin.Context) {
|
|
user, errorCode, errorMessage := GetUser(c)
|
|
if errorCode != common.CodeSuccess {
|
|
common.ErrorWithCode(c, errorCode, errorMessage)
|
|
return
|
|
}
|
|
|
|
userID := strings.TrimSpace(user.ID)
|
|
if userID == "" {
|
|
common.ResponseWithCodeData(c, common.CodeBadRequest, nil, "user_id is required")
|
|
return
|
|
}
|
|
|
|
chatID := strings.TrimSpace(c.Param("chat_id"))
|
|
if chatID == "" {
|
|
common.ResponseWithCodeData(c, common.CodeBadRequest, nil, "chat_id is required")
|
|
return
|
|
}
|
|
|
|
req := map[string]interface{}{}
|
|
if err := json.NewDecoder(c.Request.Body).Decode(&req); err != nil {
|
|
if errors.Is(err, io.EOF) {
|
|
req = map[string]interface{}{}
|
|
} else {
|
|
// Mirror Python's malformed-JSON contract message.
|
|
common.ResponseWithCodeData(c, common.CodeArgumentError, nil, "Malformed JSON syntax: Missing commas/brackets or invalid encoding")
|
|
return
|
|
}
|
|
}
|
|
if req == nil {
|
|
req = map[string]interface{}{}
|
|
}
|
|
|
|
ctx := c.Request.Context()
|
|
result, code, err := h.chatSessionService.CreateSession(ctx, userID, chatID, req)
|
|
if err != nil {
|
|
if code == common.CodeAuthenticationError {
|
|
common.ResponseWithCodeData(c, code, false, err.Error())
|
|
return
|
|
}
|
|
common.ErrorWithCode(c, code, err.Error())
|
|
return
|
|
}
|
|
|
|
common.SuccessWithData(c, result, "success")
|
|
}
|
|
|
|
// DeleteSessions delete a session in a dialog
|
|
func (h *ChatSessionHandler) DeleteSessions(c *gin.Context) {
|
|
user, errorCode, errorMessage := GetUser(c)
|
|
if errorCode != common.CodeSuccess {
|
|
common.ErrorWithCode(c, errorCode, errorMessage)
|
|
return
|
|
}
|
|
|
|
chatID := strings.TrimSpace(c.Param("chat_id"))
|
|
if chatID == "" {
|
|
common.ResponseWithCodeData(c, common.CodeBadRequest, nil, "chat_id is required")
|
|
return
|
|
}
|
|
|
|
userID := strings.TrimSpace(user.ID)
|
|
if userID == "" {
|
|
common.ResponseWithCodeData(c, common.CodeBadRequest, nil, "user_id is required")
|
|
return
|
|
}
|
|
|
|
req := map[string]interface{}{}
|
|
if err := json.NewDecoder(c.Request.Body).Decode(&req); err != nil {
|
|
if errors.Is(err, io.EOF) {
|
|
req = map[string]interface{}{}
|
|
} else {
|
|
// Mirror Python's malformed-JSON contract message.
|
|
common.ResponseWithCodeData(c, common.CodeArgumentError, nil, "Malformed JSON syntax: Missing commas/brackets or invalid encoding")
|
|
return
|
|
}
|
|
}
|
|
if req == nil {
|
|
req = map[string]interface{}{}
|
|
}
|
|
|
|
ctx := c.Request.Context()
|
|
result, message, code, err := h.chatSessionService.DeleteSessions(ctx, userID, chatID, req)
|
|
if err != nil {
|
|
if code == common.CodeAuthenticationError {
|
|
common.ResponseWithCodeData(c, code, false, err.Error())
|
|
return
|
|
}
|
|
common.ErrorWithCode(c, code, err.Error())
|
|
return
|
|
}
|
|
|
|
common.SuccessWithData(c, result, message)
|
|
}
|
|
|
|
func (h *ChatSessionHandler) UpdateSession(c *gin.Context) {
|
|
user, errorCode, errorMessage := GetUser(c)
|
|
if errorCode != common.CodeSuccess {
|
|
common.ErrorWithCode(c, errorCode, errorMessage)
|
|
return
|
|
}
|
|
|
|
userID := user.ID
|
|
chatID, sessionID := c.Param("chat_id"), c.Param("session_id")
|
|
|
|
// An empty payload is a valid no-op (mirrors Python's update_session).
|
|
req := map[string]any{}
|
|
if err := c.ShouldBindJSON(&req); err != nil && !errors.Is(err, io.EOF) {
|
|
common.ResponseWithCodeData(c, common.CodeArgumentError, nil, "Invalid request: "+err.Error())
|
|
return
|
|
}
|
|
|
|
ctx := c.Request.Context()
|
|
result, code, err := h.chatSessionService.UpdateSession(ctx, userID, chatID, sessionID, req)
|
|
if err != nil {
|
|
common.ErrorWithCode(c, code, err.Error())
|
|
return
|
|
}
|
|
common.SuccessWithData(c, result, "success")
|
|
}
|
|
|
|
func (h *ChatSessionHandler) DeleteSessionMessage(c *gin.Context) {
|
|
user, errorCode, errorMessage := GetUser(c)
|
|
if errorCode != common.CodeSuccess {
|
|
common.ErrorWithCode(c, errorCode, errorMessage)
|
|
return
|
|
}
|
|
userID := user.ID
|
|
chatID, sessionID, msgID := c.Param("chat_id"), c.Param("session_id"), c.Param("msg_id")
|
|
|
|
ctx := c.Request.Context()
|
|
result, code, err := h.chatSessionService.DeleteSessionMessage(ctx, userID, chatID, sessionID, msgID)
|
|
if err != nil {
|
|
if code == common.CodeAuthenticationError {
|
|
common.ResponseWithCodeData(c, code, false, err.Error())
|
|
return
|
|
}
|
|
common.ErrorWithCode(c, code, err.Error())
|
|
return
|
|
}
|
|
common.SuccessWithData(c, result, "success")
|
|
}
|
|
|
|
func (h *ChatSessionHandler) UpdateMessageFeedback(c *gin.Context) {
|
|
user, errorCode, errorMessage := GetUser(c)
|
|
if errorCode != common.CodeSuccess {
|
|
common.ErrorWithCode(c, errorCode, errorMessage)
|
|
return
|
|
}
|
|
|
|
userID := user.ID
|
|
chatID, sessionID, msgID := c.Param("chat_id"), c.Param("session_id"), c.Param("msg_id")
|
|
|
|
req := map[string]interface{}{}
|
|
if err := c.ShouldBindJSON(&req); err != nil {
|
|
if errors.Is(err, io.EOF) {
|
|
common.ResponseWithCodeData(c, common.CodeArgumentError, nil,
|
|
"Request body cannot be empty")
|
|
return
|
|
}
|
|
common.ResponseWithCodeData(c, common.CodeArgumentError, nil, "Invalid request: "+err.Error())
|
|
return
|
|
}
|
|
if len(req) == 0 {
|
|
common.ResponseWithCodeData(c, common.CodeArgumentError, nil, "Request body cannot be empty")
|
|
return
|
|
}
|
|
|
|
result, code, err := h.chatSessionService.UpdateMessageFeedback(c.Request.Context(), userID, chatID, sessionID, msgID, req)
|
|
if err != nil {
|
|
if code == common.CodeAuthenticationError {
|
|
common.ResponseWithCodeData(c, code, false, err.Error())
|
|
return
|
|
}
|
|
common.ErrorWithCode(c, code, err.Error())
|
|
return
|
|
}
|
|
common.SuccessWithData(c, result, "success")
|
|
}
|