homeassistant.components.assist_pipeline Namespace Reference

Namespaces
	audio_enhancer
	const
	error
	logbook
	pipeline
	repair_flows
	ring_buffer
	select
	vad
	websocket_api

Functions
None	async_pipeline_from_audio_stream (HomeAssistant hass, *Context context, PipelineEventCallback event_callback, stt.SpeechMetadata stt_metadata, AsyncIterable[bytes] stt_stream, str|None wake_word_phrase=None, str|None pipeline_id=None, str|None conversation_id=None, str|dict[str, Any]|None tts_audio_output=None, WakeWordSettings|None wake_word_settings=None, AudioSettings|None audio_settings=None, str|None device_id=None, PipelineStage start_stage=PipelineStage.STT, PipelineStage end_stage=PipelineStage.TTS)
bool	async_setup (HomeAssistant hass, ConfigType config)

Variables
tuple	__all__
	CONFIG_SCHEMA

Detailed Description

The Assist pipeline integration.

Function Documentation

async_pipeline_from_audio_stream()

None homeassistant.components.assist_pipeline.async_pipeline_from_audio_stream	(	HomeAssistant	hass,
		*Context	context,
		PipelineEventCallback	event_callback,
		stt.SpeechMetadata	stt_metadata,
		AsyncIterable[bytes]	stt_stream,
		str | None	wake_word_phrase = None,
		str | None	pipeline_id = None,
		str | None	conversation_id = None,
		str | dict[str, Any] | None	tts_audio_output = None,
		WakeWordSettings | None	wake_word_settings = None,
		AudioSettings | None	audio_settings = None,
		str | None	device_id = None,
		PipelineStage	start_stage = PipelineStage.STT,
		PipelineStage	end_stage = PipelineStage.TTS
	)

Create an audio pipeline from an audio stream.

Raises PipelineNotFound if no pipeline is found.

Definition at line 95 of file __init__.py.

async_setup()

bool homeassistant.components.assist_pipeline.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up the Assist pipeline integration.

Definition at line 81 of file __init__.py.

Variable Documentation

__all__

tuple homeassistant.components.assist_pipeline.__all__

private

Initial value:

=  (
    "DOMAIN",
    "async_create_default_pipeline",
    "async_get_pipelines",
    "async_migrate_engine",
    "async_setup",
    "async_pipeline_from_audio_stream",
    "async_update_pipeline",
    "AudioSettings",
    "Pipeline",
    "PipelineEvent",
    "PipelineEventType",
    "PipelineNotFound",
    "WakeWordSettings",
    "EVENT_RECORDING",
    "OPTION_PREFERRED",
    "SAMPLES_PER_CHUNK",
    "SAMPLE_RATE",
    "SAMPLE_WIDTH",
    "SAMPLE_CHANNELS",
)

Definition at line 47 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.assist_pipeline.CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {
        DOMAIN: vol.Schema(
            {
                vol.Optional(CONF_DEBUG_RECORDING_DIR): str,
            },
        )
    },
    extra=vol.ALLOW_EXTRA,
)

Definition at line 69 of file __init__.py.