jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/conversation/index.html
Travis CI 779c204a2c Site updated at 2018-03-09 18:51:31 UTC
2018-03-09 18:51:31 +00:00

239 lines
14 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Conversation - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to have conversations with your Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/conversation/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Conversation">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/conversation/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to have conversations with your Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="Conversation">
<meta name="twitter:description" content="Instructions how to have conversations with your Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection, print" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header class='site-header'>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href="/getting-started/">Getting started</a></li>
<li><a href="/components/">Components</a></li>
<li><a href="/docs/">Docs</a></li>
<li><a href="/cookbook/">Examples</a></li>
<li><a href="/developers/">Developers</a></li>
<li><a href="/blog/">Blog</a></li>
<li><a href="/help/">Need help?</a></li>
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
</ul>
</nav>
<div class='search-container' style='display: none'>
<div class='search'>
<i class="icon-search"></i>
<input id='search' placeholder='Search the docs…'>
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
</div>
</div>
</div>
</div>
</div>
</header>
<div class="grid-wrapper">
<div class="grid grid-center">
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
<article class="page">
<header>
<h1 class="title indent">
Conversation
</h1>
</header>
<hr class="divider">
<p>The conversation component allows you to converse with Home Assistant. You can either converse by pressing the microphone in the frontend (supported browsers only (no iOS)) or by calling the <code class="highlighter-rouge">conversation/process</code> service with the transcribed text.</p>
<p class="img">
<img src="/images/screenshots/voice-commands.png" />
Screenshot of the conversation interface in Home Assistant.
</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example base configuration.yaml entry</span>
<span class="s">conversation</span><span class="pi">:</span>
</code></pre>
</div>
<div class="config-vars">
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
<dl class="">
<dt><a class="title-link" name="intents" href="#intents"></a> intents</dt>
<dd>
<p class="desc"><span class="type">(<span class="map">map</span>)</span><span class="required">(Optional)</span><span class="description">Intents that the conversation component should understand.</span></p>
</dd>
<dd>
<dl class="nested">
<dt><a class="title-link" name="intent-name" href="#intent-name"></a> <code class="highlighter-rouge">&lt;INTENT NAME&gt;</code></dt>
<dd>
<p class="desc"><span class="type">(<span class="list">list</span>)</span><span class="required">(Required)</span><span class="description">Sentences that should trigger this intent.</span></p>
</dd>
</dl>
</dd>
</dl>
</div>
<h2><a class="title-link" name="adding-custom-sentences" href="#adding-custom-sentences"></a> Adding custom sentences</h2>
<p>By default, it will support turning devices on and off. You can say things like “turn on kitchen lights” or “turn the living room lights off”. You can also configure your own sentences to be processed. This works by mapping sentences to intents and then configure the <a href="/components/intent_script/">intent script component</a> to handle these intents.</p>
<p>Here is a simple example to be able to ask what the temperature in the living room is.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">conversation</span><span class="pi">:</span>
<span class="s">intents</span><span class="pi">:</span>
<span class="s">LivingRoomTemperature</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">What is the temperature in the living room</span>
<span class="s">intent_script</span><span class="pi">:</span>
<span class="s">LivingRoomTemperature</span><span class="pi">:</span>
<span class="s">speech</span><span class="pi">:</span>
<span class="s">text</span><span class="pi">:</span> <span class="s">It is currently {{ states.sensor.temperature }} degrees in the living room.</span>
</code></pre>
</div>
<h2><a class="title-link" name="adding-advanced-custom-sentences" href="#adding-advanced-custom-sentences"></a> Adding advanced custom sentences</h2>
<p>Sentences can contain slots (marked with curly braces: <code class="highlighter-rouge"><span class="p">{</span><span class="err">name</span><span class="p">}</span></code>) and optional words (marked with square brackets: <code class="highlighter-rouge">[the]</code>). The values of slots will be passed on to the intent and are available inside the templates.</p>
<p>The following configuration can handle the following sentences:</p>
<ul>
<li>Change the lights to red</li>
<li>Change the lights to green</li>
<li>Change the lights to blue</li>
<li>Change the lights to the color red</li>
<li>Change the lights to the color green</li>
<li>Change the lights to the color blue</li>
</ul>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">conversation</span><span class="pi">:</span>
<span class="s">intents</span><span class="pi">:</span>
<span class="s">ColorLight</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">Change the lights to [the color] {color}</span>
<span class="s">intent_script</span><span class="pi">:</span>
<span class="s">ColorLight</span><span class="pi">:</span>
<span class="s">speech</span><span class="pi">:</span>
<span class="s">text</span><span class="pi">:</span> <span class="s">Changed the lights to {{ color }}.</span>
<span class="s">action</span><span class="pi">:</span>
<span class="s">service</span><span class="pi">:</span> <span class="s">light.turn_on</span>
<span class="s">data_template</span><span class="pi">:</span>
<span class="s">rgb_color</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s2">"</span><span class="s">{%</span><span class="nv"> </span><span class="s">if</span><span class="nv"> </span><span class="s">color</span><span class="nv"> </span><span class="s">==</span><span class="nv"> </span><span class="s">'red'</span><span class="nv"> </span><span class="s">%}255{%</span><span class="nv"> </span><span class="s">else</span><span class="nv"> </span><span class="s">%}0{%</span><span class="nv"> </span><span class="s">endif</span><span class="nv"> </span><span class="s">%}"</span>
<span class="pi">-</span> <span class="s2">"</span><span class="s">{%</span><span class="nv"> </span><span class="s">if</span><span class="nv"> </span><span class="s">color</span><span class="nv"> </span><span class="s">==</span><span class="nv"> </span><span class="s">'green'</span><span class="nv"> </span><span class="s">%}255{%</span><span class="nv"> </span><span class="s">else</span><span class="nv"> </span><span class="s">%}0{%</span><span class="nv"> </span><span class="s">endif</span><span class="nv"> </span><span class="s">%}"</span>
<span class="pi">-</span> <span class="s2">"</span><span class="s">{%</span><span class="nv"> </span><span class="s">if</span><span class="nv"> </span><span class="s">color</span><span class="nv"> </span><span class="s">==</span><span class="nv"> </span><span class="s">'blue'</span><span class="nv"> </span><span class="s">%}255{%</span><span class="nv"> </span><span class="s">else</span><span class="nv"> </span><span class="s">%}0{%</span><span class="nv"> </span><span class="s">endif</span><span class="nv"> </span><span class="s">%}"</span>
</code></pre>
</div>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/conversation.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/home-assistant.png' />
</div>
<div class='section'>
<h1 class="title delta">Category Voice</h1>
<ul class='divided'>
<li>
<a href='/components/alexa/'>Alexa / Amazon Echo</a>
</li>
<li>
Conversation
</li>
<li>
<a href='/components/dialogflow/'>Dialogflow</a>
</li>
<li>
<a href='/components/google_assistant/'>Google Assistant</a>
</li>
<li>
<a href='/components/cloud/'>Home Assistant Cloud</a>
</li>
<li>
<a href='/components/homekit/'>HomeKit</a>
</li>
<li>
<a href='/components/mycroft/'>Mycroft</a>
</li>
<li>
<a href='/components/snips/'>Snips</a>
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
</div>
</div>
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
<script type="text/javascript">
docsearch({
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
indexName: 'home-assistant',
inputSelector: '#search',
debug: false // Set debug to true if you want to inspect the dropdown
});
document.querySelector('.search .close').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'none';
});
document.querySelector('.show-search').addEventListener('click', function(ev) {
ev.preventDefault();
document.querySelector('.search-container').style.display = 'block';
document.getElementById('toggle').checked = false;
document.querySelector('.search-container input').focus();
});
</script>
</body>
</html>
Reference in a new issue View git blame Copy permalink