Obtener la lista de campos de metadatos

Obtiene las definiciones de los campos de metadatos del Agent, agrupadas en campos globales y campos exclusivos de cada base de conocimientos. Los campos predefinidos por el sistema, como document_name, no se devuelven.

Método de solicitud

GET

Endpoint

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

Autenticación

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

Solicitud

Ejemplo de solicitud

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

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

No se requieren parámetros. El Agent se identifica mediante la API Key.

Respuesta

Ejemplo de respuesta

{ "global_fields": [ { "id": "665f1c8a9b2e4d001a3f0001", "name": "category", "display_name": "Categoría", "type": "LIST", "options": ["Técnico", "Producto"], "description": "Categoría del documento", "ai_search_filter": true, "is_predefined": false } ], "knowledge_bases": [ { "knowledge_base_id": "kb_001", "knowledge_base_name": "Documentación del producto", "fields": [ { "id": "665f1c8a9b2e4d001a3f0009", "name": "product_line", "display_name": "Línea de productos", "type": "STRING", "options": null, "description": "", "ai_search_filter": false, "is_predefined": false } ] }, { "knowledge_base_id": "kb_002", "knowledge_base_name": "Preguntas frecuentes posventa", "fields": [] } ] }

                      
                      {
    "global_fields": [
        {
            "id": "665f1c8a9b2e4d001a3f0001",
            "name": "category",
            "display_name": "Categoría",
            "type": "LIST",
            "options": ["Técnico", "Producto"],
            "description": "Categoría del documento",
            "ai_search_filter": true,
            "is_predefined": false
        }
    ],
    "knowledge_bases": [
        {
            "knowledge_base_id": "kb_001",
            "knowledge_base_name": "Documentación del producto",
            "fields": [
                {
                    "id": "665f1c8a9b2e4d001a3f0009",
                    "name": "product_line",
                    "display_name": "Línea de productos",
                    "type": "STRING",
                    "options": null,
                    "description": "",
                    "ai_search_filter": false,
                    "is_predefined": false
                }
            ]
        },
        {
            "knowledge_base_id": "kb_002",
            "knowledge_base_name": "Preguntas frecuentes posventa",
            "fields": []
        }
    ]
}

Este bloque de código en una ventana flotante

Respuesta correcta

Campo	Tipo	Descripción
global_fields	Array<Object>	Campos globales aplicables a todos los documentos del Agent.
id	String	ID del campo, utilizado para editarlo o eliminarlo.
name	String	Identificador interno de campo, minúscula, único.
display_name	String	Nombre para mostrar del campo, único.
type	String	Tipo de campo: STRING / NUMBER / DATETIME / LIST.
options	Array<String>	Opciones de enumeración para el tipo LIST; para los demás tipos es null.
description	String	Descripción del campo.
ai_search_filter	Boolean	Indica si el campo se utiliza como filtro de AI Search.
is_predefined	Boolean	Si se trata de un campo preestablecido del sistema.
knowledge_bases	Array<Object>	Cada base de conocimiento y sus campos exclusivos.
knowledge_base_id	String	ID de la base de conocimientos.
knowledge_base_name	String	Nombre de la base de conocimientos.
fields	Array<Object>	Campos exclusivos de esta base de conocimientos; su estructura es la misma que la de global_fields.

Respuesta de error

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