logo
Développement
Rechercher
Supprimer les champs de métadonnées

Supprimer les champs de métadonnées

Supprimez des champs de métadonnées par lots à partir de leurs ID. Les champs prédéfinis par le système ne peuvent pas être supprimés. Une requête peut supprimer jusqu'à 50 champs. ids est transmis comme paramètre de requête URL, avec les ID séparés par des virgules, et non dans le corps de la requête.

Méthode de requête

DELETE

Endpoint

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

Authentification

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

Requête

Exemple de requête

curl -X DELETE 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/field/delete?ids=665f1c8a9b2e4d001a3f0001,665f1c8a9b2e4d001a3f0002' \ -H 'Authorization: Bearer ${API Key}'
                      
                      curl -X DELETE 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/field/delete?ids=665f1c8a9b2e4d001a3f0001,665f1c8a9b2e4d001a3f0002' \
-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

Champ Type Obligatoire Description
ids String Oui ID de champs séparés par des virgules, jusqu'à 50 par requête.

Réponse

Exemple de réponse

{ "success_count": 1, "failure_count": 2, "results": [ { "id": "665f1c8a9b2e4d001a3f0001", "success": true }, { "id": "665f1c8a9b2e4d001a3f0003", "success": false, "error_message": "field not found" }, { "id": "665f1c8a9b2e4d001a3f0004", "success": false, "error_message": "predefined field cannot be deleted" } ] }
                      
                      {
    "success_count": 1,
    "failure_count": 2,
    "results": [
        {
            "id": "665f1c8a9b2e4d001a3f0001",
            "success": true
        },
        {
            "id": "665f1c8a9b2e4d001a3f0003",
            "success": false,
            "error_message": "field not found"
        },
        {
            "id": "665f1c8a9b2e4d001a3f0004",
            "success": false,
            "error_message": "predefined field cannot be deleted"
        }
    ]
}

                    
Ce bloc de code dans la fenêtre flottante

Réponse réussie

Champ Type Description
success_count Integer Nombre de champs supprimés avec succès.
failure_count Integer Nombre de champs dont la suppression n'a pas abouti.
results Array<Object> Résultat de suppression pour chaque ID.
id String ID du champ.
success Boolean Si la suppression a réussi.
error_message String Raison de l'échec : field not found (le champ n'existe pas) / predefined field cannot be deleted (les champs prédéfinis ne peuvent pas être supprimés).

Réponse d'erreur

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