match phrase クエリ - Tablestore SDK for Python - Tablestore - Alibaba Cloud ドキュメントセンター

前提条件

Tablestore SDK for Python をインストールし、クライアントを初期化します。

概要

match phrase クエリは、Text フィールド (「文字列型」をご参照ください) を検索し、指定された順序と位置に出現するトークンを探します。フィールド値とクエリテキストの両方が、検索インデックスに設定されたアナライザーによってトークン化されます。トークンの一致のみをチェックする match クエリとは異なり、match phrase クエリはトークンの順序と位置もチェックします。隣接するトークン間のギャップを許容するには、slop を使用します。

MatchPhraseQuery(field_name, text, weight=None, slop=None)

次の例では、description フィールドに tablestore と durable のトークンがこの順序で連続して含まれている行をクエリします。

query = MatchPhraseQuery("description", "tablestore durable")
response = client.search(
    "example_table",
    "example_index",
    SearchQuery(
        query,
        sort=Sort([ScoreSort()]),
        limit=10,
        get_total_count=True,
    ),
    ColumnsToGet(return_type=ColumnReturnType.ALL),
)
for hit in response.search_hits:
    print(hit.score, hit.row)

パラメーター

検索リクエスト

search メソッドには、次のパラメーターが含まれます。

名前	型	説明
table_name (必須)	`str`	データテーブルの名前。
index_name (必須)	`str`	検索インデックスの名前。
search_query (必須)	`SearchQuery`	クエリ条件と共通のクエリ設定。
columns_to_get (任意)	`ColumnsToGet`	返す列の設定。このパラメーターが指定されていない場合、プライマリキー列のみが返されます。
routing_keys (任意)	`list`	カスタムルーティングフィールドのプライマリキー値。カスタムルーティングが設定されていない場合、このパラメーターは不要です。
timeout_s (任意)	`int`	リクエストのタイムアウト (秒) 。このパラメーターが指定されていない場合、クライアントレベルのタイムアウトが使用されます。

クエリ設定

search_query は SearchQuery 型で、次のパラメーターが含まれます。

名前	型	説明
query (必須)	`Query`	クエリ条件。このパラメーターを `MatchPhraseQuery` に設定します。
sort (任意)	`Sort`	結果のソート順。詳細については、「結果のソートとページ分割」をご参照ください。
get_total_count (任意)	`bool`	一致する行の総数を返すかどうかを指定します。デフォルト値：`False`。このパラメーターを `True` に設定すると、クエリのオーバーヘッドが増加します。
next_token (任意)	`bytes`	ページネーショントークン。前のレスポンスの `next_token` を渡して次のページを取得します。
offset (任意)	`int`	クエリの開始オフセット。このパラメーターは、浅いページ分割に使用します。
limit (任意)	`int`	返す行の最大数。このパラメーターが `0` に設定されている場合、行は返されません。
aggs (任意)	`list[Agg]`	メトリック集計の設定。詳細については、「集計」をご参照ください。
group_bys (任意)	`list[BaseGroupBy]`	グループ化の設定。詳細については、「集計」をご参照ください。
collapse_field (任意)	`Collapse`	結果の折りたたみ設定。詳細については、「クエリ結果の折りたたみ」をご参照ください。
highlight (任意)	`Highlight`	`Text` フィールドのサマリーとハイライトの設定。詳細については、「サマリーとハイライト」をご参照ください。

match phrase 条件

search_query.query は MatchPhraseQuery 型で、次のパラメーターが含まれます。

名前	型	説明
field_name (必須)	`str`	クエリ対象の `Text` フィールドの名前。
text (必須)	`str`	クエリテキスト。フィールドのアナライザーによってトークン化され、トークンの順序と位置によって照合されます。
weight (任意)	`float`	クエリの重み。正の float である必要があります。デフォルト値：`1.0`。関連度スコアに影響しますが、マッチングには影響しません。
slop (任意)	`int`	隣接するクエリトークン間で許容される最大位置ギャップ。デフォルト値：`0`。この場合、トークンは連続している必要があります。

返す列

columns_to_get は ColumnsToGet 型で、次のパラメーターが含まれます。

名前	型	説明
column_names (任意)	`list[str]`	返す属性列の名前。このパラメーターは、`return_type` が `SPECIFIED` の場合にのみ指定します。
return_type (任意)	`ColumnReturnType`	返す列のモード。`NONE` (デフォルト) はプライマリキー列のみを返します。`SPECIFIED` は指定された属性列を返します。`ALL` はテーブル内のすべての属性列を返します。`ALL_FROM_INDEX` はインデックスに格納されているすべてのフィールドを返します。

レスポンス

search メソッドは SearchResponse を返します。次の表に、主要なフィールドを示します。

フィールド	型	説明
rows	`list[Row]`	クエリによって返された行。数は `limit` を超えません。
next_token	`bytes`	次のページのトークン。値が空の場合は、利用可能なデータがこれ以上ないことを示します。
total_count	`int`	一致する行の数。値は `get_total_count` に依存します。
is_all_succeed	`bool`	すべてのインデックスパーティションがクエリされたかどうかを示します。値が `False` の場合、部分的な結果が返されます。
agg_results	`list[AggResult]`	メトリック集計の結果。`aggs` が設定されていない場合、このフィールドは空になります。
group_by_results	`list[GroupByResult]`	グループ化の結果。`group_bys` が設定されていない場合、このフィールドは空になります。
search_hits	`list[SearchHit]`	検索ヒット。行、関連度スコア、ハイライトなどの拡張情報を含みます。

タプル互換レスポンス

Tablestore SDK for Python 5.2.0 以降、検索 API はタプルの代わりにレスポンスオブジェクトを返します。バージョン 5.1.0 以前では、タプルが直接返されます。バージョン 5.2.1 以降では、SearchResponse.v1_response() を呼び出すことで、以前のバージョンと互換性のあるタプルを取得できます。新しいコードでは、レスポンスフィールドが拡張された場合にアンパックエラーを避けるために、SearchResponse の属性に直接アクセスしてください。

(
    rows,
    next_token,
    total_count,
    is_all_succeed,
    agg_results,
    group_by_results,
    search_hits,
) = response.v1_response()