Create schema

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic and VPC

Create a schema by configuring the same schema fields as the fields in the data file before creating the dataset.

Request

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

Method	URI
POST	/schemas

Request headers

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

Request body

The following describes the request body.

Field	Type	Required	Description
`datasetType`	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	Schema name 3 to 20 characters, including English letters, numbers, and special characters "_" and "-", and must begin with an English letter
`fields`	Array	Required	Schema field information
`description`	String	Optional	Schema description 0 - 100 characters

`fields`

The following describes fields.

Field	Type	Required	Description
`name`	String	Required	Schema field name Enter the same field names as in the data file Check basic schema fields by dataset type with Get basic schema information
`type`	Array	Required	Schema field data type `string` \| `int` \| `long` \| `boolean` \| `null`
`categorical`	Boolean	Optional	Whether the field is categorical `true` \| `false` (default) `true`: categorical data `false`: uncategorical data

Request example

The following is a sample request.

curl --location --request POST 'https://aitems.apigw.ntruss.com/api/v1/schemas' \
--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 '{
    "datasetType": "interaction",
    "name": "LogInfo",
    "fields": [
        {
            "name": "TIMESTAMP",
            "type": [
                "long"
            ]
        },
        {
            "name": "USER_ID",
            "type": [
                "string"
            ]
        },
        {
            "name": "ITEM_ID",
            "type": [
                "string"
            ]
        }
    ],
    "description": "desc"
}'

Response

The following describes the response format.

Response body

The following describes the response body.

Field	Type	Required	Description
`datasetType`	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	-	Schema name
`fields`	Array	-	Schema field information
`description`	String	-	Schema description
`createdDate`	String	-	Schema creation date and time

`fields`

The following describes fields.

Field	Type	Required	Description
`name`	String	-	Schema field name
`type`	Array	-	Schema field data type `string` \| `int` \| `long` \| `boolean` \| `null`
`categorical`	Boolean	-	Whether the field is categorical `true` \| `false` `true`: categorical data `false`: uncategorical data Not displayed when `false`

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.

{
    "datasetType": "interaction",
    "name": "LogInfo",
    "fields": [
        {
            "name": "TIMESTAMP",
            "type": [
                "long"
            ]
        },
        {
            "name": "USER_ID",
            "type": [
                "string"
            ]
        },
        {
            "name": "ITEM_ID",
            "type": [
                "string"
            ]
        }
    ],
    "description": "desc",
    "createdDate": "2024-07-29T16:36:06.626"
}

Was this article helpful?

What's Next

Get schema list

Table of contents

Request
Response