数据结构

Chunk

文件分片

被如下接口引用：QueryChunkList。

名称	类型	必选	描述
Id	String	否	切片ID 示例值：sdjfi
Content	String	否	切片内容 示例值：content
Size	Integer	否	切片的字数 示例值：10
Summary	String	否	切片概要 示例值：summary

ColumnInfo

知识库文档表列信息

被如下接口引用：GetKnowledgeBaseFileList。

名称	类型	必选	描述
Name	String	否	列名称 示例值：username
Type	String	否	列类型：int, bigint, double, date, datetime, string，decimal 示例值：int
Description	String	否	列名称描述 示例值：用户名称
Index	Integer	否	列索引 示例值：1
OriginalName	String	否	原始字段名称 示例值：name

CosFileInfo

cos 文件信息

被如下接口引用：UploadAndCommitFile。

名称	类型	必选	描述
FileName	String	否	文件名称，包含后缀 示例值：a.txt
FileType	String	否	文件类型，"PDF", "DOC", "DOCX", "XLS", "XLSX", "PPT", "PPTX", "MD", "TXT", "PNG", "JPG", "JPEG", "CSV" 示例值：DOC
UserCosUrl	String	否	用户文件的cosurl 示例值：http://xxx-bucket.ap-xxxx.cos.com/a.txt

ExampleQA

问答数据

被如下接口引用：AddScene, UpdateScene。

名称	类型	必选	描述
ExampleId	String	否	示例记录的唯一业务 ID 示例值：001
Questions	Array of String	否	问题列表 示例值：["100"]
Answer	String	否	对应的标准答案或回复 示例值：dfsb
Type	String	否	内容类型，类型包含 'text', 'sql', 'code' 示例值：code
CreateTime	String	否	记录的创建时间 示例值：2025-10-10 10:10:10
UpdateTime	String	否	记录的最后更新时间 示例值：2025-10-10 11:12:10

FileInfo

知识库文件信息

被如下接口引用：GetKnowledgeBaseFileList。

名称	类型	必选	描述
FileName	String	是	文件名称 示例值：信息.txt
FileSize	Float	是	文件大小，字节 示例值：1231.1
Type	Integer	是	文件类型,0=文本,1=表格，默认0 示例值：0
FileId	String	是	文件ID 示例值：xkewk9
Status	Integer	否	状态，0：数据处理中 1：可用 -1：错误 示例值：0
CreateUser	String	否	操作者 示例值：u8j8j
CreateTime	String	否	创建时间 示例值：2025-12-23 18:23:32
ChunkConfig	KnowledgeTaskConfig	否	分片策略
Source	Integer	否	文件来源0=unknow,1=user_cos,2=local 示例值：1
FileUrl	String	否	文件url 示例值：http://abc/dcd
IsShowCase	Integer	否	是否官方示例，0=否，1=是 示例值：1
DocumentSummary	String	否	文档摘要 示例值：sfsd

KnowledgeBase

知识库信息

被如下接口引用：GetKnowledgeBaseList。

名称	类型	必选	描述
KnowledgeBaseId	String	否	知识库id 示例值：klbase-dxjajwq
KnowledgeBaseName	String	否	知识库名称 示例值：测试知识库
KnowledgeBaseDesc	String	否	知识库描述 示例值：用户存放测试数据
Creator	String	否	创建者subuin 示例值：4348798
CreateTime	String	否	创建时间 示例值：2025-02-23 23:23:11
FileNum	Integer	否	文件数量 示例值：12
DatasourceIds	Array of String	否	知识库关联的数据库列表，目前是只绑定一个数据源，数组预留拓展 示例值：["datasource-xjaj","datasource_jxuamj"]

KnowledgeTaskConfig

任务配置

被如下接口引用：GetKnowledgeBaseFileList。

名称	类型	必选	描述
ChunkType	Integer	否	切片类型 0:自定义切片，1：智能切片 示例值：1
MaxChunkSize	Integer	否	/智能切片：最小值 1000，默认 4800 自定义切片：正整数即可,默认值 1000 示例值：1
Delimiters	Array of String	否	切片分隔符,自定义切片使用：默认值为：["\n\n", "\n", "。", "！", "？", "，", ""] 注意：此字段可能返回 null，表示取不到有效值。 示例值：[",","|"]
ChunkOverlap	Integer	否	自定义切片使用:默认0 可重叠字符长度 示例值：100
Columns	Array of ColumnInfo	否	表格类文档解析
Indexes	Array of Integer	否	带检索的索引列表 示例值：[1,2]
GenDocSummary	Integer	否	0：不生成文档摘要，1：生成文档概要。默认0，当取1时，GenParaSummary必须也为1 示例值：1
GenParaSummary	Integer	否	0：不生成段落摘要，1：生成段落概要。默认0 示例值：1

ModelUserAuthority

用户对象的权限

被如下接口引用：QueryUserAuthority。

名称	类型	必选	描述
InstanceId	String	否	实例id 示例值：dataagent-fsgdftertf
Module	String	否	模块，分为知识库knowledge、数据源datasource、自定义场景scene 示例值：knowledge/datasource/scene
CreatorUin	String	否	对象创建者 示例值：104354545634
ObjectId	String	否	对象id,分为知识库id、数据源id、场景id 示例值：kbase-ssfdsfs3
UseScope	Integer	否	作用范围：1仅自己使用，2指定用户，0全员 示例值：1
AuthorityUins	Array of String	否	可使用的用户列表 示例值：["1000031244","105335553"]
CreateTime	String	否	创建时间 示例值：2025-12-25 12:12:12
UpdateTime	String	否	更新时间 示例值：2025-12-25 12:12:12

Record

问答结构

被如下接口引用：GetSessionDetails。

名称	类型	必选	描述
Question	String	是	问题内容 示例值：hello
Answer	String	否	回答内容 示例值：hello
Think	String	否	思考内容 示例值：think
TaskList	Array of Task	否	任务列表
CreateTime	String	否	记录创建时间 示例值：2025-05-13 14:23:41
UpdateTime	String	否	记录更新时间 示例值：2025-05-13 14:23:41
RecordId	String	否	记录id 示例值：1j28j8-2j83e2-2312-xjax
FinalSummary	String	否	总结内容 示例值：总结
SessionId	String	否	会话ID 示例值：j28j8-2j83e2-2312-xazx
Feedback	Integer	否	1=赞，2=踩，0=无反馈 示例值：1
DbInfo	String	否	数据库信息 示例值："{"DbTable":[{"DbName":"database_name","TableList":["table1"]}],"DatasourceName":"test"}")
ErrorContext	String	否	错误信息 示例值：error msg
TaskListStr	String	否	TaskList的string字符串 示例值："{"TaskName":"task1"}"
KnowledgeBaseIds	Array of String	否	知识库id列表 示例值：["dxjajkke"]
Context	String	否	上下文 示例值："sdfs"

Scene

场景

被如下接口引用：AddScene, UpdateScene。

名称	类型	必选	描述
SceneId	String	否	场景ID 示例值：sn001
SceneName	String	否	场景名称 示例值：cran_sn
Skills	Array of String	否	技能列表，包含：rag（知识检索）、data_analytics（数据分析）、data_prediction（数据预测） 示例值：["rag"]
Prompt	String	否	提示词文本 示例值：key
Description	String	否	描述 示例值：mytest
SearchConfig	SearchConfig	否	检索配置
ExampleQAList	Array of ExampleQA	否	示例问答列表
CreateTime	String	否	记录的创建时间 示例值：2025-11-02 12:12:12
UpdateTime	String	否	记录的最后更新时间 示例值：2025-11-02 12:12:12
CreatorUin	String	否	创建者Uin 示例值：10104343253

SearchConfig

检索配置

被如下接口引用：AddScene, UpdateScene。

名称	类型	必选	描述
Type	Integer	否	检索类型：0:混合搜索 1：向量搜索 2：全文搜索 示例值：1
Num	Integer	否	召回数量最大值 示例值：100
EmbeddingWeight	Float	否	权重配置 示例值：0.5
Rerank	Integer	否	0:关闭 1:开启，默认1 示例值：1
AutoRag	Integer	否	0:关闭 1:开启，默认0 示例值：1
KnowledgeBaseIds	Array of String	否	AutoRag关联的知识库ID列表 示例值：["kb001"]
SearchStatus	Integer	否	AutoRag搜索状态：0-未完成，1-已完成。仅当AutoRag=1时，该字段有效 示例值：1

StepExpand

步骤扩展结构

被如下接口引用：GetSessionDetails。

名称	类型	必选	描述
Title	String	否	标题 示例值：数据查询
Status	String	否	状态 示例值：running
CellIds	Array of String	否	cellid数组

StepInfo

任务步骤

被如下接口引用：GetSessionDetails。

名称	类型	必选	描述
Id	Integer	是	步骤id 示例值：1
Name	String	是	步骤名称 示例值：查询
Status	String	是	步骤状态 示例值：待补充
Type	String	是	类型(text/expand) 示例值：text
Summary	String	否	总结 示例值：总结内容
Expand	StepExpand	否	步骤扩展结构
Desc	String	否	描述 示例值：描述

Task

任务信息

被如下接口引用：GetSessionDetails。

名称	类型	必选	描述
Id	Integer	否	任务ID 示例值：1
Name	String	否	任务名称 示例值：查询db
Status	String	否	任务状态 示例值：processing
StepInfoList	Array of StepInfo	否	任务步骤列表

UploadJob

上传任务

被如下接口引用：GetJobsByKnowledgeBaseId, GetUploadJobDetails。

名称	类型	必选	描述
Id	Integer	否	id 示例值：1
JobId	String	否	任务id 示例值：job-sfsfdsfd
InstanceId	String	否	实例id 示例值：data-afafase
KnowledgeBaseId	String	否	知识库id 示例值：kb-sssscsdfs
Uin	String	否	uin 示例值：1002213242
SubUin	String	否	subuin 示例值：10432523553
Status	String	否	Pending、FileUploading、 FileParsing、 Success、 Failed 示例值：FileUploading
CreateTime	String	否	任务创建时间 示例值：2025-11-11 12:12:12
UpdateTime	String	否	任务更新时间 示例值：2025-11-11 12:12:12
Message	String	否	错误信息 示例值：error:xxxxx