Spesifikasi API
Rujukan untuk penyepaduan merentas aliran kerja teks, ejen, media dan pencarian maklumat.
https://cicora.ai/api/v1https://cicora.ai/apiRujukan penyepaduan: pilih parameter dan keupayaan yang tersedia daripada tetapan API akaun serta katalog model untuk persekitaran anda.
Hantar permintaan pertamaMulakan
Hantar permintaan pertama, pilih model daripada katalog dan simpan pengecam permintaan untuk diagnosis.
PengesahanHantar kunci API dalam pengepala Bearer dan asingkan kelayakan akses pengeluaran daripada kelayakan akses pembangunan.
SDK dan klien HTTPGunakan URL asas berbeza untuk klien gaya OpenAI dan Messages: kedua-duanya menyasarkan satu spesifikasi tetapi menyusun laluan secara berbeza.
CLI dan penyepaduanKonfigurasikan klien dengan kunci, model dan URL asas yang sepadan dengan protokolnya; simpan rahsia dalam persekitaran.
Soalan Lazim pembangunJawapan praktikal ringkas tentang kunci, URL asas, model, kos dan diagnosis penyepaduan.
Akaun dan katalog
Bina pemilihan model daripada data katalog dan bukannya senarai berkod keras dalam aplikasi anda.
Pasukan dan kunci APIAsingkan kunci, pemilik, belanjawan dan jejak penggunaan merentas aplikasi serta ruang kerja.
HadAnggap had kunci, organisasi, model dan penghalaan sebagai sebahagian daripada aliran kerja pengguna.
Penggunaan dan kosHubungkan metadata respons dan log permintaan anda sendiri kepada tindakan pengguna sebenar.
Data dan privasiMinimumkan data yang dihantar, asingkan pengecam pengguna akhir daripada kandungan dan kawal pengekalan dalam produk anda.
Teks dan ejen
Cipta perbualan berbilang giliran dalam format messages yang lazim dan pilih model bagi setiap permintaan.
API MessagesGunakan format Messages untuk perbualan dengan arahan sistem peringkat atas dan had output yang jelas.
API ResponsesGunakan satu objek input apabila aplikasi anda mendapat manfaat daripada pengendalian item output dan tindakan dalam satu model data.
PenstrimanTerima token dan delta berstruktur melalui SSE tanpa menunggu respons lengkap.
Alat dan panggilan fungsiHuraikan fungsi dengan JSON Schema, laksanakan panggilan dalam aplikasi anda dan kembalikan hasil kepada perbualan.
Output berstrukturMinta objek JSON atau JSON Schema apabila perisian, bukannya manusia, akan menggunakan respons.
PenaakulanTetapkan usaha penaakulan bagi setiap permintaan hanya untuk model yang mengisytiharkan keupayaan tersebut.
PenghalaanNyatakan keperluan pelaksanaan dalam keutamaan penyedia dan simpan hasil sebenar untuk kebolehcerapan.
Pencachean konteksAsingkan konteks berulang supaya klien boleh menggunakan pencachean serasi apabila model yang dipilih menyokongnya.
Carian webDapatkan sumber terkini melalui fungsi `web_search` yang dilaksanakan oleh klien dan asingkan pautan daripada teks yang dijana.
Media dan pencarian maklumat
Muat naik fail melalui operasi khusus, simpan ID fail dan hantar rujukannya dalam permintaan serasi kemudian.
ImejCipta imej melalui satu laluan dan pilih parameter daripada keupayaan model yang dipilih.
VideoMulakan video sebagai kerja tak segerak, simpan ID kerjanya dan asingkan penciptaan daripada pembacaan hasil.
AudioGunakan operasi berasingan untuk sintesis pertuturan, transkripsi dan input audio kepada model.
PembenamanTukarkan teks atau input yang disokong kepada vektor untuk carian, pengelompokan dan cadangan.
Penyusunan semula kedudukanSusun semula set calon yang kecil berdasarkan pertanyaan untuk meningkatkan ketepatan pencarian akhir.
Pelaksanaan kelompokProses operasi bebas dalam kumpulan terkawal apabila aliran kerja membenarkan penghantaran tak segerak.