OpenAI Conversation

The OpenAI integration adds a conversation agent powered by OpenAI in Home Assistant.

Controlling Home Assistant is done by providing the AI access to the Assist API of Home Assistant. You can control what devices and entities it can access from the exposed entities page. The AI is able to provide you information about your devices and control them.

This integration does not integrate with sentence triggers.

This integration requires an API key to use, which you can generate here.. This is a paid service, we advise you to monitor your costs in the OpenAI portal closely and configure usage limits to avoid unwanted costs associated with using the service.

Configuration

To add the OpenAI Conversation service to your Home Assistant instance, use this My button:

Generate an API Key

The OpenAI key is used to authenticate requests to the OpenAI API. To generate an API key take the following steps:

• Log in to the OpenAI portal or sign up for an account.
• Enable billing with a valid credit card
• Configure usage limits.
• Visit the API Keys page to retrieve the API key you’ll use to configure the integration.

Options

Options for OpenAI Conversation can be set via the user interface, by taking the following steps:

• Browse to your Home Assistant instance.
• Go to Settings > Devices & Services.
• If multiple instances of OpenAI Conversation are configured, choose the instance you want to configure.
• Select the integration, then select Configure.

If you choose to not use the recommended settings, you can configure the following options:

Talking to Super Mario over the phone

You can use an OpenAI Conversation integration to talk to Super Mario and, if desired, have it control devices in your home.

Actions

Action openai_conversation.generate_image

Allows you to ask OpenAI to generate an image based on a prompt. This action populates Response Data with the requested image.

action: openai_conversation.generate_image
data:
  config_entry: abce6b8696a15e107b4bd843de722249
  prompt: "Cute picture of a dog chasing a herd of cats"
  size: 1024x1024
  quality: standard
  style: vivid
response_variable: generated_image

The response data field url will contain a URL to the generated image and revised_prompt will contain the updated prompt used.

Example using a generated image entity

The following example shows an automation that generates an image and displays it in a image template entity. The prompt uses the state of the weather entity to generate a new image of New York in the current weather state.

The resulting image entity can be used in, for example, a card on your dashboard.

The config_entry is installation specific. To get the value, make sure the integration has been installed. Then, go to Developer Tools > Actions. Ensure you are in UI mode and enter the following below:

Select YAML Mode to reveal the config_entry value to be used in the below example automation.

automation:
  - alias: "Update image when weather changes"
    triggers:
      - trigger: state
        entity_id: weather.home
    actions:
      - alias: "Ask OpenAI to generate an image"
        action: openai_conversation.generate_image
        response_variable: generated_image
        data:
          config_entry: abce6b8696a15e107b4bd843de722249
          size: "1024x1024"
          prompt: >-
            New York when the weather is {{ states("weather.home") }}

      - alias: "Send out a manual event to update the image entity"
        event: new_weather_image
        event_data:
          url: '{{ generated_image.url }}'

template:
  - trigger:
      - alias: "Update image when a new weather image is generated"
        trigger: event
        event_type: new_weather_image
    image:
      - name: "AI generated image of New York"
        url: "{{ trigger.event.data.url }}"

Service openai_conversation.generate_content

Allows you to ask OpenAI to generate a content based on a prompt. This service populates Response Data with the response from OpenAI.

• Service data attribute: config_entry

  • Description: Integration entry ID to use.
  • Example:
  • Optional: no

• Service data attribute: prompt

  • Description: The text to generate content from.
  • Example: Describe the weather
  • Optional: no

• Service data attribute: image_filename

  • Description: List of file names for images to include in the prompt.
  • Example: /tmp/image.jpg
  • Optional: yes

service: openai.generate_content
data:
  config_entry: abce6b8696a15e107b4bd843de722249
  prompt: >-
    Very briefly describe what you see in this image from my doorbell camera.
    Your message needs to be short to fit in a phone notification. Don't
    describe stationary objects or buildings.
  image_filename: 
    - /tmp/doorbell_snapshot.jpg
response_variable: generated_content

The response data field text will contain the generated content.

Another example with multiple images:

service: openai.generate_content
data:
  prompt: >-
    Briefly describe what happened in the following sequence of images
    from my driveway camera.
  image_filename:
    - /tmp/driveway_snapshot1.jpg
    - /tmp/driveway_snapshot2.jpg
    - /tmp/driveway_snapshot3.jpg
    - /tmp/driveway_snapshot4.jpg
response_variable: generated_content