Etkileşimli Canvas API referansı

Interactive Canvas API, web uygulamanızın interactiveCanvas nesnesini kullanarak Conversational Action ile arayüz oluşturmak için kullandığınız bir JavaScript kitaplığıdır.

Etkileşimli Tuval hakkında daha fazla bilgi için Etkileşimli Tuval belgelerine bakın.

Yöntemler

hazır

ready(callbacks) returns undefined

Geri çağırmaları kaydetmek için yüklendikten sonra Etkileşimli Tuval web uygulaması tarafından çağrılır.

Parametreler
callbacks InteractiveCanvasCallbacks

Yöntem geri çağırmaları içeren bir nesne.

sendTextQuery

sendTextQuery(textQuery) returns Promise<state>

Görüşme işlemine bir metin sorgusu gönderir.

Parametreler
textQuery string

Görüşme işlemine gönderilecek sorgu.
state string

Şunlardan biri:

READY: İstekler platform tarafından kabul edilebilir.

BLOCKED: Yayında bir sorgu var ve yeni sorgu atlanacak.

UNKNOWN: Geçerli sorgu durumu belirlenemedi.

getHeaderHeightPx

getHeaderHeightPx() returns Promise<height>

Bir ekranın üst kısmındaki üstbilginin yüksekliğini belirler.

Parametreler
height number

Piksel cinsinden yükseklik.

outputTts

outputTts(text, openMic) returns undefined;

SSML metnini çalar.

Parametreler
text string

SSML destekli ve oynatılacak dize.
openMic boolean

TTS çaldıktan sonra mikrofonun açılıp açılmayacağını belirler.

createIntentHandler

createIntentHandler(intentId, callback) returns IntentHandler

NLU özel amacı için bir intent işleyici oluşturur.

Parametreler
intentId string

Actions Builder'da tanımlanan amaç adı.
callback function(MatchedIntent)

Amaç eşleştiğinde yürütülecek işlev.
IntentHandler object

expect() ile kaydedilebilen amaç işleyici nesnesi.

IntentHandler

Amaç işleyiciyi temsil eden bir nesne. expect() veya prompt() kullanılarak kaydedilebilir.

MatchedIntent

Eşleşen bir amacın verilerini içeren bir nesne.

Yöntemler
getIntentArg(parameterName) function(string)

Eşleşen bir amacın intent parametresini alma yöntemi.

createNumberSlot

createNumberSlot(callback, hints?) returns Slot<number>

Numara türünde bir alan oluşturur.

Parametreler
callback function(FilledSlot)

Alan doldurulduğunda yürütülecek işlev.
hints Hints

Kullanıcının bir alanı doldururken söyleyebileceği kısa kelimeler. hints, NLU sisteminin hangi alanı dolduracağına karar vermesine yardımcı olur.
Slot object

prompt() kullanılarak kaydedilebilen slot nesnesi.

createTextSlot

createTextSlot(callback, hints?) returns Slot<string>

Dize türünde bir alan oluşturur.

Parametreler
callback function(FilledSlot)

Alan doldurulduğunda yürütülecek işlev.
hints Hints

Kullanıcının bir alanı doldururken söyleyebileceği kısa kelimeler. hints, NLU sisteminin hangi alanı dolduracağına karar vermesine yardımcı olur.
Slot object

prompt() kullanılarak kaydedilebilen slot nesnesi.

createConfirmationSlot

createConfirmationSlot(callback, hints?) returns Slot<boolean>

Boole türünde bir alan oluşturur.

Parametreler
callback function(FilledSlot)

Alan doldurulduğunda yürütülecek işlev.
hints Hints

Kullanıcının bir alanı doldururken söyleyebileceği kısa kelimeler. hints, NLU sisteminin hangi alanı dolduracağına karar vermesine yardımcı olur.
Slot object

prompt() kullanılarak kaydedilebilen slot nesnesi.

createOptionsSlot

createOptionsSlot(options, callback, hints?) returns Slot<string>

Önceden tanımlanmış seçenek listesinden bir alan oluşturur.

Parametreler
options array<Option>

Alan doldurulduğunda yürütülecek işlev.
callback function(FilledSlot)

Alan doldurulduğunda yürütülecek işlev.
hints Hints

Kullanıcının bir alanı doldururken söyleyebileceği kısa kelimeler. hints, NLU sisteminin hangi alanı dolduracağına karar vermesine yardımcı olur.
Slot object

prompt() kullanılarak kaydedilebilen slot nesnesi.

Alan

Doldurulacak alanı temsil eden bir nesne. expect() veya prompt() kullanılarak kaydedilebilir.

FilledSlot<T>

Doldurulmuş alanı temsil eden bir nesne.

Parametre
T boolean|number|string

Alan türü.

Option

Slot türü girişini temsil eden bir nesne.

Alanlar
key string

Slot türü girişinin benzersiz tanımlayıcısı.
synonyms array<string>

Alan seçeneğini belirlemek için kullanılan kelimelerin listesi.

İpuçları

Bir alanla ilgili ipuçlarını temsil eden bir nesne.

Alanlar
associatedWords array<string>

NLU sisteminin hangi alanın doldurulacağına karar vermesine yardımcı olmak için kullanılan kelime listesi.

expect

expect(expectation) returns HandlerRegistration

Müşterideki beklentiyi kaydeder. Amaç işleyicilerde ve alanlarda çağrılabilir.

Parametreler
expectation IntentHandler|Slot

Kaydedilecek amaç işleyici veya alan.
HandlerRegistration object

Kayıtlı amaç işleyici veya alan.

HandlerRegistration

Kayıtlı bir amaç işleyiciyi temsil eden bir nesne.

Yöntemler
deleteHandler() function

Beklenen amaç işleyicinin kaydını iptal eder.

clearExpectations

clearExpectations() returns undefined;

Önceden kaydedilmiş tüm amaç işleyicileri ve alanları silerek tüm beklentileri ortadan kaldırır.

istem

prompt(tts, expectation) returns Promise<Answer<T>>

Kullanıcıya sağlanan TTS dizesini ister ve beklentiyi istemciye kaydeder. Amaç işleyicilerde ve alanlarda çağrılabilir.

Parametreler
tts string

Sağlanan beklenti için kullanıcıyı istemek amacıyla kullanılan TTS dizesi.
expectation IntentHandler|Slot

Kaydedilecek amaç işleyici veya alan.
Answer<T> object

İsteme yönelik kullanıcı tarafından sağlanan yanıt.

Cevap<T>

Bir isteme verilen kullanıcı tarafından sağlanan yanıtı temsil eden nesne.

Alanlar
value boolean|number|string

Kullanıcı tarafından sağlanan cevabın değeri.
status string

Yanıt durumu.

Şunlardan biri:

ANSWERED: Kullanıcı, isteme bir yanıt ile yanıt verdi.

NO_MATCH: Kullanıcıdan yanıt vermesi istendi ve beklenen yanıt veya beklenen başka bir amaçla eşleşmeyen bir yanıt verildi.

YIELD: Kullanıcı, isteğe farklı bir amaçla yanıt verdi.

triggerScene

triggerScene(sceneName) returns Promise<TriggerSceneStatus>

Bir sahneyi tetikler.

Parametreler
sceneName string

Tetiklenecek sahnenin adı.
TriggerSceneStatus string

tetikleyiciScene() çağrısının durumu.

Şunlardan biri:

SUCCESS: İstek, sunucu tarafından başarıyla işlendi.

BLOCKED: İstek, yayındaki mevcut bir sorgu tarafından engellendi.

UNKNOWN: İsteğin durumu bilinmiyor.

setUserParam

setUserParam(key, value) returns Promise<undefined>;

İleti dizileri arasında iletilen ve sürdürülen anahtar/değer çiftini ayarlar.

Parametreler
key string

Parametre anahtarı.
value object|array|boolean|number|string

Parametre değeri.

getUserParam

getUserParam(key) returns Promise<object|array|boolean|number|string>;

Belirli bir anahtar varsa o anahtar için param değerini ve çağrının durumunu alır.

Parametreler
key string

Parametre anahtarı.

resetUserParam

resetUserParam() returns Promise<void>;

Tüm kullanıcı parametrelerini temizler.

setHomeParam

setHomeParam(key, value) returns Promise<undefined>;

İleti dizileri arasında iletilen ve sürdürülen anahtar/değer çiftini ayarlar.

Parametreler
key string

Parametre anahtarı.
value object|array|boolean|number|string

Parametre değeri.

getHomeParam

getHomeParam(key) returns Promise<object|array|boolean|number|string>;

Belirli bir anahtar varsa o anahtar için param değerini ve çağrının durumunu alır.

Parametreler
key string

Parametre anahtarı.

resetHomeParam

resetHomeParam() returns Promise<void>;

Tüm kullanıcı parametrelerini temizler.

setCanvasState

setCanvasState(state) returns undefined

Asistan'a Canvas web uygulamasının durumunu güncellediğini bildirir. setCanvasState yöntemi değer döndürmez. Eyalet yüküne conv.context.canvas.state mülkü üzerinden erişilebilir.

Parametreler
state Object

Canvas uygulamasının JSON nesnesi olarak güncellenmiş durumu.

InteractiveCanvasCallbacks

Bu geri çağırma yöntemleri, Conversational Action'ınızdan gelen bilgi veya isteklere yanıt vermeniz için bir yol sunarken, yöntemler Conversational Action'ınıza bilgi veya istek göndermeniz için bir yol sağlar.

onUpdate

onUpdate(data) returns Promise|undefined

Conversational Action'dan Canvas yanıtı gönderildiğinde çağrılır. TTS, geri verilen söz çözümlendiğinde başlar veya 10 saniye sonra zaman aşımına uğrar.

Parametreler
data Object

Webhook tarafından gönderilen veriler güncellendi.

onTtsMark

onTtsMark(markName) returns undefined

TTS oynatma sırasında çağrılan geri arama.

Her zaman tetiklenen özel işaretler:

  • START, TTS'nin başlangıcını gösterir.
  • END, TTS'nin sonunu gösterir.
  • ERROR, TTS oynatılırken hata olduğunu gösterir.

Özel işaretleri, <mark name="custom"/> gibi SSML ve <mark> etiketini kullanarak da tanımlayabilirsiniz.

Parametreler
markName string

TTS oynatma sırasında çağrılan adı işaretle

onInputStatusChanged

onInputStatusChanged(inputStatus) returns undefined

Canvas uygulamasına Asistan giriş durumunun değiştiğini bildirir.

Parametreler
inputStatus Enum

Cihazda ses ve/veya metin girişi işlemenin durumu. Aşağıdakiler olabilir:

  • LISTENING : Mikrofon açık.
  • IDLE : Mikrofon kapalı.
  • PROCESSING : Asistan şu anda bir sorgu yürütüyor (mikrofon kapalı).