Index 操作

更新时间：2024-10-30

创建索引

接口描述

为指定表和字段新建索引，当前仅支持新建向量索引。支持同时建立多个索引（针对不同字段）。

请求结构

POST /v{version}/index?create HTTP/1.1
HOST: {Endpoint}
Authorization: {Authorization}
{
    "database": "db_name",
    "table": "table_name",
    "indexes": [
         {
             "field": "vector_field",
             "indexName": "vector_idx",
             "indexType": "HNSW",
             "metricType": "L2",
             "params": {
                  "M": 32,
                  "efConstruction": 200
             },
             "autoBuild": true,
             "autoBuildPolicy": {
                  "policyType": "timing",
                  "timing": "2024-01-01 12:00:00"
             }
         }
    ]
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必填	参数位置	描述
version	String	是	URL参数	API版本号，当前取1。
database	String	是	RequestBody参数	指定库的名称。
table	String	是	RequestBody参数	指定表的名称。
indexes	List Index	是	RequestBody参数	索引定义详情列表。

Index参数

参数名称	参数类型	描述
indexName	String	索引名称，要求表内唯一。索引名称的命名要求如下： 1. 仅支持大小写字母、数字以及下划线（_），必须以字母开头； 2. 长度限制为1~255。
indexType	String	索引类型。当前支持如下类型： SECONDARY：标量二级索引 HNSW：HNSW向量索引 FLAT：FLAT向量索引（暴力检索） PUCK：PUCK向量索引（百度自研搜索算法） HNSWPQ：HNSWPQ向量索引
metricType	String	向量索引的距离度量算法。支持如下距离类型： L2：欧几里得距离 IP：内积距离 COSINE：余弦距离注：当使用COSINE距离时，用户需要自行对相关向量进行归一化操作，未经归一化的向量将导致search结果不准确
params	VectorIndexParams	向量索引的参数详情。
field	String	索引作用于的字段名称。
autoBuild	Boolean	是否自动构建索引。
autoBuildPolicy	AutoBuildPolicy	构建索引策略。

AutoBuildPolicy

参数名称	类型	描述
policyType	String	自动构建索引策略类型，大小写不敏感，支持的类型如下： timing：定时构建索引，只构建一次。 periodical：周期性构建索引，每过多少秒会构建一次索引。 row_count_increment：根据tablet增加多少行数构建一次索引。
timing	String	定时构建索引，支持格式为LOCAL(%Y-%m-%d %H:%M:%S)以及UTC(%Y-%m-%dT%H:%M:%Z)，在policyType为timing时生效时只构建一次，不会重复构建。当policyType为periodical时，传入的时间作为周期性策略的开始时间
periodInSecond	Uint64	周期性构建索引的参数，每过periodInSecond构建一次索引，只在policyType为periodical时生效。可以指定从某个时间点开始，通过上面的timing参数传入。周期不能低于3600
rowCountIncrement	Uint64	当tablet（不是table）增加或者减少行数大于rowCountIncrement时构建一次索引，只在policyType为row_count_increment时生效。不能低于10000
rowCountIncrementRatio	double	当tablet增加或者减少行数百分比大于rowCountIncrementRatio时构建一次索引，只在policyType为row_count_increment时生效。不能小于等于0

VectorIndexParams参数

HNSW索引

参数名称	参数类型	描述
M	Int	HNSW索引算法参数，取值范围为[4, 128]。该参数表示每个节点在索引构图中可以连接多少个邻居节点。
efConstruction	Int	HNSW索引算法参数，取值范围为[8, 1024]。该参数表示搜索时指定寻找节点邻居遍历的范围。数值越大构图效果越好，构图时间也越长。

PUCK索引

参数名称	参数类型	描述
coarseClusterCount	Int	PUCK索引算法参数，取值范围为[1, 5000]。该参数表示索引中粗聚类中心个数。
fineClusterCount	Int	PUCK索引算法参数，取值范围为[1, 5000]。该参数表示每个粗聚类中心下细聚类中心个数。

HNSWPQ索引

参数名称	参数类型	描述
M	Int	HNSWPQ索引参数，取值范围为[4, 128]。该参数表示在HNSWPQ索引图中每个节点连接多少个邻居节点。
efConstruction	Int	HNSWPQ索引参数，取值范围为[8, 1024]。该参数表示在构建时使用临时邻居节点的数量，数值较大时搜索质量更好，构建时间也较长。
NSQ	Int	HNSWPQ索引参数，取值范围为[1, dim]。该参数表示量化子空间个数，pq量化相关系数，要求NSQ \| dim，NSQ越大量化越精细
sampleRate	float	HNSWPQ索引参数，取值范围为[0.0f, 1.0f]。该参数表示kmeans的采样率，pq抽样总数：10000 + (rowCount - 10000)*sampleRate

响应头域

除公共头域外，无其它特殊头域。

响应参数

参数名称	类型	描述
code	Int	返回码
msg	String	返回信息

请求示例

POST http://vdb.nXWNyPCOSLci.vdb.bj.baidubce.com/v1/index?create
Host: vdb.nXWNyPCOSLci.vdb.bj.baidubce.com
Authorization: Bearer account=root&api_key=eC4bLRy2va******************************
{
    "database": "db_name",
    "table": "table_name",
    "indexes": [
         {
             "field": "vector_field"
             "indexName": "vector_idx",
             "indexType": "HNSW",
             "metricType": "L2",
             "params": {
                  "M": 32,
                  "efConstruction": 200
             }
         }
    ]
}

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
Request-ID: d8752367-38e8-45e4-b4c7-e53be3137ce5
{
    "code": 0,
    "msg": "Success"
}

查询索引详情

接口描述

查询指定索引的详情。

请求结构

POST /v{version}/index?desc HTTP/1.1
HOST: {Endpoint}
Authorization: {Authorization}
{
    "database": "db_name",
    "table": "table_name",
    "indexName": "vector_idx"
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必填	参数位置	描述
version	String	是	URL参数	API版本号，当前取1。
database	String	是	RequestBody参数	指定库的名称。
table	String	是	RequestBody参数	指定表的名称。
indexName	String	是	RequestBody参数	指定索引的名称。

响应头域

除公共头域外，无其它特殊头域。

响应参数

Index参数

参数名称	参数类型	描述
indexName	String	索引名称。
indexType	String	索引类型。当前支持如下类型： SECONDARY：标量二级索引 HNSW：HNSW向量索引 FLAT：FLAT向量索引（暴力检索） PUCK：PUCK向量索引（厂内自研搜索算法） HNSWPQ：HNSWPQ向量索引
metricType	String	向量索引的距离度量算法。支持如下距离类型 L2：欧几里得距离 IP：内积距离 COSINE：余弦距离注：当使用COSINE距离时，用户需要自行对相关向量进行归一化操作，未经归一化的向量将导致search结果不准确
params	VectorIndexParams	向量索引的参数详情。
field	String	索引作用于的字段名称。
state	String	索引状态。取值如下： BUILDING：表示索引正在构建中； NORMAL：表示索引已完成构建并处于正常状态。
autoBuild	Boolean	是否自动构建索引。。
autoBuildPolicy	AutoBuildPolicy	自动构建索引策略参数 policyType：策略类型，有如下几种类型： periodical，周期性构建索引 rowCountIncrement，根据tablet行增长数自动构建索引 timing，定时构建索引 periodInSecond：周期性构建索引的秒数，只在周期性构建索引策略类型时返回 timing：字符串类型，返回定时构建的时间，在定时和周期性构建索引策略类型时返回 rowCountIncrement：返回触发构建时增量行数，只在增量构建索引类型时返回。 rowCountIncrementRatio：返回触发构建时增量行数百分比，只在增量构建索引类型时返回。
indexMajorVersion	Uint64	返回当前索引的版本，只在手动rebuild index建索引完成时增加。

VectorIndexParams参数

HNSW索引

参数名称	参数类型	描述
M	Int	HNSW索引算法参数。该参数表示每个节点在索引构图中可以连接多少个邻居节点。
efConstruction	Int	HNSW索引算法参数。该参数表示搜索时指定寻找节点邻居遍历的范围。数值越大构图效果越好，构图时间也越长。

PUCK索引

参数名称	参数类型	描述
coarseClusterCount	Int	PUCK索引算法参数。该参数表示索引中粗聚类中心的个数。
fineClusterCount	Int	PUCK索引算法参数。该参数表示索引中每个粗聚类中心下细聚类中心的个数。

HNSWPQ索引

参数名称	参数类型	描述
M	Int	HNSWPQ索引参数，取值范围为[4, 128]。该参数表示在HNSWPQ索引图中每个节点连接多少个邻居节点。
efConstruction	Int	HNSWPQ索引参数，取值范围为[8, 1024]。该参数表示在构建时使用临时邻居节点的数量，数值较大时搜索质量更好，构建时间也较长。
NSQ	Int	HNSWPQ索引参数，取值范围为[1, dim]。该参数表示量化子空间个数，pq量化相关系数，要求NSQ \| dim，NSQ越大量化越精细
sampleRate	float	HNSWPQ索引参数，取值范围为[0.0f, 1.0f]。该参数表示kmeans的采样率，pq抽样总数：10000 + (rowCount - 10000)*sampleRate

请求示例

POST http://vdb.nXWNyPCOSLci.vdb.bj.baidubce.com/v1/index?desc
Host: vdb.nXWNyPCOSLci.vdb.bj.baidubce.com
Authorization: Bearer account=root&api_key=eC4bLRy2va******************************
{
    "database": "db_test",
    "table": "table_test",
    "indexName": "vector_idx"
}

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
Request-ID: d8752367-38e8-45e4-b4c7-e53be3137ce5
{
    "index": {
        "indexName": "vector_idx",
        "field": "vector_field",
        "autoBuild": false,
        "indexType": "HNSW",
        "metricType": "L2",
        "params": {
            "M": 32,
            "efConstruction": 200
        },
        "state": "NORMAL"
    },
    "code": 0,
    "msg": "Success"
}

重建索引

接口描述

重建指定索引，仅支持重建向量索引。

请求结构

POST /v{version}/index?rebuild HTTP/1.1
HOST: {Endpoint}
Authorization: {Authorization}
{
    "database": "db_name",
    "table": "table_name",
    "indexName": "vector_idx"
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必填	参数位置	描述
version	String	是	URL参数	API版本号，当前取1。
database	String	是	Request Body参数	指定库的名称。
table	String	是	Request Body参数	指定表的名称。
indexName	Index	是	Request Body参数	指定索引的名称。

响应头域

除公共头域外，无其它特殊头域。

响应参数

参数名称	类型	描述
code	Int	返回码
msg	String	返回信息

请求示例

POST http://vdb.nXWNyPCOSLci.vdb.bj.baidubce.com/v1/index?rebuild
Host: vdb.nXWNyPCOSLci.vdb.bj.baidubce.com
Authorization: Bearer account=root&api_key=eC4bLRy2va******************************
{
    "database": "db_test",
    "table": "table_test",
    "indexName": "vector_idx"
}

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
Request-ID: d8752367-38e8-45e4-b4c7-e53be3137ce5
{
    "code": 0,
    "msg": "Success"
}

删除索引

接口描述

删除指定索引。

请求结构

DELETE /v{version}/index HTTP/1.1
HOST: {Endpoint}
Authorization: {Authorization}
{
    "database": "db_name",
    "table": "table_name",
    "indexName": "index_name"
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必填	参数位置	描述
version	String	是	URL参数	API版本号，当前取1。
database	String	是	Query参数	指定库的名称。
table	String	是	Query参数	指定表的名称。
indexName	Index	是	Query参数	指定索引的名称。

响应头域

除公共头域外，无其它特殊头域。

响应参数

参数名称	类型	描述
code	Int	返回码
msg	String	返回信息

请求示例

DELETE http://vdb.nXWNyPCOSLci.vdb.bj.baidubce.com/v1/index
Host: vdb.nXWNyPCOSLci.vdb.bj.baidubce.com
Authorization: Bearer account=root&api_key=eC4bLRy2va******************************
{
    "database": "db_test",
    "table": "table_test",
    "indexName": "vector_idx"
}

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
Request-ID: d8752367-38e8-45e4-b4c7-e53be3137ce5
{
    "code": 0,
    "msg": "Success"
}

修改索引

接口描述

修改向量索引信息，目前只支持修改autoBuild属性。

请求结构

POST /v{version}/index?modify HTTP/1.1
HOST: {Endpoint}
Authorization: {Authorization}
{
    "database": "db_name",
    "table": "table_name",
    "index": {
         "indexName": "vector_idx",
         "autoBuild": true,
         "autoBuildPolicy": {
              "policyType": "PERIODICAL",
              "periodInSecond": 5000,
              "timing": "2026-01-01 12:00:00"
         }
    }
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必填	参数位置	描述
version	String	是	URL参数	API版本号，当前取1。
database	String	是	RequestBody参数	指定库的名称。
table	String	是	RequestBody参数	指定表的名称。
index	Index	是	RequestBody参数	索引定义详情。

Index参数

参数名称	参数类型	描述
indexName	String	索引名称，要求表内唯一。索引名称的命名要求如下： 1. 仅支持大小写字母、数字以及下划线（_），必须以字母开头； 2. 长度限制为1~255。
autoBuild	Boolean	是否自动构建索引。
autoBuildPolicy	AutoBuildPolicy	构建索引策略。

AutoBuildPolicy

参数名称	类型	描述
policyType	String	自动构建索引策略类型，大小写不敏感，支持的类型如下： timing：定时构建索引，只构建一次。 periodical：周期性构建索引，每过多少秒会构建一次索引。 row_count_increment：根据tablet增加多少行数构建一次索引。
timing	String	定时构建索引，支持格式为LOCAL(%Y-%m-%d %H:%M:%S)以及UTC(%Y-%m-%dT%H:%M:%Z)，在policyType为timing时生效时只构建一次，不会重复构建。当policyType为periodical时，传入的时间作为周期性策略的开始时间
periodInSecond	Uint64	周期性构建索引的参数，每过periodInSecond构建一次索引，只在policyType为periodical时生效。可以指定从某个时间点开始，通过上面的timing参数传入。周期不能低于3600
rowCountIncrement	Uint64	当tablet（不是table）增加或者减少行数大于rowCountIncrement时构建一次索引，只在policyType为row_count_increment时生效。不能低于10000
rowCountIncrementRatio	double	当tablet增加或者减少行数百分比大于rowCountIncrementRatio时构建一次索引，只在policyType为row_count_increment时生效。不能小于等于0

响应头域

除公共头域外，无其它特殊头域。

响应参数

参数名称	类型	描述
code	Int	返回码
msg	String	返回信息

请求示例

POST http://vdb.nXWNyPCOSLci.vdb.bj.baidubce.com/v1/index?create
Host: vdb.nXWNyPCOSLci.vdb.bj.baidubce.com
Authorization: Bearer account=root&api_key=eC4bLRy2va******************************
{
    "database": "db_name",
    "table": "table_name",
    "index": [
         "indexName": "vector_idx",
         "autoBuild": true,
         "autoBuildPolicy": {
              "policyType": "PERIODICAL",
              "periodInSecond": 5000,
              "timing": "2026-01-01 12:00:00"
         }
    ]
}

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
Request-ID: d8752367-38e8-45e4-b4c7-e53be3137ce5
{
    "code": 0,
    "msg": "Success"
}

Row 操作

Role 操作

向量数据库 VectorDB

Index 操作

创建索引

接口描述

请求结构

请求头域

请求参数

响应头域

响应参数

请求示例

响应示例

查询索引详情

接口描述

请求结构

请求头域

请求参数

响应头域

响应参数

请求示例

响应示例

重建索引

接口描述

请求结构

请求头域

请求参数

响应头域

响应参数

请求示例

响应示例

删除索引

接口描述

请求结构

请求头域

请求参数

响应头域

响应参数

请求示例

响应示例

修改索引

接口描述

请求结构

请求头域

请求参数

响应头域

响应参数

请求示例

响应示例