Dokumentacja interfejsu Interactive Canvas API

Interfejs Interactive Canvas API to biblioteka JavaScript, której możesz używać do za pomocą akcji związanej z rozmową, używając obiektu interactiveCanvas w aplikacji internetowej.

Więcej informacji o interaktywnym obszarze roboczym znajdziesz w artykule Interaktywny obszar roboczy dokumentacji.

Metody

gotowe

ready(callbacks) returns undefined

Wywoływana przez aplikację internetową Interactive Canvas po 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 działania konwersacyjnego.

Parametry
textQuery string

Zapytanie, które ma zostać wysłane do działania konwersacyjnego.
state string

Jedna z tych wartości:

READY: Prośby mogą być akceptowane przez platformę.

BLOCKED: jest w trakcie wyświetlania zapytanie, w związku z czym nowe zostanie usunięte.

UNKNOWN: Nie udało się określić bieżącego stanu zapytania.

getHeaderHeightPx

getHeaderHeightPx() returns Promise<height>

Określa wysokość nagłówka na górze wyświetlacza.

Parametry
height number

Wysokość w pikselach.

outputTts

outputTts(text, openMic) returns undefined;

Odtwarza tekst SSML.

Parametry
text string

Ciąg tekstowy obsługiwany przez SSML, który ma zostać odtworzony.
openMic boolean

Określa, czy włączyć mikrofon po zakończeniu odtwarzania tekstu.

createIntentHandler

createIntentHandler(intentId, callback) returns IntentHandler

Tworzy moduł obsługi intencji dla intencji niestandardowej NLU.

Parametry
intentId string

Nazwa intencji zdefiniowana w Actions Builder.
callback function(MatchedIntent)

Funkcja, która ma zostać wykonana po spełnieniu intencji.
IntentHandler object

Obiekt modułu obsługi intencji, który można zarejestrować za pomocą expect().

IntentHandler

Obiekt reprezentujący moduł obsługi intencji. Można zarejestrować się za pomocą expect() lub prompt().

MatchedIntent

Obiekt zawierający dane dopasowanej intencji.

Metody
getIntentArg(parameterName) function(string)

Metoda pobierania parametru intencji dopasowanej intencji.

createNumberSlot

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

Tworzy przedział typu liczbowego.

Parametry
callback function(FilledSlot)

Funkcja, która ma zostać wykonana po wypełnieniu boksu.
hints Hints

Krótkie słowa, które użytkownik może wypowiedzieć podczas wypełniania boksu. hints pomaga systemowi NLU zdecydować, który boks wypełnić.
Slot object

Obiekt boksu, który można zarejestrować za pomocą prompt().

createTextSlot

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

Tworzy boks reklamowy typu ciąg znaków.

Parametry
callback function(FilledSlot)

Funkcja, która ma zostać wykonana po wypełnieniu boksu.
hints Hints

Krótkie słowa, które użytkownik może wypowiedzieć podczas wypełniania boksu. hints pomaga systemowi NLU zdecydować, który boks wypełnić.
Slot object

Obiekt boksu, który można zarejestrować za pomocą prompt().

createConfirmationSlot

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

Tworzy przedział typu wartość logiczna.

Parametry
callback function(FilledSlot)

Funkcja, która ma zostać wykonana po wypełnieniu boksu.
hints Hints

Krótkie słowa, które użytkownik może wypowiedzieć podczas wypełniania boksu. hints pomaga systemowi NLU zdecydować, który boks wypełnić.
Slot object

Obiekt boksu, który można zarejestrować za pomocą prompt().

createOptionsSlot

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

Tworzy boks ze wstępnie zdefiniowanej listy opcji.

Parametry
options array<Option>

Funkcja, która ma zostać wykonana po wypełnieniu boksu.
callback function(FilledSlot)

Funkcja, która ma zostać wykonana po wypełnieniu boksu.
hints Hints

Krótkie słowa, które użytkownik może wypowiedzieć podczas wypełniania boksu. hints pomaga systemowi NLU zdecydować, który boks wypełnić.
Slot object

Obiekt boksu, który można zarejestrować za pomocą prompt().

Boks

Obiekt reprezentujący boks do wypełnienia. Można zarejestrować się za pomocą expect() lub prompt().

FilledSlot&lt;T&gt;

Obiekt reprezentujący wypełniony boks.

Parametr
T boolean|number|string

Typ przedziału.

Opcja

Obiekt reprezentujący wpis typu przedziału.

Pola
key string

Unikalny identyfikator wpisu typu przedziału.
synonyms array<string>

Lista słów używanych do wyboru opcji boksu.

Wskazówki

Obiekt reprezentujący wskazówki dotyczące boksu.

Pola
associatedWords array<string>

Lista słów pomaganych systemowi NLU w podjęciu decyzji, które boksy wypełnić.

Nie tego się spodziewałem

expect(expectation) returns HandlerRegistration

Rejestruje oczekiwanie na kliencie. Może być wywoływana w przypadku modułów obsługi intencji i przedziałów.

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;

Eliminuje wszystkie oczekiwania przez usunięcie wszystkich zarejestrowanych wcześniej modułów obsługi intencji i przedziałów.

prompt

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

Wyświetla użytkownikowi prośbę o podany ciąg tekstowy zamiany tekstu na mowę i rejestruje oczekiwanie u klienta. Może być wywoływana w przypadku modułów obsługi intencji i przedziałów.

Parametry
tts string

Ciąg tekstowy zamiany tekstu na tekst używany, aby zapytać użytkownika o podaną odpowiedź.
expectation IntentHandler|Slot

Moduł obsługi intencji lub przedział do zarejestrowania.
Answer<T> object

Odpowiedź użytkownika na prompt.

Odpowiedz<T>

Obiekt reprezentujący odpowiedź użytkownika na prompt.

Pola
value boolean|number|string

Wartość odpowiedzi podanej przez użytkownika.
status string

Stan odpowiedzi.

Jedna z tych wartości:

ANSWERED: Użytkownik odpowiedział na prompt

NO_MATCH: Użytkownik został poproszony o podanie odpowiedzi, która nie pasuje do oczekiwanej lub niezwiązanej z innym zamiarem użytkownika.

YIELD: Użytkownik odpowiedział na prompt w innym zamiarze.

triggerScene

triggerScene(sceneName) returns Promise<TriggerSceneStatus>

Wyzwala scenę.

Parametry
sceneName string

Nazwa sceny, która ma zostać wyzwolona.
TriggerSceneStatus string

Stan wywołania aktywatora Scene().

Jedna z tych wartości:

SUCCESS: Serwer pomyślnie przetworzył żądanie.

BLOCKED: Żądanie zostało zablokowane przez istniejące zapytanie w trakcie wyświetlania.

UNKNOWN: Stan prośby jest nieznany.

setUserParam

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

Ustawia parę klucz-wartość, która jest przekazywana i zachowywana 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) oraz 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 zachowywana 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) 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. setCanvasState nie zwraca wartości. Dostęp do ładunku stanowego można uzyskać za pomocą conv.context.canvas.state.

Parametry
state Object

Zaktualizowany stan aplikacji Canvas jako obiekt JSON.

InteractiveCanvasCallbacks

Dzięki tym wywołaniem możesz odpowiadać na informacje lub prośby z akcji konwersacyjnych, a metody umożliwiają wysyłanie informacje lub żądania do akcji dotyczącej konwersacji.

onUpdate

onUpdate(data) returns Promise|undefined

Wywoływana, gdy z poziomu akcji dotyczącej rozmów zostanie wysłana odpowiedź Canvas. Funkcja TTS rozpocznie się, zwrócona obietnica jest zrealizowana lub upłynął limit czasu po 10 sekundach.

Parametry
data Object

Zaktualizowane dane wysłane przez webhooka.

onTtsMark

onTtsMark(markName) returns undefined

Wywołanie zwrotne wywoływane podczas odtwarzania zamiany tekstu na mowę.

Znaki specjalne, które są zawsze aktywowane:

  • START wskazuje początek TTS.
  • END oznacza koniec TTS.
  • ERROR oznacza błąd zamiany tekstu na mowę.

Znaczniki niestandardowe możesz też zdefiniować, używając SSML i tagu <mark>, np. <mark name="custom"/>

Parametry
markName string

Oznacz nazwę wywoływaną 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. Puszka w następujący sposób:

  • LISTENING : mikrofon jest otwarty.
  • IDLE : mikrofon jest zamknięty.
  • PROCESSING : Asystent właśnie wykonuje (mikrofon jest zamknięty).