スキーマの作成

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

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

データセットを作成する前に、データファイルのフィールドと同じスキーマフィールドを構成してスキーマを作成します。

リクエスト

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

メソッド	URI
POST	/schemas

リクエストヘッダ

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

リクエストボディ

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

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

`fields`

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

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

リクエスト例

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

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"
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`datasetType`	String	-	データセットタイプ `user` \| `item` \| `interaction` `user`: ユーザー情報(年齢、性別など)を含むデータ `item`: 商品関連情報(価格、発売日、カテゴリなど)を含むデータ `interaction`: ユーザーと商品間の相互作用から得られた記録を含むデータ
`name`	String	-	スキーマ名
`fields`	Array	-	スキーマフィールド情報
`description`	String	-	スキーマの説明
`createdDate`	String	-	スキーマの作成日時

`fields`

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

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

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

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

レスポンス例

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

{
    "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"
}

この記事は役に立ちましたか?

What's Next

スキーマリストの照会

リクエスト
レスポンス

タグ

AiTEMS