CreativeWorkSection Intents

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

Introduction

A section or part of a creative work, such as a page or chapter. These intents let users specify a particular part of a book, movie, page, or other section.

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

{
    "intents": [
        {
            "name": "AMAZON.RestartAction<object@CreativeWorkSection>"
        }, 
        {
            "name": "AMAZON.CloseAction<object@CreativeWorkSection>"
        }
    ]
}

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 CreativeWorkSection intents can be used in English (US) skills. They are not available for English (UK) or German skills.

CreativeWorkSection Intents

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

Intent Signature	Example Utterance	Possible Slots
`AMAZON.CloseAction<object@CreativeWorkSection>`	"close that page"	`object.type`
`AMAZON.PlaybackAction<object@CreativeWorkSection>`	"reread previous three pages"	`object.type` `object.select`
`AMAZON.RestartAction<object@CreativeWorkSection>`	"can i start this chapter over again"	`object.type` `object.select` `object.sectionNumber`
`AMAZON.ResumeAction<object@CreativeWorkSection>`	"continue reading chapter four"	`object.type` `object.sectionNumber`
`AMAZON.SearchAction<object@CreativeWorkSection>`	"alexa what chapter am i on"	`object.type`
`AMAZON.SearchAction<object@CreativeWorkSection[name]>`	"what's the name of this chapter"	`object.type`
`AMAZON.StartAction<object@CreativeWorkSection>`	"start with the previous chapter"	`object.type` `object.select`
`AMAZON.SuspendAction<object@CreativeWorkSection>`	"pause this part"	`object.type`

CloseAction<object@CreativeWorkSection>

User: close that page

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.CloseAction<object@CreativeWorkSection>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.CloseAction<object@CreativeWorkSection>", 
            "slots": {
                "object.type": {
                    "name": "object.type", 
                    "value": "page"
                }
            }
        }
    }
}

PlaybackAction<object@CreativeWorkSection>

User: reread previous three pages

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.PlaybackAction<object@CreativeWorkSection>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.PlaybackAction<object@CreativeWorkSection>", 
            "slots": {
                "object.select": {
                    "name": "object.select", 
                    "value": "previous"
                }, 
                "object.type": {
                    "name": "object.type", 
                    "value": "pages"
                }
            }
        }
    }
}

RestartAction<object@CreativeWorkSection>

User: can i start this chapter over again

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.RestartAction<object@CreativeWorkSection>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.RestartAction<object@CreativeWorkSection>", 
            "slots": {
                "object.type": {
                    "name": "object.type", 
                    "value": "chapter"
                }
            }
        }
    }
}

ResumeAction<object@CreativeWorkSection>

User: continue reading chapter four

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.ResumeAction<object@CreativeWorkSection>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.ResumeAction<object@CreativeWorkSection>", 
            "slots": {
                "object.type": {
                    "name": "object.type", 
                    "value": "chapter"
                }, 
                "object.sectionNumber": {
                    "name": "object.sectionNumber", 
                    "value": "4"
                }
            }
        }
    }
}

SearchAction<object@CreativeWorkSection>

User: alexa what chapter am i on

Intent Schema:

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

Request:

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

SearchAction<object@CreativeWorkSection[name]>

User: what's the name of this chapter

Intent Schema:

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

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.SearchAction<object@CreativeWorkSection[name]>", 
            "slots": {
                "object.type": {
                    "name": "object.type", 
                    "value": "chapter"
                }
            }
        }
    }
}

StartAction<object@CreativeWorkSection>

User: start with the previous chapter

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.StartAction<object@CreativeWorkSection>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.StartAction<object@CreativeWorkSection>", 
            "slots": {
                "object.select": {
                    "name": "object.select", 
                    "value": "previous"
                }, 
                "object.type": {
                    "name": "object.type", 
                    "value": "chapter"
                }
            }
        }
    }
}

SuspendAction<object@CreativeWorkSection>

User: pause this part

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.SuspendAction<object@CreativeWorkSection>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.SuspendAction<object@CreativeWorkSection>", 
            "slots": {
                "object.type": {
                    "name": "object.type", 
                    "value": "part"
                }
            }
        }
    }
}

CreativeWorkSection Slots

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

The following table shows the slots the CreativeWorkSection 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.sectionNumber`	"… four"	`AMAZON.NUMBER` `{ "name": "object.sectionNumber", "value": "4" }`
`object.select`	"… next"	`{ "name": "object.select", "value": "next" }`
`object.type`	"…pause this part"	`{ "name": "object.type", "value": "part" }`

Built-in Intent Library Documentation

CreativeWorkSection is used in the following built-in intent library categories:

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