forked from OHF-Voice/intents
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathintents.yaml
More file actions
2405 lines (2074 loc) · 69.3 KB
/
intents.yaml
File metadata and controls
2405 lines (2074 loc) · 69.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
# Available intents and slot combinations.
# Format:
#
# <intent name>:
# supported: true if the intent is supported in Home Assistant.
# domain: entity domain that this intent applies to.
# description: "Description of the intent"
# slots:
# <slot name>:
# description: "Description of slot"
# required: true if slot is required by intent
# slot_combinations:
# <slot combination name>:
# importance: "required" (bare minimum),
# "usable" (expected by users),
# "complete" (needed for 100% coverage),
# "optional" (extra, not needed for 100% coverage)
# slots: [], list of slot names that are required.
# example: "English example of voice command"
# context_area: true if the area of the voice satellite is required.
# inferred_domain: "<domain>", domain inferred by sentence like "cover" for "open the windows".
# name_domains: [], list of domain names for entities matching {name}.
# wildcard_slots: [], list of slot names that must be wildcards
# -----------------------------------------------------------------------------
# homeassistant
# -----------------------------------------------------------------------------
HassTurnOn:
supported: true
domain: homeassistant
description: "Turns on a device or entity"
slots:
name:
description: "Name of a device or entity"
required: false
area:
description: "Name of an area"
required: false
floor:
description: "Name of a floor"
required: false
domain:
description: "Domain of devices/entities in an area"
required: false
device_class:
description: "Device class of devices/entities in an area"
required: false
slot_combinations:
# -------------------------------------------------------------------------
# Required slot combinations
# -------------------------------------------------------------------------
domain_only:
description: "Turns on devices by domain in the voice satellite's area"
slots:
- "domain"
context_area: true
inferred_domains:
required:
- "light"
optional:
- "fan"
example:
- "turn on the lights in here"
- "turn on the fans"
# -------------------------------------------------------------------------
name_only:
description: "Turns on a device or opens a cover by name"
slots:
- "name"
name_domains:
required:
- "light"
- "switch"
- "fan"
- "media_player"
- "input_boolean"
- "cover"
complete:
- "lock"
optional:
- "valve"
example:
- "turn on the overhead light"
- "open sliding door"
# -------------------------------------------------------------------------
area_domain:
description: "Turns on devices by domain in an area"
slots:
- "area"
- "domain"
inferred_domains:
required:
- "light"
optional:
- "fan"
example: "turn on the lights in the kitchen"
# -------------------------------------------------------------------------
# Optional slot combinations
# -------------------------------------------------------------------------
device_class_cover:
description: "Opens the covers in the voice satellite's area by device class"
slots:
- "domain"
- "device_class"
context_area: true
inferred_domains:
complete:
- "cover"
example: "open the windows in here"
# -------------------------------------------------------------------------
name_area:
description: "Turns on a device or opens a cover in an area by name"
slots:
- "name"
- "area"
name_domains:
complete:
- "light"
- "switch"
- "fan"
- "media_player"
- "input_boolean"
- "cover"
- "lock"
- "valve"
example:
- "turn on the overhead light in the kitchen"
- "open the sliding door in the kitchen"
# -------------------------------------------------------------------------
name_floor:
description: "Turns on a device or opens a cover on a floor by name"
slots:
- "name"
- "floor"
name_domains:
optional:
- "light"
- "switch"
- "fan"
- "media_player"
- "input_boolean"
- "cover"
- "valve"
example:
- "turn on the overhead light on the first floor"
- "open the sliding door on the first floor"
# -------------------------------------------------------------------------
name_script:
description: "Run a script by name"
slots:
- "name"
name_domains:
complete:
- "script"
example: "run party time script"
# -------------------------------------------------------------------------
name_scene:
description: "Activate a scene by name"
slots:
- "name"
name_domains:
complete:
- "scene"
example: "activate mood lighting scene"
# -------------------------------------------------------------------------
area_device_class_cover:
description: "Opens the covers in an area by device class"
slots:
- "area"
- "domain"
- "device_class"
inferred_domains:
complete:
- "cover"
example: "open the curtains in the living room"
# -------------------------------------------------------------------------
floor_device_class_cover:
description: "Opens all the covers on a floor by device class"
slots:
- "floor"
- "domain"
- "device_class"
inferred_domains:
optional:
- "cover"
example: "open the curtains on the first floor"
# -----------------------------------------------------------------------------
HassTurnOff:
supported: true
domain: homeassistant
description: "Turns off a device or entity"
slots:
name:
description: "Name of a device or entity"
required: false
area:
description: "Name of an area"
required: false
floor:
description: "Name of a floor"
required: false
domain:
description: "Domain of devices/entities in an area"
required: false
device_class:
description: "Device class of devices/entities in an area"
required: false
slot_combinations:
# -------------------------------------------------------------------------
# Required slot combinations
# -------------------------------------------------------------------------
domain_only:
description: "Turns off devices by domain in the voice satellite's area"
slots:
- "domain"
context_area: true
inferred_domains:
required:
- "light"
optional:
- "fan"
example:
- "turn off the lights in here"
- "turn off the fans"
# -------------------------------------------------------------------------
name_only:
description: "Turns off a device or closes a cover by name"
slots:
- "name"
name_domains:
required:
- "light"
- "switch"
- "fan"
- "media_player"
- "input_boolean"
- "cover"
complete:
- "lock"
optional:
- "valve"
example:
- "turn off the overhead light"
- "close sliding door"
# -------------------------------------------------------------------------
area_domain:
description: "Turns off devices by domain in an area"
slots:
- "area"
- "domain"
inferred_domains:
required:
- "light"
optional:
- "fan"
example: "turn off the lights in the kitchen"
# -------------------------------------------------------------------------
# Optional slot combinations
# -------------------------------------------------------------------------
device_class_cover:
description: "Closes the covers in the voice satellite's area by device class"
slots:
- "domain"
- "device_class"
context_area: true
inferred_domains:
complete:
- "cover"
example: "close the windows in here"
# -------------------------------------------------------------------------
name_area:
description: "Turns off a device or close a cover in an area by name"
slots:
- "name"
- "area"
name_domains:
complete:
- "light"
- "switch"
- "fan"
- "media_player"
- "input_boolean"
- "cover"
- "lock"
- "optional"
example:
- "turn off the overhead light in the kitchen"
- "close the sliding door in the kitchen"
# -------------------------------------------------------------------------
name_floor:
description: "Turns off a device or closes a cover on a floor by name"
slots:
- "name"
- "floor"
name_domains:
optional:
- "light"
- "switch"
- "fan"
- "media_player"
- "input_boolean"
- "cover"
- "valve"
example:
- "turn off the overhead light on the first floor"
- "close the sliding door on the first floor"
# -------------------------------------------------------------------------
area_device_class_cover:
description: "Closes the covers in an area by device class"
slots:
- "area"
- "domain"
- "device_class"
inferred_domains:
complete:
- "cover"
example: "close the curtains in the living room"
# -------------------------------------------------------------------------
floor_device_class_cover:
description: "Closes all the covers on a floor by device class"
slots:
- "floor"
- "domain"
- "device_class"
inferred_domains:
optional:
- "cover"
example: "close the curtains on the first floor"
# -------------------------------------------------------------------------
domain_all:
description: "Turns off devices by domain in the house"
slots:
- "domain"
context_area: false
inferred_domains:
optional:
- "light"
example: "turn off all the lights in the house"
# -----------------------------------------------------------------------------
HassGetState:
supported: true
domain: homeassistant
description: "Gets or checks the state of an entity"
slots:
name:
description: "Name of a device or entity"
required: false
area:
description: "Name of an area"
required: false
floor:
description: "Name of a floor"
required: false
domain:
description: "Domain of devices/entities in an area"
required: false
device_class:
description: "Device class of devices/entities in an area"
required: false
state:
description: "Name of state to match"
required: false
response_variables:
state:
description: "State of the first entity matched"
query.matched:
description: "List of states that matched the query and state name"
query.unmatched:
description: "List of states that matched everything except state name"
slot_combinations:
name_only:
description: "Get the state of a device by name"
slots:
- "name"
name_domains:
complete:
- "sensor"
example: "what is the value of sensor 1"
# -------------------------------------------------------------------------
name_state:
description: "Check if the state of a device matches by name"
slots:
- "name"
- "state"
name_domains:
complete:
- "cover"
- "lock"
- "valve"
example: "is the sliding door open"
# -----------------------------------------------------------------------------
HassNevermind:
supported: true
domain: homeassistant
description: "Does nothing. Used to cancel a request"
slot_combinations:
default:
description: "Cancels the current request"
importance: "usable"
slots: []
example: "nevermind"
# -----------------------------------------------------------------------------
HassRespond:
supported: true
domain: homeassistant
description: "Returns response but takes no action"
slots:
response:
description: "Text to respond with"
required: false
slot_combinations:
default:
description: "Return hard-coded response"
importance: "optional"
slots: []
example: "hello"
# -----------------------------------------------------------------------------
HassBroadcast:
supported: true
domain: assist_satellite
description: "Announces a message on other satellites"
slots:
message:
description: "Message to broadcast"
required: true
slot_combinations:
message_only:
description: "Broadcast a message to all other satellites"
importance: "optional"
slots:
- "message"
example: "broadcast that dinner is ready"
# -----------------------------------------------------------------------------
HassSetPosition:
supported: true
domain: homeassistant
description: "Sets the position of an entity"
slots:
name:
description: "Name of a device or entity"
required: false
area:
description: "Name of an area"
required: false
floor:
description: "Name of a floor"
required: false
domain:
description: "Domain of devices/entities in an area"
required: false
device_class:
description: "Device class of devices/entities in an area"
required: false
position:
description: "Position from 0 to 100"
required: true
slot_combinations:
name_only:
description: "Set the position of a cover by name"
slots:
- "name"
- "position"
name_domains:
complete:
- "cover"
- "valve"
example: "set curtain left to 50%"
# -----------------------------------------------------------------------------
HassGetCurrentDate:
supported: true
domain: homeassistant
description: "Gets the current date"
slot_combinations:
default:
description: "Gets the current date"
importance: "usable"
slots: []
example: "what is the date"
response_variables:
date:
description: "Date object with day, month, and year"
# -----------------------------------------------------------------------------
HassGetCurrentTime:
supported: true
domain: homeassistant
description: "Gets the current time"
slot_combinations:
default:
description: "Get the current weather"
importance: "usable"
slots: []
example: "what time is it"
response_variables:
time:
description: "Time object with hours, minutes, and seconds"
# -----------------------------------------------------------------------------
# light
# -----------------------------------------------------------------------------
HassLightSet:
supported: true
domain: light
description: "Sets the brightness or color of a light"
slots:
name:
description: "Name of a device or entity"
required: false
area:
description: "Name of an area"
required: false
floor:
description: "Name of a floor"
required: false
brightness:
description: "Brightness percentage from 0 to 100"
required: false
color:
description: "Name of color"
required: false
slot_combinations:
# -------------------------------------------------------------------------
# Usable slot combinations
# -------------------------------------------------------------------------
name_brightness:
description: "Set the brightness of a light by name"
slots:
- "name"
- "brightness"
name_domains:
usable:
- "light"
example: "set the overhead light brightness to 50%"
# -------------------------------------------------------------------------
name_color:
description: "Set the color of a light by name"
slots:
- "name"
- "color"
name_domains:
usable:
- "light"
example: "set the overhead light to red"
# -------------------------------------------------------------------------
# Optional slot combinations
# -------------------------------------------------------------------------
brightness_only:
description: "Set the brightness of lights in the voice satellite's area"
slots:
- "brightness"
context_area: true
inferred_domains:
complete:
- "light"
example: "set the brightness in here to 50%"
# -------------------------------------------------------------------------
area_brightness:
description: "Set the brightness of all lights in an area"
slots:
- "area"
- "brightness"
inferred_domains:
complete:
- "light"
example: "set the living room brightness to 50%"
# -------------------------------------------------------------------------
floor_brightness:
description: "Set the brightness of all lights on a floor"
slots:
- "floor"
- "brightness"
inferred_domains:
complete:
- "light"
example: "set the main floor brightness to 50%"
# -------------------------------------------------------------------------
color_only:
description: "Set the color of all lights in the voice satellite's area"
slots:
- "color"
context_area: true
inferred_domains:
complete:
- "light"
example: "set the lights in here to red"
# -------------------------------------------------------------------------
area_color:
description: "Set the color of all lights in an area"
slots:
- "area"
- "color"
inferred_domains:
complete:
- "light"
example: "set the living room to red"
# -------------------------------------------------------------------------
floor_color:
description: "Set the color of all lights on a floor"
slots:
- "floor"
- "color"
inferred_domains:
complete:
- "light"
example: "set the main floor to red"
# -----------------------------------------------------------------------------
# climate
# -----------------------------------------------------------------------------
HassClimateSetTemperature:
supported: true
domain: climate
description: "Sets the desired indoor temperature"
slots:
name:
description: "Name of a device or entity"
required: false
area:
description: "Name of an area"
required: false
floor:
description: "Name of a floor"
required: false
temperature:
description: "Temperature in degrees"
required: true
slot_combinations:
# -------------------------------------------------------------------------
# Usable slot combinations
# -------------------------------------------------------------------------
temperature_only:
description: "Sets the temperature in the voice satellite's area"
importance: "complete"
slots:
- "temperature"
context_area: true
example: "set the temperature to 30 degrees"
# -------------------------------------------------------------------------
name_temperature:
description: "Sets the temperature of a climate entity by name"
slots:
- "name"
- "temperature"
name_domains:
complete:
- "climate"
example: "set the EcoBee to 30 degrees"
# -------------------------------------------------------------------------
area_temperature:
description: "Sets the temperature in an area"
importance: "complete"
slots:
- "area"
- "temperature"
example: "set the bedroom temperature to 30 degrees"
# -------------------------------------------------------------------------
floor_temperature:
description: "Sets the temperature of a floor"
importance: "complete"
slots:
- "floor"
- "temperature"
example: "set the temperature of the main floor to 30 degrees"
# -----------------------------------------------------------------------------
HassClimateGetTemperature:
supported: true
domain: climate
description: "Gets the actual indoor temperature (not the desired indoor temperature as set by HassClimateSetTemperature)"
slots:
name:
description: "Name of a device or entity"
required: false
area:
description: "Name of an area"
required: false
floor:
description: "Name of a floor"
required: false
slot_combinations:
# -------------------------------------------------------------------------
# Usable slot combinations
# -------------------------------------------------------------------------
default:
description: "Gets the temperature in the in the voice satellite's area"
importance: "usable"
slots: []
context_area: true
example: "what is the temperature"
# -------------------------------------------------------------------------
name_only:
description: "Gets the temperature of a climate entity by name"
slots:
- "name"
name_domains:
usable:
- "climate"
example: "what is the temperature of the EcoBee"
area_only:
description: "Gets the temperature of an area"
importance: "usable"
slots:
- "area"
example: "what is the temperature in the bedroom"
# -------------------------------------------------------------------------
# Optional slot combinations
# -------------------------------------------------------------------------
floor_only:
description: "Gets the temperature on a floor"
importance: "complete"
slots:
- "floor"
example: "what is the temperature downstairs"
response_variables:
state:
description: "State of the entity that contains the temperature"
# -----------------------------------------------------------------------------
# shopping_list
# -----------------------------------------------------------------------------
HassShoppingListAddItem:
supported: true
domain: shopping_list
description: "Adds an item to the shopping list"
slots:
item:
description: "Item to add"
required: true
slot_combinations:
item_only:
description: "Adds an item to the shopping list"
importance: "optional"
slots:
- "item"
wildcard_slots:
- "item"
example: "add apples to my shopping list"
# -----------------------------------------------------------------------------
HassShoppingListCompleteItem:
supported: false
domain: shopping_list
description: "Checks off an item from the shopping list"
slots:
item:
description: "Item to check off"
required: true
slot_combinations:
item_only:
description: "Checks off an item from the shopping list"
importance: "optional" # change to complete after 2025-07-01
slots:
- "item"
wildcard_slots:
- "item"
example: "check off apples from my shopping list"
# -----------------------------------------------------------------------------
# weather
# -----------------------------------------------------------------------------
HassGetWeather:
supported: true
domain: "weather"
description: "Gets the current weather"
slots:
name:
description: "Name of the weather entity to use"
required: false
slot_combinations:
default:
description: "Get the current weather"
importance: "usable"
slots: []
example: "what is the weather"
# -------------------------------------------------------------------------
name_only:
description: "Get the current weather by name"
slots:
- "name"
name_domains:
usable:
- "weather"
example: "what is the weather in New York"
response_variables:
state:
description: "State of the entity that contains the weather"
# -----------------------------------------------------------------------------
# todo
# -----------------------------------------------------------------------------
HassListAddItem:
supported: true
domain: todo
description: "Adds an item to a todo list"
slots:
item:
description: "Item to add"
required: true
name:
description: "Name of the list"
required: true
slot_combinations:
name_item:
description: "Adds an item to a todo list"
slots:
- "item"
- "name"
wildcard_slots:
- "item"
name_domains:
complete:
- "todo"
example: "add apples to my shopping list"
# -----------------------------------------------------------------------------
HassListCompleteItem:
supported: false
domain: todo
description: "Checks off an item from a todo list"
slots:
item:
description: "Item to check off"
required: true
name:
description: "Name of the list"
required: true
slot_combinations:
name_item:
description: "Checks off an item from a todo list"
slots:
- "item"
- "name"
wildcard_slots:
- "item"
name_domains:
optional: # change to complete after 2025-07-01
- "name"
example: "check off take out the trash from my chores list"
# -----------------------------------------------------------------------------
# vacuum
# -----------------------------------------------------------------------------
HassVacuumStart:
supported: true
domain: vacuum
description: "Starts a vacuum"
slots:
name:
description: "Name of a device or entity"
required: false
area:
description: "Name of an area"
required: false
floor:
description: "Name of a floor"
required: false
slot_combinations:
name_only:
description: "Starts a vacuum by name"
slots:
- "name"
name_domains:
complete:
- "vacuum"
example: "start rover"
# -------------------------------------------------------------------------
area_only:
description: "Starts a vacuum in an area"
importance: "complete"
slots:
- "area"
example: "vacuum the kitchen"
# -------------------------------------------------------------------------
floor_only:
description: "Starts a vacuum on a floor"
importance: "complete"
slots:
- "floor"
example: "vacuum the main floor"
# -----------------------------------------------------------------------------
HassVacuumReturnToBase:
supported: true
domain: vacuum
description: "Returns a vacuum to base"
slots:
name:
description: "Name of a device or entity"
required: false
area:
description: "Name of an area"
required: false
slot_combinations:
name_only:
description: "Returns a vacuum to base by name"
slots:
- "name"
name_domains:
complete:
- "vacuum"
example: "return rover to base"