Obtén conocimiento básico

La API para obtener los modelos de app.neoagent.co proporciona la funcionalidad para crear un nuevo chatbot enviando una solicitud POST al endpoint /chat/Chatbot/GetSource.

Endpoint

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

Cuerpo de la Solicitud

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

{
  // string, requerido - El identificador único (ID) del chatbot
  "serialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx"
}

Parámetros

• serialNumber - string, obligatorio - El identificador único (ID) del chatbot a eliminar

Headers requeridos

La solicitud API debe incluir los siguientes encabezados:

• Authorization: <Your-Secret-Key> - string, obligatorio - La clave secreta para autenticar la solicitud API
• Content-Type: application/json - string, obligatorio - 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/GetSource'
headers = {
    "Authorization": "<Your-Secret-Key>",
    "Content-Type": "application/json"
}
data = {
  "serialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx"
}

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

cURL

curl 'https://app.neoagent.co/chat/Chatbot/GetSource' \
  -X POST \
  -H 'Authorization: <Your-Secret-Key>' \
  -H 'Content-Type: application/json' \
  -d '{"serialNumber":"3254a9d0424c4806b9ea3d0763xxxxxx"}'

HTTP Raw

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

{
  "serialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx"
}

Respuesta

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

{
  // array - Lista de elementos de conocimiento
  "Data": [
    {
      "Type": "FileList",
      "Name": "34321",
      "Value": "FAQ_0403.txt",
      "Length": 12043,
      "Status": 2,
      "StatusMessage": "Succeeded",
      "ID": 377631,
      "SourceLink": ""
    },
    {
      "Type": "CompanyInfo",
      "Name": "CompanyInfo",
      "Value": "",
      "Length": 286,
      "Status": 2,
      "StatusMessage": "Succeeded",
      "ID": 377634,
      "SourceLink": ""
    },
    {
      "Type": "UrlList",
      "Name": "www.example.com",
      "Value": "",
      "Length": 0,
      "Status": 3,
      "StatusMessage": "Failed",
      "ID": 377635,
      "SourceLink": "www.example.com"
    },
    {
      "Type": "Text",
      "Name": "111111111",
      "Value": "",
      "Length": 9,
      "Status": 2,
      "StatusMessage": "Succeeded",
      "ID": 377636,
      "SourceLink": ""
    },
    {
      "Type": "QAList",
      "Name": "Question",
      "Value": "Answer",
      "Length": 9,
      "Status": 2,
      "StatusMessage": "Succeeded",
      "ID": 377627,
      "SourceLink": ""
    }
  ],
  // string - versión de la API
  "Version": "1.0.0",
  // boolean - Estado de éxito de la operación
  "Success": true,
  // integer - código de estado HTTP
  "Code": 200,
  // string - Mensaje de error, si lo hay
  "Message": ""
}

Gestión de Errores

Si la solicitud falla, debes:

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