Interactive Canvas API to biblioteka JavaScript, której używasz do interakcji z działaniem konwersacyjnym 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 aplikacji w celu zarejestrowania wywołań zwrotnych.
Parametry | |
---|---|
callbacks |
InteractiveCanvasCallbacks
Obiekt zawierający wywołania zwrotne metody. |
wyślij zapytanie
sendTextQuery(textQuery) returns Promise<state>
Wysyła zapytanie tekstowe do czynności konwersacyjnej.
Parametry | |
---|---|
textQuery |
string
Zapytanie, które ma zostać wysłane do czynności konwersacyjnej. |
state |
string
Jedna z tych wersji: Platforma może akceptować prośby od użytkowników
|
getHeaderHeightPx,
getHeaderHeightPx() returns Promise<height>
Określa wysokość nagłówka u góry wyświetlacza.
Parametry | |
---|---|
height |
number
Wysokość w pikselach. |
dane wyjściowe
outputTts(text, openMic) returns undefined;
Odtwarza tekst SSML.
Parametry | |
---|---|
text |
string
Ciąg znaków obsługiwany przez SSML. |
openMic |
boolean
Określa, czy włączyć mikrofon po odtworzeniu TTS. |
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 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 pokazujący moduł obsługi intencji. Możesz ją zarejestrować za pomocą expect()
lub prompt()
.
Dopasowane intencje
Obiekt zawierający dane dla dopasowanej intencji.
Metody | |
---|---|
getIntentArg(parameterName) |
function(string)
Metoda pobierania parametru intencji dopasowanej intencji. |
Utwórz numer boksu
createNumberSlot(callback, hints?) returns Slot<number>
Tworzy przedział typu.
Parametry | |
---|---|
callback |
function(FilledSlot)
Funkcja, która ma być wykonywana po wypełnieniu przedziału. |
hints |
Hints
Krótkie słowa, które użytkownik może powiedzieć podczas wypełniania boksu. |
Slot |
object
Obiekt boksu, który można zarejestrować za pomocą |
createTextSlot,
createTextSlot(callback, hints?) returns Slot<string>
Tworzy boks z typem ciągu.
Parametry | |
---|---|
callback |
function(FilledSlot)
Funkcja, która ma być wykonywana po wypełnieniu przedziału. |
hints |
Hints
Krótkie słowa, które użytkownik może powiedzieć podczas wypełniania boksu. |
Slot |
object
Obiekt boksu, który można zarejestrować za pomocą |
createConfirmationSlot,
createConfirmationSlot(callback, hints?) returns Slot<boolean>
Tworzy boks typu boolean.
Parametry | |
---|---|
callback |
function(FilledSlot)
Funkcja, która ma być wykonywana po wypełnieniu przedziału. |
hints |
Hints
Krótkie słowa, które użytkownik może powiedzieć podczas wypełniania boksu. |
Slot |
object
Obiekt boksu, który można zarejestrować za pomocą |
tworzenie opcji
createOptionsSlot(options, callback, hints?) returns Slot<string>
Tworzy przedział na podstawie wstępnie zdefiniowanej listy opcji.
Parametry | |
---|---|
options |
array<Option>
Funkcja, która ma być wykonywana po wypełnieniu przedziału. |
callback |
function(FilledSlot)
Funkcja, która ma być wykonywana po wypełnieniu przedziału. |
hints |
Hints
Krótkie słowa, które użytkownik może powiedzieć podczas wypełniania boksu. |
Slot |
object
Obiekt boksu, który można zarejestrować za pomocą |
Boks
Obiekt reprezentujący boks do wypełnienia. Możesz ją zarejestrować za pomocą expect()
lub prompt()
.
Wypełniony boks reklamowy<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 wybierania opcji boksu. |
Wskazówki
Obiekt pokazujący wskazówki 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
Rejestrowanie oczekiwań klienta. Można ją wywoływać w modułach obsługi intencji i przedziałach.
Parametry | |
---|---|
expectation |
IntentHandler|Slot
Moduł obsługi intencji lub przedział, który ma zostać zarejestrowany. |
HandlerRegistration |
object
Zarejestrowany moduł obsługi intencji lub przedział. |
Rejestracja modułów obsługi klienta
Obiekt reprezentujący zarejestrowany moduł 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 przedziały.
znak zachęty
prompt(tts, expectation) returns Promise<Answer<T>>
Wysyła użytkownikowi odpowiedni ciąg tekstowy TTS i rejestruje oczekiwania klienta. Można ją wywoływać w modułach obsługi intencji i przedziałach.
Parametry | |
---|---|
tts |
string
Ciąg tekstowy TTS używany do informowania użytkownika o oczekiwanych oczekiwaniach. |
expectation |
IntentHandler|Slot
Moduł obsługi intencji lub przedział, który ma zostać zarejestrowany. |
Answer<T> |
object
Dostarczona przez użytkownika odpowiedź na komunikat. |
Odpowiedź<T>
Obiekt reprezentujący odpowiedź użytkownika na komunikat.
Pola | |
---|---|
value |
boolean|number|string
Wartość odpowiedzi przekazanej przez użytkownika. |
status |
string
Stan odpowiedzi. Jedna z tych wersji:
|
scena
triggerScene(sceneName) returns Promise<TriggerSceneStatus>
Wywołuje scenę.
Parametry | |
---|---|
sceneName |
string
Nazwa punktu widokowego, który ma być aktywowany. |
TriggerSceneStatus |
string
Stan wywołania wyzwalającego aktywator. Jedna z tych wersji:
|
setUserParam
setUserParam(key, value) returns Promise<undefined>;
Określa 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. |
resetuj parametr użytkownika
resetUserParam() returns Promise<void>;
Usuwa wszystkie parametry użytkownika.
Ustawianie parametru HomeHomeParam
setHomeParam(key, value) returns Promise<undefined>;
Określa 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. |
resetujHomeParam
resetHomeParam() returns Promise<void>;
Usuwa wszystkie parametry użytkownika.
setCanvasState
setCanvasState(state) returns undefined
Informuje Asystenta, że aplikacja internetowa Canvas zaktualizowała stan. Metoda setCanvasState
nie zwraca wartości. Ładunek stanowy jest dostępny za pomocą właściwości conv.context.canvas.state
.
Parametry | |
---|---|
state |
Object
Zaktualizowano stan aplikacji Canvas jako obiektu JSON. |
Interaktywne wywołania zwrotne Canvas
Te wywołania zwrotne umożliwiają odpowiadanie na informacje i żądania związane z działaniem konwersacyjnym, natomiast metody umożliwiają przekazywanie informacji lub żądań do czynności konwersacyjnej.
onUpdate
onUpdate(data) returns Promise|undefined
Wywoływane, gdy z komendy konwersacyjnej jest wysyłana odpowiedź Canvas
. TTS rozpocznie się, gdy zwrócona obietnica zostanie zakończona lub upłynie 10 sekund.
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
wskazuje koniec zamiany tekstu na mowę.ERROR
wskazuje błąd podczas odtwarzania TTS.
Znaczniki niestandardowe możesz też definiować za pomocą SSML i tagu <mark>
, np. <mark name="custom"/>
.
Parametry | |
---|---|
markName |
string
Oznacz nazwę wywołane podczas odtwarzania 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 być:
|