search_knowledge--向量数据库VikingDB-火山引擎

文档中心

向量数据库VikingDB

知识库（Collection）

search_knowledge

概述

search_knowledge 用于对知识库进行检索和前后处理，当前会默认对原始文本加工后的知识内容进行检索。

请求参数

参数	子参数	类型	是否必选	默认值	参数说明
collection_name	--	string	否	--	知识库名称
project_name	--	string	否	default	知识库所属项目，获取方式参见文档API 接入与技术支持若不指定该字段，则在default项目下创建。若需要操作指定项目下的知识库，需正确配置该字段。
resource_id	--	string	否	--	知识库唯一 id 可选择直接传 resource_id，或同时传 collection_name 和 project_name 作为知识库的唯一标识
query	--	Any	是	--	检索文本最大可输入长度为 8000，query 长度 > 8000 时，接口报错所选 embedding 模型输入最大长度 < query 长度 < 8000 时，query 按所选模型自动截断 query 长度 < 所选 embedding 模型输入最大长度时，正常检索返回目标切片
image_query	--	Optional[Any]	否	--	检索图片支持图片 URL 或 Base64 编码，详细要求见图片像素说明和图片文件格式图片 URL 传入：适用于图片文件已存在公网可访问 URL 的场景，单张图片小于 10 MB Base64 编码传入：适用于图片文件较小的场景，支持 JPEG、PNG、WebP、BMP 四种格式的 Base64 编码，单张图片小于 3 MB，请求体不能超过 4 MB
limit	--	int	否	10	检索结果数量数量要求：[1, 1000]
query_param		Optional[Dict[str, Any]]	否		检索的过滤和返回设置
	doc_filter	map	否	--	检索过滤条件支持对 doc 的 meta 信息过滤详细使用方式和支持字段见filter表达式，可支持对 doc_id 做筛选此处用过过滤的字段，需要在 collection/create 时添加到 index_config 的 fields 上例如：单层 filter： `doc_filter = { "op": "must", // 查询算子 must/must_not/range/range_out "field": "doc_id", "conds": ["tos_doc_id_123", "tos_doc_id_456"] } query_param = { "doc_filter": doc_filter }` 多层 filter： `doc_filter = { "op": "and", // 逻辑算子 and/or "conds": [ // 条件列表，支持嵌套逻辑算子和查询算子 { "op": "must", "field": "type", "conds": [1] }, { ... // 支持>=1的任意数量的条件进行组合 } ] } query_param = { "doc_filter": doc_filter }`
dense_weight	--	float	否	0.5	混合检索中稠密向量的权重 1 表示纯稠密检索，0 表示纯字面检索，范围 [0.2, 1] 只有在请求的知识库使用的是混合检索时有效，即索引算法为 hnsw_hybrid
pre_processing		Optional[Dict[str, Any]]			检索预处理
	need_instruction	bool	否	False	是否拼接 instruction 进行检索
	return_token_usage	bool	否	False	是否返回 search 流程中各阶段的 token 使用量
	rewrite	bool	否	False	是否对 query 进行改写根据 messages 字段传入的历史对话信息进行改写，最多 3 轮注：只有在messages字段长度大于2且不为空时，设置参数值为True，才能返回有效的rewrite_query； `"messages"：[ {"role": "user", "content": "prompt 1"}, {"role": "assistant", "content": "prompt2"}, {"role": "user", "content": "prompt 3"}, ]`
	messages	json	是	--	多轮对话信息仅开启改写时需要上传，可根据历史对话内容进行问题改写，注意上传对话轮数需 >= 1 发出消息的对话参与者角色，可选值包括： user：User Message 用户消息 assistant：Assistant Message 对话助手消息 `[ {"role": "user", "content": "知识库支持哪些文档格式？"}, {"role": "assistant", "content": "知识库支持结构化和非结构化文档，其中结构化文档支持 excel、csv、jsonl 等常见格式，非结构化文档支持 pdf、docx、ppt 等常见格式。"}, {"role": "user", "content": "那大小呢？"}, ]`
post_processing		Optional[Dict[str, Any]]			检索后处理
	rerank_switch	bool	否	False	自动对结果做 rerank 打开后，会自动请求 rerank 模型排序
	retrieve_count	int	否	25	进入重排的切片数量，默认为 25 只有在 rerank_switch 为 True 时生效。retrieve_count 需要大于等于 limit，否则会抛出错误
	chunk_diffusion_count	int	否	0	检索阶段返回命中切片的上下几片邻近切片默认为 0，表示不进行 chunk diffusion。范围 [0, 5]
	chunk_group	bool	否	False	文本聚合默认不聚合，对于非结构化文件，考虑到原始文档内容语序对大模型的理解，可开启文本聚合。开启后，会根据文档及文档顺序，对切片进行重新聚合排序返回
	rerank_model	string	否	"base-multilingual-rerank"	rerank 模型选择仅在 "rerank_switch" == True 的时候生效可选模型： "doubao-seed-rerank"（即 doubao-seed-1.6-rerank）：字节自研多模态重排模型、支持文本 / 图片 / 视频混合重排、精细语义匹配、可选阈值过滤与指令设置 "base-multilingual-rerank"：速度快、长文本、支持70+种语言 "m3-v2-rerank"：常规文本、支持100+种语言
	rerank_threshold	float	否	--	阈值过滤仅当 rerank_model=="doubao-seed-rerank" 时生效，用于设置重排分数的过滤阈值，低于阈值的结果将不会被返回，取值范围为 0 到 1
	rerank_instruction	string	否	--	rerank 指令仅在 "rerank_switch" == True 且 "rerank_model" == "doubao-seed-rerank" 时生效，用于提供给模型一个明确的排序指令，提升重排效果。字符串长度不超过 1024 如，Whether the document answers the query or matches the content retrieval intent
	rerank_only_chunk	bool	否	False	是否仅根据 chunk 内容计算重排分数可选值： True：只根据 chunk 内容计算分 False：根据 chunk title + 内容一起计算排序分
	get_attachment_link	bool	否	False	是否获取切片中图片的临时下载链接

响应消息

字段	类型	参数说明
code	Optional[int]	状态码
message	Optional[str]	返回信息
request_id	Optional[str]	标识每个请求的唯一标识符
data	Optional[SearchKnowledgeResult]	SearchKnowledgeResult

SearchKnowledgeResult

字段	类型	参数说明
count	Optional[int]	检索结果返回的条数
rewrite_query	Optional[str]	query 改写的结果
token_usage	Optional[Dict[str, Any]]	Token 使用信息
result_list	List[PointInfo]	检索召回切片信息列表

PointInfo

字段	类型	参数说明
collection_name	Optional[str]	知识库名称
point_id	Optional[str]	切片 id
content	Optional[str]	切片内容 1、非结构化文件：content 返回切片内容 2、faq 文件：content 返回答案 3、结构化文件：content 返回参与索引的字段和取值，以 K:V 对拼接，使用 \n 区隔
md_content	Optional[str]	markdown 格式的解析结果（表格切片可通过 chunk_type == table 判断）
html_content	Optional[str]	html 格式的解析结果（表格切片可通过 chunk_type == table 判断）
description	Optional[str]	文档描述（当前仅支持图片文档）
table_chunk_fields	Optional[List[PointTableChunkField]]	结构化数据检索返回单行全量数据
original_question	Optional[str]	faq 数据检索召回答案对应的原始问题
score	Optional[float]	向量化语义检索得分
chunk_title	Optional[str]	切片标题
chunk_id	Optional[int]	切片位次 id（代表在原始文档中的位次顺序）
process_time	Optional[int]	切片处理完成的时间
rerank_score	Optional[float]	重排得分
doc_info	Optional[PointDocInfo]	PointDocInfo
chunk_type	Optional[str]	切片所属类型
chunk_source	Optional[str]	切片来源
chunk_attachment	Optional[List[ChunkAttachment]]	附件临时下载链接（有效期 10 分钟）
original_coordinate	Optional[Dict[str, Any]]	切片在所属文档的原始位置坐标
audio_start_time	Optional[int]	音频切片的起始时间（ms）
audio_end_time	Optional[int]	音频切片的结束时间（ms）
update_time	Optional[int]	更新时间
chunk_status	Optional[str]	切片状态
video_frame	Optional[str]	视频帧
video_url	Optional[str]	视频链接
video_start_time	Optional[int]	视频切片的起始时间（ms）
video_end_time	Optional[int]	视频切片的结束时间（ms）
video_outline	Optional[Dict[str, Any]]	视频大纲
audio_outline	Optional[Dict[str, Any]]	音频大纲
sheet_name	Optional[str]	sheet 名称
project	Optional[str]	项目名
resource_id	Optional[str]	知识库唯一 id

PointDocInfo

字段	类型	参数说明
doc_id	Optional[str]	所属文档 id
doc_name	Optional[str]	所属文档名字
create_time	Optional[int]	文档创建时间
doc_type	Optional[str]	所属原始文档类型
doc_meta	Optional[str]	所属文档的 meta 信息
source	Optional[str]	所属文档知识来源（url，tos 等）
title	Optional[str]	所属文档标题
status	Optional[DocStatus]	DocStatus

DocStatus

字段	类型	参数说明
process_status	Optional[int]	处理状态
failed_code	Optional[int]	失败错误码
failed_msg	Optional[str]	失败错误信息

ChunkAttachment

字段	类型	参数说明
uuid	Optional[str]	附件的唯一标识
caption	Optional[str]	图片所属标题，若未识别到标题则值为 "\n"
type	Optional[str]	image 等
link	Optional[str]	临时下载链接，有效期 10 分钟
info_link	Optional[str]	附件 info_link
column_name	Optional[str]	附件列名

PointTableChunkField

字段	类型	参数说明
field_name	Optional[str]	字段名
field_value	Optional[Any]	字段值

状态码说明

状态码	http状态码	返回信息	状态码说明
0	200	success	成功
1000001	401	unauthorized	缺乏鉴权信息
1000002	403	no permission	权限不足
1000003	400	invalid request：%s	非法参数
1000005	400	collection not exist	collection 不存在

请求示例

首次使用知识库 SDK ，可参考使用说明
本示例演示了知识库 Python SDK 中 SearchKnowledge 的基础使用方法，通过指定数据集名称和查询语句实现知识库检索，使用前需配置 AK/SK 鉴权参数。

import os

from vikingdb.knowledge import VikingKnowledge
from vikingdb.auth import IAM
from vikingdb.knowledge.models.search import SearchKnowledgeRequest

def main():
    access_key = os.getenv("VIKINGDB_AK")
    secret_key = os.getenv("VIKINGDB_SK")
    endpoint = "api-knowledgebase.mlp.cn-beijing.volces.com"
    region = "cn-beijing"
    
    client = VikingKnowledge(
        host=endpoint,
        region=region,
        auth=IAM(ak=access_key, sk=secret_key),
        scheme="https"
    )
    
    collection = client.collection(
        collection_name="Your collection name",
        project_name="default",
    )
    
    try:
        resp = collection.search_knowledge(SearchKnowledgeRequest(
            query="Your query",
            limit=10,
            dense_weight=0.5
        ))
        print(f"Response: {resp}")
    except Exception as e:
        print(f"SearchKnowledge failed, err: {e}")

if __name__ == "__main__":
    main()

最近更新时间：2026.03.20 12:23:13

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

SearchKnowledgeResult #

PointInfo #

PointDocInfo #

DocStatus #

ChunkAttachment #

PointTableChunkField #