요약

Classic/VPC 환경에서 이용 가능합니다.

다양한 옵션을 적용하여 긴 문장을 요약합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
POST	/v1/api-tools/summarization/v2

요청 헤더

요청 헤더에 대한 설명은 다음과 같습니다.

필드	필수 여부	설명
`Authorization`	Required	인증을 위한 API 키 <예시> `Bearer nv-************`
`X-NCP-CLOVASTUDIO-REQUEST-ID`	Optional	요청 ID
`Content-Type`	Required	요청 데이터의 형식 `application/json`

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`texts`	Array	Required	요약 대상 문장 1~35,000자(한글 기준, 공백 포함)
`autoSentenceSplitter`	Boolean	Optional	요약 대상 문장의 문단 분리 허용 여부 `true` (기본값) \| `false` `true`: 문단 분리 및 `segCount`, `segMaxSize`, `segMinSize` 적용 `false`: 문단 분리 안 함
`segCount`	Integer	Optional	요약 대상 문장의 문단 분리 수 -1 (기본값) \| 1 이상 -1: 모델이 최적값으로 자동 수행
`segMaxSize`	Integer	Optional	문단 분리 시 한 문단의 최대 글자 수 1~3,000자(한글 기준, 공백 포함) (기본값: 1,000)
`segMinSize`	Integer	Optional	문단 분리 시 한 문단의 최소 글자 수 0~`segMaxSize` 값 (기본값: 300)
`includeAiFilters`	Boolean	Optional	AI 필터 적용 여부 `true` \| `false` (기본값) `true`: 적용 `false`: 적용 안 함

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://clovastudio.stream.gov-ntruss.com/testapp/v1/api-tools/summarization/v2' \
--header 'Authorization: Bearer {API Key}' \
--header 'X-NCP-CLOVASTUDIO-REQUEST-ID: {Request ID}' \
--header 'Content-Type: application/json' \
--data '{
            "texts": [
                "CLOVA Studio가 제공하는 다양한 기능은 다음과 같습니다. - 문장 생성: 몇 가지 키워드만 입력하면 해당 키워드를 기반으로 시나리오 창작, 자기소개서 작성, 이메일 생성, 마케팅 문구 창작 등 다양한 분야의 문장 생성. - 요약: 줄거리, 보고서, 이메일과 같이 긴 글에서 주요 요소를 파악하여 설정한 요약문 길이에 따라 글 요약. - 분류: 문장의 유형, 문서 색인, 감정, 의도와 같은 특징을 분류하거나 문단에서 주요 키워드 추출 가능. - 대화: 예제 입력을 통해 고유의 페르소나를 가진 AI를 생성하여 지식백과형 챗봇, 커스텀 챗봇 등 대화 인터페이스 제작 가능. - 문장 변환: 입력한 예제와 유사한 스타일의 문장으로 문장 형태 변환 가능 AI Filter: 민감하거나 안전하지 않은 결과물이 생성되는 것을 감지하여 알리는 AI Filter 기능 제공"
            ],
            "autoSentenceSplitter": true,
            "segCount": -1,
            "segMaxSize": 1000,
            "segMinSize": 300,
            "includeAiFilters": false
}'

응답

응답 형식을 설명합니다.

응답 바디

바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
text	string	-	요약 결과
inputTokens	integer	-	요약할 문장 입력 시 사용한 토큰 수

응답 구문

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`text`	String	-	요약 결과
`inputTokens`	Integer	-	요약 대상 문장의 토큰 수

응답 예시

응답 예시는 다음과 같습니다.

성공

호출이 성공한 경우의 응답 예시는 다음과 같습니다.

{
    "status": {
        "code": "20000",
        "message": "OK"
    },
    "result": {
        "text": "- 클로바 스튜디오가 제공하는 다양한 기능에 대해 설명하고 있음",
        "inputTokens": 187
    }
}

실패

호출이 실패한 경우의 구문 예시는 다음과 같습니다.