データセットリストの照会
    • PDF

    データセットリストの照会

    • PDF

    記事の要約

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

    作成されたデータセットの全リストを照会します。

    リクエスト

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

    メソッドURI
    GET/datasets

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    offsetIntegerOptional照会データのスタート位置
    • デフォルト: 0
    limitIntegerOptional照会データの最大数
    • デフォルト: 1,000

    リクエスト例

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

    curl --location --request GET 'https://aitems.apigw.ntruss.com/api/v1/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'
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    datasetsArray-データセット情報
    offsetInteger-照会データのスタート位置
    limitInteger-照会データの最大数

    datasets

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

    フィールドタイプ必須の有無説明
    datasetIdString-データセットに付与された固有 ID
    typeString-データセットタイプ
    • user | item | interaction
      • user: ユーザー情報(年齢、性別など)を含むデータ
      • item: 商品関連情報(価格、発売日、カテゴリなど)を含むデータ
      • interaction: ユーザーと商品間の相互作用から得られた記録を含むデータ
    nameString-データセット名
    statusString-データセットの状態
    • enable | waiting | processing | upload_failed | disable | deleting
      • enable: 学習可能
      • waitingprocessing: 待機中
      • upload_faileddisabledeleting: アップロード失敗
    createdDateString-データセットの作成日時
    actionNameString-照会した項目に対する Sub Account権限
    permissionString-Sub Account権限を許可するかどうか

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

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

    レスポンス例

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

    {
        "datasets": [
            {
                "datasetId": "bu457******",
                "type": "interaction",
                "name": "interaction_dataset",
                "status": "enable",
                "createdDate": "2024-07-30T09:49:19.254",
                "actionName": "View/getDatasetDetail",
                "permission": "Allow"
            },
            {
                "datasetId": "oeq4i******",
                "type": "user",
                "name": "user_dataset",
                "status": "enable",
                "createdDate": "2024-07-30T08:58:00.662",
                "actionName": "View/getDatasetDetail",
                "permission": "Allow"
            },
            {
                "datasetId": "g8rf6******",
                "type": "item",
                "name": "item_dataset",
                "status": "enable",
                "createdDate": "2024-07-29T16:46:35.968",
                "actionName": "View/getDatasetDetail",
                "permission": "Allow"
            }
        ],
        "offset": 0,
        "limit": 1000
    }
    

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

    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.