Document 검색

색인별로 생성한 문서에 대해 검색을 수행합니다.
해당 요청을 수행하기 이전에 Domain 생성 및 Document 관리이 되어져 있어야 합니다.

• 검색 서비스 구성을 위해서는 검색 기본 지식이 필요합니다.
• 서비스 생성 시 설정한 Schema로 검색 수행
• JSON 형태의 queryDSL 사용

POST https://cloudsearch.apigw.ntruss.com/CloudSearch/real/v1/domain/{name}/document/search

요청

요청 파라미터

overview

Search Query에 대한 자세한 예제는 Cloud Search 사용가이드 - Search Query 사용 가이드를 참고하시기 바랍니다.

{
  "search": {
      "start": (string|int),

      "display": (string|int),

      "result_format": (string),

      "search": {
        "[index_name]": {
          "[query_method]": [{
            "query": (string),
            "name": (string),
            "type": (string),
            "option": (string|bool),
            "ratio": (string|double),
            "term_extractor": (string),
            "stopword": (string)
          }]
        }
      },

      "sort": {
        "[sort_target]": (string)
      },

      "scope": {
        "[scope_target]": {
          "[scope_method]": (string|int|double|array)
        }
      },

      "key_scope": {
        "[scope_method]": (string|array)
      },

      "user_scope": (string),

      "highlighting": {
        "enable": (string|bool),
        "pre_tag": (string),
        "post_tag": (string),
        "[highlighting_option]": (string|bool)
      },

      "display_section": (string|array),
      "passage": {
        "[section_name]": {
           "passage_type": (string),
           "passage_option": (string),
           "max_length": (string)
        },
      },

      "aggregate": {
        "[docprop_name]": {
          "max": (string),
          "min": (string),
          "one": (string),
          "sum": (string)
        }
      },

      "result_processing": {
        "[section_name]": {
          "remove_duplicate": (string|bool)
        }
      },

      "setting": {
        "transfer_timeout": (string|int),
        "search_timeout": (string|int),
        "use_df": (string|bool),
        "reuse_term_extractor": (string|bool),
        "log_level": (string|list),
      }
    },
  "ip_str": (string)
}

요청 바디

응답

응답 Status

요청 예시

예시에서 사용되는 문서는, 검색 서비스 생성 예제와 동일합니다.

일반 검색 요청 예시(검색어 "현대")

POST https://cloudsearch.apigw.ntruss.com/CloudSearch/real/v1/domain/car_dev/document/search

POST /CloudSearch/real/v1/domain/car_dev/document/manage HTTP/1.1
Host:cloudsearch.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: cDwtHuQeGmwWyNmwlN6XIGA66zge4iMXvfoDQNna05g=
x-ncp-apigw-timestamp: 1545817618751
x-ncp-iam-access-key: teGTwtcSEGA7fu28BGGi

{
  "search": {
    "brand_name": {
      "main": {
        "query": "현대"
      }
    }
  },
  "ip_str": "10.78.140.200"
}

응답 예시

{
  "version": "1.3.0",
  "status": 200,
  "type": "response",
  "time_zone": "+09:00",
  "elapsed_time": 0.000521,
  "term": {
    "brand_name": {
      "main": {
        "term_count": 1,
        "term_list": [
          "현대"
        ]
      }
    }
  },
  "result": {
    "start": 1,
    "display": 20,
    "ranking": "clous",
    "sort_by": "qds",
    "total_count": 2,
    "removed_count": 0,
    "item_count": 2,
    "items": [
      {
        "_rank": 1,
        "_key": "car-10001",
        "_qds": 0.8729686141014099,
        "brand": "<b>현대</b>",
        "docid": "car-10001",
        "name": "2018 싼타페",
        "price": 2815,
        "type": "중형"
      },
      {
        "_rank": 2,
        "_key": "car-10002",
        "_qds": 0.8729686141014099,
        "brand": "<b>현대</b>",
        "docid": "car-10002",
        "name": "2018 그랜저",
        "price": 2615,
        "type": "중형"
      }
    ]
  }
}

불용어 검색 요청 예시(검색어 "현대와 쉐보레")

불용어 예시(rule name: "josa")

{
  "type": "filter",
  "word_list": [
    "은", "는", "이", "가", "을", "를", "의", "와"
  ]
}

검색어와 매칭되는 모든 단어를 찾기 위해서는 "or" option이 필요합니다.

POST https://cloudsearch.apigw.ntruss.com/CloudSearch/real/v1/domain/car_dev/document/search

POST /CloudSearch/real/v1/domain/car_dev/document/manage HTTP/1.1
Host:cloudsearch.apigw.ntruss.com

x-ncp-apigw-signature-v2: cDwtHuQeGmwWyNmwlN6XIGA66zge4iMXvfoDQNna05g=
x-ncp-apigw-timestamp: 1545817618751
x-ncp-iam-access-key: teGTwtcSEGA7fu28BGGi

{
  "search": {
    "brand_name": {
      "main": {
        "query": "현대와 쉐보레",
        "option":"or",
        "stopword":"josa"
      }
    }
  }
}

응답 예시

{
  "version": "1.3.0",
  "status": 200,
  "type": "response",
  "time_zone": "+09:00",
  "elapsed_time": 0.000517,
  "term": {
    "brand_name": {
      "main": {
        "term_count": 2,
        "term_list": [
          "쉐보레",
          "현대"
        ]
      }
    }
  },
  "result": {
    "start": 1,
    "display": 20,
    "ranking": "clous",
    "sort_by": "qds",
    "total_count": 3,
    "removed_count": 0,
    "item_count": 3,
    "items": [
      {
        "_rank": 1,
        "_key": "car-10001",
        "_qds": 0.8729686141014099,
        "brand": "<b>현대</b>",
        "docid": "car-10001",
        "name": "2018 싼타페",
        "price": 2815,
        "type": "중형"
      },
      {
        "_rank": 2,
        "_key": "car-10002",
        "_qds": 0.8729686141014099,
        "brand": "<b>현대</b>",
        "docid": "car-10002",
        "name": "2018 그랜저",
        "price": 2615,
        "type": "중형"
      },
      {
        "_rank": 3,
        "_key": "car-3",
        "_qds": 0.8707408308982849,
        "brand": "<b>쉐보레</b>",
        "docid": "car-3",
        "name": "2018 말리부",
        "price": 2388,
        "type": "중형"
      }
    ]
  }
}