リクエスト

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

メソッド	URI
PUT	/services/{serviceId}/schedule

リクエストヘッダ

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

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

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

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

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

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

フィールド	タイプ	必須の有無	説明
`action`	String	Required	周期学習の実行有無 `start` \| `stop` `start`: 周期学習を実行 `stop`: 周期学習を停止

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`trainTypes`	Array	Required	学習リクエストタイプ `personalRecommend` \| `relatedItem` \| `pop` `personalRecommend`: 顧客サービス利用者の過去の履歴に基づいて個別に推薦 `relatedItem`: アイテムの関連履歴に基づいて個別に推薦 `pop`: ランキング別人気アイテムを推薦
`description`	String	Optional	学習の説明
`hpConfig`	Object	Required	Hyperparameter Optimization(HPO)の設定情報
`hpConfig.is_enabled`	Boolean	Required	HPOの設定有無 `true` \| `false` `true`: HPOを設定。最適なトレーニングモデルを実装可能。 `false`: HPOは設定しない。AiTEMS内部の独自のアルゴリズムで学習。
`hpConfig.{option}`	String, Long, Boolean	Optional	設定された HPO HPOの値情報はHPOを参照

HPO

設定可能な HPO値の説明は次の通りです。

オプション名	タイプ	必須の有無	学習タイプ	説明
`session_max_timestamp`	Long	Optional	個別化推薦、関連項目推薦	同一セッションとみなすアクション間の最大アイドルセッション時間(秒) 10~86,400(デフォルト: 1,800) 1,800以上に設定することがお勧め
`item_top_n`	Long	Optional	個別化推薦、関連項目推薦	推薦に活用する最大商品数人気順に活用 1,000~500,000(デフォルト: 20,000)
`min_item_cut`	Long	Optional	個別化推薦、関連項目推薦	商品の最小登場条件回数 1~1,000(デフォルト: 5)
`min_session_length`	Long	Optional	個別化推薦、関連項目推薦	セッション内に最小アクション回数 2~1,000(デフォルト: 2)
`max_user_recommend_top`	Long	Optional	個別化推薦	ユーザー1人当たりの最大推薦商品数 1~1,000(デフォルト: 100)
`max_relate_recommend_top`	Long	Optional	関連項目推薦	商品ごとの最大関連項目推薦商品数 1~1,000(デフォルト: 100)
`remove_history_item`	Boolean	Optional	個別化推薦、関連項目推薦	過去に推薦された商品を個別化推薦リストから削除するかどうか `true` \| `false`(デフォルト) `true`: 過去に推薦された商品を個別化推薦リストから削除 `false`: 過去に推薦された商品を個別化推薦リストに含める
`group_column`	Array	Required	人気項目推薦	人気の抽出グループカラムリスト USER_ID、ITEM_ID、TIMESTAMPは選択不可
`target_column`	String	Optional	人気項目推薦	人気の抽出対象のカラム USER_ID、ITEM_ID、TIMESTAMPは入力不可最大100個まで入力可能
`max_group_recommend_top`	Long	Optional	人気項目推薦	グループごとの最大人気商品数 1~1,000(デフォルト: 100)

リクエスト例

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

curl --location --request PUT 'https://aitems.apigw.ntruss.com/api/v1/services/6wxgu******/schedule
?action=start' \
--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' \
--data '{
    "trainTypes": [
        "pop"
    ],
    "hpConfig": {
        "is_enabled": false
    }
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`serviceId`	String	-	サービス ID
`name`	String	-	サービス名
`description`	String	-	サービスの説明
`status`	String	-	サービスの状態 `scheduled` \| `scheduledLearning` \| `learnable` \| `learning` \| `deleting` \| `deleted` \| `disable` \| `drafted` \| `requestLearning` \| `datasetRequired` `scheduled`: 予約済み `scheduledLearning`: 予約された学習を実行中 `learnable`: 学習可能 `learning`: 学習実行中 `deleting`: 削除中 `deleted`:削除済み `disable`: 学習不可 `drafted`: 下書き保存状態 `requestLearning`: 学習リクエスト状態 `datasetRequired`: サービス作成後にデータセットを指定していない状態
`datasets`	Array	-	サービスに設定されたデータセット情報
`hpConfig`	Object	-	Hyperparameter Optimization(HPO)の設定情報
`hpConfig.is_enabled`	Boolean	-	HPOの設定有無 `true` \| `false` `true`: HPOを設定。最適なトレーニングモデルを実装可能。 `false`: HPOは設定しない。AiTEMS内部の独自のアルゴリズムで学習。
`hpConfig.{option}`	String, Long, Boolean	-	設定された HPO 値の詳細は、HPOを参照
`infers`	Array	-	学習結果情報 `type`が`interval`の場合にのみ表示
`createdDate`	String	-	サービスの作成日時
`updatedDate`	String	-	サービスの最終更新日時
`type`	String	-	サービスタイプ `batch` \| `interval` `batch`: 学習を1回実行 `interval`: 学習実行後、一定周期で再学習
`learningInterval`	String	-	データセットの更新周期
`scheduledDate`	String	-	データセット更新予約時間

`datasets`

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

フィールド	タイプ	必須の有無	説明
`datasetId`	String	-	サービスに設定されたデータセット ID
`type`	String	-	サービスに設定されたデータセットタイプ `user` \| `item` \| `interaction` `user`: ユーザー情報(年齢、性別など)を含むデータ `item`: 商品関連情報(価格、発売日、カテゴリなど)を含むデータ `interaction`: ユーザーと商品間の相互作用から得られた記録を含むデータ
`name`	String	-	サービスに設定されたデータセット名
`schemaName`	String	-	サービスに設定されたデータセットスキーマ名
`status`	String	-	サービスに設定されたデータセットの状態 `learnable` \| `disable` \| `uploading` \| `updateRequired` `learnable`: 学習可能 `disable`: 学習不可 `uploading`: アップロード中 `updatedRequired`: 更新されたデータセットの登録が必要(学習時、自動で登録される)
`createdDate`	String	-	サービスに設定されたデータセットの作成日時
`updatedDate`	String	-	サービスに設定されたデータセットの最終更新日時

`infers`

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

フィールド	タイプ	必須の有無	説明
`dataType`	String	-	学習結果のデータセットタイプ `user` \| `item` \| `interaction` `user`: ユーザー情報(年齢、性別など)を含むデータ `item`: 商品関連情報(価格、発売日、カテゴリなど)を含むデータ `interaction`: ユーザーと商品間の相互作用から得られた記録を含むデータ
`trainVersion`	String	-	学習結果バージョン
`status`	String	-	学習結果の状態 `enable` \| `waiting` \| `pending` \| `processing` \| `updateFailed` \| `disable` `enable`: 更新可能 `waiting`: 更新待ち `pending`: 更新待ち `processing`: 更新中 `updateFailed`: 更新失敗 `disable`: 更新不可
`rowCount`	String	-	結果データ数
`createdDate`	String	-	データの作成日時
`updatedDate`	String	-	データの最終更新日時

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

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

レスポンス例

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

{
    "serviceId": "6wxgu******",
    "name": "service2",
    "description": "",
    "status": "scheduled",
    "datasets": [
        {
            "datasetId": "bu457******",
            "type": "interaction",
            "name": "interaction_dataset",
            "schemaName": "interaction_schema",
            "status": "learnable",
            "createdDate": "2024-07-30T09:49:19.254",
            "updatedDate": "2024-07-30T09:49:35.364"
        },
        {
            "datasetId": "g8rf6******",
            "type": "item",
            "name": "item_dataset",
            "schemaName": "item_schema",
            "status": "learnable",
            "createdDate": "2024-07-29T16:46:35.968",
            "updatedDate": "2024-07-30T08:57:35.209"
        },
        {
            "datasetId": "oeq4i******",
            "type": "user",
            "name": "user_dataset",
            "schemaName": "user_schema",
            "status": "learnable",
            "createdDate": "2024-07-30T08:58:00.662",
            "updatedDate": "2024-07-30T08:58:35.205"
        }
    ],
    "hpConfig": {
        "is_enabled": false
    },
    "infers": [],
    "createdDate": "2024-07-30T10:28:57.825",
    "updatedDate": "2024-07-30T10:29:21.550",
    "type": "interval",
    "learningInterval": "hour1",
    "scheduledDate": "2024-07-30T11:25:36.558"
}

この記事は役に立ちましたか?

リクエスト
レスポンス