Arbeta med variabler i Botpress: A Practical Approach

Arbeta Med Variabler I Botpress A Practical Approach



Variablerna används för att lagra data som kommer att användas senare i din chatbots flöde. En av huvudfunktionerna som skiljer Botpress från de andra utvecklingsverktygen för chatbot är dess omfattande stöd för variabler. Botpress erbjuder åtta olika typer av variabel data. Förutom lagring tillåter variablerna utvecklarna att manipulera data och göra konversationerna mer dynamiska och personliga. I den här bloggen kommer vi att utforska variablerna i Botpress Studio genom att titta på olika datatyper, omfattningar och praktiska metoder för att använda dem korrekt.

Förstå datatyper för variabler

Innan vi dyker in i de praktiska aspekterna av att använda variablerna, låt oss bekanta oss med de olika tillgängliga datatyperna i Botpress.







  1. Sträng: Strängar används för att lagra texten som kan bestå av bokstäver, siffror eller specialtecken. De används vanligtvis för att lagra användarnamn eller AI-genererade meddelanden.
  2. Boolean: Boolean kan bara innehålla två värden – sant eller falskt. De är idealiska för att lagra den binära informationen som om en användare är en återkommande kund eller om användaren vill fråga något annat.
  3. Siffra: Som namnet antyder används talvariablerna för att lagra de numeriska värdena som kan vara antingen heltal eller tal med decimaler. De är användbara för att lagra telefonnummer, riktnummer och andra numeriska data.
  4. Datum: Datumvariablerna använder ISO 8601 datum/tid-format. Det representerar antingen ett enda datum eller ett datum och tid.
  5. Objekt: En objektvariabel är en samling nyckel-värdepar som liknar ordböckerna eller kartorna. De är värdefulla för att lagra komplexa datastrukturer som användarprofiler eller resultaten av ett API-anrop.
  6. Array: Matriserna används för att lagra samlingar av liknande variabler. De kan hålla strängarna eller objekten, vilket gör dem mångsidiga för olika användningsfall som att lagra en användares tidigare meddelanden eller tillhandahålla alternativ för användaren att välja mellan.
  7. Enum: Detta är en variabel med en begränsad uppsättning fördefinierade val. De är lämpliga för scenarier som att lagra veckodagar eller de tillgängliga föremålen på en matmeny.
  8. Mönster: Mönstervariablerna använder Regular Expressions (Regex) för att lagra de speciella mönster som kan användas för att matcha specifika ord eller siffror. De är praktiska för att lagra kontonummer eller flightnummer.

Förstå de variabla omfattningarna

Olika typer av variabler ingår i Botpress, och de varierar beroende på var de kan vara tillgängliga i din chatbots flöde. Låt oss utforska de olika variabla omfattningarna, från det mest begränsade till det bredaste:



Arbetsflödesvariabler

Dessa variabler definieras och används inom ett enda eller samma arbetsflöde. De är utmärkta för engångsflöden som att lagra AI-uppgiftsutdata, användarsvar på frågor eller organisera data från API-anrop.



Dessa steg kan följas för att skapa en arbetsflödesvariabel:





Steg 1. Välj lämpligt arbetsflöde i menyn 'Utforskare'.

Steg 2. Dubbelklicka på ett tomt område i arbetsflödesredigeraren öppnar panelen Inspektör.



Steg 3. Ange variabelnamnet, välj variabelns datatyp och klicka på knappen 'Lägg till' för att skapa variabeln.

Du kan lägga till ett standardvärde (initial) till din variabel från avsnittet 'Ytterligare inställningar'.

Arbetsflödesvariabler för inmatning och utdata

För att utbyta information kan arbetsflöden ha in- och utdatavariabler. Ingångar används för att ta emot en information från de externa källorna eller andra arbetsflöden, medan utgångar ger en information till de externa källorna eller andra arbetsflöden. Detta möjliggör mer flexibel kommunikation och datautbyte inom boten.

Dessa steg kan följas för att markera en indatavariabel:

Steg 1. Skapa variabeln i arbetsflödet.

Steg 2. Välj variabeln genom att klicka på arbetsflödets ingångsnod i inspektörspanelen.

Dessa steg kan följas för att markera en utdatavariabel:

Steg 1. Skapa variabeln i arbetsflödet.

Steg 2. Välj variabeln genom att klicka på arbetsflödets utgångsnod i inspektörspanelen.

Sessionsvariabler

Alla flöden har åtkomst till dessa variabler, men bara för en enda konversation. De är idealiska för att lagra data som används under en konversation, såsom chatthistorik, insamlade föremål i en virtuell kundvagn eller tillfällig data från API-anrop.

För att skapa en sessionsvariabel kan du skriva följande kod:

session.variablename = 'Hej grabbar!' ;

För att kunna använda din variabel i ett textkort måste vi stänga den inom de krulliga parenteserna, t.ex. {{session.variablename}} .

Användarvariabler

Användarvariablerna följer en användare mellan konversationer vilket gör att data kan kvarstå under flera interaktioner med chatboten. De är perfekta för att lagra information som förblir relevant för en användare över tid, såsom personliga detaljer, taggar från tidigare konversationer eller språkinställningar.

Så här skapar du en användarvariabel:

Steg 1. Öppna 'Chatbot Settings' från Botpress-ikonen i det övre vänstra hörnet.

Steg 2. Välj 'Variables' från flikarna.

Steg 3. Definiera användarvariabeln genom att namnge den och ange datatypen.

Antingen @user.variablename eller {{user.variablename}} kan användas för att referera till 'User'-variabeln i ett textkort.

Botvariabler

Alla användare i chatboten har tillgång till dessa variabler i alla konversationer. De används ofta för att lagra utvecklarinformation och konfiguration som att lagra slutpunkter för API-anrop, botens versionsnummer eller dess namn.

Följ dessa steg för att skapa en Bot-variabel:

Steg 1. Välj 'Chatbot Settings' genom att klicka på Botpress-ikonen i det övre vänstra hörnet.

Steg 2. Välj 'Variables' från flikarna.

Steg 3. Ange namnet och datatypen för botvariabeln.

Precis som användarvariabler kan @bot.variablename eller bot.variablename användas för att referera till botvariabler på korten.

Konfigurationsvariabler

De är en speciell typ av säker botvariabel. Du kan hantera dem från Cloud Dashboard, och det finns inget behov av att öppna boten. Konfigurationsvariablerna är idealiska för att lagra känslig information som API-tokens, privata IP-adresser eller databasuppgifter.

Så här skapar du en konfigurationsvariabel:

Steg 1. Öppna 'Chatbot Settings' från Botpress-ikonen i det övre vänstra hörnet.

Steg 2. Klicka på fliken 'Variabler'.

Steg 3. Lägg till en konfigurationsvariabel och ange dess namn och värde.

För att komma åt konfigurationsvariablerna i koden kan du använda 'env.key' där 'key' representerar konfigurationsvariabelns namn som ska hämtas.

Använda variabler i koden

De lockiga parenteserna '{{ }}' eller @-symbolen är inte nödvändiga när du använder variabler i koden. Syntaxen för att komma åt variablerna i koden följer mönstret 'variabletype.variablename'. Till exempel:

Koda:

  • workflow.phoneNumber
  • session.userAcctId
  • user.firstName
  • bot.endpoint
  • env.apiKey

Variablerna kan tilldelas värden eller uppdateras i koden. Men det är viktigt att se till att det tilldelade värdet matchar variabelns datatyp för att undvika fel.

Slutsats

Variablerna är byggstenarna för dynamiska och personliga interaktioner i Botpress. Genom att använda de olika datatyperna och förstå de variabla omfattningarna kan utvecklarna skapa chatbots med kraftfulla möjligheter. Oavsett om du behöver lagra användarinformationen, ansluta till API:er eller skicka data mellan arbetsflöden och variabler i Botpress ger den nödvändig flexibilitet och kontroll.