Interactive Canvas API to biblioteka JavaScript, której używasz do obsługi akcji konwersacyjnej za pomocą obiektu interactiveCanvas
w aplikacji internetowej.
Więcej informacji o interaktywnym obszarze roboczym znajdziesz w dokumentacji obszaru interaktywnego.
Metody
gotowa
ready(callbacks) returns undefined
Wywoływana przez aplikację internetową Interactive Canvas po jej załadowaniu w celu zarejestrowania wywołań zwrotnych.
Parametry | |
---|---|
callbacks |
InteractiveCanvasCallbacks
Obiekt zawierający wywołania zwrotne metody. |
sendTextQuery
sendTextQuery(textQuery) returns Promise<state>
Wysyła zapytanie tekstowe do czynności związanej z konwersacją.
Parametry | |
---|---|
textQuery |
string
Zapytanie wysłane do działania związanego z konwersacją. |
state |
string
Jedna z tych wersji:
|
getHeaderHeightPx
getHeaderHeightPx() returns Promise<height>
Określa wysokość nagłówka u góry ekranu.
Parametry | |
---|---|
height |
number
Wysokość w pikselach. |
outputTts
outputTts(text, openMic) returns undefined;
Wyświetla tekst SSML.
Parametry | |
---|---|
text |
string
Ciąg znaków obsługiwany przez SSML do odtworzenia. |
openMic |
boolean
Określa, czy włączyć mikrofon po odtworzeniu zamiany tekstu na mowę. |
createIntentHandler
createIntentHandler(intentId, callback) returns IntentHandler
Tworzy moduł obsługi intencji dla niestandardowej intencji NLU.
Parametry | |
---|---|
intentId |
string
Nazwa intencji zdefiniowana w Kreatorze działań. |
callback |
function(MatchedIntent)
Funkcja, która ma zostać wykonana po dopasowaniu intencji. |
IntentHandler |
object
Obiekt modułu obsługi intencji, który można zarejestrować za pomocą: |
IntentHandler
Obiekt reprezentujący moduł obsługi intencji. Można zarejestrować za pomocą expect()
lub prompt()
.
MatchedIntent
Obiekt zawierający dane dotyczące dopasowanej intencji.
Metody | |
---|---|
getIntentArg(parameterName) |
function(string)
Metoda pobierania parametru intencji pasującej do intencji. |
createNumberSlot
createNumberSlot(callback, hints?) returns Slot<number>
Tworzy boks typu liczba.
Parametry | |
---|---|
callback |
function(FilledSlot)
Funkcja, która jest wykonywana, gdy przedział jest wypełniony. |
hints |
Hints
Krótkie słowa, które użytkownik może powiedzieć, wypełniając miejsce. |
Slot |
object
Obiekt przedziału, który można zarejestrować za pomocą |
createTextSlot
createTextSlot(callback, hints?) returns Slot<string>
Tworzy boks typu ciąg znaków.
Parametry | |
---|---|
callback |
function(FilledSlot)
Funkcja, która jest wykonywana, gdy przedział jest wypełniony. |
hints |
Hints
Krótkie słowa, które użytkownik może powiedzieć, wypełniając miejsce. |
Slot |
object
Obiekt przedziału, który można zarejestrować za pomocą |
createConfirmationSlot
createConfirmationSlot(callback, hints?) returns Slot<boolean>
Tworzy boks typu wartość logiczna.
Parametry | |
---|---|
callback |
function(FilledSlot)
Funkcja, która jest wykonywana, gdy przedział jest wypełniony. |
hints |
Hints
Krótkie słowa, które użytkownik może powiedzieć, wypełniając miejsce. |
Slot |
object
Obiekt przedziału, który można zarejestrować za pomocą |
createOptionsSlot
createOptionsSlot(options, callback, hints?) returns Slot<string>
Tworzy przedział ze wstępnie zdefiniowanej listy opcji.
Parametry | |
---|---|
options |
array<Option>
Funkcja, która jest wykonywana, gdy przedział jest wypełniony. |
callback |
function(FilledSlot)
Funkcja, która jest wykonywana, gdy przedział jest wypełniony. |
hints |
Hints
Krótkie słowa, które użytkownik może powiedzieć, wypełniając miejsce. |
Slot |
object
Obiekt przedziału, który można zarejestrować za pomocą |
Boks
Obiekt reprezentujący boks do wypełnienia. Można zarejestrować za pomocą expect()
lub prompt()
.
FilledSlot<T>
Obiekt reprezentujący wypełniony boks.
Parametr | |
---|---|
T |
boolean|number|string
Typ przedziału. |
Option
Obiekt reprezentujący wpis typu przedziału.
Pola | |
---|---|
key |
string
Unikalny identyfikator wpisu typu przedziału. |
synonyms |
array<string>
Lista słów użytych do wyboru opcji przedziału. |
Wskazówki
Obiekt reprezentujący wskazówki dotyczące boksu.
Pola | |
---|---|
associatedWords |
array<string>
Lista słów, które mają pomóc systemowi NLU w wyborze odpowiedniego wypełnienia. |
expect
expect(expectation) returns HandlerRegistration
Rejestruje oczekiwania wobec klienta. Można ją wywoływać z modułami obsługi intencji i przedziałami.
Parametry | |
---|---|
expectation |
IntentHandler|Slot
Moduł obsługi intencji lub przedział do zarejestrowania. |
HandlerRegistration |
object
Zarejestrowany moduł obsługi intencji lub przedział. |
HandlerRegistration
Obiekt reprezentujący zarejestrowany moduł obsługi intencji.
Metody | |
---|---|
deleteHandler() |
function
Wyrejestrowuje oczekiwany moduł obsługi intencji. |
clearExpectations
clearExpectations() returns undefined;
Usuwa wszystkie oczekiwania przez usunięcie wszystkich wcześniej zarejestrowanych modułów obsługi intencji i przedziałów.
prośba
prompt(tts, expectation) returns Promise<Answer<T>>
Wyświetla użytkownikowi podany przez Ciebie ciąg tekstowy TTS i rejestruje oczekiwania klienta. Można ją wywoływać z modułami obsługi intencji i przedziałami.
Parametry | |
---|---|
tts |
string
Ciąg tekstowy TTS używany do przekazania użytkownikowi prośby o swoją rzeczywistość. |
expectation |
IntentHandler|Slot
Moduł obsługi intencji lub przedział do zarejestrowania. |
Answer<T> |
object
Odpowiedź użytkownika na prompt. |
Odpowiedź<T>
Obiekt reprezentujący odpowiedź użytkownika na pytanie.
Pola | |
---|---|
value |
boolean|number|string
Wartość odpowiedzi użytkownika. |
status |
string
Stan odpowiedzi. Jedna z tych wersji:
|
triggerScene
triggerScene(sceneName) returns Promise<TriggerSceneStatus>
Wywołuje scenę.
Parametry | |
---|---|
sceneName |
string
Nazwa sceny do wywołania. |
TriggerSceneStatus |
string
Stan wywołania funkcji aktywatorScene(). Jedna z tych wersji:
|
setUserParam
setUserParam(key, value) returns Promise<undefined>;
Ustawia parę klucz-wartość, która jest przekazywana i trwała między wątkami.
Parametry | |
---|---|
key |
string
Klucz parametru. |
value |
object|array|boolean|number|string
Wartość parametru. |
getUserParam
getUserParam(key) returns Promise<object|array|boolean|number|string>;
Pobiera wartość parametru dla danego klucza (jeśli istnieje) i stan wywołania.
Parametry | |
---|---|
key |
string
Klucz parametru. |
resetUserParam
resetUserParam() returns Promise<void>;
Usuwa wszystkie parametry użytkownika.
setHomeParam
setHomeParam(key, value) returns Promise<undefined>;
Ustawia parę klucz-wartość, która jest przekazywana i trwała między wątkami.
Parametry | |
---|---|
key |
string
Klucz parametru. |
value |
object|array|boolean|number|string
Wartość parametru. |
getHomeParam
getHomeParam(key) returns Promise<object|array|boolean|number|string>;
Pobiera wartość parametru dla danego klucza (jeśli istnieje) i stan wywołania.
Parametry | |
---|---|
key |
string
Klucz parametru. |
resetHomeParam
resetHomeParam() returns Promise<void>;
Usuwa wszystkie parametry użytkownika.
setCanvasState
setCanvasState(state) returns undefined
Powiadamia Asystenta, że aplikacja internetowa Canvas została zaktualizowana. Metoda setCanvasState
nie zwraca wartości. Ładunek stanowy jest dostępny za pomocą właściwości conv.context.canvas.state
.
Parametry | |
---|---|
state |
Object
Zaktualizowany stan aplikacji Canvas jako obiekt JSON. |
InteractiveCanvasCallbacks
Wywołania zwrotne umożliwiają odpowiadanie na informacje lub prośby z akcji dotyczącej rozmowy, natomiast metody umożliwiają wysyłanie informacji lub próśb do akcji dotyczącej rozmowy.
onUpdate
onUpdate(data) returns Promise|undefined
Wywoływane, gdy w ramach akcji dotyczącej rozmów zostanie wysłana odpowiedź Canvas
. Przekształcanie tekstu w funkcję rozpocznie się po odpowiedzi na zwróconą obietnicę lub po upływie 10 sekund.
Parametry | |
---|---|
data |
Object
Zaktualizowane dane wysłane przez webhooka. |
onTtsMark
onTtsMark(markName) returns undefined
Wywołanie zwrotne podczas odtwarzania zamiany tekstu na mowę.
Specjalne znaki, które są zawsze wywoływane:
START
wskazuje początek zamiany tekstu na mowę.END
wskazuje koniec zamiany tekstu na mowę.ERROR
oznacza błąd podczas odtwarzania zamiany tekstu na mowę.
Znaczniki niestandardowe możesz też definiować za pomocą SSML i tagu <mark>
, np. <mark name="custom"/>
.
Parametry | |
---|---|
markName |
string
Oznacz nazwę wywołaną podczas odtwarzania zamiany tekstu na mowę. |
onInputStatusChanged
onInputStatusChanged(inputStatus) returns undefined
Powiadamia aplikację Canvas o zmianie stanu wprowadzania danych Asystenta.
Parametry | |
---|---|
inputStatus |
Enum
Stan przetwarzania głosowego lub wprowadzania tekstu na urządzeniu. Mogą to być:
|