参数命名风格

驼峰（IndexName）

下划线（index_name）

ProjectName

String

否

项目名称

CollectionName

String

2选1

数据集名称

ResourceId

String

数据集资源ID。请求必须指定ResourceId和CollectionName其中之一。

IndexName

String

是

索引名称

CollectionName

String

数据集名称

ProjectName

String

项目名称

ResourceId

String

资源ID

IndexName

String

索引名称

CpuQuota

Integer

索引检索消耗的 CPU 配额。

ShardPolicy

String

索引分片类型，auto为自动分片、custom为自定义分片。

ShardCount

Integer

索引分片数

Description

String

索引描述

VectorIndex

Map

向量索引配置

IndexType

String

索引类型

Distance

String

距离类型，衡量向量之间距离的算法。取值如下：
ip：全称是 Inner Product，内积，该算法基于向量的内积，即两个元素的对应元素相乘并求和的结果计算相似度，内积值越大相似度越高。
l2：欧几里得距离，它计算两个向量的欧几里得空间距离，欧式距离越小相似度越高。
cosine：余弦相似度（Cosine Similarity），也称为余弦距离（Cosine Distance），用于计算两个高维向量的夹角余弦值从而衡量向量相似度，夹角余弦值越小表示两向量的夹角越大，则两个向量差异越大。
当 distance=cosine 时，默认对向量做归一化处理。
当索引算法选择IVF时，距离类型可选ip、cosine。
对于hnsw_hybrid索引算法，距离类型选择只对稠密向量生效，稀疏向量仅支持内积。

Quant

String

量化方式。量化方式是索引中对向量的压缩方式，可以降低向量间相似性计算的复杂度。基于向量的高维度和大规模特点，采用向量量化可以有效减少向量的存储和计算成本。取值如下：

• int8：将4字节的 float 压缩为单个字节，以获取内存和计算延迟的收益，会造成微小的损失精度，比如 cosine 距离会出现大于1的分值。
• float：全精度，未做压缩量化。
• fix16：将4字节的 float 压缩为两个字节，以获取内存和计算延迟的收益，会造成微小的损失精度。通过损失一定的检索精度，提升检索性能，节约资源成本。
• pq：将高维向量转换为低维码本向量，以减少内存占用并提高搜索效率。

int8适用于hnsw、hnsw_hybrid、flat索引算法，距离方式为ip、consine。

float适用于hnsw、hnsw_hybrid、flat、diskann索引算法，距离方式为ip、l2、consine。

fix16适用于hnsw、hnsw_hybrid、flat索引算法，距离方式为ip、l2、consine。

pq适用于diskann、ivf索引算法，距离方式为ip、l2、consine。

HnswM

Integer

hnsw 索引参数，表示邻居节点个数。

• 当 index_type 配置为 hnsw 和 hnsw_hybrid 时可选配置。

HnswCef

Integer

hnsw 索引参数，表示构建图时搜索邻居节点的广度。

• 当 index_type 配置为 hnsw 和 hnsw_hybrid 时可选配置。

HnswSef

Integer

hnsw 索引参数，表示线上检索的搜索广度。

• 当 index_type 配置为 hnsw 和 hnsw_hybrid 时可选配置。

DiskannM

Integer

diskann参数，标识邻居节点个数。

• 当 index_type 配置为 diskann时可选配置。

DiskannCef

Integer

diskann参数，表示构建图时搜索邻居节点的广度。

• 当 index_type 配置为 diskann时可选配置。

PqCodeRatio

Float

diskann参数，向量维度编码的大小限制。值越大，召回率越高，但会增加内存使用量，范围 (0.0, 0.25]。

• 当 index_type 配置为 diskann时可选配置。

CacheRatio

Float

diskann参数，缓存节点数与原始数据的比率，较大的值会提高索引性能并增加内存使用量。范围 [0.0,0.3)。

• 当 index_type 配置为 diskann时可选配置。

ScalarIndex

Array of Map

标量字段列表

"ScalarIndex": [
    {
        "FieldName": "f_int64_1", #string
        "FieldType": "int64", #string
        "DefaultValue": 0 #any
    },

ActualCU

Integer

实际CU用量