Docs
AI
AISummary

Summary

다양한 주제의 한국어 원문(문서)으로부터 핵심 문장을 추출하여 1~2줄로 요약하는 서비스로 그 결과를 반환하는 HTTP 기반의 REST API입니다.

공통 설정

인증키 발급

인증 토근 발급받기 위한 계정 생성 이름, 이메일, 패스워드 입력 후 계정을 생성 해야만 정상적으로 사용이 가능합니다.

토큰 발급을 위한 로그인

이메일 / 패스워드 입력 토큰 값 발급 후 인증 통해 정상적으로 API 를 이용 하실 수 있습니다.

발급 토큰 유효

토큰은 발급 1시간 후 자동 파기 됩니다. 재발급 받으셔야 정상 이용 가능합니다.

API URL

MethodRequest URI
POST
/api/v1/summary

요청 헤더

헤더명설명
Authorization로그인 또는 회원 가입 후 발급 받은 토큰키 입력 Bearer [토큰값]
Content-Typeapplication/json

요청 파라미터

파라미터 이름타입설명기본값필수 여부
languagestring

문서의 언어

  • ko: 한국어
  • ja: 일본어
koY
modelstring

요약에 사용할 모델, 미지정시 일반 문서 요약 모델 사용

  • general:일반 문서 요약
  • news: 뉴스 요약
newsN
toneinteger

요약돤 결과의 어투 변환, 미지정시 원문의 어투를 유지
(단, language=ko 옵션을 선택할 경우만 적용

  • 0: 원문의 어투를 유지
  • 1: 해요체로 변환, ex) 조사한다 -> 조사해요
  • 2: 정중체로 변환, ex)조사한다 -> 조사합니다
  • 3: 명사형 종결체로 변환, ex) 조사한다 -> 조사함
0N
contentstring

본문(content), 제목(title) 필드를 모두 합쳐서
2,000자 이내로 사용해야 합니다.

NY

응답 바디

필드 이름타입설명
summarystring요약된 문서 텍스트

오류 코드

# JSON
 
{
  "error": {
    "errorCode": "300",
    "message": "Not Found Exception"
  }
}

공통 오류

HttpStatusCodeErrorCodeErrorMessageDescription
400100Bad Request Exception

protocol(https), endocing(UTF-8) 등
request 오류

401200Authentication Failed인증실패
401210Permission Denied권한없음
404300Not Found Exception권한없음
429400Quota ExceededQuota 초과
429410Throttle LimitedRate 초과
429420Rate LimitedRate 초과
413430Request Entity Too Largecontent-length 초과 (10MB)
503500Endpoint Error엔드포인트 연결오류
504510Endpoint Timeout엔드포인트 연결시간 초과
500900Unexpected Error예외처리가 안된 오류

Swagger 문서

Swagger 바로가기
Was this helpful?
Prev
Next
Docs
© 2024 Ubion, Coursemos, Service Develop Team. All rights reserved.