Search autocomplete
    • PDF

    Search autocomplete

    • PDF

    Article summary

    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

    ParameterRequiredTypeLimitationsDescription
    nameYstringDomain to searchName of the domain to search
    typeYstringterm, sectionSearch type
  • term: Search autocomplete by index
  • section: Search autocomplete by section
  • queryYstringSearch term

    Response

    Response Body

    FieldRequiredTypeDescriptionNote
    typeYstringAutocomplete search request type
    item_countYnumberNumber of autocomplete search results
    itemsYArray[string]Autocomplete search result

    Response status

    HTTP statusDescription
    200OK (Successfully completed)
    400Bad Request
    401Unauthorized
    403Forbidden
    404Not Found
    500Internal 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

    ParameterRequiredTypeLimitationsDescription
    nameYstringDomain to searchName of the domain to search

    Request Body

    ParameterRequiredTypeLimitationsDescription
    AutocompleteSearchQueryYAutocompleteSearchQueryAutocomplete search query

    Response

    Response Body

    FieldRequiredTypeDescriptionNote
    typeYstringAutocomplete search request type
    item_countYnumberNumber of autocomplete search results
    itemsYArray[string]Autocomplete search result

    Response status

    HTTP statusDescription
    200OK (Successfully completed)
    400Bad Request
    401Unauthorized
    403Forbidden
    404Not Found
    500Internal 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"
      ]
    }
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.