Ενσωματώστε το chatbot σας με προσαρμοσμένα API
Χρησιμοποιώντας το πρόγραμμα επεξεργασίας ενεργειών AI, μπορείτε να δημιουργήσετε οποιαδήποτε προσαρμοσμένη ενοποίηση με οποιοδήποτε σύστημα backend που μπορεί να εκθέσει δεδομένα μέσω τελικών σημείων API. Για παράδειγμα, μπορείτε να κάνετε το chatbot να ελέγχει τη διαθεσιμότητα του προϊόντος στην αποθήκη σας, να ελέγχει την κατάσταση της παραγγελίας στο σύστημα ERP σας ή να ελέγχει το τρέχον υπόλοιπο στον λογαριασμό του πελάτη.
Μπορείτε επίσης να εκτελείτε ενέργειες για την ενημέρωση εξωτερικών συστημάτων - για παράδειγμα, να καλείτε τελικά σημεία που ορίζουν ραντεβού ή webhook.
Προαπαιτούμενα
ℹ️ Πριν ξεκινήσετε - βεβαιωθείτε ότι διαθέτετε συνδρομή ChatLab που επιτρέπει ενοποιήσεις Custom API. Ελέγξτε τη σελίδα τιμολόγησης
Προσθήκη προσαρμοσμένου API στο chatbot σας
Η ενοποίηση ενός προσαρμοσμένου API επιτρέπει στο chatbot σας να επικοινωνεί με εξωτερικές υπηρεσίες - για παράδειγμα, το προσαρμοσμένο κατάστημά σας, να ανακτά δεδομένα ή να εκτελεί ενέργειες εκ μέρους του χρήστη.
Αυτός ο οδηγός θα σας καθοδηγήσει στα βήματα που απαιτούνται για τη ρύθμιση ενός προσαρμοσμένου API χρησιμοποιώντας την πλατφόρμα ChatLab.
Το API σας
Πρέπει να διαθέτετε δημόσια προσβάσιμα τελικά σημεία API που μπορούν να κληθούν από το chatbot - αυτό σημαίνει ότι πρέπει να εκθέσετε δεδομένα από την πλατφόρμα ηλεκτρονικού εμπορίου σας ή το προσαρμοσμένο σας σύστημα μέσω τελικών σημείων API, ώστε το chatbot μας να μπορεί να καλέσει αυτά τα τελικά σημεία για να εξαγάγει αυτά τα δεδομένα και να τα παρέχει στους χρήστες σας.
Κλήση API από το chatbot
Το API θα καλείται δυναμικά από το chatbot κατά τη διάρκεια των αλληλεπιδράσεων με τους χρήστες, με βάση την ανάγκη του chatbot να αποκτήσει πρόσβαση σε εξωτερικά δεδομένα ή να εκτελέσει συγκεκριμένες ενέργειες. Είναι σημαντικό να σημειωθούν τα εξής:
-
Καμία εγγυημένη κλήση: Το API θα καλείται μόνο όταν η λογική του chatbot κρίνει ότι είναι απαραίτητο. Δεν υπάρχουν εγγυήσεις σχετικά με το πότε ή πόσο συχνά θα καλείται το API.
-
Απαιτήσεις μοντέλου AI: Για βέλτιστη απόδοση, συνιστάται η χρήση μοντέλων AI ανώτερης κατηγορίας που υποστηρίζουν σύνθετη κλήση συναρτήσεων (function calling), όπως το GPT-4o ή νεότερο. Αυτά τα μοντέλα είναι πιο ικανά να προσδιορίζουν τις κατάλληλες στιγμές για την κλήση του API με βάση το πλαίσιο της συνομιλίας και την πρόθεση του χρήστη.
-
Κλήσεις με επίγνωση πλαισίου: Το chatbot θα προσπαθεί να καλέσει το API κάθε φορά που εντοπίζει ένα πλαίσιο στη συνομιλία που ευθυγραμμίζεται με τον σκοπό του API, αλλά η πραγματική κλήση θα εξαρτηθεί από πολλαπλούς παράγοντες, όπως:
- Διαθεσιμότητα και ταχύτητα απόκρισης του εξωτερικού API.
- Η τρέχουσα κατάσταση της συνομιλίας και τα prompt του χρήστη.
- Εσωτερικά επίπεδα βεβαιότητας και αλγόριθμοι βαθμολόγησης του μοντέλου AI κατά τη λήψη απόφασης για την αναγκαιότητα της κλήσης.
Βήματα για τη ρύθμιση Custom API
Βήμα 1: Μεταβείτε στις ρυθμίσεις Custom API
-
Συνδεθείτε στον πίνακα ελέγχου του ChatLab.
-
Στην αριστερή πλαϊνή γραμμή, στην ενότητα Settings (Ρυθμίσεις), κάντε κλικ στο Custom API.
Βήμα 2: Ορίστε ένα νέο API
-
Κάντε κλικ στο κουμπί + Define API (+ Ορισμός API).
-
Εισαγάγετε ένα όνομα για το API σας στο πεδίο API Name (Όνομα API).
-
Καταχωρίστε τη βασική διεύθυνση URL της εξωτερικής υπηρεσίας στην οποία θέλετε να συνδεθείτε στο πεδίο URL.
-
Κάντε κλικ στο Save (Αποθήκευση) για να δημιουργήσετε το API.
Βήμα 3: Προσθέστε λειτουργίες API
-
Στη νεοδημιουργηθείσα καταχώριση API, κάντε κλικ στο κουμπί View (Προβολή).
-
Κάντε κλικ στο + Define API Operation (+ Ορισμός λειτουργίας API) για να ρυθμίσετε μεμονωμένες λειτουργίες (τελικά σημεία) για το API.
-
Συμπληρώστε τα απαιτούμενα στοιχεία:
- Operation Name: Ένα περιγραφικό όνομα για τη λειτουργία.
- Operation URI: Η διαδρομή του τελικού σημείου για τη λειτουργία (π.χ.
/v1/resource).
Βήμα 4: Διαμορφώστε το URI και τις παραμέτρους του τελικού σημείου
- Διαμόρφωση URI τελικού σημείου:
- Προσθέστε τυχόν μεταβλητές διαδρομής που απαιτούνται για τη λειτουργία κάνοντας κλικ στο + Add path variable (+ Προσθήκη μεταβλητής διαδρομής).
- Εισαγάγετε τα στοιχεία της μεταβλητής και επισημάνετέ τα ως υποχρεωτικά, εάν είναι απαραίτητο.
- Επιλέξτε την πηγή τιμής:
- Provided by user to chatbot - σε περίπτωση που απαιτείται κάποια τιμή από τον χρήστη για τη συμπλήρωσή της.
- Constant - σε περίπτωση που πρόκειται για σταθερή τιμή την οποία θα πρέπει να καταχωρίσετε κατά τον ορισμό της λειτουργίας API
- προσθέστε τη νεοπροστιθέμενη μεταβλητή διαδρομής στον ορισμό της διαδρομής ανάμεσα σε δύο σύμβολα «@»: @myvariable@:
- Παράμετροι ερωτήματος (Query Parameters):
- Προσθέστε τυχόν παραμέτρους ερωτήματος κάνοντας κλικ στο + Add query parameter (+ Προσθήκη παραμέτρου ερωτήματος).
- Ορίστε το όνομα της παραμέτρου, τον τύπο δεδομένων και την πηγή (π.χ. παρέχεται από τον χρήστη ή το chatbot).
Βήμα 5: Ορίστε τη μέθοδο και το σώμα αιτήματος
-
Επιλέξτε τη μέθοδο HTTP για τη λειτουργία (π.χ. GET, POST).
-
Εάν η μέθοδος αιτήματος είναι POST, διαμορφώστε το σώμα αιτήματος (request body):
- Επιλέξτε τον τύπο περιεχομένου (π.χ.
application/json). - Προσθέστε τις παραμέτρους σώματος, καθορίζοντας το όνομα, τον τύπο δεδομένων και την πηγή.
- Προσθέστε τις μεταβλητές στον ορισμό του σώματος - συνήθως είναι ένα json στο οποίο μπορείτε να τοποθετήσετε τις μεταβλητές που έχετε ορίσει
Βήμα 6: Ορίστε τις κεφαλίδες λειτουργίας
Προσθέστε κεφαλίδες - δηλ. Authorization ή άλλες που απαιτούνται από το API σας. Ρίξτε μια ματιά στο παρακάτω στιγμιότυπο οθόνης για τη ρύθμιση μόνιμου διακριτικού στην κεφαλίδα Authorization:
Βήμα 7: Αποθηκεύστε τη λειτουργία
-
Ελέγξτε τη διαμόρφωση για να βεβαιωθείτε ότι όλα τα στοιχεία είναι σωστά.
-
Κάντε κλικ στο Save changes (Αποθήκευση αλλαγών) για να αποθηκεύσετε τη λειτουργία API.
Βήμα 8: Δοκιμάστε την ενοποίηση του API
-
Χρησιμοποιήστε τη λειτουργία Test API (Δοκιμή API) για να στείλετε ένα δοκιμαστικό αίτημα και να βεβαιωθείτε ότι η ενοποίηση λειτουργεί σωστά.
-
Παρακολουθήστε τα αρχεία καταγραφής για τυχόν σφάλματα ή προβλήματα και προσαρμόστε τη διαμόρφωση όπως απαιτείται.
Βήμα 9: Συνδέστε τις λειτουργίες API με το chatbot
Μόλις ορίσετε τις API Operations (Λειτουργίες API), ήρθε η ώρα να τις αντιστοιχίσετε στο chatbot. Επιλέξτε το chatbot στον κύριο πίνακα ελέγχου των chatbot, κάντε κλικ στο Integrations (Ενοποιήσεις) και επιλέξτε AI API Actions (Ενέργειες AI API) στο αριστερό μενού
Κάντε κλικ στο Attach (Σύνδεση) στην επιλεγμένη λειτουργία API
Βήμα 10: Προσθέστε οδηγίες ρόλου για το chatbot
Επιλέξτε το chatbot σας στον κύριο πίνακα ελέγχου των chatbot, κάντε κλικ στο Settings (Ρυθμίσεις) και στο αριστερό μενού επιλέξτε Role (Ρόλος)
Κάντε κλικ στο Provide custom role instructions (Παροχή προσαρμοσμένων οδηγιών ρόλου).
Προσθέστε οδηγίες σχετικά με τη χρήση της πρόσφατα προστιθέμενης λειτουργίας API. Για παράδειγμα, μπορείτε να προσθέσετε έναν κανόνα:
«- Όταν ο χρήστης ρωτά για το απόθεμα του καταστήματος, να καλείτε πάντα τη συνάρτηση getItems και να αποδίδετε το αποτέλεσμα της συνάρτησης με τους ακόλουθους κανόνες…..»
Συμβουλές για επιτυχημένη ενοποίηση
-
Βεβαιωθείτε ότι η βασική διεύθυνση URL και τα τελικά σημεία είναι σωστά και προσβάσιμα.
-
Επαληθεύστε ότι τυχόν απαιτήσεις ελέγχου ταυτότητας (όπως κλειδιά API ή διακριτικά) έχουν ρυθμιστεί σωστά.
-
Δοκιμάστε διεξοδικά κάθε λειτουργία για να βεβαιωθείτε ότι επιστρέφει τις αναμενόμενες αποκρίσεις.
Ακολουθώντας αυτά τα βήματα, μπορείτε να ενσωματώσετε απρόσκοπτα προσαρμοσμένα API στο chatbot σας στο ChatLab, αναβαθμίζοντας τη λειτουργικότητά του και παρέχοντας μια πιο πλούσια εμπειρία χρήστη.
Προστασία της προσαρμοσμένης ενοποίησης API
Για να διασφαλίσετε ότι το προσαρμοσμένο API σας είναι ασφαλές και προστατευμένο από μη εξουσιοδοτημένη πρόσβαση, λάβετε υπόψη τις ακόλουθες βέλτιστες πρακτικές:
Χρήση σταθερών διακριτικών (Constant Tokens)
Σταθερά διακριτικά API: Ρυθμίστε ένα σταθερό διακριτικό (ή κλειδί) API που απαιτείται για όλα τα αιτήματα προς το API. Αυτό το διακριτικό θα πρέπει να είναι μοναδικό και να δημιουργείται με ασφάλεια.
-
Τρόπος υλοποίησης: Συμπεριλάβετε το διακριτικό στην κεφαλίδα αιτήματος ή ως παράμετρο ερωτήματος σε κάθε κλήση API.
-
Πού να το αποθηκεύσετε: Αποθηκεύστε το διακριτικό με ασφάλεια στις ρυθμίσεις του ChatLab ως σταθερή παράμετρο της λειτουργίας
Χρησιμοποιήστε τελικό σημείο σύνδεσης για προσωρινά διακριτικά
Προσθέστε μια επιπλέον λειτουργία API στο API που επιστρέφει προσωρινό διακριτικό ασφαλείας - δηλ. τελικό σημείο σύνδεσης στο σύστημά σας.
Θα χρειαστεί να καταχωρίσετε τα διαπιστευτήρια σύνδεσής σας που αντιστοιχούν στο σύστημά σας ως σταθερές παραμέτρους λειτουργίας API κατά τον ορισμό αυτής της λειτουργίας API. Προκειμένου το chatbot να μπορεί να χρησιμοποιήσει το διακριτικό που αποκτήθηκε με αυτόν τον τρόπο, πρέπει να προσθέσετε το διακριτικό ασφαλείας στους ορισμούς άλλων λειτουργιών API και να προσθέσετε κατάλληλες οδηγίες prompt τόσο στη λειτουργία σύνδεσης όσο και στις άλλες λειτουργίες API (Για παράδειγμα: «Να χρησιμοποιείτε πάντα το διακριτικό ασφαλείας που αποκτήθηκε από τη λειτουργία Login ως παράμετρο security_token για τη λειτουργία getOrder»).
Έλεγχος ευαίσθητων πληροφοριών μέσω του ChatLab
Για να αποτρέψουν την εμφάνιση ευαίσθητων πληροφοριών από το chatbot, οι χρήστες του ChatLab μπορούν να προβούν στις ακόλουθες ενέργειες:
Χρησιμοποιήστε μηχανική prompt (Prompt Engineering) για να κατευθύνετε τη συμπεριφορά του AI
-
Ορίστε σαφείς οδηγίες στα prompt: Κατά τη διαμόρφωση του chatbot, παρέχετε ρητές οδηγίες στις ρυθμίσεις prompt ώστε να αποφεύγεται η εμφάνιση ευαίσθητων πληροφοριών. Για παράδειγμα:
- Παράδειγμα prompt: «Μην εμφανίζετε προσωπικές, οικονομικές ή εμπιστευτικές πληροφορίες που επιστρέφονται από μια κλήση API.»
- Χρήση μηνυμάτων συστήματος: Συμπεριλάβετε ένα μήνυμα συστήματος στην αρχή της ροής συνομιλίας για να ενισχύσετε τη σημασία του απορρήτου δεδομένων (π.χ. «Βεβαιωθείτε ότι όλα τα αποτελέσματα αποκλείουν τυχόν ευαίσθητες πληροφορίες.»).
-
Ενημερώνετε τακτικά τα prompt: Προσαρμόστε τα prompt με βάση τα σχόλια των χρηστών ή τις αλλαγές στις απαιτήσεις ευαισθησίας δεδομένων. Αυτό συμβάλλει στη διασφάλιση ότι το AI ακολουθεί με συνέπεια τις πιο πρόσφατες οδηγίες σχετικά με τον χειρισμό ευαίσθητων πληροφοριών.
Σχεδιάστε τελικά σημεία API με ενσωματωμένη λογική επαλήθευσης
-
Απαιτήστε επαλήθευση χρήστη για πρόσβαση σε ευαίσθητα δεδομένα: Σχεδιάστε τα τελικά σημεία του API σας ώστε να περιλαμβάνουν ελέγχους επαλήθευσης πριν από την επιστροφή ευαίσθητων δεδομένων. Για παράδειγμα:
- Παράμετροι επαλήθευσης: Απαιτήστε από τους χρήστες να παρέχουν ορισμένες πληροφορίες (όπως διεύθυνση email, αριθμό παραγγελίας ή μια συγκεκριμένη ερώτηση ασφαλείας) προτού το API επιστρέψει δεδομένα που σχετίζονται με αυτόν τον χρήστη.
- Επαλήθευση πολλαπλών παραγόντων: Υλοποιήστε πρόσθετες παραμέτρους (π.χ. ημερομηνία παραγγελίας, διεύθυνση αποστολής ή μυστικό κωδικό) για να επαληθεύσετε την ταυτότητα του χρήστη και να διασφαλίσετε ότι είναι εξουσιοδοτημένος να έχει πρόσβαση στα δεδομένα.
-
Εφαρμόστε ασφαλείς αποκρίσεις σε περίπτωση αποτυχίας (Fail-Safe Responses): Ρυθμίστε τη λογική του API σας ώστε να επιστρέφει γενικά μηνύματα ή σφάλματα εάν η απαιτούμενη επαλήθευση δεν παρασχεθεί ή δεν ταιριάζει:
- Παράδειγμα: «Δεν είναι δυνατή η ανάκτηση των στοιχείων της παραγγελίας. Επαληθεύστε το email και τον αριθμό παραγγελίας σας.»
Χρησιμοποιήστε περιορισμένα πεδία δεδομένων στις αποκρίσεις API
- Ελαχιστοποιήστε την έκθεση δεδομένων: Διαμορφώστε τις αποκρίσεις API ώστε να περιλαμβάνουν μόνο τα απαραίτητα δεδομένα για τη λειτουργία του chatbot, μειώνοντας τον κίνδυνο ακούσιας εμφάνισης ευαίσθητων πληροφοριών.
- Παράδειγμα: Αντί να επιστρέφετε πλήρη προφίλ χρηστών, επιστρέψτε μόνο συγκεκριμένα πεδία όπως την κατάσταση παραγγελίας ή την επιβεβαίωση πληρωμής που απαιτούνται για την εργασία του chatbot.