帮你快速理解、总结文档立即下载

数据结构

最近更新时间:2026-09-24 01:54:06
我的收藏

AppendDocument

追加文件

被如下接口引用:AppendKnowledgeTask。

名称 类型 必选 描述
FileName String 是

文件名称


示例值:test.csv
FileId String 是

文件id


示例值:2ca9279d-21ea-4e39-8b3b-c49c65ba83ea
FileUrl String 是

文件url


示例值:https://data-agent-dev-1353879163.cos.ap-chongqing.myqcloud.com/user-storage/100041873387/klbase-YuVJ1k3U37/2ca9279d-21ea-4e39-8b3b-c49c65ba83eb_test.csv
FileSize Float 是

文件大小


示例值:111111

Chunk

文件分片

被如下接口引用:QueryChunkList。

名称 类型 必选 描述
Id String 否

切片ID


示例值:sdjfi
Content String 否

切片内容


示例值:content
Size Integer 否

切片的字数


示例值:10
Summary String 否

切片概要


示例值:summary
ChunkSource Integer 否

分段类型

枚举值:

  • 0: 自动分段
  • 1: 新建分段

示例值:0

ColumnInfo

知识库文档表列信息

被如下接口引用:ModifyKnowledgeBase。

名称 类型 必选 描述
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
UpdateTime 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
WebUrl String 否

网页地址


示例值:http://www.baidu.com
Capabilities Array of String 否

文件能力标识列表


示例值:["readme"]
EnableGraphBuild Integer 否

0:关闭 1:开启图谱构建(入库时构建图谱),默认0


示例值:0
EnableTreeBuild Integer 否

0:关闭 1:开启树构建(入库时构建树),默认0


示例值:0
GraphBuildStatus Integer 否

图谱构建状态:null=未启用图谱; 0=待入库; 1=入库中; 2=入库成功; -1=入库失败(仅 EnableGraphBuild=1 时有意义)


示例值:0
TreeBuildStatus Integer 否

图谱构建状态:null=未启用图谱; 0=待入库; 1=入库中; 2=入库成功; -1=入库失败(仅 EnableGraphBuild=1 时有意义)


示例值:0

FileTaskStatus

文件任务状态

被如下接口引用:QueryKnowledgeTask。

名称 类型 必选 描述
FileId String 否

文件id


示例值:de1c7e8b-ace4-4d1f-8b2c-953d67a0128c
Status Integer 否

状态

枚举值:

  • 0: 处理中
  • 1: 可用
  • -1: 错误

示例值:1
IsTerminated Integer 否

是否已拉取过状态

枚举值:

  • 0: 未被拉取过状态
  • 1: 已被拉取过状态

示例值:1
ErrorMsg String 否

错误信息,状态-1时不为空


示例值:文件名:****.xlsx。追加文件结构与目标表不一致,请检查表头是否完整后重新上传。

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"]
Config KnowledgeTaskConfig 否

知识库任务配置

KnowledgeTaskConfig

任务配置

被如下接口引用:GetKnowledgeBaseFileList, GetKnowledgeBaseList, ModifyKnowledgeBase。

名称 类型 必选 描述
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
EnableImageUnderstanding Integer 否

0:不开启图片理解,1:开启图片理解。默认1

取值范围:[1, 10000]

默认值:1


示例值:1
EnableExtractDb Integer 否

是否开启表格结构化提取

枚举值:

  • 0: 不开启表格提取
  • 1: 开启表格提取

默认值:1


示例值:1
EnableGraphBuild Integer 否

0:关闭 1:开启图谱构建(入库时),默认0


示例值:0
EnableTreeBuild Integer 否

0:关闭 1:开启树构建(入库时),默认0


示例值:0

ModelList

模型详情

被如下接口引用:QueryModels。

名称 类型 必选 描述
Model String 否

模型版本名称


示例值:deepseek-v3.2
Vendor String 否

模型厂商


示例值:deepseek
DisplayName String 否

展示名称


示例值:DeepSeek-V3.2
Description String 否

模型描述


示例值:DeepSeek系列大模型
ContextWindow Integer 否

上下文窗口大小,单位 token


示例值:128000
IconUrl String 否

模型图标 URL


示例值:https://xxxxx.png
CreditMultiplier Float 否

计费倍率


示例值:3.33
Thinking Thinking 否

思考配置

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

RecordList

记录列表

被如下接口引用:QueryUserSessionDetail。

名称 类型 描述
Context String

会话上下文


示例值:{"KnowledgeBases":[{"KnowledgeBaseId":"klbase-TX1cUnuOLa","FileIds":[],"SelectAllFiles":true,"DbTables":[]},{"KnowledgeBaseId":"klbase-YlPWM4EWXt","FileIds":[],"SelectAllFiles":true,"DbTables":[]}],"SceneId":"","Version":"2.0.1","DataSourceInfo":{}}
RecordId String

记录id


示例值:c36a73a9-c158-4e88-9aff-161115ab2036
TraceId String

追踪id


示例值:7c6d5c68-dc83-4929-b3f2-c1909633701a
SessionId String

会话id


示例值:5a905d26-a24d-47cc-a5e4-00f2d27155da
Question String

问题


示例值:模拟一个工具调用失败的场景?
Answer String

回答


示例值:["durationMs": 823}, {"kind": "run.finished", "name": "", "status": "completed", "payload": {"status": "completed"}, "durationMs": null}]
Feedback Integer

0-否定反馈, 1-肯定反馈


示例值:0
ErrorContext String

错误信息


示例值:Internal error.
CreateTime String

创建时间


示例值:2026-07-15T10:51:38.862993+00:00
UpdateTime String

更新时间


示例值:2026-07-15T10:51:44.358128+00:00
Model String

模型信息


示例值:deepseek-v4-pro-202606

Thinking

模型思考强度

被如下接口引用:QueryModels。

名称 类型 必选 描述
Mode String 否

模式

枚举值:

  • toggle: 可开关
  • always_on: 固定开启
  • always_off: 固定关闭
  • unconfigured: 未配置

示例值:toggle
DefaultEnabled Boolean 否

默认是否开启思考


示例值:true
EffortOptions Array of String 否

思考强度可选项,如 ["high","max"]


示例值:["high"]
DefaultEffort String 否

默认思考强度


示例值:high

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