データセットの変更
    • PDF

    データセットの変更

    • PDF

    記事の要約

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

    データセットの名前、説明、スキーマなどの情報を変更します。

    リクエスト

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

    メソッドURI
    POST/datasets/{datasetId}

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    datasetIdStringRequiredデータセット ID

    リクエストボディ

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

    フィールドタイプ必須の有無説明
    typeStringRequiredデータセットタイプ
    • user | item | interaction
      • user: ユーザー情報(年齢、性別など)を含むデータ
      • item: 商品関連情報(価格、発売日、カテゴリなど)を含むデータ
      • interaction: ユーザーと商品間の相互作用から得られた記録を含むデータ
    nameStringRequiredデータセット名
    • 英数字、記号の「_」、「-」のみ使用して3~20文字以内で入力、先頭文字は英字のみ使用可能
    descriptionStringOptionalデータセットの説明
    • 0~100文字
    schemaNameStringRequiredデータセットのスキーマ名
    osInfoObjectRequiredデータファイルが保存された Object Storage情報
    osInfo.regionStringRequiredデータファイルが保存された Object Storageのリージョン
    • KR
    osInfo.bucketStringRequiredデータファイルが保存された Object Storageのバケット名
    osInfo.keyStringRequiredデータファイルが保存された Object Storageのパス(Prefix)

    リクエスト例

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

    curl --location --request POST 'https://aitems.apigw.ntruss.com/api/v1/datasets/bu457******' \
    --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 '{
        "type": "item",
        "name": "item_dataset1",
        "description": "item dataset",
        "schemaName": "item_schema",
        "osInfo": {
            "region": "KR",
            "bucket": "aitems",
            "key": "bookmarks-items.csv"
        }
    }'
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    datasetIdString-データセット ID
    typeString-データセットタイプ
    • user | item | interaction
      • user: ユーザー情報(年齢、性別など)を含むデータ
      • item: 商品関連情報(価格、発売日、カテゴリなど)を含むデータ
      • interaction: ユーザーと商品間の相互作用から得られた記録を含むデータ
    nameString-データセット名
    descriptionString-データセットの説明
    schemaNameString-データセットのスキーマ名
    statusString-データセットの状態
    • enable | waiting | processing | upload_failed | disable | deleting
      • enable: 学習可能
      • waitingprocessing: 待機中
      • upload_faileddisabledeleting: アップロード失敗
    osInfoObject-データファイルが保存された Object Storage情報
    osInfo.regionString-データファイルが保存された Object Storageのリージョン
    • KR
    osInfo.bucketString-データファイルが保存された Object Storageのバケット名
    osInfo.keyString-データファイルが保存された Object Storageのパス(Prefix)
    connectedServicesArray-データセットを使用中のサービス情報
    createdDateString-データセットの作成日時
    updatedDateString-データセットの最終更新日時

    connectedServices

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

    フィールドタイプ必須の有無説明
    serviceIdString-サービス ID
    nameString-サービス名

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

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

    レスポンス例

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

    {
        "datasetId": "bu457******",
        "type": "interaction",
        "name": "item_dataset1",
        "description": "item dataset",
        "schemaName": "item_schema",
        "status": "waiting",
        "osInfo": {
            "region": "KR",
            "bucket": "aitems",
            "key": "bookmarks-items.csv"
        },
        "connectedServices": [
            {
                "serviceId": "fboyb******",
                "name": "service"
            },
            {
                "serviceId": "xv94v******",
                "name": "service1"
            },
            {
                "serviceId": "6wxgu******",
                "name": "service3"
            }
        ],
        "createdDate": "2024-07-30T09:49:19.254",
        "updatedDate": "2024-07-30T15:45:54.217"
    }
    

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

    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.