SearchHighlighting

Classic環境で利用できます。

検索結果の構文強調設定情報です。

構文

構文は次の通りです。

private String enable;
private String pre_tag;
private String post_tag;
private Object option;

フィールド

フィールドの詳細は次の通りです。

フィールド	タイプ	必須の有無	説明
`enable`	String, Boolean	Optional	ハイライト表示するかどうかを設定 `true`(デフォルト) \| `false`
`pre_tag`	String	Optional	マッチする構文の開始タグ HTMLタグ形式 `<b>`(デフォルト)
`post_tag`	String	Optional	マッチする構文の終了タグ HTMLタグ形式 `<b>`(デフォルト)
`option`	Object	Optional	構文強調設定を指定する Map形式の Object key: 構文強調オプション <例> 重複削除: "remove_duplicate" value: このオプションの使用有無 `true` \| `false` keyオプションの種類 `remove_html_tag`: このオプションが有効な場合、HTMLタグを削除 `skip_html_tag`: このオプションが有効な場合、HTMLタグをハイライト表示するか、タグに含まれている文字を変更せずに維持 `braket_as_tag`: このオプションが有効な場合、<と > の間はすべて HTMLタグとみなす `num_entity_as_char`: このオプションが有効な場合、値などの数値型エンティティを文字と同じように扱う。ハイライト表示も当該エンティティを文字として扱って実行 `skip_char_entity`: このオプションが有効な場合、文字型エンティティをハイライト表示したり、含まれている文字を変更せずに維持 `kata_to_hira`: このオプションが有効な場合、対応する日本語のカタカナ文字とひらがな文字を同じ文字として扱う `bold_sub_query`: このオプションが有効な場合、クエリと完全に一致する文字列を見つけても、部分的なキーワードをすべてハイライト表示 `bold_sub_english`: このオプションが有効な場合、英語の単語の一部がキーワードと一致する場合にもハイライト表示。例: キーワードが「a」の場合、「about」の先頭文字の「a」をハイライト表示 `bold_sub_digit`: このオプションが有効な場合、数字の一部がキーワードと一致する場合にもハイライト表示。例: キーワードが「1」の場合、「12345」の先頭数字の「1」をハイライト表示 `bold_sub_hanja`: このオプションが有効な場合、漢字のハイライト表示を制限しない

例

検索リクエストのサンプルコードは次の通りです。

{
  "search": {
    "product": {
      "main": {
        "query": "キーボード"
      }
    }
  },
  "highlighting": {
    "enable": true,
    "pre_tag": "<b>",
    "post_tag": "</b>",
    "remove_html_tag": true,
    "skip_char_entity": true,
    "kata_to_hira": false,
    "bold_sub_query": false,
    "bold_sub_english": true,
    "bold_sub_digit": true,
    "bold_sub_hanja": false
  }
}