サービス学習のリクエスト
    • PDF

    サービス学習のリクエスト

    • PDF

    記事の要約

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

    サービスタイプがbatchのサービスが一回きりのデータセット学習を行うようにリクエストします。

    リクエスト

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

    メソッドURI
    POST/services/{serviceId}

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    serviceIdStringRequiredサービス ID

    リクエストボディ

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

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

    HPO

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

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

    リクエスト例

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

    curl --location --request POST 'https://aitems.apigw.ntruss.com/api/v1/services/xv94v******' \
    --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 '{
        "types": [
            "personalRecommend"
        ],
        "description": "test",
        "hpConfig": {
            "is_enabled": false
        }
    }'
    

    レスポンス

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

    レスポンスボディ

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

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

    datasets

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

    フィールドタイプ必須の有無説明
    datasetIdString-サービスに設定されたデータセット ID
    typeString-サービスに設定されたデータセットタイプ
    • personalRecommend | relatedItem | pop
      • personalRecommend: 顧客サービス利用者の過去の履歴に基づいて個別に推薦
      • relatedItem: アイテムの関連履歴に基づいて個別に推薦
      • pop: ランキング別人気アイテムを推薦
    nameString-サービスに設定されたデータセット名
    schemaNameString-サービスに設定されたデータセットスキーマ名
    statusString-サービスに設定されたデータセットの状態
    • learnable | disable | uploading | updateRequired
      • learnable: 学習可能
      • disable: 学習不可
      • uploading: アップロード中
      • updatedRequired: 更新されたデータセットの登録が必要(学習時、自動で登録される)
    createdDateString-サービスに設定されたデータセットの作成日時
    updatedDateString-サービスに設定されたデータセットの最終更新日時

    infers

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

    フィールドタイプ必須の有無説明
    dataTypeString-学習結果のデータセットタイプ
    • personalRecommend | relatedItem | pop
      • personalRecommend: 顧客サービス利用者の過去の履歴に基づいて個別に推薦
      • relatedItem: アイテムの関連履歴に基づいて個別に推薦
      • pop: ランキング別人気アイテムを推薦
    trainVersionString-学習結果バージョン
    statusString-学習結果の状態
    • enable | waiting | pending | processing | updateFailed | disable
      • enable: 更新可能
      • waiting: 更新待ち
      • pending: 更新待ち
      • processing: 更新中
      • updateFailed: 更新失敗
      • disable: 更新不可
    rowCountString-結果データ数
    createdDateString-データの作成日時
    updatedDateString-データの最終更新日時

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

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

    レスポンス例

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

    {
        "serviceId": "xv94v******",
        "name": "service1",
        "description": "",
        "status": "learning",
        "datasets": [
            {
                "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": "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": "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-30T09:50:53.521",
        "updatedDate": "2024-07-30T10:32:00.492",
        "type": "batch"
    }
    

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.