Recupera e aggiorna la configurazione completa dell'agente AI tramite l'API REST.
Impostazioni del chatbot
Sezione intitolata “Impostazioni del chatbot”Recupera e aggiorna la configurazione completa dell’agente AI, incluse personalità, stile della conversazione e prompt di sistema.
Le impostazioni del comportamento si trovano in Identità > Personalità AI nella dashboard. I testi rivolti ai visitatori si trovano in Canali > Il tuo sito web > Contenuto testuale. La tabella seguente indica la posizione esatta di ogni impostazione.
Recuperare le impostazioni del chatbot
Sezione intitolata “Recuperare le impostazioni del chatbot”GET https://app.quickchat.ai/v1/api/chatbot_settings
curl https://app.quickchat.ai/v1/api/chatbot_settings \ -H 'Authorization: Bearer <API_TOKEN>'import requests
response = requests.get( url="https://app.quickchat.ai/v1/api/chatbot_settings", headers={"Authorization": "Bearer <API_TOKEN>"},)data = response.json()Risposta 200 OK
{ "personality": 0, "profession": "helpful_assistant", "creativity_level": 1, "greeting": "<p>Hello! How can I help you today?</p>", "greeting2": "", "header": "Support Assistant", "header2": "", "language_chosen": "en", "reply_length": 1, "one_word_description": "Support Agent", "short_description": "A helpful customer support assistant.", "ai_commands": ["Be polite", "Stay on topic"]}| Campo | Descrizione |
|---|---|
one_word_description stringa | Nome dell’agente AI. Dashboard: Identità > Personalità AI > Nome. L’API accetta fino a 200 caratteri; il campo nell’app è limitato a 40. |
short_description stringa | Il prompt principale (prompt di sistema). Dashboard: Identità > Personalità AI > Prompt principale. L’API accetta fino a 25.000 caratteri in ogni piano; l’editor nell’app applica il limite del piano, che parte da 15.000. |
ai_commands array di stringhe | Linee guida comportamentali per l’AI, una per elemento dell’array. Dashboard: Identità > Personalità AI > Linee guida. Fino a 250 elementi, 5.000 caratteri per elemento e 10.000 caratteri complessivi. |
personality intero (0–13) | Personalità AI predefinita. Dashboard: Identità > Personalità AI > Personalità. Vedi la tabella seguente |
profession stringa | Professione/ruolo dell’AI. Dashboard: Identità > Personalità AI > Ruolo (massimo 200 caratteri). Vedi la tabella seguente |
creativity_level intero (0–2) | Dashboard: Identità > Personalità AI > Creatività. 0 = Bassa, 1 = Normale, 2 = Alta |
reply_length intero (0–2) | Dashboard: Identità > Personalità AI > Lunghezza delle risposte. 0 = Breve, 1 = Normale, 2 = Più lunga |
greeting stringa | Messaggio di saluto principale (HTML). Dashboard: Canali > Il tuo sito web > Contenuto testuale > Messaggio di benvenuto (massimo 1000 caratteri). È lo stesso campo di welcome_message nella configurazione del widget. |
greeting2 stringa | Messaggio di saluto secondario (HTML). Disponibile tramite API; non ha un campo di modifica nella dashboard. |
header stringa | Testo dell’intestazione della chat. Dashboard: Canali > Il tuo sito web > Contenuto testuale > Testo dell’intestazione (massimo 200 caratteri) |
header2 stringa | Testo dell’intestazione secondaria (massimo 200 caratteri). Disponibile tramite API come header2 o come subtitle nella configurazione del widget; non ha un campo di modifica nella dashboard. |
language_chosen stringa | Codici lingua separati da virgole, per esempio "en,es,de". Dashboard: Identità > Personalità AI > Lingue (massimo 200 caratteri complessivi; i codici oltre il limite di 30 lingue vengono scartati) |
Valori della personalità:
| Valore | Etichetta | Descrizione |
|---|---|---|
| 0 | Classico | Versatile, bilancia professionalità e accessibilità (predefinito) |
| 1 | Spiritoso | Tono arguto con giochi di parole e battute per interazioni divertenti |
| 2 | Formale | Formale e serio, con informazioni fattuali concise per contesti aziendali |
| 3 | Amichevole | Conversazioni informali con un tocco personale e accessibile |
| 4 | Irriverente | Sicuro e giocoso, con umorismo |
| 5 | Intelligente | Informazioni dettagliate e accurate per una comprensione completa |
| 6 | Empatico | Interazioni premurose e comprensive, attente alle emozioni |
| 7 | Audace | Opinioni e raccomandazioni decise, comunicate con sicurezza |
| 9 | Entusiasta | Interazioni vivaci ed energiche |
| 10 | Misterioso | Risposte enigmatiche e intriganti per un’esperienza unica |
| 11 | Motivante | Promuove pensiero positivo e raggiungimento degli obiettivi con uno stile da coach |
| 12 | Avventuroso | Incoraggia a uscire dalla zona di comfort ed esplorare nuove opportunità |
| 13 | Elegante | Esperienza raffinata per brand unici e ricercati |
Valori del ruolo:
| Valore | Etichetta nella dashboard | Descrizione |
|---|---|---|
helpful_assistant | Assistente disponibile | Versatile e multiuso. Consigliato nella maggior parte dei casi |
customer_support_representative | Agente di assistenza | Empatico, offre soluzioni passo passo e aiuto nella risoluzione dei problemi |
shopping_assistant | Assistente agli acquisti | Offre attivamente consigli sui prodotti con link |
field_expert | Esperto di settore | Consulente professionale, pone domande di chiarimento e offre indicazioni specialistiche |
interviewer | Intervistatore | Pone domande anziché fornire risposte. Per sondaggi, interviste e feedback |
I campi one_word_description, short_description e ai_commands sono disponibili anche tramite l’endpoint Impostazioni della base di conoscenza. Sono campi condivisi: un aggiornamento tramite uno qualsiasi dei due endpoint modifica gli stessi dati sottostanti.
Aggiornare le impostazioni del chatbot
Sezione intitolata “Aggiornare le impostazioni del chatbot”PATCH https://app.quickchat.ai/v1/api/chatbot_settings
Corpo della richiesta: tutti i campi sono facoltativi. Includi solo quelli da aggiornare.
| Parametro | Descrizione |
|---|---|
personality intero (0–13) | Personalità AI predefinita |
profession stringa | Professione/ruolo dell’AI (massimo 200 caratteri) |
creativity_level intero (0–2) | 0 = Bassa, 1 = Normale, 2 = Alta |
greeting stringa | Messaggio di benvenuto principale (HTML, massimo 1000 caratteri) |
greeting2 stringa | Messaggio di benvenuto secondario |
header stringa | Testo dell’intestazione della chat (massimo 200 caratteri) |
header2 stringa | Testo dell’intestazione secondaria (massimo 200 caratteri) |
language_chosen stringa | Codici lingua separati da virgole (massimo 200 caratteri complessivi; i codici oltre il limite di 30 lingue vengono scartati) |
reply_length intero (0–2) | 0 = Breve, 1 = Normale, 2 = Più lunga |
one_word_description stringa | Nome dell’agente AI. Massimo 200 caratteri tramite API; il campo nell’app è limitato a 40. |
short_description stringa | Prompt principale dell’AI (prompt di sistema). L’API accetta fino a 25.000 caratteri in ogni piano; l’editor nell’app applica il limite del piano, che parte da 15.000. Un valore troppo lungo restituisce 422. |
ai_commands array di stringhe | Linee guida AI, una per elemento dell’array. Fino a 250 elementi, 5.000 caratteri per elemento e 10.000 caratteri complessivi. Un valore troppo lungo restituisce 422. |
Ogni elemento dell’array è una linea guida, salvata esattamente come la invii. La punteggiatura, inclusi i punti e virgola, viene preservata. In precedenza questo endpoint rimuoveva ; dal testo prima di salvarlo: se rimuovevi o sostituivi i punti e virgola per aggirare il problema, non è più necessario.
Ometti ai_commands oppure invia null per lasciare invariate le linee guida. Invia [] per cancellarle.
curl -X PATCH https://app.quickchat.ai/v1/api/chatbot_settings \ -H 'Authorization: Bearer <API_TOKEN>' \ -H 'Content-Type: application/json' \ -d '{ "greeting": "<p>Welcome! Ask me anything.</p>", "creativity_level": 2}'import requests
response = requests.patch( url="https://app.quickchat.ai/v1/api/chatbot_settings", headers={"Authorization": "Bearer <API_TOKEN>"}, json={ "greeting": "<p>Welcome! Ask me anything.</p>", "creativity_level": 2, },)data = response.json()Risposta 200 OK: restituisce le impostazioni aggiornate del chatbot, con lo stesso schema della risposta di Recuperare le impostazioni del chatbot.