すべてのプロダクト
Search
ドキュメントセンター

Tablestore:サマリーとハイライト

最終更新日:Oct 09, 2026

データをクエリする際に、ハイライトパラメーターを設定することで、検索クエリを含むテキストスニペットを返し、そのクエリをハイライト表示できます。サマリーとハイライト機能は、Text 型のフィールドでのみサポートされています。

前提条件

注意事項

  • クエリハイライト機能は、Tablestore Node.js SDK 5.5.0 以降で利用できます。互換性のある SDK バージョンを使用していることを確認してください。 Node.js SDK のリリース履歴の詳細については、「Node.js SDK リリース履歴」をご参照ください。

  • MatchQuery または MatchPhraseQuery でクエリハイライト機能を使用すると、検索クエリが複数の pre タグと post タグでハイライト表示されることがあります。

  • Text 型のフィールドで最大セマンティクス形態素解析が使用されている場合、MatchPhraseQuery ではクエリハイライト機能はサポートされません。

  • シャーディングによってソーステキスト内でクエリが分割された場合、検索クエリがハイライト表示されないことがあります。

パラメーター

パラメーター

説明

highlightEncoder

ハイライトされたフラグメントの元のコンテンツのエンコーディング方式。有効値:

  • PLAIN_MODE (デフォルト):元のコンテンツはエンコードされずに表示されます。

  • HTML_MODE:ハイライトされたフラグメントの元のコンテンツは HTML エスケープされます。 たとえば、< は &lt; に、> は &gt; に、" は &quot; に、' は &#x27; に、/ は &#x2F; にエスケープされます。 このフォーマットは、Web 表示に推奨されます。

fieldHighlightParams

フィールドのハイライトパラメーター。 このパラメーターは、SearchQuery 内のキーワードクエリに含まれるフィールドに対してのみ設定できます。

HighlightParameter

numberOfFragments

返すハイライトされたフラグメントの最大数。 1 に設定することを推奨します。

fragmentSize

各フラグメントの長さ。 デフォルト値:100。

重要

返されるフラグメントの長さは、この値と完全に一致しない場合があります。

preTag

検索クエリをハイライト表示するための pre タグ (<em> や <b> など) 。 デフォルト値は <em> です。 必要に応じて pre タグをカスタマイズできます。 preTag でサポートされている文字セットには、< > " ' /、a-z、A-Z、0-9 が含まれます。

postTag

検索クエリをハイライト表示するための post タグ (</em> や </b> など) 。 デフォルト値は </em> です。 必要に応じて post タグをカスタマイズできます。 postTag でサポートされている文字セットには、< > " ' /、a-z、A-Z、0-9 が含まれます。

highlightFragmentOrder

ハイライトされたフィールドで複数のフラグメントが返される場合のソートルール。

  • TEXT_SEQUENCE (デフォルト):フラグメントは、テキスト内での出現順にソートされます。

  • SCORE:フラグメントは、検索クエリヒットのスコアに基づいてソートされます。

例

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

client.search({
    tableName: "<TABLE_NAME>",
    indexName: "<SEARCH_INDEX_NAME>",
    searchQuery: {
        offset: 0,
        limit: 10, // データなしで行数のみを取得するには、limit を 0 に設定します。これにより行は返されません。
        query: { // クエリタイプを MatchQuery に設定します。
            queryType: TableStore.QueryType.MATCH_QUERY,
            query: {
                fieldName: "Col_Text", // 一致させる列を設定します。
                text: "hangzhou shanghai" // 一致させる値を設定します。
            }
        },
        highlight:{
            highlightEncoder:TableStore.HighlightEncoder.PLAIN_MODE,
            highlightParameters:[
                {
                    fieldName:"Col_Text",
                    preTag: "",
                    postTag: "",
                    highlightFragmentOrder: TableStore.HighlightFragmentOrder.TEXT_SEQUENCE,
                    fragmentSize: 20,
                    numberOfFragments: 3,
                }
                
            ],
        },
        getTotalCount: true // 結果の TotalCount は、テーブル内の総行数を示します。 デフォルト値は false で、総数は返されません。
    },
    columnToGet: { // 返す列。 有効値:RETURN_SPECIFIED (カスタム列を返す)、RETURN_ALL (すべての列を返す)、RETURN_ALL_FROM_INDEX (検索インデックスからすべての列を返す)、RETURN_NONE (列を返さない)。
        returnType: TableStore.ColumnReturnType.RETURN_ALL
    }
}, function (err, data) {
    if (err) {
        console.log('error:', err);
        return;
    }
    console.log('success:', JSON.stringify(data.rows, null, 2));
    printSearchHit(data.searchHits, "");
});


/**
 * searchHits の内容を出力します。
 * @param searchHits 検索ヒット。
 * @param prefix ネストされた構造の階層情報を出力するためのプレフィックス。
 */
function printSearchHit(searchHits, prefix) {
    TableStore.util.arrayEach(searchHits, function (searchHit) {
        if (searchHit.highlightResultItem != null) {
            console.log(prefix + "Highlight: \n");
            var strBuilder = ""
            for  (const [key,val]  of searchHit.highlightResultItem.highlightFields.entries()) {
                strBuilder += key + ":[";
                strBuilder += val.fragments.join(",") + "]\n";
                console.log(strBuilder);
            }
        }
        for  (const [key,val]  of searchHit.searchInnerHits.entries()) {
            console.log(prefix + "Path: " + key + "\n");
            console.log(prefix + "InnerHit: \n");
            printSearchHit(val.subSearchHits, prefix + "    ");
        }
    });
}

関連ドキュメント

  • クエリハイライト機能の詳細については、「サマリーとハイライト」をご参照ください。

  • ネストされたフィールドでクエリハイライト機能を使用する方法については、「ネストされたクエリ」をご参照ください。