リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`datasetIds`	Array	Required	設定対象データセットの IDリストデータセットリストの照会を通じて確認 3つのタイプのデータセット(user、item、interaction) IDをすべて入力すること

リクエスト例

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

curl --location --request POST 'https://aitems.apigw.ntruss.com/api/v1/services/49qkb******/datasets' \
--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 '{
    "datasetIds": [
        "bu457******", "oeq4i******", "g8rf6******"
    ]
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`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	-	サービスに設定されたデータセット情報
`hpConfigs`	Object	-	Hyperparameter Optimization(HPO)の設定情報
`hpConfigs.is_enabled`	Boolean	-	HPOの設定有無 `true` \| `false` `true`: HPOを設定。最適なトレーニングモデルを実装可能。 `false`: HPOは設定しない。AiTEMS内部の独自のアルゴリズムで学習。
`hpConfigs.{option}`	String, Long, Boolean	-	設定された HPO 値の詳細は、HPOを参照
`infers`	Array	-	学習結果情報 `type`が`interval`の場合にのみ表示
`createdDate`	String	-	サービスの作成日時
`updatedDate`	String	-	サービスの最終更新日時
`type`	String	-	サービスタイプ `batch` \| `interval` `batch`: 学習を1回実行 `interval`: 学習実行後、一定周期で再学習
`learningInterval`	String	-	データセットの更新周期 `type`が`interval`の場合にのみ表示
`scheduledDate`	String	-	データセットの更新予約時間 `type`が`interval`の場合にのみ表示

`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": "xv94v******",
    "name": "service1",
    "description": "",
    "status": "learnable",
    "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": "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"
        },
        {
            "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"
        }
    ],
    "hpConfig": {
        "is_enabled": false
    },
    "infers": [],
    "createdDate": "2024-07-30T09:50:53.521",
    "updatedDate": "2024-07-30T09:52:49.575",
    "type": "batch"
}

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

リクエスト
レスポンス

タグ

AiTEMS