查询知识库详情

接口描述（Description）

通过ID查询知识库详情

请求地址（Request URL）

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

请求头（Request Header）

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

请求参数（Path Parameters）

名称	类型	必须	默认值	可选值	描述
knowledge_base_id	string	是	-	-	知识库ID

请求示例（Request Example）

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

响应（Response）

名称	类型	描述
knowledge_base	object	知识库详情

• knowledge_base 部分参数如下：

名称	类型	描述
id	string	知识库ID
description	string	知识库描述
status	string	知识库状态 可用：AVAILABLE 不可用：UNAVAILABLE 正在准备：LOADING 等待中：PENDING
files	object[]	文件列表
configs	object	知识库构建参数详情
created_at	string	知识库创建时间，ISO 8601标准时间格式，精确到纳秒
updated_at	string	知识库更新时间，ISO 8601标准时间格式，精确到纳秒

• files 部分参数如下：

名称	类型	描述
id	string	文件ID
description	string	文件描述
status	string	文件状态，枚举值 未上传/上传中：NOTUPLOADED 已上传：UPLOADED 文件无效：INVALID 文件有效：VALID

• configs 部分参数如下：

名称	类型	描述
text_split	object	文本分割配置
embedding	object	embedding配置

• text_split 部分参数如下：

名称	类型	描述
mode	string	文本分割模式
config	object	delimiter模式下的分隔符配置，semantics模式无此配置

• config 部分参数如下：

名称	类型	描述
max_length	string	每个分割片段最大字数长度
punctuations	object[]	分割每个片段的标记符号列表

• punctuations 部分参数如下：

名称	类型	描述
mark	string	分割标记
priority	int	分割标记优先级

• embedding 部分参数如下：

名称	类型	描述
model	string	模型ID

响应示例（Response Example）

{
    "knowledge_base":{    
            "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"      
    }
}

错误信息

参考错误码