サービス周期学習のリクエスト
- 印刷する
- PDF
サービス周期学習のリクエスト
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
サービスタイプがinterval
のサービスがデータセット学習を定期的に行うようにリクエストします。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
PUT | /services/{serviceId}/schedule |
リクエストヘッダ
AiTEMS APIで共通して使用されるヘッダの詳細は、AiTEMSの共通ヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
serviceId | String | Required | サービス ID
|
リクエストクエリパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
action | String | Required | 周期学習の実行有無
|
リクエストボディ
リクエストボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
trainTypes | Array | Required | 学習リクエストタイプ
|
description | String | Optional | 学習の説明 |
hpConfig | Object | Required | Hyperparameter Optimization(HPO)の設定情報 |
hpConfig.is_enabled | Boolean | Required | HPOの設定有無
|
hpConfig.{option} | String, Long, Boolean | Optional | 設定された HPO
|
HPO
設定可能な HPO値の説明は次の通りです。
オプション名 | タイプ | 必須の有無 | 学習タイプ | 説明 |
---|---|---|---|---|
session_max_timestamp | Long | Optional | 個別化推薦、関連項目推薦 | 同一セッションとみなすアクション間の最大アイドルセッション時間(秒)
|
item_top_n | Long | Optional | 個別化推薦、関連項目推薦 | 推薦に活用する最大商品数
|
min_item_cut | Long | Optional | 個別化推薦、関連項目推薦 | 商品の最小登場条件回数
|
min_session_length | Long | Optional | 個別化推薦、関連項目推薦 | セッション内に最小アクション回数
|
max_user_recommend_top | Long | Optional | 個別化推薦 | ユーザー1人当たりの最大推薦商品数
|
max_relate_recommend_top | Long | Optional | 関連項目推薦 | 商品ごとの最大関連項目推薦商品数
|
remove_history_item | Boolean | Optional | 個別化推薦、関連項目推薦 | 過去に推薦された商品を個別化推薦リストから削除するかどうか
|
group_column | Array | Required | 人気項目推薦 | 人気の抽出グループカラムリスト
|
target_column | String | Optional | 人気項目推薦 | 人気の抽出対象のカラム
|
max_group_recommend_top | Long | Optional | 人気項目推薦 | グループごとの最大人気商品数
|
リクエスト例
リクエストのサンプルコードは次の通りです。
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 | - | サービスの状態
|
datasets | Array | - | サービスに設定されたデータセット情報 |
hpConfig | Object | - | Hyperparameter Optimization(HPO)の設定情報 |
hpConfig.is_enabled | Boolean | - | HPOの設定有無
|
hpConfig.{option} | String, Long, Boolean | - | 設定された HPO
|
infers | Array | - | 学習結果情報
|
createdDate | String | - | サービスの作成日時 |
updatedDate | String | - | サービスの最終更新日時 |
type | String | - | サービスタイプ
|
learningInterval | String | - | データセットの更新周期 |
scheduledDate | String | - | データセット更新予約時間 |
datasets
datasets
の説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
datasetId | String | - | サービスに設定されたデータセット ID |
type | String | - | サービスに設定されたデータセットタイプ
|
name | String | - | サービスに設定されたデータセット名 |
schemaName | String | - | サービスに設定されたデータセットスキーマ名 |
status | String | - | サービスに設定されたデータセットの状態
|
createdDate | String | - | サービスに設定されたデータセットの作成日時 |
updatedDate | String | - | サービスに設定されたデータセットの最終更新日時 |
infers
infers
の説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
dataType | String | - | 学習結果のデータセットタイプ
|
trainVersion | String | - | 学習結果バージョン |
status | String | - | 学習結果の状態
|
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"
}
この記事は役に立ちましたか?