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

文档中心

向量数据库VikingDB

实验版本（新）

create

api/knowledge/pipeline/create 创建一个新的实验版本

pipeline 对应知识库控制台的“实验版本”功能，每个 pipeline 拥有一条独立的离线数据处理流水线，可以通过多个 pipeline 对比同一批数据的不同处理策略，并择优发布成正式版本

实验版本相关控制台操作介绍：https://www.volcengine.com/docs/84313/1510752
单个知识库最多创建 10 个 pipeline
仅旗舰版知识库支持使用实验版本 API

前提条件

完成“签名鉴权方式”页面的注册账号、实名认证、AK/SK 密钥获取和签名获取后，可调用 API 接口实现从知识库创建一个新实验版本的功能。

请求接口

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

请求参数

参数	子参数	类型	必选	默认值	说明
collection_name	--	string	否	--	知识库名称
project	--	string	否	default	项目名
resource_id	--	string	否	--	知识库唯一 id 可选择直接传 resource_id ，或同时传 name 和 project 作为知识库的唯一标识
name	--	string	是	--	实验版本名称不能使用已有系统的默认值 “default” 实验版本由字母、数字、下划线组成，并只能以字母开头长度不超过 128 个字符
index		object	否		索引配置
	index_config	object	否	--	支持以下字段： fields（list）：标签配置，数量上限 180 个，名称不可重复，可用于检索过滤。每个标签包含 field_name（标签名）、field_type（标签类型）、default_val（默认值）。字段名不能以 “_sys_auto” 开头；不传或为空则不添加过滤字段；若 field_name 设为 “doc_id” 且类型为 string，系统将自动写入文档的 doc_id 值 cpu_quota（int）：cpu 配额，整数，大于 0，默认为 1 embedding_model（string）：向量化模型 embedding_dimension（int）：向量维度 quant（string）：向量量化方式 “embedding_model”、”embedding_dimension” 和 “quant” 的可选范围参考向量化模型及索引算法对照表
	index_type	string	否	hnsw_hybrid	指定索引算法支持 hnsw_hybrid、hnsw 和 flat 推荐选择 “hnsw_hybrid”，能够兼具对关键词和语义的理解，综合提高检索精度向量化模型和索引算法的对照关系参考向量化模型及索引算法对照表
preprocessing		object	否		非结构化文档处理策略当 data_type 为 “unstructured_data” 时生效，为 “structured_data” 时无效。
	chunking_strategy	string	否	--	选用的切片策略，枚举值：["custom_balance", "custom"] “custom_balance” 是方舟知识库系统提供的最新默认文档处理策略，该策略：升级了对 PDF, DOCX 等复杂文档的解析和理解能力，对复杂文档版面结构、语义结构的解析能力获得大幅提升；特别优化了图片内容及其上下文的理解和加工能力，支持将图片和文本 chunk 混合编排，增强上下文一致性；特别优化了表格内容的理解加工能力，对长表格解析和切片更具优势；结合 VikingDB 语义和关键词融合检索算法，提高了多模态内容的检索能力，大幅提升相关信息的召回能力；提高了切片算法信噪比，无关信息更少，语义损失更小。选用此策略后，可生效的文档处理策略子参数包括： "chunk_length" (仅当“chunking_identifier”为空时生效） "merge_small_chunks" (仅当“chunking_identifier”为空时生效） "multi_mode" (仅当“chunking_identifier”为空时生效） “custom” 是使用自定义分隔符的文档处理策略，选用此策略后，可生效的文档处理策略子参数包括： “chunking_identifier” "chunk_length" (仅当“chunking_identifier”为空时生效） "merge_small_chunks" (仅当“chunking_identifier”为空时生效） "multi_mode" (仅当“chunking_identifier”为空时生效）请注意原 “default” 策略目前仅用于兼容存量知识库，不再维护，新建知识库建议采用 “custom_balance”
	chunking_identifier	list	否	--	自定义分隔符号
	chunk_length	int	否	500	切片最大长度取值范围见向量化模型及索引算法对照表
	merge_small_chunks	bool	否	true	是否合并短文本片配置是否对短文本片进行合并，且合并后的文本片会限制不超过切片最大长度
	multi_modal	list	否	--	图片召回策略枚举值： "image_ocr"：图片 ocr 传参示例：当 `"multi_modal": ["image_ocr"]` 时，开启图片 ocr，不传值即代表不开启图片 ocr 使用旧参数命名“multi_mode”创建的库仍保留原命名，但新创建知识库不推荐继续使用。
data_type	--	string	是	--	知识库内的数据类型 unstructured_data：非结构化数据 structured_data：结构化数据
table_config	--	object	否	--	结构化知识库表字段定义，当 data_type 为 “structured_data” 时生效，支持以下字段： table_type（string）：解析起始维度，可选 row（从行解析）或 col（从列解析） table_pos（int）：字段所在行或列的序号 start_pos（int）：起始数据所在行的序号 table_fields（list）：字段配置，每项包含 field_name（字段名）、field_type（字段类型，支持 string、int64、float32、bool）、if_embedding（是否参与索引）、default_value（默认值）、if_filter（是否设为过滤字段）
auto_sync_doc	--	bool	否	--	是否自动同步新增文档打开后调用 add_doc 接口向知识库上传文档时，自动同步到当前实验版本
doc_summary_config		object	否	--	知识库摘要配置
	enabled	bool	否	false	是否开启文档 AI 摘要功能配置知识库是否开启文档 AI 生成摘要功能，开启后，该知识库将自动为每篇文档生成摘要并保存结果到文档元信息中注：此功能仅对当知识库类型为非结构化知识库时生效，即 data_type 为 “unstructured_data” 时生效
pipeline_strategy_sync_type	--	string	否	--	同步策略选择，枚举值： sync：与正式版本一致 default：默认策略

响应消息

参数	参数说明
code	状态码
message	返回信息

状态码说明

状态码	http状态码	返回信息	状态码说明
0	200	success	成功
1000001	403	unauthorized	鉴权失败
1000002	403	no permission	权限不足
1000003	400	invalid request：%s	非法参数缺失必选参数 collection_name 命名不符合规范字段类型与相关字段属性不满足约束条件
1709905	400	A parameter specified in the request is not valid: %s	请求参数异常
1709900	500	Service has some internal Error. Pls Contact With Admin. %s	内部异常

完整示例

请求消息

curl -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: token=****' \
https://api-knowledgebase.mlp.cn-beijing.volces.com/api/knowledge/pipeline/create \
-d '{
  "collection_name": "test_collection_name",
  "project": "default",
  "name": "custom_pipeline_01",
  "data_type": "unstructured_data",
  "index_type": "hnsw_hybrid",
  "index_config": {
    "embedding_dimension": 2048,
    "quant": "int8",
    "cpu_quota": 1,
    "fields": [
      {
        "field_name": "type",
        "field_type": "string",
        "default_val": "instruction"
      }
    ]
  },
  "preprocessing": {
    "chunking_strategy": "custom_balance",
    "chunk_length": 800,
    "merge_small_chunks": true,
    "multi_modal": ["image_ocr"]
  },
  "auto_sync_doc": true
}'

响应消息

执行成功返回：

HTTP/1.1 200 OK
Content-Length: 78
Content-Type: application/json

{"code":0,"message":"success","request_id":"021695029537650fd001de666660000000000000000000230da93"}

执行失败返回：

HTTP/1.1 400 Bad Request
Content-Length: 105
Content-Type: application/json

{
"code": 1000003,
"message": "invalid request: pipeline name cannot be 'default'",
"request_id": "021695029757920fd001de6666600000000000000000002569b8f"
}

最近更新时间：2026.05.15 20:38:34

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

状态码说明 #

请求消息 #

响应消息 #

状态码说明

请求消息

响应消息