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

Tablestore:HighlightParameter

最終更新日:Feb 06, 2025

HighlightParameter は、ハイライトパラメーターを指定します。

データ構造

message HighlightParameter {
    optional string  field_name = 1;
    optional int32   number_of_fragments = 2;
    optional int32   fragment_size = 3;
    optional string  pre_tag = 4;
    optional string  post_tag = 5;
    optional HighlightFragmentOrder fragments_order = 6 [default=TEXT_SEQUENCE];
}

パラメーター

必須

field_name

string

はい

フィールドの名前。 多次元インデックスを作成するときに、フィールドに対してハイライト機能が有効になっていることを確認してください。

number_of_fragments

int32

いいえ

返される強調表示されたテキストフラグメントの最大数。 このパラメーターを 1 に設定することをお勧めします。

fragment_size

int32

いいえ

返される各テキストフラグメントの長さ。 デフォルト値:100。

pre_tag

string

いいえ

クエリ文字列の強調表示に使用する開始タグ。 例:<em><b>。 デフォルト値:<em>。 ビジネス要件に基づいてカスタム開始タグを指定できます。 pre_tag パラメーターは、次の文字セットをサポートしています:< > " ' /a-zA-Z、および 0-9

post_tag

string

いいえ

クエリ文字列の強調表示に使用する終了タグ。 例:</em></b>。 デフォルト値:</em>。 ビジネス要件に基づいてカスタム終了タグを指定できます。 post_tag パラメーターは、次の文字セットをサポートしています:< > " ' /a-zA-Z、および 0-9

fragments_order

HighlightFragmentOrder

いいえ

返される強調表示されたテキスト フラグメントの並べ替えルール。