Skip to content

Intent Structures

This describes the structures associated with intents. The audio after a "Hey Vector" is sent to servers for processing. The servers send a response back, in the form of an intent. This is a code and a structure that represents an action to carry out in response to the spoken request, query, or statement; it may represent the action requested, an answer to a query, or an action that emotionally responds to what was said.

Cloud Intents

Cloud Intent Description
intent_amazon_signin
intent_amazon_signout
intent_blackjack_hit
intent_blackjack_playagain
intent_blackjack_stand
intent_character_age
intent_clock_checktimer
intent_explore_start
intent_global_delete_extend
intent_global_stop_extend
intent_greeting_goodbye
intent_greeting_hello
intent_greeting_goodmorning
intent_greeting_goodnight
intent_imperative_abuse
intent_imperative_affirmative
intent_imperative_apologize
intent_imperative_come
intent_imperative_dance
intent_imperative_eyecolor
intent_imperative_eyecolor_specific_extend
intent_imperative_fetchcube
intent_imperative_findcube
intent_imperative_lookatme
intent_imperative_lookoverthere
intent_imperative_love
intent_imperative_negative
intent_imperative_praise
intent_imperative_scold
intent_imperative_quiet
intent_imperative_shutup
intent_imperative_volumedown
intent_imperative_volumelevel_extend
intent_imperative_volumeup
intent_knowledge_promptquestion
intent_knowledge_response_extend
intent_knowledge_no_response
intent_names_username_extend
intent_message_playmessage_extend
intent_message_recordmessage_extend
intent_imperative_backup
intent_imperative_forward
intent_imperative_turnaround
intent_imperative_turnleft
intent_imperative_turnright
intent_names_ask
intent_play_anygame
intent_play_anytrick
intent_play_blackjack
intent_play_fistbump
intent_play_pickupcube
intent_play_popawheelie
intent_play_rollcube
intent_play_specific_extend
intent_seasonal_happyholidays
intent_seasonal_happynewyear
intent_clock_settimer_extend
intent_clock_time
intent_system_noaudio
intent_status_feeling
intent_system_charger
intent_system_sleep
intent_photo_take_extend
intent_weather_extend

Parameters for the Intents

The following are the parameters for each of the intents. These structures are serialized as a JSON string and passed in the parameters property of the ASR response. The intents not listed below do not have any added parameters properties.

Clock set timer

The intent_clock_settimer_extend intent parameters structure has the following properties:

Table: intent_clock_settimer_extend properties

Property Type Units Description
timer_duration int seconds number of seconds to set the timer to.

Global Delete

The intent_global_delete_extend intent parameters structure has the following properties:

Table: intent_global_stop_deletable properties

Property Type Units Description
entity_behavior_deletable string See the table below for an enumeration of the allowed values. The item to delete.

The set of acceptable items that can be deleted include:

String Description
message
photo
timer

Global stop

The intent_global_stop_extend intent parameters structure has the following properties:

Table: intent_global_stop_extend properties

Property Type Units Description
entity_behavior_stoppable string See the table above for an enumeration of the allowed values. The item to delete.

Imperative Eye Color

The intent_imperative_eyecolor_extend intent parameters structure has the following properties:

Table: intent_imperative_eyecolor_extend properties

Property Type Units Description
eye_color string See the table below for an enumeration of the allowed values. The name of the color to set the eye color to.

The enumeration of eye color values:

String Description
COLOR_BLUE
COLOR_GREEN
COLOR_ORANGE
COLOR_PURPLE
COLOR_TEAL
COLOR_YELLOW

Imperative Volume Lvel

The intent_imperative_volumelevel_extend intent parameters structure has the following properties:

Table: intent_imperative_volumelevel_extend properties

Property Type Units Description
volume_level string See the table below for an enumeration of the allowed values. The name of the volume level to change to.

The enumeration of volume levels:

String Description
VOLUME_1
VOLUME_2
VOLUME_3
VOLUME_4
VOLUME_5

Knowledge Response

This intent_knowledge_response_extend intent parameters structure has the following properties:

Table: intent_knowledge_response_extend properties

Property Type Units Description
answer string The text to be spoken
answer_type string "InformationCommand" "NoResultCommand"
query_text string The text of the question asked.

Play Message

This intent_message_playmessage_extend intent parameters structure has the following properties:

Table: intent_message_playmessage_extend properties

Property Type Units Description
given_name string The name of the person to send the message to.

User name

This intent_names_username_extend intent parameters structure has the following properties:

Table: intent_names_username_extend properties

Property Type Units Description
username string The name of the user

Take Photo

The intent_photo_take_extend intent parameters structure has the following properties:

Table: intent_photo_take_extend properties

Property Type Units Description
entity_photo_selfie string Empty string if taking a photo, "photo_selfie" if taking a selfie.

Weather

The intent_weather_extend intent parameters structure has the following properties:

Table: intent_weather_extend properties

Property Type Units Description
condition string The current weather conditions. One of "Clear", "Cloudy", "Cold", "Rain", "Snow", "Stars", "Sunny", "Thunderstorms", or "Windy"
is_forecast string "false" or "true" "false" if it is the current weather conditions; "true" if forecasted weather conditions.
local_datetime string The local time (where the weather conditions apply) in UTC ISO 8601 format.
speakable_location_string string The location name that Vector could employ in his verbal description of the temperature.
temperature string degrees The current or forecasted temperature, in the given units.
temperature_unit string F or C, for the units