Sohbet
custom-chat görünüm türü, MonoChat'in kendi parçalarından kurulan bir sohbet ekranı gösterir: bir başlık, isteğe bağlı bir bağlam alanı, kayan bir mesaj listesi ve altta sabit bir yazma alanı. Açıldığı drawer'ı veya sayfayı doldurur. Tipik bir kullanım, gelen kutusundan açılan, görüşmeyi okuyan ve temsilci için bir yanıt taslağı hazırlayan bir AI asistanıdır.
Aynı parçalar başka herhangi bir görünümde (form, sekme paneli, workspace) kullanabileceğiniz öğeler olarak da vardır: chat-bubble, chat-message-list ve chat-composer.
Sohbetin göründüğü yerler
Bir custom-chat görünümü her customViewLocation ile çalışır: navbar (kendi ekranı), settings, report-menu, dashboard-widget, session-widget ya da onu bir drawer'da açan session-footer-action ve message-action. Bu ikisi için @monochat-sync bloğundaki customViewDrawerSize drawer boyutunu seçer: lg (varsayılan), xl veya full.
/* @monochat-sync
{
"type": "custom-view",
"name": "assistant.js",
"title": "Assistant",
"sdkVersion": 1,
"customViewType": "custom-chat",
"customViewLocation": "session-footer-action",
"customViewIconName": "sparkle",
"customViewDrawerSize": "xl"
}
*/
Örnek: gelen kutusunda bir AI asistanı
Görünüm açık görüşmeyi okur, temsilcinin sorusunu çalışma alanının AI modellerinden birine gönderir ve yanıtı Put in reply ve Send eylemleriyle bir ai balonu olarak gösterir.
CustomFunction(async function ({ sdk }, reject, resolve) {
resolve(async function CustomFunction({ sdk }) {
const session = sdk.templateInstance.data._payload.session
const aiModelClientId = 'YOUR_AI_MODEL_ID'
const bubbles = new ReactiveVar([])
const isLoading = new ReactiveVar(false)
const conversation = await sdk.method({ name: 'business.tenants.chat.sessions.messages.listBySessionId' }).callAsync({
payload: { sessionId: session._id, options: { pagination: { currentPage: 1, pageItems: 50 }, sorting: { 'payload.createdAt': -1 } } },
})
const transcript = (conversation?.messages || [])
.filter((message) => message.type === 'text')
.reverse()
.map((message) => `${message.direction === 'incoming' ? 'Customer' : 'Agent'}: ${message.payload.text.text}`)
.join('\n')
const replyActions = function (message) {
return [
{
type: 'atoms-button',
text: 'Put in reply',
iconName: 'arrow-bend-up-left',
size: 'sm',
variant: 'primary-ghost',
events: { onClick: () => sdk.chat.composer.put(message) },
},
{
type: 'atoms-button',
text: 'Send',
iconName: 'paper-plane-tilt',
size: 'sm',
variant: 'primary-ghost',
isHidden: !session.connector().messagesRules[message.type]?.enabled,
events: {
onClick: () => sdk.method({ name: 'business.tenants.chat.sessions.messages.create' }).callAsync({ payload: { sessionId: session._id, type: message.type, isWhisper: false, payload: message.payload } }),
},
},
]
}
const ask = async function (question) {
bubbles.set([...bubbles.get(), { type: 'chat-bubble', direction: 'outgoing', message: { type: 'text', payload: { text: { text: question } } }, time: new Date() }])
isLoading.set(true)
const response = await sdk.method({ name: 'business.tenants.automation.ai.inferences.chatWithCustomMessages' }).callAsync({
payload: {
aiModelClientId,
systemPrompt: `You help an agent answer a customer. The conversation so far:\n${transcript}`,
aiMessages: [{ role: 'user', content: question }],
},
})
isLoading.set(false)
if (!response) {
return
}
const message = { type: 'text', payload: { text: { text: response.result } } }
bubbles.set([...bubbles.get(), { type: 'chat-bubble', variant: 'ai', isMarkdown: true, author: { name: 'Assistant', iconName: 'sparkle' }, message, time: new Date(), actions: replyActions(message) }])
}
sdk.options = function () {
return {
header: { title: 'Assistant', iconName: 'sparkle' },
messages: isLoading.get() ? [...bubbles.get(), { type: 'chat-bubble', variant: 'ai', isTyping: true }] : bubbles.get(),
notFound: { iconName: 'sparkle', title: 'Ask about this conversation' },
suggestions: [{ text: 'What does the customer want?', isSend: true }],
isLoading: isLoading.get(),
composer: { events: { onSend: (text) => ask(text) } },
}
}
})
})
response.result modelin yanıtıdır. Bir uygulamanın hangi AI modelini çağırdığı ve onu çağırma yetkisi olmayan bir kullanıcıya bunu nasıl söylediği uygulamanın kendi seçimidir.
custom-chat seçenekleri
| Anahtar | Açıklama |
|---|---|
header | { title, text, iconName, iconColor, titleSize, badgeText, badgeVariant, actions }; actions bir öğe dizisidir. |
context | Başlık ile liste arasında gösterilen öğe dizisi, örneğin bir atoms-alert veya müşterinin adı. |
messages | Liste için öğe dizisi. type taşımayan bir öğe chat-bubble'dır. Listenin güncellenmesi için bir ReactiveVar'dan okuyun. |
notFound | messages boşken gösterilen { iconName, title, text }. |
events | Kullanıcı listenin en üstüne kaydırdığında çağrılan { onLoadMore(event, templateInstance) }. |
composer | Aşağıdaki chat-composer anahtarları, type olmadan. |
suggestions | Yazma alanının öneri çipleri (aşağıya bakın). |
isLoading | Uygulama beklerken yazma alanının yükleniyor durumunu gösterir; gönder düğmesi devre dışı kalır. |
chat-bubble
Bir balon, mesajı gelen kutusunun kullandığı şablonlarla gösterir; böylece her MonoChat mesaj türü bir görüşmedeki gibi görünür. Gelen kutusunun mesaj menüsü, okundu durumu ve tepkileri gösterilmez; balon bunların yerine kendi zamanını, durumunu ve eylemlerini gösterir.
| Anahtar | Açıklama |
|---|---|
message | Bir MonoChat mesajı biçiminde { type, payload }: { type: 'text', payload: { text: { text } } }. listBySessionId ile okunan bir mesaj olduğu gibi verilebilir. |
session | İsteğe bağlı. Bir görüşme verildiğinde (örneğin sdk.env.session) tür, o görüşmenin kanalında göründüğü gibi gösterilir. |
direction | incoming (varsayılan) veya outgoing. |
variant | default, ai, note veya error. |
author | Balonun üstünde gösterilen { name, avatarSrc, iconName }. |
time | Balonun altında gösterilen bir Date. Mesaj listesi bunu tarih ayırıcıları için de kullanır. |
status | sending, sent veya failed. |
actions | Balonun altında gösterilen öğe dizisi, genellikle atoms-button. |
isTyping | Mesaj yerine bir yazıyor göstergesi gösterir. |
isMarkdown | Bir text mesajı için metni temizlenmiş markdown olarak gösterir. AI yanıtlarında kullanın. |
className | Balona eklenen bir sınıf. |
Medya URL'leri gelen kutusunda olduğu gibi imzalı okunur. Gelen kutusunun gösteremediği bir tür orada olduğu gibi, desteklenmiyor olarak görünür.
Örnek mesajlar
{ type: 'text', payload: { text: { text: 'Hello!' } } }
{ type: 'image', payload: { image: { fileUrl, caption: 'Our new menu' } } }
{ type: 'video', payload: { video: { fileUrl, caption } } }
{ type: 'document', payload: { document: { fileUrl, fileName: 'invoice.pdf', caption } } }
{ type: 'audio', payload: { audio: { fileUrl } } }
{ type: 'location', payload: { location: { latitude: 41.04, longitude: 29.0, address: 'Office' } } }
Diğer her tür, payload'ını aynı şekilde kendi anahtarı altında alır: bir görüşmedeki o türden bir mesajın payload'ı.
chat-message-list
| Anahtar | Açıklama |
|---|---|
items | Gösterilecek öğeler; type taşımayan bir öğe chat-bubble'dır. |
notFound | Boş bir liste için { iconName, title, text }. |
events | Listenin en üstünde çağrılan { onLoadMore(event, templateInstance) }. |
className | Listeye eklenen bir sınıf. |
Liste, kullanıcı yukarı kaydırmadıkça mesajlar geldikçe en altta kalır; kaydırdığında aşağı kaydırma düğmesi görünür. Kapsayıcısının yüksekliğini doldurur, bu yüzden bir formda kullandığınızda ona bir yükseklik verin (className).
chat-composer
| Anahtar | Açıklama |
|---|---|
events | { onSend(text, templateInstance) }. Enter gönderir, Shift+Enter yeni satır başlatır. Yazma alanı gönderdikten sonra kendini temizler. |
value | Metni tutan bir ReactiveVar; yazma alanını doldurmak veya temizlemek için onu ayarlayın. |
placeholder | Yer tutucu metin. |
maxlength | En uzun metin, bir sayaçla. |
isDisabled | Yazma alanını devre dışı bırakır. |
isLoading | Yükleniyor durumunu gösterir; gönder düğmesi devre dışı kalır. |
suggestions | Girişin üstündeki çipler: [{ text, prompt, iconName, isSend }]. Tıklama girişi prompt (veya text) ile doldurur ya da isSend true olduğunda onu gönderir. |
leftActions, rightActions | Girişin yanındaki öğeler. |
name, className | Textarea'nın adı ve yazma alanına eklenen bir sınıf. |
Yazma alanı uygulamanın kendi girişidir. Gelen kutusunun yanıt kutusuna dokunmaz.
Gelen kutusu yanıt kutusuna taslak koymak
sdk.chat.composer.put(message, { includeMedia, mode }), temsilcinin kontrol edip göndermesi için açık görüşmeye bir taslak verir. Hiçbir şey gönderilmez. Bkz. Utils.
Mesaj göndermek
Balonun type ve payload değerleriyle her türü business.tenants.chat.sessions.messages.create ile gönderin. Send seçeneğini yalnızca görüşmenin kanalı türü desteklediğinde sunun: sdk.env.session.connector().messagesRules[type]?.enabled.