Completions
- 印刷する
- PDF
Completions
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
プレイグラウンドの一般モード(LKモデル)を通じて利用できる Completions APIのガイドです。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /v1/completions/{model} |
参考
チューニング学習を行った作業を利用する際は/v1/tasks/{taskId}/completions形式で呼び出します。呼び出しに必要なtaskIDは学習作成 APIのレスポンスボディで確認できます。
リクエストヘッダ
ヘッダの説明は次の通りです。
| ヘッダ | 必須の有無 | 説明 |
|---|---|---|
| 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 |
リクエストパスパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
| model | string | Y | 使用するモデル名(例: LK-D2) |
チューニングを行った作業の場合、パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
| taskId | string | Y | 学習 ID |
参考
呼び出しに必要なtaskIDは学習作成 APIのレスポンスボディで確認できます。
リクエストボディ
ボディの説明は次の通りです。
参考
一部フィールドの入力時、下記の内容をご確認ください。
- textに入力したトークン数と maxTokensに入力したトークン数の合計は2,048トークンを超えることはできません。
- textで入力したトークン数は、CLOVA Studioウェブでエクスプローラ > ツールタブのトークン計算機 APIを呼び出すと確認できます。
- topP、temperature: 小数点第2位まで表記します。
リクエスト構文
構文のサンプルコードは次の通りです。
curl --location --request POST 'https://clovastudio.apigw.ntruss.com/testapp/v1/completions/LK-D2' \
--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 '{
"start": "\n英語: ",
"stopBefore": ["\n韓国語: "],
"text": "韓国語: 사과\n英語: Apple\n韓国語: 바나나",
"includeAiFilters": true
}'
レスポンス
レスポンス形式を説明します。
レスポンスヘッダ
ヘッダの説明は次の通りです。
| ヘッダ | 必須の有無 | 説明 |
|---|---|---|
| Content-Type | - | application/json |
レスポンスボディ
ボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
| text | string | - | 生成したトークン。プロンプトと結果をいずれも含む |
| stopReason | string | - | 結果の生成を停止した理由
|
| inputLength | integer | - | 入力されたトークン数 |
| inputTokens | string array | - | 入力トークン情報 |
| outputLength | integer | - | レスポンストークン数 |
| outputTokens | string array | - | 生成トークン情報 |
| probs | float | - | 各生成トークンが選択される確率 |
| aiFilter | array | - | AI Filter結果 |
| aiFilter.groupName | string | - | AI Filterカテゴリグループ名 |
| aiFilter.name | string | - | AI Filterの詳細なカテゴリの名前 |
| aiFilter.score | string | - | AI Filterスコア |
| aiFilter.result | string | - | AI Filterは正常に動作しているか |
参考
AI Filterは最大500文字まで分析できます。ただし、分析対象テキストに異常な形式、絵文字、記号などが多い場合、正常に分析されないことがあります。
レスポンス構文
構文のサンプルコードは次の通りです。
成功
呼び出しに成功した場合の構文例は次の通りです。
{
"status": {
"code": "20000",
"message": "OK"
},
"result": {
"text": "豊かな感受性のキャッチコピーを作成しなさい\n\n商品: 乳液\nキャッチコピー: お肌に触れる瞬間、満たされる潤い\n###\n商品: 手帳\nキャッチコピー: 自分へのご褒美",
"stopReason": "end_token",
"startLength": 33,
"inputText": "豊かな感受性のキャッチコピーを作成しなさい\n\n商品: 乳液\nキャッチコピー: お肌に触れる瞬間、満たされる潤い\n###\n商品: 手帳",
"inputLength": 33,
"inputTokens": ["豊かな","感受性","の"," キャッチ"," コピー","を"," 作成","しなさい","\n",
"\n","商品",":"," 乳液","\n","キャッチコピー",":","お","肌","に","触れる","瞬間","、","満たされる","潤い",
"\n","##","#","\n","`商品",":"," 手帳","\n","キャッチコピー",":"
],
"outputText": "\nキャッチコピー: 自分へのご褒美",
"outputLength": 7,
"outputTokens": ["自分","へ","の","ご","褒美",""
],
"probs": [],
"ok": true,
"aiFilter": [
{
"groupName": "curse",
"name": "insult",
"score": "2"
},
{
"groupName": "curse",
"name": "discrimination",
"score": "1"
},
{
"groupName": "unsafeContents",
"name": "sexualHarassment",
"score": "2"
}
]
}
}
失敗
呼び出しに失敗した場合の構文例は次の通りです。
この記事は役に立ちましたか?