Document検索

インデックス別に作成した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

リクエスト例示

例示で使われるDocumentは検索サービス作成例題と同じです。

一般検索リクエスト例示(検索語"Hyundai")

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
accept:application/json
x-ncp-apigw-signature-v2: cDwtHuQeGmwWyNmwlN6XIGA66zge4iMXvfoDQNna05g=
x-ncp-apigw-timestamp: 1545817618751
x-ncp-iam-access-key: teGTwtcSEGA7fu28BGGi

{
  "search": {
    "brand_name": {
      "main": {
        "query": "Hyundai"
      }
    }
  },
  "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": [
          "Hyundai"
        ]
      }
    }
  },
  "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>Hyundai</b>",
        "docid": "car-10001",
        "name": "2018 Santafe",
        "price": 2815,
        "type": "中型"
      },
      {
        "_rank": 2,
        "_key": "car-10002",
        "_qds": 0.8729686141014099,
        "brand": "<b>Hyundai</b>",
        "docid": "car-10002",
        "name": "2018 Grandure",
        "price": 2615,
        "type": "中型"
      }
    ]
  }
}

ストップワード検索 リクエスト例示(検索語"Hyundaiとchevrolet")

ストップワード例示(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
accept:application/json
x-ncp-apigw-signature-v2: cDwtHuQeGmwWyNmwlN6XIGA66zge4iMXvfoDQNna05g=
x-ncp-apigw-timestamp: 1545817618751
x-ncp-iam-access-key: teGTwtcSEGA7fu28BGGi

{
  "search": {
    "brand_name": {
      "main": {
        "query": "Hyundaiとchevrolet",
        "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": [
          "chevrolet",
          "Hyundai"
        ]
      }
    }
  },
  "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>Hyundai</b>",
        "docid": "car-10001",
        "name": "2018 Santafe",
        "price": 2815,
        "type": "中型"
      },
      {
        "_rank": 2,
        "_key": "car-10002",
        "_qds": 0.8729686141014099,
        "brand": "<b>Hyundai</b>",
        "docid": "car-10002",
        "name": "2018 Grandure",
        "price": 2615,
        "type": "中型"
      },
      {
        "_rank": 3,
        "_key": "car-3",
        "_qds": 0.8707408308982849,
        "brand": "<b>chevrolet</b>",
        "docid": "car-3",
        "name": "2018 Malibu",
        "price": 2388,
        "type": "中型"
      }
    ]
  }
}