Pochopení akcí v Botpressu
Akce v Botpressu jsou funkce na straně serveru, které robot provádí během konverzačních toků. Mají moc měnit stav konverzace, posílat přizpůsobené zprávy, spouštět libovolný kód (jako je volání rozhraní API nebo ukládání dat) a další. Akce jsou v podstatě běžné funkce JavaScriptu, což znamená, že mohou provádět téměř cokoli v rámci omezení platformy.
Když Dialogue Manager (DM) vyvolá akci, obdrží několik argumentů, které poskytují kontext funkci. Tyto argumenty zahrnují uživatelské atributy, proměnné relace, dočasné proměnné, proměnné na úrovni bota, poslední uživatelskou událost v konverzaci, předané argumenty z Visual Flow Builder a izolovaný virtuální počítač, který obsahuje některé proměnné prostředí.
Registrace nových akcí
Chcete-li přidat vlastní akce robota, musíte vytvořit soubor JavaScript (.js) a umístit jej do data/globální/akce složku v rámci vašeho projektu Botpress. Bohužel neexistuje způsob, jak programově přidávat nové akce za běhu. Pomocí komentářů JavaDoc ve vašem kódu můžete poskytnout smysluplné informace o akcích, jako je jejich název, popis, argumenty a výchozí hodnoty. Akci v editoru toku můžete také skrýt přidáním příznaku @hidden true do komentáře JavaDoc.
Jak vytvořit vlastní akce v Botpressu
Zde je několik kroků, podle kterých můžete vytvořit vlastní akci v Botpressu:
Krok 1: Vytvořte robota a přidejte uzel
Chcete-li začít, vytvořte nového robota v Botpressu. Jakmile je váš robot vytvořen, přidejte do toku konverzace nový uzel.
Krok 2: Přidejte vhodné zprávy do svého uzlu
Do nově vytvořeného uzlu přidejte potřebné zprávy pro usnadnění výměny obsahu s uživateli. Můžete například přidat textovou zprávu, abyste uživatele pozdravili a zeptali se na jeho jméno.
Krok 3: Otevřete spouštěcí kód z postranního panelu
Přejděte na postranní panel v Botpress Flow Builder a otevřete „Editor kódu“. Zde můžete vytvářet a spravovat své vlastní akce.
Krok 4: Klikněte na tlačítko „Přidat akci“.
V části „Spustit kód“ klikněte na tlačítko „Přidat akci“. Tato akce otevře okno „Vytvořit nový action_legacy“.
Krok 5: Zadejte název souboru a klikněte na tlačítko Odeslat
V okně „Create a new action_legacy“ zadejte smysluplný název souboru vlastní akce; například customAction.js. Jakmile zadáte název, klikněte na tlačítko „Odeslat“. Tím se vytvoří soubor „customAction.js“.
Krok 6: Napište svůj vlastní kód
Otevřete nově vytvořený soubor „customAction.js“. Uvnitř souboru uvidíte standardní kód, který je vygenerován pro novou akci. Uveďte smysluplný popis vlastní akce pomocí příslušných komentářů.
Nyní napište svůj vlastní kód do funkce. Tento kód definuje chování vaší vlastní akce. JavaScript můžete použít k provádění různých úkolů, jako je volání API, přístup k databázím nebo zpracování složité logiky.
Krok 7: Upravte svůj uzel tak, aby používal vlastní akci
Vraťte se do Botpress Flow Builder a upravte uzel, kde chcete spustit vlastní akci. Přidejte do uzlu kartu „Execute Code“.
Krok 8: Vyberte název vlastní akce a zadejte parametry akce
Na kartě „Provést kód“ uvidíte rozevírací seznam, který obsahuje názvy všech vašich vlastních akcí. Vyberte název vlastní akce ze seznamu. Pokud vaše vlastní akce vyžaduje nějaké parametry, můžete je zadat v sekci „Parametry“ na kartě „Provést kód“.
Krok 9: Nechte svého robota provést akci
Nakonec přidejte do uzlu další kartu, aby váš robot provedl vlastní akci. Proměnné, které jsou uloženy v události (určené na kartě „Provést kód“), můžete použít k přístupu k výsledkům vlastní akce a zahrnout je do odpovědi robota.
Příklad vlastní akce
Řekněme, že chcete, aby váš chatbot poskytoval aktuální informace o počasí pro konkrétní místo. Můžete vytvořit vlastní akci, která volá rozhraní API počasí a vrací data o počasí.
const axios = vyžadovat ( 'axios' );const getWeather = async ( uživatel , session, args) => {
const location = args.location || 'New York' ;
const apiKey = 'your_weather_api_key' ;
const apiUrl = `https://api.weatherapi.com/v1/current.json?key=${apiKey}&q=${location}`;
Snaž se {
const response = wait axios.get(apiUrl);
const weatherData = odezva.data;
return `Aktuální počasí v ${location} je ${weatherData.current.condition.text} s teplotou ${weatherData.current.temp_c}°C.`;
} catch (chyba) {
vrátit se „Promiň, nemohl jsem \' t načíst informace o počasí v tuto chvíli. Prosím zkuste to znovu později.' ;
}
};
vrátit getWeather( uživatel , session, args);
Tato akce vyžaduje určité argumenty včetně uživatele, relace a argumentů, které poskytují kontext a data pro akci, se kterou má pracovat. V tomto příkladu vlastní akce „getWeather“ vezme místo jako argument, nebo pokud není zadána, použije se jako výchozí hodnota „New York“. Akce zavolá Weather API pomocí Axios, načte data o počasí a vrátí zprávu, která obsahuje stav počasí a teplotu.
Výhody vlastních akcí
Vlastní akce v Botpressu nabízejí několik výhod, které vylepšují možnosti a funkčnost vašeho chatbota:
- Rozšiřují funkce chatbota nad rámec vestavěných možností.
- Vytvářejí přizpůsobené interakce pro lepší uživatelský zážitek.
- Načítají data v reálném čase z API pro dynamické odpovědi.
- Integrují se s backendovými systémy a databázemi.
- Zvládají složité scénáře pomocí vlastního kódu.
- Znovu používají akce napříč chatboty a toky.
- Implementují vlastní zpracování chyb a protokolování.
- Optimalizují úkoly náročné na zdroje.
- Pro škálování využívají externí služby.
- Mají přístup a sdílejí předem vytvořené vlastní akce.
Závěr
Vlastní akce v Botpressu rozšiřují možnosti chatbota, přizpůsobují interakce a integrují externí API. Vývojáři vytvářejí funkce JavaScriptu na straně serveru a vyvolávají je z Botpress Flow Builder. Tyto akce nabízejí opětovnou použitelnost kódu, lepší výkon a škálovatelnost, díky čemuž jsou chatboti všestrannější a výkonnější nástroje. Využití vlastních akcí v Botpressu vytváří inovativní a poutavé chatboty.