Récupérer la liste des champs de métadonnées

Récupérez les définitions des champs de métadonnées de l'Agent. Les résultats sont regroupés en champs globaux et champs propres à chaque base de connaissances. Les champs prédéfinis par le système, tels que document_name, ne sont pas renvoyés.

Méthode de requête

GET

Endpoint

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

Authentification

Pour plus d'informations sur l'authentification, consultez l'Aperçu de l'API.

Requête

Exemple de requête

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

Ce bloc de code dans la fenêtre flottante

En-têtes de requête

Champ	Type	Description
Authorization	Bearer ${API Key}	Authentifiez-vous avec `Authorization: Bearer ${API Key}`. Obtenez l'API Key depuis la page des clés API.

Paramètres de requête

Aucun paramètre de requête n'est nécessaire. L'Agent est identifié à partir de l'API Key.

Réponse

Exemple de réponse

{ "global_fields": [ { "id": "665f1c8a9b2e4d001a3f0001", "name": "category", "display_name": "Catégorie", "type": "LIST", "options": ["Technique", "Produit"], "description": "Catégorie du document", "ai_search_filter": true, "is_predefined": false } ], "knowledge_bases": [ { "knowledge_base_id": "kb_001", "knowledge_base_name": "Documentation produit", "fields": [ { "id": "665f1c8a9b2e4d001a3f0009", "name": "product_line", "display_name": "Gamme de produits", "type": "STRING", "options": null, "description": "", "ai_search_filter": false, "is_predefined": false } ] }, { "knowledge_base_id": "kb_002", "knowledge_base_name": "FAQ après-vente", "fields": [] } ] }

                      
                      {
    "global_fields": [
        {
            "id": "665f1c8a9b2e4d001a3f0001",
            "name": "category",
            "display_name": "Catégorie",
            "type": "LIST",
            "options": ["Technique", "Produit"],
            "description": "Catégorie du document",
            "ai_search_filter": true,
            "is_predefined": false
        }
    ],
    "knowledge_bases": [
        {
            "knowledge_base_id": "kb_001",
            "knowledge_base_name": "Documentation produit",
            "fields": [
                {
                    "id": "665f1c8a9b2e4d001a3f0009",
                    "name": "product_line",
                    "display_name": "Gamme de produits",
                    "type": "STRING",
                    "options": null,
                    "description": "",
                    "ai_search_filter": false,
                    "is_predefined": false
                }
            ]
        },
        {
            "knowledge_base_id": "kb_002",
            "knowledge_base_name": "FAQ après-vente",
            "fields": []
        }
    ]
}

Ce bloc de code dans la fenêtre flottante

Réponse réussie

Champ	Type	Description
global_fields	Array<Object>	Champs globaux applicables à tous les documents de l'Agent.
id	String	ID du champ, utilisé pour le modifier ou le supprimer.
name	String	Identifiant interne du champ, minuscule, unique.
display_name	String	Nom d’affichage du champ, unique.
type	String	Type de champ : STRING / NUMBER / DATETIME / LIST.
options	Array<String>	Options d'énumération du type LIST ; la valeur est null pour les autres types.
description	String	Description du champ.
ai_search_filter	Boolean	Indique si le champ est utilisé comme filtre AI Search.
is_predefined	Boolean	Qu'il s'agisse d'un champ prédéfini du système.
knowledge_bases	Array<Object>	Bases de connaissances et leurs champs respectifs.
knowledge_base_id	String	ID de la base de connaissances.
knowledge_base_name	String	Nom de la base de connaissances.
fields	Array<Object>	Champs propres à cette base de connaissances ; leur structure est identique à celle de global_fields.

Réponse d'erreur

Champ	Type	Description
code	Integer	Code d'erreur.
message	String	Détails de l'erreur.