VideoPlaylist Intents

Introduction

A collection of video creative works, such as a list of shows to watch. These intents let users make requests to manipulate video playlists by adding, removing, and choosing items.

This document provides a quick reference to the VideoPlaylist 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 VideoPlaylist intents:

{
    "intents": [
        {
            "name": "AMAZON.ChooseAction<object@VideoCreativeWork,sourceCollection@VideoPlaylist>"
        }, 
        {
            "name": "AMAZON.SearchAction<object@VideoCreativeWork,sourceCollection@VideoPlaylist>"
        }
    ]
}

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.

VideoPlaylist Intents

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

Intent Signature Example Utterance Possible Slots
AMAZON.ChooseAction<object@VideoCreativeWork,sourceCollection@VideoPlaylist> "pick the second movie on this list" sourceCollection
sourceCollection.type
object.name
object.select
AMAZON.ExitAction<object@VideoPlaylist> "exit this video list" object.type
object.name
AMAZON.SearchAction<object@VideoCreativeWork,sourceCollection@VideoPlaylist> "search for star trek movies on my favorites list" object.type
object.name
sourceCollection.owner.name
sourceCollection.name

ChooseAction<object@VideoCreativeWork,sourceCollection@VideoPlaylist>

User: pick the second movie on this list

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.ChooseAction<object@VideoCreativeWork,sourceCollection@VideoPlaylist>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.ChooseAction<object@VideoCreativeWork,sourceCollection@VideoPlaylist>", 
            "slots": {
                "object.select": {
                    "name": "object.select", 
                    "value": "second"
                }, 
                "sourceCollection": {
                    "name": "sourceCollection", 
                    "value": "list"
                }
            }
        }
    }
}

ExitAction<object@VideoPlaylist>

User: exit this video list

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.ExitAction<object@VideoPlaylist>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.ExitAction<object@VideoPlaylist>", 
            "slots": {
                "object.name": {
                    "name": "object.name", 
                    "value": "video list"
                }
            }
        }
    }
}

SearchAction<object@VideoCreativeWork,sourceCollection@VideoPlaylist>

User: search for star trek movies on my favorites list

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.SearchAction<object@VideoCreativeWork,sourceCollection@VideoPlaylist>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.SearchAction<object@VideoCreativeWork,sourceCollection@VideoPlaylist>", 
            "slots": {
                "object.name": {
                    "name": "object.name", 
                    "value": "star trek"
                }, 
                "object.type": {
                    "name": "object.type", 
                    "value": "movies"
                }, 
                "sourceCollection.owner.name": {
                    "name": "sourceCollection.owner.name", 
                    "value": "my"
                }, 
                "sourceCollection.name": {
                    "name": "sourceCollection.name", 
                    "value": "favorites list"
                }
            }
        }
    }
}

VideoPlaylist Slots

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

The following table shows the slots the VideoPlaylist 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.name

"…stop playing the videos"

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

object.name

"…exit this video list"

 
{
    "name": "object.name", 
    "value": "video list"
}

object.select

"… next"

 
{
    "name": "object.select", 
    "value": "next"
}

object.type

"… movie"

 
{
    "name": "object.type", 
    "value": "movie"
}

object.type

"…exit movie list"

 
{
    "name": "object.type", 
    "value": "movie list"
}

sourceCollection.name

"… favorites list"

 
{
    "name": "sourceCollection.name", 
    "value": "favorites list"
}

sourceCollection.owner.name

"…take my"

AMAZON.Person

{
    "name": "sourceCollection.owner.name", 
    "value": "my"
}

sourceCollection.type

"… from the shows i watch"

 
{
    "name": "sourceCollection.type", 
    "value": "shows i watch"
}

sourceCollection

"… movie on this list"

 
{
    "name": "sourceCollection", 
    "value": "list"
}

Built-in Intent Library Documentation

VideoPlaylist 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