查询知识库列表 | 大装置帮助中心
跳到主要内容

查询知识库列表

接口描述(Description)

查询当前账户下存在的知识库列表


请求地址(Request URL)

[GET] https://api.sensenova.cn/v1/llm/knowledge-bases

请求头(Request Header)

无特殊Header,请参考接口鉴权


请求示例(Request Example)

curl --request GET "https://api.sensenova.cn/v1/llm/knowledge-bases" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $API_TOKEN"

响应(Response)

名称类型描述
knowledge_basesobject[]知识库列表
  • knowledge_bases 部分参数如下:
名称类型描述
idstring知识库ID
descriptionstring知识库描述
statusstring知识库状态
可用:AVAILABLE
不可用:UNAVAILABLE
正在准备:LOADING
等待中:PENDING
filesobject[]知识库文件列表
configsobject知识库构建参数详情
created_atstring知识库创建时间,ISO 8601标准时间格式,精确到纳秒
updated_atstring知识库更新时间,ISO 8601标准时间格式,精确到纳秒
  • files 部分参数如下:
名称类型描述
idstring文件ID
descriptionstring文件描述
statusstring文件状态,枚举值
未上传/上传中:NOTUPLOADED
已上传:UPLOADED
文件无效:INVALID
文件有效:VALID
  • configs 部分参数如下:
名称类型描述
text_splitobject文本分割配置
embeddingobjectembedding配置
  • text_split 部分参数如下:
名称类型描述
modestring文本分割模式
configobjectdelimiter模式下的分隔符配置,semantics模式无此配置
  • config 部分参数如下:
名称类型描述
max_lengthstring每个分割片段最大字数长度
punctuationsobject[]分割每个片段的标记符号列表
  • punctuations 部分参数如下:
名称类型描述
markstring分割标记
priorityint分割标记优先级
  • embedding 部分参数如下:
名称类型描述
modelstring模型ID

响应示例(Response Example)

{
"knowledge_bases": [
{
"id" : "string",
"description": "string",
"status": "string",
"files":[
{
"id": "string",
"description": "string",
"status": "string"
}
],
"configs":{
"text_split":{
"mode": "string",
"config": {}
},
"embedding":{
"model": "string"
}
},
"created_at": "2023-06-28T17:23:01.243566533Z",
"updated_at": "2023-06-28T17:23:01.243566533Z"
}
]
}

错误信息

参考错误码