Eliminar campos de metadatos

Permite eliminar campos de metadatos por lotes mediante sus ID. Los campos predefinidos por el sistema no se pueden eliminar. Se pueden eliminar hasta 50 campos por solicitud. ids se envía como parámetro de consulta de la URL, con los ID separados por comas, y no en el cuerpo de la solicitud.

Método de solicitud

DELETE

Endpoint

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

Autenticación

Para obtener información sobre la autenticación, consulte Visión general de la API.

Solicitud

Ejemplo de solicitud

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

Este bloque de código en una ventana flotante

Encabezados de solicitud

Campo	Tipo	Descripción
Authorization	Bearer ${API Key}	Autentíquese con `Authorization: Bearer ${API Key}`. Obtenga la API Key en la página de claves API.

Parámetros de solicitud

Campo	Tipo	Obligatorio	Descripción
ids	String	Sí	ID de campos separados por comas, hasta 50 por solicitud.

Respuesta

Ejemplo de respuesta

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

Este bloque de código en una ventana flotante

Respuesta correcta

Campo	Tipo	Descripción
success_count	Integer	Número de campos eliminados correctamente.
failure_count	Integer	Número de campos que no se pudieron eliminar.
results	Array<Object>	Resultado de eliminación de cada ID.
id	String	ID del campo.
success	Boolean	Si la eliminación fue exitosa.
error_message	String	Motivo del error: field not found (el campo no existe) / predefined field cannot be deleted (los campos preestablecidos no se pueden eliminar).

Respuesta de error

Campo	Tipo	Descripción
code	Integer	Código de error.
message	String	Detalles del error.