请求方法

POST

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

请求头

Content-Type: application/json

请求消息类型

Authorization: HMAC-SHA256 ***

鉴权

name

--

string

是

--

知识库的名字

• 只能使用英文字母、数字、下划线_，并以英文字母开头，不能为空
• 长度要求：[1-64]
• 知识库名称不能重复

project

--

string

否

default

知识库所属项目，即在【访问控制】-【资源管理】-【项目】中创建的项目

description

--

string

否

""

知识库描述信息

• 长度要求：[1, 65535]

data_type

string

否

unstructured_data

知识库内的数据类型。

• unstructured_data：非结构化数据
• structured_data：结构化数据。

preprocessing

object

否

文档处理策略，当data_type为“unstructured_data”时生效，为“structured_data”时无效。

chunking_strategy

string

选用的切片策略，枚举值：["custom_balance", "custom"]

• “custom_balance” 是方舟知识库系统提供的最新默认文档处理策略，该策略：
  1. 升级了对 PDF, DOCX 等复杂文档的解析和理解能力，对复杂文档版面结构、语义结构的解析能力获得大幅提升；特别优化了图片内容及其上下文的理解和加工能力，支持将图片和文本 chunk 混合编排，增强上下文一致性；特别优化了表格内容的理解加工能力，对长表格解析和切片更具优势；结合VikingDB 语义和关键词融合检索算法，提高了多模态内容的检索能力，大幅提升相关信息的召回能力；提高了切片算法信噪比，无关信息更少，语义损失更小。
  2. 选用此策略后，可生效的文档处理策略子参数包括：
  • "chunk_length" (仅当“chunk_identifier"为空时生效）
  • "merge_small_chunks" (仅当“chunk_identifier"为空时生效）
  • "multi_mode" (仅当“chunk_identifier"为空时生效）
• “custom” 是使用自定义分隔符的文档处理策略，选用此策略后，可生效的文档处理策略子参数包括：
  • “chunking_identifier"
  • "chunk_length" (仅当“chunk_identifier"为空时生效）
  • "merge_small_chunks" (仅当“chunk_identifier"为空时生效）
  • "multi_mode" (仅当“chunk_identifier"为空时生效）
• 请注意原“default”策略目前仅用于兼容存量知识库，不再维护，新建知识库建议采用“custom_balance”

chunking_identifier

list

否

--

自定义分隔符号

chunk_length

int

否

500

切片最大长度
范围为 [100,500]、[100,4000] 或 [100,8000]（根据选择的 embedding_model 判定，bge-large-zh-and-m3 和 bge-large-zh 范围为 [100,500]，doubao-embedding-and-m3 和 doubao-embedding 为 [100,4000]，bge-m3 为 [100,8000]），默认为 500，不在范围内会报错

merge_small_chunks

bool

否

true

是否合并短文本片

multi_modal

--

否

--

图片召回策略
枚举值：

• "image_ocr"：图片ocr

传参示例：

• 当 "multi_modal": ["image_ocr"] 时，开启图片ocr，不传值即代表不开启图片ocr

使用旧参数命名“multi_mode"创建的库仍保留原命名，但新创建知识库不推荐继续使用。

table_config

object

否

当 data_type为“structured_data”时生效

{
  "table_type": "row","col",
  // row表示从行开始解析，col表示从列开始解析,
  "table_pos": "int",
  // 字段位于第几行或第几列,
  "start_pos": "int",
  // 起始数据在第几行,
  "table_fields": [
      { "field_name": "xxx", //字段名称
          "field_type": "int64", //字段类型, 支持string, int64, float32, bool
          "if_embedding": true, //是否参与索引
          "default_value":"xxx", //默认值
          "if_filter": false //设置为过滤字段
    },
    .....
  ]
}

index

object

否

--

索引配置

index_config

object

否

--

{
    "fields": [
        {
            "field_name": "type",
            //字段名
            "field_type": "string",
            //字段类型
            "default_val": "instruction"
            //字段默认值
         },
         {...}
    ],
    "cpu_quota": 1,
    // cpu 配额，整数型，大于 0， 默认值为 1
    "embedding_model": "doubao-embedding-and-m3",
    // 指定向量化模型
    "embedding_dimension": 2048,
    // 向量维度
    "quant": "int8"
    // 向量的量化方式

    // "embedding_model"、"embedding_dimension"和"quant"可选范围参考
}

注：

• fields 数量限制为 50 个，且名称不可重复。
• fields 的名字不能以 "_sys_auto" 开头，否则会创建失败。
• 对于 fields，如果不传或 value 为空，将不会加入任何的筛选字段。
• 如果 field 设置 doc_id 字段，doc_id 字段需要为 string 类型，这时系统会将 doc 的 doc_id 字段加入筛选字段

index_type

string

否

hnsw_hybrid

指定索引算法，支持 hnsw_hybrid、hnsw 和 flat
推荐选择 “hnsw_hybrid”，能够兼具对关键词和语义的理解，综合提高检索精度
向量化模型和索引算法的对照关系参考 向量化模型及索引算法对照表

doubao-embedding-and-m3

稠密向量和稀疏向量

hnsw_hybrid

1024、2048

int8、float、fix16

混合检索（兼顾语义检索和关键词匹配）

doubao-embedding

稠密向量

hnsw、flat

1024、2048

int8、float、fix16

语义检索（字节自研模型）

bge-large-zh

稠密向量

hnsw、flat

1024

int8、float、fix16

语义检索

bge-m3

稠密向量和稀疏向量

hnsw_hybrid

1024

int8、float、fix16

混合检索（兼顾语义检索和关键词匹配）

hnsw、flat

1024

int8、float、fix16

语义检索（此时稀疏向量被忽略，适用于只需要长文本窗口、多语言检索的纯语义检索场景）

bge-large-zh-and-m3

稠密向量和稀疏向量

hnsw_hybrid

1024

int8、float、fix16

混合检索（兼顾语义检索和关键词匹配）

code

状态码

message

返回信息

data

返回的详细信息
{
"resource_id": 知识库的唯一id
}

request_id

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

0

200

success

成功

1000001

403

unauthorized

鉴权失败

1000002

403

no permission

权限不足

1000003

400

invalid request：%s

非法参数

• 缺失必选参数
• collection命名不符合规范
• 字段类型与相关字段属性不满足约束条件

1000004

400

collection exist

collection已存在