请求方法

POST

客户端对向量数据库服务器请求的操作类型

请求头

Content-Type: application/json

请求消息类型

Authorization: HMAC-SHA256 ***

鉴权

collection_name

string

否

--

知识库名称

project

string

否

default

知识库所属项目，获取方式参见文档API 接入与技术支持

resource_id

string

否

--

知识库唯一 id
可选择直接传 resource_id，或同时传 collection_name 和 project 作为知识库的唯一标识

doc_id

string

是

--

要查询的文档 id

return_token_usage

bool

否

false

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

pipeline_name

string

否

--

实验版本名称

• 不指定时，默认查询知识库主版本下的文档信息
• 当指定时，查询特定实验版本内的文档信息

code

状态码

message

返回信息

request_id

标识每个请求的唯一标识符

data

文档信息

collection_name

--

string

知识库名称

doc_name

--

string

文档名称

doc_hash

--

string

文档内容的唯一 hash 值

doc_id

--

string

文档唯一标识

add_type

--

string

文档导入方式

doc_type

--

string

文档类型

create_time

--

number

文档创建时间，毫秒级时间戳

added_by

--

string

文档上传人

update_time

--

number

文档更新时间，毫秒级时间戳

url

--

string

文档的 URL 地址

meta

--

string

文档元信息，JSON 字符串格式

point_num

--

number

文档切片数量

status

object

文档处理状态对象

process_status

number

文档处理状态

doc_summary

--

string

文档全文摘要

brief_summary

--

string

文档精简摘要

title

--

string

文档或视频标题

video_outline

object

视频大纲信息（音视频知识库且 enable_smart_summary=true 时返回）

title

string

视频大纲标题

summary

string

视频整体摘要

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",
    ...
  ]
}

video_frame

string

视频关键帧路径

video_frame

--

string

视频封面或关键帧访问 URL 地址

audio_outline

object

音频大纲信息（仅在音视频知识库且 enable_audio_smart_summary=true 时返回）

title

string

音频大纲标题

summary

string

音频整体摘要说明

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"
    ...
  ]
}