com.amazon.speech.speechlet

Interface Speechlet

public interface Speechlet

A Speechlet is a speech-enabled web service that runs in the cloud. A Speechlet receives and responds to speech initiated requests.

The methods in the Speechlet interface define:

• life-cycle events for the skill as experienced by the user
• a way to service speech requests from the user
• call-backs from events happening on the device the user is interacting with

Because a Speechlet is a cloud-based service, the life-cycle of the actual object implementing the Speechlet interface is unrelated to the life-cycle of the Alexa skill as experienced by the user interacting with the speech enabled device. A single Speechlet object typically handles requests from many users, from many devices, for many sessions, using many concurrent threads. Also, multiple requests that are part of a single session coming from a single user and a single device may actually be serviced by different Speechlet objects if your service is deployed on multiple machines and load-balanced. The Session object is what defines a single run of a skill as experienced by a user.

See Also:

Session, SpeechletException

Method Summary

Modifier and Type	Method and Description
SpeechletResponse	onIntent(IntentRequest request, Session session) Entry point for handling speech initiated requests. This is where the bulk of the Speechlet logic lives.
SpeechletResponse	onLaunch(LaunchRequest request, Session session) Entry point for Speechlets for handling a speech initiated request to start the skill without providing an Intent. This method is only invoked when Session.isNew() is true.
void	onSessionEnded(SessionEndedRequest request, Session session) Callback used to notify that the session ended as a result of the user interacting, or not interacting with the device.
void	onSessionStarted(SessionStartedRequest request, Session session) Used to notify that a new session started as a result of a user interacting with the device.

Method Detail

onSessionStarted

void onSessionStarted(SessionStartedRequest request,
                      Session session)
               throws SpeechletException

Used to notify that a new session started as a result of a user interacting with the device. This method enables Speechlets to perform initialization logic and allows for session attributes to be stored for subsequent requests.

Parameters:

request - the session started request

session - the session associated with the user starting a Speechlet

Throws:

SpeechletException - for any errors encountered in the processing of the request

onLaunch

SpeechletResponse onLaunch(LaunchRequest request,
                           Session session)
                    throws SpeechletException

Entry point for Speechlets for handling a speech initiated request to start the skill without providing an Intent.
This method is only invoked when Session.isNew() is true.

Parameters:

request - the launch request

session - the session associated with the request

Returns:

the response, spoken and visual, to the request

Throws:

SpeechletException - for any errors encountered in the processing of the request

onIntent

SpeechletResponse onIntent(IntentRequest request,
                           Session session)
                    throws SpeechletException

Entry point for handling speech initiated requests.
This is where the bulk of the Speechlet logic lives. Intent requests are handled by this method and return responses to render to the user.
If this is the initial request of a new Speechlet session, Session.isNew() returns true. Otherwise, this is a subsequent request within an existing session.

Parameters:

request - the intent request to handle

session - the session associated with the request

Returns:

the response, spoken and visual, to the request

Throws:

SpeechletException - for any errors encountered in the processing of the request

onSessionEnded

void onSessionEnded(SessionEndedRequest request,
                    Session session)
             throws SpeechletException

Callback used to notify that the session ended as a result of the user interacting, or not interacting with the device. This method is not invoked if the Speechlet itself ended the session using SpeechletResponse.setShouldEndSession(boolean).

Parameters:

request - the end of session request

session - the session associated with the request

Throws:

SpeechletException - for any errors encountered in the processing of the request