Knowledge Folder API genel bakış
Knowledge base'leri programatik olarak listeleyin, paylaşın, yeniden adlandırın, yükleyin, yönetin ve arayın
Knowledge Folder API, bir workspace anahtarının kullanabileceği Knowledge base'leri listelemenizi, erişimi yönetmenizi ve yeniden adlandırmanızı sağlar. Dosyaları programatik olarak yükleyebilir, yönetebilir ve arayabilirsiniz. Yüklenen dosyalar işlenir, embedding'lenir ve anlamsal arama için kullanılabilir hale gelir. API, Library'de Knowledge base olarak görünen kaynakları yönetir.
Başlamadan önce
- API key scope:
KNOWLEDGE_FOLDER_APIkapsamına sahip bir API anahtarı gerekir. Knowledge base API anahtarıyla paylaşılmış olmalıdır; yazma işlemleri Editor rolü gerektirir. Anahtarın zaten kullanabileceği id'leri keşfetmek için List Knowledge bases kullanın. Bkz. Share Knowledge bases with the API.
Base URL
https://api.ajan.ioDedicated deployments Tüm isteklerde
api.ajan.com'u/api/publicile değiştirin.
Kullanılabilir endpoint'ler
| Method | Endpoint | Description |
|---|---|---|
GET | /knowledge | List Knowledge bases |
POST | /knowledge/{folderId}/access | Grant Knowledge base access |
PATCH | /knowledge/{folderId}/access | Change Knowledge base access |
DELETE | /knowledge/{folderId}/access | Revoke Knowledge base access |
PATCH | /knowledge/{folderId}/folder | Update a Knowledge base |
POST | /knowledge/{folderId} | Upload a file to a Knowledge base |
GET | /knowledge/{folderId}/list | List files in a Knowledge base |
PATCH | /knowledge/{folderId} | Update a file in a Knowledge base |
DELETE | /knowledge/{folderId}/{attachmentId} | Delete a file from a Knowledge base |
POST | /knowledge/search | Search across Knowledge bases |
Kılavuzlar
- Share Knowledge bases with the API: API anahtarı oluşturun ve bir Knowledge base'i onunla paylaşın