スキーマの有効性チェック

Classic/VPC環境で利用できます。

入力したスキーマ情報が使用可能かどうかを検証します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/schemas/validation-check

リクエストヘッダ

AiTEMS APIで共通して使用されるヘッダの詳細は、AiTEMSの共通ヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`datasetType`	String	Required	データセットタイプ `user` \| `item` \| `interaction` `user`: ユーザー情報(年齢、性別など)を含むデータ `item`: 商品関連情報(価格、発売日、カテゴリなど)を含むデータ `interaction`: ユーザーと商品間の相互作用から得られた記録を含むデータ
`name`	String	Required	スキーマ名英数字、記号の「_」のみ使用して3~20文字以内で入力、先頭文字は英字のみ使用可能
`fields`	Array	Required	スキーマフィールド情報
`description`	String	Required	スキーマの説明 0~100文字

`fields`

fieldsの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`name`	String	Required	スキーマフィールド名データファイルのフィールド名と同じ名前を入力基本スキーマ情報の照会を通じてデータセットのタイプ別基本スキーマフィールドを確認可能
`type`	Array	Required	スキーマフィールドのデータタイプ `string` \| `int` \| `long` \| `boolean` \| `null`
`categorical`	Boolean	Required	カテゴリ型フィールドかどうか `true` \| `false` `true`: カテゴリが決まっているデータ `false`: カテゴリが決まっていないデータ

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://aitems.apigw.ntruss.com/api/v1/schemas/validation-check' \
--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": "user",
    "name": "user_schema",
    "fields": [
        {
            "name": "USER_ID",
            "type": [
                "string"
            ],
            "categorical": false
        }
    ],
    "description": "desc"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`name`	String	-	スキーマフィールド名
`type`	Array	-	スキーマフィールドのデータタイプ `string` \| `int` \| `long` \| `boolean` \| `null`
`categorical`	Boolean	-	カテゴリ型かどうか `true` \| `false` `true`: カテゴリが決まっているデータ `false`: カテゴリが決まっていないデータ `false`の場合は表示されない

レスポンスステータスコード

AiTEMS APIで共通して使用されるレスポンスステータスコードの詳細は、AiTEMS APIの共通レスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

[
    {
        "name": "USER_ID",
        "type": [
            "string"
        ]
    }
]