Search autocomplete

Prev Next

We are preparing a localization service for the content. We will do our best to provide the localization service as soon as possible.

  • You should enable autocomplete before using this operation.
    This operation searches autocomplete indexes of the requested search term.
    Both GET and POST requests are available, and they work exactly the same.

GET request

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

Request

Request Parameters

Parameter Required Type Limitations Description
name Y string Domain to search Name of the domain to search
type Y string term, section Search type
  • term: Search autocomplete by index
  • section: Search autocomplete by section
  • query Y string Search term

    Response

    Response Body

    Field Required Type Description Note
    type Y string Autocomplete search request type
    item_count Y number Number of autocomplete search results
    items Y Array[string] Autocomplete search result

    Response status

    HTTP status Description
    200 OK (Successfully completed)
    400 Bad Request
    401 Unauthorized
    403 Forbidden
    404 Not Found
    500 Internal Server Error

    Examples

    Request Example

    GET /cloudsearch/api/v1/domain/abcdef/document/search/autocomplete?type=section&query=%E3%85%8E 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
    
    

    Request Example

    {
      "type": "section",
      "item_count": 1,
      "items": [
        "2018 Toyota Camry Hybrid"
      ]
    }
    

    POST request

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

    Request

    Request Parameters

    Parameter Required Type Limitations Description
    name Y string Domain to search Name of the domain to search

    Request Body

    Parameter Required Type Limitations Description
    AutocompleteSearchQuery Y AutocompleteSearchQuery Autocomplete search query

    Response

    Response Body

    Field Required Type Description Note
    type Y string Autocomplete search request type
    item_count Y number Number of autocomplete search results
    items Y Array[string] Autocomplete search result

    Response status

    HTTP status Description
    200 OK (Successfully completed)
    400 Bad Request
    401 Unauthorized
    403 Forbidden
    404 Not Found
    500 Internal Server Error

    Examples

    Request Example

    POST /CloudSearch/real/v1/domain/abcdef/document/search/autocomplete 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
    
    {
      "query": "h",
      "type": "term"
    }
    

    Request Example

    {
      "type": "term",
      "item_count": 2,
      "items": [
        “Hyundai"
        "Hybrid"
      ]
    }