API спецификациясы
Мәтін, агенттер, медиа және ақпарат іздеу жұмыс үдерістерін біріктіруге арналған анықтамалық.
https://cicora.ai/api/v1https://cicora.ai/apiИнтеграция анықтамалығы: параметрлер мен қолжетімді мүмкіндіктерді тіркелгіңіздің API параметрлерінен және ортаңызға арналған модельдер каталогынан таңдаңыз.
Алғашқы сұрауды жіберуБастау
Алғашқы сұрауды жіберіңіз, каталогтан модель таңдаңыз және диагностика үшін сұрау идентификаторын сақтаңыз.
АутентификацияAPI кілтін Bearer тақырыбында жіберіп, өндірістік тіркелгі деректерін әзірлеу тіркелгі деректерінен бөлек ұстаңыз.
SDK және HTTP клиенттеріOpenAI стиліндегі және Messages клиенттері үшін әртүрлі негізгі URL мекенжайларын пайдаланыңыз: олар бір спецификацияны нысана етеді, бірақ жолдарды әртүрлі құрастырады.
CLI және интеграцияларКлиентті хаттамасына сәйкес келетін кілтпен, модельмен және негізгі URL мекенжайымен конфигурациялаңыз; құпияны ортада сақтаңыз.
Әзірлеушілерге арналған жиі қойылатын сұрақтарКілттер, негізгі URL мекенжайлары, модельдер, құн және интеграция диагностикасы туралы қысқа практикалық жауаптар.
Тіркелгі және каталог
Модель таңдауды қолданбаңыздағы кодқа тікелей жазылған тізімнен емес, каталог деректерінен құрыңыз.
Топтар және API кілттеріҚолданбалар мен жұмыс кеңістіктері бойынша кілттерді, иелерді, бюджеттерді және пайдалану трассаларын бөлек ұстаңыз.
ШектеулерКілт, ұйым, модель және бағдарлау шектеулерін пайдаланушы жұмыс үдерісінің бөлігі деп санаңыз.
Пайдалану және құнЖауап метадеректерін және өз сұрау журналдарыңызды пайдаланушылардың нақты әрекеттерімен байланыстырыңыз.
Деректер және құпиялылықЖіберілетін деректерді азайтыңыз, соңғы пайдаланушы идентификаторын мазмұннан бөліңіз және сақтау мерзімін өніміңізде басқарыңыз.
Мәтін және агенттер
Таныс messages пішімінде көп айналымды сөйлесулер жасап, әр сұрау үшін модель таңдаңыз.
Messages APIЖоғарғы деңгейдегі жүйелік нұсқауы және нақты шығыс шегі бар сөйлесулер үшін Messages пішімін пайдаланыңыз.
Responses APIҚолданбаңыз шығыс элементтері мен әрекеттерін бір деректер моделінде өңдеуден пайда көрсе, бір кіріс нысанын пайдаланыңыз.
Ағынмен жіберуТолық жауапты күтпей, SSE арқылы токендер мен құрылымды дельталарды қабылдаңыз.
Құралдар және функция шақыруФункцияларды JSON Schema арқылы сипаттап, шақыруды қолданбаңызда орындаңыз және нәтижені сөйлесуге қайтарыңыз.
Құрылымды шығыстарЖауапты адам емес, бағдарламалық құрал тұтынатын болса, JSON нысанын немесе JSON Schema сұраңыз.
Ой қорытуОй қорыту күшін әр сұрау үшін тек осы мүмкіндікті жариялаған модельдерге орнатыңыз.
БағдарлауОрындау талаптарын провайдер теңшелімдерінде көрсетіп, бақылау мүмкіндігі үшін нақты нәтижені сақтаңыз.
Контексті кэштеуКлиент таңдалған модель қолдайтын үйлесімді кэштеуді пайдалана алуы үшін қайталанатын контексті бөліңіз.
Веб-іздеуЖаңа дереккөздерді клиент орындайтын `web_search` функциясы арқылы алып, сілтемелерді жасалған мәтіннен бөлек ұстаңыз.
Медиа және ақпарат іздеу
Файлды арнайы операция арқылы жүктеп, оның идентификаторын сақтаңыз және кейінгі үйлесімді сұрауда сілтеме жіберіңіз.
КескіндерКескіндерді бір бағыт арқылы жасап, параметрлерді таңдалған модель мүмкіндіктерінен таңдаңыз.
БейнеБейнені асинхронды тапсырма ретінде бастаңыз, оның тапсырма идентификаторын сақтаңыз және жасауды нәтижені оқудан бөлек ұстаңыз.
АудиоСөйлеу синтезі, транскрипция және модельге аудио енгізу үшін бөлек операцияларды пайдаланыңыз.
ЕндірмелерІздеу, кластерлеу және ұсынымдар үшін мәтінді немесе қолдау көрсетілетін кірістерді векторларға айналдырыңыз.
Қайта ранжирлеуСоңғы іздеу дәлдігін жақсарту үшін кандидаттардың шағын жиынын сұрауға қатысты қайта реттеңіз.
Пакеттік орындауЖұмыс үдерісі асинхронды жеткізуге мүмкіндік бергенде тәуелсіз операцияларды басқарылатын топтарда өңдеңіз.