API-specifikáció
Referenciadokumentáció szöveges, ügynök-, média- és visszakeresési munkafolyamatok integrációjához.
https://cicora.ai/api/v1https://cicora.ai/apiIntegrációs referencia: válassza ki a paramétereket és az elérhető képességeket a fiókja API-beállításaiból és a környezetéhez tartozó modellkatalógusból.
Az első kérés elküldéseKezdés
Küldjön első kérést, válasszon modellt a katalógusból, és őrizzen meg kérésazonosítót a hibafeltáráshoz.
HitelesítésAPI-kulcsot Bearer fejlécben küldjön, és az éles hitelesítő adatokat tartsa külön a fejlesztőiektől.
SDK-k és HTTP-kliensekAz OpenAI-stílusú és Messages-kliensekhez eltérő alap-URL-t használjon: ugyanazt a specifikációt célozzák, de eltérően állítják össze az útvonalakat.
CLI és integrációkA klienst a protokolljának megfelelő kulccsal, modellel és alap-URL-lel állítsa be; a titkot a környezetben tartsa.
Fejlesztői GYIKRövid, gyakorlati válaszok kulcsokról, alap-URL-ekről, modellekről, költségekről és integrációs hibafeltárásról.
Fiók és katalógus
A modellválasztást katalógusadatokból építse fel, ne az alkalmazásba kódolt listából.
Csapatok és API-kulcsokAz alkalmazások és munkaterületek között különítse el a kulcsokat, tulajdonosokat, költségkereteket és használati nyomokat.
KorlátokA kulcsra, a szervezetre, a modellre és az útválasztásra vonatkozó korlátokat tekintse a felhasználói munkafolyamat részének.
Használat és költségKapcsolja össze a válasz metaadatait és saját kérési naplóit a tényleges felhasználói műveletekkel.
Adatok és adatvédelemMinimalizálja a továbbított adatokat, válassza külön a végfelhasználói azonosítót a tartalomtól, és a termékben szabályozza a megőrzést.
Szöveg és ügynökök
Hozzon létre többfordulós beszélgetéseket a megszokott messages formátumban, és minden kéréshez válasszon modellt.
Messages APIA Messages formátumot használja a legfelső szintű rendszerutasítást és kifejezett kimeneti korlátot tartalmazó beszélgetésekhez.
Responses APIHasználjon egyetlen input objektumot, ha az alkalmazásnak előnyös, hogy a kimeneti elemeket és a műveleteket egységes adatmodellben kezelheti.
StreamelésTokenek és strukturált változásrészek fogadása SSE-n keresztül a teljes válasz megvárása nélkül.
Eszközök és függvényhívásA függvényeket JSON Schema segítségével írja le, a hívást az alkalmazásban hajtsa végre, majd az eredményt adja vissza a beszélgetésnek.
Strukturált kimenetekKérjen JSON-objektumot vagy JSON Schema sémát, ha a választ ember helyett szoftver fogja feldolgozni.
ÉrvelésAz érvelési erőfeszítést kérésenként csak olyan modelleknél állítsa be, amelyek jelzik ezt a képességet.
ÚtválasztásA végrehajtási követelményeket a szolgáltatói beállításokban fejezze ki, a tényleges eredményt pedig őrizze meg a megfigyelhetőség érdekében.
Kontextus-gyorsítótárazásVálassza külön az ismétlődő kontextust, hogy a kliens kompatibilis gyorsítótárazást használhasson, ahol azt a választott modell támogatja.
Webes keresésKérjen le friss forrásokat kliens által végrehajtott `web_search` függvénnyel, és a hivatkozásokat tartsa külön a generált szövegtől.
Média és visszakeresés
Töltsön fel fájlt külön művelettel, őrizze meg az azonosítóját, és egy későbbi kompatibilis kérésben adjon át rá hivatkozást.
KépekKépeket egy útvonalon hozzon létre, a paramétereket pedig a kiválasztott modell képességeiből válassza ki.
VideóA videót aszinkron feladatként indítsa, őrizze meg a feladatazonosítóját, és a létrehozást válassza külön az eredmény beolvasásától.
HangA beszédszintézishez, átíráshoz és modell-hangbemenethez külön műveleteket használjon.
BeágyazásokAlakítsa a szöveget vagy támogatott bemeneteket vektorokká kereséshez, klaszterezéshez és ajánlásokhoz.
ÚjrarangsorolásA végleges visszakeresés pontosságának javításához rendezzen újra egy kis jelölthalmazt a lekérdezéshez viszonyítva.
Kötegelt végrehajtásHa a munkafolyamat lehetővé teszi az aszinkron kézbesítést, a független műveleteket szabályozott csoportokban dolgozza fel.