Skip to content

Voice rules

Trigger listening

Listening is triggered by configurable keywords in the Dialog tab of each client's properties.

There are three ways to say a rule:

The rule is said in the same sentence as the trigger keyword. 

graph LR
A[keyword and rule]
A --> B[execution of the action];

You: Jarvis, what time is it?
Client: The time is 10 a.m.

Listening is activated by the trigger keyword, the client responds, then you say the rule. 

graph LR
A[keyword]
A --> B[listening message];
B --> C[rule];
C --> D[execution of the action];

You: Jarvis
Client: I'm listening
Vous: What time is it?
Client: The time is 10 a.m.

Listening is activated by the trigger keyword, the customer responds, you pass a rule, another... then you end the dialog.

graph LR
A[keyword]
A --> B[listening message];
B --> C[rule];
C --> D[execution of the action];
D--> E{shall we<br>continue?};
E --> F{rule?}; 
F --> |Yes| D; 
F --> |No| G[Exit];

You: Jarvis
Client: I'm listening
Vous: quelle heure est-il ?
Client: What time is it?
Client: Would you like anything else?
Vous: turn on the TV
Client: It's done
Client: anything else?
etc...
etc...
Client: anything else?
Vous: it's fine thanks
Client: At your service

Note

Loop mode must be enabled in the Dialog tab of each client's properties.

All sentences are defined in the Rules tab of each client's properties.

Listening mode

To use A.V.A.T.A.R properly, you need to understand how a dialog is executed.
The diagram below shows the various steps in the execution of a rule.

graph LR
A[listening];
A --> B{activation?};
B --> |Yes| C[stop listening]; 
B --> |No| A; 
C --> D[dialogue and action];
D --> E[end];
E --> F[Restitution of<br>the listening];
F --> A

As can be seen in the diagram, the listening of the client is stopped at the beginning and restored at the end, so as not to pick up sentences, noises or say another rule at the same time that could interfere with the dialogue and actions in progress.

In the client console, you can see the various related messages:

  • Stop listening...: Listening is stopped, you can no longer say a rule.
  • Ready to listen!: The client is in listening mode, you can say a rule.
Important

After a dialog and/or an action, if you don't see the Ready to listen! in the client console and listening is not reactivated, this is usually due to a development error in the plugin linked to the rule that doesn't send the end-of-action request to the client.

In this case, you'll need to reactivate the listening function manually (see below), and don't forget to correct the plugin error!

Listening actions in the contextual menu

You can use contextual menu actions to manage listening:

These actions are available:

  • On each client node context menu in the server interface.
  • In the contextual menu accessible by left-clicking on its name in each client's interface.

Activate listening

Enables listening on the client. This action resets the listening function if it has been deactivated.

Disable listening

Disables listening on the client.

Start listening

Activates listening on the client. This action is identical to the trigger keyword.

Stop listening

Stop listening on the customer if this has been triggered.



Getting started