学習リストの照会

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

学習の実行をリクエストした全リストを照会します。

リクエスト

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

メソッド	URI
GET	/services/{serviceId}/trains

リクエストヘッダ

AiTEMS APIで共通して使用されるヘッダの詳細は、AiTEMSの共通ヘッダをご参照ください。

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

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

フィールド	タイプ	必須の有無	説明
`offset`	Integer	Optional	照会データのスタート位置デフォルト: 0
`limit`	Integer	Optional	照会データの最大数デフォルト: 1,000

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

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

フィールド	タイプ	必須の有無	説明
`serviceId`	String	Required	サービス ID サービスリストの照会を通じて確認

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

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

フィールド	タイプ	必須の有無	説明
`isRecent`	Boolean	Optional	タイプごとに最近リクエストした項目かどうか `true` \| `false` `true`: 最近リクエストした項目 `false`: 最近リクエストした項目ではない

リクエスト例

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

curl --location --request GET 'https://aitems.apigw.ntruss.com/api/v1/services/6wxgu******/trains
?isRecent=true' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`trains`	Array	-	学習情報
`offset`	Integer	-	照会データのスタート位置
`limit`	Integer	-	照会データの最大数

`trains`

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

フィールド	タイプ	必須の有無	説明
`serviceId`	String	-	サービス ID
`type`	String	-	学習リクエストタイプ `personalRecommend` \| `relatedItem` \| `pop` `personalRecommend`: 顧客サービス利用者の過去の履歴に基づいて個別に推薦 `relatedItem`: アイテムの関連履歴に基づいて個別に推薦 `pop`: ランキング別人気アイテムを推薦
`hpConfig`	Object	-	Hyperparameter Optimization(HPO)の設定情報
`hpConfig.is_enabled`	Boolean	-	HPOの設定有無 `true` \| `false` `true`: HPOを設定。最適なトレーニングモデルを実装可能 `false`: HPOは設定しない。AiTEMS内部の独自のアルゴリズムで学習
`hpConfig.{option}`	String, Long, Boolean	-	設定された HPO 値の詳細は、HPOを参照
`version`	String	-	学習バージョン
`description`	String	-	学習の説明
`status`	String	-	学習の状態 `ready` \| `learning` \| `completed` \| `waiting` \| `requesting` \| `requestFailed` \| `refinedFailed` \| `stopping` \ `learningFailed` `ready`: 準備完了(学習可能) `learning`: 学習中 `completed`: 学習完了 `waiting`: 学習実行待ち `requesting`: 学習リクエスト中 `requestFailed`: 学習リクエスト失敗 `refinedFailed`: データクレンジング失敗 `stopping`: 停止中 `learningFailed`: 学習失敗
`createdDate`	String	-	サービスの作成日時
`nextUpdateDate`	String	-	サービスの次回の更新予定日時
`inference`	Boolean	-	推論結果の有無 `true` \| `false` `true`: 結果あり `false`: 結果なし

レスポンスステータスコード

AiTEMS APIで共通して使用されるレスポンスステータスコードの詳細は、AiTEMS APIの共通レスポンスステータスコードをご参照ください。

レスポンス例

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

{
    "trains": [
        {
            "serviceId": "6wxgu******",
            "type": "pop",
            "hpConfig": {
                "is_enabled": false
            },
            "version": "maqll******",
            "status": "stopping",
            "createdDate": "2024-07-30T11:25:36.558",
            "inference": false
        }
    ],
    "offset": 0,
    "limit": 1000
}