Angular

Integrating with Alan AI

To integrate an Angular app with Alan AI:

1. Add the Alan AI Web SDK to your app. You can do it in two ways:

   • With the npm package

   • In the browser library mode

   NPM package

   To install the Alan Web SDK with the npm package:

   1. In the Terminal, run the command:

      Terminal

      npm install @alan-ai/alan-sdk-web --save
      

   2. Import alanBtn to your Angular component:

      Client app

      import alanBtn from "@alan-ai/alan-sdk-web";
      

   Browser library mode

   To load the Alan AI Web SDK in the browser library mode, add the alan_lib.min.js library to the index.html file using the <script> tag:

   Client app

   <script type="text/javascript" src="https://studio.alan.app/web/lib/alan_lib.min.js"></script>
   

2. Add the Alan AI button to your component:

   Client app

   export class AppComponent {
   
     alanBtnInstance;
   
     constructor(){
       this.alanBtnInstance = alanBtn({
         key: 'YOUR_KEY_FROM_ALAN_STUDIO_HERE',
         onCommand: (commandData) => {
           if (commandData.command === 'go:back') {
             // Call the client code that will react to the received command
           }
         },
       });
     }
   }
   

Note

Regularly update the @alan-ai/alan-sdk-web package your project depends on. To check if a newer version is available, run npm outdated. To update the alan package, run npm update @alan-ai/alan-sdk-web. For more details, see npm documentation.

Specifying the Alan AI button parameters

You can specify the following parameters for the Alan AI button added to your app:

Name	Type	Description
key	string	The Alan AI SDK key for a project in Alan AI Studio.
authData	JSON object	The authentication or configuration data to be sent to the dialog script. For details, see authData.
rootEl	HTMLElement	The element where Alan AI button will be added. If no rootEl is provided, the Alan AI button is added to the body.
showOverlayOnMicPermissionPrompt	Boolean	The property signaling whether the overlay fade effect must be used when the microphone permission prompt in the browser is displayed. The overlay effect makes the prompt more noticeable and helps make sure users provide microphone access to the AI assistant.
onCommand	function	A callback for handling commands from the dialog script. In this callback, you can set up logic on how your app must react to commands received from the dialog script. For details, see onCommand handler.
onButtonState	function	A callback for receiving the connection state of the Alan AI button. For details, see onButtonState handler.
onConnectionStatus	function	A callback for receiving the connection state of the virtual assistant project run in the Alan AI Cloud. For details, see onConnectionStatus handler.
onEvent	function	A callback responsible for handling events received from Alan AI. For details, see onEvent handler.

Changing the Alan AI button position

By default, the Alan AI button is placed in the bottom right corner of the window. To change the Alan AI button position, you can use the following options for the alanBtn variable:

• left: sets the Alan AI button position from the left edge

• right: sets the Alan AI button position from the right edge

• top: sets the Alan AI button position from the top edge

• bottom: sets the Alan AI button position from the bottom edge

• zIndex: sets the z-order of the Alan AI button

Client app

alanBtn({
   key: 'YOUR_KEY_FROM_ALAN_STUDIO_HERE',
   bottom: '50px',
   left: '50px',
   zIndex: 10
});

Using client API methods

You can use the following client API methods in your Angular app:

• setVisualState()

• callProjectApi()

• playText()

• sendText()

• playCommand()

• activate()

• deactivate()

• isActive()

• remove()

• textChat.isAudioOutputEnabled()

• textChat.setAudioOutputEnabled()

setVisualState()

Use the setVisualState() method to inform the AI assistant about the app’s visual context. For details, see setVisualState().

app.component.ts

export class AppComponent {

  alanBtnInstance;

  constructor(){
    this.alanBtnInstance = alanBtn({
      key: 'YOUR_KEY_FROM_ALAN_STUDIO_HERE',
    });
  }

  public setVisualState() {
    this.alanBtnInstance.setVisualState({data: "your data"});
  }
}

app.component.html

<div>
  <a class="card" (click)="setVisualState()">
    <span>Set visual state</span>
  </a>
</div>

callProjectApi()

Use the callProjectApi() method to send data from the client app to the dialog script and trigger activities without voice and text commands. For details, see callProjectApi().

Dialog script

projectAPI.setClientData = function(p, param, callback) {
  console.log(param);
};

app.component.ts

export class AppComponent {

  alanBtnInstance;

  constructor(){
    this.alanBtnInstance = alanBtn({
      key: 'YOUR_KEY_FROM_ALAN_STUDIO_HERE',
    });
  }

  public callProjectApi() {
    this.alanBtnInstance.callProjectApi("setClientData", {value:"your data"}, function (error, result){
      // handle error and result here
    });
  }
}

app.component.html

<div>
  <a class="card" (click)="callProjectApi()">
    <span>Call setClientData method</span>
  </a>
</div>

playText()

Use the playText() method to play specific text in the client app. For details, see playText().

app.component.ts

export class AppComponent {

  alanBtnInstance;

  constructor(){
    this.alanBtnInstance = alanBtn({
      key: 'YOUR_KEY_FROM_ALAN_STUDIO_HERE',
    });
  }

  public playText() {
    this.alanBtnInstance.playText("Hello, I am Alan!");
  }
}

app.component.html

<div>
  <a class="card" (click)="playText()">
    <span>Play text</span>
  </a>
</div>

sendText()

Use the sendText() method to send a text message to Alan as the user’s input. For details, see sendText().

app.component.ts

export class AppComponent {

  alanBtnInstance;

  constructor(){
    this.alanBtnInstance = alanBtn({
      key: 'YOUR_KEY_FROM_ALAN_STUDIO_HERE',
    });
  }

  public sendText() {
    this.alanBtnInstance.sendText("Hello Alan, can you help me?");
  }
}

app.component.html

<div>
  <a class="card" (click)="sendText()">
    <span>Send text</span>
  </a>
</div>

playCommand()

Use the playCommand() method to execute a specific command in the client app. For details, see playCommand().

app.component.ts

export class AppComponent {

  alanBtnInstance;

  constructor(){
    this.alanBtnInstance = alanBtn({
      key: 'YOUR_KEY_FROM_ALAN_STUDIO_HERE',
      onCommand: (commandData: any) => {
        if (commandData.command === 'goBack') {
          // Call client code that will react to the received command
        }
      },
    });
  }

  public playCommand() {
    this.alanBtnInstance.playCommand({command: "goBack"});
  }
}

app.component.html

<div>
  <a class="card" (click)="playCommand()">
    <span>Play command</span>
  </a>
</div>

activate()

Use the activate() method to activate the Alan AI button programmatically. For details, see activate().

app.component.ts

export class AppComponent {

  alanBtnInstance;

  constructor(){
    this.alanBtnInstance = alanBtn({
      key: 'YOUR_KEY_FROM_ALAN_STUDIO_HERE',
    });
  }

  public activateButton() {
    this.alanBtnInstance.activate();
  }
}

app.component.html

<div>
  <a class="card" (click)="activateButton()">
    <span>Activate Alan AI button</span>
  </a>
</div>

deactivate()

Use the deactivate() method to deactivate the Alan AI button programmatically. For details, see deactivate().

app.component.ts

export class AppComponent {

  alanBtnInstance;

  constructor(){
    this.alanBtnInstance = alanBtn({
      key: 'YOUR_KEY_FROM_ALAN_STUDIO_HERE',
    });
  }

  public deactivateButton() {
    this.alanBtnInstance.deactivate();
  }
}

app.component.html

<div>
  <a class="card" (click)="deactivateButton()">
    <span>Deactivate Alan AI button</span>
  </a>
</div>

isActive()

Use the isActive() method to check the Alan AI button state: active or not. For details, see isActive().

app.component.ts

export class AppComponent {

  alanBtnInstance;

  constructor(){
    this.alanBtnInstance = alanBtn({
      key: 'YOUR_KEY_FROM_ALAN_STUDIO_HERE',
    });
  }

  public isActive() {
    console.log("The button is active: " + this.alanBtnInstance.isActive());
  }
}

app.component.html

<div>
  <a class="card" (click)="isActive()">
    <span>Check button state</span>
  </a>
</div>

remove()

Use the remove() method to remove the Alan AI button from the parent element. For details, see remove().

app.component.ts

export class AppComponent {

  alanBtnInstance;

  constructor(){
    this.alanBtnInstance = alanBtn({
      key: 'YOUR_KEY_FROM_ALAN_STUDIO_HERE',
    });
  }

  public removeButton() {
    this.alanBtnInstance.remove();
  }
}

app.component.html

<div>
  <a class="card" (click)="removeButton()">
    <span>Remove Alan AI button</span>
  </a>
</div>

textChat.isAudioOutputEnabled()

Use the textChat.isAudioOutputEnabled() method to get the state of audio output for the Alan AI Chat. For details, see textChat.isAudioOutputEnabled().

Client app

alanBtnInstance.textChat.isAudioOutputEnabled()

textChat.setAudioOutputEnabled()

Use the textChat.setAudioOutputEnabled() method to enable or disable audio output for the Alan AI Chat. For details, see textChat.setAudioOutputEnabled().

Client app

alanBtnInstance.textChat.setAudioOutputEnabled(true)

Using handlers

You can use the following Alan AI handlers in your Angular app:

• onCommand handler

• onButtonState handler

• onConnectionStatus handler

• onEvent handler

onCommand handler

Use the onCommand handler to handle commands sent from the dialog script. For details, see onCommand handler.

Client app

this.alanBtnInstance = alanBtn({
  key: 'YOUR_KEY_FROM_ALAN_STUDIO_HERE',
  onCommand: (commandData: any) => {
    if (commandData.command === 'go:back') {
      // Call client code that will react to the received command
    }
  },
});

onButtonState handler

Use the onButtonState handler to capture and handle the Alan AI button state changes. For details, see onButtonState handler.

Client app

this.alanBtnInstance = alanBtn({
  key: 'YOUR_KEY_FROM_ALAN_STUDIO_HERE',
  onButtonState: function (e) {
    console.info('onButtonState', e);
  },
});

onConnectionStatus handler

Use the onConnectionStatus handler to capture and handle the connection status for the virtual assistant project. For details, see onConnectionStatus handler.

Client app

this.alanBtnInstance = alanBtn({
  key: 'YOUR_KEY_FROM_ALAN_STUDIO_HERE',
  onConnectionStatus: function(status) {
    console.log("The status is " + status);
  },
});

onEvent handler

Use the onEvent handler to capture and handle events emitted by Alan AI: get user’s utterances, assistant responses and so on. For details, see onEvent handler.

Client app

this.alanBtnInstance = alanBtn({
  key: 'YOUR_KEY_FROM_ALAN_STUDIO_HERE',
  onEvent: function (e) {
    console.info('onEvent', e);
  },
});

What’s next?

Example apps

Find and explore examples of voice-enabled apps on the Alan AI GitHub repository.

View on GitHub