Ana içeriğe geç

Prediction API

Prediction API bir akışı HTTP üzerinden çalıştırır. Bir mesaj gönderirsiniz, akışın yanıtını alırsınız — bir arka uçtan, bir mobil uygulamadan, bir betikten ya da bir otomasyon platformundan.

Akışı HTTP üzerinden çalıştırma

POST /api/v1/prediction/<akisId>

Bir akışı açıp canvas başlığındaki API Endpoint düğmesine basın; Flowera o akış için kimliği doldurulmuş hazır isteği Python, JavaScript ve cURL sürümleriyle gösterir.

API penceresi: Embed, Python, JavaScript, cURL ve Share Chatbot sekmeleri.

Kimlik doğrulama

Bkz. API anahtarları.

Anahtarı bearer token olarak gönderin:

Authorization: Bearer <api_anahtariniz>

Anahtarın zorunlu olup olmadığı akışa bağlıdır. Her akışın bir güvenlik ayarı vardır: açık bırakırsanız kimliği bilen herkes çağırabilir; bir anahtar eklerseniz yalnızca o anahtar çalışır.

Açık uç noktalar yerel geliştirme içindir. Üretimde bir anahtar ekleyin — açık bir prediction uç noktası, kredinizi harcamak için açık bir davetiyedir.

Bir adresi geçici olarak engelleyen şey var olmayan akış kimliklerini çağırmaktır — 15 dakika içinde üç 404, adresi bir saat engeller; bu, kimlik taramasını durdurmak içindir. Hatalı anahtar 401 döner ve sayılmaz, yani bozuk bir entegrasyon kendini kilitlemez; yine de anahtarı yeniden denemek yerine düzeltin.

İstek gövdesi

{
"question": "Çalışma saatleriniz nedir?",
"chatId": "musteri-4821",
"overrideConfig": {
"vars": { "customerTier": "premium" }
}
}
AlanZorunluNe yapar
questionEvetAkışın aldığı mesaj
chatIdHayırOturum. Bir konuşmayı sürdürmek için aynısını kullanın
overrideConfigHayırÇalıştırmaya enjekte edilen değerler; akış değişkenleri dahil
uploadsHayırEklenecek dosyalar — görsel, ses, doküman
streamingHayırtrue, yanıtı Server-Sent Events olarak akıtır. Varsayılanı false

Oturumlar ve geçmiş

Bir konuşmayı konuşma yapan şey chatId'dir.

  • İstekler arasında aynı chatId'yi gönderin; akış belleğini ve Flow State değerlerini korur — müşteri kendini tekrar etmez.
  • Göndermezseniz her istek geçmişi olmayan bir yabancıdır.

Kendi sisteminizden sabit bir tanımlayıcı kullanın — bir müşteri kimliği, bir talep numarası. Sonradan arayabileceğiniz bir şey olsun; çünkü Mesajları Görüntüle ve Çalıştırmalar sayfalarında arayacağınız değer aynısıdır.

Streaming yanıtlar

Streaming, yanıtı sonunda tek blok hâlinde değil üretildikçe token token döndürür. Bir insanın izlediği her yerde kullanın — toplam süre aynı olsa da algılanan bekleme çarpıcı biçimde kısalır.

Kimsenin izlemediği sunucudan sunucuya çağrılarda zahmet etmeyin: streaming olmayan yanıtı ele almak daha basittir.

İstek gövdesinde "streaming": true ile talep edin. Akışın da bunu desteklemesi gerekir — akıtılabilir bir node ile bitmeyen bir akış, hata vermeden sıradan JSON döndürür; bu yüzden bayrağın işe yaradığını varsaymak yerine yanıtın content type'ını kontrol edin.

Hata yönetimi

DurumAnlamıNe yapmalı
401Hatalı ya da eksik API anahtarıAnahtarı ve akışın güvenlik ayarını kontrol edin
402Yetersiz bakiyeYükleme yapın — bkz. Düşük bakiye
403İzin Verilen Alan Adları engelledi ya da paylaşım linki herkese açık değilAkışın İzin Verilen Alan Adları'nı ve Make Public anahtarını kontrol edin
404Böyle bir akış yokAkış kimliğini kontrol edin. 15 dakikada üç tanesi adresinizi bir saat engeller
429Hız sınırıGeri çekilin. Hız sınırları akış başına yapılandırılabilir
500Akış başarısız olduÇalıştırmayı açın — iz hangi node olduğunu gösterir

İşe yarayan 500 durumudur: entegrasyonunuzdaki bir hata ile akışın içindeki bir hata dışarıdan birebir aynı görünür ve ikisini ayıran şey çalıştırma izidir. Her API çağrısı, tıpkı arayüzden yapılan bir çalıştırma gibi bir çalıştırma üretir.

Pratik notlar

  • Çalıştırmalar kredi harcar. Bir test döngüsü gerçek bir ücrettir; Kullanım Paneli'ni izleyin.
  • Zaman aşımı belirleyin. Yavaş araçları olan bir akış onlarca saniye sürebilir; beş saniyede vazgeçen bir istemci, bozuk olmadığı hâlde bozuk görünür.
  • Önce canvas'ta test edin. Sohbet paneli ile API aynı akışı çalıştırır ve orada hata ayıklamak çok daha hızlıdır.

İlgili