red-future/common
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 19 Wiki Activity

修改rag的实体类

Browse Source
This commit is contained in:
Cold
2025-12-02 14:59:07 +08:00
committed by 张斌
parent cd3571554f
commit 5d4c8c8711
6 changed files with 78 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
ragflow/agent.go
View File

@@ -10,10 +10,17 @@ import (
// Agent Agent 结构体 // Agent Agent 结构体
type Agent struct { type Agent struct {
ID string `json:"id"` ID string `json:"id"` // Agent ID
Title string `json:"title"` Title string `json:"title"` // Agent 标题
Description string `json:"description"` Description string `json:"description"` // Agent 描述
DSL map[string]interface{} `json:"dsl"` // Canvas DSL 对象 Avatar string `json:"avatar"` // 头像（Base64 编码）
CanvasType string `json:"canvas_type"` // 画布类型
CreateDate string `json:"create_date"` // 创建日期（格式化字符串）
CreateTime int64 `json:"create_time"` // 创建时间（Unix 时间戳）
UpdateDate string `json:"update_date"` // 更新日期（格式化字符串）
UpdateTime int64 `json:"update_time"` // 更新时间（Unix 时间戳）
UserID string `json:"user_id"` // 用户 ID
DSL map[string]interface{} `json:"dsl"` // Canvas DSL 对象，定义 Agent 的工作流
} }
// CreateAgentReq 创建 Agent 请求 // CreateAgentReq 创建 Agent 请求
@@ -41,10 +48,10 @@ type ListAgentsReq struct {
} }
// ListAgentsRes 列出 Agent 响应 // ListAgentsRes 列出 Agent 响应
// 注意：API 不返回 total 字段，仅返回 data 数组
type ListAgentsRes struct { type ListAgentsRes struct {
Code int `json:"code"` Code int `json:"code"` // 状态码，0 表示成功
Data []*Agent `json:"data"` Data []*Agent `json:"data"` // Agent 列表
Total int `json:"total"`
} }
// CreateAgent 创建 Agent // CreateAgent 创建 Agent
@@ -79,7 +86,8 @@ func (c *Client) UpdateAgent(ctx context.Context, agentID string, req *UpdateAge
func (c *Client) DeleteAgent(ctx context.Context, agentID string) error { func (c *Client) DeleteAgent(ctx context.Context, agentID string) error {
path := fmt.Sprintf("/api/v1/agents/%s", agentID) path := fmt.Sprintf("/api/v1/agents/%s", agentID)
var res CommonResponse var res CommonResponse
if err := c.request(ctx, "DELETE", path, nil, &res); err != nil { // 官方文档要求传空对象，不是 nil
if err := c.request(ctx, "DELETE", path, map[string]interface{}{}, &res); err != nil {
return fmt.Errorf("delete agent failed: %w", err) return fmt.Errorf("delete agent failed: %w", err)
} }
if !res.IsSuccess() { if !res.IsSuccess() {

8
ragflow/chat.go
View File

@@ -82,10 +82,10 @@ type ListChatsReq struct {
} }
// ListChatsRes 列出聊天助手响应 // ListChatsRes 列出聊天助手响应
// 注意：API 不返回 total 字段，仅返回 data 数组
type ListChatsRes struct { type ListChatsRes struct {
Code int `json:"code"` Code int `json:"code"` // 状态码，0 表示成功
Data []*Chat `json:"data"` Data []*Chat `json:"data"` // 聊天助手列表
Total int `json:"total"` // API 文档中未明确 total 字段，但通常列表接口会有
} }
// DeleteChatsReq 删除聊天助手请求 // DeleteChatsReq 删除聊天助手请求
@@ -111,7 +111,7 @@ func (c *Client) CreateChat(ctx context.Context, req *CreateChatReq) (*Chat, err
// ListChats 列出聊天助手 // ListChats 列出聊天助手
func (c *Client) ListChats(ctx context.Context, req *ListChatsReq) (*ListChatsRes, error) { func (c *Client) ListChats(ctx context.Context, req *ListChatsReq) (*ListChatsRes, error) {
path := "/api/v1/chats?" path := "/api/v1/chats"
params := map[string]interface{}{} params := map[string]interface{}{}
if req.Page > 0 { if req.Page > 0 {
params["page"] = req.Page params["page"] = req.Page

11
ragflow/chunk.go
View File

@@ -39,12 +39,13 @@ type ListChunksReq struct {
} }
// ListChunksRes 列出知识块响应 // ListChunksRes 列出知识块响应
// 注意：响应结构包含 chunks（知识块列表）、doc（关联文档信息）和 total（总数）
type ListChunksRes struct { type ListChunksRes struct {
Code int `json:"code"` Code int `json:"code"` // 状态码，0 表示成功
Data struct { Data struct {
Chunks []*Chunk `json:"chunks"` Chunks []*Chunk `json:"chunks"` // 知识块列表
Doc interface{} `json:"doc"` // 文档信息，暂时用 interface{} Doc interface{} `json:"doc"` // 关联文档信息（完整的 Document 对象）
Total int `json:"total"` Total int `json:"total"` // 知识块总数
} `json:"data"` } `json:"data"`
} }
@@ -108,7 +109,7 @@ func (c *Client) AddChunk(ctx context.Context, datasetId, documentId string, req
// ListChunks 列出知识块 // ListChunks 列出知识块
func (c *Client) ListChunks(ctx context.Context, datasetId, documentId string, req *ListChunksReq) (*ListChunksRes, error) { func (c *Client) ListChunks(ctx context.Context, datasetId, documentId string, req *ListChunksReq) (*ListChunksRes, error) {
path := fmt.Sprintf("/api/v1/datasets/%s/documents/%s/chunks?", datasetId, documentId) path := fmt.Sprintf("/api/v1/datasets/%s/documents/%s/chunks", datasetId, documentId)
params := map[string]interface{}{} params := map[string]interface{}{}
if req.Keywords != "" { if req.Keywords != "" {
params["keywords"] = req.Keywords params["keywords"] = req.Keywords

9
ragflow/dataset.go
View File

@@ -67,10 +67,11 @@ type ListDatasetsReq struct {
} }
// ListDatasetsRes 列出数据集响应 // ListDatasetsRes 列出数据集响应
// 注意：与 Agent/Chat 等接口不同，Dataset API 会返回 total 字段
type ListDatasetsRes struct { type ListDatasetsRes struct {
Code int `json:"code"` Code int `json:"code"` // 状态码，0 表示成功
Data []*Dataset `json:"data"` Data []*Dataset `json:"data"` // 数据集列表
Total int `json:"total"` Total int `json:"total"` // 总数据集数
} }
// DeleteDatasetsReq 删除数据集请求 // DeleteDatasetsReq 删除数据集请求
@@ -97,7 +98,7 @@ func (c *Client) CreateDataset(ctx context.Context, req *CreateDatasetReq) (*Dat
// ListDatasets 列出数据集 // ListDatasets 列出数据集
func (c *Client) ListDatasets(ctx context.Context, req *ListDatasetsReq) (*ListDatasetsRes, error) { func (c *Client) ListDatasets(ctx context.Context, req *ListDatasetsReq) (*ListDatasetsRes, error) {
// 构建查询参数 // 构建查询参数
path := "/api/v1/datasets?" path := "/api/v1/datasets"
params := map[string]interface{}{} params := map[string]interface{}{}
if req.Page > 0 { if req.Page > 0 {
params["page"] = req.Page params["page"] = req.Page

58
ragflow/document.go
View File

@@ -3,12 +3,13 @@ package ragflow
import ( import (
"context" "context"
"fmt" "fmt"
"strings"
) )
// 数据集内文件管理 // 数据集内文件管理
// 参考: https://ragflow.com.cn/docs/dev/http_api_reference#数据集内文件管理 // 参考: https://ragflow.com.cn/docs/dev/http_api_reference#数据集内文件管理
// Document 文档结构体 // ... (rest of the code remains the same)
type Document struct { type Document struct {
Id string `json:"id"` Id string `json:"id"`
DatasetId string `json:"dataset_id"` DatasetId string `json:"dataset_id"`
@@ -39,22 +40,27 @@ type UploadDocumentReq struct {
// ListDocumentsReq 列出文档请求 // ListDocumentsReq 列出文档请求
type ListDocumentsReq struct { type ListDocumentsReq struct {
Page int `json:"page,omitempty"` Page int `json:"page,omitempty"` // 页码，默认 1
PageSize int `json:"page_size,omitempty"` PageSize int `json:"page_size,omitempty"` // 每页数量，默认 30
OrderBy string `json:"orderby,omitempty"` OrderBy string `json:"orderby,omitempty"` // 排序字段：create_time（默认）或 update_time
Desc bool `json:"desc,omitempty"` Desc bool `json:"desc,omitempty"` // 是否降序，默认 true
Keywords string `json:"keywords,omitempty"` Keywords string `json:"keywords,omitempty"` // 关键词过滤（匹配文档标题）
Id string `json:"id,omitempty"` Id string `json:"id,omitempty"` // 文档 ID 过滤
Name string `json:"name,omitempty"` Name string `json:"name,omitempty"` // 文档名称过滤
CreateTimeFrom int64 `json:"create_time_from,omitempty"` CreateTimeFrom int64 `json:"create_time_from,omitempty"` // 创建时间起始（Unix 时间戳），0 表示无限制
CreateTimeTo int64 `json:"create_time_to,omitempty"` CreateTimeTo int64 `json:"create_time_to,omitempty"` // 创建时间截止（Unix 时间戳），0 表示无限制
Suffix []string `json:"suffix,omitempty"` // 文件后缀过滤，如 ["pdf", "txt", "docx"]
Run []string `json:"run,omitempty"` // 处理状态过滤，支持 ["UNSTART", "RUNNING", "CANCEL", "DONE", "FAIL"] 或数字格式 ["0", "1", "2", "3", "4"]
} }
// ListDocumentsRes 列出文档响应 // ListDocumentsRes 列出文档响应
// 注意：响应结构与其他 List 接口不同，data 是一个对象而非数组
type ListDocumentsRes struct { type ListDocumentsRes struct {
Code int `json:"code"` Code int `json:"code"` // 状态码，0 表示成功
Data []*Document `json:"data"` Data struct {
Total int `json:"total"` Docs []*Document `json:"docs"` // 文档列表
TotalDatasets int `json:"total_datasets"` // 总文档数
} `json:"data"`
} }
// DeleteDocumentsReq 删除文档请求 // DeleteDocumentsReq 删除文档请求
@@ -64,7 +70,7 @@ type DeleteDocumentsReq struct {
// ListDocuments 列出文档 // ListDocuments 列出文档
func (c *Client) ListDocuments(ctx context.Context, datasetId string, req *ListDocumentsReq) (*ListDocumentsRes, error) { func (c *Client) ListDocuments(ctx context.Context, datasetId string, req *ListDocumentsReq) (*ListDocumentsRes, error) {
path := fmt.Sprintf("/api/v1/datasets/%s/documents?", datasetId) path := fmt.Sprintf("/api/v1/datasets/%s/documents", datasetId)
params := map[string]interface{}{} params := map[string]interface{}{}
if req.Page > 0 { if req.Page > 0 {
params["page"] = req.Page params["page"] = req.Page
@@ -96,11 +102,33 @@ func (c *Client) ListDocuments(ctx context.Context, datasetId string, req *ListD
params["create_time_to"] = req.CreateTimeTo params["create_time_to"] = req.CreateTimeTo
} }
// 构造查询字符串
query := buildQueryString(params) query := buildQueryString(params)
var queryParts []string
if query != "" { if query != "" {
path += "?" + query queryParts = append(queryParts, query)
} }
// 处理数组参数：suffix（文件后缀过滤）
// API 要求多个值时重复参数名，如：suffix=pdf&suffix=txt
// 这里使用 fmt.Sprintf 来构造每个参数值
for _, suffix := range req.Suffix {
queryParts = append(queryParts, fmt.Sprintf("suffix=%s", suffix))
}
// 处理数组参数：run（处理状态过滤）
// 支持数字格式（"0"-"4"）或文本格式（"UNSTART", "RUNNING", "CANCEL", "DONE", "FAIL"）
// 这里使用 fmt.Sprintf 来构造每个参数值
for _, run := range req.Run {
queryParts = append(queryParts, fmt.Sprintf("run=%s", run))
}
// 构造最终请求路径
if len(queryParts) > 0 {
path += "?" + strings.Join(queryParts, "&")
}
// 发送请求并处理响应
var res ListDocumentsRes var res ListDocumentsRes
if err := c.request(ctx, "GET", path, nil, &res); err != nil { if err := c.request(ctx, "GET", path, nil, &res); err != nil {
return nil, err return nil, err

8
ragflow/session.go
View File

@@ -43,10 +43,10 @@ type ListSessionsReq struct {
} }
// ListSessionsRes 列出会话响应 // ListSessionsRes 列出会话响应
// 注意：API 不返回 total 字段，仅返回 data 数组
type ListSessionsRes struct { type ListSessionsRes struct {
Code int `json:"code"` Code int `json:"code"` // 状态码，0 表示成功
Data []*Session `json:"data"` Data []*Session `json:"data"` // 会话列表
Total int `json:"total"` // API 文档未明确
} }
// DeleteSessionsReq 删除会话请求 // DeleteSessionsReq 删除会话请求
@@ -93,7 +93,7 @@ func (c *Client) CreateSession(ctx context.Context, chatId string, req *CreateSe
// ListSessions 列出会话 // ListSessions 列出会话
func (c *Client) ListSessions(ctx context.Context, chatId string, req *ListSessionsReq) (*ListSessionsRes, error) { func (c *Client) ListSessions(ctx context.Context, chatId string, req *ListSessionsReq) (*ListSessionsRes, error) {
path := fmt.Sprintf("/api/v1/chats/%s/sessions?", chatId) path := fmt.Sprintf("/api/v1/chats/%s/sessions", chatId)
params := map[string]interface{}{} params := map[string]interface{}{}
if req.Page > 0 { if req.Page > 0 {
params["page"] = req.Page params["page"] = req.Page