Text Classification API

Text Classification 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 를 입력해야 합니다.

Text Classification API

POST https://nlu-api.allganize.ai/api/inference

Headers

Name	Type	Description
API-KEY	string	할당된 API 키입니다. 대시보드의 설정 메뉴 > 일반 탭에서 찾을 수 있습니다.

Request Body

Name	Type	Description
text	string	분석을 원하는 텍스트입니다. 최대 2000자까지 입력하실 수 있으며, 그 이후의 텍스트는 처되지 않습니다.

200 Response 에는 요청된 텍스트에 대한 분류 결과가 표시됩니다. displayText: Text classification 결과가 텍스트 형태로 표시됩니다. 분류 유형은 NLU API 대시보드에서 정의할 수 있습니다. id: Text classification 결과의 ID입니다. confidence: AI모델이 산출한 confidence 값을 보여줍니다. 0과 1 사이의 숫자입니다.

{
  "inputText": STRING,
  "intent": {
    "id": NUMBER,
    "displayText": STRING,
    "confidence": NUMBER
  }
}

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": "실손보험도 가입했는데 중복보장이 가능한가요?",
  "intent": {
    "id": 656,
    "displayText": "보험금_지급/청구",
    "confidence": 0.7613087892532349
  }
}

에러 메시지

예상했던 response 를 받지 못한 경우 에러 메시지를 확인해 주세요.

Status Code	Error Code	Name	Message	Description
500	7000	API Error	Something went wrong	API 처리 실패에 대한 기본 메시지로, 분류되지 않은 에러 발생시 수령
403	7001	Invalid API Key	API-KEY is not valid	헤더에 요청한 API Key가 유효하지 않은 경우 수
403	7002	Invalid JSON	Cannot decode tuen requested JSON body	요청한 JSON 파일이 잘못되어 Decode가 불가능한 경우 수령
400	7003	Invalid Parameter	Requested parameters are not valid. 'text' is empty.	요청된 파라미터가 잘못된 경우(e.g., 빈 텍스트로 인퍼런스를 요청 등) 수령
403	7004	Payment error	billing error.	지불 관련 일반 오류 (e.g., 지불 기한이 넘어간 경우 등)가 발생한 경우 수령
405	-	Wrong HTTP Method	-	잘못된 HTTP 메소드를 사용한 경우 수령

Error Response example

{
    "type": "APIError",
    "code": 7000,
    "message": "Something went wrong."
}