ScreeningEvent Intents

Note: Sign in to the developer console to build or publish your skill.

Introduction

A screening of a movie or other video. These intents let users make requests related to particular screening events, such as asking for the show time for an event, asking what movies are playing, and asking what movie theaters are playing a particular movie.

This document provides a quick reference to the ScreeningEvent intents and corresponding slots. For details around how these intents are specified, see Understanding the Structure of the Built-in Intent Library.

Note: This functionality is offered as a developer preview and may improve and change as we receive feedback and iterate on the feature.

Intent Signature

Use the intent signature as the intent name in your intent schema. This example shows a schema with two ScreeningEvent intents:

{
    "intents": [
        {
            "name": "AMAZON.ChooseAction<object@ScreeningEvent[location]>"
        }, 
        {
            "name": "AMAZON.SearchAction<object@ScreeningEvent[location]>"
        }
    ]
}

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.

Note: The ScreeningEvent intents can be used in English (US) skills. They are not available for English (UK) or German skills.

ScreeningEvent Intents

The following table summarizes the available ScreeningEvent 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 ScreeningEvent Slots.

Intent Signature	Example Utterance	Possible Slots
`AMAZON.ChooseAction<object@ScreeningEvent[location]>`	"choose the one that's showing in arlington"	`object.location.name`
`AMAZON.ChooseAction<object@ScreeningEvent[workPresented]>`	"choose the movie that's nearest to me"	`object.spatialRelation` `object.workPresented.name` `object.location.name` `object.select` `object.location.type` `object.startDate` `object.type` `object.startTime` `object.workPresented.character.name` `object.workPresented.type`
`AMAZON.SearchAction<object@ScreeningEvent>`	"what 's playing at the movies"	`object.spatialRelation` `object.workPresented.name` `object.location.name` `object.endTime` `object.location.type` `object.startDate` `object.type` `object.startTime` `object.workPresented.type`
`AMAZON.SearchAction<object@ScreeningEvent[location]>`	"what movie theaters will show spectre this weekend"	`object.spatialRelation` `object.workPresented.name` `object.location.name` `object.location.type` `object.startDate` `object.workPresented` `object.workPresented.type`

ChooseAction<object@ScreeningEvent[location]>

User: choose the one that's showing in arlington

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.ChooseAction<object@ScreeningEvent[location]>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.ChooseAction<object@ScreeningEvent[location]>", 
            "slots": {
                "object.location.name": {
                    "name": "object.location.name", 
                    "value": "arlington"
                }
            }
        }
    }
}

ChooseAction<object@ScreeningEvent[workPresented]>

User: choose the movie that's nearest to me

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.ChooseAction<object@ScreeningEvent[workPresented]>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.ChooseAction<object@ScreeningEvent[workPresented]>", 
            "slots": {
                "object.workPresented.type": {
                    "name": "object.workPresented.type", 
                    "value": "movie"
                }, 
                "object.spatialRelation": {
                    "name": "object.spatialRelation", 
                    "value": "nearest"
                }
            }
        }
    }
}

SearchAction<object@ScreeningEvent>

User: what 's playing at the movies

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.SearchAction<object@ScreeningEvent>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.SearchAction<object@ScreeningEvent>", 
            "slots": {
                "object.location.type": {
                    "name": "object.location.type", 
                    "value": "movies"
                }
            }
        }
    }
}

SearchAction<object@ScreeningEvent[location]>

User: what movie theaters will show spectre this weekend

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.SearchAction<object@ScreeningEvent[location]>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.SearchAction<object@ScreeningEvent[location]>", 
            "slots": {
                "object.location.type": {
                    "name": "object.location.type", 
                    "value": "movie theaters"
                }, 
                "object.workPresented.name": {
                    "name": "object.workPresented.name", 
                    "value": "spectre"
                }, 
                "object.startDate": {
                    "name": "object.startDate", 
                    "value": "2016-W47-WE"
                }
            }
        }
    }
}

ScreeningEvent Slots

The ScreeningEvent 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 ScreeningEvent Intents to see which slots are applicable to each intent.

The following table shows the slots the ScreeningEvent 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.endTime`	"… and ten p. m."	`AMAZON.TIME` `{ "name": "object.endTime", "value": "22:00" }`
`object.location.name`	"…what's playing at the greenville"	`AMAZON.US_CITY` `{ "name": "object.location.name", "value": "greenville" }`
`object.location.name`	"… playing at cinemark"	`AMAZON.MovieTheater` `{ "name": "object.location.name", "value": "cinemark" }`
`object.location.name`	"… at mcdonald's"	`{ "name": "object.location.name", "value": "mcdonald's" }`
`object.location.name`	"… michigan"	`AMAZON.US_STATE` `{ "name": "object.location.name", "value": "michigan" }`
`object.location.type`	"… theater"	`{ "name": "object.location.type", "value": "theater" }`
`object.select`	"… next"	`{ "name": "object.select", "value": "next" }`
`object.spatialRelation`	"… are playing near"	`{ "name": "object.spatialRelation", "value": "near" }`
`object.startDate`	"…what's on may first"	`AMAZON.DATE` `{ "name": "object.startDate", "value": "2017-05-01" }`
`object.startTime`	"… nine o'clock"	`AMAZON.TIME` `{ "name": "object.startTime", "value": "09:00" }`
`object.type`	"…what is the movie schedule"	`{ "name": "object.type", "value": "movie schedule" }`
`object.workPresented.character.name`	"…select the captain america"	`AMAZON.FictionalCharacter` `{ "name": "object.workPresented.character.name", "value": "captain america" }`
`object.workPresented.name`	"…when is finding dory"	`{ "name": "object.workPresented.name", "value": "finding dory" }`
`object.workPresented.type`	"…what movie"	`{ "name": "object.workPresented.type", "value": "movie" }`
`object.workPresented`	"…where is the movie"	`{ "name": "object.workPresented", "value": "movie" }`

Built-in Intent Library Documentation

ScreeningEvent is used in the following built-in intent library category:

Cinema Showtimes

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?

Provide feedback

Last updated: Nov 28, 2023