Specifikacija API-ja
Referenčna dokumentacija za integracije v potekih dela z besedilom, agenti, mediji in pridobivanjem informacij.
https://cicora.ai/api/v1https://cicora.ai/apiReferenčna dokumentacija za integracijo: parametre in razpoložljive zmožnosti izberite v nastavitvah API-ja svojega računa in v katalogu modelov za svoje okolje.
Pošljite prvo zahtevoPrvi koraki
Pošljite prvo zahtevo, iz kataloga izberite model in ohranite identifikator zahteve za diagnostiko.
OverjanjeKljuč API pošljite v glavi Bearer, produkcijske poverilnice pa hranite ločeno od razvojnih.
Kompleti SDK in odjemalci HTTPZa odjemalce v slogu OpenAI in Messages uporabite različne osnovne URL-je: ciljajo na isto specifikacijo, vendar poti sestavljajo različno.
CLI in integracijeOdjemalca konfigurirajte s ključem, modelom in osnovnim URL-jem, ki ustreza njegovemu protokolu; skrivnost hranite v okolju.
Pogosta vprašanja za razvijalceKratki praktični odgovori o ključih, osnovnih URL-jih, modelih, stroških in diagnosticiranju integracije.
Račun in katalog
Izbiro modela zgradite iz podatkov kataloga namesto iz trdo kodiranega seznama v aplikaciji.
Ekipe in ključi APIKljuče, lastnike, proračune in sledi uporabe ločite med aplikacijami in delovnimi prostori.
OmejitveOmejitve ključa, organizacije, modela in usmerjanja obravnavajte kot del uporabniškega poteka dela.
Uporaba in stroškiMetapodatke odgovora in svoje dnevnike zahtev povežite z dejanskimi dejanji uporabnikov.
Podatki in zasebnostZmanjšajte količino prenesenih podatkov, ločite identifikator končnega uporabnika od vsebine in nadzorujte hrambo v svojem izdelku.
Besedilo in agenti
Večkrožne pogovore ustvarite v znani obliki messages in za vsako zahtevo izberite model.
Messages APIZa pogovore uporabite obliko Messages z navodilom sistema na najvišji ravni in izrecno omejitvijo izhoda.
Responses APIUporabite en predmet input, kadar vaši aplikaciji koristi obdelava izhodnih elementov in dejanj v enem podatkovnem modelu.
PretakanjePrejemajte žetone in strukturirane delčke prek SSE, ne da bi čakali na celoten odgovor.
Orodja in klicanje funkcijFunkcije opišite z JSON Schema, klic izvedite v aplikaciji in rezultat vrnite v pogovor.
Strukturirani izhodiZahtevajte predmet JSON ali JSON Schema, kadar bo odgovor uporabila programska oprema in ne oseba.
SklepanjeStopnjo napora pri sklepanju nastavite za posamezno zahtevo le pri modelih, ki to zmožnost navajajo.
UsmerjanjeZahteve za izvajanje izrazite v nastavitvah ponudnika, dejanski rezultat pa shranite za opazljivost.
Predpomnjenje kontekstaPonavljajoči se kontekst ločite, da lahko odjemalec uporabi združljivo predpomnjenje, kadar ga izbrani model podpira.
Spletno iskanjeSveže vire pridobite prek funkcije `web_search`, ki jo izvede odjemalec, povezave pa hranite ločeno od ustvarjenega besedila.
Mediji in pridobivanje informacij
Datoteko naložite z namenskim postopkom, ohranite njen identifikator in sklic posredujte v poznejši združljivi zahtevi.
SlikeSlike ustvarite prek ene poti, parametre pa izberite glede na zmožnosti izbranega modela.
VideoVideo začnite kot asinhrono opravilo, ohranite njegov identifikator in ločite ustvarjanje od branja rezultata.
ZvokZa sintezo govora, prepisovanje in zvočni vhod v model uporabite ločene postopke.
VdelaveBesedilo ali podprte vhode pretvorite v vektorje za iskanje, gručenje in priporočila.
Ponovno razvrščanjeMajhen nabor kandidatov glede na poizvedbo prerazvrstite, da izboljšate natančnost končnega pridobivanja.
Paketno izvajanjeNeodvisne postopke obdelujte v nadzorovanih skupinah, kadar potek dela dopušča asinhrono dostavo.