lightspeed-stack 0.1.0__py3-none-any.whl

lightspeed_stack-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

models/__init__.py

@@ -0,0 +1 @@
+"""Pydantic models."""

models/config.py

@@ -0,0 +1,161 @@
+"""Model with service configuration."""
+
+from typing import Optional
+
+from pydantic import BaseModel, model_validator, FilePath, AnyHttpUrl
+from typing_extensions import Self
+
+import constants
+
+from utils import checks
+
+
+class TLSConfiguration(BaseModel):
+    """TLS configuration."""
+
+    tls_certificate_path: Optional[FilePath] = None
+    tls_key_path: Optional[FilePath] = None
+    tls_key_password: Optional[FilePath] = None
+
+    @model_validator(mode="after")
+    def check_tls_configuration(self) -> Self:
+        """Check TLS configuration."""
+        return self
+
+
+class ServiceConfiguration(BaseModel):
+    """Service configuration."""
+
+    host: str = "localhost"
+    port: int = 8080
+    auth_enabled: bool = False
+    workers: int = 1
+    color_log: bool = True
+    access_log: bool = True
+    tls_config: TLSConfiguration = TLSConfiguration()
+
+    @model_validator(mode="after")
+    def check_service_configuration(self) -> Self:
+        """Check service configuration."""
+        if self.port <= 0:
+            raise ValueError("Port value should not be negative")
+        if self.port > 65535:
+            raise ValueError("Port value should be less than 65536")
+        if self.workers < 1:
+            raise ValueError("Workers must be set to at least 1")
+        return self
+
+
+class ModelContextProtocolServer(BaseModel):
+    """model context protocol server configuration."""
+
+    name: str
+    provider_id: str = "model-context-protocol"
+    url: str
+
+
+class LLamaStackConfiguration(BaseModel):
+    """Llama stack configuration."""
+
+    url: Optional[str] = None
+    api_key: Optional[str] = None
+    use_as_library_client: Optional[bool] = None
+    library_client_config_path: Optional[str] = None
+
+    @model_validator(mode="after")
+    def check_llama_stack_model(self) -> Self:
+        """Check Llama stack configuration."""
+        if self.url is None:
+            if self.use_as_library_client is None:
+                raise ValueError(
+                    "LLama stack URL is not specified and library client mode is not specified"
+                )
+            if self.use_as_library_client is False:
+                raise ValueError(
+                    "LLama stack URL is not specified and library client mode is not enabled"
+                )
+        if self.use_as_library_client is None:
+            self.use_as_library_client = False
+        if self.use_as_library_client:
+            if self.library_client_config_path is None:
+                # pylint: disable=line-too-long
+                raise ValueError(
+                    "LLama stack library client mode is enabled but a configuration file path is not specified"  # noqa: C0301
+                )
+        return self
+
+
+class UserDataCollection(BaseModel):
+    """User data collection configuration."""
+
+    feedback_disabled: bool = True
+    feedback_storage: Optional[str] = None
+    transcripts_disabled: bool = True
+    transcripts_storage: Optional[str] = None
+
+    @model_validator(mode="after")
+    def check_storage_location_is_set_when_needed(self) -> Self:
+        """Check that storage_location is set when enabled."""
+        if not self.feedback_disabled and self.feedback_storage is None:
+            raise ValueError("feedback_storage is required when feedback is enabled")
+        if not self.transcripts_disabled and self.transcripts_storage is None:
+            raise ValueError(
+                "transcripts_storage is required when transcripts is enabled"
+            )
+        return self
+
+
+class AuthenticationConfiguration(BaseModel):
+    """Authentication configuration."""
+
+    module: str = constants.DEFAULT_AUTHENTICATION_MODULE
+    skip_tls_verification: bool = False
+    k8s_cluster_api: Optional[AnyHttpUrl] = None
+    k8s_ca_cert_path: Optional[FilePath] = None
+
+    @model_validator(mode="after")
+    def check_authentication_model(self) -> Self:
+        """Validate YAML containing authentication configuration section."""
+        if self.module not in constants.SUPPORTED_AUTHENTICATION_MODULES:
+            supported_modules = ", ".join(constants.SUPPORTED_AUTHENTICATION_MODULES)
+            raise ValueError(
+                f"Unsupported authentication module '{self.module}'. "
+                f"Supported modules: {supported_modules}"
+            )
+        return self
+
+
+class Customization(BaseModel):
+    """Service customization."""
+
+    system_prompt_path: Optional[FilePath] = None
+    system_prompt: Optional[str] = None
+
+    @model_validator(mode="after")
+    def check_authentication_model(self) -> Self:
+        """Load system prompt from file."""
+        if self.system_prompt_path is not None:
+            checks.file_check(self.system_prompt_path, "system prompt")
+            self.system_prompt = checks.get_attribute_from_file(
+                dict(self), "system_prompt_path"
+            )
+        return self
+
+
+class Configuration(BaseModel):
+    """Global service configuration."""
+
+    name: str
+    service: ServiceConfiguration
+    llama_stack: LLamaStackConfiguration
+    user_data_collection: UserDataCollection
+    mcp_servers: list[ModelContextProtocolServer] = []
+    authentication: Optional[AuthenticationConfiguration] = (
+        AuthenticationConfiguration()
+    )
+    customization: Optional[Customization] = None
+
+    def dump(self, filename: str = "configuration.json") -> None:
+        """Dump actual configuration into JSON file."""
+        with open(filename, "w", encoding="utf-8") as fout:
+            fout.write(self.model_dump_json(indent=4))

models/requests.py

@@ -0,0 +1,208 @@
+"""Model for service requests."""
+
+from typing import Optional, Self
+
+from pydantic import BaseModel, model_validator, field_validator, Field
+from llama_stack_client.types.agents.turn_create_params import Document
+
+from utils import suid
+
+
+class Attachment(BaseModel):
+    """Model representing an attachment that can be send from UI as part of query.
+
+    List of attachments can be optional part of 'query' request.
+
+    Attributes:
+        attachment_type: The attachment type, like "log", "configuration" etc.
+        content_type: The content type as defined in MIME standard
+        content: The actual attachment content
+
+    YAML attachments with **kind** and **metadata/name** attributes will
+    be handled as resources with specified name:
+    ```
+    kind: Pod
+    metadata:
+        name: private-reg
+    ```
+    """
+
+    attachment_type: str
+    content_type: str
+    content: str
+
+    # provides examples for /docs endpoint
+    model_config = {
+        "json_schema_extra": {
+            "examples": [
+                {
+                    "attachment_type": "log",
+                    "content_type": "text/plain",
+                    "content": "this is attachment",
+                },
+                {
+                    "attachment_type": "configuration",
+                    "content_type": "application/yaml",
+                    "content": "kind: Pod\n metadata:\n name:    private-reg",
+                },
+                {
+                    "attachment_type": "configuration",
+                    "content_type": "application/yaml",
+                    "content": "foo: bar",
+                },
+            ]
+        }
+    }
+
+
+# TODO(lucasagomes): add media_type when needed, current implementation
+# does not support streaming response, so this is not used
+class QueryRequest(BaseModel):
+    """Model representing a request for the LLM (Language Model).
+
+    Attributes:
+        query: The query string.
+        conversation_id: The optional conversation ID (UUID).
+        provider: The optional provider.
+        model: The optional model.
+        system_prompt: The optional system prompt.
+        attachments: The optional attachments.
+
+    Example:
+        ```python
+        query_request = QueryRequest(query="Tell me about Kubernetes")
+        ```
+    """
+
+    query: str
+    conversation_id: Optional[str] = None
+    provider: Optional[str] = None
+    model: Optional[str] = None
+    system_prompt: Optional[str] = None
+    attachments: Optional[list[Attachment]] = None
+
+    # provides examples for /docs endpoint
+    model_config = {
+        "extra": "forbid",
+        "json_schema_extra": {
+            "examples": [
+                {
+                    "query": "write a deployment yaml for the mongodb image",
+                    "conversation_id": "123e4567-e89b-12d3-a456-426614174000",
+                    "provider": "openai",
+                    "model": "model-name",
+                    "system_prompt": "You are a helpful assistant",
+                    "attachments": [
+                        {
+                            "attachment_type": "log",
+                            "content_type": "text/plain",
+                            "content": "this is attachment",
+                        },
+                        {
+                            "attachment_type": "configuration",
+                            "content_type": "application/yaml",
+                            "content": "kind: Pod\n metadata:\n    name: private-reg",
+                        },
+                        {
+                            "attachment_type": "configuration",
+                            "content_type": "application/yaml",
+                            "content": "foo: bar",
+                        },
+                    ],
+                }
+            ]
+        },
+    }
+
+    def get_documents(self) -> list[Document]:
+        """Return the list of documents from the attachments."""
+        if not self.attachments:
+            return []
+        return [
+            Document(content=att.content, mime_type=att.content_type)
+            for att in self.attachments  # pylint: disable=not-an-iterable
+        ]
+
+    @model_validator(mode="after")
+    def validate_provider_and_model(self) -> Self:
+        """Perform validation on the provider and model."""
+        if self.model and not self.provider:
+            raise ValueError("Provider must be specified if model is specified")
+        if self.provider and not self.model:
+            raise ValueError("Model must be specified if provider is specified")
+        return self
+
+
+class FeedbackRequest(BaseModel):
+    """Model representing a feedback request.
+
+    Attributes:
+        conversation_id: The required conversation ID (UUID).
+        user_question: The required user question.
+        llm_response: The required LLM response.
+        sentiment: The optional sentiment.
+        user_feedback: The optional user feedback.
+
+    Example:
+        ```python
+        feedback_request = FeedbackRequest(
+            conversation_id="12345678-abcd-0000-0123-456789abcdef",
+            user_question="what are you doing?",
+            user_feedback="Great service!",
+            llm_response="I don't know",
+            sentiment=-1,
+        )
+        ```
+    """
+
+    conversation_id: str
+    user_question: str
+    llm_response: str
+    sentiment: Optional[int] = None
+    # Optional user feedback limited to 1–4096 characters to prevent abuse.
+    user_feedback: Optional[str] = Field(
+        default=None,
+        max_length=4096,
+        description="Feedback on the LLM response.",
+        examples=["I'm not satisfied with the response because it is too vague."],
+    )
+
+    # provides examples for /docs endpoint
+    model_config = {
+        "json_schema_extra": {
+            "examples": [
+                {
+                    "conversation_id": "12345678-abcd-0000-0123-456789abcdef",
+                    "user_question": "foo",
+                    "llm_response": "bar",
+                    "user_feedback": "Great service!",
+                    "sentiment": 1,
+                }
+            ]
+        }
+    }
+
+    @field_validator("conversation_id")
+    @classmethod
+    def check_uuid(cls, value: str) -> str:
+        """Check if conversation ID has the proper format."""
+        if not suid.check_suid(value):
+            raise ValueError(f"Improper conversation ID {value}")
+        return value
+
+    @field_validator("sentiment")
+    @classmethod
+    def check_sentiment(cls, value: Optional[int]) -> Optional[int]:
+        """Check if sentiment value is as expected."""
+        if value not in {-1, 1, None}:
+            raise ValueError(
+                f"Improper sentiment value of {value}, needs to be -1 or 1"
+            )
+        return value
+
+    @model_validator(mode="after")
+    def check_sentiment_or_user_feedback_set(self) -> Self:
+        """Ensure that either 'sentiment' or 'user_feedback' is set."""
+        if self.sentiment is None and self.user_feedback is None:
+            raise ValueError("Either 'sentiment' or 'user_feedback' must be set")
+        return self