Kaynaklar · Dokümantasyon

Platform Belgeleri.

Başından itibaren üretime hazır.

Kapsamlı çalışma zamanı kontrolüyle sohbet, ses, çok modlu üretim ve bilgi iş akışlarında güvenilir yapay zeka ürünleri geliştiren ekipler için OpenQCore belgeleri.

API odaklı çalışma zamanıÇalışma alanı ve kişisel kapsamlarAkışlı + AkışsızHız Sınırı + Tekilleştirme + KilitlemeSes Boru Hattı (STT/LLM/TTS)Konsol Bilgi API'leri

Hızlı Başlangıç

İlk isteğinizden üretime geçişe dakikalar içinde.

1) Kimlik doğrulama

Kapsam duyarlı erişim kontrolü için JWT oturum doğrulaması veya API anahtarıyla kimlik doğrulaması kullanın.

2) Çalışma zamanı kapsamını seçin

Gerekirse çalışma zamanı başlıklarıyla kişisel veya çalışma alanı bağlamını ayarlayın.

3) Sohbet tamamlamalarını çağırın

Asistanın temel yürütümü için /api/v1/chat/completions endpoint'ini kullanın.

4) Ses ve çok modlu özellikler ekleyin

STT/TTS, görüntü, video ve OCR iş akışları için /api/v1/voice ve Iris uç noktalarını kullanın.

5) Bilgi entegrasyonunu yapın

Yükleme, içeri aktarma ve geri getirme odaklı sorgulama için /api/v1/console/knowledge kullanın.

Temel URL

Genel API temel adresi

/api/v1

Tüm genel platform uç noktaları /api/v1 altında yer alır.

Kimlik Doğrulama ve Kapsam

Kişisel ve çalışma alanı yürütmeleri için bağlama duyarlı erişim.

Kimlik doğrulama yöntemleri

JWT/oturum veya API anahtarı

Kapsam başlığı

X-Scope-Type: personal | workspace

Workspace başlığı

X-Workspace-ID: [uuid] (workspace kapsamındayken gerekli)

Agent başlığı

X-Agent-ID: [uuid] (isteğe bağlı)

Doğrulama kuralları

  • scope 'personal' ise workspace_id kullanılamaz.
  • scope 'workspace' ise workspace_id zorunludur.
  • Geçersiz scope başlıkları 422 döner.

İstek sınırları

Yetkilendirme bağlamına göre politika tabanlı hız sınırlaması.

API anahtarı

Dakikada 60 istek

Bucket anahtarı, API anahtarının hash kimliğini kullanır.

JWT/oturum

Dakikada 120 istek

Bucket anahtarı, varsa workspace id'sini, yoksa user id'sini kullanır.

Hız sınırlama yanıt başlıkları

Retry-AfterX-RateLimit-LimitX-RateLimit-RemainingX-RateLimit-Reset

Chat çalışma zamanı

/chat/completions, üretim kontrol katmanlarıyla.

GET /api/v1/chat/health
POST /api/v1/chat/completions

Yürütme davranışları

  • Geri basınç takibi ve sistem aşırı yüklenmesi durumunda reddetme (503).
  • Çift işlenmeyi önlemek için dağıtık kilit (409).
  • Akış dışı yanıtlar için yinelenmeyi önleyen önbellek.
  • Kullanıcı ve asistan etkileşimleri için oturum ve mesaj kalıcılığı.
  • İstek, ekler ve oturum erişimi için çalışma zamanı doğrulaması.

Ses Çalışma Zamanı

Akış ve kesintiyi destekleyen STT → LLM → TTS iş akışı.

POST /api/v1/voice/chat/meta
POST /api/v1/voice/chat
POST /api/v1/voice/interrupt/{session_id}
WS /api/v1/voice/ws

Ses özellikleri

  • Yedek sağlayıcı yönlendiricisi (OpenAI + Azure).
  • STT, LLM ve TTS aşamaları için devre kesiciler.
  • WAV dışı girişler için ses dönüştürme iş akışı.
  • Meta veri başlıklarıyla birlikte akış halinde ses yanıtları.
  • Oturum düzeyinde kesintiler için iptal bağlamı.
  • Yük altında yük azaltma ve kalite düşüşü.

Iris Çok Modlu

Görüntü, video, OCR ve doğrulama için model bazlı iş akışları.

Model kataloğu

iris-orbit

Otomatik yönlendirme modu

iris-genesis

Görüntü oluşturma

iris-edit

Görüntü düzenleme (henüz uygulanmadı)

iris-lens

Görüntü analizi (henüz uygulanmadı)

iris-video

Video oluşturma

iris-ocr

Belge OCR

iris-verify

Kimlik doğrulama

iris-guard

Dolandırıcılık tespiti (henüz uygulanmadı)

iris-face

Yüz doğrulama (henüz uygulanmadı)

Konsol Bilgisi

Çalışma alanı konsolu için içerik yükleme ve sorgulama API'leri.

/api/v1/console/knowledge
GET /api/v1/console/knowledge
POST /api/v1/console/knowledge
POST /api/v1/console/knowledge/upload
GET /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/ask

Bilgi kısıtlamaları

  • Maks. dosya boyutu: 20MB
  • İzin verilen dosya türleri: PDF, DOC, DOCX, TXT, Markdown
  • Yükleme işlemi arka planda asenkron olarak çalışır.
  • Durumlar: pending → processing → processed | failed

Hata Semantiği

Yaygın platform yanıt sınıfları.

400

Geçersiz istek, eksik veri veya hatalı biçimlendirilmiş girdi

401

Kimlik doğrulaması eksik veya geçersiz

403

Yetkisiz kapsam / çalışma alanı rolü kısıtlaması

404

Kaynak bulunamadı

409

İstek zaten işleniyor (kilit çakışması)

413

Gönderilen veri çok büyük (örn. ses/dosya limitleri)

415

Desteklenmeyen içerik türü

422

Doğrulama hatası (kapsam/bağlam/şema)

429

İstek oranı sınırı aşıldı

503

Sistem aşırı yüklenmiş / sağlayıcı kullanılamıyor

Gözlemlenebilirlik

Sohbet ve ses yaşam döngülerinde izlenebilir yürütme.

  • İstekleri ilişkilendirmek için Trace ID'leri.
  • Kullanım günlükleme için middleware hattı.
  • OTLP dışa aktarımı ile OpenTelemetry başlatma.
  • Yanıt başlıkları, ses akışlarında zamanlama bilgilerini sağlar.
X-Trace-IDX-Session-IDX-STT-Time-MSX-LLM-Time-MSX-TTS-Time-MS

OpenQCore çalışma zamanı üzerinde güvenle geliştirin.

Sohbet, ses, çok modlu üretim ve bilgi destekli yürütme için belgeleri üretimdeki yol haritanız olarak kullanın.