Create dataset
- Print
- PDF
Create dataset
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Create a dataset.
POST https://aitems.apigw.ntruss.com/api/v1/datasets
Request
Request body
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| type | Yes | String | Select one from among user, item, or interaction | Dataset type |
| name | Yes | String | Start with English letter or underscore ( _ ). English letters, numbers, underscores ( _ ), and hyphens ( - ) are allowed. 3 to 20 characters can be entered. | Dataset name |
| description | Yes | String | Enter 0 to 100 characters | Dataset description |
| schemaName | Yes | String | Schema name created | Select a schema for the dataset to create |
| osInfo.region | Yes | String | KR, EN, JP .. | Object storage region |
| osInfo.bucket | Yes | String | Object storage bucket name | |
| osInfo.key | Yes | String | Object storage key |
Response
| Field name | Type | Description | Remarks |
|---|---|---|---|
| datasetId | String | Dataset ID | |
| type | String | Dataset type | |
| name | String | Dataset name | |
| description | String | Dataset description | |
| schemaName | String | Schema name | |
| status | String | Service status | |
| osInfo.region | String | Object storage region | |
| osInfo.bucket | String | Object storage bucket name | |
| osInfo.key | String | Object storage key | |
| connectedService[].serviceId | String | Service ID using the dataset | |
| connectedService[].name | String | Service name using the dataset | |
| createdDate | String | Dataset creation date | |
| updatedDate | String | Last update |
Response status
| HTTP Status | Desc |
|---|---|
| 201 | Created (Successfully created) |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
Examples
Request example
POST /api/v1/datasets
Host: aitems.apigw.ntruss.com
accept: application/json
x-ncp-iam-access-key: {Access key}
x-ncp-apigw-signature-v2: {API GW signature}
x-ncp-apigw-timestamp: {timestamp}
{
"type": "item",
"name": "item_dataset",
"description": "abc",
"schemaName": "test_item",
"osInfo": {
"region": "KR",
"bucket": "aitems-820431800",
"key": "bookmarks-items.csv"
}
}
Response example
{
"type": "item",
"name": "item_dataset",
"description": "abc",
"datasetId": "3vewbw8r9r9",
"schemaName": "test_item",
"status": "enable",
"osInfo": {
"region": "KR",
"bucket": "aitems-820431800",
"key": "bookmarks-items.csv"
},
"connectedService": [],
"createdDate": "2021-08-21T15:47:58.302",
"updatedDate": "2021-09-03T16:22:07.509"
}
Was this article helpful?