@re-ai/volc-knowledge
Version:
火山引擎知识库接口接入SDK
183 lines (174 loc) • 7.95 kB
Markdown
# 查询账户下所有知识库信息接口文档
## 一、接口概述
`/knowledge/collection/list`接口用于查询某个账户下的所有知识库信息，默认按照知识库的创建时间从晚到早排序。
## 二、前提条件
完成“签名鉴权方式”页面的注册账号、实名认证、AK/SK密钥获取和签名获取后，方可调用该API接口实现查看知识库列表的功能。
## 三、请求接口
|参数|详情|描述|
|---|---|---|
|URI|`/api/knowledge/collection/list`|统一资源标识符|
|请求方法|POST|客户端对向量数据库服务器请求的操作类型|
|请求头|`Content-Type: application/json`<br>`Authorization: HMAC-SHA256 ***`|请求消息类型<br>鉴权|
## 四、请求参数
|参数|类型|是否必选|默认值|参数说明|
|---|---|---|---|---|
|project|string|否|--|知识库所属项目，在【访问控制】-【资源管理】-【项目】中创建。若不传，则返回所有project下的知识库|
|brief|bool|否|false|是否查询和返回索引状态，false代表查询和返回索引状态，true代表不查询和返回索引状态|
## 五、响应消息
|参数|参数说明|
|---|---|
|code|状态码|
|message|返回信息|
|request_id|标识每个请求的唯一标识符|
|data|包含total_num（列表里的知识库总数）、collection_list（知识库详细信息列表，数组型，每个元素是一个知识库的详细信息，具体参数形式见info）|
## 六、状态码说明
|状态码|http状态码|返回信息|状态码说明|
|---|---|---|---|
|0|200|success|成功|
|1000001|401|unauthorized|鉴权失败|
|1000002|403|no permission|权限不足|
|1000003|400|invalid request：%s|非法参数|
|1000005|400|collection not exist|collection不存在|
## 七、完整示例
### （一）请求消息
```bash
curl -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: HMAC-SHA256 ***' \
https://api-knowledgebase.mlp.cn-beijing.volces.com/api/knowledge/collection/list \
-d '{
"project": "abc",
"brief": false
}'
```
### （二）响应消息
1. **执行成功返回**
```json
HTTP/1.1 200 OK
Content-Length: 43
Content-Type: application/json
{
"code": 0,
"data": {
"total_num": 200,
"collection_list": [
{
"collection_name": "apiexample",
"description": "test",
"create_time": 1724747158,
"update_time": 1724747158,
"creator": "xxx",
"pipeline_list": [
{
"pipeline_type": "user_define",
"pipeline_stat": {
"doc_num": 0,
"finish_doc_num": 0,
"point_num": 0,
"success_doc_num": 0
},
"index_list": [
{
"index_type": "hnsw_hybrid",
"index_config": {
"vector_field": {
"field_name": "_sys_auto_content_vector",
"field_type": "vector",
"dim": 2048
},
"sparse_vector_field": {
"field_name": "_sys_auto_content_sparse_vector",
"field_type": "sparse_vector"
},
"cpu_quota": 1,
"distance": "ip",
"quant": "int8",
"embedding_model": "doubao-embedding-and-m3",
"embedding_dimension": 2048,
"need_instruction": true,
"fields": [
{
"field_name": "_sys_auto_id",
"field_type": "string"
},
{
"field_name": "_sys_auto_doc_id",
"field_type": "string"
},
{
"field_name": "_sys_auto_chunk_id",
"field_type": "int64"
},
{
"field_name": "_sys_auto_doc_type",
"field_type": "string"
},
{
"field_name": "_sys_auto_add_type",
"field_type": "string"
}
]
},
"primary_key": "",
"status": -1
}
],
"preprocessing_list": [
{
"chunking_strategy": "default",
"chunking_identifier": null,
"chunk_length": 2000
}
],
"table_config_list": [
{
"table_type": "row",
"table_pos": 1,
"start_pos": 2,
"table_fields": [
{
"field_name": "讲解模块",
"field_type": "string",
"if_embedding": true,
"if_filter": false
},
{
"field_name": "子模块",
"field_type": "string",
"if_embedding": true,
"if_filter": false
},
{
"field_name": "问题示例",
"field_type": "string",
"if_embedding": true,
"if_filter": false
},
{
"field_name": "记忆化 ————讲解要点",
"field_type": "string",
"if_embedding": true,
"if_filter": false
}
]
}
]
}
],
"data_type": "structured_data"
}
],
"resource_id": "kb-be6833502748aaef",
"project": "default"
},
"message": "success",
"request_id": "02172474869381600000000000000000000ffff0a005049697e42"
}
```
2. **执行失败返回**
```json
HTTP/1.1 400 OK
Content-Length: 43
Content-Type: application/json
{"code":1000003, "message":"invalid request：%s", "request_id": "021695029757920fd001de6666600000000000000000002569b8f"}
```