homeassistant.components.openai_conversation.config_flow Namespace Reference

Classes
class	OpenAIConfigFlow
class	OpenAIOptionsFlow

Functions
VolDictType	openai_config_option_schema (HomeAssistant hass, dict[str, Any]|MappingProxyType[str, Any] options)
None	validate_input (HomeAssistant hass, dict[str, Any] data)

Variables
	_LOGGER = logging.getLogger(__name__)
dictionary	RECOMMENDED_OPTIONS
	STEP_USER_DATA_SCHEMA

Detailed Description

Config flow for OpenAI Conversation integration.

Function Documentation

openai_config_option_schema()

VolDictType homeassistant.components.openai_conversation.config_flow.openai_config_option_schema	(	HomeAssistant	hass,
		dict[str, Any] | MappingProxyType[str, Any]	options
	)

Return a schema for OpenAI completion options.

Definition at line 150 of file config_flow.py.

validate_input()

None homeassistant.components.openai_conversation.config_flow.validate_input	(	HomeAssistant	hass,
		dict[str, Any]	data
	)

Validate the user input allows us to connect.

Data has the keys from STEP_USER_DATA_SCHEMA with values provided by the user.

Definition at line 60 of file config_flow.py.

Variable Documentation

_LOGGER

homeassistant.components.openai_conversation.config_flow._LOGGER = logging.getLogger(__name__)

private

Definition at line 45 of file config_flow.py.

RECOMMENDED_OPTIONS

dictionary homeassistant.components.openai_conversation.config_flow.RECOMMENDED_OPTIONS

Initial value:

=  {
    CONF_RECOMMENDED: True,
    CONF_LLM_HASS_API: llm.LLM_API_ASSIST,
    CONF_PROMPT: llm.DEFAULT_INSTRUCTIONS_PROMPT,
}

Definition at line 53 of file config_flow.py.

STEP_USER_DATA_SCHEMA

homeassistant.components.openai_conversation.config_flow.STEP_USER_DATA_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_API_KEY): str,
    }
)

Definition at line 47 of file config_flow.py.