BookSeries Intents

Introduction

A named series of books, such as "The Lord of the Rings." These intents let users take actions on a book series, such as adding the books in the series to a reading list.

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

{
    "intents": [
        {
            "name": "AMAZON.AddAction<object@BookSeries,targetCollection@ReadingList>"
        }, 
        {
            "name": "AMAZON.DeleteAction<object@BookSeries,sourceCollection@ReadingList>"
        }
    ]
}

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.

BookSeries Intents

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

Intent Signature Example Utterance Possible Slots
AMAZON.AddAction<object@BookSeries,targetCollection@ReadingList> "add the ayn rand collection to my reading list" targetCollection.owner.name
object.name
object.author.name
targetCollection.type
AMAZON.DeleteAction<object@BookSeries,sourceCollection@ReadingList> "delete the harry potter series from my reading list" object.type
object.name
sourceCollection.owner.name
sourceCollection.type

AddAction<object@BookSeries,targetCollection@ReadingList>

User: add the ayn rand collection to my reading list

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.AddAction<object@BookSeries,targetCollection@ReadingList>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.AddAction<object@BookSeries,targetCollection@ReadingList>", 
            "slots": {
                "object.author.name": {
                    "name": "object.author.name", 
                    "value": "ayn rand"
                }, 
                "object.name": {
                    "name": "object.name", 
                    "value": "collection"
                }, 
                "targetCollection.owner.name": {
                    "name": "targetCollection.owner.name", 
                    "value": "my"
                }, 
                "targetCollection.type": {
                    "name": "targetCollection.type", 
                    "value": "reading list"
                }
            }
        }
    }
}

DeleteAction<object@BookSeries,sourceCollection@ReadingList>

User: delete the harry potter series from my reading list

Intent Schema:

{
    "intents": [
        {
            "name": "AMAZON.DeleteAction<object@BookSeries,sourceCollection@ReadingList>"
        }
    ]
}

Request:

{
    "request": {
        "type": "IntentRequest", 
        "locale": "en-US", 
        "intent": {
            "name": "AMAZON.DeleteAction<object@BookSeries,sourceCollection@ReadingList>", 
            "slots": {
                "object.name": {
                    "name": "object.name", 
                    "value": "harry potter"
                }, 
                "object.type": {
                    "name": "object.type", 
                    "value": "series"
                }, 
                "sourceCollection.owner.name": {
                    "name": "sourceCollection.owner.name", 
                    "value": "my"
                }, 
                "sourceCollection.type": {
                    "name": "sourceCollection.type", 
                    "value": "reading list"
                }
            }
        }
    }
}

BookSeries Slots

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

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

"…search for nick offerman's"

AMAZON.Person

{
    "name": "object.author.name", 
    "value": "nick offerman's"
}

object.name

"…delete the harry potter"

AMAZON.BookSeries

{
    "name": "object.name", 
    "value": "harry potter"
}

object.type

"… series"

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

sourceCollection.owner.name

"…take my"

AMAZON.Person

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

sourceCollection.type

"… reading list"

 
{
    "name": "sourceCollection.type", 
    "value": "reading list"
}

targetCollection.owner.name

"…add to my"

AMAZON.Person

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

targetCollection.type

"… reading list"

 
{
    "name": "targetCollection.type", 
    "value": "reading list"
}

Built-in Intent Library Documentation

BookSeries 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