---
title: "SearchHighlighting"
slug: "common-apidatatype-cssearchhighlighting"
updated: 2026-07-23T09:04:15Z
published: 2026-07-23T09:04:15Z
canonical: "api.ncloud-docs.com/common-apidatatype-cssearchhighlighting"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SearchHighlighting

Classic/VPC 환경에서 이용 가능합니다.

검색 결과 구문 강조 설정 정보입니다.

## 구문

구문은 다음과 같습니다.

```
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
  }
}
```