Get basic schema information

Available in Classic and VPC

Get basic schema information, configured as required by the dataset type.

Request

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

Method	URI
GET	/schemas/default

Request headers

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

Request query parameters

The following describes the parameters.

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

Request example

The following is a sample request.

curl --location --request GET 'https://aitems.apigw.ntruss.com/api/v1/schemas/default
?datasetType=interaction' \
--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'

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

`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": "user",
    "name": "user-sample",
    "fields": [
        {
            "name": "USER_ID",
            "type": [
                "string"
            ]
        }
    ],
    "description": ""
}