Modifier les champs de métadonnées

Modifiez des champs de métadonnées par lots. Seuls display_label, description et ai_search_filter peuvent être modifiés. Seules les valeurs fournies sont mises à jour ; les autres restent inchangées. Une requête peut modifier jusqu'à 50 champs.

Règles de lots :
Un maximum de 50 peuvent être modifiés à la fois, et l'ensemble du lot ne sera pas traité s'il dépasse 50.
Si un id apparaît plusieurs fois dans la requête, seul le premier élément est traité ; les doublons suivants échouent.

Méthode de requête

PUT

Endpoint

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

Authentification

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

Requête

Exemple de requête

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": "Catégorie du document", "description": "Catégorie métier du document", "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": "Catégorie du document",
            "description": "Catégorie métier du document",
            "ai_search_filter": false
        }
    ]
}'

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.
Content-Type	application/json	Type de données, défini sur `application/json`.

Paramètres de requête

Champ	Type	Obligatoire	Description
fields	Array<Object>	Oui	Une liste de champs à modifier, jusqu'à 50 à la fois.
id	String	Oui	ID du champ de métadonnées utilisé pour l'identifier.
display_label	String	Non	Nouveau nom d'affichage, maximum 64. Modifié uniquement s'il est fourni.
description	String	Non	Nouvelle description du champ, maximum 50. Modifiée uniquement si elle est fournie.
ai_search_filter	Boolean	Non	Nouveau commutateur de filtre AI Search. Modifié uniquement s'il est fourni.

Réponse

Exemple de réponse

{ "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"
        }
    ]
}

Ce bloc de code dans la fenêtre flottante

Réponse réussie

Champ	Type	Description
success_count	Integer	Nombre de champs modifiés avec succès.
failure_count	Integer	Nombre de champs dont la modification a échoué.
results	Array<Object>	Résultats champ par champ, renvoyés dans l'ordre de la demande.
id	String	ID du champ.
success	Boolean	Indique si la modification a réussi.
error_message	String	Raison de l'échec : display_label already exists (le nom d'affichage est en conflit avec un nom existant) / duplicate id in request (id est répété dans la requête) / field not found (le champ n'existe pas).

Réponse d'erreur

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