Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.alexa.intent Namespace Reference

Classes

class  AlexaIntentResponse
 
class  AlexaIntentsView
 
class  CardType
 
class  SpeechType
 
class  UnknownRequest
 

Functions

dict[str, Any] async_handle_intent (HomeAssistant hass, dict[str, Any] message)
 
dict[str, Any] async_handle_message (HomeAssistant hass, dict[str, Any] message)
 
None async_setup (HomeAssistant hass)
 
None async_setup_intents (HomeAssistant hass)
 
dict[str, Any] intent_error_response (HomeAssistant hass, dict[str, Any] message, str error)
 
dict[str, str] resolve_slot_data (str key, dict[str, Any] request)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string INTENTS_API_ENDPOINT = "/api/alexa"
 
dictionary SPEECH_MAPPINGS = {"plain": SpeechType.plaintext, "ssml": SpeechType.ssml}
 

Detailed Description

Support for Alexa skill service end point.

Function Documentation

◆ async_handle_intent()

dict[str, Any] homeassistant.components.alexa.intent.async_handle_intent ( HomeAssistant  hass,
dict[str, Any]   message 
)
Handle an intent request.

Raises:
 - intent.UnknownIntent
 - intent.InvalidSlotInfo
 - intent.IntentError

Definition at line 141 of file intent.py.

◆ async_handle_message()

dict[str, Any] homeassistant.components.alexa.intent.async_handle_message ( HomeAssistant  hass,
dict[str, Any]   message 
)
Handle an Alexa intent.

Raises:
 - UnknownRequest
 - intent.UnknownIntent
 - intent.InvalidSlotInfo
 - intent.IntentError

Definition at line 117 of file intent.py.

◆ async_setup()

None homeassistant.components.alexa.intent.async_setup ( HomeAssistant  hass)
Activate Alexa component.

Definition at line 45 of file intent.py.

◆ async_setup_intents()

None homeassistant.components.alexa.intent.async_setup_intents ( HomeAssistant  hass)
Do intents setup.

Right now this module does not expose any, but the intent component breaks
without it.

Definition at line 50 of file intent.py.

◆ intent_error_response()

dict[str, Any] homeassistant.components.alexa.intent.intent_error_response ( HomeAssistant  hass,
dict[str, Any]  message,
str   error 
)
Return an Alexa response that will speak the error message.

Definition at line 107 of file intent.py.

◆ resolve_slot_data()

dict[str, str] homeassistant.components.alexa.intent.resolve_slot_data ( str  key,
dict[str, Any]  request 
)
Check slot request for synonym resolutions.

Definition at line 195 of file intent.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.alexa.intent._LOGGER = logging.getLogger(__name__)
private

Definition at line 18 of file intent.py.

◆ INTENTS_API_ENDPOINT

string homeassistant.components.alexa.intent.INTENTS_API_ENDPOINT = "/api/alexa"

Definition at line 24 of file intent.py.

◆ SPEECH_MAPPINGS

dictionary homeassistant.components.alexa.intent.SPEECH_MAPPINGS = {"plain": SpeechType.plaintext, "ssml": SpeechType.ssml}

Definition at line 34 of file intent.py.