接口详情

字段

传参方式

类型

必传

描述

示例值

Authorization

header

String

是

API-Key

Bearer d1**2a

字段

传参方式

类型

必传

描述

示例值

x-fag-appcode

header

String

是

应用表示，固定为 aca

x-fag-servicename

header

String

是

请求路由标识，不同接口值不一样，映射管理参考

aca-character-create

接口

路径

x-fag-appcode

创建知识库

/v2/api/knowledge_base/create

aca-kb-create

修改知识库

/v2/api/knowledge_base/update

aca-kb-update

查询知识库

/v2/api/knowledge_base/search

aca-kb-search

删除知识库

/v2/api/knowledge_base/delete

aca-kb-delete

知识库文件详情上传

/v2/api/knowledge_base/detail/upload

aca-kb-detail-upload

知识库文件详情修改

/v2/api/knowledge_base/detail/update

aca-kb-detail-update

知识库文件详情查询

/v2/api/knowledge_base/detail/delete

aca-kb-detail-delete

知识库文件详情删除

/v2/api/knowledge_base/detail/search

aca-kb-detail-search

名称

类型

是否必传

说明

name

string

是

知识库名称

description

string

否

知识库描述

userProfile

object

否

用户信息

userProfile.userId

string

否

用户自定义userId

名称

类型

说明

code

int

返回码，正常返回200，异常返回空

success

bool

正常返回 true，异常返回null

requestId

string

请求唯一标识

data

object

请求返回内容

data.knowledgeBaseId

string

知识库id

data.name

string

知识库名称

data.description

string

知识库描述

名称

类型

是否必传

说明

knowledgeBaseId

string

是

知识库id

name

string

否

知识库名称

description

string

否

知识库描述

userProfile

object

否

用户信息

userProfile.userId

string

否

用户自定义userId

名称

类型

说明

code

int

返回码，正常返回200，异常返回空

success

bool

正常返回 true，异常返回null

requestId

string

请求唯一标识

data

bool

是否修改成功

名称

类型

是否必传

说明

pageNum

int

否（默认1）

分页页码

pageSize

ing

否（默认30）

分页大小

userProfile

object

否

用户信息

userProfile.userId

string

否

用户自定义userId

名称

类型

说明

code

int

返回码，正常返回200，异常返回空

success

bool

正常返回 true，异常返回null

requestId

string

请求唯一标识

data

object

请求返回内容

data.page

int

分页页码

data.pageSize

int

分页大小

data.total

int

总数

data.list

array

数据

data.list[i].id

int

知识库主键id

data.list[i].knowledgeBaseId

string

知识库id

data.list[i].name

string

知识库名称

data.list[i].gmtCreate

int

知识库创建时间

data.list[i].gmtModified

int

知识库修改时间

data.list[i].description

string

知识库描述

data.list[i].count

int

知识库下文件详情数量

名称

类型

是否必传

说明

knowledgeBaseId

string

是

知识库id

userProfile

object

否

用户信息

userProfile.userId

string

否

用户自定义userId

名称

类型

说明

code

int

返回码，正常返回200，异常返回空

success

bool

正常返回 true，异常返回null

requestId

string

请求唯一标识

data

bool

是否修改成功

名称

类型

是否必传

说明

knowledgeBaseId

string

是

知识库id

type

string

是

文件类型:text,form和document

fileInfos

array

是

上传文件集合

fileInfos[i].filename

string

是

文件名称,以文件格式后缀结尾

fileInfos[i].fileUrl

string

是

公网可访问地址

userProfile

object

否

用户信息

userProfile.userId

string

否

用户自定义userId

名称

类型

说明

code

int

返回码，正常返回200，异常返回空

success

bool

正常返回 true，异常返回null

requestId

string

请求唯一标识

data

bool

是否上传成功

名称

类型

是否必传

说明

knowledgeBaseId

string

是

知识库id

name

string

是

现在文件的名称

newName

string

是

修改的名称

userProfile

object

否

用户信息

userProfile.userId

string

否

用户自定义userId

名称

类型

说明

code

int

返回码，正常返回200，异常返回空

success

bool

正常返回 true，异常返回null

requestId

string

请求唯一标识

data

bool

是否修改成功

名称

类型

是否必传

说明

knowledgeBaseId

string

是

知识库id

pageNum

int

否（默认1）

分页页码

pageSize

ing

否（默认30）

分页大小

userProfile

object

否

用户信息

userProfile.userId

string

否

用户自定义userId

名称

类型

说明

code

int

返回码，正常返回200，异常返回空

success

bool

正常返回 true，异常返回null

requestId

string

请求唯一标识

data

object

请求返回内容

data.page

int

分页页码

data.pageSize

int

分页大小

data.total

int

总数

data.list

array

数据

data.list[i].id

int

知识库详情主键id

data.list[i].knowledgeBaseId

string

知识库id

data.list[i].name

string

知识库详情名称

data.list[i].gmtCreate

int

知识库详情创建时间

data.list[i].gmtModified

int

知识库详情修改时间

data.list[i].type

string

知识库详情类型

data.list[i].status

int

知识库详情数状态不

data.list[i].fileInfo

object

文件详情

data.list[i].fileInfo.filename

string

文件名

data.list[i].fileInfo.fileSavePath

string

oss路径

data.list[i].fileInfo.fileUrl

string

转存后的地址

名称

类型

是否必传

说明

knowledgeBaseId

string

是

知识库id

name

string

是

知识库文件详情名称

userProfile

object

否

用户信息

userProfile.userId

string

否

用户自定义userId

名称

类型

说明

code

int

返回码，正常返回200，异常返回空

success

bool

正常返回 true，异常返回null

requestId

string

请求唯一标识

data

bool

是否修改成功