diff --git a/README.md b/README.md index 60b98824..9304031f 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,11 @@ Lightspeed Core Stack (LCS) is an AI-powered assistant that provides answers to * [Configuration](#configuration) * [Integration with Llama Stack](#integration-with-llama-stack) * [Llama Stack as separate server](#llama-stack-as-separate-server) + * [Llama Stack project and configuration](#llama-stack-project-and-configuration) + * [Check connection to Llama Stack](#check-connection-to-llama-stack) * [Llama Stack as client library](#llama-stack-as-client-library) * [System prompt](#system-prompt) + * [Safety Shields](#safety-shields) * [Usage](#usage) * [Make targets](#make-targets) * [Running Linux container image](#running-linux-container-image) @@ -457,3 +460,12 @@ uv run src/lightspeed_stack.py --data-collector # Using Make target make run-data-collector ``` + + + +# Project structure + +## Configuration classes + +![Configuration classes](docs/config.png) + diff --git a/docs/config.png b/docs/config.png index f20f30f1..25f0e0f6 100644 Binary files a/docs/config.png and b/docs/config.png differ diff --git a/docs/config.puml b/docs/config.puml index 3827a52c..4e60727d 100644 --- a/docs/config.puml +++ b/docs/config.puml @@ -33,7 +33,7 @@ class "DataCollectorConfiguration" as src.models.config.DataCollectorConfigurati ingress_server_url : Optional[str] check_data_collector_configuration() -> Self } -class "LLamaStackConfiguration" as src.models.config.LLamaStackConfiguration { +class "LlamaStackConfiguration" as src.models.config.LlamaStackConfiguration { api_key : Optional[str] library_client_config_path : Optional[str] url : Optional[str] @@ -70,7 +70,7 @@ class "UserDataCollection" as src.models.config.UserDataCollection { check_storage_location_is_set_when_needed() -> Self } src.models.config.DataCollectorConfiguration --* src.models.config.UserDataCollection : data_collector -src.models.config.LLamaStackConfiguration --* src.models.config.Configuration : llama_stack +src.models.config.LlamaStackConfiguration --* src.models.config.Configuration : llama_stack src.models.config.ServiceConfiguration --* src.models.config.Configuration : service src.models.config.TLSConfiguration --* src.models.config.ServiceConfiguration : tls_config src.models.config.UserDataCollection --* src.models.config.Configuration : user_data_collection