---
title: "SearchQuery"
slug: "common-apidatatype-cssearchquery"
tags: ["Classic"]
updated: 2026-09-17T09:25:03Z
published: 2026-09-17T09:25:03Z
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

Available in Classic

This is the search query information.

## Syntax

The syntax is as follows.

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

## Field

The following describes the fields.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `query_method` | String | Required | Set search method - `main` \| `intersection` \| `scope` \| `exclusion` \| `rerank` - `main`: Must be present in the search request, where "main query" performs a union operation on the search result set - `intersection`: Perform an intersection operation on the search result set of "main query" and the result set obtained with "intersection query" - `scope`: "scope query" has the same effect as "intersection query", but does not participate in the document query score (QDS) - `exclusion`: "exclusion query" is the result of a subset operation of the search results of "main, intersection, scope query" and the search results obtained by "exclusion query" - `rerank`: "rerank query" does not affect search results, but is used to change the qds value. Available query types include `simbst` and `proxrank` |
| `query` | String | Optional | Content to search - Can be omitted if type is `null` |
| `stopword` | String | Optional | Specify a stopword policy - Select from existing stopword policies - [View stopword policy list](/docs/en/analytics-cloudsearch-getstopwordlist) |
| `name` | String | Optional | Specify the format of search results - `json` (default) \| `xml` - Currently only `json` type can be set |
| `type` | String | Optional | Specify the search type - `oneterm`: When there is a single word, find documents containing that word - `nterm`: When there are multiple words, find documents containing those words (can use the "option" parameter) - `nofm`: Find documents that contain at least a percentage given by the "ratio" parameter among all words - `ebool`: Find documents that satisfy a combination of boolean operators (and, or) - `simbst`: Among the found documents, those containing the query words will raise the qds by the value given by the "ratio" parameter (used with the "rerank" search type and the "ratio" parameter) - `proxrank`: Calculate proximity (used with the "rerank" search type) - `null`: Search the entire document with an empty query |
| `option` | String | Optional | Specify options of the query type - `and` \| `or` - `and`: Search for documents containing all given words - `or`: Search for documents that contain any of the given words |
| `ratio` | String, Double | Optional | Specify the percentage of a specific query type (used when nofm, simbst type) - 0 - 1 |
| `term_extractor` | String | Optional | Specify how search query terms are extracted - Currently unchangeable (Korean only) |