---
title: "SearchQuery"
slug: "common-vapidatatype-cssearchpassage"
updated: 2026-09-17T09:56:55Z
published: 2026-09-17T09:56:55Z
canonical: "api.ncloud-docs.com/common-vapidatatype-cssearchpassage"
---

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

Classic環境で利用できます。

検索クエリ情報です。

## 構文

構文は次の通りです。

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

## フィールド

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `query_method` | String | Required | 検索方法を設定 - `main` \| `intersection` \| `scope` \| `exclusion` \| `rerank` - `main`: 検索リクエスト時に必須で、「main query」は検索結果集合の和集合演算を行う - `intersection`: 「main query」の検索結果集合と「intersection query」で求めた結果集合の共通集合演算を行う - `scope`: 「scope query」は「intersection query」と効果は同じだが、文書クエリのスコア(qds)には関与しない - `exclusion`: 「exclusion query」は「main、intersection、scope query」の検索結果と「exclusion query」で求めた検索結果に対し差集合演算を行った結果 - `rerank`: 「rerank query」は検索結果には影響しないが、qds値の変更に使用。使用可能な query typeは`simbst`、`proxrank` |
| `query` | String | Optional | 検索する内容 - typeが`null`の場合、省略可能 |
| `stopword` | String | Optional | ストップワードポリシーを指定 - 現在作成されているストップワードポリシーの中から1つ選択 - [ストップワードポリシーリストの照会](/docs/ja/analytics-cloudsearch-getstopwordlist) |
| `name` | String | Optional | 検索結果の形式を指定 - `json`(デフォルト) \| `xml` - 現在は`json`タイプのみ設定可能 |
| `type` | String | Optional | 検索タイプを指定 - `oneterm`: 単語が1つの場合、その単語を含む文書を探す - `nterm`: 単語が複数の場合、その単語を含む文書を探す(「option」パラメータを使用可能) - `nofm`: すべての単語の中から「ratio」パラメータで与えられた割合以上含まれた文書を探す - `ebool`: boolean演算子(and、or)を組み合わせた結果を満たす文書を探す - `simbst`: 見つかった文書の中でクエリ単語を含む文書は「ratio」パラメータで与えられた値だけ qdsを上げる(「rerank」検索タイプと「ratio」パラメータを一緒に使用) - `proxrank`: 近接度を計算(「rerank」検索タイプと一緒に使用) - `null`: 空のクエリで全文書を検索 |
| `option` | String | Optional | queryタイプのオプションを指定 - `and` \| `or` - `and`: 与えられたすべての単語を含む文書を検索 - `or`: 与えられた単語のうち1つでも含む文書を検索 |
| `ratio` | String, Double | Optional | 特定の Queryタイプの割合を指定(nofm、simbst typeの場合に使用) - 0~1 |
| `term_extractor` | String | Optional | 検索クエリタームの抽出方法を指定 - 現在は変更不可(韓国語のみサポート) |