A collection of functions for building responses expected by the Alexa Skills Kit.

Usage

alias AlexaPlug.Response

Example

To create a response:

response = Response.new
|> Response.add_session_attributes(%{"user" => "test"})
|> Response.add_output_speech("PlainText", "Hello!")
|> Response.add_card("Simple", "Title", "Content")
|> Response.add_reprompt("PlainText", "Can I help with anything else?")
|> Response.add_should_not_end_session

and the following response map is created:

%{
  "version" => "1.0",
  "sessionAttributes" => %{"user" => "test"},
  "response" => %{
    "outputSpeech" => %{
      "type" => "PlainText",
      "text" => "Can I help with anything else?"
    },
    "card": %{
      "type" => "Simple",
      "title" => "Title",
      "content" => "Content"
    },
    "reprompt" => %{
      "outputSpeech" => %{
        "type" => "PlainText",
        "text" => "Can I help with anything else?"
      }
    },
    "shouldEndSession" => false
  }
}

The same response can be built using convenience methods as follows:

response = Response.new
|> Response.add_session_attributes(%{"user" => "test"})
|> Response.add_plain_text_output_speech("Hello!")
|> Response.add_simple_card("Title", "Content")
|> Response.add_plain_text_reprompt("Can I help with anything else?")
|> Response.add_should_not_end_session