aiq.utils.settings.global_settings#

Attributes#

Functions#

configure_registry_channel(→ None)

Perform channel updates, gathering input from user and validatinig against the global settings data model.

add_channel_interative(→ None)

Add a remote registry channel to publish/search/pull AgentIQ plugin packages.

get_existing_channel_interactive(→ tuple[str, bool])

Retrieve an existing channel by configured name.

remove_channel(→ None)

Remove a configured registry channel from the global settings.

remove_channel_interactive(→ None)

match_valid_channel(→ None)

Performs a match by registry channel to perform a channel configuration update.

update_channel_interactive(channel_name)

Launch an interactive session to update a configured channels settings.

Module Contents#

logger#
configure_registry_channel(
config_type: aiq.data_models.registry_handler.RegistryHandlerBaseConfig,
channel_name: str,
) None#

Perform channel updates, gathering input from user and validatinig against the global settings data model.

Args:

config_type (RegistryHandlerBaseConfig): The registry handler configuration object to ensure valid channel settings channel_name (str): The name to use to reference the remote registry channel.

add_channel_interative(channel_type: str) None#

Add a remote registry channel to publish/search/pull AgentIQ plugin packages.

Args:

channel_type (str): They type of channel to configure.

get_existing_channel_interactive(
channel_name: str,
) tuple[str, bool]#

Retrieve an existing channel by configured name.

Args:

channel_name (str): The name to use to reference the remote registry channel.

Returns:
tuple[str, bool]: A tuple containing the retrieved channel name and a boolean representing a

valid match was or was not successful.

remove_channel(channel_name: str) None#

Remove a configured registry channel from the global settings.

Args:

channel_name (str): The name to use to reference the remote registry channel.

remove_channel_interactive(channel_name: str) None#
match_valid_channel(channel_name: str) None#

Performs a match by registry channel to perform a channel configuration update.

Args:

channel_name (str): The name to use to reference the remote registry channel.

update_channel_interactive(channel_name: str)#

Launch an interactive session to update a configured channels settings.

Args:

channel_name (str): The name to use to reference the remote registry channel.