인덱스 토크나이저 유형 조회

지정한 인덱스 토크나이저 유형을 조회합니다. 응답은 설정 명세 목록을 포함합니다.

HTTP 요청

GET /api/database/index-tokenizer-factories/:name
cURL 예시
curl -H "Authorization: Bearer <API_KEY>" \
    https://HOSTNAME/api/database/index-tokenizer-factories/query-parsed?locale=ko
요청 매개변수
필수타입설명비고
localeX문자열en, ko 중 하나미지정 시 영문 출력

정상 응답

{
    "factory": {
        "name": "query-parsed",
        "display_name": "쿼리 기반 필드 추출",
        "description": "쿼리를 이용하여 원본 데이터에서 필드 인덱스 토큰을 추출합니다.",
        "config_specs": [
            {
                "key": "query_string",
                "name": "인덱스 토큰 추출 쿼리",
                "required": false,
                "description": "필드 인덱스 토큰을 추출하는 쿼리를 입력합니다. 미설정 시 원본 데이터를 인덱싱합니다."
            },
            {
                "key": "fields_not_analyzed",
                "name": "토크나이징 제외 대상 필드",
                "required": false,
                "description": "추출된 필드 중 구분자로 잘라서 인덱스 하지 않을 필드 목록을 쉼표로 구분하여 입력합니다."
            },
            {
                "key": "fields_anonymized",
                "name": "익명화 필드 목록",
                "required": false,
                "description": "필드 이름을 지정하지 않고 풀텍스트 검색할 필드 목록을 쉼표로 구분하여 입력합니다."
            },
            {
                "key": "delimiters",
                "name": "구분자",
                "required": false,
                "description": "구분자 문자 목록, 미설정 시 모든 아스키 특수문자가 지정됩니다."
            }
        ]
    }
}
  • factory (맵): 인덱스 토크나이저 유형
    • name (문자열): 인덱스 토크나이저 유형 식별자
    • display_name (문자열): 인덱스 토크나이저 화면 표시 이름
    • description (문자열): 인덱스 토크나이저 유형 설명
    • config_specs (배열): 설정 명세 목록
      • key (문자열): 설정 변수 이름
      • name (문자열): 화면 표시 이름
      • required (불리언): 필수 여부
      • description (문자열): 옵션 설명

오류 응답

미지원 인덱스 토크나이저 유형을 조회한 경우
{
    "error_code": "illegal-state",
    "error_msg": "index tokenizer factory 'aa' not found."
}