Skip to main content

公共响应数据字典

本页定义多接口复用的对象,接口页会明确 data 是对象、数组还是分页条目,并链接到对应模型。

空值与扩展规则:资源类型、处理阶段和调用入口决定可选字段是否有值。展示、统计、权限及解析配置字段可能为空或未输出;客户端应允许 null、空集合和未知扩展字段。没有统计数据不等于数值为零,没有正文不等于文件不存在。日期、大整数和响应包装见 通用约定

KnowledgeContainer · 知识库

字段JSON 类型说明
idinteger/主/键/i/d/
creatorstring/创/建/人/
creatorNamestring/创/建/人/名/字/
creatorAvatarstring/头/像/
createTimestring/创/建/时/间/;日期时间字符串,可无时区偏移
modifierstring/修/改/人/
modifierTimestring/修/改/时/间/;日期时间字符串,可无时区偏移
sortinteger/排/序/
namestring/知/识/库/名/称/
categorystring/知/识/库/类/别/;/常/用/ /C/O/M/M/O/N/、/D/A/T/A/B/A/S/E/、/W/E/B/S/I/T/E/,/按/实/际/返/回/枚/举/处/理/
createModeLabelstring/创/建/模/式/文/案/
archivedinteger/是/否/已/归/档/,/0/-/未/归/档/,/1/-/已/归/档/
descriptionstring/描/述/
codestring/编/码/i/d/
typestring/容/器/类/型/:/K/N/O/W/L/E/D/G/E/ /知/识/库/、/D/I/R/E/C/T/O/R/Y/ /目/录/
parentCodestring/父/i/d/
totalSizeinteger/已/统/计/容/量/,/字/节/;/是/否/已/统/计/看/ /s/t/a/t/u/s/
totalSizeDisplaystring/容/量/大/小/-/显/示/
statusinteger/是/否/已/经/统/计/,/0/-/未/统/计/,/1/-/已/统/计/
statisticalTimestring/统/计/时/间/;日期时间字符串,可无时区偏移
tagarray[string]/标/签/,/支/持/多/个/
visibilityRangestring/可/见/性/范/围/,/取/值/示/例/:/M/E/M/B/E/R/S//O/N/L/Y/=/仅/成/员/,/E/N/T/E/R/P/R/I/S/E//P/U/B/L/I/C/=/企/业/内/公/开/,/I/N/T/E/R/N/E/T/_/P/U/B/L/I/C/=/互/联/网/公/开/
permissionTypestring/当/前/用/户/权/限/,/例/如/ /M/A/N/A/G/E/、/E/D/I/T/、/V/I/E/W//O/N/L/Y/、/A/S/K//O/N/L/Y/
capacitySizeinteger/配/置/容/量/,/字/节/
capacitySizeDisplaystring/容/器/容/量/大/小/-/显/示/
remainingSizeinteger/剩/余/容/量/,/字/节/
remainingSizeDisplaystring/剩/余/容/量/大/小/-/显/示/
fileCountinteger/非/目/录/文/件/数/,/未/统/计/时/可/空/
startTimestring/开/始/时/间/;日期时间字符串,可无时区偏移
endTimestring/结/束/时/间/;日期时间字符串,可无时区偏移
neverExpireinteger/是/否/永/久/有/效/,/0/ /否/ /1/ /是/ / /为/0/时/,/必/须/设/置/开/始/和/结/束/时/间/
classifyCodestring/知/识/库/分/类/编/码/
classifyNamestring/知/识/库/分/类/名/称/
admissionEnabledboolean/知/识/库/是/否/启/用/知/识/准/入/
kbKnowledgeBasePermissionReqListarray[object]/权/限/条/目/数/组/,/见/ /P/e/r/m/i/s/s/i/o/n/E/n/t/r/y/;/部/分/查/询/入/口/不/填/充/
embeddingModelstring/向/量/模/型/名/称/
embeddingProviderstring/向/量/提/供/商/
dimsinteger/向/量/维/度/

该对象还可包含下一节的解析配置字段。不能假定每个查询入口均填充全部统计与配置字段。

KnowledgeConfig · 解析配置

字段JSON 类型说明
splitModestring/文/档/切/分/模/式/:/F/I/X/E/D//S/I/Z/E/、/S/E/M/A/N/T/I/C/、/D/E/L/I/M/I/T/E/R/、/S/E/M/A/N/T/I/C//M/D/_/E/X/C/E/L/、/L/L/M/
maxChunkSizeinteger/切/片/大/小/配/置/,/语/义/与/单/位/由/使/用/的/切/分/模/式/决/定/
maxChunkLengthinteger/语/义/切/片/最/大/长/度/配/置/
overlapSizeinteger/重/叠/字/符/数/
mergeChunksboolean/是/否/合/并/文/本/块/
imageOcrboolean/图/片/O/C/R/
embeddingModelstring/E/m/b/e/d/d/i/n/g/模/型/,/如/O/p/e/n/A/I/ /A/d/a/-/0/0/2/
splitDelimitersarray[string]/分/隔/符/数/组/
analysisEnginestring/ /解/析/引/擎/
analysisModestring/ /解/析/模/式/
ocrEnginestring/O/C/R/引/擎/
multiModalityEnginestring/多/模/态/引/擎/
engineTypestring/图/片/解/析/引/擎/类/型/ /O/C/R/ /和/V/L/M/
expandConfigobject/可/选/扩/展/配/置/对/象/,/见/ /E/x/p/a/n/d/C/o/n/f/i/g/

KnowledgeElement · 文件与知识资源

字段JSON 类型说明
idinteger/主/键/i/d/
creatorstring/创/建/人/
creatorNamestring/创/建/人/
createTimestring/创/建/时/间/;日期时间字符串,可无时区偏移
modifierstring/修/改/人/
modifierNamestring/修/改/人/
modifierTimestring/修/改/时/间/;日期时间字符串,可无时区偏移
sortinteger/排/序/
tenantIdstring/租/户/i/d/
containerIdstring/所/属/知/识/库/业/务/编/码/(/c/o/d/e/)/
categorystring/知/识/资/源/类/别/,/例/如/ /F/I/L/E/S/、/D/I/R/E/C/T/O/R/Y/、/T/X/T/、/Q/A/;/按/实/际/返/回/值/处/理/
codestring/唯/一/编/码/
parentCodestring/父/编/码/
eleNamestring/知/识/库/元/素/名/称/(/文/件/名/称///文/件/夹/名/称/等/等/)/
eleSuffixstring/文/件/后/缀/
eleUrlstring/文/件/地/址/;/使/用/实/际/返/回/值/,/不/自/行/拼/接/
elePreviewUrlstring/预/览/地/址/
eleSizeinteger/文/件/大/小/,/字/节/
eleSizeDisplaystring/文/件/大/小/-/显/示/k/b/、/m/b/
eleTokenSizeinteger/内/容/ /T/o/k/e/n/ /估/算/数/量/
eleMd5string/文/件/ /M/D/5/ /用/于/重/复/文/件/校/验/
neverExpireinteger/是/否/永/久/有/效/,/0/ /否/ /1/ /是/ / /为/0/时/,/必/须/设/置/开/始/和/结/束/时/间/
startTimestring/开/始/日/期/;日期时间字符串,可无时区偏移
endTimestring/截/止/日/期/;日期时间字符串,可无时区偏移
processStatusinteger/0/ /未/处/理/;/1/0/ /及/其/他/处/理/中/阶/段/值/表/示/处/理/中/;/2/0/ /完/成/;/3/0/ /失/败/。/未/知/状/态/不/可/当/成/完/成/
admissionStatusstring/准/入/状/态/:/D/R/A/F/T/-/草/稿/、/P/E/N/D/I/N/G/_/R/E/V/I/E/W/-/待/审/核/、/P/U/B/L/I/S/H/E/D/-/已/发/布/、/R/E/J/E/C/T/E/D/-/已/驳/回/
errorMessagestring/处/理/失/败/诊/断/提/示/,/可/空/
processCountinteger/处/理/次/数/,/不/是/页/数/
pageCountinteger/文/档/页/或/分/页/产/物/数/量/,/依/来/源/而/定/
configstring/其/它/配/置/信/息/,/网/页/参/数/等/等/
topicstring/摘/要/
answerstring/Q/A/对/-/答/案/,/如/果/是/文/本/的/知/识/,/那/么/该/字/段/是/文/本/的/c/o/n/t/e/n/t/信/息/
similararray[string]/Q/A/对/-/相/似/问/题/
processPercentinteger/处/理/进/度/,/百/分/制/,/不/替/代/最/终/状/态/
originContentstring/富/文/本/的/原/始/文/本/信/息/
contentMarkedstring/内/容/的/m/a/r/k/d/o/w/n/格/式/内/容/
contentstring/当/前/版/本/内/容/
underReviewboolean/当/前/文/档/是/否/正/在/审/核/
publishedContentstring/最/新/已/发/布/版/本/内/容/;/无/已/发/布/版/本/时/为/空/
publishedContentMarkedstring/最/新/已/发/布/版/本/M/a/r/k/d/o/w/n/内/容/;/无/已/发/布/版/本/时/为/空/
reviewContentstring/当/前/审/核/版/本/内/容/;/非/审/核/中/时/为/空/
reviewContentMarkedstring/当/前/审/核/版/本/M/a/r/k/d/o/w/n/内/容/;/非/审/核/中/时/为/空/
followersinteger/关/注/者/数/量/
readCountinteger/阅/读/数/量/
commentCountinteger/评/论/数/量/
likesCountinteger/点/赞/数/量/
collectCountinteger/被/收/藏/数/量/
enableinteger/启/用/禁/用/
hotNumberinteger/热/度/值/,/方/便/排/序/整/个/文/档/的/热/度/
permissionStatusinteger/1/ /继/承/权/限/,/0/ /资/源/独/立/权/限/
sourceTypestring/知/识/来/源/类/型/
sourceCodestring/知/识/来/源/编/码/
relationTypestring/A/g/e/n/t/会/话/文/件/来/源/:/A/N/S/W/E/R//C/O/P/Y/、/U/S/E/R//U/P/L/O/A/D/、/A/G/E/N/T/_/G/E/N/E/R/A/T/E/D/
onlineobject/预/览/地/址/对/象/,/见/ /M/a/t/e/r/i/a/l/P/r/e/v/i/e/w/
childrensarray[object]/子/资/源/数/组/,/递/归/使/用/本/对/象/,/字/段/名/为/ /c/h/i/l/d/r/e/n/s/

ImportedFile · 导入结果条目

字段JSON 类型说明
idinteger/主/键/i/d/
creatorstring/创/建/人/
createTimestring/创/建/时/间/;日期时间字符串,可无时区偏移
modifierstring/修/改/人/
modifierTimestring/修/改/时/间/;日期时间字符串,可无时区偏移
sortinteger/排/序/
tenantIdstring/租/户/i/d/
containerIdstring/所/属/知/识/库/ /c/o/d/e/
categorystring/知/识/实/例/类/型/(/f/i/l/e/s/-/文/件/,/v/i/r/t/u/a/l/_/f/i/l/e/-/虚/拟/文/件/,/d/i/r/e/c/t/o/r/y/-/文/件/夹/)/
codestring/入/库/后/的/文/件/ /c/o/d/e/;/不/是/临/时/预/览/ /d/a/t/a/I/d/
parentCodestring/父/编/码/
eleNamestring/知/识/库/元/素/名/称/(/文/件/名/称///文/件/夹/名/称/等/等/)/
eleSuffixstring/文/件/后/缀/
eleUrlstring/文/件/地/址/;/使/用/实/际/返/回/值/,/不/自/行/拼/接/
elePreviewUrlstring/针/对/w/o/r/d/文/件/转/预/览/地/址/
eleSizeinteger/文/件/大/小/,/字/节/
eleMd5string/文/件/ /M/D/5/ /用/于/重/复/文/件/校/验/
sourceTypestring/知/识/来/源/类/型/
sourceCodestring/知/识/来/源/编/码/

UploadPreview · 上传与网页预览

字段JSON 类型说明
dataIdstring/临/时/预/览/批/次/标/识/,/用/作/提/交/导/入/时/的/ /d/a/t/a/S/e/t/s/[/]/./d/a/t/a/I/d/;/不/是/最/终/文/件/ /c/o/d/e/
responsesarray[object]/单/文/件/预/览/结/果/数/组/,/见/ /U/p/l/o/a/d/P/r/e/v/i/e/w/I/t/e/m/

UploadPreviewItem · 单文件预览

字段JSON 类型说明
categorystring/数/据/集/类/型/
eleNamestring/文/件/名/称/
eleSuffixstring/文/件/后/缀/
eleUrlstring/文/件/地/址/;/使/用/实/际/返/回/值/,/不/自/行/拼/接/
eleSizeinteger/文/件/大/小/,/字/节/
tokenSizeinteger/预/览/内/容/长/度///估/算/值/,/依/处/理/器/而/定/,/不/作/为/计/费/依/据/
eleMd5string/文/件/m/d/5/
pageCountinteger/文/件/页/数/
statusboolean/本/文/件/是/否/预/览/成/功/;/外/层/ /c/o/d/e/ /成/功/不/保/证/每/项/都/成/功/
errorMsgstring/预/览/失/败/提/示/,/成/功/时/可/空/
configstring/其/它/类/型/等/的/配/置/参/数/,/比/如/w/e/b/
chunksarray[object]/有/限/预/览/片/段/,/不/是/完/整/分/片/;/条/目/见/ /P/r/e/v/i/e/w/C/h/u/n/k/

PreviewChunk · 预览片段

字段JSON 类型说明
pageinteger/预/览/片/段/序/号/,/从/ /1/ /开/始/,/不/保/证/对/应/原/始/文/档/页/码/
contentstring/片/段/文/本/
tokenSizeinteger/预/览/片/段/长/度/;/当/前/预/览/按/字/符/长/度/填/充/,/不/作/为/模/型/计/费/ /T/o/k/e/n/ /数/

Directory · 创建目录结果

字段JSON 类型说明
codestring/新/目/录/ /c/o/d/e/,/用/作/子/资/源/ /p/a/r/e/n/t/C/o/d/e/
namestring/知/识/元/素/名/称/
urlstring/目/录/资/源/地/址/,/可/空/
parentCodestring/父/级/代/码/
containerCodestring/所/属/知/识/库/ /c/o/d/e/,/注/意/字/段/名/为/ /c/o/n/t/a/i/n/e/r/C/o/d/e/

KnowledgeCategory · 知识分类

字段JSON 类型说明
idinteger/主/键/i/d/
creatorstring/创/建/人/
createTimestring/创/建/时/间/;日期时间字符串,可无时区偏移
modifierstring/修/改/人/
modifierTimestring/修/改/时/间/;日期时间字符串,可无时区偏移
sortinteger/排/序/
codestring/分/类/编/码/
namestring/分/类/名/称/
parentCodestring/父/编/码/
gradeinteger/级/别/
childrenarray[object]/子/分/类/数/组/,/递/归/使/用/本/对/象/

Reference · 文件级引用

字段JSON 类型说明
containerIdstring/容/器/编/码/
containerPkIdstring/知/识/库/数/字/主/键/的/字/符/串/表/示/
containerNamestring/所/属/知/识/库/&/文/件/夹/
dataSetIdstring/文/件/业/务/编/码/(/c/o/d/e/)/
dataSetUrlstring/数/据/集/u/r/l/
dataSetPkIdstring/文/件/数/字/主/键/的/字/符/串/表/示/
dataSetNamestring/所/属/数/据/集/名/称/
suffixstring/后/缀/
versionNointeger/文/件/版/本/号/,/例/如/1/表/示/V/1/
neverExpireinteger/是/否/永/久/有/效/,/0/-/否/,/1/-/是/
startTimestring/有/效/期/开/始/时/间/
endTimestring/有/效/期/结/束/时/间/
pagesarray[integer]/引/用/页/码/数/组/,/无/分/页/来/源/可/空/
paragraphsarray[object]/来/源/引/用/段/落/,/见/ /R/e/f/e/r/e/n/c/e/P/a/r/a/g/r/a/p/h/
chunkIdsarray[string]/关/联/分/片/ /I/D/ /数/组/,/按/集/合/使/用/

ReferenceParagraph · 命中段落

字段JSON 类型说明
containerIdstring/容/器/编/码/
containerPkIdstring/知/识/库/数/字/主/键/的/字/符/串/表/示/
containerNamestring/所/属/知/识/库/&/文/件/夹/
dataSetIdstring/文/件/业/务/编/码/(/c/o/d/e/)/
dataSetPkIdstring/文/件/数/字/主/键/的/字/符/串/表/示/
dataSetUrlstring/可/选/文/件/地/址/,/可/能/不/参/与/序/列/化/;/优/先/从/ /r/e/f/e/r/e/n/c/e/s/ /读/取/地/址/
dataSetNamestring/所/属/数/据/集/名/称/
pageinteger/所/属/页/码/
contentstring/段/落/内/容/
suffixstring/后/缀/
versionNointeger/文/件/版/本/号/,/例/如/1/表/示/V/1/
neverExpireinteger/是/否/永/久/有/效/,/0/-/否/,/1/-/是/
startTimestring/有/效/期/开/始/时/间/
endTimestring/有/效/期/结/束/时/间/
chunkIdsarray[string]/关/联/分/片/ /I/D/ /数/组/
indexinteger/答/案/引/用/索/引/,/不/是/文/件/主/键/
scorenumber/相/关/分/数/,/受/检/索///重/排/模/型/影/响/,/不/是/答/案/正/确/率/
tokenScorenumber/关/键/词/检/索/分/数/,/可/空/
hybridScorenumber/混/合/检/索/分/数/,/可/空/
vectorScorenumber/向/量/检/索/分/数/,/可/空/
retrievalTypeobject/D/I/R/E/C/T/ /直/接/召/回/,/N/E/A/R/E/S/T/ /邻/近/片/段/
categorystring/类/别/
metadatastring/来/源/相/关/元/数/据/键/值/对/象/,/可/空/,/不/假/定/固/定/键/集/合/

MultiPart · 多媒体引用

字段JSON 类型说明
fileNamestring/文/件/名/称/
pageinteger/所/属/页/码/,/段/落/
categorystring/类/型/,/i/m/a/g/e///v/i/d/e/o///m/p/3/等/等/
valuestring/资/源/内/容/或/访/问/值/,/依/ /c/a/t/e/g/o/r/y/ /而/定/,/不/保/证/是/永/久/下/载/ /U/R/L/

MaterialPreview · 在线预览地址

字段JSON 类型说明
sourcestring/原/始/地/址/
targetstring/完/整/的/u/r/l/地/址/
iframeUrlstring/i/f/r/a/m/e/访/问/地/址/

EmployeeListItem · 员工列表条目

字段JSON 类型说明
idinteger/主/键/i/d/
creatorstring/创/建/人/
createTimestring/创/建/时/间/;日期时间字符串,可无时区偏移
modifierstring/修/改/人/
modifierTimestring/修/改/时/间/;日期时间字符串,可无时区偏移
sortinteger/排/序/
tenantIdstring/所/属/租/户/编/号/
codestring/用/户/编/码/
telstring/联/系/电/话/
namestring/用/户/名/称/
nickNamestring/昵/称/
logoImagestring/用/户/头/像/
sexstring/性/别/标/识/,/按/实/际/返/回/值/处/理/
signstring/个/性/签/名/
birthdaystring/生/日/;yyyy-MM-dd
emailstring/邮/箱/地/址/
industrystring/所/属/领/域/(/行/业/)/
typestring/人/员/类/型/,/正/式/员/工/,/实/习/员/工/,/外/包/员/工/
relationCodestring/关/联/外/包/企/业/编/码/
jobNostring/工/号/
joinTimestring/加/入/公/司/时/间/;yyyy-MM-dd
jobTitlestring/职/务/
countrystring/国/家/
citystring/工/作/城/市/
departmentNostring/组/织///部/门/编/码/的/字/符/串/表/示/,/不/是/员/工/创/建/请/求/中/的/数/组/
stateinteger/状/态/,/1/-/正/常/,/0/-/禁/用/
departmentNamestring/部/门/名/称/
departmentShortNamestring/部/门/简/称/,/只/保/留/最/后/一/个/部/门/名/称/
relationNamestring/关/联/企/业/名/称/
roleIdstring/角/色/编/码/的/字/符/串/表/示/,/不/是/角/色/更/新/请/求/中/的/数/组/
roleNamestring/角/色/名/称/
orgCodestring/第/一/级/的/组/织/
expirationTimestring/过/期/时/间/;日期时间字符串,可无时区偏移
uniqueNamestring/唯/一/登/录/名/称/
inSpaceboolean/场/景/性/空/间/成/员/标/记/,/普/通/列/表/可/空/
inPermboolean/场/景/性/权/限/成/员/标/记/,/普/通/列/表/可/空/
limitTypestring/场/景/性/权/限/类/型/,/普/通/列/表/可/空/

PermissionEntry · 权限条目

字段JSON 类型说明
idinteger已存在权限记录主键,新增可不提供
permissionTypestringMANAGE、EDIT、VIEW_ONLY、ASK_ONLY 等已支持权限
membershipTypestringUSER 用户、ORGANIZATION 组织/部门,其他类型按已开通能力使用
membershipCodestring成员业务编码
membershipNamestring展示名称
ownerboolean是否所有者,使用 JSON 布尔值

权限更新为全量替换,保留真实所有者。详见 知识库权限

ExpandConfig · 解析扩展配置

字段JSON 类型说明
summaryConfigobject摘要配置,下表
llmSplitConfigobject大模型切片配置,下表

summaryConfig

字段JSON 类型说明
modelCodestring/大/模/型/编/码/,/调/度/类/型/为/O/n/e/D/i/s/p/a/t/c/h/e/r/时/该/字/段/生/效/
temperatureinteger/创/造/性/,/范/围/(/0/,/1/0/0/]/之/间/
topPinteger/多/样/性/,/范/围/(/0/,/1/0/0/]/之/间/
promptstring/生/成/摘/要/要/求/

llmSplitConfig

字段JSON 类型说明
modelCodestring/大/模/型/编/码/
promptstring/自/定/义/分/片/规/则/;/输/出/格/式/和/待/分/片/正/文/由/系/统/注/入/;/支/持/ /$/{/t/i/m/e/}/、/$/{/y/e/s/t/e/r/d/a/y/}/、/$/{/t/o/m/o/r/r/o/w/}/

这些是响应中的配置字段,不代表每个简化创建接口都接受这些参数;请求以对应接口参数表为准。