学習リストの照会

Prev Next

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

作成した学習リストを照会します。

リクエスト

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

メソッド URI
GET /tuning/v2/tasks

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

フィールド 必須の有無 説明
Authorization Required 認証用 APIキー<例> Bearer nv-************
X-NCP-CLOVASTUDIO-REQUEST-ID Optional リクエスト ID
Content-Type Required リクエストデータの形式
  • application/json

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
size Integer Optional ページの出力数
  • 1~100 (デフォルト: 20)
page Integer Optional ページ番号
  • 0~N (デフォルト: 0)

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://clovastudio.stream.ntruss.com/tuning/v2/tasks?page=0&size=20' \
--header 'Authorization: Bearer {API Key}' \
--header 'Content-Type: application/json' \
--header 'X-NCP-CLOVASTUDIO-REQUEST-ID: {Request ID}'

レスポンス

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

レスポンスヘッダ

レスポンスヘッダの説明は次の通りです。

ヘッダ 必須の有無 説明
Content-Type - レスポンスデータの形式
  • application/json

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
status Object - レスポンスステータス
result Object - レスポンス結果
result.totalPages Integer - ページの総数
result.totalElements Integer - データの総数
result.size Integer - ページ別データ数
result.number Integer - ページ番号
result.content Object - 学習情報
result.content.id String - 学習 ID
result.content.name String - 学習名
result.content.model String - チューニングモデル名
result.content.method Enum - チューニング技法
  • LoRA
result.content.taskType String - 学習タイプ
  • GENERATION | CLASSIFICATION
    • GENERATION: 生成
    • CLASSIFICATION: 分類
result.content.trainEpochs Integer - モデルを学習したエポック数
result.content.learningRate Double - 学習率(チューニング時にモデルパラメータを再学習するレベルや程度)
result.content.status Enum - 学習の進行状況
  • WAIT | RUNNING | FAILED | SUCCEEDED
    • WAIT: 学習待ち
    • RUNNING: 学習中
    • FAILED: 学習停止
    • SUCCEEDED: 学習完了
result.content.statusInfo Array - 学習の進行状況の詳細情報
result.content.createdClientType String - 学習をリクエストしたクライアントタイプ
  • API | WEB
    • API: APIAPI
    • WEB: ウェブクライアント
result.content.createdDate String - 学習の作成日(ISO 8601形式)
result.content.updatedDate String - 学習の変更日(ISO 8601形式)

statusInfo

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

フィールド タイプ 必須の有無 説明
label Array -
  • 学習タイプがCLASSIFICATIONの場合: ユーザーのデータラベルを表示
  • 学習タイプがGENERATIONの場合: null
dataRows Integer - データ数
numOfTokens Integer - データトークン数
currStep Integer - 学習現在ステップ数
totalTrainSteps Integer - 学習総ステップ数
currEpoch Integer - 現在のエポック
totalTrainEpochs Integer - 全学習エポック
estimatedTime Integer - 予測所要時間
  • 1エポックの平均時間と全学習のエポック数を乗算して導き出す
trainLoss Double - 学習損失量
sendWeightSuccess Boolean - 学習結果を保存するかどうか
  • false | true
    • false: 保存しない
    • true: 保存
failureReason String - 学習失敗(FAILED)の理由
message String - 学習失敗(FAILED)の理由の詳細メッセージ
endDatetime String - 学習終了日(ISO 8601形式)

failureReason, message

学習失敗の理由(failureReason)と、学習失敗の理由の詳細メッセージ(message)の説明は次の通りです。

学習失敗の理由 詳細メッセージ 説明
file.extension Unavailable file extension. Please check the file extension again. リクエストしたtuningTypeに合致しないデータファイル拡張子
file.size Exceeded the disk usage limit. Please check if the file size is {limit} or less. 学習リクエストで期待されるファイルサイズを超過
file.encoding Unsupported charset UTF8-sigエンコードではない場合
file.format Invalid json format. {reason} データセットファイル(.json/.jsonl)のデコードが不可能な場合
file.format Invalid dataset: required field empty. {column} データセットファイルで必須 column漏れ
file.format Invalid dataset: unexpected column. {column} データセットファイルに予想外の columnが存在
file.format Invalid dataset: duplicate columns. {column} データセットファイルで大文字・小文字の区別がつかないため、重複した columnが発生
file.format Invalid dataset: column order データセットファイルの column順序が System_Prompt、C_ID、T_ID、Text、Completionではない場合
file.format Invalid dataset: {column} データセットファイルの C_IDまたは T_IDが0からスタートして1ずつ増えるパターンを満たさないか、空の値の場合
file.error - ファイル読み取りエラー
resource.timeout - GPU確保失敗によるレスポンス時間超過。再試行が必要
clops.error - 学習中 CLOpsエラー
train.unknown - 学習中ファイル関連以外のエラー

レスポンス例

レスポンスのサンプルコードは次の通りです。

成功

呼び出しに成功した場合のレスポンスのサンプルコードは次の通りです。

{
    "status": {
        "code": "20000",
        "message": "OK"
    },
    "result": {
        "totalPages": "7,",
        "totalElements": "122,",
        "size": "20,",
        "number": "0,",
        "content": [
        {
            "id": "oi55o2ej",
            "name": "230709-202307",
            "model": "HCX-003",
            "method": "LoRA",
            "taskType": "GENERATION",
            "trainEpochs": 4,
            "learningRate": 1.0E-4,
            "status": "FAILED",
            "statusInfo": {
            "label": null,
            "dataRows": null,
            "numOfTokens": null,
            "currStep": null,
            "totalTrainSteps": null,
            "currEpoch": null,
            "totalTrainEpochs": null,
            "estimatedTime": null,
            "trainLoss": null,
            "sendWeightSuccess": null,
            "failureReason": "resource.timeout"
            },
            "createdClientType": "WEB",
            "createdDate": "2023-08-20T20:23:08+0900",
            "updatedDate": "2023-08-21T10:31:40+0900"
            },
            {
                "id": "oi55o2ej",
                "name": "230709-202307",
                "model": "HCX-002",
                "method": "LoRA",
                "taskType": "GENERATION",
                "trainEpochs": 4,
                "learningRate": 1.0E-4,
                "status": "FAILED",
                "statusInfo": {
                22
                "label": null,
                "dataRows": null,
                "numOfTokens": null,
                "currStep": null,
                "totalTrainSteps": null,
                "currEpoch": null,
                "totalTrainEpochs": null,
                "estimatedTime": null,
                "trainLoss": null,
                "sendWeightSuccess": null,
                "failureReason": "resource.timeout",
                "message": null
                },
                "createdClientType": "WEB",
                "createdDate": "2023-08-21T20:23:08+0900",
                "updatedDate": "2023-08-22T10:31:40+0900"
            }
        ]
    }
}

失敗

呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。