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])

index（必須）: インデックスに付ける名前です。同じ名前のインデックスがすでに存在する場合は、エラーが返されます。
ON HASH（省略可）: HASH データ型を示します。HASH データ型のみがサポートされています。
PREFIX [count] [prefix]（省略可）: インデックスに登録するハッシュキーを示します。
SCHEMA hash_field_name（必須）: SCHEMA の後の hash_field_name がハッシュ内のフィールド名を識別します。[AS alias] VECTOR は、フィールド名属性のエイリアスとして名前 VECTOR を割り当てます。

項目の種類

VECTOR（必須）: ベクトル検索のベクトルフィールド:
- [HNSW|FLAT]（必須）: 指定されたアルゴリズム。FLAT（ブルートフォース）または HNSW（Hierarchical Navigable Small World）のいずれか。
- attribute_count（必須）: アルゴリズム構成で渡される名前と値の属性の合計数。
- attribute_name attribute_value: インデックス構成を定義する Key-Value ペア。ただし、このペアは使用可能な 2 つのアルゴリズムのいずれかに固有のものです。
  - 必須の 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（省略可）: インデックスの開始ベクトル容量を決定します。このパラメータにより、インデックスのメモリ割り当てが決定されます。

例

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