Vector

类别

说明

语法

TVS.CREATEINDEX index_name dims algorithm distance_method [algo_param_key alog_param_value] ...

时间复杂度

O(1)

命令描述

创建一个向量索引空间，同时指定构建索引和查询的具体算法，以及距离函数。该对象仅能通过TVS.DELINDEX命令删除。

选项

• index_name：向量索引名称。

• dims：向量维度，插入该索引的向量需具有相同的向量维度，取值范围为[1, 32768]。

• algorithm：构建、查询索引的算法，取值如下：

  • FLAT：不单独构建索引，采用暴力搜索的方式执行查询，适合1万条以下的小规模数据集。

  • HNSW：采用HNSW图结构构建整个索引，并通过该算法进行查询，适合大规模的数据集。

• distance_method：计算向量距离函数，取值如下：

  • L2：平方欧氏距离。

  • IP：向量内积，距离值为1-向量内积。

  • COSINE：余弦距离，距离值为1-向量余弦值。使用余弦距离会将写入的向量转化为单元向量（L2正则化），因此查询得到的向量结果可能不是原始向量值。

  • JACCARD：Jaccard距离，距离值为1-Jaccard系数，且需指定向量数据类型（data_type）为BINARY。

• algo_param_key和alog_param_value：

  • data_type：（稠密）向量的数据类型，取值说明如下。

    • FLOAT32（默认）：4字节的单精度浮点数。

    • FLOAT16：2字节的半精度浮点数（IEEE 754-2008标准），可节省向量存储空间，但会损失一定的精度，FLOAT16能表示的最大数值范围为[-65519, 65519]。

    • BINARY：二进制向量，仅能包含0或1，仅支持Jaccard距离函数。

  • HNSW索引的特定参数，取值说明如下：

    • ef_construct：使用HNSW算法构建索引时，动态列表的长度。默认为100，取值范围为[1,1000]，该值越大则ANN查询精度越高，同时性能开销越大。

    • M：图索引结构中，每一层的最大出边数量。默认为16，取值范围为[1,100]。该值越大则ANN查询精度越高，同时性能开销越大。

    • auto_gc：自动回收索引空间，取值为false（默认，表示关闭）、true（表示开启），该功能要求实例的小版本为6.2.8.2及以上。HNSW索引的向量删除采用标记删除的方式，开启该功能后，支持索引空间的自动回收，可有效降低内存占用，但该功能会影响该索引近邻查询的性能，推荐对内存占用量敏感的场景使用该功能。

  • HybridIndex（混合索引）的特定参数，取值说明如下：

    • 如需对指定标签字段创建倒排索引，需提前指定字段名称与对应的数据类型。

      语法为inverted_index_<field_name> int|long|float|double|string，对field_name字段建立倒排索引，支持的类型为Int、Long、Float、Double和String，field_name字段和数据类型关键字需小写。

      例如希望对productname字段（String类型）创建倒排索引的示例为inverted_index_productname string。

    • lexical_algorithm：全文检索算法。

      • bm25：BM25（Okapi BM25）算法，适用于全文检索

        • 后续 TVS.HSET 写入时，attribute_key 为 TEXT 关键字（必须大写），对应的 attribute_value 会自动建全文索引。

        • 您可传入原始文本，由Tair向量服务构建索引。

      • vector：Vector算法，适用于稀疏向量。

        您需要对原始文本进行编码（Embedding），传入稀疏向量。数据格式为"[[2,0.221],[42,09688],...]"，其中Key为Indices，类型为uint32_t，Value为该Index的词频概览，类型为Float。

    • 若lexical_algorithm设置为bm25，您还可以设置如下参数。

      • analyzer：分词器，当前支持jieba（默认）、ik_smart。

      • k1：BM25算法中控制词频饱和度，默认为1.2，取值范围需大于0。

      • b：BM25算法中控制文档长度的影响，默认为0.75，取值范围为[0,1]。

    • 若lexical_algorithm设置为vector，您还可以设置如下参数。

      • lexical_use_hnsw：稀疏向量是否使用HNSW索引，取值：1（使用HNSW索引）、0（默认，使用倒排索引）。

      • lexical_hnsw_m：当lexical_use_hnsw为1时，该参数为HNSW索引的M参数，作用与说明请参见HNSW索引的特定参数。

      • lexical_hnsw_ef_construct：当lexical_use_hnsw为1时，该参数为HNSW索引的ef_construct参数，作用与说明请参见HNSW索引的特定参数。

    • hybrid_ratio：该索引在查询时向量检索的默认权重，默认为0.5，取值范围为[0,1]，Float类型，全文检索的权重为1-hybrid_ratio。

返回值

• 执行成功：返回OK。

• 其他情况返回相应的异常信息。

示例

命令示例：

# 创建向量存储结构：向量维度为2、索引类型为HNSW、距离函数为Jaccard、向量数据类型为BINARY。
TVS.CREATEINDEX index_name0 2 HNSW JACCARD data_type BINARY

# 创建向量存储结构：向量维度为2、索引类型为HNSW、距离函数为L2、向量数据类型为FLOAT32。
TVS.CREATEINDEX index_name1 2 HNSW L2 

# 创建向量存储结构：向量维度为2、索引类型为FLAT、距离函数为IP、向量数据类型为FLOAT32。
TVS.CREATEINDEX index_name2 2 FLAT IP 

# 创建向量存储结构：向量维度为2、索引类型为FLAT、距离函数为Jaccard、向量数据类型为BINARY。
TVS.CREATEINDEX index_name3 2 FLAT JACCARD data_type BINARY

# 创建向量存储结构：向量维度为2、索引类型为HNSW、距离函数为IP、向量数据类型为FLOAT32、全文检索算法为BM25，指定productname字段（String类型）为倒排索引。
TVS.CREATEINDEX index_name4 2 HNSW IP lexical_algorithm bm25 inverted_index_productname string

# 创建稀疏向量存储结构：向量维度为2、距离函数为IP、使用HNSW索引。
TVS.CREATEINDEX index_name5 2 HNSW IP lexical_algorithm vector lexical_use_hnsw 1 lexical_hnsw_m 8 lexical_hnsw_ef_construct 100

返回示例均为如下：

OK

类别

说明

语法

TVS.GETINDEX index_name

时间复杂度

O(1)

命令描述

查询指定的向量索引，获取该向量索引的元数据信息。

选项

• index_name：向量索引名称。

返回值

• 执行成功：返回该向量索引的元数据信息。

• 若指定的向量索引不存在，返回(empty array)。

• 其他情况返回相应的异常信息。

示例

请提前执行如下命令：

TVS.CREATEINDEX my_index 2 HNSW L2 auto_gc true lexical_algorithm bm25
TVS.HSET my_index key0 VECTOR [1,2] creation_time 1730
TVS.HSET my_index key1 VECTOR [3,4] creation_time 1740
TVS.HSET my_index key2 VECTOR [5,6] creation_time 1750

命令示例（以HNSW算法的向量索引为例）：

TVS.GETINDEX my_index

返回示例：

 1) "lexical_term_count"   // 全文索引分词数，Int类型。
 2) "0"
 3) "lexical_record_count" // 全文索引文档数，Int类型。
 4) "0"
 5) "lexical_algorithm"    // 全文索引算法。
 6) "bm25"
 7) "auto_gc"              // HNSW算法模式下，是否开启自动回收索引空间。
 8) "1"
 9) "dimension"            // 向量维度。
10) "2"
11) "attribute_data_size"  // 属性信息内存占用（单位：字节）。
12) "3720"
13) "distance_method"      // 向量距离函数。
14) "L2"
15) "data_type"            // 向量数据类型。
16) "FLOAT32"
17) "algorithm"            // 索引算法。
18) "HNSW"
19) "index_data_size"      // 向量数据内存占用（单位：字节）。
20) "105128040"
21) "M"                    // HNSW算法模式下，图索引结构中，每一层的最大出边数量。
22) "16"
23) "data_count"           // 用户记录数。
24) "3"
25) "current_record_count" // 总向量数。
26) "3"
27) "ef_construct"         // HNSW算法模式下，动态列表的长度。
28) "100"
29) "inverted_index_productname" // 倒排索引信息：字段名称、数据类型、数量。
30) "field: productname, type: string, size: 1"
31) "delete_record_count"  // 待回收的向量数。
32) "0"

类别

说明

语法

TVS.DELINDEX index_name

时间复杂度

O(N)，N为该向量索引中Key的数量。

命令描述

删除指定的向量索引及该索引内的所有数据。

选项

• index_name：向量索引名称。

返回值

• 执行成功：删除向量索引，并返回1。

• 若指定索引不存在，返回0。

• 其他情况返回相应的异常信息。

示例

命令示例：

TVS.DELINDEX index_name0

返回示例：

 (integer) 1

类别

说明

语法

TVS.SCANINDEX cursor [MATCH pattern] [COUNT count]

时间复杂度

O(N)，N为Tair实例中向量索引数量。

命令描述

扫描Tair实例中所有符合条件的向量索引。

选项

• cursor：指定本次扫描的游标，从0开始。

• pattern：模式匹配。

• count：指定本次扫描的数量，默认为10，但无法保证每次迭代都返回精准的元素数量。

返回值

• 执行成功，返回一个数组：

  • 第一个元素：下次查询的游标，若已扫描完成，则返回0。

  • 第二个元素：本次查询的向量索引（ index_name）名称。

• 其他情况返回相应的异常信息。

示例

命令示例：

TVS.SCANINDEX 0

返回示例：

1) "0"
2) 1) "index_name1"
   2) "index_name0"
   3) "index_name2"
   4) "index_name3"

带Pattern的查询示例：

TVS.SCANINDEX 0 MATCH **name[0|1]

返回示例：

1) "0"
2) 1) "index_name1"
   2) "index_name0"

类别

说明

语法

TVS.HSET index_name key attribute_key attribute_value [attribute_key attribute_value] ...

时间复杂度

若本次插入、更新数据无需创建或更新向量值，则时间复杂度为O(1)；否则时间复杂度为O(log(N))，N为该向量索引中Key的数量。

命令描述

往向量索引中插入数据记录（key），若该记录已存在则更新并覆盖原记录。

选项

• index_name：向量索引名称。

• key：该记录的主键标识，该对象可通过TVS.DEL命令删除。

• attribute_key和attribute_value：该条记录的数值，为Key-value格式。

  • 插入向量数据：需要将attribute_key设置为VECTOR关键字（必须大写），对应的attribute_value则需要为该向量索引指定维度（dims）的向量数据字符串，例如VECTOR [1,2]。一个Key仅支持写入一个VECTOR数据，若重复写入会更新并覆盖原数据。

  • 插入文本数据：在创建索引时已制定HybridIndex相关参数，需要将attribute_key设置为TEXT关键字（必须大写），对应的attribute_value可以是文本格式（Text），例如"TairVector是Tair自研的向量数据库服务"，也可以是向量化（Embedding）后的数据，例如"[[2,0.221],[42,09688],...]"。

  • 插入其他属性：可以自定义额外属性或信息，例如create_time 1663637425（创建时间）、location Hangzhou（地点）等。

返回值

• 执行成功：返回新增的数据记录数量，若更新已有的字段则返回0。

• 其他情况返回相应的异常信息。

示例

命令示例：

TVS.HSET my_index key5 VECTOR [7,8] TEXT "TairVector是Tair自研的向量数据库服务" create_time 1800

返回示例：

(integer) 3

类别

说明

语法

TVS.HGETALL index_name key

时间复杂度

O(1)

命令描述

查询指定向量索引中的key对应的所有数据记录。

选项

• index_name：向量索引名称。

• key：该记录的主键标识。

返回值

• 执行成功：返回该key的所有数据记录。

• 若指定的向量索引或key不存在，返回(empty array)。

• 其他情况返回相应的异常信息。

示例

命令示例：

TVS.HGETALL index_name0 key0

返回示例：

1) "VECTOR"
2) "[1,2]"
3) "location"
4) "Hangzhou"
5) "create_time"
6) "1663637425"

类别

说明

语法

TVS.HMGET index_name key attribute_key [attribute_key ...]

时间复杂度

O(1)

命令描述

查询指定向量索引的key中对应的attribute_key所对应的数值。

选项

• index_name：向量索引名称。

• key：该记录的主键标识。

• attribute_key：待操作的属性Key，支持指定多个。若需查询向量数据，需传入VECTOR关键字（必须大写）。若需查询全文索引中原生文本数据，需传入TEXT关键字（必须大写）。

返回值

• 执行成功：返回attribute_key对应的数值。

• 其他情况返回相应的异常信息。

示例

命令示例：

TVS.HMGET index_name0 key0 create_time location VECTOR TEXT

返回示例：

1) "1800"
2) "[7,8]"
3) "TairVector是Tair自研的向量数据库服务"

类别

说明

语法

TVS.DEL index_name key [key ...]

时间复杂度

O(1)

命令描述

在指定向量索引中，删除指定数据记录（key）。

选项

• index_name：向量索引名称。

• key：该记录的主键标识，支持指定多个。

返回值

• 执行成功：删除指定数据记录（key），并返回删除key的数量。

• 若指定索引不存在，返回0。

• 其他情况返回相应的异常信息。

示例

命令示例：

TVS.DEL index_name0 keyV

返回示例：

 (integer) 1

类别

说明

语法

TVS.HDEL index_name key attribute_key [attribute_key ...]

时间复杂度

O(1)

命令描述

在向量索引的数据记录（key）中，删除指定的attribute_key与其数值。

选项

• index_name：向量索引名称。

• key：该记录的主键标识，支持指定多个。

• attribute_key：待操作的属性Key，支持指定多个。若需删除向量数据，需传入VECTOR关键字（必须大写）。若需删除全量索引数据，需传入TEXT关键字（必须大写）。

返回值

• 执行成功：删除指定数据，并返回删除attribute_key的数量。

• 若指定索引不存在，返回0。

• 其他情况返回相应的异常信息。

示例

命令示例：

TVS.HDEL index_name0 keyc VECTOR

返回示例：

 (integer) 1

类别

说明

语法

TVS.SCAN index_name cursor [MATCH pattern] [COUNT count] [FILTER filter_string] [VECTOR vector] [MAX_DIST max_distance]

时间复杂度

O(N)，N为该向量索引中Key的数量。

命令描述

在指定向量索引中，扫描符合条件的数据记录（key）。

选项

• index_name：向量索引名称。

• cursor：指定本次扫描的游标，从0开始。

• pattern：模式匹配。

• count：指定本次扫描的数量，默认为10，但无法保证每次迭代都返回精准的元素数量。

• filter_string：过滤条件。

  • 支持+-*/<>!=()&&||等操作符，暂不支持比较字符串之间的大小。如需输入字符串，请输入转义字符（\），例如create_time > 1663637425 && location == \"Hangzhou\"。

  • 操作符两侧必须用空格隔开，例如"creation_time > 1735"。

  • 不支持flag == true类型的比较，即不支持true、false布尔类型，可以替换为flag == \"true\"，当成字符串传递即可。

• vector：查询向量，需要配合max_distance参数使用。

• max_distance：最大距离限制，必须配合vector参数使用。填写这两个参数后，返回结果与vector参数的距离将小于max_distance参数。

返回值

• 执行成功，返回一个数组：

  • 第一个元素：下次查询的游标，若已扫描完成，则返回0。

  • 第二个元素：本次查询的数据记录（key）名称。

• 其他情况返回相应的异常信息。

示例

命令示例：

TVS.SCAN index_name0 0

返回示例：

1) "0"
2) 1) "key0"
   2) "keyV"

类别

说明

语法

TVS.HINCRBY index_name key attribute_key num

时间复杂度

O(1)

命令描述

在指定向量索引中，将指定数据记录（key）的attribute_key的值增加num，num为一个整数。

若指定的attribute_key不存在则自动新建并赋予该值，若该记录已存在则更新并覆盖原值。

选项

• index_name：向量索引名称。

• key：该记录的主键标识。

• attribute_key：待操作的属性Key。

• num：需要为attribute_key的value增加的整数值。

返回值

• 执行成功：添加num后的值。

• 其他情况返回相应的异常信息。

示例

命令示例：

TVS.HINCRBY index_name0 key0 tv01 20 

返回示例：

(integer) 20

类别

说明

语法

TVS.HINCRBYFLOAT index_name key attribute_key num

时间复杂度

O(1)

命令描述

在指定向量索引中，将指定数据记录（key）的attribute_key的值增加num，num为一个浮点数。

若指定的attribute_key不存在则自动新建并赋予该值，若该记录已存在则更新并覆盖原值。

选项

• index_name：向量索引名称。

• key：该记录的主键标识。

• attribute_key：待操作的属性Key。

• num：需要为attribute_key的value增加的值，类型为Float。

返回值

• 执行成功：添加num后的值。

• 其他情况返回相应的异常信息。

示例

命令示例：

TVS.HINCRBYFLOAT index_name0 key0 tv02 9.34

返回示例：

"9.34"

类别

说明

语法

TVS.HPEXPIREAT index_name key milliseconds-timestamp

时间复杂度

O(1)

命令描述

在指定向量索引中，为指定数据记录（key）设置绝对过期时间，精确到毫秒。

选项

• index_name：向量索引名称。

• key：该记录的主键标识。

• milliseconds-timestamp：精确到毫秒的UNIX时间戳 （Unix timestamp）。若该时间早于当前时间，则该key会立即过期。

返回值

• key存在且设置成功：1。

• key不存在：0。

• 其他情况返回相应的异常信息。

示例

命令示例：

TVS.HPEXPIREAT index_name0 key1 16914619090000

返回示例：

(integer) 1

类别

说明

语法

TVS.HPEXPIRE index_name key milliseconds-timestamp

时间复杂度

O(1)

命令描述

在指定向量索引中，为指定数据记录（key）设置相对过期时间，精确到毫秒。

选项

• index_name：向量索引名称。

• key：该记录的主键标识。

• milliseconds-timestamp：相对过期时间，单位为毫秒。

返回值

• key存在且设置成功：1。

• key不存在：0。

• 其他情况返回相应的异常信息。

示例

命令示例：

TVS.HPEXPIRE index_name0 key1 1000

返回示例：

(integer) 1

类别

说明

语法

TVS.HEXPIREAT index_name key timestamp

时间复杂度

O(1)

命令描述

在指定向量索引中，为指定数据记录（key）设置绝对过期时间，精确到秒。

选项

• index_name：向量索引名称。

• key：该记录的主键标识。

• timestamp：精确到秒的UNIX时间戳 （Unix timestamp）。若该时间早于当前时间，则该key会立即过期。

返回值

• key存在且设置成功：1。

• key不存在：0。

• 其他情况返回相应的异常信息。

示例

命令示例：

TVS.HPEXPIREAT index_name0 key2 1691466981

返回示例：

(integer) 1

类别

说明

语法

TVS.HEXPIRE index_name key timestamp

时间复杂度

O(1)

命令描述

在指定向量索引中，为指定数据记录（key）设置相对过期时间，精确到秒。

选项

• index_name：向量索引名称。

• key：该记录的主键标识。

• timestamp：相对过期时间，单位为秒。

返回值

• key存在且设置成功：1。

• key不存在：0。

• 其他情况返回相应的异常信息。

示例

命令示例：

TVS.HPEXPIREAT index_name0 key2 100

返回示例：

(integer) 1

类别

说明

语法

TVS.HPTTL index_name key

时间复杂度

O(1)

命令描述

在指定向量索引中，查看指定数据记录（key）的剩余过期时间，精确到毫秒。

选项

• index_name：向量索引名称。

• key：该记录的主键标识。

返回值

• key存在且设置了过期时间：剩余过期时间，单位为毫秒。

• key存在但未设置过期时间：-1。

• key或index_name不存在：-2。

• 其他情况返回相应的异常信息。

示例

命令示例：

TVS.HPTTL index_name0 key2

返回示例：

(integer) 65417

类别

说明

语法

TVS.HTTL index_name key

时间复杂度

O(1)

命令描述

在指定向量索引中，查看指定数据记录（key）的剩余过期时间，精确到秒。

选项

• index_name：向量索引名称。

• key：该记录的主键标识。

返回值

• key存在且设置了过期时间：剩余过期时间，单位为秒。

• key存在但未设置过期时间：-1。

• key或index_name不存在：-2。

• 其他情况返回相应的异常信息。

示例

命令示例：

TVS.HTTL index_name0 key2

返回示例：

(integer) 58

类别

说明

语法

TVS.HPEXPIRETIME index_name key

时间复杂度

O(1)

命令描述

在指定向量索引中，查看指定数据记录（key）的绝对过期时间，精确到毫秒。

选项

• index_name：向量索引名称。

• key：该记录的主键标识。

返回值

• key存在且设置了过期时间：绝对过期时间（Unix timestamp），单位为毫秒。

• key存在但未设置过期时间：-1。

• key或index_name不存在：-2。

• 其他情况返回相应的异常信息。

示例

命令示例：

TVS.HPEXPIRETIME index_name0 key2

返回示例：

(integer) 1691473985764

类别

说明

语法

TVS.HEXPIRETIME index_name key

时间复杂度

O(1)

命令描述

在指定向量索引中，查看指定数据记录（key）的绝对过期时间，精确到秒。

选项

• index_name：向量索引名称。

• key：该记录的主键标识。

返回值

• key存在且设置了过期时间：绝对过期时间（Unix timestamp），单位为秒。

• key存在但未设置过期时间：-1。

• key或index_name不存在：-2。

• 其他情况返回相应的异常信息。

示例

命令示例：

TVS.HEXPIRETIME index_name0 key2

返回示例：

(integer) 1691473985

类别

说明

语法

TVS.KNNSEARCH index_name topN vector [filter_string] [param_key param_value]

时间复杂度

• HNSW算法：O(log(N))

• FLAT算法：O(N)

N为该向量索引中Key的数量。

命令描述

在指定向量索引中，对指定的向量（VECTOR）进行近邻查询，最多可返回topN条。

选项

• index_name：向量索引名称。

• topN：查询返回的数量，取值范围为[1,10000]。

• vector：执行近邻查询的向量值。若您仅希望执行全文检索（索引为混合索引），可在该字段传入""。

• filter_string：过滤条件。

  • 支持+-*/<>!=()&&||等操作符，暂不支持比较字符串之间的大小。如需输入字符串，请输入转义字符（\），例如"create_time > 1663637425 && location == \"Hangzhou\""。

  • 操作符两侧必须用空格隔开，例如"creation_time > 1735"。

  • 不支持flag == true类型的比较，即不支持true、false布尔类型，可以替换为flag == \"true\"，当成字符串传递即可。

• param_key和param_value：查询的运行参数，取值如下。

  • ef_search：查询索引的时候，动态列表的长度，默认为100，取值范围为[1,1000]，该值越大则查询精度越高，同时性能开销越大。该参数为HNSW算法的特定参数。

    sparse_ef_search：在创建混合索引时，如果稀疏向量使用了HNSW索引，则请使用sparse_ef_search参数为稀疏向量HNSW索引的ef_search参数。

  • MAX_DIST：最大距离限制，Float类型，若某Key与待查询向量的距离大于该值，则会过滤，不会返回。

  • TEXT：执行查询的文本（混合检索），可传入文本类型或向量类型，若不传入该字段或在该字段传入""，表示不进行全文检索，仅执行向量检索。

  • hybrid_ratio：本次查询时向量检索的权重，默认为TVS.CREATEINDEX设置的hybrid_ratio值，取值范围为[0,1]，Float类型，全量检索的权重为1-hybrid_ratio。

  • 默认情况下，系统使用先执行KNN向量检索、再执行标量检索的后置过滤（PostFilter）策略。

    • vector_filter_count：向量检索过滤的最大数量，默认为10000。

      在PostFilter策略中，当向量检索结果过滤超过vector_filter_count条记录，但仍未到达足够返回的数据量时，系统会终止向量检索遍历。

    • fulltext_filter_count：全文检索过滤的最大数量，默认为10000。

      在PostFilter策略中，当全文检索结果过滤超过fulltext_filter_count条记录，但仍未到达足够返回的数据量时，系统会终止全文检索遍历。

    • 若您希望系统先执行倒排索引的标量检索，再执行KNN向量检索的前置过滤（PreFilter）策略，您可以在查询中增加search_policy scala参数。

      同时提供ivf_filter_count参数，即倒排索引过滤的最大数量，默认为10000。在PreFilter策略中，当倒排索引过滤的结果超过ivf_filter_count条记录时，系统会自动退化为PostFilter策略。

    说明

    在绝大多数情况下，上述默认参数可以在确保准确性的前提下保证系统的延迟。您可以在特定请求中调整上述参数，但上述参数越大，请求延迟也可能越大。

返回值

• 执行成功：按距离近到远的顺序返回近邻的key及与该目标向量的距离。

• 若指定的向量索引不存在，返回(empty array)。

• 其他情况返回相应的异常信息。

示例

TVS.CREATEINDEX my_index_k 2 HNSW L2 inverted_index_productname string
TVS.HSET my_index_k key0 VECTOR [1,2] creation_time 1730 productname "Aliyun"
TVS.HSET my_index_k key1 VECTOR [3,4] creation_time 1740 productname "other"
TVS.HSET my_index_k key2 VECTOR [5,6] creation_time 1750 productname "Aliyun"

命令示例1：

TVS.KNNSEARCH my_index_k 2 [3,3.1] "creation_time > 1735"

返回示例1：

1) "key1"
2) "0.81000018119812012"
3) "key2"
4) "12.410000801086426"

命令示例2：

TVS.KNNSEARCH my_index_k 2 [3,3.1]  "creation_time > 1735 && productname ==  \"Aliyun\"" search_policy scala ivf_filter_count 15000

返回示例2：

1) "key2"
2) "12.410000801086426"

类别

说明

语法

TVS.KNNSEARCHFIELD index_name topN vector field_count field_name [field_name ...] [filter_string] [param_key param_value]

时间复杂度

• HNSW算法：O(log(N))

• FLAT算法：O(N)

N为该向量索引中Key的数量。

命令描述

在指定向量索引中，对指定的向量（VECTOR）进行近邻查询，检索逻辑与TVS.KNNSEARCH相同，额外支持返回标签属性。

选项

• index_name：向量索引名称。

• topN：查询返回的数量，取值范围为[1,10000]。

• vector：执行近邻查询的向量值。若您仅希望执行全文检索（索引为混合索引），可在该字段传入""。

• field_count：返回结果中标签属性的数量，若希望返回所有标签，可以设置field_count为0。

• field_name：标签名称，数量需要与field_count保持一致。

• filter_string：过滤条件，更多信息请参见TVS.KNNSEARCH中的说明。

• param_key和param_value：查询的运行参数，更多信息请参见TVS.KNNSEARCH中的说明。

返回值

• 执行成功：按距离近到远的顺序返回近邻的key及与该目标向量的距离，以及对应的标签属性键值对。

• 若指定的向量索引不存在，返回(empty array)。

• 其他情况返回相应的异常信息。

示例

TVS.CREATEINDEX my_index_k 2 HNSW L2
TVS.HSET my_index_k key0 VECTOR [1,2] creation_time 1730
TVS.HSET my_index_k key1 VECTOR [3,4] creation_time 1740
TVS.HSET my_index_k key2 VECTOR [5,6] creation_time 1750

命令示例：

TVS.KNNSEARCHFIELD my_index_k 2 [3,3.1] 0 "creation_time > 1735"

返回示例：

1) 1) "key1"
   2) "0.81000018119812012"
   3) "VECTOR"
   4) "[3,4]"
   5) "creation_time"
   6) "1740"
2) 1) "key2"
   2) "12.410000801086426"
   3) "VECTOR"
   4) "[5,6]"
   5) "creation_time"
   6) "1750"

类别

说明

语法

TVS.GETDISTANCE index_name vector key_count key [key, ...] [TOPN topN] [FILTER filter_string] [MAX_DIST max_distance]

时间复杂度

• HNSW算法：O(log(N))

• FLAT算法：O(N)

N为该向量索引中Key的数量。

命令描述

在指定向量索引中，针对指定Key列表，进行向量（VECTOR）近邻查询。

选项

• index_name：向量索引名称。

• vector：执行近邻查询的向量值。

• key_count：候选Key的数量。

• key：Key名称，Key的数量需要与key_count一致。

• TOPN：查询返回的数量，默认为key_count，取值范围为[1,key_count]。

• FILTER：过滤条件。

  • 支持+-*/<>!=()&&||等操作符，暂不支持比较字符串之间的大小。如需输入字符串，请输入转义字符（\），例如create_time > 1663637425 && location == \"Hangzhou\"。

  • 操作符两侧必须用空格隔开，例如"creation_time > 1735"。

  • 不支持flag == true类型的比较，即不支持true、false布尔类型，可以替换为flag == \"true\"，当成字符串传递即可。

• MAX_DIST：最大距离限制，若某Key与待查询向量的距离大于该值，则会过滤，不会返回。

返回值

• 执行成功：默认按Key的顺序返回对应距离，若指定了TOPN，则按距离近到远的顺序返回近邻Key与对应距离。

• 若指定的向量索引不存在，返回(empty array)。

• 其他情况返回相应的异常信息。

示例

TVS.CREATEINDEX my_index_k 2 HNSW L2
TVS.HSET my_index_k key0 VECTOR [1,2] creation_time 1730
TVS.HSET my_index_k key1 VECTOR [3,4] creation_time 1740
TVS.HSET my_index_k key2 VECTOR [5,6] creation_time 1750

命令示例：

TVS.GETDISTANCE my_index_k [1,1] 2 key1 key2

返回示例：

1) "key1"
2) "13"
3) "key2"
4) "41"

类别

说明

语法

TVS.MKNNSEARCH index_name topN vector_count vector [vector ...] [filter_string] [param_key param_value]

时间复杂度

• HNSW算法：vector_count * O(log(N))

• FLAT算法：vector_count * O(N)

N为该向量索引中Key的数量。

命令描述

在指定向量索引中，批量对多条向量（VECTOR）进行近邻查询。

选项

• index_name：向量索引名称。

• topN：每条向量查询返回的数量，取值范围为[1,10000]。

• vector_count ：查询的向量数。

• vector：执行近邻查询的向量值。若您仅希望执行全文检索（索引为混合索引），可在该字段传入""。

• filter_string：过滤条件，更多信息请参见TVS.KNNSEARCH中的说明。

• param_key和param_value：查询的运行参数，更多信息请参见TVS.KNNSEARCH中的说明。

返回值

• 执行成功：按向量查询顺序返回多个查询结果数组，每个数组中按距离近到远的顺序返回近邻的key及与该目标向量的距离。

• 若指定的向量索引不存在，返回(empty array)。

• 其他情况返回相应的异常信息。

示例

TVS.CREATEINDEX my_index_m 2 HNSW L2
TVS.HSET my_index_m key0 VECTOR [1,2] creation_time 1730
TVS.HSET my_index_m key1 VECTOR [3,4] creation_time 1740
TVS.HSET my_index_m key2 VECTOR [5,6] creation_time 1750

命令示例：

TVS.MKNNSEARCH my_index_m 2 2 [3,4] [5,6] "creation_time > 1735"

返回示例：

1) 1) "key1"
   2) "0"
   3) "key2"
   4) "8"
2) 1) "key2"
   2) "0"
   3) "key1"
   4) "8"

类别

说明

语法

TVS.MINDEXKNNSEARCH index_count index_name [index_name ...] topN vector [filter_string] [param_key param_value]

时间复杂度

• HNSW算法：index_count * O(log(N))

• FLAT算法：index_count * O(N)

N为该向量索引中Key的数量。

命令描述

在多个向量索引中，对指定的向量（VECTOR）进行近邻查询。

选项

• index_count：向量索引的数量。

• index_name：向量索引名称。

• topN：查询返回的数量，取值范围为[1,10000]，默认会查询出每个向量索引的topN个结果，并将所有查询结果进行聚合，返回距离最近的topN个结果。

• vector：执行近邻查询的向量值。

• filter_string：过滤条件，更多信息请参见TVS.KNNSEARCH中的说明。

• param_key和param_value：查询的运行参数，更多信息请参见TVS.KNNSEARCH中的说明。

返回值

• 执行成功：按距离近到远的顺序返回近邻的key及与该目标向量的距离。

• 若指定的向量索引不存在，返回(empty array)。

• 其他情况返回相应的异常信息。

示例

TVS.CREATEINDEX my_index_mk 2 HNSW L2
TVS.HSET my_index_mk key0 VECTOR [1,2] creation_time 1730
TVS.HSET my_index_mk key1 VECTOR [3,4] creation_time 1740
TVS.HSET my_index_mk key2 VECTOR [5,6] creation_time 1750
TVS.CREATEINDEX my_index_mx 2 HNSW L2
TVS.HSET my_index_mx key5 VECTOR [8,7] creation_time 1730
TVS.HSET my_index_mx key6 VECTOR [6,5] creation_time 1740
TVS.HSET my_index_mx key7 VECTOR [4,3] creation_time 1750

命令示例：

TVS.MINDEXKNNSEARCH 2 my_index_mk my_index_mx 2 [0,0]

返回示例：

1) "key0"
2) "5"
3) "key7"
4) "25"

类别

说明

语法

TVS.MINDEXKNNSEARCHFIELD index_count index_name [index_name ...] topN vector field_count field_name [field_name ...] [filter_string] [param_key param_value]

时间复杂度

• HNSW算法：index_count * O(log(N))

• FLAT算法：index_count * O(N)

N为该向量索引中Key的数量。

命令描述

在多个向量索引中，对指定的向量（VECTOR）进行近邻查询，支持返回标签属性。

选项

• index_count：向量索引的数量。

• index_name：向量索引名称。

• topN：查询返回的数量，取值范围为[1,10000]，默认会查询出每个向量索引的topN个结果，并将所有查询结果进行聚合，返回距离最近的topN个结果。

• vector：执行近邻查询的向量值。

• field_count：返回结果中标签属性的数量，若希望返回所有标签，可以设置field_count为0。

• field_name：标签名称，数量需要与field_count保持一致。

• filter_string：过滤条件，更多信息请参见TVS.KNNSEARCH中的说明。

• param_key和param_value：查询的运行参数，更多信息请参见TVS.KNNSEARCH中的说明。

返回值

• 执行成功：按距离近到远的顺序返回近邻的key及与该目标向量的距离，以及对应的标签属性键值对。

• 若指定的向量索引不存在，返回(empty array)。

• 其他情况返回相应的异常信息。

示例

TVS.CREATEINDEX my_index_mk 2 HNSW L2
TVS.HSET my_index_mk key0 VECTOR [1,2] creation_time 1730
TVS.HSET my_index_mk key1 VECTOR [3,4] creation_time 1740
TVS.HSET my_index_mk key2 VECTOR [5,6] creation_time 1750
TVS.CREATEINDEX my_index_mx 2 HNSW L2
TVS.HSET my_index_mx key5 VECTOR [8,7] creation_time 1730
TVS.HSET my_index_mx key6 VECTOR [6,5] creation_time 1740
TVS.HSET my_index_mx key7 VECTOR [4,3] creation_time 1750

命令示例：

TVS.MINDEXKNNSEARCHFIELD 2 my_index_mk my_index_mx 2 [0,0] 0

返回示例：

1) 1) "key0"
   2) "5"
   3) "my_index_mk"
   4) "VECTOR"
   5) "[1,2]"
   6) "creation_time"
   7) "1730"
2) 1) "key1"
   2) "25"
   3) "my_index_mk"
   4) "VECTOR"
   5) "[3,4]"
   6) "creation_time"
   7) "1740"

类别

说明

语法

TVS.MINDEXMKNNSEARCH index_count index_name [index_name ...] topN vector_count vector [vector ...] [filter_string] [param_key param_value]

时间复杂度

• HNSW算法：index_count * vector_count * O(log(N))

• FLAT算法：index_count * vector_count * O(N)

N为该向量索引中Key的数量。

命令描述

在多个向量索引中，批量对多条向量（VECTOR）进行近邻查询。

选项

• index_count：向量索引的数量。

• index_name：向量索引名称。

• topN：每条向量查询返回的数量，取值范围为[1,10000]，默认会查询出每个向量索引的topN个结果，并将所有查询结果进行聚合，返回距离最近的topN个结果。

• vector_count ：查询的向量数。

• vector：执行近邻查询的向量值。

• filter_string：过滤条件，更多信息请参见TVS.KNNSEARCH中的说明。

• param_key和param_value：查询的运行参数，更多信息请参见TVS.KNNSEARCH中的说明。

返回值

• 执行成功：按向量查询顺序返回多个查询结果数组，每个数组中按距离近到远的顺序返回近邻的key及与该目标向量的距离。

• 若指定的向量索引不存在，返回(empty array)。

• 其他情况返回相应的异常信息。

示例

TVS.CREATEINDEX my_index_mk 2 HNSW L2
TVS.HSET my_index_mk key0 VECTOR [1,2] creation_time 1730
TVS.HSET my_index_mk key1 VECTOR [3,4] creation_time 1740
TVS.HSET my_index_mk key2 VECTOR [5,6] creation_time 1750
TVS.CREATEINDEX my_index_mx 2 HNSW L2
TVS.HSET my_index_mx key5 VECTOR [8,7] creation_time 1730
TVS.HSET my_index_mx key6 VECTOR [6,5] creation_time 1740
TVS.HSET my_index_mx key7 VECTOR [4,3] creation_time 1750

命令示例：

TVS.MINDEXMKNNSEARCH 2 my_index_mk my_index_mx 2 2 [0,0] [3,3]

返回示例：

1) 1) "key0"
   2) "5"
   3) "key7"
   4) "25"
2) 1) "key1"
   2) "1"
   3) "key7"
   4) "1"