Sohbet

İsteğe bağlı örnek kontrolleri

• Bir API Eylemi isteğini önizleyin. Verilen istek şablonunu göndermeden, sentetik örnek değerlerle oluşturun. Kimlik bilgisi içeren üstbilgileri eklemeyin.

• Meta veri anahtarlarını önizleyin. Yinelenen adlar ve ayrılmış anahtar hataları dahil verilen alan adlarının değişken anahtarlarına nasıl dönüştüğünü kontrol edin. Bu araç değerleri veya hesaba özel izinleri incelemez.

Sohbet

Gerçek zamanlı Chat uç noktası, ziyaretçi mesajını AI Temsilcinize gönderir ve AI yanıtını tek istek-yanıt döngüsünde döndürür. Quickchat AI üzerinde özel bir sohbet arayüzü oluştururken kullanmanız gereken uç nokta budur.

Diğer uç noktalardan iki açıdan ayrılır: /v1/api/ ve /v1/api_core/ temel yollarının dışında, app.quickchat.ai/chat adresindedir ve scenario_id değerini belirteçten değil istek gövdesinden okur. Bu API’nin geri kalanıyla aynı Bearer belirteci kimlik doğrulamasını kullanır.

Not

Her isteği https://app.quickchat.ai/chat adresine gönderin. Gövdedeki scenario_id, Bearer belirtecinizin bağlı olduğu AI Temsilcisiyle eşleşmelidir.

Mesaj gönderme

POST https://app.quickchat.ai/chat

İstek gövdesi

Parametre	Açıklama
scenario_id dize, zorunlu	AI Temsilcinizin kimliği. Bearer belirtecine bağlı scenario_id ile eşleşmelidir
text dize, zorunlu	Kullanıcının girdiği mesaj
conv_id dize	Konuşma kimliği. Yeni konuşma başlatmak için ilk istekte göndermeyin. Devam etmek için sonraki isteklerde dönen conv_id değerini geri gönderin
client_metadata nesne	Her mesaja eklenen özel anahtar-değer çiftleri (en fazla 5 anahtar öneririz). Gelen Kutusundaki konuşma dışa aktarımında veri sütunları olarak gösterilir

conv_id içermeyen bir istek yeni konuşma başlatır ve oluşturulan conv_id yanıtta döndürülür. Birden fazla kullanıcı etkileşiminde konuşma bağlamını korumak için bu conv_id değerini saklayın ve sonraki isteklerde geri gönderin.

Shell

# Start a new conversation by omitting conv_id
curl -X POST https://app.quickchat.ai/chat \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "scenario_id": "<SCENARIO_ID>",
  "text": "Hello!"
}'

Python

import requests

response = requests.post(
    url="https://app.quickchat.ai/chat",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={
        "scenario_id": "<SCENARIO_ID>",
        "text": "Hello!",
    },
)
data = response.json()

Yanıt 200 OK

{
  "conv_id": "conv-uuid-1234",
  "reply": "Hi there! How can I help you today?",
  "ord_number": 3,
  "src": 0
}

Alan	Açıklama
conv_id dize	Konuşma tanımlayıcısı. Her zaman döndürülür. Konuşmaya devam etmek için gövdedeki conv_id alanında geri gönderin
reply dize	AI Temsilcisinin yanıtı. <br> satır sonları gibi HTML içerebilir
ord_number tamsayı	Konuşma içindeki sıralı mesaj numarası
src tamsayı	Dahili kaynak göstergesi. API istemcileri bu alanı yok sayabilir

Mevcut bir konuşmaya devam etmek için aldığınız conv_id değerini geri gönderin:

Shell

curl -X POST https://app.quickchat.ai/chat \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "scenario_id": "<SCENARIO_ID>",
  "conv_id": "conv-uuid-1234",
  "text": "What is your return policy?"
}'

Python

import requests

response = requests.post(
    url="https://app.quickchat.ai/chat",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={
        "scenario_id": "<SCENARIO_ID>",
        "conv_id": "conv-uuid-1234",
        "text": "What is your return policy?",
    },
)
data = response.json()

İstemci meta verileri

Chat uç noktası isteğe bağlı client_metadata parametresini kabul eder: her yeni mesaja atanan ve Gelen Kutusundaki konuşma dışa aktarımında veri sütunları olarak gösterilen özel öznitelikler. Aynı öznitelikleri widget üzerinden de ekleyebilirsiniz. Bir seferde en fazla 5 anahtar göndermenizi öneririz; örneğin {"userId": 12, "website": "mywebsite.com"}. Bu bir öneridir, API tarafından uygulanan bir sınır değildir.

Shell

curl -X POST https://app.quickchat.ai/chat \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "scenario_id": "<SCENARIO_ID>",
  "conv_id": "conv-uuid-1234",
  "text": "Hello!",
  "client_metadata": {"userId": 12, "website": "mywebsite.com"}
}'

Python

import requests

response = requests.post(
    url="https://app.quickchat.ai/chat",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={
        "scenario_id": "<SCENARIO_ID>",
        "conv_id": "conv-uuid-1234",
        "text": "Hello!",
        "client_metadata": {"userId": 12, "website": "mywebsite.com"},
    },
)
data = response.json()

Bilgi Tabanı etiket filtreleme

Bilgi Tabanı makalelerine etiketler ekleyebilir ve AI’ın yararlandığı makaleleri sınırlandırarak yalnızca Bilgi Tabanının bir alt kümesine göre yanıt vermesini sağlayabilirsiniz. Bu filtreleme şu anda yalnızca API üzerinden desteklenir.

Etikete göre filtrelemek için client_metadata içine kb_topic anahtarı ekleyin. kb_topic anahtarı, konuşmayı başlatan istek dahil konuşmadaki her istekte bulunmalıdır. Değeri istekler arasında değişebilir, ancak filtrenin uygulanması için anahtarın kendisi konuşma boyunca mevcut olmalıdır.

Aşağıdaki örnekte your-topic etiketli veya hiç etiketi olmayan tüm makaleler yanıt için aday bilgi havuzuna dahil edilir.

json={
    "scenario_id": "<SCENARIO_ID>",
    "conv_id": "conv-uuid-1234",
    "text": "Hello!",
    "client_metadata": {"kb_topic": "your-topic"},
}

Hatalar

Chat uç noktası, uygun HTTP durum koduyla birlikte düz metin hata mesajı döndürür.

Durum	Açıklama	Yapılacak işlem
400	scenario_id eksik veya kimlik bilgisi sağlanmamış	Gövdeye scenario_id ve geçerli bir Authorization: Bearer <API_TOKEN> üstbilgisi ekleyin
400	Geçersiz conv_id (Conversation conv_id <id> is not valid.)	Yeni konuşma başlatmak için conv_id göndermeyin veya önceki yanıttan dönen bir conv_id gönderin
401	Geçersiz kimlik bilgileri (Unauthorized.)	Bearer belirtecinizin veya API anahtarınızın bu scenario_id için geçerli olduğunu kontrol edin
404	Bilinmeyen scenario_id (No implementation found for scenario_id <id>)	scenario_id değerini ve Bearer belirtecinizin ona bağlı olduğunu doğrulayın
500	Dahili sunucu hatası	Bizim tarafımızda bir sorun oluştu. Destekle iletişime geçin
503	Hizmet kullanılamıyor	Sunucular geçici olarak aşırı yüklü veya bakımda. Sorun devam ederse destekle iletişime geçin