数据结构

最近更新时间:2025-12-09 01:33:00

我的收藏

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

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

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"

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

上传任务

被如下接口引用: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