Modifica la base de conocimiento

La API proporciona la modificación de la base de conocimiento enviando una solicitud POST al endpoint /chat/Chatbot/EditKnowledge.

Endpoint

URL de la Solicitud: https://app.neoagent.co/chat/Chatbot/EditKnowledge
Método: POST

Cuerpo de la Solicitud

El cuerpo de la solicitud debe contener los siguientes parámetros:

{
// cadena, obligatoria - Identificador único (ID) del chatbot
"serialNumber": "3254a9d0424c4806b9ea3d0763ccf1bf",
// cadena, opcional - URL del mapa del sitio
"SiteMapUrl": "",
// booleano, opcional - Si habilitar la sincronización del mapa del sitio
"EnableSyncSiteMap": false,
// entero, obligatorio cuando EnableSyncSiteMap es true - Frecuencia de sincronización (Mensual: 30, Semanal: 7, Diaria: 1)
"SyncSiteMapDays": 0,
// array de cadenas, opcional - Lista de IDs de archivos
"fileList": [
"34322",
"34321"
],
// cadena, opcional - Contenido de texto a agregar
"text": "111111111",
// cadena, opcional - URL de la hoja de cálculo de Google
"googleSheetUrl": "",
// booleano, opcional - Si reentrenar utilizando los datos de Google Sheet
"isRetrainGoogleSheet": true,
// array de objetos, opcional - Lista de sitios web a escanear
"websiteList": [
{
"url": "https://www.google.com",
"retrain": false
}
],
// array de objetos, opcional - Lista de pares de preguntas y respuestas
"qaList": [
{
"key": "Pregunta",
"value": "Respuesta"
}
]
}

Parámetros

• serialNumber - cadena, obligatoria - Identificador único (ID) del chatbot
• SiteMapUrl - cadena, opcional - URL del mapa del sitio
• EnableSyncSiteMap - booleano, opcional - Si habilitar la sincronización del mapa del sitio
• SyncSiteMapDays - entero, obligatorio cuando EnableSyncSiteMap está configurado en true - Frecuencia de sincronización (Mensual: 30, Semanal: 7, Diaria: 1)
• fileList - array de cadenas, opcional - Lista de IDs de archivos
• text - cadena, opcional - Contenido de texto a agregar
• googleSheetUrl - cadena, opcional - URL de la Hoja de Google
• isRetrainGoogleSheet - booleano, opcional - Si reentrenar utilizando los datos de la Hoja de Google
• websiteList - array de objetos, opcional - Lista de sitios web a escanear
• websiteList[].url - cadena - URL del sitio web
• websiteList[].retrain - booleano - Si reentrenar utilizando este sitio web
• qaList - array de objetos, opcional - Lista de pares de preguntas y respuestas
• qaList[].key - cadena - Pregunta
• qaList[].value - cadena - Respuesta

Headers requeridos

La solicitud API debe incluir los siguientes encabezados:

• Authorization: <Your-Secret-Key> - cadena, obligatoria - La clave secreta para autenticar la solicitud API
• Content-Type: application/json - cadena, obligatoria - El tipo de contenido del payload de la solicitud (debe ser application/json)

Ejemplos de Solicitud

JavaScript (Fetch API)

const res = await fetch('https://app.neoagent.co/chat/Chatbot/GetSource', {
  method: 'POST',
  headers: {
  "Authorization": "<Your-Secret-Key>",
  "Content-Type": "application/json"
},
  body: JSON.stringify({
  "serialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx"
})
});

const data = await res.json();
console.log(data);

Python (Requests)

import requests
import json

url = 'https://app.neoagent.co/chat/Chatbot/EditKnowledge'
headers = {
    "Authorization": "<Your-Secret-Key>",
    "Content-Type": "application/json"
}
data = {
  "serialNumber": "3254a9d0424c4806b9ea3d0763ccf1bf",
  "fileList": [
    "34322",
    "34321"
  ]
}

response = requests.post(url, headers=headers, json=data)
data = response.json()
print(data)

cURL

curl 'https://app.neoagent.co/chat/Chatbot/EditKnowledge' \
  -X POST \
  -H 'Authorization: <Your-Secret-Key>' \
  -H 'Content-Type: application/json' \
  -d '{"serialNumber":"3254a9d0424c4806b9ea3d0763ccf1bf","fileList":["34322","34321"]}'

HTTP Raw

POST /chat/Chatbot/EditKnowledge HTTP/1.1
Host: app.neoagent.co
Authorization: <Your-Secret-Key>
Content-Type: application/json

{
  "serialNumber": "3254a9d0424c4806b9ea3d0763ccf1bf",
  "fileList": [
    "34322",
    "34321"
  ]
}

Respuesta

La respuesta de la API será un objeto JSON con la siguiente estructura:

{
  // booleano - Estado de éxito de la operación
  "Data": true,
  // cadena - Versión de la API
  "Version": "1.0.0",
  // booleano - Estado de éxito de la operación
  "Success": true,
  // entero - Código de estado HTTP
  "Code": 200,
  // cadena - Mensaje de error, si lo hay
  "Message": ""
}

Manejo de Errores

Si la solicitud falla, debes:

1. Verificar el código de estado HTTP para errores a nivel de red
2. Examinar los campos Code y Message en la respuesta para errores a nivel comercial
3. El campo Message contendrá información detallada sobre el error