Editar campos de metadatos

Permite editar campos de metadatos por lotes. Solo se pueden modificar display_label, description y ai_search_filter. Se actualizan únicamente los valores enviados; los demás permanecen sin cambios. Se pueden editar hasta 50 campos por solicitud.

Reglas de lotes:
Se puede editar un máximo de 50 a la vez y no se procesará el lote completo si supera los 50.
Si un id se repite en la solicitud, solo se procesa el primer elemento y los duplicados posteriores fallan.

Método de solicitud

PUT

Endpoint

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

Autenticación

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

Solicitud

Ejemplo de solicitud

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": "Categoría del documento", "description": "Categoría empresarial del documento", "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": "Categoría del documento",
            "description": "Categoría empresarial del documento",
            "ai_search_filter": false
        }
    ]
}'

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.
Content-Type	application/json	Tipo de datos, establecido en `application/json`.

Parámetros de solicitud

Campo	Tipo	Obligatorio	Descripción
fields	Array<Object>	Sí	Una lista de campos para editar, hasta 50 a la vez.
id	String	Sí	ID del campo de metadatos utilizado para localizarlo.
display_label	String	No	Nuevo nombre para mostrar, hasta 64 caracteres. Solo se modifica si se proporciona.
description	String	No	Nueva descripción de campo, máximo 50. Solo se modifica si se proporciona.
ai_search_filter	Boolean	No	Nuevo interruptor de filtro AI Search. Solo se modifica si se proporciona.

Respuesta

Ejemplo de respuesta

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

Este bloque de código en una ventana flotante

Respuesta correcta

Campo	Tipo	Descripción
success_count	Integer	Número de campos editados correctamente.
failure_count	Integer	El número de campos que no se pudieron editar.
results	Array<Object>	Resultados campo por campo, devueltos en el orden de solicitud.
id	String	ID del campo.
success	Boolean	Si la edición fue exitosa.
error_message	String	Motivo del error: display_label already exists (el nombre para mostrar entra en conflicto con uno existente) / duplicate id in request (id se repite en la solicitud) / field not found (el campo no existe).

Respuesta de error

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