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

向量数据库VikingDB

请输入
  • 文档首页
    • 向量数据库VikingDBViking 知识库API参考实验版本（新）create
复制全文
下载 pdf
我的收藏
实验版本（新）
create
复制全文
下载 pdf
我的收藏
create

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

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

  • 实验版本相关控制台操作介绍：配置实验版本
  • 单个知识库最多创建 10 个 pipeline
  • 仅旗舰版知识库支持使用实验版本 API
前提条件

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

请求接口
URIapi/knowledge/pipeline/create统一资源标识符
请求方法POST客户端向向量数据库服务器请求的操作类型
请求头Content-Type: application/json请求消息类型
Authorization: HMAC-SHA256 ***鉴权
请求参数
参数子参数类型必选默认值说明
collection_name--string否--知识库名称
project--string否default知识库所属的已有项目名；值不能为空，且必须是当前账号下已存在并可访问的项目。该接口不创建项目，不传时使用 default；接口层未额外限制字符集或长度。
resource_id--string二选一--知识库唯一 ID；与 collection_name 至少传一个，都不传返回参数错误，同时传入时优先使用 resource_id。

name

--

string

是

--

实验版本名称

  • 不能使用已有系统的默认值 “default”
  • 实验版本由字母、数字、下划线组成，并只能以字母开头
  • 长度不超过 128 个字符
indexobject否索引配置
index_configobject否--索引配置对象，所有子字段均为选填：fields（list<object>，默认空）、cpu_quota（int，单位核，范围 [1,100]，默认 1）、embedding_model（string，默认 doubao-embedding-and-m3）、embedding_dimension（int，默认模型维度）、quant（string，默认 int8）。模型、维度和量化范围见创建知识库接口的对照表。

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” 是方舟知识库系统提供的最新默认文档处理策略，该策略：
  1. 升级了对 PDF, DOCX 等复杂文档的解析和理解能力，对复杂文档版面结构、语义结构的解析能力获得大幅提升；特别优化了图片内容及其上下文的理解和加工能力，支持将图片和文本 chunk 混合编排，增强上下文一致性；特别优化了表格内容的理解加工能力，对长表格解析和切片更具优势；结合 VikingDB 语义和关键词融合检索算法，提高了多模态内容的检索能力，大幅提升相关信息的召回能力；提高了切片算法信噪比，无关信息更少，语义损失更小。
  2. 选用此策略后，可生效的文档处理策略子参数包括：
  • "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_identifierlist<string>否--自定义分隔符号。列表长度 [1,20]，每项长度 [1,10] 个字符且不能包含 \|。
chunk_lengthint否500切片最大长度，单位为字节；取值范围随 embedding_model 变化。

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否true是否自动同步新增文档。true 时后续上传文档自动进入当前实验版本；false 时新文档不会自动同步，需通过批量同步或重处理接口导入。
doc_summary_configobject否--知识库摘要配置

enabled

bool

否

false

是否开启文档 AI 摘要功能
配置知识库是否开启文档 AI 生成摘要功能，开启后，该知识库将自动为每篇文档生成摘要并保存结果到文档元信息中
注：此功能仅对当知识库类型为非结构化知识库时生效，即 data_type 为 “unstructured_data” 时生效

pipeline_strategy_sync_type

--

string

否

--

同步策略选择，枚举值：

  • sync：与正式版本一致
  • default：默认策略
响应消息
参数参数说明
code状态码
message返回信息

状态码说明

状态码http状态码返回信息状态码说明
0200success成功
1000001403unauthorized鉴权失败
1000002403no permission权限不足

1000003

400

invalid request：%s

非法参数

  • 缺失必选参数
  • collection_name 命名不符合规范
  • 字段类型与相关字段属性不满足约束条件
1709905400A parameter specified in the request is not valid: %s请求参数异常
1709900500Service has some internal Error. Pls Contact With Admin. %s内部异常
完整示例

请求消息 

curl -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: HMAC-SHA256 ***' \
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": {
    "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.09.08 20:33:12
这个页面对您有帮助吗？
有用
有用
无用
无用