# 查看知识库详情接口文档
## 一、接口概述
`/api/knowledge/collection/info`接口用于查看知识库详情，可根据知识库名称返回知识库的描述，以及知识库配置的pipeline详细信息。

## 二、前提条件
完成“签名鉴权方式”页面的注册账号、实名认证、AK/SK密钥获取和签名获取后，才能调用该API接口查看知识库信息。

## 三、请求接口
|参数|详情|描述|
|---|---|---|
|URI|`/api/knowledge/collection/info`|统一资源标识符|
|请求方法|POST|客户端对向量数据库服务器请求的操作类型|
|请求头|`Content-Type: application/json`<br>`Authorization: HMAC-SHA256 ***`|请求消息类型<br>鉴权|

## 四、请求参数
|参数|类型|是否必选|默认值|参数说明|
|---|---|---|---|---|
|name|string|否|--|知识库的名字，只能使用英文字母、数字、下划线_，并以英文字母开头，不能为空，长度要求为[1-64]|
|project|string|否|default|知识库所属项目，在【访问控制】-【资源管理】-【项目】中创建|
|resource_id|string|否|--|知识库的唯一id，可选择直接传resource_id，或同时传name和project作为知识库的唯一标识|

## 五、响应消息
|参数|参数说明|
|---|---|
|code|状态码|
|message|返回信息|
|request_id|标识每个请求的唯一标识符|
|data|检索返回内容|

### data返回值
|字段|子字段|字段类型|说明|
|---|---|---|---|
|collection_name|--|string|知识库名称|
|description|--|string|知识库描述|
|doc_num|--|int|知识库内文档数|
|create_time|--|int|知识库创建时间|
|update_time|--|int|知识库更新时间|
|creator|--|string|知识库创建用户|
|pipeline_list|--|list|知识库下pipeline列表|
|pipeline_stat|doc_num<br>finish_doc_num<br>point_num<br>success_doc_num|int|导入文档数<br>完成导入文档数<br>切片数<br>成功导入文档数|
|index_list|--|list|知识库索引详情|
|preprocessing_list|chunking_strategy<br>chunking_identifier<br>chunk_length<br>merge_small_chunks|string<br>null/string<br>int<br>bool|切片策略<br>自定义分隔符<br>切片最大长度<br>是否合并短文本片|
|table_config_list|table_type<br>table_pos<br>start_pos<br>table_fields|string<br>int<br>int<br>list[object]|从行/列开始解析<br>字段位置<br>起始数据位置<br>结构化知识库表结构字段详情|
|data_type|--|string|知识库内的数据类型|
|resource_id|--|string|知识库唯一标识id|
|project|--|string|知识库所属项目|

### index_list返回值
|字段|子字段|字段类型|说明|
|---|---|---|---|
|index_type|--|string|索引算法|
|index_config|vector_field<br>sparse_vector_field<br>cpu_quota<br>distance<br>quant<br>embedding_model<br>embedding_dimension<br>need_instruction<br>fields<br>field_enumerated_list<br>primary_key<br>status|json<br>json<br>int<br>string<br>string<br>string<br>int<br>bool<br>list[object]<br>string<br>string<br>int|稠密向量字段<br>稀疏向量字段<br>CPU配额<br>距离类型<br>量化方式<br>向量化模型<br>向量维度<br>是否拼接instruction进行检索<br>数据集字段详情<br>标签列表<br>主键<br>索引状态（-1：待构建；0：构建中；1：构建完成；2：构建失败；3：变更中）|

## 六、状态码说明
|状态码|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/info \
  -d '{
    "name": "test_collection_name",
    "project": ""
}'
```

### （二）响应消息
1. **执行成功返回**
```json
{
    "code": 0,
    "data": {
        "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": "02172474937697900000000000000000000ffff0a00501d3f1d67"
}
```
2. **执行失败返回**
```json
HTTP/1.1 400 OK
Content-Length: 43
Content-Type: application/json
{"code":1000003, "message":"invalid request：%s", "request_id": "021695029757920fd001de6666600000000000000000002569b8f"}
```