本节将说明如何查看一个已创建知识库的信息。

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

完成“签名鉴权方式“页面的注册账号、实名认证、AK/SK 密钥获取和签名获取后，可调用 API 接口实现知识库信息查看的功能。

data 返回值

{
    "doc_num": 1, // 导入文档数
    "finish_doc_num": 1, // 完成导入文档数
    "point_num": 1, // 切片数
    "success_doc_num": 1 // 成功导入文档数
},

{
    "chunking_strategy": "custom_balance",// 切片策略
    "chunking_identifier": null, // 自定义分隔符
    "chunk_length": 2000, // 切片最大长度
    "merge_small_chunks": true // 是否合并短文本片
 }

{
  "table_type": "row","col",
  // row表示从行开始解析，col表示从列开始解析,
  "table_pos": "int",
  // 字段位于第几行或第几列,
  "start_pos": "int",
  // 起始数据在第几行,
  "table_fields": [
      {
          "field_name": "xxx", //字段名称
          "field_type": "int64", //字段类型, 支持string, int64, float32, bool
          "if_embedding": true, //是否参与索引
          "default_value":"xxx", //默认值
          "if_filter": false //设置为过滤字段
    },
    .....
  ]
}

index_list 返回值

{
    "field_name": "_sys_auto_content_vector", // 字段名
    "field_type": "vector", // 字段类型
    "dim": 2048 // 向量维度
}

{
    "field_name": "_sys_auto_content_vector", // 字段名
    "field_type": "vector", // 字段类型
}

[
    {
    "field_name": "_sys_auto_id", // 字段名
    "field_type": "string", // 字段类型
    },
    ......
]

Status：
    -1:    待构建构建
    0:     构建中
    1:     构建完成
    2:     构建失败
    3:     变更中

状态码说明

请求消息

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": ""
}'

响应消息

执行成功返回：

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

执行失败返回：

HTTP/1.1 400 OK
Content-Length: 43
Content-Type: application/json
 
{"code":1000003, "message":"invalid request：%s", "request_id": "021695029757920fd001de6666600000000000000000002569b8f"}