Merge branch 'main' into LCORE_945_optional_topic_summary

Author: radofuchs

.coderabbit.yaml

@@ -0,0 +1,187 @@
+language: en-US
+tone_instructions: ''
+early_access: false
+enable_free_tier: true
+reviews:
+  profile: chill
+  request_changes_workflow: false
+  high_level_summary: true
+  high_level_summary_placeholder: '@coderabbitai summary'
+  high_level_summary_in_walkthrough: false
+  auto_title_placeholder: '@coderabbitai'
+  auto_title_instructions: ''
+  review_status: true
+  commit_status: true
+  fail_commit_status: false
+  collapse_walkthrough: false
+  changed_files_summary: true
+  sequence_diagrams: true
+  estimate_code_review_effort: true
+  assess_linked_issues: true
+  related_issues: true
+  related_prs: true
+  suggested_labels: true
+  labeling_instructions: []
+  auto_apply_labels: false
+  suggested_reviewers: true
+  auto_assign_reviewers: false
+  in_progress_fortune: true
+  poem: false
+  path_filters: []
+  path_instructions: []
+  abort_on_close: true
+  disable_cache: false
+  auto_review:
+    enabled: true
+    auto_incremental_review: true
+    ignore_title_keywords: []
+    labels: []
+    drafts: false
+    base_branches: []
+    ignore_usernames: []
+  finishing_touches:
+    docstrings:
+      enabled: true
+    unit_tests:
+      enabled: true
+  pre_merge_checks:
+    docstrings:
+      mode: warning
+      threshold: 80
+    title:
+      mode: warning
+      requirements: ''
+    description:
+      mode: warning
+    issue_assessment:
+      mode: warning
+    custom_checks: []
+  tools:
+    ast-grep:
+      rule_dirs: []
+      util_dirs: []
+      essential_rules: true
+      packages: []
+    shellcheck:
+      enabled: true
+    ruff:
+      enabled: true
+    markdownlint:
+      enabled: true
+    github-checks:
+      enabled: true
+      timeout_ms: 90000
+    languagetool:
+      enabled: true
+      enabled_rules: []
+      disabled_rules: []
+      enabled_categories: []
+      disabled_categories: []
+      enabled_only: false
+      level: default
+    biome:
+      enabled: true
+    hadolint:
+      enabled: true
+    swiftlint:
+      enabled: true
+    phpstan:
+      enabled: true
+      level: default
+    phpmd:
+      enabled: true
+    phpcs:
+      enabled: true
+    golangci-lint:
+      enabled: true
+    yamllint:
+      enabled: true
+    gitleaks:
+      enabled: true
+    checkov:
+      enabled: true
+    detekt:
+      enabled: true
+    eslint:
+      enabled: true
+    flake8:
+      enabled: true
+    rubocop:
+      enabled: true
+    buf:
+      enabled: true
+    regal:
+      enabled: true
+    actionlint:
+      enabled: true
+    pmd:
+      enabled: true
+    clang:
+      enabled: true
+    cppcheck:
+      enabled: true
+    semgrep:
+      enabled: true
+    circleci:
+      enabled: true
+    clippy:
+      enabled: true
+    sqlfluff:
+      enabled: true
+    prismaLint:
+      enabled: true
+    pylint:
+      enabled: true
+    oxc:
+      enabled: true
+    shopifyThemeCheck:
+      enabled: true
+    luacheck:
+      enabled: true
+    brakeman:
+      enabled: true
+    dotenvLint:
+      enabled: true
+    htmlhint:
+      enabled: true
+    checkmake:
+      enabled: true
+    osvScanner:
+      enabled: true
+chat:
+  art: true
+  auto_reply: true
+  integrations:
+    jira:
+      usage: auto
+    linear:
+      usage: auto
+knowledge_base:
+  opt_out: false
+  web_search:
+    enabled: true
+  code_guidelines:
+    enabled: true
+    filePatterns: []
+  learnings:
+    scope: auto
+  issues:
+    scope: auto
+  jira:
+    usage: auto
+    project_keys: []
+  linear:
+    usage: auto
+    team_keys: []
+  pull_requests:
+    scope: auto
+  mcp:
+    usage: auto
+    disabled_servers: []
+code_generation:
+  docstrings:
+    language: en-US
+    path_instructions: []
+  unit_tests:
+    path_instructions: []
+

CLAUDE.md

@@ -15,11 +15,11 @@ Lightspeed Core Stack (LCS) is an AI-powered assistant built on FastAPI that pro
 ### Project Structure
 ```
 src/
-├── app/                    # FastAPI application
-│   ├── endpoints/         # REST API endpoints
+├── app/                  # FastAPI application
+│   ├── endpoints/        # REST API endpoints
 │   └── main.py           # Application entry point
-├── auth/                  # Authentication modules (k8s, jwk, noop)
-├── authorization/         # Authorization middleware & resolvers
+├── auth/                 # Authentication modules (k8s, jwk, noop)
+├── authorization/        # Authorization middleware & resolvers
 ├── models/               # Pydantic models
 │   ├── config.py         # Configuration classes
 │   ├── requests.py       # Request models
@@ -110,8 +110,8 @@ src/
 ### Test Structure
 ```
 tests/
-├── unit/                 # Unit tests (pytest)
-├── integration/          # Integration tests
+├── unit/                # Unit tests (pytest)
+├── integration/         # Integration tests (pytest)
 └── e2e/                 # End-to-end tests (behave)
     └── features/        # Gherkin feature files
 ```
@@ -146,7 +146,7 @@ tests/
 ```bash
 uv run make test-unit        # Unit tests with coverage
 uv run make test-integration # Integration tests  
-uv run make test-e2e        # End-to-end tests
+uv run make test-e2e         # End-to-end tests
 ```
 
 ## Quality Assurance
@@ -184,4 +184,4 @@ uv run make test-e2e        # End-to-end tests
 3. **ALWAYS** check `pyproject.toml` for existing dependencies and versions before adding new ones
 4. Follow existing code patterns in the module you're modifying
 5. Write unit tests covering new functionality
-6. Run format and verify before completion
+6. Run format and verify before completion

Makefile

@@ -8,8 +8,6 @@ PYTHON_REGISTRY = pypi
 run: ## Run the service locally
 	uv run src/lightspeed_stack.py
 
-
-
 test-unit: ## Run the unit tests
 	@echo "Running unit tests..."
 	@echo "Reports will be written to ${ARTIFACT_DIR}"
@@ -24,7 +22,7 @@ test-e2e: ## Run end to end tests for the service
 	script -q -e -c "uv run behave --color --format pretty --tags=-skip -D dump_errors=true @tests/e2e/test_list.txt"
 
 check-types: ## Checks type hints in sources
-	uv run mypy --explicit-package-bases --disallow-untyped-calls --disallow-untyped-defs --disallow-incomplete-defs --ignore-missing-imports --disable-error-code attr-defined src/ tests/unit
+	uv run mypy --explicit-package-bases --disallow-untyped-calls --disallow-untyped-defs --disallow-incomplete-defs --ignore-missing-imports --disable-error-code attr-defined src/ tests/unit tests/integration tests/e2e/
 
 security-check: ## Check the project for security issues
 	bandit -c pyproject.toml -r src tests

README.md

@@ -34,6 +34,9 @@ The service includes comprehensive user data collection capabilities for various
     * [Llama Stack version check](#llama-stack-version-check)
     * [User data collection](#user-data-collection)
     * [System prompt](#system-prompt)
+        * [System Prompt Path](#system-prompt-path)
+        * [System Prompt Literal](#system-prompt-literal)
+        * [Custom Profile](#custom-profile)
         * [Control model/provider overrides via authorization](#control-modelprovider-overrides-via-authorization)
     * [Safety Shields](#safety-shields)
     * [Authentication](#authentication)
@@ -75,6 +78,10 @@ The service includes comprehensive user data collection capabilities for various
 * [Project structure](#project-structure)
     * [Configuration classes](#configuration-classes)
     * [REST API](#rest-api)
+    * [Sequence diagrams](#sequence-diagrams)
+        * [Query endpoint REST API handler](#query-endpoint-rest-api-handler)
+    * [Streaming query endpoint REST API handler](#streaming-query-endpoint-rest-api-handler)
+    * [Versioning](#versioning)
 
 <!-- vim-markdown-toc -->
 
@@ -94,6 +101,31 @@ Lightspeed Core Stack is based on the FastAPI framework (Uvicorn). The service i
     - please note that currently Python 3.14 is not officially supported
     - all sources are made (backward) compatible with Python 3.12; it is checked on CI
 
+* OpenAI API Key (Recommended for Getting Started)
+
+  Lightspeed Stack supports multiple LLM providers.
+
+  | Provider       | Setup Documentation                                                   |
+  |----------------|-----------------------------------------------------------------------|
+  | OpenAI         | https://platform.openai.com                                           |
+  | Azure OpenAI   | https://azure.microsoft.com/en-us/products/ai-services/openai-service |
+  | RHOAI (vLLM)   | See tests/e2e-prow/rhoai/configs/run.yaml                             |
+  | RHEL AI (vLLM) | See tests/e2e/configs/run-rhelai.yaml                                 |
+
+  See `docs/providers.md` for configuration details.
+
+  You will need an API key from one of these providers to run LightSpeed Stack.
+
+  For example, if you choose to use OpenAI: 
+
+  1. **Create an account** at [platform.openai.com](https://platform.openai.com)
+  2. **Add payment information** (new accounts receive free trial credits)
+  3. **Generate an API key** from your dashboard at [API Keys](https://platform.openai.com/api-keys)
+  4. **Export the key** in your environment:
+     ```bash
+     export OPENAI_API_KEY="sk-your-api-key-here"
+    ```
+
 # Installation
 
 Installation steps depends on operation system. Please look at instructions for your system:
@@ -864,3 +896,22 @@ For complete integration setup, deployment options, and configuration details, s
 ## REST API
 
 ![REST API](docs/rest_api.png)
+
+## Sequence diagrams
+
+### Query endpoint REST API handler
+
+![Query endpoint](docs/query_endpoint.svg)
+
+## Streaming query endpoint REST API handler
+
+![Streaming query endpoint](docs/streaming_query_endpoint.svg)
+
+## Versioning
+
+We follow [Semantic Versioning](http://semver.org/spec/v1.0.0.html).
+The version X.Y.Z indicates:
+
+* X is the major version (backward-incompatible),
+* Y is the minor version (backward-compatible), and
+* Z is the patch version (backward-compatible bug fix).

docs/architecture.png

@@ -38,7 +38,7 @@ class "Configuration" as src.models.config.Configuration {
   authentication : Optional[AuthenticationConfiguration]
   authorization : Optional[AuthorizationConfiguration]
   byok_rag : Optional[list[ByokRag]]
-  conversation_cache : Optional[ConversationCacheConfiguration]
+  conversation_cache : Optional[ConversationHistoryConfiguration]
   customization : Optional[Customization]
   database : Optional[DatabaseConfiguration]
   inference : Optional[InferenceConfiguration]
@@ -53,7 +53,7 @@ class "Configuration" as src.models.config.Configuration {
 class "ConfigurationBase" as src.models.config.ConfigurationBase {
   model_config
 }
-class "ConversationCacheConfiguration" as src.models.config.ConversationCacheConfiguration {
+class "ConversationHistoryConfiguration" as src.models.config.ConversationHistoryConfiguration {
   memory : Optional[InMemoryCacheConfig]
   postgres : Optional[PostgreSQLDatabaseConfiguration]
   sqlite : Optional[SQLiteDatabaseConfiguration]
@@ -185,7 +185,7 @@ src.models.config.AuthorizationConfiguration --|> src.models.config.Configuratio
 src.models.config.ByokRag --|> src.models.config.ConfigurationBase
 src.models.config.CORSConfiguration --|> src.models.config.ConfigurationBase
 src.models.config.Configuration --|> src.models.config.ConfigurationBase
-src.models.config.ConversationCacheConfiguration --|> src.models.config.ConfigurationBase
+src.models.config.ConversationHistoryConfiguration --|> src.models.config.ConfigurationBase
 src.models.config.Customization --|> src.models.config.ConfigurationBase
 src.models.config.DatabaseConfiguration --|> src.models.config.ConfigurationBase
 src.models.config.InMemoryCacheConfig --|> src.models.config.ConfigurationBase