FT.CREATE

FT.CREATE 會建立可搜尋的索引。

語法

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 (選用)：TAG 搜尋的標記欄位。

  • SEPARATOR (選用)：用於將代碼字串分割為個別代碼的字元。預設選項為 ,。指定的值必須是單一字元。舉例來說，標記字串「hello, world」會解讀為「hello」和「world」，並據此建立索引。有效值為 ,.<>{}[]"':;!@#$%^&*()-+=~

  • CASESENSITIVE (選用)：表示代碼欄位是否區分大小寫。根據預設，代碼不區分大小寫。標記字串「HeLLo」會被編入索引為「hello」，因此查詢「Hello」和「HeLlo」會產生相同的結果。

附註

• 在 FT.CREATE 指令中，向量、數值和代碼索引可按任意順序顯示。

• 一個欄位只能編入索引一次。在提供的範例中，欄位 my_vector_field_key 不得在同一個索引中重複。

• 在單一 FT.CREATE 指令中，最多可為 10 個欄位建立索引。

• 根據預設，TAG 不區分大小寫。

• 根據預設，TAG 會以 , 分隔。

• 系統不支援標記和數字查詢的個別查詢。這些欄位只能與向量搜尋搭配使用。

範例

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