Špecifikácia API
Referenčná dokumentácia pre integrácie pracovných postupov s textom, agentmi, médiami a vyhľadávaním informácií.
https://cicora.ai/api/v1https://cicora.ai/apiReferenčná dokumentácia integrácie: parametre a dostupné funkcie vyberte z nastavení API účtu a katalógu modelov pre svoje prostredie.
Odoslať prvú požiadavkuZačíname
Odošlite prvú požiadavku, vyberte model z katalógu a uchovajte identifikátor požiadavky na diagnostiku.
OverovanieOdošlite kľúč API v hlavičke Bearer a produkčné prihlasovacie údaje uchovávajte oddelene od vývojových.
SDK a klienti HTTPPre klientov v štýle OpenAI a Messages používajte rôzne základné adresy URL: cielia na jednu špecifikáciu, ale cesty skladajú odlišne.
CLI a integrácieNakonfigurujte klienta s kľúčom, modelom a základnou adresou URL, ktorá zodpovedá jeho protokolu; tajný údaj uchovávajte v prostredí.
Časté otázky vývojárovKrátke praktické odpovede o kľúčoch, základných adresách URL, modeloch, nákladoch a diagnostike integrácie.
Účet a katalóg
Výber modelu zostavte z údajov katalógu namiesto pevne zakódovaného zoznamu v aplikácii.
Tímy a kľúče APIOddeľte kľúče, vlastníkov, rozpočty a záznamy využitia medzi aplikáciami a pracovnými priestormi.
LimityLimity kľúča, organizácie, modelu a smerovania považujte za súčasť pracovného postupu používateľa.
Využitie a nákladyPrepojte metadáta odpovede a vlastné denníky požiadaviek so skutočnými úkonmi používateľa.
Údaje a ochrana súkromiaMinimalizujte prenášané údaje, oddeľte identifikátor koncového používateľa od obsahu a riadte uchovávanie vo svojom produkte.
Text a agenti
Vytvárajte viacťahové konverzácie v známom formáte messages a pre každú požiadavku vyberte model.
Messages APIPre konverzácie používajte formát Messages so systémovým pokynom na najvyššej úrovni a výslovným limitom výstupu.
Responses APIPoužite jeden objekt input, ak vašej aplikácii prospieva spracovanie výstupných položiek a úkonov v jednom dátovom modeli.
StreamovaniePrijímajte tokeny a štruktúrované prírastky cez SSE bez čakania na úplnú odpoveď.
Nástroje a volanie funkciíOpíšte funkcie pomocou JSON Schema, vykonajte volanie vo svojej aplikácii a vráťte výsledok do konverzácie.
Štruktúrované výstupyKeď odpoveď bude spracúvať softvér, nie človek, vyžiadajte si objekt JSON alebo JSON Schema.
UvažovanieÚsilie pri uvažovaní nastavujte pre každú požiadavku iba pri modeloch, ktoré túto možnosť deklarujú.
SmerovaniePožiadavky na vykonanie vyjadrite v predvoľbách poskytovateľa a skutočný výsledok uchovajte na účely pozorovateľnosti.
Ukladanie kontextu do vyrovnávacej pamäteOddeľte opakujúci sa kontext, aby klient mohol používať kompatibilné ukladanie do vyrovnávacej pamäte tam, kde ho vybraný model podporuje.
Vyhľadávanie na webeZískavajte aktuálne zdroje prostredníctvom funkcie `web_search` vykonávanej klientom a odkazy uchovávajte oddelene od vygenerovaného textu.
Médiá a vyhľadávanie informácií
Nahrajte súbor prostredníctvom osobitného úkonu, uchovajte jeho ID a v neskoršej kompatibilnej požiadavke odovzdajte referenciu.
ObrázkyObrázky vytvárajte prostredníctvom jednej trasy a parametre vyberajte z možností zvoleného modelu.
VideoSpustite generovanie videa ako asynchrónnu úlohu, uchovajte jej ID a oddeľte vytvorenie od čítania výsledku.
ZvukNa syntézu reči, prepis a zvukový vstup do modelu používajte samostatné operácie.
Vektorové reprezentácieTransformujte text alebo podporované vstupy na vektory na vyhľadávanie, zhlukovanie a odporúčania.
RerankingZmeňte poradie malej množiny kandidátov vzhľadom na dopyt, aby ste zvýšili presnosť konečného vyhľadania.
Dávkové vykonávanieNezávislé úkony spracúvajte v riadených skupinách, keď pracovný postup umožňuje asynchrónne doručenie.