メタデータフィールドリストを取得する

Agent のメタデータフィールド定義を取得し、グローバルフィールドと各ナレッジベースの専用フィールドに分けて返します。システムのプリセットフィールド（document_name など）は返されません。

リクエストメソッド

GET

エンドポイント

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

認証

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

リクエスト

リクエスト例

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/field/list' \ -H 'Authorization: Bearer ${API Key}'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/field/list' \
-H 'Authorization: Bearer ${API Key}'

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

リクエストヘッダー

フィールド	型	説明
Authorization	Bearer ${API Key}	`Authorization: Bearer ${API Key}` で認証します。API キーページで API Key を取得してください。

リクエストパラメータ

リクエストパラメータはありません。API Key から対象の Agent を識別します。

レスポンス

レスポンス例

{ "global_fields": [ { "id": "665f1c8a9b2e4d001a3f0001", "name": "category", "display_name": "カテゴリ", "type": "LIST", "options": ["技術", "製品"], "description": "ドキュメントカテゴリ", "ai_search_filter": true, "is_predefined": false } ], "knowledge_bases": [ { "knowledge_base_id": "kb_001", "knowledge_base_name": "製品ドキュメント", "fields": [ { "id": "665f1c8a9b2e4d001a3f0009", "name": "product_line", "display_name": "製品ライン", "type": "STRING", "options": null, "description": "", "ai_search_filter": false, "is_predefined": false } ] }, { "knowledge_base_id": "kb_002", "knowledge_base_name": "アフターサービス FAQ", "fields": [] } ] }

                      
                      {
    "global_fields": [
        {
            "id": "665f1c8a9b2e4d001a3f0001",
            "name": "category",
            "display_name": "カテゴリ",
            "type": "LIST",
            "options": ["技術", "製品"],
            "description": "ドキュメントカテゴリ",
            "ai_search_filter": true,
            "is_predefined": false
        }
    ],
    "knowledge_bases": [
        {
            "knowledge_base_id": "kb_001",
            "knowledge_base_name": "製品ドキュメント",
            "fields": [
                {
                    "id": "665f1c8a9b2e4d001a3f0009",
                    "name": "product_line",
                    "display_name": "製品ライン",
                    "type": "STRING",
                    "options": null,
                    "description": "",
                    "ai_search_filter": false,
                    "is_predefined": false
                }
            ]
        },
        {
            "knowledge_base_id": "kb_002",
            "knowledge_base_name": "アフターサービス FAQ",
            "fields": []
        }
    ]
}

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

成功レスポンス

フィールド	型	説明
global_fields	Array<Object>	Agent 配下のすべてのドキュメントに適用されるグローバルフィールド。
id	String	フィールド ID、編集/削除時に使用されます。
name	String	フィールドの内部識別子、小文字、一意。
display_name	String	フィールド表示名、一意。
type	String	フィールドタイプ: STRING / NUMBER / DATETIME / LIST。
options	Array<String>	LIST タイプの列挙オプション。他のタイプは null です。
description	String	フィールドの説明。
ai_search_filter	Boolean	AI Search フィルターフィールドとして使用するかどうか。
is_predefined	Boolean	システムのプリセットフィールドかどうか。
knowledge_bases	Array<Object>	各知識ベースとその専用フィールド。
knowledge_base_id	String	ナレッジベース ID。
knowledge_base_name	String	ナレッジベース名。
fields	Array<Object>	このナレッジベースの専用フィールド。構造は global_fields と同じです。

エラーレスポンス

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