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

向量数据库VikingDB

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

/api/knowledge/doc/info 接口用于查看知识库或某个实验版本下的文档信息。

支持通过指定 pipeline_name 参数，来实现查看某个实验版本下的文档状态

前提条件

完成 API Key 鉴权（在控制台获取 VIKING_API_KEY）后，可调用 API 接口查看知识库下某个文档的信息。

请求接口
URI/api/knowledge/doc/info统一资源标识符
请求方法POST客户端对向量数据库服务器请求的操作类型
请求头Content-Type: application/json请求消息类型
Authorization: Bearer {VIKING_API_KEY}鉴权
请求参数
参数类型是否必选默认值参数说明
collection_namestring否--知识库名称

project

string

否

default

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

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

doc_id

string

是

--

要查询的文档 ID
可通过文档上传结果或文档列表接口获取

return_token_usage

bool

否

false

是否返回文档向量化和文档生成摘要所消耗的 tokens

  • true：返回 token 用量信息；false：不返回 token 用量信息
pipeline_namestring否--实验版本名称，长度 [1, 128]，必须以英文字母开头，仅支持英文字母、数字和下划线。不指定时查询主版本。

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

data 返回值

字段子字段字段类型说明
collection_name--string知识库名称
doc_name--string文档名称
doc_hash--string文档内容的唯一 hash 值
doc_id--string文档唯一标识
add_type--string文档导入方式：url、tos、tos_fe、tos_connector 或 lark。
doc_type--string文档类型。支持文本/办公文档 txt、doc、docx、pdf、ppt、pptx、html、markdown、epub、faq.xlsx，结构化类型 xlsx、csv、jsonl、parquet，图片、音频和视频类型等。
create_time--number文档创建时间，毫秒级时间戳
added_by--string文档上传人
update_time--number文档更新时间，毫秒级时间戳
url--string文档的 URL 地址
meta--string文档元信息，JSON 字符串格式
point_num--number文档切片数量
statusobject文档处理状态对象

process_status

number

文档处理状态
0：成功
1：失败
2：排队中
3：更新中
5：删除中
6：处理中

doc_summary--string文档全文摘要
brief_summary--string文档精简摘要
title--string文档或视频标题
video_outlineobject视频大纲信息（音视频知识库且 enable_smart_summary == true 时返回）
titlestring视频全部智能大纲标题
summarystring视频全部智能大纲内容

chapters

array

视频章节列表，单个元素结构如下：

{
"title": "xxx", // 智能大纲标题
"content": "xxx", // 智能大纲内容
"start_time": 0, // 章节开始时间（毫秒）
"end_time": 296000, // 章节结束时间（毫秒）
"element_content": [ // 章节内的详细句子列表
"说话人1[00:00:23.72]：xxx",
"说话人1[00:00:25.48]：xxx",
...
]
}
video_frame--string视频帧 URL 地址
audio_outlineobject音频大纲信息（仅在音视频知识库且 enable_audio_smart_summary == true 时返回）
titlestring音频全部智能大纲标题
summarystring音频全部智能大纲内容

chapters

array

音频章节列表，单个元素结构如下：

{
"title": "xxx", // 智能大纲标题
"content": "xxx", // 智能大纲内容
"start_time": 0, // 章节开始毫秒
"end_time": 296000, // 章节结束毫秒
"element_content": [ // 章节详细句子列表
"说话人1[00:00-00:28]：xxx"
"说话人1[00:29-00:35]：xxx"
...
]
}
doc_size--number文档大小（字节）
full_directory_path--array文档所在目录路径
is_wiki--boolean是否为 wiki 类型文档
statisticsobject文档统计信息对象
pagesnumber页数
linesnumber行数
cellsnumber单元格数量
charsnumber提取文本字符数
imagesnumber图片数量
tablesnumber表格数量

failed_code 报错码：

failed_code错误描述处理建议
10001文档下载超时请上传重试。如果问题仍然存在，请联系我们
10003URL 校验失败，请确认 URL 链接请确认 URL 链接正确后重试。如果问题仍然存在，请联系我们
10005飞书文档获取异常，请确认有效且已授权请确认飞书文档权限，并通过飞书开放平台 OpenAPI 飞书开放平台确认授权
30001超过知识库文件限制大小超过知识库配额限制。配额说明参考
35001超过知识库切片数量限制超过知识库配额限制。配额说明参考
35002FAQ 文档解析为空FAQ 文档解析结果为空，切片数为 0。请确保文档中包含有效数据
35004超过知识库 FAQ 文档 sheet 数量限制超过知识库配额限制。配额说明参考
36003结构化文档表头不匹配结构化文档表头不匹配，请确保上传文档中每个 sheet 的表头与预定义的知识库表结构完全一致
36004结构化文档数据类型转换失败结构化文档数据类型转换失败，请确保上传文档中每个 sheet 的单元格的内容格式与预定义的知识库表结构数据类型完全一致
36005超过知识库结构化文档 sheet 数量限制超过知识库配额限制。配额说明参考
36006超过知识库结构化文档有效行数限制超过知识库配额限制。配额说明参考
36007结构化文档解析为空结构化文档解析结果为空，切片数为 0。请确保文档中包含有效数据
36008embedding 的列组合长度超出限制缩短待 embedding 原始文本长度
其他错误码未知错误，请联系我们未知错误，请联系我们

状态码说明

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

请求消息 

curl -i -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {VIKING_API_KEY}' \
  https://api-knowledgebase.mlp.cn-beijing.volces.com/api/knowledge/doc/info \
  -d '{
    "collection_name": "test_collection_name",
    "project": "",
    "doc_id": "test123",
    "return_token_usage": true
}'

响应消息

执行成功返回：

HTTP/1.1 200 OK
Content-Length: 1234
Content-Type: application/json
 
{
  "code": 0,
  "message": "success",
  "request_id": "021695029757920fd001de6666600000000000000000002569b8f",
  "data": {
    "collection_name": "video_collection",
    "doc_name": "会议视频.mp4",
    "doc_hash": "xxxxxxxxxxxxxxxx",
    "doc_id": "_sys_auto_gen_doc_id-xxxx",
    "add_type": "tos_fe",
    "doc_type": "mp4",
    "create_time": 1768804541257,
    "added_by": "user@example.com",
    "update_time": 1768804640273,
    "meta": "[]",
    "point_num": 11,
    "status": {
      "process_status": 0
    },
    "doc_summary": "",
    "brief_summary": "",
    "title": "项目交付与竞品分析会议",
    "video_outline": {
      "title": "项目交付与竞品分析会议大纲",
      "summary": "会议围绕项目进度、重点事项以及竞品分析方式展开。",
      "chapters": [
        {
          "title": "项目交付计划与重点事项",
          "content": "讨论项目时间节点与需要优先推进的关键事项。",
          "start_time": 0,
          "end_time": 76000,
          "element_content": [
            "说话人1: 讨论项目整体时间安排。[00:00:00]",
            "说话人1: 确认需要优先处理的事项。[00:00:09]",
            "说话人2: 补充相关技术方向建议。[00:00:19]"
          ]
        },
        {
          "title": "公司复盘与阶段总结",
          "content": "回顾阶段性成果，并讨论改进方向。",
          "start_time": 76000,
          "end_time": 169000,
          "element_content": [
            "说话人1: 提出阶段复盘的必要性。[00:01:23]",
            "说话人1: 讨论如何系统总结经验。[00:02:23]"
          ]
        },
        {
          "title": "分阶段竞品分析策略",
          "content": "明确不同阶段的竞品范围与分析重点。",
          "start_time": 169000,
          "end_time": 317000,
          "element_content": [
            "说话人2: 说明竞品需按阶段区分。[00:03:00]",
            "说话人1: 当前阶段聚焦核心竞品。[00:04:31]",
            "说话人2: 提出补充竞品条目的建议。[00:05:01]"
          ]
        }
      ],
    },
    "video_frame": "xxx",
    "doc_size": 29964057,
    "full_directory_path": [],
    "is_wiki": false,
    "statistics": {
      "pages": 0,
      "lines": 0,
      "cells": 0,
      "chars": 6127,
      "images": 0,
      "tables": 0
    }
  }
}

执行失败返回：

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:09
这个页面对您有帮助吗？
有用
有用
无用
无用