Named Entity Recognition API

Named Entity Recognition (NER) API 는 자연어 문장에서 도메인별로 중요한 키워드들을 추출할 수 있습니다.

API Server

Allganize 의 API 엔드포인트는 nlu-api.allganize.ai 입니다. On-prem 플랜을 사용중이시라면 사용을 원하는 API 엔드포인트를 사용하시면 됩니다.

API 키 얻기

모든 NLU API 들은 요청을 검증하기 위해 API 키를 사용합니다. API 키는 NLU API 대시보드의 설정 메뉴에서 찾을 수 있습니다. NLU API 대시보드 계정이 없다면 여기에서 생성할 수 있습니다.

Request 헤더의 API-KEY 에 할당된 API KEY 를 입력해야 합니다.

에러 메시지

예상했던 response 를 받지 못한 경우 에러 메시지를 확인해 주세요. 예를 들어 잘못된 HTTP 메소드를 사용한 경우 아래와 같은 형식의 에러 메시지가 리턴됩니다.

{“error”: “Method Not Allowed POST: /webapi/faq_feedbacks”}

post
Named Entity Recognition API

https://nlu-api.allganize.ai/api/inference
Request
Response
Request
Headers
API-KEY
required
string
할당된 API 키입니다. 대시보드의 설정 메뉴 > 일반 탭에서 찾을 수 있습니다.
Body Parameters
text
required
string
분석을 원하는텍스트입니다. 영어, 일본어, 한국어, 중국어를 지원합니다.
Response
200: OK
Response 에는 요청된 텍스트에 대한 분석 결과가 포함되어 있습니다. startIndex: Named entity 로 인식된 단어의 시작 위치를 나타냅니다. 숫자로 표시됩니다. endIndex: Named entity 로 인식된 단어의 끝 위치를 나타냅니다. 숫자로 표시됩니다. tag: 해당 Named entity 의 타입(카테고리)입니다. 타입의 종류는 NLU API 대시보드에서 정의할 수 있습니다. token: Named entity로 인식된 단어입니다.
{
"entities": [
{
"startIndex": NUMBER,
"endIndex": NUMBER,
"tag": STRING,
"token": STRING
}, ...
]
}

Request Example

YOUR API KEY 를 프로젝트의 API 키로 바꾸어야 합니다. API 키 얻기 항목을 참고하세요.

curl https://nlu-api.allganize.ai/api/inference \
-d '{"text": "뮌헨에서 파리까지 에어 프랑스 비즈니스 클래스로 여행중입니다."}' \
-H "Content-Type: application/json" \
-H "API-KEY: YOUR_API_KEY"

Response Example

{
"inputText": "뮌헨에서 파리까지 에어 프랑스 비즈니스 클래스로 여행중입니다.",
"entities": [
{"startIndex": 1, "endIndex": 4, "tag": "DEPARTURE", "token": "뮌헨"},
{"startIndex": 10, "endIndex": 13, "tag": "ARRIVAL", "token": "파리"},
{"startIndex": 19, "endIndex": 29, "tag": "AIRLINE", "token": "에어 프랑스"},
{"startIndex": 31, "endIndex": 45, "tag": "SEAT_CLASS", "token": "비즈니스 클래스"}
}