---
title: "スキーマ説明の変更"
slug: "ai-application-service-aitems-schema-modifydesc"
updated: 2026-09-17T09:57:17Z
published: 2026-09-17T09:57:17Z
canonical: "api.ncloud-docs.com/ai-application-service-aitems-schema-modifydesc"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# スキーマ説明の変更

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

スキーマの説明を変更します。

## リクエスト

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

| メソッド | URI |
| --- | --- |
| PUT | /schemas/{schemaName} |

### リクエストヘッダ

AiTEMS APIで共通して使用されるヘッダの詳細は、[AiTEMSのリクエストヘッダ](/docs/ja/aiservices-aitems-overview#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

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

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `schemaName` | String | Required | スキーマ名 - [スキーマリストの照会](/docs/ja/aiservices-aitems-schema-list)を参照 |

### リクエストボディ

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `content` | String | Required | スキーマの説明 - 0~100文字 |

### リクエスト例

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

```
curl --location --request GET 'https://aitems.apigw.ntruss.com/api/v1/schemas/item_schema' \
--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 '{
    "content": "description"
}'
```

## レスポンス

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

### レスポンスボディ

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `datasetType` | String | - | データセットタイプ - `user` \| `item` \| `interaction` - `user`: ユーザー情報(年齢、性別など)を含むデータ - `item`: 商品関連情報(価格、発売日、カテゴリなど)を含むデータ - `interaction`: ユーザーと商品間の相互作用から得られた記録を含むデータ |
| `name` | String | - | スキーマ名 |
| `fields` | Array | - | Schema field information: [fields](/docs/ja/ai-application-service-aitems-schema-modifydesc#fields) |
| `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のレスポンスステータスコード](/docs/ja/aiservices-aitems-overview#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

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

```
{
    "datasetType": "item",
    "name": "item_schema",
    "fields": [
        {
            "name": "ITEM_ID",
            "type": [
                "string"
            ]
        },
        {
            "name": "TAG_ID",
            "type": [
                "int",
                "long"
            ]
        },
        {
            "name": "TAGWEIGHT",
            "type": [
                "int"
            ]
        }
    ],
    "description": "description",
    "createdDate": "2024-07-30T08:56:29.040"
}
```