HERE Android SDK Developer's Guide

Field

The enumeration Field is a member of com.here.android.mpa.nlp.Intention.

Enumeration Summary

public static final enumeration Intention.Field

extends java.lang.Enum, java.lang.Object

Intention parameters names

[For complete information, see the section Enumeration Details]

Enum Constant Summary

Table 1. Enum Constants in Field
Fields

public static final Field VENDOR

Vendor which generated this intent.

public static final Field VERSION

Version of the deduced intention.

public static final Field LANGUAGE

Language used for deduction.

public static final Field DOMAIN

Knowledge domain.

public static final Field DURATION

Request processing time for your information only.

public static final Field FUNCTION

Function of the intent.

public static final Field TEXT

Sentence that produced this intention.

public static final Field OPTIMIZE

Optimize the route by reordering stops on the route for the following intents and may not always be present:

public static final Field REROUTE

Determines whether an alternative route should be requested in in ROUTE_FROM_TO intent and may not always be present.

public static final Field ARRIVAL_TIME

Arrival time for the following intents and may not always be present:

public static final Field ARRIVAL_TIME_VALUE

Arrival time value for the following intents and may not always be present:

public static final Field TIME_SUFFIX

AM/PM time suffix for the following intents and may not always be present:

public static final Field REPLY

Proposed talk back response for the following intents and may not always be present:

public static final Field SEARCH_COUNT

Search results count for the following intents:

public static final Field RADIUS

Search radius for the following intents and may not always be present:

public static final Field TYPE

Subcategorization of intents.

public static final Field ROUTE_TYPE

Route type for the following intents and may not always be present:

public static final Field RATING

Place rating for POI intent and may not always be present.

public static final Field MEASURE

Measure system for the following intents and may not always be present:

public static final Field EXCEPTION

Exclusion for the following intents and may not always be present:

public static final Field WHERE

Search criteria for destination for the following intents and may not always be present:

public static final Field NEAR

Search criteria for destinaton for the following intents and may not always be present:

public static final Field STOPOVER_WHERE

Search criteria for stopover for the following intents and may not always be present:

public static final Field STOPOVER_NEAR

Search criteria for stopover for the following intents and may not always be present:

public static final Field DEPARTURE_WHERE

Search criteria for departure for the following intents and may not always be present:

public static final Field DEPARTURE_NEAR

Search criteria for departure for the following intents and may not always be present:

public static final Field FROM

Used to indicate the source for the intent.

public static final Field TARGET

Use to indicate the target for the intent.

public static final Field STOPOVER

Used to indicate a stopover for the following intents and may not always be present:

public static final Field BY_NUMBER

Indicates whether value provided for TARGET in CALL_NUMBER intent is a phone number to be used for making a call.

public static final Field MESSAGE

Text of the message for SEND_MESSAGE intent.

public static final Field TOGGLE

To turn a feature on/off for the following intents:

public static final Field BY

Transport indicator for the following intents and may not always be present:

public static final Field COLLECTION_NAME

Collection name for the following intents and may not always be present:

public static final Field COLLECTION_ITEM

Collected item for the following intents and may not always be present:

public static final Field CONTACT

Contact name for the following intents and may not always be present:

public static final Field CATEGORY

Category for the following intents and may not always be present:

public static final Field WHEN

Time reference for the following intents and may not always be present:

public static final Field CONVERSATION

Asking user for more info.

public static final Field USE_LAST_INTENT

Indicates whether to use previous intent for context for POI intent and may not always be present.

public static final Field ONLINE_DEDUCTION

Indicates whether to use remote backend vs local NLP database for deduction.

public static final Field WAKEUP_WORDS

Whether to use wakeup words for SET_PARAM intent and may not always be present.

public static final Field DISTANCE_MEASURE

Distance measurement for SET_PARAM intent and may not always be present.

public static final Field SHOW_ROUTE_ONLY

Indicate whether to just show the route without starting navigation for the following intents and may not always be present:

public static final Field SIMULATE

Indicates whether to start guidance simulation for ROUTE_FROM_TO intent and may not always be present.

public static final Field ALTERNATIVE_ROUTE

Indicates whether to calculate a route for ROUTE_FROM_TO intent and may not always be present.

public static final Field FIRST_OPERAND

First operand of an arithmetic expression for MATH intent and it's always present.

public static final Field SECOND_OPERAND

Second operand of an arithmetic expression for MATH intent and it's always present.

public static final Field OPERATOR

Operator of an arithmetic expression for MATH intent and it's always present.

Method Summary

Table 2. Methods in Field
Methods

public static Field get (String name)

Retrieve enum value from the given string.

public String getName ()

Retrieve string value for the enum, e.g.

public static Field valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

public static Intention.Field[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.

Enumeration Details

Intention parameters names

Enum Constant Details

public static final Field VENDOR

Vendor which generated this intent. This is applicable for all intents and is always present. Its value is array with one string. e.g. "vendor":["HERE"]

public static final Field VERSION

Version of the deduced intention. This is applicable for all intents and is always present.Its value is an array with one string in the format of major.minor.build. e.g. "version":["1.0.2"]

public static final Field LANGUAGE

Language used for deduction. This is applicable for all intents and is always present. Its value is an array that contains one of the following:

e.g. "language":["eng"]

public static final Field DOMAIN

Knowledge domain. e.g. "domain":["map.routing"]. This is not currently returned in any intent.

public static final Field DURATION

Request processing time for your information only. This is applicable for all intents and is always present. e.g. "duration":["0ms"]

public static final Field FUNCTION

Function of the intent. This is applicable for all intents and is always present. Its value is an array that contains at least one of the values defined in Intention.Function. e.g. "func":["ROUTE_FROM_TO"] e.g. "func":["START_TALKING","DISTANCE_FROM_TO"]

public static final Field TEXT

Sentence that produced this intention. This is applicable for all intents and is always present. Its value a array of one string. e.g. "text":["where am i"]

public static final Field OPTIMIZE

Optimize the route by reordering stops on the route for the following intents and may not always be present:

Its values is an array that contains one of the following:

e.g. "optimize":["false_"]

public static final Field REROUTE

Determines whether an alternative route should be requested in in ROUTE_FROM_TO intent and may not always be present. Its value is an array that contains one of the following values:

e.g. "reroute":["on_"]

Note that REROUTE means to stop using the existing route and get a new route to the same destination. On the other hand, ALTERNATIVE_ROUTE means to stop using the existing route and get a new route to an alternative destination.

public static final Field ARRIVAL_TIME

Arrival time for the following intents and may not always be present:

Its value is an array that contains one string.

e.g. "I have to be in seattle by 5" --> "arrival_time":["5"]

e.g. "I have to be in seattle by 5pm" --> "arrival_time":["5pm"]

This is the concatenation of the values for ARRIVAL_TIME_VALUE and TIME_SUFFIX if TIME_SUFFIX exists.

public static final Field ARRIVAL_TIME_VALUE

Arrival time value for the following intents and may not always be present:

Its value is an array that contains one string that represents the arrival time without am/pm suffix.

e.g. "I have to be in seattle by 5" --> "arrival_time_value":["5"]

e.g. "I have to be in seattle by 5pm" --> "arrival_time_value":["5"]

public static final Field TIME_SUFFIX

AM/PM time suffix for the following intents and may not always be present:

Its value is an array that contains one of the following:

e.g. "I have to be in seattle by 5" --> not present

e.g. "I have to be in seattle by 5pm" --> "time_suffix":["pm"]

public static final Field REPLY

Proposed talk back response for the following intents and may not always be present:

Its value is an array that contains one string. e.g. "reply":["sure"]

public static final Field SEARCH_COUNT

Search results count for the following intents:

This may not always be present for POI but is always present for SEARCH_RESULT_LIMIT.

Its value is an array that contains one string. e.g. "search_count":["5"]

public static final Field RADIUS

Search radius for the following intents and may not always be present:

Its value is an array that contains one string. e.g. "radius":["5"]

public static final Field TYPE

Subcategorization of intents.

For the following intents:

it may not always be present and its value is an array that contains one of the following:

For POI intent, it may not always be present and its value is an array that contains one of the following:

For PLACE_INFO intent, it may not always be present and its value is an array that contains one of the following:

For REPORT_GEO_EVENT intent, it's always present and its value is an array that contains one of the following:

For TRAFFIC intent, it may not always be present and its value is an array that contains one of the following:

For NUMBER_OF intent, it's always present and its value is an array that contains one of the following:

public static final Field ROUTE_TYPE

Route type for the following intents and may not always be present:

Its value is an array that contains one of the following:

public static final Field RATING

Place rating for POI intent and may not always be present. Its value is an array that contains one of the following values:

public static final Field MEASURE

Measure system for the following intents and may not always be present:

Its value is an array that contains one of the following:

public static final Field EXCEPTION

Exclusion for the following intents and may not always be present:

Its value is an array that contains at least one string.

public static final Field WHERE

Search criteria for destination for the following intents and may not always be present:

Its value is an array that contains at least one string.

public static final Field NEAR

Search criteria for destinaton for the following intents and may not always be present:

Its value is an array that contains at least one string.

public static final Field STOPOVER_WHERE

Search criteria for stopover for the following intents and may not always be present:

Its value is an array that contains at least one string.

public static final Field STOPOVER_NEAR

Search criteria for stopover for the following intents and may not always be present:

Its value is an array that contains at least one string.

public static final Field DEPARTURE_WHERE

Search criteria for departure for the following intents and may not always be present:

Its value is an array that contains at least one string.

public static final Field DEPARTURE_NEAR

Search criteria for departure for the following intents and may not always be present:

Its value is an array that contains at least one string.

public static final Field FROM

Used to indicate the source for the intent. For the following intents, it may not always be present:

Its value is an array that contains one of the following:

For the following intents, it's always present:

Its value is an array that contains one string.

For POI intent, it may not always be present and its value is an array that contains COLLECTION_OBJ.

public static final Field TARGET

Use to indicate the target for the intent.

For CALL_NUMBER intent, it's always present and its value is an array that contains one of the following:

  • HOME
  • WORK
  • a string that represents a contact name
  • a string that contains a phone number
  • a string that represents a search category

For CHANGE_MAP_CENTER intent, it's always present and its value is an array that contains one of the following:

  • ORIGIN
  • a string that indicates a location

For CHECK_COLLECTION intent, it's always present and its value is an array that contains one of the following:

  • HOME
  • WORK
  • a string that indicates a location

For the following intents, it's always present:

Its value is an array that contains one string representing the target collection.

For DOWNLOAD intent, it's always present and its value is an array that contains one string that indicates a location.

For REMOVE intent, it's always present and its value is an array that contains one of the following:

For REMOVE_FROM_CONTACTS intent, it's always present and its value is an array that contains a string representing the contact to be removed.

For REMOVE_FROM_MAP, it's always present and its value is an array that contains one of the following:

  • ALL_OBJ
  • ROUTE_OBJ
  • STOPOVER_OBJ
  • a string that presents the ordinal of the objects on the map
  • a string that presents a category of the objects on the map
  • a string that presents the object on the map

For SEND_MESSAGE intent, it's always present and its value is an array that contains one of the following:

For TALK_SPEED intent, it's always present and its value is an array that contains one of the following:

For VOLUME intent, it's always present and its value is an array that contains one of the following:

For WEB_SEARCH intent, it's always present and its value is an array that contains a search topic.

For ZOOM intent, it's always present and its value is an array that contains one of the following:

For ADD_STOPOVER intent, it may not always be present and its value is an array that contains a string that indicates a category for the search.

For ADDRESS intent, it may not always be present and its value is an array that contains one of the following:

For ELEVATION intent, it may not always be present and its value is an array that contains one of the following:

  • HOME
  • WORK
  • a string that indicates a location

For COLLECT_LOCATION intent, it may not always be present and its value is an array that contains one of the following value:

  • HOME
  • WORK
  • CAR
  • a string that indicates the name for the location to be collected.

For POI intent, it may not always be present and its value is an array that contains one of the following:

  • a string that indicates a category for the search, e.g. restaurant.
  • a string that indicates a place name, e.g. starbucks.
  • a string that indicates an address.
  • COLLECTION_OBJ
  • IT_OR_THERE

For the following intents, it may not always be present:

Its value is an array that contains one of the folliwing value:

For the following intents, it may not always be present:

Its value is an array that contains on of the following:

  • ALL_OBJ
  • IT_OR_THERE
  • a string that indicates the ordinal of the object to be removed.
  • a string that indicates a category of objects to be removed.
  • a string that indicates the object to be removed.

For REPORT_GEO_EVENT intent, it may not always be present and its value is an array that contains one string that presents the event, e.g. crime, hear attack, road accident, ...etc.

For SAVE_PHONE_NUMBER intent, it may not always be present and its value is an array that contains a phone number string.

For SEND_LOCATION intent, it may not always be present and its value is an array that contains one of the following:

For SYS_TIME intent, it may not always be present and its value is an array that contains one of the following:

For TRAFFIC intent, it may not always be present and its value is an array that contains one of the following:

For the following intents, it may not always be present:

Its value is an array that contains one of the following:

  • ROUTE_OBJ
  • a string that indicates a search topic

For USE_LANGUAGE intent, it may not always be present and its value is an array that contains one of the following string:

public static final Field STOPOVER

Used to indicate a stopover for the following intents and may not always be present:

Its value is an array that contains at least one of the following:

  • IT_OR_THERE
  • HOME
  • WORK
  • a string that indicates a category for the stopover
  • a string that represents a location
  • a string that represents a collected place

public static final Field BY_NUMBER

Indicates whether value provided for TARGET in CALL_NUMBER intent is a phone number to be used for making a call. Its value is an array of one of the following:

This may not always be present. When not present, it's assumed that the value provided for TARGET is not a phone number.

public static final Field MESSAGE

Text of the message for SEND_MESSAGE intent. This may not always be present. Its value is an array of one string that indicates the message to be sent.

public static final Field TOGGLE

To turn a feature on/off for the following intents:

Its value is an array of one of the following:

This will always be present except for TRAFFIC. For TRAFFIC intent, when it's absent, it's assumed to be ON.

public static final Field BY

Transport indicator for the following intents and may not always be present:

Its value is an array of one of the following:

public static final Field COLLECTION_NAME

Collection name for the following intents and may not always be present:

This will always be present for the following intents:

Its value is an array that contains one string representing the name of the collection.

public static final Field COLLECTION_ITEM

Collected item for the following intents and may not always be present:

Its value is an array that contains one of the following:

  • IT_OR_THERE
  • ALL_OBJ
  • a string that presents the name of the item in the collection
  • a string that presents the ordinal of the item in the collection

public static final Field CONTACT

Contact name for the following intents and may not always be present:

Its value is an array that contains one string representing the name of the contact.

public static final Field CATEGORY

Category for the following intents and may not always be present:

Its value is an array that contains one string representing a category, e.g. restaurant, parking, hotel, ...etc.

public static final Field WHEN

Time reference for the following intents and may not always be present:

Its value is an array that contains at least one of the following:

  • today
  • tomorrow
  • day after tomorrow
  • now
  • time, e.g. 5pm
  • day of the week, e.g. Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, weekend
  • date, 1st of January, January 1st
  • month, e.g. January, Feburary, March, ...etc.

public static final Field CONVERSATION

Asking user for more info. Conversation support for COLLECT_LOCATION intent and may not always be present. Its value is an array that contains one of the following:

When absent, it should be assumed to be OFF.

public static final Field USE_LAST_INTENT

Indicates whether to use previous intent for context for POI intent and may not always be present. Its value is an array that contains one of the following:

When absent, it should be assumed to be OFF.

public static final Field ONLINE_DEDUCTION

Indicates whether to use remote backend vs local NLP database for deduction. This is applicable for SET_PARAM intent and may not always be present. Its value is an array that contains one of the following:

public static final Field WAKEUP_WORDS

Whether to use wakeup words for SET_PARAM intent and may not always be present. Its value is an array that contains one of the following:

public static final Field DISTANCE_MEASURE

Distance measurement for SET_PARAM intent and may not always be present. Its value is an array that contains one of the following:

public static final Field SHOW_ROUTE_ONLY

Indicate whether to just show the route without starting navigation for the following intents and may not always be present:

Its value is an array that contains one of the following:

public static final Field SIMULATE

Indicates whether to start guidance simulation for ROUTE_FROM_TO intent and may not always be present. Its value is an array that contains one of the following:

When absent, it should be assumed to be OFF.

public static final Field ALTERNATIVE_ROUTE

Indicates whether to calculate a route for ROUTE_FROM_TO intent and may not always be present. Its value is an array that contains one of the following:

When absent, it should be assumed to be FALSE.

Note that ALTERNATIVE_ROUTE means to stop using the existing route and get a new route to an alternative destination. E.g. instead of the current route to the closest Startbucks, show route to a different Startbucks. On the other hand, REROUTE means to stop using the existing route and get a new route to the same destination.

public static final Field FIRST_OPERAND

First operand of an arithmetic expression for MATH intent and it's always present. Its value is an array of one numeric string.

public static final Field SECOND_OPERAND

Second operand of an arithmetic expression for MATH intent and it's always present. Its value is an array of one numeric string.

public static final Field OPERATOR

Operator of an arithmetic expression for MATH intent and it's always present. Its value is an array that contains one of the following:

  • +
  • -
  • *
  • /

Method Details

public static Field get (String name)

Retrieve enum value from the given string. e.g. Field.get("vendor"); returns Field.VENDOR .

Parameters:

  • name

    string to be matched

Returns:

null if there is no enum with the specified name

public String getName ()

Retrieve string value for the enum, e.g. Field.VENDOR.getName(); returns "vendor" .

Returns:

String value for the enum

public static Field valueOf (String name)

This method retrieves the enumeration value that matches the name specified by the caller.

Parameters:

  • name

    A string containing the name of the enumeration member whose value is to be retrieved.

public static Intention.Field[] values ()

This method retrieves an array of constants of the given enum type in the order in which they are declared.