Liste der Metadatenfelder abrufen

Rufen Sie die Metadatenfelddefinitionen des Agents ab. Die Ergebnisse werden in globale Felder und Felder der einzelnen Wissensdatenbanken gruppiert. Vom System vordefinierte Felder wie document_name werden nicht zurückgegeben.

Anfragemethode

GET

Endpunkt

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

Authentifizierung

Informationen zur Authentifizierung finden Sie in der API-Übersicht.

Anfrage

Anfragebeispiel

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

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Bearer ${API Key}	Authentifizieren Sie sich mit `Authorization: Bearer ${API Key}`. Den API Key erhalten Sie auf der API-Schlüsselseite.

Anfrageparameter

Es sind keine Anfrageparameter erforderlich. Der Agent wird anhand des API Key identifiziert.

Antwort

Antwortbeispiel

{ "global_fields": [ { "id": "665f1c8a9b2e4d001a3f0001", "name": "category", "display_name": "Kategorie", "type": "LIST", "options": ["Technik", "Produkt"], "description": "Dokumentkategorie", "ai_search_filter": true, "is_predefined": false } ], "knowledge_bases": [ { "knowledge_base_id": "kb_001", "knowledge_base_name": "Produktdokumentation", "fields": [ { "id": "665f1c8a9b2e4d001a3f0009", "name": "product_line", "display_name": "Produktlinie", "type": "STRING", "options": null, "description": "", "ai_search_filter": false, "is_predefined": false } ] }, { "knowledge_base_id": "kb_002", "knowledge_base_name": "FAQ zum Kundendienst", "fields": [] } ] }

                      
                      {
    "global_fields": [
        {
            "id": "665f1c8a9b2e4d001a3f0001",
            "name": "category",
            "display_name": "Kategorie",
            "type": "LIST",
            "options": ["Technik", "Produkt"],
            "description": "Dokumentkategorie",
            "ai_search_filter": true,
            "is_predefined": false
        }
    ],
    "knowledge_bases": [
        {
            "knowledge_base_id": "kb_001",
            "knowledge_base_name": "Produktdokumentation",
            "fields": [
                {
                    "id": "665f1c8a9b2e4d001a3f0009",
                    "name": "product_line",
                    "display_name": "Produktlinie",
                    "type": "STRING",
                    "options": null,
                    "description": "",
                    "ai_search_filter": false,
                    "is_predefined": false
                }
            ]
        },
        {
            "knowledge_base_id": "kb_002",
            "knowledge_base_name": "FAQ zum Kundendienst",
            "fields": []
        }
    ]
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
global_fields	Array<Object>	Globale Felder, die für alle Dokumente des Agents gelten.
id	String	Feld-ID, die zum Bearbeiten oder Löschen verwendet wird.
name	String	Feldinterne Kennung, Kleinschreibung, eindeutig.
display_name	String	Feldanzeigename, eindeutig.
type	String	Feldtyp: STRING / NUMBER / DATETIME / LIST.
options	Array<String>	Aufzählungsoption für den Typ LIST, andere Typen sind null.
description	String	Feldbeschreibung.
ai_search_filter	Boolean	Ob als AI Search-Filterfeld verwendet werden soll.
is_predefined	Boolean	Ob es sich um ein vom System voreingestelltes Feld handelt.
knowledge_bases	Array<Object>	Wissensdatenbanken und ihre jeweiligen Felder.
knowledge_base_id	String	ID der Wissensdatenbank.
knowledge_base_name	String	Name der Wissensdatenbank.
fields	Array<Object>	Felder dieser Wissensdatenbank; die Struktur entspricht global_fields.

Fehlerantwort

Feld	Typ	Beschreibung
code	Integer	Fehlercode.
message	String	Fehlerdetails.