Assist pipeline

The Assist pipeline integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] provides the foundation for the Assist voice assistant in Home Assistant.

For most users, there is no need to install this integration manually. The Assist pipeline integration is part of the default configuration and is set up automatically if needed by other integrations. If you are not using the default integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more], you need to add the following to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes.

# Example configuration.yaml entry
assist_pipeline:

For more information, refer to the procedure on configuring a pipeline.

Debug recordings

If Assist doesn’t understand you or doesn’t react to the wake word, you can save the audio of your voice commands and listen to what Home Assistant received.

Important

Risk of recording private conversations and running out of disk space

If Home Assistant listens for the wake word itself, debug recording saves everything the microphone picks up while it’s waiting for the wake word, not only your commands. Home Assistant never deletes the recordings, so they keep using disk space until you remove them.

To avoid this:

  • Turn on debug recording only while you reproduce the problem.

  • When you’re done, turn off debug recording and delete the recordings folder.

Recording voice commands for debugging

Prerequisites:

  1. In your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, add debug_recording_dir under assist_pipeline:

    # Example configuration.yaml entry
    assist_pipeline:
      debug_recording_dir: /share/assist_pipeline
    
    • On Home Assistant OS, use a folder in /share. This is the share folder in the Samba app.
    • On other installation types, use a folder that you can access from outside Home Assistant.
    • Home Assistant creates the folder if it doesn’t exist.
  2. Restart Home Assistant.

  3. Reproduce the problem: say the wake word and your command to the device that has the problem.

  4. Open the folder with the recording.

    • Each voice command gets its own folder: <debug_recording_dir>/<device ID>/<assistant name>/<number>. If the command didn’t come from a device, there is no <device ID> folder.
    • To find the device ID, go to Settings > Devices & services > Devices and select the device. The ID is the last part of the URL.
    • The folder numbers aren’t dates. To find the latest recording, sort by Date modified.
  5. Listen to the recordings.

    • 01_stt-*.wav: the audio that was sent to speech-to-text.
    • 00_wake-*.wav: the audio Home Assistant listened to for the wake word. Only saved if Home Assistant detects the wake word, not the device itself.
    • Result: You hear what wake word detection and speech-to-text received. For an example of how to use this, see tweaking the Assist audio configuration.

When you’re done, turn off debug recording.

Turning off debug recording

  1. In your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, remove the debug_recording_dir line.
  2. Restart Home Assistant.
  3. Delete the folder with the recordings.