Skip to content

Commit 690125d

Browse files
author
jekalmin
committed
add README of energy
1 parent 5323211 commit 690125d

File tree

2 files changed

+63
-31
lines changed

2 files changed

+63
-31
lines changed

examples/function/calendar/README.md

-31
Original file line numberDiff line numberDiff line change
@@ -33,37 +33,6 @@
3333
response_variable: _function_result
3434
```
3535
36-
### 1. get_events
37-
```yaml
38-
- spec:
39-
name: get_events
40-
description: Use this function to get list of calendar events.
41-
parameters:
42-
type: object
43-
properties:
44-
start_date_time:
45-
type: string
46-
description: The start date time in '%Y-%m-%dT%H:%M:%S%z' format
47-
end_date_time:
48-
type: string
49-
description: The end date time in '%Y-%m-%dT%H:%M:%S%z' format
50-
required:
51-
- start_date_time
52-
- end_date_time
53-
function:
54-
type: script
55-
sequence:
56-
- service: calendar.get_events
57-
data:
58-
start_date_time: "{{start_date_time}}"
59-
end_date_time: "{{end_date_time}}"
60-
target:
61-
entity_id:
62-
- calendar.[YourCalendarHere]
63-
- calendar.[MoreCalendarsArePossible]
64-
response_variable: _function_result
65-
```
66-
6736
### 2. create_event
6837
```yaml
6938
- spec:

examples/function/energy/README.md

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
## Objective
2+
- Get energy statistics
3+
4+
<img width="300" src="https://github.com/jekalmin/extended_openai_conversation/assets/2917984/04ef6eaa-f0be-4cf2-ae53-b11aecf88c4d">
5+
<img width="300" src="https://github.com/jekalmin/extended_openai_conversation/assets/2917984/a38e88e2-c5e5-4db9-a7d3-b3ee2cecb8c2">
6+
7+
## Function
8+
9+
### get_energy_statistic_ids
10+
```yaml
11+
- spec:
12+
name: get_energy_statistic_ids
13+
description: Get statistics
14+
parameters:
15+
type: object
16+
properties:
17+
dummy:
18+
type: string
19+
description: Nothing
20+
function:
21+
type: composite
22+
sequence:
23+
- type: native
24+
name: get_energy
25+
response_variable: result
26+
- type: template
27+
value_template: "{{result.device_consumption | map(attribute='stat_consumption') | list}}"
28+
```
29+
### get_statistics
30+
```yaml
31+
- spec:
32+
name: get_statistics
33+
description: Get statistics
34+
parameters:
35+
type: object
36+
properties:
37+
start_time:
38+
type: string
39+
description: The start datetime
40+
end_time:
41+
type: string
42+
description: The end datetime
43+
statistic_ids:
44+
type: array
45+
items:
46+
type: string
47+
description: The statistic ids
48+
period:
49+
type: string
50+
description: The period
51+
enum:
52+
- day
53+
- week
54+
- month
55+
required:
56+
- start_time
57+
- end_time
58+
- statistic_ids
59+
- period
60+
function:
61+
type: native
62+
name: get_statistics
63+
```

0 commit comments

Comments
 (0)