4. Asistan API Entegrasyonu

API entegrasyonu, asistanın kod, webhook veya harici sistemler üzerinden programatik olarak çağrılmasını sağlar.

Entegrasyon yöntemi seçildikten sonra Başla seçeneğini kullanarak API yapılandırmasına geçebilirsiniz.

Bu işlem, seçili asistana ait API Anahtarları ekranını açar.

Bu ekran üzerinden API anahtarı görüntülenebilir ve kopyalanabilir, istek zaman aşımı ve hız limiti ayarları yapılandırılabilir ve ilgili API dokümantasyonuna erişilebilir.

4.1. API Anahtarı​

API Anahtarı, seçili asistanı harici sistemlerden çağırmak için kullanılan kimlik doğrulama bilgisidir.

Oluşturulan API anahtarı yalnızca seçili asistan için geçerlidir. Kapsam alanında API anahtarının hangi asistana ait olduğu görüntülenir.

API anahtarı, görüntüleme seçeneğiyle görüntülenebilir veya kopyalama seçeneğiyle kopyalanabilir.

API anahtarı gizli tutulmalıdır. Anahtara erişimi olan kişiler ilgili asistanı çağırabilir ve çalışma alanı kullanımını tüketebilir. Bu nedenle API anahtarı tarayıcı koduna, herkese açık kaynak kod depolarına veya yetkisiz kişilerin erişebileceği ortamlara eklenmemelidir.

4.2. İstek Zaman Aşımı​

İstek Zaman Aşımı, sunucunun yanıtını beklerken isteğin iptal edilmeden önce bekleyeceği maksimum süreyi belirler.

Bu değer, İstek Zaman Aşımı alanından yapılandırılabilir. Asistanın gerçekleştirdiği işlemlerin süresine göre uygun zaman aşımı değeri seçilebilir.

4.3. Hız Limiti ve Anlık Tolerans​

Hız Limiti, API üzerinden saniye başına gerçekleştirilebilecek istek sayısını belirler.

Bu değer Hız Limiti alanından yapılandırılabilir.

Anlık Tolerans, kısa süreli istek yoğunluklarında izin verilen ek istek kapasitesini gösterir.

Hız Limiti ve Anlık Tolerans değerleri, API üzerinden gerçekleştirilen isteklerin kontrollü şekilde yönetilmesini sağlar.

4.4. Asistan API Kullanımı​

Asistan API’si, seçili asistanın harici uygulamalar, webhook’lar veya diğer sistemler üzerinden çağrılmasını sağlar.

API isteği gönderilirken API Anahtarları ekranında oluşturulan anahtar kullanılmalıdır.

4.4.1. API Bağlantı Bilgileri​

4.4.2. Yetkilendirme​

API anahtarı, isteğin Authorization başlığına Bearer Token olarak eklenmelidir.

Authorization: Bearer YOUR_API_KEY
Content-Type: text/plain

YOUR_API_KEY alanı, API Anahtarları ekranından alınan anahtarla değiştirilmelidir.

4.4.3. Dosyasız Kullanım​

Asistana herhangi bir dosya göndermeden soru sormak için aşağıdaki istek gövdesi kullanılabilir:

{
  "query": "E-posta imzası neden görünmüyor?",
  "isStream": false,
  "citationType": "html"
}

4.4.4. Dosyalı Kullanım​

SkyStudio’ya daha önce yüklenmiş bir dosya üzerinden soru sormak için dosyanın adı veya kimliği file alanında gönderilir:

{
  "query": "Bu dosya ne hakkında?",
  "file": "IK_dataset_100.csv",
  "isStream": false,
  "citationType": "html"
}

Belirtilen dosyanın ilgili asistana veya çalışma alanına yüklenmiş ve erişilebilir olması gerekir.

4.4.5. Görsel URL ile Kullanım​

İnternet üzerinden erişilebilen bir görseli analiz ettirmek için görsel URL’si sorguya eklenebilir:

{
  "query": "https://example.com/image.png Bu görselde ne görüyorsun?",
  "isStream": false,
  "citationType": "html"
}

Görsel URL’sinin dışarıdan erişilebilir olması gerekir.

4.4.6. İstek Parametreleri​

4.4.7. Sorun Giderme​

API isteği başarısız olduğunda aşağıdaki kontroller yapılmalıdır:

• Endpoint adresinin doğru olduğundan emin olun.
• Method değerinin POST olduğunu kontrol edin.
• API anahtarının geçerli ve doğru asistana ait olduğunu doğrulayın.
• Authorization başlığında Bearer ifadesinin bulunduğunu kontrol edin.
• Content-Type değerinin doğru gönderildiğinden emin olun.
• İstek gövdesinin geçerli JSON biçiminde olduğunu kontrol edin.
• Dosyalı isteklerde dosyanın sisteme yüklenmiş ve erişilebilir olduğunu doğrulayın.
• İsteğin yapılandırılan zaman aşımı veya hız limiti değerlerini aşmadığından emin olun.

Sorun devam ederse dönen HTTP durum kodu ve hata mesajı incelenmelidir.