MENU
      Create schema

        Create schema


        Article summary

        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:

        MethodURI
        POST/schemas

        Request headers

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

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        datasetTypeStringRequiredDataset 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
        nameStringRequiredSchema name
        • 3 to 20 characters, including English letters, numbers, and special characters "_" and "-", and must begin with an English letter
        fieldsArrayRequiredSchema field information
        descriptionStringOptionalSchema description
        • 0 - 100 characters

        fields

        The following describes fields.

        FieldTypeRequiredDescription
        nameStringRequiredSchema field name
        typeArrayRequiredSchema field data type
        • string | int | long | boolean | null
        categoricalBooleanOptionalWhether 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"
        }'
        Shell

        Response

        The following describes the response format.

        Response body

        The following describes the response body.

        FieldTypeRequiredDescription
        datasetTypeString-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-Schema name
        fieldsArray-Schema field information
        descriptionString-Schema description
        createdDateString-Schema creation date and time

        fields

        The following describes fields.

        FieldTypeRequiredDescription
        nameString-Schema field name
        typeArray-Schema field data type
        • string | int | long | boolean | null
        categoricalBoolean-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"
        }
        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.