API specifikacija
Integracijų žinynas teksto, agentų, medijos ir informacijos paieškos darbo eigoms.
https://cicora.ai/api/v1https://cicora.ai/apiIntegracijų žinynas: savo paskyros API nustatymuose ir jūsų aplinkos modelių kataloge pasirinkite parametrus bei galimas funkcijas.
Siųsti pirmąją užklausąDarbo pradžia
Išsiųskite pirmąją užklausą, pasirinkite modelį iš katalogo ir išsaugokite užklausos identifikatorių diagnostikai.
AutentifikavimasSiųskite API raktą Bearer antraštėje, o gamybinius kredencialus laikykite atskirai nuo kūrimo kredencialų.
SDK ir HTTP klientaiOpenAI stiliaus ir Messages klientams naudokite skirtingus bazinius URL: jie skirti tai pačiai specifikacijai, bet kelius sudaro skirtingai.
CLI ir integracijosSukonfigūruokite klientą nurodydami raktą, modelį ir jo protokolą atitinkantį bazinį URL; paslaptį laikykite aplinkoje.
DUK kūrėjamsTrumpi praktiniai atsakymai apie raktus, bazinius URL, modelius, kainą ir integracijos diagnostiką.
Paskyra ir katalogas
Modelio pasirinkimą kurkite iš katalogo duomenų, o ne iš programoje įrašyto nekintamo sąrašo.
Komandos ir API raktaiAtskirkite raktus, savininkus, biudžetus ir naudojimo pėdsakus pagal programas ir darbo erdves.
RibosRakto, organizacijos, modelio ir maršruto parinkimo ribas laikykite naudotojo darbo eigos dalimi.
Naudojimas ir sąnaudosSusiekite atsakymo metaduomenis ir savo užklausų žurnalus su tikrais naudotojų veiksmais.
Duomenys ir privatumasMažinkite perduodamų duomenų kiekį, atskirkite galutinio naudotojo identifikatorių nuo turinio ir valdykite saugojimą savo produkte.
Tekstas ir agentai
Kurkite kelių etapų pokalbius įprastu messages formatu ir kiekvienai užklausai pasirinkite modelį.
Messages APIPokalbiams naudokite Messages formatą su aukščiausio lygio sistemos instrukcija ir aiškia išvesties riba.
Responses APINaudokite vieną input objektą, kai jūsų programai naudinga tvarkyti išvesties elementus ir veiksmus viename duomenų modelyje.
Srautinis perdavimasGaukite žetonus ir struktūrizuotas dalis per SSE nelaukdami viso atsakymo.
Įrankiai ir funkcijų iškvietimasAprašykite funkcijas su JSON Schema, vykdykite iškvietimą savo programoje ir grąžinkite rezultatą į pokalbį.
Struktūrizuota išvestisPrašykite JSON objekto arba JSON Schema, kai atsakymą naudos programinė įranga, o ne žmogus.
SamprotavimasKiekvienai užklausai nustatykite samprotavimo pastangų lygį tik tiems modeliams, kurie deklaruoja šią galimybę.
Maršruto parinkimasVykdymo reikalavimus išreikškite teikėjo nuostatose ir stebimumui išsaugokite faktinį rezultatą.
Konteksto kaupimas podėlyjeAtskirkite pasikartojantį kontekstą, kad klientas galėtų naudoti suderinamą podėlį, kai pasirinktas modelis jį palaiko.
Paieška žiniatinklyjeNaujausius šaltinius gaukite per kliento vykdomą funkciją `web_search`, o nuorodas laikykite atskirai nuo sugeneruoto teksto.
Medija ir informacijos paieška
Įkelkite failą specialia operacija, išsaugokite jo identifikatorių ir vėlesnėje suderinamoje užklausoje perduokite nuorodą.
VaizdaiVaizdus kurkite vienu maršrutu ir parametrus rinkitės pagal pasirinkto modelio galimybes.
Vaizdo įrašasVaizdo įrašo kūrimą pradėkite kaip asinchroninę užduotį, išsaugokite jos identifikatorių ir atskirkite kūrimą nuo rezultato skaitymo.
GarsasKalbos sintezei, transkribavimui ir garso įvesčiai į modelį naudokite atskiras operacijas.
ĮterpiniaiPaverskite tekstą ar palaikomas įvestis vektoriais paieškai, grupavimui ir rekomendacijoms.
PerrikiavimasPakartotinai surikiuokite nedidelį kandidatų rinkinį pagal užklausą, kad pagerintumėte galutinės paieškos tikslumą.
Paketinis vykdymasKai darbo eiga leidžia asinchroninį pateikimą, nepriklausomas operacijas vykdykite valdomomis grupėmis.