Modifica conoscenza base

L'API fornisce la modifica della Knowledge base inviando una richiesta POST all'endpoint /chat/Chatbot/EditKnowledge.

Endpoint

URL della Richiesta: https://app.neoagent.co/chat/Chatbot/EditKnowledge
Metodo: POST

Corpo della Richiesta

Il corpo della richiesta deve contenere i seguenti parametri:

{
// stringa, obbligatoria - Identificatore univoco (ID) del chatbot
"serialNumber": "3254a9d0424c4806b9ea3d0763ccf1bf",
// stringa, facoltativa - URL della mappa del sito
"SiteMapUrl": "",
// booleano, facoltativo - Se abilitare la sincronizzazione della mappa del sito
"EnableSyncSiteMap": false,
// intero, obbligatorio quando EnableSyncSiteMap è true - Frequenza di sincronizzazione (Mensile: 30, Settimanale: 7, Giornaliera: 1)
"SyncSiteMapDays": 0,
// array di stringhe, facoltativo - Elenco degli ID file
"fileList": [
"34322",
"34321"
],
// stringa, facoltativa - Contenuto di testo da aggiungere
"text": "111111111",
// stringa, facoltativa - URL del foglio di calcolo Google
"googleSheetUrl": "",
// booleano, facoltativo - Se riaddestrare utilizzando i dati di Google Sheet
"isRetrainGoogleSheet": true,
// array di oggetti, facoltativo - Elenco dei siti web da scansionare
"websiteList": [
{
"url": "https://www.google.com",
"retrain": false
}
],
// array di oggetti, facoltativo - Elenco delle coppie di domande e risposte
"qaList": [
{
"key": "Domanda",
"value": "Risposta"
}
]
}

Parametri

• serialNumber - stringa, obbligatorio - Identificatore univoco (ID) del chatbot
• SiteMapUrl - stringa, facoltativo - URL della mappa del sito
• EnableSyncSiteMap - booleano, facoltativo - Se abilitare la sincronizzazione della mappa del sito
• SyncSiteMapDays - intero, obbligatorio quando EnableSyncSiteMap è impostato su true - Frequenza di sincronizzazione (Mensile: 30, Settimanale: 7, Giornaliera: 1)
• fileList - array di stringhe, facoltativo - Elenco degli ID file
• text - stringa, facoltativo - Contenuto di testo da aggiungere
• googleSheetUrl - stringa, facoltativo - URL del Foglio Google
• isRetrainGoogleSheet - booleano, facoltativo - Se riaddestrare utilizzando i dati del Foglio Google
• websiteList - array di oggetti, facoltativo - Elenco dei siti web da scansionare
• websiteList[].url - stringa - URL del sito web
• websiteList[].retrain - booleano - Se riaddestrare utilizzando questo sito web
• qaList - array di oggetti, facoltativo - Elenco delle coppie di domande e risposte
• qaList[].key - stringa - Domanda
• qaList[].value - stringa - Risposta

Headers richiesti

La richiesta API deve includere i seguenti header:

• Authorization: <Your-Secret-Key> - string, obbligatorio - La chiave segreta per autenticare la richiesta API
• Content-Type: application/json - string, obbligatorio - Il tipo di contenuto del payload della richiesta (deve essere application/json)

Esempi di Richiesta

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

Risposta

La risposta API sarà un oggetto JSON con la seguente struttura:

{
  // boolean - Operation success status
  "Data": true,
  // string - API version
  "Version": "1.0.0",
  // boolean - Operation success status
  "Success": true,
  // integer - HTTP status code
  "Code": 200,
  // string - Error message if any
  "Message": ""
}

Gestione degli Errori

Se la richiesta fallisce, dovresti:

1. Controllare il codice di stato HTTP per errori a livello di rete
2. Esaminare i campi Code e Message nella risposta per errori a livello business
3. Il campo Message conterrà informazioni dettagliate sull'errore