Classes
class	AssistDevice

class	AudioSettings

class	DeviceAudioQueue

class	InvalidPipelineStagesError

class	Pipeline

class	PipelineData

class	PipelineEvent

class	PipelineEventType

class	PipelineInput

class	PipelinePreferred

class	PipelineRun

class	PipelineRunDebug

class	PipelineRuns

class	PipelineRunValidationError

class	PipelineStage

class	PipelineStorageCollection

class	PipelineStorageCollectionWebsocket

class	PipelineStore

class	SerializedPipelineStorageCollection

class	WakeWordSettings

Functions
Pipeline	_async_create_default_pipeline (HomeAssistant hass, PipelineStorageCollection pipeline_store)

Pipeline	_async_get_pipeline_from_conversation_entity (HomeAssistant hass, str entity_id)

dict[str, str\|None]	_async_resolve_default_pipeline_settings (HomeAssistant hass, *str\|None conversation_engine_id=None, str\|None stt_engine_id=None, str\|None tts_engine_id=None, str pipeline_name)

bytes	_multiply_volume (bytes chunk, float volume_multiplier)

None	_pipeline_debug_recording_thread_proc (Path run_recording_dir, Queue[str\|bytes\|None] queue, float message_timeout=5)

Pipeline\|None	async_create_default_pipeline (HomeAssistant hass, str stt_engine_id, str tts_engine_id, str pipeline_name)

Pipeline	async_get_pipeline (HomeAssistant hass, str\|None pipeline_id=None)

list[Pipeline]	async_get_pipelines (HomeAssistant hass)

None	async_migrate_engine (HomeAssistant hass, Literal["conversation", "stt", "tts", "wake_word"] engine_type, str old_value, str new_value)

None	async_run_migrations (HomeAssistant hass)

PipelineData	async_setup_pipeline_store (HomeAssistant hass)

None	async_update_pipeline (HomeAssistant hass, Pipeline pipeline, *str\|UndefinedType conversation_engine=UNDEFINED, str\|UndefinedType conversation_language=UNDEFINED, str\|UndefinedType language=UNDEFINED, str\|UndefinedType name=UNDEFINED, str\|None\|UndefinedType stt_engine=UNDEFINED, str\|None\|UndefinedType stt_language=UNDEFINED, str\|None\|UndefinedType tts_engine=UNDEFINED, str\|None\|UndefinedType tts_language=UNDEFINED, str\|None\|UndefinedType tts_voice=UNDEFINED, str\|None\|UndefinedType wake_word_entity=UNDEFINED, str\|None\|UndefinedType wake_word_id=UNDEFINED, bool\|UndefinedType prefer_local_intents=UNDEFINED)

Any	validate_language (dict[str, Any] data)

Variables
	_LOGGER = logging.getLogger(__name__)

tuple	ENGINE_LANGUAGE_PAIRS

list	PIPELINE_STAGE_ORDER

	PipelineEventCallback

int	SAVE_DELAY = 10

string	STORAGE_KEY = f"{DOMAIN}.pipelines"

int	STORAGE_VERSION = 1

int	STORAGE_VERSION_MINOR = 2

int	STORED_PIPELINE_RUNS = 10

Detailed Description

Classes for voice assistant pipelines.

Function Documentation

◆ _async_create_default_pipeline()

Pipeline homeassistant.components.assist_pipeline.pipeline._async_create_default_pipeline	(	HomeAssistant	hass,
		PipelineStorageCollection	pipeline_store
	)

private

Create a default pipeline.

The default pipeline will use the homeassistant conversation agent and the
default stt / tts engines.

Definition at line 224 of file pipeline.py.

◆ _async_get_pipeline_from_conversation_entity()

Pipeline homeassistant.components.assist_pipeline.pipeline._async_get_pipeline_from_conversation_entity	(	HomeAssistant	hass,
		str	entity_id
	)

private

Get a pipeline by conversation entity ID.

Definition at line 266 of file pipeline.py.

◆ _async_resolve_default_pipeline_settings()

dict[str, str \| None] homeassistant.components.assist_pipeline.pipeline._async_resolve_default_pipeline_settings	(	HomeAssistant	hass,
		*str \| None	conversation_engine_id = `None`,
		str \| None	stt_engine_id = `None`,
		str \| None	tts_engine_id = `None`,
		str	pipeline_name
	)

private

Resolve settings for a default pipeline.

The default pipeline will use the homeassistant conversation agent and the
default stt / tts engines if none are specified.

Definition at line 122 of file pipeline.py.

◆ _multiply_volume()

bytes homeassistant.components.assist_pipeline.pipeline._multiply_volume	(	bytes	chunk,
		float	volume_multiplier
	)

private

Multiplies 16-bit PCM samples by a constant.

Definition at line 1306 of file pipeline.py.

◆ _pipeline_debug_recording_thread_proc()

None homeassistant.components.assist_pipeline.pipeline._pipeline_debug_recording_thread_proc	(	Path	run_recording_dir,
		Queue[str \| bytes \| None]	queue,
		float	message_timeout = `5`
	)

private

Definition at line 1319 of file pipeline.py.

◆ async_create_default_pipeline()

Pipeline \| None homeassistant.components.assist_pipeline.pipeline.async_create_default_pipeline	(	HomeAssistant	hass,
		str	stt_engine_id,
		str	tts_engine_id,
		str	pipeline_name
	)

Create a pipeline with default settings.

The default pipeline will use the homeassistant conversation agent and the
specified stt / tts engines.

Definition at line 238 of file pipeline.py.

◆ async_get_pipeline()

Pipeline homeassistant.components.assist_pipeline.pipeline.async_get_pipeline	(	HomeAssistant	hass,
		str \| None	pipeline_id = `None`
	)

Get a pipeline by id or the preferred pipeline.

Definition at line 282 of file pipeline.py.

◆ async_get_pipelines()

list[Pipeline] homeassistant.components.assist_pipeline.pipeline.async_get_pipelines ( HomeAssistant hass )

Get all pipelines.

Definition at line 305 of file pipeline.py.

◆ async_migrate_engine()

None homeassistant.components.assist_pipeline.pipeline.async_migrate_engine	(	HomeAssistant	hass,
		Literal["conversation", "stt", "tts", "wake_word"]	engine_type,
		str	old_value,
		str	new_value
	)

Register a migration of an engine used in pipelines.

Definition at line 1873 of file pipeline.py.

◆ async_run_migrations()

None homeassistant.components.assist_pipeline.pipeline.async_run_migrations ( HomeAssistant hass )

Run pipeline migrations.

Definition at line 1889 of file pipeline.py.

◆ async_setup_pipeline_store()

PipelineData homeassistant.components.assist_pipeline.pipeline.async_setup_pipeline_store ( HomeAssistant hass )

Set up the pipeline storage collection.

Definition at line 1854 of file pipeline.py.

◆ async_update_pipeline()

None homeassistant.components.assist_pipeline.pipeline.async_update_pipeline	(	HomeAssistant	hass,
		Pipeline	pipeline,
		*str \| UndefinedType	conversation_engine = `UNDEFINED`,
		str \| UndefinedType	conversation_language = `UNDEFINED`,
		str \| UndefinedType	language = `UNDEFINED`,
		str \| UndefinedType	name = `UNDEFINED`,
		str \| None \| UndefinedType	stt_engine = `UNDEFINED`,
		str \| None \| UndefinedType	stt_language = `UNDEFINED`,
		str \| None \| UndefinedType	tts_engine = `UNDEFINED`,
		str \| None \| UndefinedType	tts_language = `UNDEFINED`,
		str \| None \| UndefinedType	tts_voice = `UNDEFINED`,
		str \| None \| UndefinedType	wake_word_entity = `UNDEFINED`,
		str \| None \| UndefinedType	wake_word_id = `UNDEFINED`,
		bool \| UndefinedType	prefer_local_intents = `UNDEFINED`
	)

Update a pipeline.

Definition at line 312 of file pipeline.py.

◆ validate_language()

Any homeassistant.components.assist_pipeline.pipeline.validate_language ( dict[str, Any] data )

Validate language settings.

Definition at line 93 of file pipeline.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.assist_pipeline.pipeline._LOGGER = logging.getLogger(__name__)

private

Definition at line 81 of file pipeline.py.

◆ ENGINE_LANGUAGE_PAIRS

tuple homeassistant.components.assist_pipeline.pipeline.ENGINE_LANGUAGE_PAIRS

Initial value:

 =  (
     ("stt_engine", "stt_language"),
     ("tts_engine", "tts_language"),
 )

Definition at line 87 of file pipeline.py.

◆ PIPELINE_STAGE_ORDER

list homeassistant.components.assist_pipeline.pipeline.PIPELINE_STAGE_ORDER

Initial value:

 =  [
     PipelineStage.WAKE_WORD,
     PipelineStage.STT,
     PipelineStage.INTENT,
     PipelineStage.TTS,
 ]

Definition at line 461 of file pipeline.py.

◆ PipelineEventCallback

homeassistant.components.assist_pipeline.pipeline.PipelineEventCallback

Definition at line 387 of file pipeline.py.

◆ SAVE_DELAY

int homeassistant.components.assist_pipeline.pipeline.SAVE_DELAY = 10

Definition at line 118 of file pipeline.py.

◆ STORAGE_KEY

string homeassistant.components.assist_pipeline.pipeline.STORAGE_KEY = f"{DOMAIN}.pipelines"

Definition at line 83 of file pipeline.py.

◆ STORAGE_VERSION

int homeassistant.components.assist_pipeline.pipeline.STORAGE_VERSION = 1

Definition at line 84 of file pipeline.py.

◆ STORAGE_VERSION_MINOR

int homeassistant.components.assist_pipeline.pipeline.STORAGE_VERSION_MINOR = 2

Definition at line 85 of file pipeline.py.

◆ STORED_PIPELINE_RUNS

int homeassistant.components.assist_pipeline.pipeline.STORED_PIPELINE_RUNS = 10

Definition at line 116 of file pipeline.py.

Home Assistant Unofficial Reference 2024.12.1

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ _async_create_default_pipeline()

◆ _async_get_pipeline_from_conversation_entity()

◆ _async_resolve_default_pipeline_settings()

◆ _multiply_volume()

◆ _pipeline_debug_recording_thread_proc()

◆ async_create_default_pipeline()

◆ async_get_pipeline()

◆ async_get_pipelines()

◆ async_migrate_engine()

◆ async_run_migrations()

◆ async_setup_pipeline_store()

◆ async_update_pipeline()

◆ validate_language()

Variable Documentation

◆ _LOGGER

◆ ENGINE_LANGUAGE_PAIRS

◆ PIPELINE_STAGE_ORDER

◆ PipelineEventCallback

◆ SAVE_DELAY

◆ STORAGE_KEY

◆ STORAGE_VERSION

◆ STORAGE_VERSION_MINOR

◆ STORED_PIPELINE_RUNS