Categories:
auraCommand model
Description of the auraCommand model suitable for sending intents directly to Aura with no recognition stage
Introduction
An auraCommand is an structure to send intents directly to Aura. It includes specific messages consisting on pre-defined options that the user can select from Aura’s interface as part of the response to her request.
These messages come from channels using Direct Line format. Currently, they correspond to notifications and suggestions.
The aura-bot recognizer in charge of auraCommand is aura-command-recognizer-middleware. This recognizer detects if the message matches auraCommand format and then processes the message and extract the intent and entities from it.
An auraCommand should be sent within the channelData of the request to aura-bot in an optional property called auraCommand.
AuraCommand property in channelData
It is the channelData property called AuraCommand, which value should fit an AuraCommand Model.
| Property | Type | Description |
|---|---|---|
| auraCommand | AuraCommand | This property contains an auraCommand object. |
AuraCommand Model
| Property | Type | Description |
|---|---|---|
| type | string | AuraCommand type:
|
| value | Intent model or string | Object intent or text. |
| utm | Utm model | Source that contains the AuraCommand. |
| actions | Action model | Array of actions. |
Intent model
| Property | Type | Description |
|---|---|---|
| intent | string | Name of the intent. If this name does not contain the prefix intent., Aura will add the it. |
| entities | Entity model | Array with the entities. This array can be empty. |
Entity model
| Property | Type | Description |
|---|---|---|
| type | string | Name of the intent. If this name does not contain the prefix intent., Aura will add it. |
| entity | string | Name of the entity. If this name does not contain the prefix ent. Aura will add it. |
| canon | string | |
| score | float | Array with the entities. This array can be empty. |
Utm model
| Property | Type | Description |
|---|---|---|
| source | string | It identifies which site sent the traffic. In Aura, use the channel name. |
| medium | string | It identifies what type of link was used, such as cost per click or email. In Aura, use banner, button, etc. |
| campaign | string | It identifies a specific product, promotion or strategic campaign. |
| term | string | It identifies search terms. |
| content | string | It identifies what was specifically clicked to bring the user to the site, such as a banner ad or a text link. |