이슈 발화 감지 API Reference

카카오 i 클라우드의 이슈 발화 감지 API를 호출할 때 필요한 개발 정보는 다음과 같습니다.

Request

Request Syntax

코드 예제 Request Syntax

curl -X POST '{API Endpoint URL}' \
  -H 'x-api-key: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
        "q": "조금 기다려보시죠|뭔 소리고?|어차피 대중들은 개돼지입니다"
    }'

표 API 호출 방식

메서드	요청 URL
POST	{API Endpoint URL} - API 호출 시 필요한 Endpoint 경로 - 카카오 i 클라우드 콘솔 > Conversation > 도메인 탭의 [인증 정보] 버튼 클릭해 조회

Request Header

표 Request Header

파라미터	타입	필수여부	설명
x-api-key	String	필수	{API Key}: API 호출 시 필요한 인증키 - 카카오 i 클라우드 콘솔 > Conversation > 도메인 탭의 [인증 정보] 버튼 클릭해 조회
Content-Type	String	필수	다음의 방식을 지원 - application/json

Request Elements

표 Request Elements

파라미터	타입	필수여부	설명
q	String	필수	이슈 발화 여부를 판별하려는 대화 - 발화 단위로 입력하며 |로 발화 구분 - 최대 발화 3개까지 입력받아 마지막 발화의 이슈 발화 여부 판단 - 전체 대화: 최소 1자, 최대 500자(공백 및 \| 포함) - 발화를 입력하지 않은 경우(ex. “||” ) 발화 기준에 어긋나 오류 처리

안내
파라미터 q에 컨트롤 캐릭터를 입력할 수 없습니다. (ASCII 코드 0~31과 127)

Response

Response Syntax

코드 예제 Response Syntax

{
  "input": "조금 기다려보시죠|뭔 소리고?|어차피 대중들은 개돼지입니다",
  "model_score": 0.9988,
  "release": "2.4.0"
}

Response Elements

표 Response Elements

필드	타입	필수 여부	설명
input	String	필수	사용자 입력 대화
model_score	Float	필수	이슈 발화 여부에 대한 모델 스코어 - 0에서 1 사이의 값으로 표현 - 1에 가까울수록 이슈 발화에 해당
release	String	필수	이슈 발화 감지 API 버전

Status Code

표 Status Code

응답 코드	응답 내용	설명
200	-	API 호출 성공
400	Bad Request	요청 주소가 잘못된 경우
	INVALID_SIGNATURE	요청 Endpoint 주소의 signature가 잘못된 경우
	INPUT_CONTEXT_OVERFLOW	context 값의 길이가 최대 발화 개수(3)를 초과한 경우
401	Authentication failed	x-api-key 헤더가 없거나 값이 잘못된 경우
404	NOT FOUND	지원하지 않는 Method로 요청을 보낸 경우
405	Method Not Allowed	지원하지 않는 Method로 요청을 보낸 경우
413	Request Entity Too Large	요청의 크기가 제한보다 큰 경우
415	Unsupported content type	Content Type 헤더가 없거나 규격에 맞지 않는 경우
422	INVALID_PARAMETER_TYPE	파라미터 타입 오류인 경우
	INVALID_PARAMETER_VALUE	길이 제한 초과, 지원되지 않는 값 등 파라미터 값이 오류인 경우
425	Domain not found	요청한 도메인이 삭제되어 없을 경우
	Domain not deployed	요청한 도메인이 아직 배포되지 않은 경우
429	Too many Requests	설정한 한도를 초과해서 요청한 경우
503	INTERNAL ERROR	예상하지 못한 서버 오류가 발생한 경우

안내
제시된 이슈 발화 감지 API 성능보다 더 높은 성능이 필요한 경우에는 헬프데스크 > 기술문의 또는 상담 및 도입 문의 신청으로 문의하시기 바랍니다.