cicora.ai
cicora.ai / Αναφορά ενσωμάτωσης

Προδιαγραφή API

Τεκμηρίωση αναφοράς για ενσωματώσεις σε ροές εργασίας κειμένου, πρακτόρων, πολυμέσων και ανάκτησης πληροφοριών.

SDK τύπου OpenAI και curlhttps://cicora.ai/api/v1
SDK Messages και Claude Codehttps://cicora.ai/api

Αναφορά ενσωμάτωσης: επιλέξτε παραμέτρους και διαθέσιμες δυνατότητες από τις ρυθμίσεις API του λογαριασμού σας και τον κατάλογο μοντέλων για το περιβάλλον σας.

Αποστολή πρώτου αιτήματος

Πρώτα βήματα

POST /chat/completionsΓρήγορη εκκίνηση

Στείλτε ένα πρώτο αίτημα, επιλέξτε μοντέλο από τον κατάλογο και διατηρήστε ένα αναγνωριστικό αιτήματος για διάγνωση.

Authorization: BearerΈλεγχος ταυτότητας

Στείλτε ένα κλειδί API σε κεφαλίδα Bearer και διατηρήστε τα διαπιστευτήρια παραγωγής χωριστά από τα διαπιστευτήρια ανάπτυξης.

Βασικές διευθύνσεις URL OpenAI και MessagesSDK και πελάτες HTTP

Χρησιμοποιήστε διαφορετικές βασικές διευθύνσεις URL για πελάτες τύπου OpenAI και Messages: στοχεύουν μία προδιαγραφή, αλλά συνθέτουν διαφορετικά τις διαδρομές.

Βασική διεύθυνση URL συμβατού πελάτηCLI και ενσωματώσεις

Διαμορφώστε έναν πελάτη με κλειδί, μοντέλο και βασική διεύθυνση URL που αντιστοιχεί στο πρωτόκολλό του· διατηρήστε το μυστικό στο περιβάλλον.

Συχνές ερωτήσεις ενσωμάτωσηςΣυχνές ερωτήσεις προγραμματιστών

Σύντομες πρακτικές απαντήσεις σχετικά με κλειδιά, βασικές διευθύνσεις URL, μοντέλα, κόστος και διάγνωση ενσωμάτωσης.

Λογαριασμός και κατάλογος

Κείμενο και πράκτορες

POST /chat/completionsΟλοκληρώσεις συνομιλίας

Δημιουργήστε συνομιλίες πολλαπλών γύρων στη γνωστή μορφή μηνυμάτων και επιλέξτε μοντέλο για κάθε αίτημα.

POST /v1/messagesMessages API

Χρησιμοποιήστε τη μορφή Messages για συνομιλίες με οδηγία συστήματος ανώτατου επιπέδου και ρητό όριο εξόδου.

POST /responsesResponses API

Χρησιμοποιήστε ένα αντικείμενο input όταν η εφαρμογή σας ωφελείται από τον χειρισμό στοιχείων εξόδου και ενεργειών σε ένα ενιαίο μοντέλο δεδομένων.

POST /chat/completions · stream: trueΡοή

Λάβετε tokens και δομημένα τμήματα μέσω SSE χωρίς να περιμένετε την πλήρη απάντηση.

POST /chat/completions · toolsΕργαλεία και κλήση συναρτήσεων

Περιγράψτε συναρτήσεις με JSON Schema, εκτελέστε την κλήση στην εφαρμογή σας και επιστρέψτε το αποτέλεσμα στη συνομιλία.

POST /chat/completions · response_formatΔομημένες έξοδοι

Ζητήστε αντικείμενο JSON ή JSON Schema όταν την απάντηση θα καταναλώσει λογισμικό και όχι άνθρωπος.

POST /chat/completions · reasoningΣυλλογισμός

Ορίστε την ένταση συλλογισμού ανά αίτημα μόνο για μοντέλα που δηλώνουν αυτή τη δυνατότητα.

POST /chat/completions · providerΔρομολόγηση

Εκφράστε τις απαιτήσεις εκτέλεσης στις προτιμήσεις παρόχου και διατηρήστε το πραγματικό αποτέλεσμα για παρατηρησιμότητα.

POST /chat/completions · cache_controlΠροσωρινή αποθήκευση πλαισίου

Διαχωρίστε το επαναλαμβανόμενο πλαίσιο, ώστε ένας πελάτης να μπορεί να χρησιμοποιεί συμβατή προσωρινή αποθήκευση όπου την υποστηρίζει το επιλεγμένο μοντέλο.

POST /chat/completions · web_searchΑναζήτηση στον ιστό

Ανακτήστε πρόσφατες πηγές μέσω μιας συνάρτησης `web_search` που εκτελείται από τον πελάτη και κρατήστε τους συνδέσμους χωριστά από το παραγόμενο κείμενο.

Πολυμέσα και ανάκτηση

POST /filesΑρχεία και συνημμένα

Ανεβάστε αρχείο μέσω ειδικής λειτουργίας, διατηρήστε το αναγνωριστικό του και περάστε μια αναφορά σε μεταγενέστερο συμβατό αίτημα.

POST /imagesΕικόνες

Δημιουργήστε εικόνες μέσω μίας διαδρομής και επιλέξτε παραμέτρους από τις δυνατότητες του επιλεγμένου μοντέλου.

POST /videosΒίντεο

Ξεκινήστε το βίντεο ως ασύγχρονη εργασία, διατηρήστε το αναγνωριστικό της και κρατήστε τη δημιουργία χωριστά από την ανάγνωση αποτελέσματος.

POST /audio/speech · POST /audio/transcriptionsΉχος

Χρησιμοποιήστε ξεχωριστές λειτουργίες για σύνθεση ομιλίας, μεταγραφή και είσοδο ήχου σε μοντέλο.

POST /embeddingsΔιανυσματικές αναπαραστάσεις

Μετατρέψτε κείμενο ή υποστηριζόμενες εισόδους σε διανύσματα για αναζήτηση, ομαδοποίηση και προτάσεις.

POST /rerankΑνακατάταξη

Αναδιατάξτε ένα μικρό σύνολο υποψηφίων σε σχέση με ένα ερώτημα για να βελτιώσετε την ακρίβεια της τελικής ανάκτησης.

Παραλληλισμός ελεγχόμενος από τον πελάτηΜαζική εκτέλεση

Επεξεργαστείτε ανεξάρτητες λειτουργίες σε ελεγχόμενες ομάδες όταν η ροή εργασίας επιτρέπει ασύγχρονη παράδοση.

Συνδέσεις και αξιοπιστία