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

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 complete IntentRequest.

    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

object.aggregateRating

"…what's the best"

AMAZON.AggregateRating

{
    "name": "object.aggregateRating", 
    "value": "best"
}

object.department.telephone.type

"…what is the phone number"

 
{
    "name": "object.department.telephone.type", 
    "value": "phone number"
}

object.department.type

"… for the pharmacy"

 
{
    "name": "object.department.type", 
    "value": "pharmacy"
}

object.fromLocation.type

"… house"

AMAZON.LocalBusinessType

{
    "name": "object.fromLocation.type", 
    "value": "house"
}

object.location.addressLocality.name

"… in nags head"

AMAZON.US_CITY

{
    "name": "object.location.addressLocality.name", 
    "value": "nags head"
}

object.location.addressRegion.name

"… to florida"

AMAZON.US_STATE

{
    "name": "object.location.addressRegion.name", 
    "value": "florida"
}

object.location.name

"… in new england"

AMAZON.AdministrativeArea

{
    "name": "object.location.name", 
    "value": "new england"
}

object.location.name

"… at mcdonald's"

 
{
    "name": "object.location.name", 
    "value": "mcdonald's"
}

object.location.streetAddress.name

"… on mclaughlin"

AMAZON.StreetName

{
    "name": "object.location.streetAddress.name", 
    "value": "mclaughlin"
}

object.location.type

"… area"

 
{
    "name": "object.location.type", 
    "value": "area"
}

object.location.type

"… at twenty two paoli pike"

 
{
    "name": "object.location.type", 
    "value": "twenty two paoli pike"
}

object.name

"… walmart"

AMAZON.LocalBusiness

{
    "name": "object.name", 
    "value": "walmart"
}

object.name

"…when is todd's"

AMAZON.Person

{
    "name": "object.name", 
    "value": "todd's"
}

object.openHours.closes

"… close today"

AMAZON.DATE

{
    "name": "object.openHours.closes", 
    "value": "2016-11-21"
}

object.openHours.closes

"…ten p. m."

AMAZON.TIME

{
    "name": "object.openHours.closes", 
    "value": "22:00"
}

object.openHours.opens

"… reopen on saturday"

AMAZON.DATE

{
    "name": "object.openHours.opens", 
    "value": "2016-11-26"
}

object.openHours.opens

"…Sample Utterance Missing"

AMAZON.TIME

object.openHours.type

"…Sample Utterance Missing"

object.spatialRelation

"… are playing near"

 
{
    "name": "object.spatialRelation", 
    "value": "near"
}

object.telephone.type

"…what is the phone number"

 
{
    "name": "object.telephone.type", 
    "value": "phone number"
}

object.toLocation.addressLocality.name

"…what's the driving time from boston"

AMAZON.US_CITY

{
    "name": "object.toLocation.addressLocality.name", 
    "value": "boston"
}

object.toLocation.addressRegion.name

"… in in florida"

AMAZON.US_STATE

{
    "name": "object.toLocation.addressRegion.name", 
    "value": "florida"
}

object.toLocation.name

"… to sullivan's steakhouse"

AMAZON.LocalBusiness

{
    "name": "object.toLocation.name", 
    "value": "sullivan's steakhouse"
}

object.type

"…what grocery stores"

AMAZON.LocalBusinessType

{
    "name": "object.type", 
    "value": "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:

Learn more about building your voice interface:

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.

Was this page helpful?

Last updated: Nov 28, 2023