AISummary
Summary
다양한 주제의 한국어 원문(문서)으로부터 핵심 문장을 추출하여 1~2줄로 요약하는 서비스로 그 결과를 반환하는 HTTP 기반의 REST API입니다.
공통 설정
인증키 발급
인증 토근 발급받기 위한 계정 생성 이름, 이메일, 패스워드 입력 후 계정을 생성 해야만 정상적으로 사용이 가능합니다.
토큰 발급을 위한 로그인
이메일 / 패스워드 입력 토큰 값 발급 후 인증 통해 정상적으로 API 를 이용 하실 수 있습니다.
발급 토큰 유효
토큰은 발급 1시간 후 자동 파기 됩니다. 재발급 받으셔야 정상 이용 가능합니다.
API URL
Method | Request URI |
---|---|
POST | /api/v1/summary |
요청 헤더
헤더명 | 설명 |
---|---|
Authorization | 로그인 또는 회원 가입 후 발급 받은 토큰키 입력 Bearer [토큰값] |
Content-Type | application/json |
요청 파라미터
파라미터 이름 | 타입 | 설명 | 기본값 | 필수 여부 |
---|---|---|---|---|
language | string | 문서의 언어
| ko | Y |
model | string | 요약에 사용할 모델, 미지정시 일반 문서 요약 모델 사용
| news | N |
tone | integer | 요약돤 결과의 어투 변환, 미지정시 원문의 어투를 유지
| 0 | N |
content | string | 본문(content), 제목(title) 필드를 모두 합쳐서 | N | Y |
응답 바디
필드 이름 | 타입 | 설명 |
---|---|---|
summary | string | 요약된 문서 텍스트 |
오류 코드
# JSON
{
"error": {
"errorCode": "300",
"message": "Not Found Exception"
}
}
공통 오류
HttpStatusCode | ErrorCode | ErrorMessage | Description |
---|---|---|---|
400 | 100 | Bad Request Exception | protocol(https), endocing(UTF-8) 등 |
401 | 200 | Authentication Failed | 인증실패 |
401 | 210 | Permission Denied | 권한없음 |
404 | 300 | Not Found Exception | 권한없음 |
429 | 400 | Quota Exceeded | Quota 초과 |
429 | 410 | Throttle Limited | Rate 초과 |
429 | 420 | Rate Limited | Rate 초과 |
413 | 430 | Request Entity Too Large | content-length 초과 (10MB) |
503 | 500 | Endpoint Error | 엔드포인트 연결오류 |
504 | 510 | Endpoint Timeout | 엔드포인트 연결시간 초과 |
500 | 900 | Unexpected Error | 예외처리가 안된 오류 |
Swagger 문서
Swagger 바로가기Was this helpful?