FT.CREATE

FT.CREATE 创建可搜索的索引。使用 Memorystore for Redis Cluster 时，索引是在集群级别创建的。在任何节点上创建索引都会导致在集群中的所有节点上创建索引。

语法

FT.CREATE index
  ON HASH
  [PREFIX count prefix [prefix ...]]
  SCHEMA field_name [AS alias] VECTOR [HNSW|FLAT] attribute_count [attribute_name attribute_value]
  [field_name [AS alias] NUMERIC]
  [field_name [AS alias] TAG [SEPARATOR ...] [CASESENSITIVE]]

  • index（必需）：这是您为索引指定的名称。如果已存在同名索引，则返回错误。

  • ON HASH（可选）：表示 HASH 数据类型。仅支持 HASH 数据类型。

  • PREFIX [count] [prefix]（可选）：用于指明要为哪些哈希键编制索引。

  • SCHEMA hash_field_name（必需）：SCHEMA 之后的 hash_field_name 用于标识哈希中的字段名称。[AS alias] ����称 alias 分配为字段名称属性的别名。

字段类型

  • VECTOR（必需）：用于向量搜索的向量字段：

    • [HNSW|FLAT]（必需）：指定算法。FLAT（暴力搜索）或 HNSW（分层可导航小世界）。

    • attribute_count（必需）：算法配置中传递的名称和值的总属性数。

    • attribute_name attribute_value：用于定义索引配置的键值对，但仅适用于两种可用算法之一。

      • HNSW 算法所需的属性：

        • DIM（必需）：向量维度数。接受的值包括 1-32768。

        • TYPE（必需）：向量类型。仅支持 FLOAT32。

        • DISTANCE_METRIC（必需）：必须是以下值之一：L2、IP 或 COSINE。

      • 可选的 HNSW 算法属性：

        • EF_RUNTIME（可选）：设置在查询操作期间要检查的向量数量。默认值为 10，最大值为 4096。您可以为运行的每个查询设置此参数值。值越大，查询时间越长，但查询召回率越高。

        • M（可选）：图中每层中每个节点允许的出边数量上限。第 0 层的出边数量上限为 2M。默认值为 16。最大值为 512。

        • EF_CONSTRUCTION（可选）：设置在索引构建期间要检查的向量数量。默认值为 200，最大值为 4096。值越大，创建索引所需的时间越长，但召回率越高。

        • INITIAL_CAP（可选）：确定索引的初始向量容量。默认值为 1024。 此参数用于确定索引内存分配。

      • 必需的 FLAT 算法属性：

        • DIM（必需）：向量维度数。

        • TYPE（必需）：向量类型。仅支持 FLOAT32。

        • DISTANCE_METRIC（必需）：必须是以下值之一：L2、IP 或 COSINE。

      • 可选的 FLAT 算法属性：

        • INITIAL_CAP（可选）：确定索引的初始向量容量。此参数用于确定索引内存分配。

  • NUMERIC（可选）- 用于数值搜索的数值字段。

  • TAG（可选）- 用于基于标记进行搜索的标记字段。

    • SEPARATOR（可选）：用于将标记字符串划分为各个标记的字符。默认选项为 ,。指定��值必须是单个字符。例如，标记字符串“hello, world”将被解读为“hello”和“world”，并相应地编入索引。允许的值为 ,.<>{}[]"':;!@#$%^&*()-+=~

    • CASESENSITIVE（可选）：表示标记字段是否区分大小写。默认情况下，标记不区分大小写。标记字符串“HeLLo”将编入索引为“hello”，而对“Hello”和“HeLlo”的查询将产生相同的结果。

备注

  • 在 FT.CREATE 命令中，VECTOR、NUMERIC 和 TAG 索引可以按任意顺序显示。

  • 一个字段只能编入一次索引。在提供的示例中，字段 my_vector_field_key 不能在同一索引中重复。

  • 在单个 FT.CREATE 命令中，最多可为 10 个字段编制索引。

  • 默认情况下，标记不区分大小写。

  • 默认情况下，标记以 , 分隔。

  • 不支持对标记和数字查询进行单独查询。这些字段只能与基于向量的搜索一起使用。

示例

HNSW 示例：

FT.CREATE my_index_name SCHEMA my_hash_field_key VECTOR HNSW 10 TYPE FLOAT32 DIM 20 DISTANCE_METRIC COSINE M 4 EF_CONSTRUCTION 100

FLAT 示例：

FT.CREATE my_index_name SCHEMA my_hash_field_key VECTOR Flat 8 TYPE FLOAT32 DIM 20 DISTANCE_METRIC COSINE INITIAL_CAP 15000

包含数字字段的 HNSW 示例：

FT.CREATE my_index_name SCHEMA my_vector_field_key VECTOR HNSW 10 TYPE FLOAT32 DIM 20 DISTANCE_METRIC COSINE M 4 EF_CONSTRUCTION 100 my_numeric_field_key NUMERIC

包含标记字段的 HNSW 示例：

FT.CREATE my_index_name SCHEMA my_vector_field_key VECTOR HNSW 10 TYPE FLOAT32 DIM 20 DISTANCE_METRIC COSINE M 4 EF_CONSTRUCTION 100 my_tag_field_key TAG SEPARATOR '@' CASESENSITIVE

包含标记和数字字段的 HNSW 示例：

FT.CREATE my_index_name SCHEMA my_vector_field_key VECTOR HNSW 10 TYPE FLOAT32 DIM 20 DISTANCE_METRIC COSINE M 4 EF_CONSTRUCTION 100 my_tag_field_key TAG SEPARATOR '@' CASESENSITIVE my_numeric_field_key NUMERIC

包含多个标记和数值字段的 HNSW 示例：

FT.CREATE my_index_name SCHEMA my_vector_field_key VECTOR HNSW 10 TYPE FLOAT32 DIM 20 DISTANCE_METRIC COSINE M 4 EF_CONSTRUCTION 100 my_tag_field_key_1 TAG SEPARATOR '@' CASESENSITIVE my_numeric_field_key_1 NUMERIC my_numeric_field_key_2 NUMERIC my_tag_field_key_2 TAG