MENU
      Create dataset

        Create dataset


        Article summary

        Available in Classic and VPC

        Create a new dataset to train the service.

        Note

        To create a dataset, you must have a schema created. Create a schema first through the Create schema API.

        Request

        The following describes the request format for the endpoint. The request format is as follows:

        MethodURI
        POST/datasets

        Request headers

        For headers common to all AiTEMS APIs, see Common AiTEMS headers.

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        typeStringRequiredDataset type
        • user | item | interaction
          • user: data containing user information (age, gender, etc.)
          • item: data with product-related information (price, release date, category, etc.)
          • interaction: data that captures the history of interactions between users and products
        nameStringRequiredDataset name
        • 3 to 20 characters, including English letters, numbers, and special characters "_" and "-", and must begin with an English letter
        descriptionStringRequiredDataset description
        • 0 - 100 characters
        schemaNameStringRequiredDataset's schema name
        osInfoObjectRequiredInformation of Object Storage where the data file is stored
        osInfo.regionStringRequiredRegion of Object Storage where the data file is stored
        • KR
        osInfo.bucketStringRequiredBucket name of Object Storage where the data file is stored
        osInfo.keyStringRequiredPath (prefix) of Object Storage where the data file is stored

        Request example

        The following is a sample request.

        curl --location --request POST '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' \
        --data '{
            "type": "item",
            "name": "item_dataset2",
            "description": "abc",
            "schemaName": "item_schema",
            "osInfo": {
                "region": "KR",
                "bucket": "aitems",
                "key": "bookmarks-items.csv"
            }
        }'
        Shell

        Response

        The following describes the response format.

        Response body

        The following describes the response body.

        FieldTypeRequiredDescription
        datasetIdString-Dataset ID
        typeString-Dataset type
        • user | item | interaction
          • user: data containing user information (age, gender, etc.)
          • item: data with product-related information (price, release date, category, etc.)
          • interaction: data that captures the history of interactions between users and products
        nameString-Dataset name
        descriptionString-Dataset description
        schemaNameString-Dataset schema name
        statusString-Dataset status
        • enable | waiting | processing | upload_failed | disable | deleting
          • enable: training available
          • waiting, processing: pending
          • upload_failed, disable, deleting: upload failure
        osInfoObject-Information of Object Storage where the data file is stored
        osInfo.regionString-Region of Object Storage where the data file is stored
        • KR
        osInfo.bucketString-Bucket name of Object Storage where the data file is stored
        osInfo.keyString-Path (prefix) of Object Storage where the data file is stored
        connectedServicesArray-Information about service using dataset
        createdDateString-Dataset creation date and time
        updatedDateString-Last update date and time of the dataset

        connectedServices

        The following describes connectedServices.

        FieldTypeRequiredDescription
        serviceIdString-Service ID
        nameString-Service name

        Response status codes

        For response status codes common to all AiTEMS APIs, see Common AiTEMS API response status codes.

        Response example

        The following is a sample example.

        {
            "datasetId": "g8rf6******",
            "type": "item",
            "name": "item_dataset",
            "description": "abc",
            "schemaName": "LogInfo",
            "status": "waiting",
            "osInfo": {
                "region": "KR",
                "bucket": "bucket",
                "key": "bookmarks-items.csv"
            },
            "connectedServices": [],
            "createdDate": "2024-07-29T16:46:35.968",
            "updatedDate": "2024-07-29T16:46:35.968"
        }
        JSON

        Was this article helpful?

        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.