Burime · Dokumentacion
Dokumentacioni i Platformës.
E përgatitur për prodhim që në dizajn.
Dokumentacioni i OpenQCore për ekipe që ndërtojnë produkte të besueshme AI nëpër chat, zë, gjenerim multimodal dhe rrjedha pune të njohurive me kontroll të përcaktuar të runtime-it.
Fillim i Shpejtë
Nga kërkesa e parë deri në prodhim brenda disa minutash.
1) Autentifikim
Përdorni autentifikimin me seancë JWT ose çelës API, me kontroll të aksesit të bazuar në shtrirje (scope).
2) Zgjidhni shtrirjen e ekzekutimit (scope)
Vendosni kontekst personal ose të hapësirës së punës duke përdorur header-at e runtime-it kur është e nevojshme.
3) Thirrni plotësimet e bisedës
Përdorni /api/v1/chat/completions për ekzekutimin kryesor të asistentit.
4) Shtoni zë dhe multimodalitet
Përdorni /api/v1/voice dhe endpoint-et Iris për rrjedhat e punës STT/TTS, imazhe, video dhe OCR.
5) Integroni njohuritë
Përdorni /api/v1/console/knowledge për ngarkim, përpunim (ingestion) dhe kërkime të bazuara në rikthim.
URL Bazë
Baza e API-ve publike
/api/v1Të gjitha endpoint-et publike të platformës janë të vendosura nën /api/v1.
Autentifikimi dhe Shtrirja
Akses i ndërgjegjshëm për kontekstin për ekzekutim personal dhe në hapësirën e punës.
Metodat e autentifikimit
JWT/seancë ose çelës API
Header i shtrirjes
X-Scope-Type: personal | workspace
Header i hapësirës së punës
X-Workspace-ID: [uuid] (i kërkuar në shtrirjen workspace)
Header i agjentit
X-Agent-ID: [uuid] (opsional)
Rregullat e validimit
- Nëse scope është 'personal', workspace_id nuk lejohet.
- Nëse scope është 'workspace', workspace_id është i kërkuar.
- Header-et e scope të pavlefshëm kthejnë 422.
Kufizimet e kërkesave
Ngadalësim i bazuar në politikë sipas kontekstit të autentikimit.
Çelësi i API
60 kërkesa / minutë
Çelësi i bucket-it përdor identitetin e hash-it të çelësit API.
JWT/sesion
120 kërkesa / minutë
Çelësi i bucket-it përdor id e workspace-it kur është i pranishëm, përndryshe id e përdoruesit.
Header-at e përgjigjes për kufizimet
Mjedisi i ekzekutimit për Chat
/chat/completions me shtresat e kontrollit të prodhimit.
GET /api/v1/chat/healthPOST /api/v1/chat/completionsSjelljet e ekzekutimit
- Ndiqja e backpressure dhe refuzimi i mbingarkesës së sistemit (503).
- Bllok i shpërndarë për të parandaluar përpunimin e dyfishtë në fluturim (409).
- Cache për heqjen e duplikateve për përgjigjet jo-stream.
- Ruajtje e sesionit/mesazheve për kthesat e përdoruesit dhe asistentit.
- Validim në kohë ekzekutimi për kërkesën, bashkëngjitjet dhe aksesin e sesionit.
Mjedisi i ekzekutimit të Zërit
Pipeline STT → LLM → TTS me streaming dhe ndërprerje.
POST /api/v1/voice/chat/metaPOST /api/v1/voice/chatPOST /api/v1/voice/interrupt/{session_id}WS /api/v1/voice/wsVeçoritë e zërit
- Ruteri i ofruesit rezervë (OpenAI + Azure).
- Mekanizma circuit breaker për fazat STT, LLM dhe TTS.
- Përpunim konvertimi audio për input jo-WAV.
- Përgjigje audio të transmetuara me kokat e metadatave.
- Konteksti i anulimit për ndërprerje në nivel të sesionit.
- Heqje e ngarkesës dhe degradim i cilësisë në ngarkesë të lartë.
Iris Multimodal
Rrjedhat e punës për imazh, video, OCR dhe verifikim të drejtuara nga modeli.
Katalogu i modeleve
iris-orbit
Modalitet i rrugëtimit automatik
iris-genesis
Gjenerim imazhi
iris-edit
Redaktim imazhi (nuk është zbatuar)
iris-lens
Analizë e imazhit (nuk është zbatuar)
iris-video
Gjenerim video
iris-ocr
OCR për dokumente
iris-verify
Verifikim i identitetit
iris-guard
Zbulim i mashtrimit (nuk është zbatuar)
iris-face
Verifikimi i fytyrës (nuk është zbatuar)
Njohuritë e Konsolës
API-t e njohurive të konzolës së hapësirës së punës për importim dhe pyetje.
/api/v1/console/knowledgeGET /api/v1/console/knowledgePOST /api/v1/console/knowledgePOST /api/v1/console/knowledge/uploadGET /api/v1/console/knowledge/{item_id}PATCH /api/v1/console/knowledge/{item_id}DELETE /api/v1/console/knowledge/{item_id}POST /api/v1/console/knowledge/askKufizimet e njohurive
- Madhësia maksimale e skedarit: 20MB
- Llojet e lejueshme: PDF, DOC, DOCX, TXT, Markdown
- Importimi kryhet në mënyrë asinkrone në sfond
- Gjendjet: në pritje → duke u përpunuar → përpunuar | dështuar
Semantika e gabimeve
Klasat e përgjigjeve të zakonshme të platformës.
400
Kërkesë e pavlefshme, të dhënat mungojnë, ose hyrje e formatuar gabim
401
Mungon autentikimi ose është i pavlefshëm
403
Shtrirja e pa lejuar / kufizim i rolit në hapësirën e punës
404
Burimi nuk u gjet
409
Kërkesa është tashmë në përpunim (konflikt i bllokimit)
413
Ngarkesa shumë e madhe (p.sh. kufijtë për audio/skedarë)
415
Lloji i përmbajtjes nuk mbështetet
422
Dështim i validimit (fushë/kontekst/skemë)
429
Kufiri i kërkesave u tejkalua
503
Sistemi i mbingarkuar / ofruesi i padisponueshëm
Vëzhgueshmëri
Ekzekutim i gjurmueshëm nëpër ciklet e jetës së bisedave dhe zërit.
- ID-të e gjurmës për korrelacionin e kërkesave.
- Pipelina e middleware-it për regjistrimin e përdorimit.
- Inicializimi i OpenTelemetry me eksport OTLP.
- Header-at e përgjigjes ekspozojnë sinjale kohore në rrjedhat e zërit.
Navigimi i dokumentacionit
Eksploro Seksionet e Dokumentacionit
Shko drejtpërdrejt tek udhëzimet e implementimit dhe referencat e prodhimit për secilën sipërfaqe runtime.
Autentikimi
Autentikimi me JWT/çelës API, header-at e fushës dhe modeli i validimit.
API e Bisedave
Përfundime, sjellja në transmetim dhe kontrollet e runtime-it.
API e Zërit
Pipelina e zërit në kohë reale, rrjedha e ndërprerjes dhe header-at e metadatave.
API Iris
Endpoint-et për imazh/video/OCR/verifikim dhe rutimi.
API e Njohurive
Ngarkimi, cikli i jetës së indeksimit, marrja dhe rrjedhat e punës për pyetje.
Ofruesit
Matrica e kapaciteteve, politika e rutimit dhe strategjia e mbulimit të dështimeve.
Kontratat e Daljes
Formati i përgjigjes së unifikuar nëpër ofrues dhe modalitete.
Arkitektura
Shtresat e ekzekutimit, abstraksioni i ofruesit dhe garancitë e sistemit.
Ndërtoni me besim mbi runtime-in e OpenQCore.
Përdorni dokumentacionin si hartën tuaj të prodhimit për chat, zë, gjenerim multimodal dhe ekzekutim të mbështetur nga njohuritë.