yera.ui.fastapi_routes.settings

Module containing the infra for adding settings page API routes.

Symbols

def register_settings_routes — Register settings page API routes on the UI server app.

register_settings_routes

register_settings_routes(
    app: FastAPI,
    load_state: _LoadSettingsState = load_settings_state,
    save_defaults: _SaveDefaults = save_default_models,
    save_profile_settings_fn: Callable[..., None] = save_profile_settings,
    save_provider_connection_fn: Callable[..., None] = save_provider_connection,
    save_model_inference_fn: Callable[..., None] = save_model_inference,
) → None

Register settings page API routes on the UI server app.

Parameters

app
type: FastAPI

FastAPI application that will receive the Settings routes.

load_state
type: _LoadSettingsState = load_settings_state

Function used to load the current configuration state.

save_defaults
type: _SaveDefaults = save_default_models

Function used to persist model defaults for the active profile.

save_profile_settings_fn
type: Callable[..., None] = save_profile_settings

Function used to persist editable settings belonging to the active profile.

save_provider_connection_fn
type: Callable[..., None] = save_provider_connection

Function used to persist an existing provider connection.

save_model_inference_fn
type: Callable[..., None] = save_model_inference

Function used to persist default inference parameters for a model.