Tablestore:検索インデックスの作成

インデックス設定

index_meta は SearchIndexMeta 型で、次のパラメーターを使用できます。

インデックスフィールド

index_meta.fields[] の各要素は FieldSchema 型で、次のパラメーターを使用できます。

ベクトル設定

index_meta.fields[].vector_options は VectorOptions 型で、次のパラメーターを使用できます。

インデックス設定

index_meta.index_setting は IndexSetting 型で、次のパラメーターを使用できます。

プリソートの設定

index_meta.index_sort は Sort 型で、次のパラメーターを使用できます。

プライマリキーソート

index_meta.index_sort.sorters[] 内の PrimaryKeySort 型の要素は、主キーでデータをソートし、次のパラメーターを提供します。

フィールド値ソート

index_meta.index_sort.sorters[] の FieldSort タイプの要素は、フィールド値でデータをソートし、以下のパラメーターを提供します。

プリソートの設定

次の例では、created_at フィールドでインデックスデータを昇順に事前にソートします。

table_name = "example_table"
index_name = "example_index"

fields = [
    FieldSchema("category", FieldType.KEYWORD, index=True),
    FieldSchema(
        "created_at",
        FieldType.LONG,
        index=True,
        enable_sort_and_agg=True,
    ),
]
index_sort = Sort([FieldSort("created_at", SortOrder.ASC)])
index_meta = SearchIndexMeta(fields, index_sort=index_sort)

client.create_search_index(table_name, index_name, index_meta)

インデックス TTL の設定

次の例では、インデックスの TTL を 7 日に設定します。

table_name = "example_table"
index_name = "example_index"

fields = [
    FieldSchema("category", FieldType.KEYWORD, index=True),
    FieldSchema("price", FieldType.LONG, index=True),
]
index_meta = SearchIndexMeta(fields, time_to_live=7 * 24 * 60 * 60)

client.create_search_index(table_name, index_name, index_meta)

トークン化の設定

次の例では、テキストフィールド description の分割トークン化を設定し、区切り文字としてコンマ (,) を使用します。

table_name = "example_table"
index_name = "example_index"

fields = [
    FieldSchema("category", FieldType.KEYWORD, index=True),
    FieldSchema(
        "description",
        FieldType.TEXT,
        index=True,
        analyzer=AnalyzerType.SPLIT,
        analyzer_parameter=SplitAnalyzerParameter(","),
    ),
]
index_meta = SearchIndexMeta(fields)

client.create_search_index(table_name, index_name, index_meta)

ベクトルフィールドの作成

次の例では、embedding という名前の 4次元ベクトルフィールドを作成し、ドット積を使用してベクトル類似度を測定します。

table_name = "example_table"
index_name = "example_index"

fields = [
    FieldSchema("category", FieldType.KEYWORD, index=True),
    FieldSchema(
        "embedding",
        FieldType.VECTOR,
        index=True,
        vector_options=VectorOptions(
            data_type=VectorDataType.VD_FLOAT_32,
            dimension=4,
            metric_type=VectorMetricType.VM_DOT_PRODUCT,
        ),
    ),
]
index_meta = SearchIndexMeta(fields)

client.create_search_index(table_name, index_name, index_meta)

仮想カラムの作成

次の例では、キーワードフィールド category を Long 型の仮想列に、Long フィールド price を Keyword 型の仮想列にマッピングします。

table_name = "example_table"
index_name = "example_index"

fields = [
    FieldSchema("category", FieldType.KEYWORD, index=True),
    FieldSchema(
        "category_as_long",
        FieldType.LONG,
        index=True,
        is_virtual_field=True,
        source_fields=["category"],
    ),
    FieldSchema("price", FieldType.LONG, index=True),
    FieldSchema(
        "price_as_keyword",
        FieldType.KEYWORD,
        index=True,
        is_virtual_field=True,
        source_fields=["price"],
    ),
]
index_meta = SearchIndexMeta(fields)

client.create_search_index(table_name, index_name, index_meta)

ハイライトの有効化

次の例では、テキストフィールド description のハイライトを有効にします。

table_name = "example_table"
index_name = "example_index"

fields = [
    FieldSchema("category", FieldType.KEYWORD, index=True),
    FieldSchema("price", FieldType.LONG, index=True),
    FieldSchema(
        "description",
        FieldType.TEXT,
        index=True,
        enable_highlighting=True,
    ),
]
index_meta = SearchIndexMeta(fields)

client.create_search_index(table_name, index_name, index_meta)