Kaynaklar · Knowledge API
Knowledge API Belgeleri
Çalışma alanı için bilgi edinimi, erişim, sorgu iş akışları ve üretime uygun kısıtlamalar hakkında kapsamlı bir referans.
Uç Noktalar
GET /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/askGerekli Başlıklar
Authorization: Bearer [token] veya API anahtarı ile kimlik doğrulamaX-Scope-Type: workspaceX-Workspace-ID: [workspace_uuid]Content-Type: application/json (veya yükleme için multipart/form-data)
Yükleme Örneği
bash
curl -X POST "/api/v1/console/knowledge/upload" \
-H "Authorization: Bearer [token]" \
-H "X-Scope-Type: workspace" \
-H "X-Workspace-ID: [workspace_uuid]" \
-F "file=@handbook.pdf" \
-F "title=Team Handbook" \
-F "tags=hr,policy"Sorgu Örneği
json
{
"question": "What is our remote-work policy?",
"top_k": 5,
"filters": {
"tags": ["hr", "policy"]
},
"session_id": "sess_123"
}Yanıt Örneği
json
{
"success": true,
"answer": "Employees may work remotely up to 3 days per week...",
"citations": [
{
"item_id": "kb_456",
"title": "Team Handbook",
"score": 0.91
}
],
"usage": {
"input_tokens": 180,
"output_tokens": 72
},
"metadata": {
"retrieved_items": 5
}
}Bilgi Kısıtlamaları
- Maksimum dosya boyutu: yükleme başına 20 MB.
- Desteklenen formatlar: PDF, DOC, DOCX, TXT, Markdown.
- İçe aktarma işlemi arka plandaki işçiler tarafından eşzamansız olarak yürütülür.
- Konsoldaki bilgi işlemleri için çalışma alanı kapsamı gereklidir.
İçeri Alma Yaşam Döngüsü
- pending: dosya kabul edildi ve kuyruğa alındı.
- processing: çıkarma, bölümlendirme ve gömme işlemleri devam ediyor.
- processed: öğe dizinlendi ve sorgulamaya hazır.
- failed: içe aktarma başarısız oldu; tanılama meta verisi mevcut.
Hata Modelleri
400
Gönderilen veri geçersiz veya filtreler hatalı.
401
Kimlik doğrulama eksik veya geçersiz.
403
Rol/kapsam nedeniyle çalışma alanına erişim reddedildi.
404
Bilgi öğesi bulunamadı.
413
Yüklenen dosya izin verilen boyutu aşıyor.
415
Dosya içeriği türü desteklenmiyor.
422
İstek şeması veya bağlamında doğrulama hatası.
429
İstek sınırı aşıldı.
