学習モデル Chat Completions

Classic/VPC環境で利用できます。

学習モデルを活用して、会話型文章を作成します。もし希望する会話文が作成されていない場合、データセットを精製して学習を再実行するかリクエストパラメータ値を変更し、再度呼び出しをして意図した結果値へと最適に収束するように調整します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

ヘッダ

ヘッダの説明は次の通りです。

パスパラメータ

パラメータの説明は次の通りです。

ボディ

リクエストボディの各フィールドの説明は次の通りです。

構文

構文例は次の通りです。

curl --location --request POST 'https://clovastudio.stream.ntruss.com/testapp/v1/tasks/{taskId}/chat-completions' \
--header 'X-NCP-CLOVASTUDIO-API-KEY: <X-NCP-CLOVASTUDIO-API-KEY>' \
--header 'X-NCP-APIGW-API-KEY: <X-NCP-APIGW-API-KEY>' \
--header 'X-NCP-CLOVASTUDIO-REQUEST-ID: <X-NCP-CLOVASTUDIO-REQUEST-ID>' \
--header 'Content-Type: application/json' \
--header 'Accept: text/event-stream' \
--data '{
  "topK" : 0,
  "includeAiFilters" : true,
  "maxTokens" : 100,
  "temperature" : 0.3,
  "messages" : [ {
    "role" : "user",
    "content" : "今日の天気はどう?"
  }, {
    "role" : "assistant",
    "content" : "嵐の前夜です。"
  }, {
    "role" : "user",
    "content" : "明日の天気はどう?"
  } ],
  "stopBefore" : [ ],
  "repeatPenalty" : 1,
  "topP" : 0.8
}'

レスポンス

レスポンス形式を説明します。

ヘッダ

ヘッダの説明は次の通りです。

ボディ

ボディの各フィールドの説明は次の通りです。

構文

構文例は次の通りです。

{
  "status": {
    "code": "20000",
    "message": "OK"
  },
  "result": {
    "message": {
      "role": "assistant",
      "content": "フレーズ: 今日一日あった出来事を記録し、明日に備えましょう。日記はあなたの人生をより豊かにしてくれます。\n"
    },
    "stopReason": "LENGTH",
    "inputLength": 100,
    "outputLength": 10,
    "aiFilter": [
      {
        "groupName": "curse",
        "name": "insult",
        "score": "1"
      },
      {
        "groupName": "curse",
        "name": "discrimination",
        "score": "0"
      },
      {
        "groupName": "unsafeContents",
        "name": "sexualHarassment",
        "score": "2"
      }
    ]
  }
}

レスポンスストリーム

作成されるトークンを1つずつ出力するようトークンストリーミングを使用できます。トークンストリーミング形式について説明します。

ヘッダ

ヘッダの説明は次の通りです。

ボディ

ボディの説明は次の通りです。

StreamingChatCompletionsResultEvent

StreamingChatCompletionsResultEventの説明は次の通りです。

StreamingChatCompletionsTokenEvent

StreamingChatCompletionsResultEventの説明は次の通りです。

ErrorEvent

ErrorEventの説明は次の通りです。

SignalEvent

SignalEventの説明は次の通りです。

構文

構文例は次の通りです。

id: aabdfe-dfgwr-edf-hpqwd-f2asd-g
event: token
data: {"message": {"role": "assistant", "content": "こんに"}}

id: aabdfe-dfgwr-edf-hpqwd-f1asd-g
event: result
data: {"message": {"role": "assistant", "content": "ちは"}}