슬라이딩 윈도우

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

Chat Completions API 이용 시 최대 토큰 수를 초과하는 문장을 지워줍니다.

요청

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

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

요청 헤더

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

헤더	필수 여부	설명
Authorization	Required	인증을 위한 API 키 (예: `Bearer nv-***********`)
Content-Type	Required	application/json
X-NCP-CLOVASTUDIO-REQUEST-ID	Optional	각 요청에 대한 요청 아이디

요청 경로 파라미터

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

필드	타입	필수 여부	설명
modelName	string	Y	사용할 모델 이름 <예시> HCX-003

요청 바디

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

필드	타입	필수 여부	설명
messages	array[ChatMessage]	Y	대화 메시지 목록(최대 토큰 수에 맞게 조정할 대상)
ChatMessage.role	enum	Y	대화 메시지 역할 system: 역할을 규정하는 지시문(삭제되지 않음) user: 사용자의 발화/질문 assistant: 사용자의 발화/질문에 대한 답변
ChatMessage.content	string	Y	대화 메시지 내용
maxTokens	int	Y	최대 생성 토큰 수(messages에서 입력한 토큰 수와 maxTokens에서 입력한 토큰 수의 합이 최대 토큰 수인 4096 토큰을 초과하지 않도록 조정)

요청 구문

구문 예시는 다음과 같습니다.

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: <X-NCP-CLOVASTUDIO-REQUEST-ID>' \
--header 'Content-Type: application/json' \
--data '{
      "maxTokens" : 200,
      "messages" : [ {
        "role" : "user",
        "content" : "hello"
      } ]
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
result	result	-	응답 결과(최대 토큰 수에 맞게 조정한 결과)
result.role	enum	-	대화 메시지 역할 system: 역할을 규정하는 지시문(삭제되지 않음) user: 사용자의 발화/질문 assistant: 사용자의 발화/질문에 대한 답변
result.content	string	-	대화 메시지 내용

응답 구문

구문 예시는 다음과 같습니다.

성공

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

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

실패

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