텍스트 및 이미지

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

이미지를 해석하고 이해할 수 있는 HCX-005 비전 모델과 경량화된 HCX-DASH-002 모델을 이용할 수 있는 v3 Chat Completions에 대해 설명합니다.

요청

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

요청 헤더

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

요청 경로 파라미터

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

요청 바디

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

messages

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

content

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

요청 예시

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

curl --location --request POST 'https://clovastudio.stream.gov-ntruss.com/testapp/v3/chat-completions/{modelName}' \
--header 'Authorization: Bearer <API-KEY>' \
--header 'X-NCP-CLOVASTUDIO-REQUEST-ID: <X-NCP-CLOVASTUDIO-REQUEST-ID>' \
--header 'Content-Type: application/json' \
--header 'Accept: text/event-stream' \
--data '{
    "messages": [
      {
        "role": "system",
        "content": [
          {
            "type": "text",
            "text": "- 친절하게 답변하는 AI 어시스턴트입니다."
          }
        ]
      },
      {
        "role": "user",
        "content": [
          {
            "type": "image_url",
            "imageUrl": {
              "url": "https://www.******.com/image_a1b1c1.png"
            }
          },
          {
            "type": "text",
            "text": "이 사진에 대해서 설명해줘"
          }
        ]
      }
    ],
        "temperature": 0.5,
        "topK": 0,
        "topP": 0.8,
        "repetitionPenalty": 1.1,
        "stop": [],
        "maxTokens": 100,
        "includeAiFilters": false
    }'

응답

응답 형식을 설명합니다.

응답 헤더

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

응답 바디

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

aiFilter

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

응답 예시

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

성공

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

{
    "status": {
        "code": "20000",
        "message": "OK"
    },
    "result": {
        "created": 1791043155000,
        "usage": {
            "completionTokens": 80,
            "promptTokens": 843,
            "totalTokens": 923
        },        
        "message": {
            "role": "assistant",
            "content": "사진에는 어린 아이가 양에게 먹이를 주는 모습이 담겨 있습니다. 아이는 파란색 옷을 입고 있으며, 줄문의 모자를 쓰고 있습니다. 아이의 표정은 집중하고 있는 듯 보이며, 양은 아이가 주는 먹이를 먹으려고 머리를 숙이고 있습니다. 배경에는 다른 양들도 보이며, 이 장소가 양 목장임을 짐작할 수 있습니다."
        },
        "seed": 1561390649,
        "aiFilter": [
         {
          "groupName": "curse",
          "name": "insult",
         "score": "1"
         },
         {
          "groupName": "curse",
          "name": "discrimination",
          "score": "0"
         },
         {
          "groupName": "unsafeContents",
          "name": "sexualHarassment",
          "score": "2"
         }
        ]
    }
}

실패

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

• 클라이언트 공통 오류 문제(4xx)
• 서버 공통 오류 문제(5xx)

응답 스트림

생성되는 토큰을 하나씩 출력하도록 토큰 스트리밍을 사용할 수 있습니다. 토큰 스트리밍 형식을 설명합니다.

응답 헤더

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

응답 바디

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

StreamingChatCompletionsTokenEvent

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

StreamingChatCompletionsResultEvent

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

ErrorEvent

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

SignalEvent

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

응답 예시

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

성공

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

id: 484f9a63-8231-441b-b2dc-683ed135dd03
event: signal
data:
{
  "data": "[DONE]"
}

id: 8138bd06-9d29-43fb-9a91-72bc12bd31a1
event: result
data:
{
  "message": {
      "role": "assistant",
      "content": "문구: 생각을 기록하고, 꿈을 그리다. 내 삶의 이야기, 다이어리가 함께합니다."
  },
  "finishReason": "stop",
  "created": 1734016821,
  "seed": 1342914828,
  "usage": {
      "promptTokens": 98,
      "completionTokens": 212,
      "totalTokens": 310
 }
}

id: 9517637c-17aa-4a4a-a076-3fde680a953e
event: token
data:
{
  "message": {
      "role": "assistant",
      "content": "."
  },
  "finishReason": null,
  "created": 1734016821,
  "seed": 1342914828,
  "usage": null
}

id: 1dd8d882-4b8c-4435-abc5-f58bdbbc17a8
event: token
data:
{
  "message": {
      "role": "assistant",
      "content": "합니다"
  },
  "finishReason": null,
  "created": 1734016821,
  "seed": 1342914828,
  "usage": null
}
…

실패

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

• 클라이언트 공통 오류 문제(4xx)
• 서버 공통 오류 문제(5xx)