슬라이딩 윈도우

Prev Next

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

Chat Completions API 이용 시 최대 토큰 수를 초과하는 문장을 지워줍니다. 가장 오래된 순서로 대화 턴을 삭제하여 토큰을 확보하기 때문에 대화를 끊김 없이 생성할 수 있게 됩니다.

참고

슬라이딩 윈도우의 작동 방식 및 작업 과정에 대한 자세한 설명은 CLOVA Studio 사용 가이드의 API 활용을 참조해 주십시오.

요청

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

메서드 URI
POST /v1/api-tools/sliding/chat-messages/{modelName}

요청 헤더

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

필드 필수 여부 설명
Authorization Required 인증을 위한 API 키 (예: Bearer nv-***********)
X-NCP-CLOVASTUDIO-REQUEST-ID Optional 각 요청에 대한 요청 아이디
Content-Type Required 요청 데이터의 형식
  • application/json
  • 요청 경로 파라미터

    파라미터에 대한 설명은 다음과 같습니다.

    필드 타입 필수 여부 설명
    modelName String Required 사용할 모델 이름
  • <예시> HCX-003
  • 요청 바디

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

    필드 타입 필수 여부 설명
    maxTokens Integer Required 최대 생성 토큰 수
  • 0 < maxTokens ≤ 4096 (기본값: 100)
  • messages Array Required 대화 메시지 목록
  • 최대 토큰 수에 맞게 조정 필요)
  • messages.role Enum Required 대화 메시지 역할
    • system | user | assistant
      • system: 역할을 규정하는 지시문
      • user: 사용자의 발화 또는 질문
      • assistant: 사용자의 발화 또는 질문에 대한 답변
    messages.content String Required 대화 메시지 내용
    참고

    일부 필드 입력 시 다음 내용을 확인해 주십시오.

    • messages: 입력한 토큰 수와 maxTokens에서 입력한 토큰 수의 합은 4096 토큰을 초과할 수 없습니다. messages에서 입력한 토큰 수는 토큰 계산 API를 호출하여 확인할 수 있습니다.

    요청 예시

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

    curl --location --request POST 'https://clovastudio.stream.gov-ntruss.com/v1/api-tools/sliding/chat-messages/{modelName}' \
    --header 'Authorization: Bearer {API Key}' \
    --header 'X-NCP-CLOVASTUDIO-REQUEST-ID: {Request ID}' \
    --header 'Content-Type: application/json' \
    --data '{
          "maxTokens" : 200,
          "messages" : [ {
            "role" : "user",
            "content" : "hello"
          } ]
    }'
    

    응답

    응답 형식을 설명합니다.

    응답 바디

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

    필드 타입 필수 여부 설명
    result Object - 응답 결과
    • 최대 토큰 수에 맞게 조정한 결과
    result.messages Array - 대화 메시지 목록
    result.messages.role Enum - 대화 메시지의 역할
    • system | user | assistant
      • system: 역할을 규정하는 지시문
      • user: 사용자의 발화 또는 질문
      • assistant: 사용자의 발화 또는 질문에 대한 답변
    result.messages.content String - 대화 메시지 내용

    응답 예시

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

    성공

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

    {
        "status": {
            "code": "20000",
            "message": "OK"
        },
        "result": {
            "messages": [
                {
                    "role": "user",
                    "content": "hello"
                }
            ]
        }
    }
    

    실패

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