スライディングウィンドウ
- 印刷する
- PDF
スライディングウィンドウ
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
Chat Completions API利用時、最大トークン数を超える文を消します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /v1/api-tools/sliding/chat-messages/{modelName} |
リクエストヘッダ
ヘッダの説明は次の通りです。
| ヘッダ | 必須の有無 | 説明 |
|---|---|---|
| X-NCP-CLOVASTUDIO-API-KEY | Y | コード表示時に発行された API Key |
| X-NCP-APIGW-API-KEY | Y | コード表示時に発行された API Gateway Key |
| X-NCP-CLOVASTUDIO-REQUEST-ID | N | 各リクエストのリクエスト ID |
| Content-Type | Y | application/json |
リクエストパスパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
| modelName | string | Y | 使用するモデル名 <例> HCX-003 |
リクエストボディ
ボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
| messages | array[ChatMessage] | Y | 会話メッセージリスト(最大トークン数に合わせて調整する対象) |
| ChatMessage.role | enum | Y | 会話メッセージのロール |
| ChatMessage.content | string | Y | 会話メッセージ内容 |
| maxTokens | int | Y | 生成可能な最大トークン数(messagesで入力したトークン数と maxTokensで入力したトークン数の合計が最大トークン数の 4096トークンを超えないように調整) |
リクエスト構文
構文のサンプルコードは次の通りです。
curl --location --request POST 'https://clovastudio.apigw.ntruss.com/v1/api-tools/sliding/chat-messages/{modelName}' \
--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' \
--data '{
"maxTokens" : 200,
"messages" : [ {
"role" : "user",
"content" : "hello"
} ]
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
ボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
| result | result | - | レスポンス結果(最大トークン数に合わせて調整した結果) |
| result.role | enum | - | 会話メッセージのロール |
| result.content | string | - | 会話メッセージ内容 |
レスポンス構文
構文のサンプルコードは次の通りです。
成功
呼び出しに成功した場合の構文例は次の通りです。
{
"status": {
"code": "20000",
"message": "OK"
},
"result": {
"messages": [
{
"role": "user",
"content": "hello"
}
]
}
}
失敗
呼び出しに失敗した場合の構文例は次の通りです。
この記事は役に立ちましたか?