メタデータフィールドを編集する

メタデータフィールドを一括編集します。変更できるのは display_label、description、ai_search_filter のみです。指定した項目だけが更新され、指定していない項目はそのまま保持されます。1 回のリクエストで最大 50 件のフィールドを編集できます。

バッチルール:
一度に編集できるのは最大 50 件で、50 件を超えるとバッチ全体が処理されません。
リクエスト内に同じ id が複数ある場合、最初の項目のみが処理され、以降の重複項目は失敗します。

リクエストメソッド

PUT

エンドポイント

https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/field/update

認証

認証方法については、API 概要を参照してください。

リクエスト

リクエスト例

curl -X PUT 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/field/update' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "fields": [ { "id": "665f1c8a9b2e4d001a3f0001", "display_label": "ドキュメントカテゴリ", "description": "ドキュメントのビジネスカテゴリ", "ai_search_filter": false } ] }'

                      
                      curl -X PUT 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/field/update' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
    "fields": [
        {
            "id": "665f1c8a9b2e4d001a3f0001",
            "display_label": "ドキュメントカテゴリ",
            "description": "ドキュメントのビジネスカテゴリ",
            "ai_search_filter": false
        }
    ]
}'

このコードブロックをポップアップで表示

リクエストヘッダー

フィールド	型	説明
Authorization	Bearer ${API Key}	`Authorization: Bearer ${API Key}` で認証します。API キーページで API Key を取得してください。
Content-Type	application/json	データ型。`application/json` に設定します。

リクエストパラメータ

フィールド	型	必須	説明
fields	Array<Object>	はい	編集するフィールドのリスト (一度に最大 50 件)。
id	String	はい	メタデータフィールド ID。フィールドを見つけるために使用されます。
display_label	String	いいえ	新しい表示名（最大 64 文字）。指定した場合のみ変更されます。
description	String	いいえ	新しいフィールド説明（最大 50 文字）。指定した場合のみ変更されます。
ai_search_filter	Boolean	いいえ	AI Search フィルターの新しい設定値。指定した場合のみ変更されます。

レスポンス

レスポンス例

{ "success_count": 1, "failure_count": 2, "results": [ { "id": "665f1c8a9b2e4d001a3f0001", "success": true }, { "id": "665f1c8a9b2e4d001a3f0002", "success": false, "error_message": "display_label already exists" }, { "id": "665f1c8a9b2e4d001a3f0001", "success": false, "error_message": "duplicate id in request" } ] }

                      
                      {
    "success_count": 1,
    "failure_count": 2,
    "results": [
        {
            "id": "665f1c8a9b2e4d001a3f0001",
            "success": true
        },
        {
            "id": "665f1c8a9b2e4d001a3f0002",
            "success": false,
            "error_message": "display_label already exists"
        },
        {
            "id": "665f1c8a9b2e4d001a3f0001",
            "success": false,
            "error_message": "duplicate id in request"
        }
    ]
}

このコードブロックをポップアップで表示

成功レスポンス

フィールド	型	説明
success_count	Integer	正常に編集されたフィールドの数。
failure_count	Integer	編集に失敗したフィールドの数。
results	Array<Object>	リクエスト順に返されるフィールドごとの結果。
id	String	フィールド ID。
success	Boolean	編集が成功したかどうか。
error_message	String	失敗の理由: display_label already exists (表示名が既存のものと競合します) / duplicate id in request (リクエスト内で id が繰り返されます) / field not found (フィールドが存在しません)。

エラーレスポンス

フィールド	型	説明
code	Integer	エラーコード。
message	String	エラーの詳細。