Προδιαγραφή API
Τεκμηρίωση αναφοράς για ενσωματώσεις σε ροές εργασίας κειμένου, πρακτόρων, πολυμέσων και ανάκτησης πληροφοριών.
https://cicora.ai/api/v1https://cicora.ai/apiΑναφορά ενσωμάτωσης: επιλέξτε παραμέτρους και διαθέσιμες δυνατότητες από τις ρυθμίσεις API του λογαριασμού σας και τον κατάλογο μοντέλων για το περιβάλλον σας.
Αποστολή πρώτου αιτήματοςΠρώτα βήματα
Στείλτε ένα πρώτο αίτημα, επιλέξτε μοντέλο από τον κατάλογο και διατηρήστε ένα αναγνωριστικό αιτήματος για διάγνωση.
Έλεγχος ταυτότηταςΣτείλτε ένα κλειδί API σε κεφαλίδα Bearer και διατηρήστε τα διαπιστευτήρια παραγωγής χωριστά από τα διαπιστευτήρια ανάπτυξης.
SDK και πελάτες HTTPΧρησιμοποιήστε διαφορετικές βασικές διευθύνσεις URL για πελάτες τύπου OpenAI και Messages: στοχεύουν μία προδιαγραφή, αλλά συνθέτουν διαφορετικά τις διαδρομές.
CLI και ενσωματώσειςΔιαμορφώστε έναν πελάτη με κλειδί, μοντέλο και βασική διεύθυνση URL που αντιστοιχεί στο πρωτόκολλό του· διατηρήστε το μυστικό στο περιβάλλον.
Συχνές ερωτήσεις προγραμματιστώνΣύντομες πρακτικές απαντήσεις σχετικά με κλειδιά, βασικές διευθύνσεις URL, μοντέλα, κόστος και διάγνωση ενσωμάτωσης.
Λογαριασμός και κατάλογος
Δημιουργήστε την επιλογή μοντέλου από δεδομένα καταλόγου αντί για σκληρά κωδικοποιημένη λίστα στην εφαρμογή σας.
Ομάδες και κλειδιά APIΔιαχωρίστε κλειδιά, κατόχους, προϋπολογισμούς και ίχνη χρήσης μεταξύ εφαρμογών και χώρων εργασίας.
ΌριαΑντιμετωπίστε τα όρια κλειδιού, οργανισμού, μοντέλου και δρομολόγησης ως μέρος της ροής εργασίας χρήστη.
Χρήση και κόστοςΣυνδέστε τα μεταδεδομένα απάντησης και τα δικά σας αρχεία καταγραφής αιτημάτων με πραγματικές ενέργειες χρήστη.
Δεδομένα και απόρρητοΕλαχιστοποιήστε τα μεταδιδόμενα δεδομένα, διαχωρίστε το αναγνωριστικό τελικού χρήστη από το περιεχόμενο και ελέγξτε τη διατήρηση στο προϊόν σας.
Κείμενο και πράκτορες
Δημιουργήστε συνομιλίες πολλαπλών γύρων στη γνωστή μορφή μηνυμάτων και επιλέξτε μοντέλο για κάθε αίτημα.
Messages APIΧρησιμοποιήστε τη μορφή Messages για συνομιλίες με οδηγία συστήματος ανώτατου επιπέδου και ρητό όριο εξόδου.
Responses APIΧρησιμοποιήστε ένα αντικείμενο input όταν η εφαρμογή σας ωφελείται από τον χειρισμό στοιχείων εξόδου και ενεργειών σε ένα ενιαίο μοντέλο δεδομένων.
ΡοήΛάβετε tokens και δομημένα τμήματα μέσω SSE χωρίς να περιμένετε την πλήρη απάντηση.
Εργαλεία και κλήση συναρτήσεωνΠεριγράψτε συναρτήσεις με JSON Schema, εκτελέστε την κλήση στην εφαρμογή σας και επιστρέψτε το αποτέλεσμα στη συνομιλία.
Δομημένες έξοδοιΖητήστε αντικείμενο JSON ή JSON Schema όταν την απάντηση θα καταναλώσει λογισμικό και όχι άνθρωπος.
ΣυλλογισμόςΟρίστε την ένταση συλλογισμού ανά αίτημα μόνο για μοντέλα που δηλώνουν αυτή τη δυνατότητα.
ΔρομολόγησηΕκφράστε τις απαιτήσεις εκτέλεσης στις προτιμήσεις παρόχου και διατηρήστε το πραγματικό αποτέλεσμα για παρατηρησιμότητα.
Προσωρινή αποθήκευση πλαισίουΔιαχωρίστε το επαναλαμβανόμενο πλαίσιο, ώστε ένας πελάτης να μπορεί να χρησιμοποιεί συμβατή προσωρινή αποθήκευση όπου την υποστηρίζει το επιλεγμένο μοντέλο.
Αναζήτηση στον ιστόΑνακτήστε πρόσφατες πηγές μέσω μιας συνάρτησης `web_search` που εκτελείται από τον πελάτη και κρατήστε τους συνδέσμους χωριστά από το παραγόμενο κείμενο.
Πολυμέσα και ανάκτηση
Ανεβάστε αρχείο μέσω ειδικής λειτουργίας, διατηρήστε το αναγνωριστικό του και περάστε μια αναφορά σε μεταγενέστερο συμβατό αίτημα.
ΕικόνεςΔημιουργήστε εικόνες μέσω μίας διαδρομής και επιλέξτε παραμέτρους από τις δυνατότητες του επιλεγμένου μοντέλου.
ΒίντεοΞεκινήστε το βίντεο ως ασύγχρονη εργασία, διατηρήστε το αναγνωριστικό της και κρατήστε τη δημιουργία χωριστά από την ανάγνωση αποτελέσματος.
ΉχοςΧρησιμοποιήστε ξεχωριστές λειτουργίες για σύνθεση ομιλίας, μεταγραφή και είσοδο ήχου σε μοντέλο.
Διανυσματικές αναπαραστάσειςΜετατρέψτε κείμενο ή υποστηριζόμενες εισόδους σε διανύσματα για αναζήτηση, ομαδοποίηση και προτάσεις.
ΑνακατάταξηΑναδιατάξτε ένα μικρό σύνολο υποψηφίων σε σχέση με ένα ερώτημα για να βελτιώσετε την ακρίβεια της τελικής ανάκτησης.
Μαζική εκτέλεσηΕπεξεργαστείτε ανεξάρτητες λειτουργίες σε ελεγχόμενες ομάδες όταν η ροή εργασίας επιτρέπει ασύγχρονη παράδοση.
Συνδέσεις και αξιοπιστία
Συνδέστε έναν πελάτη AI με επιτρεπόμενα εργαλεία, πόρους και προτροπές μέσω διεύθυνσης URL σύνδεσης που εκδίδεται στις ρυθμίσεις λογαριασμού.
Σφάλματα και αποσφαλμάτωσηΔημιουργήστε τον χειρισμό γύρω από την κατάσταση HTTP, ένα δομημένο σώμα σφάλματος και το αναγνωριστικό αιτήματος, αντί για το κείμενο μηνύματος.