LocalBusiness Intents
Introduction
A particular physical business or branch of an organization, like a restaurant, a medical practice, or a store. These intents let users ask for information about businesses such as the location, contact information, or opening hours.
This document provides a quick reference to the LocalBusiness
intents and corresponding slots. For details around how these intents are specified, see Understanding the Structure of the Built-in Intent Library.
Intent Signature
Use the intent signature as the intent
name in your intent schema. This example shows a schema with two LocalBusiness
intents:
{
"intents": [
{
"name": "AMAZON.SearchAction<object@LocalBusiness>"
},
{
"name": "AMAZON.SearchAction<object@LocalBusiness[openHours]>"
}
]
}
For more about the components of this signature, see Understanding the Structure of the Built-in Intent Library.
To see the full JSON format for intents, see Interaction Model Schema. You can also use the developer console user interface to add the intents and then see the JSON code in the JSON Editor.
LocalBusiness
intents can be used in English (US) skills. They are not available for English (UK) or German skills.LocalBusiness Intents
The following table summarizes the available LocalBusiness
intents and the set of slots that may be included. For each intent, the sections below the table show:
- A sample utterance that would invoke the intent.
- The JSON you include in your intent schema if you want to use the intent.
-
An example of the
IntentRequest
sent to your skill for the provided sample utterance, illustrating the slots that may be included. For brevity, these samples leave out the full set of properties that are normally part of a completeIntentRequest
.Note that if your interaction model includes multiple intents with similar utterances, your results may vary from these examples.
For definitions of the slots used in these intents, see LocalBusiness Slots.
Intent Signature | Example Utterance | Possible Slots |
---|---|---|
AMAZON.SearchAction<object@LocalBusiness> |
"what are the three best coffee shops in baltimore" | object.location.addressLocality.name object.spatialRelation object.location.name object.location.type object.type object.name object.aggregateRating object.toLocation.name object.fromLocation.type object.toLocation.addressRegion.name object.toLocation.addressLocality.name |
AMAZON.SearchAction<object@LocalBusiness[openHours.closes]> |
"what time is smitten's ice cream shop open till" | object.location.addressLocality.name object.spatialRelation object.location.name object.openHours.closes object.type object.name object.location.streetAddress.name |
AMAZON.SearchAction<object@LocalBusiness[openHours]> |
"what time does dunkin's open tomorrow" | object.location.addressLocality.name object.spatialRelation object.location.name object.openHours.closes object.type object.name object.location.streetAddress.name object.location.addressRegion.name object.openHours.opens object.openHours.type |
AMAZON.SearchAction<object@LocalBusiness[telephone]> |
"what is the phone number for ocean road school point pleasant new jersey" | object.location.addressLocality.name object.location.name object.department.telephone.type object.telephone.type object.name object.location.addressRegion.name object.department.type object.type |
SearchAction<object@LocalBusiness>
User: what are the three best coffee shops in baltimore
Intent Schema:
{
"intents": [
{
"name": "AMAZON.SearchAction<object@LocalBusiness>"
}
]
}
Request:
{
"request": {
"type": "IntentRequest",
"locale": "en-US",
"intent": {
"name": "AMAZON.SearchAction<object@LocalBusiness>",
"slots": {
"object.aggregateRating": {
"name": "object.aggregateRating",
"value": "three best"
},
"object.type": {
"name": "object.type",
"value": "coffee shops"
},
"object.location.addressLocality.name": {
"name": "object.location.addressLocality.name",
"value": "baltimore"
}
}
}
}
}
SearchAction<object@LocalBusiness[openHours.closes]>
User: what time is smitten's ice cream shop open till
Intent Schema:
{
"intents": [
{
"name": "AMAZON.SearchAction<object@LocalBusiness[openHours.closes]>"
}
]
}
Request:
{
"request": {
"type": "IntentRequest",
"locale": "en-US",
"intent": {
"name": "AMAZON.SearchAction<object@LocalBusiness[openHours.closes]>",
"slots": {
"object.name": {
"name": "object.name",
"value": "smitten's ice cream shop"
}
}
}
}
}
SearchAction<object@LocalBusiness[openHours]>
User: what time does dunkin's open tomorrow
Intent Schema:
{
"intents": [
{
"name": "AMAZON.SearchAction<object@LocalBusiness[openHours]>"
}
]
}
Request:
{
"request": {
"type": "IntentRequest",
"locale": "en-US",
"intent": {
"name": "AMAZON.SearchAction<object@LocalBusiness[openHours]>",
"slots": {
"object.name": {
"name": "object.name",
"value": "dunkin's"
},
"object.openHours.opens": {
"name": "object.openHours.opens",
"value": "2016-11-22"
}
}
}
}
}
SearchAction<object@LocalBusiness[telephone]>
User: what is the phone number for ocean road school point pleasant new jersey
Intent Schema:
{
"intents": [
{
"name": "AMAZON.SearchAction<object@LocalBusiness[telephone]>"
}
]
}
Request:
{
"request": {
"type": "IntentRequest",
"locale": "en-US",
"intent": {
"name": "AMAZON.SearchAction<object@LocalBusiness[telephone]>",
"slots": {
"object.telephone.type": {
"name": "object.telephone.type",
"value": "phone number"
},
"object.name": {
"name": "object.name",
"value": "ocean road school"
},
"object.location.addressLocality.name": {
"name": "object.location.addressLocality.name",
"value": "point pleasant"
},
"object.location.addressRegion.name": {
"name": "object.location.addressRegion.name",
"value": "new jersey"
}
}
}
}
}
LocalBusiness Slots
The LocalBusiness
intents can return slot values to your skill. You do not include these slots in your intent schema – they are generated automatically from the intent signature.
Note that not all available slots are returned from every intent. See the table in LocalBusiness Intents to see which slots are applicable to each intent.
The following table shows the slots the LocalBusiness
intents can return. For each slot, the table includes:
- The slot name.
- An example utterance for the slot.
- The JSON that would be sent to your skill for the sample utterance.
- If applicable, the name of the slot type used by the slot. You can see details about slot types in the Slot Type Reference.
Slot Name | Utterance | Slot Values |
---|---|---|
|
"…what's the best" |
|
|
"…what is the phone number" |
|
|
"… for the pharmacy" |
|
|
"… house" |
|
|
"… in nags head" |
|
|
"… to florida" |
|
|
"… in new england" |
|
|
"… at mcdonald's" |
|
|
"… on mclaughlin" |
|
|
"… area" |
|
|
"… at twenty two paoli pike" |
|
|
"… walmart" |
|
|
"…when is todd's" |
|
|
"… close today" |
|
|
"…ten p. m." |
|
|
"… reopen on saturday" |
|
|
"…Sample Utterance Missing" | |
|
"…Sample Utterance Missing" | |
|
"… are playing near" |
|
|
"…what is the phone number" |
|
|
"…what's the driving time from boston" |
|
|
"… in in florida" |
|
|
"… to sullivan's steakhouse" |
|
|
"…what grocery stores" |
|
Built-in Intent Library Documentation
LocalBusiness
is used in the following built-in intent library category:
Navigate to all built-in intents in the Built-in Intent Library.
See all available slot types in the Slot Type Reference.
Learn more about using the built-in intent library:
- Understanding the Structure of the Built-in Intent Library
- Implementing the Built-in Intents
- Standard Built-in Intents
Learn more about building your voice interface:
- Choose the Invocation Name for a Custom Skill
- Create the Interaction Model for Your Skill
- Best Practices for Sample Utterances and Custom Slot Type Values
- Interaction Model Schema
- Alexa Design Guide
The built-in intent library incorporates material from Schema.org, which is licensed under the Creative Commons Attribution-ShareAlike License (version 3.0) (the "License"). You may not use this file except in compliance with the License. You may obtain a copy of the License at http://creativecommons.org/licenses/by-sa/3.0/. For questions, please contact us.
Last updated: Nov 28, 2023