Jetlink RAG (Bilgi Bankası) API Nasıl Kullanılır?

Bu doküman Jetlink RAG (Bilgi Bankası) servislerinin nasıl kullanılması gerektiğini anlatmaktadır.

Authorization

https://api.jetlink.io/v1/docs/index.html sayfasından buradaki yönergeleri uygulayarak authorize olun.

Mevcut bilgi bankası endpoint'leri aşağıdaki gibidir:

Endpoint:

POST /v1/LLM/StartKnowledgeBaseTraining

Bu endpoint, Jetlink LLM altyapısında bilgi bankası eğitim sürecini başlatmak için kullanılır.

Kullanım Amacı:

Bilgi bankasına eklenen veya güncellenen verilerin, LLM (Büyük Dil Modeli) tarafından yeniden eğitilmesi için bu endpoint'e istek atılır. Böylece, yeni bilgiler veya yapılan değişiklikler yapay zekâ tarafından hızlıca kullanılabilir hale getirilir.

Temel Parametreler:

companyId: Eğitim başlatılacak şirketin ID’si.
jetBotMainId: (Opsiyonel) Belirli bir JetBot için eğitim başlatmak istenirse kullanılır.
isForceStart: Eğitimi zorunlu olarak başlatmak için true gönderilir.

Başarılı yanıt örneği:

Endpoint:

PATCH /v1/LLM/UpdateKnowledgeBaseItemStatus

Kullanım Amacı:

Bilgi bankasında yer alan bir öğenin statüsünü (aktif, pasif, silinmiş) güncellemek için bu endpoint’e istek atılır. Böylece bilgi bankası yönetimini harici sistemler üzerinden de kolayca kontrol edebilirsiniz.

Temel Parametreler:

id: Durumu güncellenecek bilgi bankası kaydının ID’si.
jetBotMainId: (Opsiyonel) Belirli bir JetBot için işlem yapılacaksa kullanılır.
status: Yeni durum kodu.
- 1: Aktif
- 2: Pasif
- 3: Sil

Başarılı yanıt örneği:

Endpoint:

POST /v1/LLM/InsertKnowledgeBaseItem

Bu endpoint, Jetlink bilgi bankasına yeni bir kayıt eklemek için kullanılır.

Kullanım Amacı:

Bilgi bankasına yeni bir içerik eklemek istediğinizde bu endpoint ile kayıt işlemi gerçekleştirilir. Eklenen kayıt, belirtilen içerik ve statü ile bilgi bankasında tutulur.

Temel Parametreler:

jetBotMainId: (Opsiyonel) Belirli bir JetBot için kayıt eklenmek istenirse kullanılır.
companyId: Kayıt eklenecek şirketin ID’si.
name: Bilgi bankası kaydının adı.
content: Kayıt edilecek içerik.
status: Kayıt durumu.
- 1: Aktif
- 2: Pasif
- 3: Sil

Başarılı yanıt örneği:

Endpoint:

POST /v1/LLM/GetKnowledgeBaseItemList

Bu endpoint, Jetlink bilgi bankasında bulunan kayıtların listesini getirmek için kullanılır.

Kullanım Amacı:

Bilgi bankasında bulunan içeriklerin, belirli bir şirket ve JetBot için, duruma ve tarih aralığına göre sorgulanmasını sağlar. Böylece bilgi bankasındaki kayıtlar kolayca listelenebilir ve yönetilebilir.

Temel Parametreler:

jetBotMainId: (Opsiyonel) Belirli bir JetBot için sorgu yapmak istenirse kullanılır.
companyId: Listelenecek kayıtların ait olduğu şirketin ID’si.
startDate: (Opsiyonel) Kayıtların oluşturulma tarihine göre başlangıç (Unix timestamp veya boş bırakılabilir).
endDate: (Opsiyonel) Kayıtların oluşturulma tarihine göre bitiş (Unix timestamp veya boş bırakılabilir).
status: Kayıt durumu.
- 1: Aktif
- 2: Pasif
- 3: Sil

Başarılı yanıt örneği:

GET /v1/LLM/GetKnowledgeBaseItemDetails

Bu endpoint, Jetlink bilgi bankasında yer alan bir kaydın detaylarını getirmek için kullanılır.

Kullanım Amacı:

Belirli bir bilgi bankası kaydının tüm detaylarını (ör. ad, içerik, oluşturulma tarihi vb.) sorgulamak için kullanılır. Özellikle yönetim ve kontrol ekranlarında kayıt detayına ulaşmak için tercih edilir.

Temel Parametreler:

id: Detayları sorgulanacak bilgi bankası kaydının ID’si.

Başarılı yanıt örneği:

POST /v1/LLM/KnowledgeBaseSearch

Bu endpoint, Jetlink bilgi bankasında verilen metinle en alakalı kayıtları aramak ve listelemek için kullanılır.

Kullanım Amacı:

Girilen sorgu metnine (ör. kullanıcı mesajı) göre bilgi bankasındaki en yakın eşleşmeleri döndürür. Arama sonuçlarını, anlam veya anahtar kelime yakınlığına göre özelleştirebilirsiniz.

Temel Parametreler:

companyId: Arama yapılacak şirketin ID’si.
jetBotMainId: (Opsiyonel) Belirli bir JetBot üzerinde arama yapılacaksa kullanılır.
text: Sorgu metni.
topCount: (Opsiyonel, varsayılan=3) Döndürülecek maksimum eşleşme sayısı.
knowledgeBaseIdList: (Opsiyonel) Dahil edilmek istenen bilgi bankası kayıtlarının ID listesi.
semanticConvergence: (Opsiyonel, varsayılan=1.0) Anlamsal eşleşme hassasiyet ayarı (0-1 arası).
keywordConvergence: (Opsiyonel, varsayılan=0.0) Anahtar kelime eşleşme hassasiyet ayarı (0-1 arası).

Başarılı yanıt örneği:

POST /v1/LLM/UpdateKnowledgeBaseItem

Bu endpoint, Jetlink bilgi bankasında bulunan mevcut bir kaydı güncellemek için kullanılır.

Kullanım Amacı:

Bilgi bankasında yer alan bir kaydın adını, içeriğini veya durumunu güncellemek için kullanılır. Böylece bilgi bankası üzerinde değişiklik ve düzenleme işlemleri harici sistemlerden kolayca yönetilebilir.

Temel Parametreler:

id: Güncellenecek bilgi bankası kaydının ID’si.

jetBotMainId: (Opsiyonel) Belirli bir JetBot için işlem yapılacaksa kullanılır.

name: Kaydın güncellenecek adı.

content: Kaydın güncellenecek içeriği.

status: Kaydın yeni durumu.

1: Aktif

2: Pasif

3: Sil

Başarılı yanıt örneği:

DELETE /v1/LLM/DropKnowledgeBaseCollection

Bu endpoint, Jetlink bilgi bankasında ilgili şirkete ait tüm bilgi bankası koleksiyonunu (tüm kayıtları) silmek için kullanılır.

Kullanım Amacı:

Bir şirkete ait bilgi bankasındaki tüm kayıtları ve içerikleri kalıcı olarak silmek amacıyla kullanılır. Bu işlem geri alınamaz olduğu için yalnızca yetkili kullanıcılar tarafından, gerçekten gerekli durumlarda kullanılmalıdır.

Temel Parametreler:

companyId: Tüm bilgi bankası koleksiyonu silinecek olan şirketin ID’si.

Uyarı:

Bu endpoint çalıştırıldığında, belirtilen şirkete ait bilgi bankasındaki tüm kayıtlar silinir ve bu işlem geri alınamaz. Yanlışlıkla çalıştırmamak için dikkatli olunmalıdır.

Başarılı yanıt örneği:

Bu dokümandaki endpoint’ler sayesinde, Jetlink bilgi bankası entegrasyon ve yönetim süreçlerinizi hızlı, esnek ve güvenli bir şekilde gerçekleştirebilirsiniz. Herhangi bir sorunuz veya özel entegrasyon ihtiyacınız olması durumunda, lütfen teknik destek ekibimizle iletişime geçiniz.

Knowledge Base