You need to enable JavaScript to run this app.
文档中心
向量数据库VikingDB

向量数据库VikingDB

请输入
  • 文档首页
    • 向量数据库VikingDBViking 知识库API参考知识库info
复制全文
下载 pdf
我的收藏
知识库
info
复制全文
下载 pdf
我的收藏
info

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

概述

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

前提条件

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

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

请求参数（旗舰版、标准版通用）
参数类型是否必选默认值参数说明
namestring否--知识库名称

project

string

否

default

知识库所属项目，获取方式参见文档API 接入与技术支持
若需要操作指定项目下的知识库，需正确配置该字段。

resource_id

string

二选一

--

知识库唯一 ID
resource_id 与 name 至少传一个；都不传返回参数错误，同时传入时优先使用 resource_id。

响应消息
参数参数说明
code状态码
message返回信息
request_id标识每个请求的唯一标识符
data知识库信息

data 返回值

字段子字段字段类型说明
collection_name--string知识库名称

version

--

int

2：标准版
4：旗舰版

description--string知识库描述
doc_num--int知识库内文档数
create_time--int64知识库创建时刻，Unix 秒级时间戳。
update_time--int64知识库更新时刻，Unix 秒级时间戳。
creator--string知识库创建用户
pipeline_listlist知识库下实验版本 (pipeline) 列表
pipeline_typestring实验版本类型，如 user_define

pipeline_stat

json

pipeline 下文档导入状态
JSON | { "doc_num": 1, // 导入文档数 "finish_doc_num": 1, // 完成导入文档数 "point_num": 1, // 切片数 "success_doc_num": 1 // 成功导入文档数（已完成解析切片） }, |

index_listlist知识库索引详情

preprocessing_list

list

知识预处理配置
JSON | { "chunking_strategy": "custom_balance",// 切片策略 "chunking_identifier": null, // 自定义分隔符 "chunk_length": 2000, // 切片最大长度 "merge_small_chunks": true, // 是否合并短文本片 "vlm_prompt": "xxx", // 视频切片规则 ... } |
完整参数说明参考 请求参数（旗舰版）

table_config_list

list

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

data_typestring知识库内的数据类型
resource_id--string知识库唯一标识id
project--string知识库所属项目

index_list 返回值

字段子字段字段类型说明
index_type--string索引算法
index_configobject索引配置详情

vector_field

json

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

sparse_vector_field

稀疏向量字段
JSON | { "field_name": "_sys_auto_content_sparse_vector", // 字段名 "field_type": "sparse_vector", // 字段类型 } |

cpu_quotaintCPU 配额
distancestring距离类型：ip（内积）或 l2（欧氏距离）；实际值取决于索引配置。
quantstring量化方式：int8、float 或 fix16，可选范围取决于 index_type。
embedding_modelstring向量化模型，例如 doubao-embedding-and-m3、doubao-embedding-vision-and-m3、bge-m3 等；完整范围与创建接口的模型对照表一致。
embedding_dimensionint向量维度
need_instructionbool是否拼接 instruction 进行检索

fields

list[object]

数据集字段详情
JSON | [ { "field_name": "_sys_auto_id", // 字段名 "field_type": "string", // 字段类型 }, ...... ] |

field_enumerated_liststring标签列表
primary_key--string主键

status

--

int

索引状态
Python | Status： -1: 待构建 0: 构建中 1: 构建完成 2: 构建失败 3: 变更中 |

状态码说明

状态码http 状态码返回信息状态码说明
0200success成功
1000001401unauthorized鉴权失败
1000002403no permission权限不足
1000003400invalid request: %s非法参数
1000005400collection not existcollection 不存在
完整示例

请求消息 

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 Bad Request
Content-Length: 43
Content-Type: application/json
 
{"code":1000003, "message":"invalid request: %s", "request_id": "021695029757920fd001de6666600000000000000000002569b8f"}
最近更新时间：2026.09.08 20:33:08
这个页面对您有帮助吗？
有用
有用
无用
无用