---
title: "SearchQuery"
slug: "common-apidatatype-cssearchquery"
updated: 2026-04-23T08:55:23Z
published: 2026-04-23T09:02:10Z
canonical: "api.ncloud-docs.com/common-apidatatype-cssearchquery"
---

> ## 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.

# SearchQuery

<p class="platform-info type-classic-vpc">Classic/VPC 환경에서 이용 가능합니다.</p>

검색 질의 정보입니다.

## 구문 <a name="구문"></a>
구문은 다음과 같습니다.

```JAVA
private String query_method;
private String query;
private String stopword;
private String name;
private String type;
private String option;
private String ratio;
private String term_extractor;
```

## 필드 <a name="필드"></a>
필드에 대한 설명은 다음과 같습니다. 

| 필드            | 타입 | 필수 여부            | 설명                  |
|------------------------|-----------------|-----------------|-----------------------|
|     `query_method`     | String       | Required  | 검색 방식 설정<ul><li>`main` \| `intersection` \| `scope` \| `exclusion` \| `rerank`<ul><li>`main`: 검색 요청 시 반드시 있어야 하며, 'main query'는 검색 결과 집합의 합집합 연산을 함</li><li>`intersection`: 'main query'의 검색 결과 집합과 'intersection query'로 구한 결과 집합의 교집합 연산을 함</li><li>`scope`: 'scope query'는 'intersection query'와 효과는 같지만, 문서 질의 점수(qds)에 관여하지 않음</li><li>`exclusion`: 'exclusion query'는 'main, intersection, scope query'의 검색 결과와 'exclusion query'로 구한 검색 결과를 차집합 연산한 결과</li><li>`rerank`: 'rerank query'는 검색 결과에 영향을 주지 않지만, qds값 변경에 사용됨. 사용할 수 있는 query type은 `simbst`, `proxrank`가 있음</li></ul>|
|     `query`   | String       | Optional  | 검색하고자 하는 내용<ul><li>type이 `null` 일 경우 생략 가능</li></ul> |
|     `stopword`     | String       | Optional  | 불용어 정책 지정<ul><li>기존에 생성한 불용어 정책 중 택일 - [불용어 정책 목록 조회](/docs/analytics-cloudsearch-getstopwordlist)</li></ul> |
|     `name`     | String       | Optional  | 검색 결과의 포맷 지정<ul><li>`json` (기본값) \| `xml` </li><li>현재는 `json` 타입만 설정 가능</li></ul> |
|     `type`    | String      | Optional  | 검색 타입 지정 <ul><li>`oneterm`: 단어가 하나일 때, 해당 단어를 포함한 문서를 찾음</li> <li>`nterm`: 단어가 여러 개일 때, 해당 단어를 포함한 문서를 찾음 ('option' 파라미터 사용 가능)</li> <li> `nofm`: 모든 단어 중에서 'ratio' 파라미터로 주어진 비율 이상 포함된 문서를 찾음</li> <li> `ebool`: boolean 연산자(and, or)를 조합한 결과를 만족하는 문서를 찾음</li> <li>`simbst`: 찾은 문서 중에서 질의 단어를 포함하는 문서는 'ratio' 파라미터로 주어진 값만큼 qds를 올림 ('rerank' 검색 타입과 ratio' 파라미터와 함께 사용)</li> <li> `proxrank`: 근접도를 계산 ('rerank' 검색 타입과 함께 사용)</li> <li> `null`: 빈 질의로 전체 문서를 검색</li></ul>
|     `option`     | String       | Optional  | query 타입의 옵션을 지정<ul><li>`and` \| `or` <ul><li>`and`: 주어진 모든 단어가 포함된 문서 검색 <li>`or`: 주어진 단어 중 하나라도 포함된 문서 검색</li></ul> |
|     `ratio`     | String, Double       | Optional | 특정 Query 타입의 비율을 지정(nofm, simbst type일 때 사용)<ul><li>0~1</li></ul> |
| `term_extractor`  | String      | Optional | 검색 질의 텀 추출 방식을 지정<ul><li>현재는 변경 불가(한국어만 지원)</li></ul> |