基本スキーマ情報の照会

Prev Next

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

データセットタイプによって構成が必須である基本スキーマ情報を照会します。

リクエスト

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

メソッド URI
GET /schemas/default

リクエストヘッダ

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

リクエストクエリパラメータ

パラメータの説明は次の通りです。

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

リクエスト例

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

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'

レスポンス

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

レスポンスボディ

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

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

fields

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

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

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

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

レスポンス例

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

{
    "datasetType": "user",
    "name": "user-sample",
    "fields": [
        {
            "name": "USER_ID",
            "type": [
                "string"
            ]
        }
    ],
    "description": ""
}