Interactive Canvas API'yi arayüz oluşturmak için kullandığınız
Konuşma İşleminizle birlikte, web uygulamanızdaki interactiveCanvas
nesnesini kullanabilirsiniz.
Etkileşimli Tuval hakkında daha fazla bilgi için bkz. Etkileşimli Tuval dokümanlarına göz atı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>
Sohbet işlemine bir metin sorgusu gönderir.
Parametreler | |
---|---|
textQuery |
string
Konuşma işlemine gönderilecek sorgu. |
state |
string
Aşağıdakilerden biri:
|
getHeaderHeightPx
getHeaderHeightPx() returns Promise<height>
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 tarafından desteklenen dize. |
openMic |
boolean
TTS çaldıktan sonra mikrofonun açılıp açılmayacağı. |
createIntentHandler
createIntentHandler(intentId, callback) returns IntentHandler
NLU özel intent için intent işleyici oluşturur.
Parametreler | |
---|---|
intentId |
string
Eylem Oluşturucu'da tanımlanan amaç adı. |
callback |
function(MatchedIntent)
Amaç eşleştiğinde yürütülecek işlev. |
IntentHandler |
object
|
IntentHandler
Niyet işleyiciyi temsil eden bir nesne. expect()
veya prompt()
kullanılarak kaydedilebilir.
MatchedIntent
Eşleşen bir amaca yönelik verileri içeren 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>
Sayı 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 boşluğu doldururken söyleyebileceği kısa kelimeler. |
Slot |
object
|
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 boşluğu doldururken söyleyebileceği kısa kelimeler. |
Slot |
object
|
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 boşluğu doldururken söyleyebileceği kısa kelimeler. |
Slot |
object
|
createOptionsSlot
createOptionsSlot(options, callback, hints?) returns Slot<string>
Önceden tanımlanmış seçenekler 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 boşluğu doldururken söyleyebileceği kısa kelimeler. |
Slot |
object
|
Alan
Doldurulacak bir alanı temsil eden nesne. expect()
veya prompt()
kullanılarak kaydedilebilir.
FilledSlot<T>
Doldurulmuş bir alanı temsil eden nesne.
Parametre | |
---|---|
T |
boolean|number|string
Alan türü. |
Option
Alan türü girişini temsil eden bir nesne.
Alanlar | |
---|---|
key |
string
Alan türü girişinin benzersiz tanımlayıcısıdır. |
synonyms |
array<string>
Alan seçeneğini belirlemek için kullanılan kelimelerin listesi. |
İpuçları
Alanla ilgili ipuçlarını temsil eden bir nesne.
Alanlar | |
---|---|
associatedWords |
array<string>
NLU sisteminin hangi yuvayı dolduracağına karar vermesine yardımcı olmak için kullanılan kelimelerin listesi. |
bekle
expect(expectation) returns HandlerRegistration
Beklentiyi istemciye 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ı amaç işleyiciyi temsil eden nesne.
Yöntemler | |
---|---|
deleteHandler() |
function
Beklenen intent işleyicinin kaydını siler. |
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>>
Sağlanan TTS dizesiyle kullanıcıya istem gösterir ve beklentiyi istemciye kaydeder. Amaç işleyicilerde ve alanlarda çağrılabilir.
Parametreler | |
---|---|
tts |
string
Kullanıcıya sağlanan beklentiyi istemek için kullanılan TTS dizesi. |
expectation |
IntentHandler|Slot
Kaydedilecek amaç işleyici veya alan. |
Answer<T> |
object
İsteme kullanıcı tarafından sağlanan yanıt. |
Yanıt<T>
İsteme 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. Aşağıdakilerden biri:
|
triggerScene
triggerScene(sceneName) returns Promise<TriggerSceneStatus>
Bir sahneyi tetikler.
Parametreler | |
---|---|
sceneName |
string
Tetiklenecek sahnenin adı. |
TriggerSceneStatus |
string
tetikleyiciScene() çağrısının durumu. Aşağıdakilerden biri:
|
setUserParam
setUserParam(key, value) returns Promise<undefined>;
İleti dizileri arasında geçirilen ve devam eden 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ın varsa parametre 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 geçirilen ve devam eden 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ın varsa parametre 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. İlgili içeriği oluşturmak için kullanılan
setCanvasState
yöntemi bir değer döndürmez. Eyalet yüküne şuradan erişilebilir:
conv.context.canvas.state
mülkündeki her mülk.
Parametreler | |
---|---|
state |
Object
Tuval uygulamasının JSON nesnesi olarak güncellenmiş durumu. |
InteractiveCanvasCallbacks
Bu geri aramalar, bilgi veya isteklere yanıt verebilmeniz için bir yöntem sunar. Conversational Action'ınızdan, diğer yöntemlerle bilgi veya istekleriniz olabilir.
onUpdate
onUpdate(data) returns Promise|undefined
Görüşme İşleminden Canvas
yanıtı gönderildiğinde çağrılır. TTS şu tarihte başlayacak:
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ı belirtir.END
, TTS'nin sonunu belirtir.ERROR
, TTS çalınırken bir hata olduğunu gösterir.
Ayrıca, SSML ve <mark>
etiketini kullanarak, aşağıdaki gibi özel işaretler de tanımlayabilirsiniz:
<mark name="custom"/>
.
Parametreler | |
---|---|
markName |
string
TTS çalma sırasında çağrılan adı işaretleyin. |
onInputStatusChanged
onInputStatusChanged(inputStatus) returns undefined
Canvas uygulamasına, Asistan giriş durumunun değiştiğini bildirir.
Parametreler | |
---|---|
inputStatus |
Enum
Cihazdaki ses ve/veya metin girişi işlemenin durumu. Teneke Kutu aşağıdaki gibi olmalıdır:
|