Extended OpenAI Conversation

Additional Features

How it works

Installation

Preparation

Examples

1. Turn on single entity

2. Turn on multiple entities

3. Hook with custom notify function

4. Add automation

5. Play Netflix

Configuration

Options

Functions

Supported function types

- spec:
 name: execute_services
 description: Use this function to execute service of devices in Home Assistant.
 parameters:
 type: object
 properties:
 list:
 type: array
 items:
 type: object
 properties:
 domain:
 type: string
 description: The domain of the service
 service:
 type: string
 description: The service to be called
 service_data:
 type: object
 description: The service data object to indicate what to control.
 properties:
 entity_id:
 type: string
 description: The entity_id retrieved from available devices. It must start with domain, followed by dot character.
 required:
 - entity_id
 required:
 - domain
 - service
 - service_data
 function:
 type: native
 name: execute_service

Function Usage

1. template

1-1. Get current weather

- spec:
 name: get_current_weather
 description: Get the current weather in a given location
 parameters:
 type: object
 properties:
 location:
 type: string
 description: The city and state, e.g. San Francisco, CA
 unit:
 type: string
 enum:
 - celcius
 - farenheit
 required:
 - location
 function:
 type: template
 value_template: The temperature in {{ location }} is 25 {{unit}}

2. script

2-1. Add item to shopping cart

- spec:
 name: add_item_to_shopping_cart
 description: Add item to shopping cart
 parameters:
 type: object
 properties:
 item:
 type: string
 description: The item to be added to cart
 required:
 - item
 function:
 type: script
 sequence:
 - service: shopping_list.add_item
 data:
 name: '{{item}}'

2-2. Send messages to another messenger

- spec:
 name: send_message_to_line
 description: Use this function to send message to Line.
 parameters:
 type: object
 properties:
 message:
 type: string
 description: message you want to send
 required:
 - message
 function:
 type: script
 sequence:
 - service: script.notify_all
 data:
 message: "{{ message }}"

2-3. Get events from calendar

- spec:
 name: get_events
 description: Use this function to get list of calendar events.
 parameters:
 type: object
 properties:
 start_date_time:
 type: string
 description: The start date time in '%Y-%m-%dT%H:%M:%S%z' format
 end_date_time:
 type: string
 description: The end date time in '%Y-%m-%dT%H:%M:%S%z' format
 required:
 - start_date_time
 - end_date_time
 function:
 type: script
 sequence:
 - service: calendar.list_events
 data:
 start_date_time: "{{start_date_time}}"
 end_date_time: "{{end_date_time}}"
 target:
 entity_id: calendar.test
 response_variable: _function_result

2-4. Play Youtube on TV

- spec:
 name: play_youtube
 description: Use this function to play Youtube.
 parameters:
 type: object
 properties:
 video_id:
 type: string
 description: The video id.
 required:
 - video_id
 function:
 type: script
 sequence:
 - service: webostv.command
 data:
 entity_id: media_player.{YOUR_WEBOSTV}
 command: system.launcher/launch
 payload:
 id: youtube.leanback.v4
 contentId: "{{video_id}}"
 - delay:
 hours: 0
 minutes: 0
 seconds: 10
 milliseconds: 0
 - service: webostv.button
 data:
 entity_id: media_player.{YOUR_WEBOSTV}
 button: ENTER

2-5. Play Netflix on TV

- spec:
 name: play_netflix
 description: Use this function to play Netflix.
 parameters:
 type: object
 properties:
 video_id:
 type: string
 description: The video id.
 required:
 - video_id
 function:
 type: script
 sequence:
 - service: webostv.command
 data:
 entity_id: media_player.{YOUR_WEBOSTV}
 command: system.launcher/launch
 payload:
 id: netflix
 contentId: "m=https://www.netflix.com/watch/{{video_id}}"

3. native

3-1. Add automation

- spec:
 name: add_automation
 description: Use this function to add an automation in Home Assistant.
 parameters:
 type: object
 properties:
 automation_config:
 type: string
 description: A configuration for automation in a valid yaml format. Next line character should be \n. Use devices from the list.
 required:
 - automation_config
 function:
 type: native
 name: add_automation

- spec:
 name: add_automation
 description: Use this function to add an automation in Home Assistant.
 parameters:
 type: object
 properties:
 automation_config:
 type: string
 description: A configuration for automation in a valid yaml format. Next line character should be \\n, not \n. Use devices from the list.
 required:
 - automation_config
 function:
 type: native
 name: add_automation

3-2. Get History

- spec:
 name: get_history
 description: Retrieve historical data of specified entities.
 parameters:
 type: object
 properties:
 entity_ids:
 type: array
 items:
 type: string
 description: The entity id to filter.
 start_time:
 type: string
 description: Start of the history period in "%Y-%m-%dT%H:%M:%S%z".
 end_time:
 type: string
 description: End of the history period in "%Y-%m-%dT%H:%M:%S%z".
 required:
 - entity_ids
 function:
 type: composite
 sequence:
 - type: native
 name: get_history
 response_variable: history_result
 - type: template
 value_template: >-
 {% set ns = namespace(result = [], list = []) %}
 {% for item_list in history_result %}
 {% set ns.list = [] %}
 {% for item in item_list %}
 {% set last_changed = item.last_changed | as_timestamp | timestamp_local if item.last_changed else None %}
 {% set new_item = dict(item, last_changed=last_changed) %}
 {% set ns.list = ns.list + [new_item] %}
 {% endfor %}
 {% set ns.result = ns.result + [ns.list] %}
 {% endfor %}
 {{ ns.result }}

4. scrape

4-1. Get current HA version

- spec:
 name: get_ha_version
 description: Use this function to get Home Assistant version
 parameters:
 type: object
 properties:
 dummy:
 type: string
 description: Nothing
 function:
 type: scrape
 resource: https://www.home-assistant.io
 value_template: "version: {{version}}, release_date: {{release_date}}"
 sensor:
 - name: version
 select: ".current-version h1"
 value_template: '{{ value.split(":")[1] }}'
 - name: release_date
 select: ".release-date"
 value_template: '{{ value.lower() }}'

5. rest

5-1. Get friend names

- spec:
 name: get_friend_names
 description: Use this function to get friend_names
 parameters:
 type: object
 properties:
 dummy:
 type: string
 description: Nothing.
 function:
 type: rest
 resource: https://jsonplaceholder.typicode.com/users
 value_template: '{{value_json | map(attribute="name") | list }}'

6. composite

6-1. Search Youtube Music

- spec:
 name: search_music
 description: Use this function to search music
 parameters:
 type: object
 properties:
 query:
 type: string
 description: The query
 required:
 - query
 function:
 type: composite
 sequence:
 - type: script
 sequence:
 - service: ytube_music_player.search
 data:
 entity_id: media_player.ytube_music_player
 query: "{{ query }}"
 - type: template
 value_template: >-
 media_content_type,media_content_id,title
 {% for media in state_attr('sensor.ytube_music_player_extra', 'search') -%}
 {{media.type}},{{media.id}},{{media.title}}
 {% endfor%}

7. sqlite

7-1. Let model generate a query

- spec:
 name: query_histories_from_db
 description: >-
 Use this function to query histories from Home Assistant SQLite database.
 Example:
 Question: When did bedroom light turn on?
 Answer: SELECT datetime(s.last_updated_ts, 'unixepoch', 'localtime') last_updated_ts FROM states s INNER JOIN states_meta sm ON s.metadata_id = sm.metadata_id INNER JOIN states old ON s.old_state_id = old.state_id WHERE sm.entity_id = 'light.bedroom' AND s.state = 'on' AND s.state != old.state ORDER BY s.last_updated_ts DESC LIMIT 1
 Question: Was livingroom light on at 9 am?
 Answer: SELECT datetime(s.last_updated_ts, 'unixepoch', 'localtime') last_updated, s.state FROM states s INNER JOIN states_meta sm ON s.metadata_id = sm.metadata_id INNER JOIN states old ON s.old_state_id = old.state_id WHERE sm.entity_id = 'switch.livingroom' AND s.state != old.state AND datetime(s.last_updated_ts, 'unixepoch', 'localtime') < '2023-11-17 08:00:00' ORDER BY s.last_updated_ts DESC LIMIT 1
 parameters:
 type: object
 properties:
 query:
 type: string
 description: A fully formed SQL query.
 function:
 type: sqlite

7-2. Let model generate a query (with minimum validation)

- spec:
 name: query_histories_from_db
 description: >-
 Use this function to query histories from Home Assistant SQLite database.
 Example:
 Question: When did bedroom light turn on?
 Answer: SELECT datetime(s.last_updated_ts, 'unixepoch', 'localtime') last_updated_ts FROM states s INNER JOIN states_meta sm ON s.metadata_id = sm.metadata_id INNER JOIN states old ON s.old_state_id = old.state_id WHERE sm.entity_id = 'light.bedroom' AND s.state = 'on' AND s.state != old.state ORDER BY s.last_updated_ts DESC LIMIT 1
 Question: Was livingroom light on at 9 am?
 Answer: SELECT datetime(s.last_updated_ts, 'unixepoch', 'localtime') last_updated, s.state FROM states s INNER JOIN states_meta sm ON s.metadata_id = sm.metadata_id INNER JOIN states old ON s.old_state_id = old.state_id WHERE sm.entity_id = 'switch.livingroom' AND s.state != old.state AND datetime(s.last_updated_ts, 'unixepoch', 'localtime') < '2023-11-17 08:00:00' ORDER BY s.last_updated_ts DESC LIMIT 1
 parameters:
 type: object
 properties:
 query:
 type: string
 description: A fully formed SQL query.
 function:
 type: sqlite
 query: >-
 {%- if is_exposed_entity_in_query(query) -%}
 {{ query }}
 {%- else -%}
 {{ raise("entity_id should be exposed.") }}
 {%- endif -%}

7-3. Defined SQL manually

- spec:
 name: get_last_updated_time_of_entity
 description: >
 Use this function to get last updated time of entity
 parameters:
 type: object
 properties:
 entity_id:
 type: string
 description: The target entity
 function:
 type: sqlite
 query: >-
 {%- if is_exposed(entity_id) -%}
 SELECT datetime(s.last_updated_ts, 'unixepoch', 'localtime') as last_updated_ts
 FROM states s
 INNER JOIN states_meta sm ON s.metadata_id = sm.metadata_id
 INNER JOIN states old ON s.old_state_id = old.state_id
 WHERE sm.entity_id = '{{entity_id}}' AND s.state != old.state ORDER BY s.last_updated_ts DESC LIMIT 1
 {%- else -%}
 {{ raise("entity_id should be exposed.") }}
 {%- endif -%}

Practical Usage

Logging

logger:
 logs:
 custom_components.extended_openai_conversation: info