자동 완성 검색
    • PDF

    자동 완성 검색

    • PDF

    기사 요약

    자동 완성 설정 이후 해당 요청을 사용할 수 있습니다.
    요청한 검색어의 자동 완성 색인을 검색합니다.
    GET, POST 요청을 지원하며, 두 요청이 동일하여 선택적으로 이용할 수 있습니다.

    GET Request

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

    요청

    요청 파라미터

    파라미터 명필수 여부타입제약사항설명
    nameYesstring검색 설정이 되어 있는 도메인검색하고자 하는 도메인 이름
    typeYesstringterm, section검색하고자 하는 타입
  • term: 색인 단위의 자동 완성 검색
  • section: 섹션 단위의 자동 완성 검색
  • queryYesstring검색어

    응답

    응답 바디

    필드명필수 여부타입설명비고
    typeYesstring자동 완성 검색 요청 타입
    item_countYesnumber자동 완성 검색 결과 개수
    itemsYesArray[string]자동 완성 검색 결과

    응답 Status

    HTTP StatusDesc
    200OK(검색 완료)
    400Bad Request
    401Unauthorized
    403Forbidden
    404Not Found
    500Internal Server Error

    예시

    요청 예시

    GET https://cloudsearch.apigw.gov-ntruss.com/cloudsearch/api/v1/domain/abcdef/document/search/autocomplete?type=section&query=%E3%85%8E
    

    응답 예시

    {
      "type": "section",
      "item_count": 1,
      "items": [
        "2018 토요타 캠리 하이브리드"
      ]
    }
    

    POST Request

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

    요청

    요청 파라미터

    파라미터 명필수 여부타입제약사항설명
    nameYesstring검색 설정이 되어 있는 도메인검색하고자 하는 도메인 이름

    요청 바디

    파라미터 명필수 여부타입제약사항설명
    AutocompleteSearchQueryYesAutocompleteSearchQuery자동 완성 검색 질의

    응답

    응답 바디

    필드명필수 여부타입설명비고
    typeYesstring자동 완성 검색 요청 타입
    item_countYesnumber자동 완성 검색 결과 개수
    itemsYesArray[string]자동 완성 검색 결과

    응답 Status

    HTTP StatusDesc
    200OK(검색 완료)
    400Bad Request
    401Unauthorized
    403Forbidden
    404Not Found
    500Internal Server Error

    예시

    요청 예시

    POST /CloudSearch/real/v1/domain/abcdef/document/search/autocomplete HTTP/1.1
    Host: cloudsearch.apigw.gov-ntruss.com
    accept:application/json
    x-ncp-apigw-signature-v2: cDwtHuQeGmwWyNmwlN6XIGA66zge4iMXvfoDQNna05g=
    x-ncp-apigw-timestamp: 1545817618751
    x-ncp-iam-access-key: teGTwtcSEGA7fu28BGGi
    
    {
      "query": "ㅎ",
      "type": "term"
    }
    

    응답 예시

    {
      "type": "term",
      "item_count": 2,
      "items": [
        "현대",
        "하이브리드"
      ]
    }
    

    이 문서가 도움이 되었습니까?

    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.