Dialogflow
The dialogflow
integration is designed to be used with the webhook integration of Dialogflow. When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook.
To be able to receive messages from Dialogflow, your Open Peer Power instance needs to be accessible from the web and you need to have the base_url
configured for the HTTP integration (documentation). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds).
Dialogflow could be integrated with many popular messaging, virtual assistant and IoT platforms.
Using Dialogflow will be easy to create conversations like:
User: What is the temperature at home?
Bot: The temperature is 34 degrees
User: Turn on the light
Bot: In which room?
User: In the kitchen
Bot: Turning on kitchen light
To use this integration, you should define a conversation (intent) in Dialogflow, configure Open Peer Power with the speech to return and, optionally, the action to execute.
Configuring your Dialogflow account
To get the webhook URL, go to the integrations page in the configuration screen and find “Dialogflow”. Click on “configure”. Follow the instructions on the screen.
- Login with your Google account
- Click on “Create Agent”
- Select name, language (if you are planning to use Google Actions check their supported languages) and time zone
- Click “Save”
- Now go to “Fulfillment” (in the left menu)
- Enable Webhook and set your Dialogflow webhook URL as the endpoint, e.g.,
https://myhome.duckdns.org/api/webhook/800b4cb4d27d078a8871656a90854a292651b20635685f8ea23ddb7a09e8b417
- Click “Save”
- Create a new intent
- Below “User says” write one phrase that you, the user, will tell Dialogflow, e.g.,
What is the temperature at home?
- In “Action” set some key (this will be the bind with Open Peer Power configuration), e.g.,: GetTemperature
- In “Response” set “Cannot connect to Open Peer Power or it is taking to long” (fall back response)
- At the end of the page, click on “Fulfillment” and check “Use webhook”
- Click “Save”
- On the top right, where is written “Try it now…”, write, or say, the phrase you have previously defined and hit enter
- Dialogflow has send a request to your Open Peer Power server
Take a look to “Integrations”, in the left menu, to configure third parties.
Configuring Open Peer Power
When activated, the alexa
integration will have Open Peer Power’s native intent support handle the incoming intents. If you want to run actions based on intents, use the intent_script
integration.
Examples
Download this zip and load it in your Dialogflow agent (Settings -> Export and Import) for examples intents to use with this configuration:
# Example configuration.yaml entry
dialogflow:
intent_script:
Temperature:
speech:
text: The temperature at home is {{ states('sensor.home_temp') }} degrees
LocateIntent:
speech:
text: >
{%- for state in states.device_tracker -%}
{%- if state.name.lower() == User.lower() -%}
{{ state.name }} is at {{ state.state }}
{%- elif loop.last -%}
I am sorry, I do not know where {{ User }} is.
{%- endif -%}
{%- else -%}
Sorry, I don't have any trackers registered.
{%- endfor -%}
WhereAreWeIntent:
speech:
text: >
{%- if is_state('device_tracker.adri', 'home') and
is_state('device_tracker.bea', 'home') -%}
You are both home, you silly
{%- else -%}
Bea is at {{ states("device_tracker.bea") }}
and Adri is at {{ states("device_tracker.adri") }}
{% endif %}
TurnLights:
speech:
text: Turning {{ Room }} lights {{ OnOff }}
action:
- service: notify.pushbullet
data_template:
message: Someone asked via apiai to turn {{ Room }} lights {{ OnOff }}
- service_template: >
{%- if OnOff == "on" -%}
switch.turn_on
{%- else -%}
switch.turn_off
{%- endif -%}
data_template:
entity_id: "switch.light_{{ Room | replace(' ', '_') }}"