Er zijn drie soorten functies die fungeren als hooks bij de verwerking van de actie:

• Uitvoering van actie (verplicht) – wordt aangeroepen aan het einde van een actie nadat alle parameters zijn ingevuld.
• Parameterlader (optioneel) – wordt geactiveerd nadat alle statische parameters zijn ingevuld.
• Contextingang (optioneel) – wordt aangeroepen voor elke gebruikersinvoer tijdens een actie.

Uitvoeringsstroom van actie

Wanneer een gebruiker een zin in Zia invoert, probeert Zia de gebruikersinvoer te begrijpen en stelt Zia vast of deze overeenkomt met een van de geconfigureerde acties. Als de invoer overeenkomt met een van de geconfigureerde acties, vraagt Zia de gebruiker om de parameters op te geven die nodig zijn om een actie uit te voeren als een gesprek. Voor elke invoer van de gebruiker wordt de contexthandlerfunctie aangeroepen. Nadat alle statische parameters zijn ingevuld, wordt de parameterladerfunctie slechts eenmaal geactiveerd.

Zodra alle geconfigureerde parameters van de gebruiker zijn ontvangen, voert Zia de functie voor het uitvoeren van acties uit en ontvangt de gebruiker het bericht dat door de uitvoeringsfunctie wordt geretourneerd.

Een nieuwe actie toevoegen

Nieuwe acties kunnen worden toegevoegd vanaf het tabblad "Aanpassen". Het tabblad "Aanpassen" biedt een omgeving die vergelijkbaar is met de sandbox waarin u nieuwe acties kunt ontwikkelen en testen. In de volgende punten worden de stappen voor het toevoegen van nieuwe acties beschreven.

Een nieuwe actie toevoegen

1. Klik op Actie toevoegen.
2. Typ een naam in het veld Actienaam.
3. Kies op basis van de beoogde actie de optie Een vraag beantwoorden of Een bewerking uitvoeren.
4. Als uw actie een vraag beantwoordt, geeft u aan of het antwoord rechtstreeks moet worden gegeven of moet worden samengesteld door CRM.
5. Definieer Voorbeeldzinnen en Parameters.
6. Klik op Volgende.
   
7. Configureer zo nodig de parameterlader- en de contexthandlerfuncties.
8. Klik op Uitvoeringscode bewerken.
9. Definieer de uitvoeringsfunctie in het veld Uitvoeringsfunctie.
10. Klik op Gereed.
    De beoogde actie wordt gemaakt en is alleen beschikbaar in de chat van Zia wanneer deze wordt gepubliceerd.

Voorbeeldzinnen definiëren

Het definiëren van voorbeeldzinnen is cruciaal voor het definiëren van uw actie, omdat de gebruiker deze zinnen moet opzeggen om een actie te activeren. Laten we enkele voorbeeldzinnen bekijken:

• Voor acties waarmee een bewerking wordt uitgevoerd, moeten voorbeeldzinnen worden gedefinieerd onder de sectie "Hoe wordt deze bewerking geactiveerd?".
• Voor acties waarmee een vraag wordt beantwoord, moeten voorbeeldzinnen worden gedefinieerd onder de sectie "Hoe wordt deze vraag gesteld?".
• Alle tekst die als voorbeeldzin is getypt, kan worden geselecteerd en als parameter worden gemarkeerd. Na het selecteren van de tekst verschijnt er een pop-upvenster waarin u een willekeurige parameter aan de geselecteerde tekst kunt koppelen of u kunt een nieuwe parameter maken om aan de tekst te koppelen.

U kunt meer voorbeeldzinnen toevoegen door op het pictogram '+' te klikken en een bepaalde zin verwijderen door op het pictogram '-' te klikken.

U kunt deze zinnen ook opnieuw ordenen om de meestgebruikte zin bovenaan te plaatsen met behulp van het sorteerpictogram naast het tekstvak met voorbeeldzinnen.

De eerste drie voorbeeldzinnen die de gebruiker toevoegt, worden weergegeven als suggestie voor het aanroepen van een actie. Het wordt aanbevolen om duidelijke zinnen te gebruiken die gemakkelijk te onthouden zijn.

Parameters definiëren

Parameters zijn de invoergegevens die van de gebruiker moeten worden ontvangen om een actie te voltooien. U kunt een nieuwe parameter aan de actie toevoegen door te klikken op de optie "Nieuw" in de lijst met parameters of in het dialoogvenster voor suggesties voor parameters dat verschijnt wanneer u parameters in voorbeeldzinnen markeert.

Voer in het pop-upvenster Nieuwe param de volgende informatie in:

Let op: de gebruiker kan Engelstalige waarden opgeven voor al deze gegevenstypen waarna Zia de letterlijke zin omzet in het opgegeven gegevenstype.

1. Param-naam – Een geldige parameternaam moet aan de volgende punten voldoen.
   • Een geldige parameternaam moet beginnen met een kleine letter.
   • Alleen letters, cijfers en onderstrepingstekens zijn toegestaan.
   • Een parameternaam moet uniek zijn voor een actie.
   • De volgende namen kunnen niet worden gebruikt als parameter, omdat dit gereserveerde woorden zijn in Zia (userInput, previousParam, additionalParams, sessionData, broadcast, previousUserMsgs, cache, org en gebruiker).
2. Param-type – Kies een geschikt gegevenstype voor uw parameter. De volgende gegevenstypen worden ondersteund door Zia:
   • Tekst – Willekeurige tekenreeks
   • Getal – Elk geldig getal
   • Tijd – Elke geldige tijd
   • Datum – Elke geldige datum
   • Matrix voor enkelvoudige selectie – Een lijst met beschikbare opties waarin de gebruiker er één selecteert.
   • Matrix voor meervoudige selectie – Een lijst met beschikbare opties waarvan de gebruiker er meerdere selecteert.
3. Array type params – In geval van matrixparameters moet u mogelijk de volgende aanvullende informatie invoeren:
   • Array Values – U kunt een lijst met opties opnemen waaruit de gebruiker een of meer opties kan selecteren. U kunt ook de ID voor elke optie invoeren of de automatisch gegenereerde ID gebruiken terwijl u alleen de waarden invoert.
   • Invoermodus – Hiermee geeft u aan hoe een gebruiker wordt benaderd door de matrixparameter. Dit kan Tekstueel of Visueel zijn. Als u Tekstueel kiest, kan de gebruiker (in geval van een chat) of (in geval van spraak) de gewenste waarde invoeren die hij of zij aan de matrixparameter wil toewijzen. In het geval van een visuele invoermodus moet de gebruiker op de invoer klikken of tikken om deze te kiezen uit de matrixwaarden, die worden weergegeven als een keuzerondje (bij één selectie) of een selectievakje (bij meervoudige selectie).
     
4. Promptbericht – Dit is de vraag die Zia aan de gebruiker zou stellen om de parameterwaarde te verkrijgen als onderdeel van het gesprek van Zia met de gebruiker. Om bijvoorbeeld de waarde van de parameter "starttijd" te krijgen in de actie Evenement maken, wordt het promptbericht ingesteld op "Op welk moment begint het evenement?" of "Vanaf wanneer heeft het evenement plaats?". U kunt ook het promptbericht van een parameter overschrijven met de contexthandlerfunctie.

De volgorde van de parameters wijzigen – De conversatiestroom van Zia is afhankelijk van de volgorde van de gedefinieerde parameters. Zodra een actie is gedetecteerd, geeft Zia alle parameters een voor een weer met het bijbehorende promptbericht in de volgorde waarin ze zijn gedefinieerd. U kunt de parameters zelfs opnieuw rangschikken nadat u ze hebt gemaakt door een afzonderlijke parameter naar de gewenste positie te slepen en neer te zetten.

Functies definiëren

De conversatiestroom en de uitvoering van een actie worden bepaald door de functies die voor de specifieke actie zijn gedefinieerd. Functies zijn aangepaste hooks die zijn geschreven door actieontwikkelaars en door Zia worden aangeroepen tijdens het uitvoeren van een actie op de desbetreffende aanroeppunten.

Alle functies moeten worden geschreven in Deluge. Deluge is een online scripttaal van de Zoho-cloudomgeving. Raadpleeg deze handleiding voor een gedetailleerde beschrijving van Deluge.

Er zijn 3 functies die als hooks fungeren bij de verwerking door Zia. Zia roept de functies op de desbetreffende aanroeppunten aan met exacte waarden voor alle argumenten. Alle gedefinieerde functies moeten de opgegeven waarde voor het gegevenstype retourneren.

De volgende door het systeem gedefinieerde invoerargumenten zijn, naast de specifieke functieargumenten, beschikbaar voor alle functies.

Naast de bovengenoemde door het systeem gedefinieerde argumenten zijn alle statische parameters die voor de actie zijn gedefinieerd ook beschikbaar als invoerargumenten voor elke functie. Elke statische parameter is op zichzelf een argument voor elke functie.

Zia vult toepasselijke waarden in voor alle variabelen en geeft deze door als invoerargumenten voor alle functies.

Elke functie heeft zijn eigen specificatie van retourgegevens. Let op: het is de verantwoordelijkheid van de ontwikkelaar om de overeenkomst voor retourgegevens na te leven opdat uw actie correct functioneert.

Parameterladerfunctie definiëren

De parameterladerfunctie wordt gebruikt om nieuwe parameters dynamisch tijdens de looptijd toe te voegen aan de actie, naast de statistisch gedefinieerde parameters. Dit is handig wanneer de parameters van een actie niet van tevoren bekend zijn, bijvoorbeeld wanneer de parameters verschillen afhankelijk van de gebruiker. Het definiëren van de parameterladerfunctie is optioneel.

Als we bijvoorbeeld een actie schrijven om een taak te maken in CRM, zal het formulier voor het maken van de taak verschillen afhankelijk van de gebruiker vanwege verschillende lay-outconfiguraties in hun instellingen. In dergelijke gevallen laden we de velden uit het formulier voor het maken van de taak als dynamische parameters via de parameterladerfunctie, zodat deze parameters een voor een kunnen worden opgevraagd door Zia om een taak te maken.

Houd er rekening mee dat Zia geen waarden kan detecteren voor dynamische parameters die zijn geladen uit parameterladerfuncties die mogelijk zijn genoemd in de aanroepzin. De dynamische parameters worden een voor een door Zia gevraagd aan de gebruiker met het promptbericht dat voor elke parameter in de parameterladerfunctie is opgegeven.

Aanroeppunt

Zodra Zia de actie in de invoer van de gebruiker heeft gedetecteerd, worden de mogelijke statische parameterwaarden in de invoer ook gedetecteerd. De ontbrekende statische parameters worden een voor een aan de gebruiker gevraagd in de volgorde waarin ze zijn gedefinieerd. Zodra alle statische parameters zijn ingevuld, wordt de parameterladerfunctie aangeroepen door Zia met toepasselijke waarden voor alle invoerargumenten.

Als er geen statische parameters zijn gedefinieerd, wordt de parameterladerfunctie geactiveerd wanneer Zia een actie detecteert. De parameterladerfunctie wordt slechts eenmaal geactiveerd tijdens een actiecyclus.

Invoerargumenten

Naast de door het systeem gedefinieerde invoerargumenten zijn ook de volgende invoerargumenten beschikbaar voor de parameterladerfunctie.

Retourwaarde

De retourwaardefunctie moet een toewijzing met de volgende indeling retourneren.

additionalParams (verplicht) – De waarde van deze sleutel moet een lijst met parameterelementen zijn. Elke parameter moet van het gegevenstype Toewijzing zijn. Hieronder volgen de eigenschappen van een parametertoewijzingsobject.

1. name – Naam van de parameter.
2. data type – Gegevenstype van de parameter. Dit kan een van de onderstaande waarden zijn.
   • tekst
   • number
   • date
   • time
   • boolean
   • array_checkbox
   • array_radio
3. prompt_msg – Het promptbericht voor de parameter.
4. options – De opties van een matrixtypeparameter als lijst. Elke optie is een toewijzing met de sleutels "ID" en "label".
5. Input_mode – De invoermodus van een matrixtypeparameter. De waarde kan TEKSTUEEL of VISUEEL zijn.
   -mandatory- dergelijke sleutels moeten aanwezig zijn in de parametertoewijzing.
6. assign (optioneel) – De waarde van deze sleutel moet een toewijzing zijn. Deze sleutel wordt gebruikt om de waarden te wijzigen in een van de wijzigbare invoerargumenten van de functie. Alle statische parameters en het door het systeem gedefinieerde argument "cache" kunnen worden gewijzigd.

Contexthandlerfunctie definiëren (optioneel)

De contexthandlerfunctie wordt gebruikt om de gespreksstroom van een actie te regelen. U kunt de volgorde wijzigen waarin de parameters in de runtime aan de gebruikers worden gevraagd. U kunt ook bepaalde parameters overslaan, aangepaste validaties van de parameterwaarden uitvoeren en om een bevestiging vragen voordat een actie in de runtime wordt uitgevoerd.

Houd er rekening mee dat de contexthandlerfunctie de volgorde waarin de statische parameters zijn gedefinieerd, kan negeren. Als de contexthandlerfunctie is ingeschakeld, vraagt Zia de parameters op in de volgorde die wordt bepaald door de contexthandlerfunctie en niet in de volgorde die u hebt opgegeven bij het definiëren van de parameters.

Aanroeppunt

Zodra Zia de gebruikersinvoeractie detecteert, worden de mogelijke statische parameterwaarden gedetecteerd die in de gebruikersinvoer aanwezig zijn. Vervolgens zal Zia de eerste ontbrekende statische parameter aan de gebruiker vragen. Wanneer een gebruiker reageert op de parameterprompt, activeert Zia de contexthandlerfunctie. Daarom wordt de contexthandlerfunctie aangeroepen voor elke parameter die in het gesprek wordt gevraagd. Dit geldt zowel voor statische als dynamische parameters. Als een actie helemaal geen parameters heeft, wordt de contexthandlerfunctie één keer vóór de uitvoeringsfunctie uitgevoerd.

Invoerargumenten

Naast de door het systeem gedefinieerde invoerargumenten zijn de volgende invoerargumenten ook beschikbaar voor de contexthandlerfunctie.

Retourwaarde

De parameterladerfunctie moet een toewijzing retourneren die de volgende indeling moet hebben.

todo (verplicht) – Wordt gebruikt om aan Zia door te geven wat moet worden gedaan na het voltooien van de contexthandlerfunctie. Deze sleutel moet aanwezig zijn in de reactie op de contexthandlerfunctie. Het kan slechts een van de volgende waarden bevatten.

1. prompt – Zia opdracht geven om een parameter van de gebruiker te vragen.
2. bevestigen – Zia opdracht geven om een laatste bevestiging te vragen voor het aanroepen van de uitvoeringsfunctie van de actie.
3. uitvoeren – geeft Zia opdracht om de functie voor het uitvoeren van acties te activeren.

prompt (alleen van toepassing als "todo" = "prompt") – Bevat een toewijzing die aangeeft welke parameter aan de gebruiker moet worden gevraagd. Als deze sleutel niet wordt verstrekt – zelfs als "todo" is ingesteld op "prompt" – zal Zia de volgende parameter vragen in de volgorde van de parameterdefinitie. Deze sleutel kan dus worden overgeslagen als we de standaardvolgorde van de parameterdefinitie moeten gebruiken. De toewijzingswaarde kan de volgende sleutels bevatten.

1. param_name * – De naam van de parameter die u wilt weergeven. De parameternaam moet een van de gedeclareerde statische of dynamische parameters zijn.
2. opties – Opties die moeten worden weergegeven als suggesties voor de parameter. Dit geldt alleen voor matrixparameters.
3. msg – Wordt gebruikt om tijdelijk het standaardpromptbericht van de parameter te negeren.

Bevestigen (alleen verplicht als "todo" = "confirm") – Bevat een toewijzing waarin het bevestigingsbericht voor de uitvoering van de actie wordt opgegeven dat aan de gebruiker moet worden gevraagd. De toewijzingswaarde kan alleen de volgende sleutel bevatten.

1. bericht – Het bevestigingsbericht dat aan de gebruiker moet worden gevraagd.

toewijzen – De waarde van deze sleutel moet een toewijzing zijn. Deze sleutel wordt gebruikt om de waarden te wijzigen in een van de wijzigbare invoerargumenten van de functie. Alle statische parameters en het door het systeem gedefinieerde argument "cache" kunnen worden gewijzigd.

Uitvoeringsfunctie

De uitvoeringsfunctie is het eindpunt van een actie-uitvoering. Hiermee wordt de uitvoering van een actie gedefinieerd. Het betreft de daadwerkelijke uitvoering van de actie en de gebruiker ontvangt na het voltooien van de actie bericht of deze is geslaagd of mislukt. Het antwoord aan de gebruiker kan bestaan uit tekst zonder opmaak of een verzameling kaarten (visuele elementen).

Aanroeppunt

De uitvoeringsfunctie wordt aangeroepen op het eindpunt van een actie. Standaard komt het eindpunt van een actie nadat alle parameterwaarden zijn opgevraagd en van de juiste waarden zijn voorzien. Het eindpunt kan ook worden gedefinieerd vanuit de contexthandlerfunctie ("todo" : "execute"). Zodra de uitvoeringsfunctie wordt aangeroepen, is de actie voltooid en wordt elk gesprek van de gebruiker beschouwd als een nieuwe actie.

Invoerargumenten

Naast de door het systeem gedefinieerde invoerargumenten zijn ook de volgende invoerargumenten beschikbaar voor de uitvoeringsfunctie.

Retourwaarde

De uitvoeringsfunctie moet een toewijzing met de volgende indeling retourneren.

bericht (verplicht) – Hiermee beantwoordt u de gebruiker met een bericht in platte tekst. De platte tekst wordt weergegeven als spraak of tekst, afhankelijk van het communicatiemiddel.

kaart (optioneel) – Hiermee beantwoordt u de gebruiker met een visueel opgemaakt bericht. Een kaart bestaat uit een verzameling visuele elementen, zoals een tabel, afbeelding, enzovoort. De kaart wordt op het scherm weergegeven voor zowel oproep- als chatmedia. De waarde van deze sleutel is een lijst met toewijzingsobjecten. Elk toewijzingsobject vertegenwoordigt een element van de gebruikersinterface in de toewijzing. Eén kaart kan meer dan een element van hetzelfde type bevatten. Elk element in de kaart wordt onder het andere weergegeven in het antwoordbericht.

Hieronder vindt u een lijst met elementen van de gebruikersinterface die door Zia worden ondersteund:

Een actie publiceren

Aangepaste acties worden geschreven in de sandbox-omgeving en zijn niet beschikbaar voor de rest van de gebruikers van het bedrijf. Om de aangepaste acties beschikbaar te maken voor iedereen, moeten de actiegegevens worden bijgewerkt naar Zia.

Als u alle acties wilt bijwerken die voor Zoho CRM zijn geschreven, klikt u op de knop "Update" onder het tabblad Zoho CRM. Houd er rekening mee dat de knop "Update" alleen zichtbaar is als er updates beschikbaar zijn in de aangepaste acties die u hebt geschreven.

Machtigingen in Zia

De beheerder van Zia kan de gebruikers toegangsbeheer bieden op basis van hun rollen en hiërarchieniveau binnen het bedrijf. In de onderstaande lijst worden de machtigingsniveaus voor elke rol weergegeven.

1. Gebruiker – Kan alleen chatten of praten met Zia.
2. Ontwikkelaar – Kan vaardigheden schrijven naar Zia.
3. Manager – Kan de vaardigheden bijwerken naar Zia om deze beschikbaar te maken voor alle gebruikers.
4. Admin – Kan andere gebruikers beheren.
5. Superbeheerder – Is de primaire beheerder.

De minimale rol die vereist is om toegang te krijgen tot de ontwikkelaarsconsole is Ontwikkelaar. Gebruikers met beheerdersrollen hebben het recht om de rollen van andere gebruikers te wijzigen. De optie om de rol van een gebruiker te wijzigen is beschikbaar op het tabblad Instellingen. Klik onder Instellingen op de gebruiker wiens rol u wilt wijzigen. Klik op de optie "Rol wijzigen", kies een nieuwe rol voor de gebruiker in de vervolgkeuzelijst en klik op "Bijwerken". Gekoppelde taken worden naar de nieuwe rol verplaatst.