Tablestore:まとめとハイライト

前提条件

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

機能の説明

まとめとハイライト機能は、クエリに一致した term の周辺のテキストフラグメントを抽出し、一致した term を pre-tag と post-tag で囲みます。このフラグメントを使用して、クエリの一致のコンテキストを表示できます。この機能は Text フィールドのみをサポートします。

まとめとハイライト機能を使用する前に、多次元インデックスを作成する際に、フィールドの enableHighlighting を true に設定する必要があります。クエリでは、SearchQuery.highlight を使用して、フラグメントを返したいフィールドとフラグメントの設定を指定します。フィールドは、まとめとハイライト機能をサポートするクエリ条件で使用される必要があります。そうでない場合、そのフィールドに対してハイライトされたフラグメントは返されません。

次のクエリタイプは、まとめとハイライトの結果を返すことができます：TermQuery、TermsQuery、MatchQuery、MatchPhraseQuery、PrefixQuery、WildcardQuery、RangeQuery、BoolQuery、ConstScoreQuery、NestedQuery。

BoolQuery または ConstScoreQuery の場合、前述の 7 つのクエリタイプの子クエリで使用されるフィールドに対して、まとめとハイライトを設定できます。NestedQuery の場合、InnerHits.highlight を設定して、一致した子行のまとめとハイライトの結果を返します。詳細については、「ネスト化クエリ」をご参照ください。

次の例では、一致検索を使用して、description フィールドに tablestore という term が含まれる行を取得します。この例では、返されたフラグメント内で一致した term を <b> と </b> で囲みます。description フィールドは、まとめとハイライトが有効になっている Text フィールドです。

String tableName = "example_table";
String indexName = "example_index";

MatchQuery matchQuery = new MatchQuery();
matchQuery.setFieldName("description");
matchQuery.setText("tablestore");

HighlightParameter highlightParameter = new HighlightParameter();
highlightParameter.setPreTag("");
highlightParameter.setPostTag("");

Highlight highlight = new Highlight();
highlight.addFieldHighlightParam("description", highlightParameter);

SearchQuery searchQuery = new SearchQuery();
searchQuery.setQuery(matchQuery);
searchQuery.setHighlight(highlight);
searchQuery.setLimit(10);

SearchRequest request = new SearchRequest(tableName, indexName, searchQuery);
SearchResponse response = client.search(request);
for (SearchHit hit : response.getSearchHits()) {
    HighlightResultItem resultItem = hit.getHighlightResultItem();
    if (resultItem == null) {
        continue;
    }
    HighlightField field = resultItem.getHighlightFieldByName("description");
    if (field != null) {
        System.out.println(field.getFragments());
    }
}

パラメーター

request.searchQuery.highlight は Highlight 型です。fieldHighlightParams の値は、個々のフィールドのフラグメントの動作を設定する HighlightParameter オブジェクトです。

次の表では、完全なパラメーターパスを使用して、Highlight と HighlightParameter の 2 つの設定レベルについて説明します。

応答