Interactive Canvas API to biblioteka JavaScript, której możesz używać do wykonywania działań konwersacyjnych za pomocą obiektu interactiveCanvas
w aplikacji internetowej.
Więcej informacji o interaktywnym obszarze roboczym znajdziesz w dokumentacji obszaru roboczego.
Metody
gotowa
ready(callbacks) returns undefined
Wywołuje aplikację Interactive Canvas po załadowaniu i rejestrowaniu wywołań zwrotnych.
Parametry | |
---|---|
callbacks |
InteractiveCanvasCallbacks
Obiekt zawierający wywołania zwrotne metody. |
zapytanieTextText
sendTextQuery(textQuery) returns Promise<state>
Wysyła zapytanie tekstowe do czynności konwersacyjnej.
Parametry | |
---|---|
textQuery |
string
Zapytanie wysyłane do rozmowy. |
state |
string
Jedna z tych wartości: Platforma może zaakceptować prośby
|
getHeaderHeightPx,
getHeaderHeightPx() returns Promise<height>
Określa wysokość nagłówka u góry wyświetlacza.
Parametry | |
---|---|
height |
number
Wysokość w pikselach. |
dane wyjścioweTts
outputTts(text, openMic) returns undefined;
Odtwarza tekst SSML.
Parametry | |
---|---|
text |
string
Ciąg obsługiwany przez SSML, który ma zostać odtworzony. |
openMic |
boolean
Określa, czy po włączeniu zamiany tekstu na mowę ma zostać włączony mikrofon. |
createIntentHandler
createIntentHandler(intentId, callback) returns IntentHandler
Tworzy moduł obsługi intencji o niestandardowej intencji NLU.
Parametry | |
---|---|
intentId |
string
Nazwa intencji określona w Kreatorze działań. |
callback |
function(MatchedIntent)
Funkcja do wykonania po dopasowaniu intencji. |
IntentHandler |
object
Obiekt modułu obsługi intencji, który można zarejestrować za pomocą |
Moduł obsługi intencji
Obiekt reprezentujący moduł obsługi intencji. Możesz zarejestrować się przy użyciu expect()
lub prompt()
.
Dopasowanie intencji
Obiekt zawierający dane dotyczące pasującej intencji.
Metody | |
---|---|
getIntentArg(parameterName) |
function(string)
Metoda pobierania parametru intencji o podobnej intencji. |
Utwórz numer boksu
createNumberSlot(callback, hints?) returns Slot<number>
Tworzy przedział typu.
Parametry | |
---|---|
callback |
function(FilledSlot)
Funkcja do wykonania po wypełnieniu przedziału. |
hints |
Hints
Krótkie słowa, które użytkownik może wypowiedzieć podczas wypełniania boksu. |
Slot |
object
Obiekt boksu, który można zarejestrować za pomocą |
Utwórzboks reklamowy
createTextSlot(callback, hints?) returns Slot<string>
Tworzy boks typu ciąg znaków.
Parametry | |
---|---|
callback |
function(FilledSlot)
Funkcja do wykonania po wypełnieniu przedziału. |
hints |
Hints
Krótkie słowa, które użytkownik może wypowiedzieć podczas wypełniania boksu. |
Slot |
object
Obiekt boksu, który można zarejestrować za pomocą |
createConfirmationSlot (utwórz potwierdzenie)
createConfirmationSlot(callback, hints?) returns Slot<boolean>
Tworzy boks typu logicznego.
Parametry | |
---|---|
callback |
function(FilledSlot)
Funkcja do wykonania po wypełnieniu przedziału. |
hints |
Hints
Krótkie słowa, które użytkownik może wypowiedzieć podczas wypełniania boksu. |
Slot |
object
Obiekt boksu, który można zarejestrować za pomocą |
UtwórzSlot
createOptionsSlot(options, callback, hints?) returns Slot<string>
Tworzy boks na podstawie wstępnie zdefiniowanej listy opcji.
Parametry | |
---|---|
options |
array<Option>
Funkcja do wykonania po wypełnieniu przedziału. |
callback |
function(FilledSlot)
Funkcja do wykonania po wypełnieniu przedziału. |
hints |
Hints
Krótkie słowa, które użytkownik może wypowiedzieć podczas wypełniania boksu. |
Slot |
object
Obiekt boksu, który można zarejestrować za pomocą |
Boks
Obiekt reprezentujący boks, który ma zostać wypełniony. Możesz zarejestrować się przy użyciu expect()
lub prompt()
.
Wypełnione boksy<T>
Obiekt reprezentujący wypełniony boks.
Parametr | |
---|---|
T |
boolean|number|string
Typ boksu. |
Option
Obiekt reprezentujący typ boksu.
Pola | |
---|---|
key |
string
Unikalny identyfikator typu boksu. |
synonyms |
array<string>
Lista słów używanych do wyboru opcji boksu. |
Wskazówki
Obiekt przedstawiający podpowiedzi dotyczące boksu.
Pola | |
---|---|
associatedWords |
array<string>
Lista słów używanych, aby pomóc systemowi NLU w wyborze odpowiedniego boksu. |
Nie tego się spodziewałem
expect(expectation) returns HandlerRegistration
Rejestruje oczekiwania klienta. Może być wywoływana na potrzeby modułów obsługi i przedziałów intencji.
Parametry | |
---|---|
expectation |
IntentHandler|Slot
Moduł obsługi zamiaru lub boks do zarejestrowania. |
HandlerRegistration |
object
Zarejestrowany moduł obsługi lub przedział czasu. |
Rejestracja sprzedawcy
Obiekt reprezentujący zarejestrowany moduł obsługi intencji.
Metody | |
---|---|
deleteHandler() |
function
Wyrejestrowuje oczekiwany moduł obsługi intencji. |
jasne oczekiwania
clearExpectations() returns undefined;
Usuwa wszystkie oczekiwania, usuwając wszystkie wcześniej zarejestrowane moduły obsługi intencji i boksy.
znak zachęty
prompt(tts, expectation) returns Promise<Answer<T>>
Wysyła użytkownikowi odpowiedni ciąg tekstowy TTS i rejestruje oczekiwania klienta. Może być wywoływana na potrzeby modułów obsługi i przedziałów intencji.
Parametry | |
---|---|
tts |
string
Ciąg tekstowy, który informuje użytkownika o oczekiwanych oczekiwaniach. |
expectation |
IntentHandler|Slot
Moduł obsługi zamiaru lub boks do zarejestrowania. |
Answer<T> |
object
Dostarczona przez użytkownika odpowiedź na pytanie. |
Odpowiedź<T>
Obiekt reprezentujący odpowiedź użytkownika na pytanie.
Pola | |
---|---|
value |
boolean|number|string
Wartość odpowiedzi udzielonej przez użytkownika. |
status |
string
Stan odpowiedzi. Jedna z tych wartości:
|
scena
triggerScene(sceneName) returns Promise<TriggerSceneStatus>
Wyzwala scenę.
Parametry | |
---|---|
sceneName |
string
Nazwa sceny, która ma zostać aktywowana. |
TriggerSceneStatus |
string
Stan wywołania wyzwalającegoScene(). Jedna z tych wartości:
|
setUserParam
setUserParam(key, value) returns Promise<undefined>;
Ustawia parę klucz-wartość, która jest przekazywana i utrzymywana między rozmowami.
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 danego klucza, jeśli istnieje, oraz stan wywołania.
Parametry | |
---|---|
key |
string
Klucz parametru. |
resetujparametr użytkownika
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 utrzymywana między rozmowami.
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 danego klucza, jeśli istnieje, oraz 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 zaktualizowała swój stan. Metoda setCanvasState
nie zwraca wartości. Ładunek stanu jest dostępny za pomocą właściwości conv.context.canvas.state
.
Parametry | |
---|---|
state |
Object
Zaktualizowany stan aplikacji Canvas jako obiekt JSON. |
Interaktywne połączenia zwrotne
Te wywołania zwrotne umożliwiają odpowiadanie na informacje i prośby z działań konwersacyjnych, natomiast metody umożliwiają przesyłanie informacji lub żądań do tego działania.
onUpdate
onUpdate(data) returns Promise|undefined
Wywoływana, gdy z wątku rozmowy zostanie wysłana odpowiedź Canvas
. TTS rozpocznie się po rozwiązaniu zwróconej obietnicy lub przekroczy limit czasu po 10 sekundach.
Parametry | |
---|---|
data |
Object
Zaktualizowano dane wysłane przez webhooka. |
onTtsMark
onTtsMark(markName) returns undefined
Wywołanie zwrotne podczas odtwarzania TTS.
Znaki specjalne, które są zawsze wywoływane:
START
wskazuje początek zamiany tekstu na mowę.END
oznacza koniec zamiany tekstu na mowę.ERROR
to błąd podczas odtwarzania tekstu TTS.
Znaczniki niestandardowe możesz też definiować za pomocą SSML i tagu <mark>
, np. <mark name="custom"/>
.
Parametry | |
---|---|
markName |
string
Oznacz nazwę wywoływaną podczas odtwarzania w ramach przetwarzania TTS. |
onInputStatusChanged
onInputStatusChanged(inputStatus) returns undefined
Powiadamia aplikację Canvas o zmianie stanu wprowadzania danych przez Asystenta.
Parametry | |
---|---|
inputStatus |
Enum
Stan przetwarzania głosu lub tekstu na urządzeniu. Może to być:
|