Predefined script objects

Alan provides several predefined objects that you can use to store and share data in voice scripts:


authData is a special object that can be used to store static device- or user-specific data that need to be passed from the client app. The data is sent when the Alan client SDK connects to the voice script and can be accessed through Alan’s p.authData runtime object.

For details, see authData.


project is a special object that can be used in the global project scope. The data stored in project is accessible from any script added to the project of your in-app assistant. For example, if you need some variable to be available across all project scripts, you can save its value to project.

project can be helpful if you want to split a complex script and separate configuration and data structures from functions and project logic. This way, your project will be more transparent and easier to support.

Let’s assume you have two scripts: script1 followed by script2. In script1, we define project.config = {initValue: 1}. You can then use project.config in script2 as an already existing and defined variable:

Voice script
project.config = {initValue: 1};

console.log("Init value is " + project.config.initValue);

To store data in project, you can use onCreateProject callback. For details, see Predefined callbacks.


score stores the match score assigned to the intent that is considered the best match for the user’s utterance. The value stored in p.score is a floating point number ranging from 1.0 — the most accurate match, to 0.0 — no match. p.score can be used to adjust the accuracy of Alan’s answers.

For details, see Intent matching.


state can be used if you work with contexts in the voice script. Every context has a predefined state object. You can think of state as a dictionary or knowledge base in which you can store any information you need.

The data stored in state is available in the current conversational context and can be accessed through the p.state variable in the script. When a new context is activated, you can send this data to it or overwrite it with the then function. For details, see Sharing information between contexts.

Voice script
let startGame = context(() => {
    intent("What is my current score?", p => {`Your score is ${p.state.result.toString()}`);

intent("Let's start the game", p =>{"Sure, let's go");
    p.then(startGame, {state: {result:0}});


userData is a runtime object that can be used during a voice session with a specific user. The session starts when the user launches your app with the in-app assistant to interact with it. The session is closed when the user quits your app or is terminated if the user is inactive for a 30-minute period.

In userData, you can store arbitrary data that must be available during the current voice session. This data can be accessed through the p.userData variable in the voice script, from any script or context of the project.

Voice script
onCreateUser(p => {
    p.userData.favorites = ("action");

intent('What movies would you recommend?', p => {`Here are some popular movies in the ${p.userData.favorites} genre...`);

To store and reset data in userData, you can use onCreateUser and onCleanupUser callbacks. For details, see Predefined callbacks.


The visual object is used to store the visual state that is received from the client app. You can use this object to differentiate and filter commands in the voice script based on the current visual context of your app.

The visual state object is different and independent for every user of your app. This object is session-specific: it does not persist between voice sessions. For details, see Visual state.

Voice script
    'What (screen|) is this?',
    'Where am I?',
    p => {
        if (!p.visual.screen) {
  'This is an e-commerce app with an in-app assistant');
        switch (p.visual.screen) {
            case 'all':
      'This is the main screen showing all available products.');
            case 'clothing':
      'These are all of the available clothing.');
            case 'accessories':
      'These are all of the available accessories.');