diff --git a/src/README.md b/src/README.md index 5a819b54..12deaef1 100644 --- a/src/README.md +++ b/src/README.md @@ -15,6 +15,9 @@ Constants used in business logic. ## [lightspeed_stack.py](lightspeed_stack.py) Entry point to the Lightspeed Core Stack REST API service. +## [llama_stack_configuration.py](llama_stack_configuration.py) +Llama Stack configuration handling. + ## [log.py](log.py) Log utilities. diff --git a/src/app/endpoints/README.md b/src/app/endpoints/README.md index 0dd0cea0..2bbecf25 100644 --- a/src/app/endpoints/README.md +++ b/src/app/endpoints/README.md @@ -12,6 +12,9 @@ Handler for REST API call to retrieve service configuration. ## [conversations.py](conversations.py) Handler for REST API calls to manage conversation history. +## [conversations_v2.py](conversations_v2.py) +Handler for REST API calls to manage conversation history. + ## [feedback.py](feedback.py) Handler for REST API endpoint for user feedback. @@ -27,12 +30,21 @@ Handler for REST API call to provide metrics. ## [models.py](models.py) Handler for REST API call to list available models. +## [providers.py](providers.py) +Handler for REST API calls to list and retrieve available providers. + ## [query.py](query.py) Handler for REST API call to provide answer to query. ## [root.py](root.py) Handler for the / endpoint. +## [shields.py](shields.py) +Handler for REST API call to list available shields. + ## [streaming_query.py](streaming_query.py) Handler for REST API call to provide answer to streaming query. +## [tools.py](tools.py) +Handler for REST API call to list available tools from MCP servers. + diff --git a/src/cache/README.md b/src/cache/README.md new file mode 100644 index 00000000..ad45a75d --- /dev/null +++ b/src/cache/README.md @@ -0,0 +1,26 @@ +# List of source files stored in `src/cache` directory + +## [__init__.py](__init__.py) +Various cache implementations. + +## [cache.py](cache.py) +Abstract class that is parent for all cache implementations. + +## [cache_error.py](cache_error.py) +Any exception that can occur during cache operations. + +## [cache_factory.py](cache_factory.py) +Cache factory class. + +## [in_memory_cache.py](in_memory_cache.py) +In-memory cache implementation. + +## [noop_cache.py](noop_cache.py) +No-operation cache implementation. + +## [postgres_cache.py](postgres_cache.py) +PostgreSQL cache implementation. + +## [sqlite_cache.py](sqlite_cache.py) +Cache that uses SQLite to store cached values. + diff --git a/src/metrics/README.md b/src/metrics/README.md index 6f09eef3..1bf462a6 100644 --- a/src/metrics/README.md +++ b/src/metrics/README.md @@ -1,7 +1,7 @@ # List of source files stored in `src/metrics` directory ## [__init__.py](__init__.py) -Metrics module for Lightspeed Stack. +Metrics module for Lightspeed Core Stack. ## [utils.py](utils.py) Utility functions for metrics handling. diff --git a/src/models/README.md b/src/models/README.md index b7bd2510..427266ba 100644 --- a/src/models/README.md +++ b/src/models/README.md @@ -3,6 +3,9 @@ ## [__init__.py](__init__.py) Pydantic models. +## [cache_entry.py](cache_entry.py) +Model for conversation history cache entry. + ## [config.py](config.py) Model with service configuration. diff --git a/src/quota/README.md b/src/quota/README.md new file mode 100644 index 00000000..01eddc57 --- /dev/null +++ b/src/quota/README.md @@ -0,0 +1,8 @@ +# List of source files stored in `src/quota` directory + +## [__init__.py](__init__.py) +Quota management. + +## [sql.py](sql.py) +SQL commands used by quota management package. + diff --git a/src/runners/README.md b/src/runners/README.md index 4f9d04bf..ec669692 100644 --- a/src/runners/README.md +++ b/src/runners/README.md @@ -3,6 +3,9 @@ ## [__init__.py](__init__.py) Runners. +## [quota_scheduler.py](quota_scheduler.py) +User and cluster quota scheduler runner. + ## [uvicorn.py](uvicorn.py) Uvicorn runner. diff --git a/src/utils/README.md b/src/utils/README.md index ba6eb50d..eae8b75c 100644 --- a/src/utils/README.md +++ b/src/utils/README.md @@ -1,7 +1,7 @@ # List of source files stored in `src/utils` directory ## [__init__.py](__init__.py) -Utils. +Utility classes and functions for the Lightspeed Stack core service. ## [checks.py](checks.py) Checks that are performed to configuration options. @@ -9,6 +9,9 @@ Checks that are performed to configuration options. ## [common.py](common.py) Common utilities for the project. +## [connection_decorator.py](connection_decorator.py) +Decorator that makes sure the object is 'connected' according to it's connected predicate. + ## [endpoints.py](endpoints.py) Utility functions for endpoint handlers. @@ -21,6 +24,12 @@ MCP headers handling. ## [suid.py](suid.py) Session ID utility functions. +## [token_counter.py](token_counter.py) +Helper classes to count tokens sent and received by the LLM. + +## [tool_formatter.py](tool_formatter.py) +Utility functions for formatting and parsing MCP tool descriptions. + ## [transcripts.py](transcripts.py) Transcript handling. diff --git a/src/utils/connection_decorator.py b/src/utils/connection_decorator.py index b1dbe2c0..a13a0a33 100644 --- a/src/utils/connection_decorator.py +++ b/src/utils/connection_decorator.py @@ -1,10 +1,10 @@ -"""Decocator that makes sure the object is 'connected' according to it's connected predicate.""" +"""Decorator that makes sure the object is 'connected' according to it's connected predicate.""" from typing import Any, Callable def connection(f: Callable) -> Callable: - """Decocator that makes sure the object is 'connected' according to it's connected predicate. + """Make decorator that makes sure the object is connected according to it's connected predicate. Example: ```python