Edit dataset

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic and VPC

Edit information such as the dataset's name, description, schema, etc.

Request

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

Method	URI
POST	/datasets/{datasetId}

Request headers

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

Request path parameters

The following describes the parameters.

Field	Type	Required	Description
`datasetId`	String	Required	Dataset ID Check through Get dataset list

Request body

The following describes the request body.

Field	Type	Required	Description
`type`	String	Required	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
`name`	String	Required	Dataset name 3 to 20 characters, including English letters, numbers, and special characters "_" and "-", and must begin with an English letter
`description`	String	Optional	Dataset description 0 - 100 characters
`schemaName`	String	Required	Dataset's schema name
`osInfo`	Object	Required	Information of Object Storage where the data file is stored
`osInfo.region`	String	Required	Region of Object Storage where the data file is stored `KR`
`osInfo.bucket`	String	Required	Bucket name of Object Storage where the data file is stored
`osInfo.key`	String	Required	Path (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/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"
    }
}'

Response

The following describes the response format.

Response body

The following describes the response body.

Field	Type	Required	Description
`datasetId`	String	-	Dataset ID
`type`	String	-	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
`name`	String	-	Dataset name
`description`	String	-	Dataset description
`schemaName`	String	-	Dataset schema name
`status`	String	-	Dataset status `enable` \| `waiting` \| `processing` \| `upload_failed` \| `disable` \| `deleting` `enable`: training available `waiting`, `processing`: pending `upload_failed`, `disable`, `deleting`: upload failure
`osInfo`	Object	-	Information of Object Storage where the data file is stored
`osInfo.region`	String	-	Region of Object Storage where the data file is stored `KR`
`osInfo.bucket`	String	-	Bucket name of Object Storage where the data file is stored
`osInfo.key`	String	-	Path (prefix) of Object Storage where the data file is stored
`connectedServices`	Array	-	Information about service using dataset
`createdDate`	String	-	Dataset creation date and time
`updatedDate`	String	-	Last update date and time of the dataset

`connectedServices`

The following describes connectedServices.

Field	Type	Required	Description
`serviceId`	String	-	Service ID
`name`	String	-	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": "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"
}

Was this article helpful?

What's Next

Edit dataset description

Table of contents

Request
Response