불용어 정책 목록 조회

Prev Next

생성한 Stopword(불용어) 정책의 목록을 조회합니다.

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

요청

요청 파라미터

파라미터 명 필수 여부 타입 제약사항 설명
name Yes string 생성되어져 있는 Domain 이름
hasWordList No boolean Default: false 요청 결과에 stopword로 등록된 단어 목록 포함 여부

응답

필드명 필수 여부 타입 설명 비고
[].type Yes string filter, exact Stopword 규칙 종류
  • filter: 부분 매칭, 등록한 불용어와 검색어 일부가 일치하면 검색어 중 매칭되는 부분 제거
  • exact: 완전 매칭, 등록한 불용어와 검색어가 정확히 일치하면 검색어 중 매칭되는 단어 제거
  • [].case_sensitive Yes boolean true, false Stopword로 설정할 단어의 대소문자 구분 여부
    [].word_list No List 정책에 등록된 단어 목록
    [].word_list_length Yes number 정책에 등록된 단어 개수
    [].rule_name Yes string Stopword 정책 이름

    응답 Status

    HTTP Status Desc
    200 OK(조회 완료)
    400 Bad Request
    401 Unauthorized
    403 Forbidden
    404 Not Found
    500 Internal Server Error

    예시

    요청 예시

    GET https://cloudsearch.apigw.gov-ntruss.com/CloudSearch/real/v1/domain/car_beta/stopword   
    hasWordList: false
    

    응답 예시

    [
      {
        "type": "filter",
        "case_sensitive": true,
        "word_list_length": 2,
        "rule_name": "eomi"
      },
      {
        "type": "filter",
        "case_sensitive": false,
        "word_list_length": 7,
        "rule_name": "josa"
      }
    ]