문단 나누기

Prev Next

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

문장 간 유사도를 파악하여 주제 단위로 글의 단락을 구분합니다.

요청

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

메서드 URI
POST /v1/api-tools/segmentation

요청 헤더

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

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

요청 바디

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

필드 타입 필수 여부 설명
text Array Required 문단 나누기를 할 문서
  • 1~120,000자(한글 기준, 공백 포함)
alpha Float Optional 문단 나누기를 위한 Thresholds 값
  • 클수록 나눠지는 문단 수 증가
  • -100 | -1.5~1.5 (기본값: 0.0)
    • -100: 모델이 최적값으로 자동 수행
segCnt Integer Optional 문단 나누기 수
  • -1 (기본값) | 1 이상
    • -1: 모델이 최적값으로 자동 수행
postProcess Boolean Optional 문단 나누기 후 원하는 길이로 문단을 합치거나 나누는 후처리 수행 여부
  • true | false (기본값)
    • true: 후처리 수행 및 관련 파라미터 적용
    • false: 후처리 수행하지 않음
postProcessMaxSize Integer Optional postProcess 후처리 후 한 문단의 최대 글자 수
  • 1 이상 (기본값: 1,000)
postProcessMinSize Integer Optional postProcess 후처리 후 한 문단의 최소 글자 수
  • -1 | 0~postProcessMaxSize 값 (기본값: 300)
    • -1: 최소 단위로 자동 설정

요청 예시

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

curl --location --request POST 'https://clovastudio.stream.gov-ntruss.com/testapp/v1/api-tools/segmentation' \
--header 'Authorization: Bearer {API Key}' \
--header 'X-NCP-CLOVASTUDIO-REQUEST-ID: {Request ID}' \
--header 'Content-Type: application/json' \
--data '{
          "text": "노트는 어떻게 생성할 수 있나요?\n두 가지 방법이 있습니다.\n클로바노트 앱에서 추가 버튼을 눌러 녹음을 시작하거나, 스마트폰에 저장해둔 녹음 파일을 불러오면 노트가 생성된답니다.\n이렇게 만들어진 노트는 앱뿐만 아니라 PC의 클로바노트 웹사이트에서도 연동되어 확인하실 수 있는데요.\n클로바노트 사이트에서는 저장된 녹음파일을 불러오면 노트를 만들 수 있답니다.\n북마크는 어떻게 사용하는 건가요?\n클로바노트 앱 화면에서 녹음 중간에 북마크 버튼을 누르면, 아래처럼 표시되어 녹음을 마치고 나서도 필요한 구간을 쉽게 찾을 수 있죠.\n평소 녹음을 마치고 나면 분명히 다시 찾아보고 싶은 녹음 구간이 있었을 거예요.\n그런 순간을 위해 북마크를 제공하고 있답니다.\n그럼 녹음한 음성은 어떻게 들어볼 수 있나요?\n생성된 노트에서 기록된 대화를 선택하면 녹음 음성을 다시 들어볼 수 있답니다.\n만약 음성 기록이 잘못된 구간이 있다면 다시 한 번 음성을 들어보고 편집 버튼을 눌러 쉽게 바로잡을 수 있죠.",
          "alpha": -100,
          "segCnt": -1,
          "postProcess": false,
          "postProcessMaxSize": 2000,
          "postProcessMinSize": 500
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
topicSeg Array - 문단 나누기 결과
span Array - 문단이 나눠진 텍스트의 인덱스
  • 문단이 나눠진 위치 확인
  • [] (기본값)
inputTokens Integer - 문단 나누기 대상 문서의 토큰

응답 예시

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

성공

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

{
    "status": {
        "code": "20000",
        "message": "OK"
    },
    "result": {
        "topicSeg": [
            [
                "노트는 어떻게 생성할 수 있나요?",
                "두 가지 방법이 있습니다."
            ],
            [
                "클로바노트 앱에서 추가 버튼을 눌러 녹음을 시작하거나, 스마트폰에 저장해둔 녹음 파일을 불러오면 노트가 생성된답니다.",
                "이렇게 만들어진 노트는 앱뿐만 아니라 PC의 클로바노트 웹사이트에서도 연동되어 확인하실 수 있는데요.",
                "클로바노트 사이트에서는 저장된 녹음파일을 불러오면 노트를 만들 수 있답니다."
            ],
            [
                "북마크는 어떻게 사용하는 건가요?",
                "클로바노트 앱 화면에서 녹음 중간에 북마크 버튼을 누르면, 아래처럼 표시되어 녹음을 마치고 나서도 필요한 구간을 쉽게 찾을 수 있죠.",
                "평소 녹음을 마치고 나면 분명히 다시 찾아보고 싶은 녹음 구간이 있었을 거예요.",
                "그런 순간을 위해 북마크를 제공하고 있답니다."
            ],
            [
                "그럼 녹음한 음성은 어떻게 들어볼 수 있나요?",
                "생성된 노트에서 기록된 대화를 선택하면 녹음 음성을 다시 들어볼 수 있답니다.",
                "만약 음성 기록이 잘못된 구간이 있다면 다시 한 번 음성을 들어보고 편집 버튼을 눌러 쉽게 바로잡을 수 있죠."
            ]
        ],
        "span": [
            [
                0,
                1
            ],
            [
                2,
                3,
                4
            ],
            [
                5,
                6,
                7,
                8
            ],
            [
                9,
                10,
                11
            ]
        ],
        "inputTokens": 330
    }
}

실패

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