Merge pull request #487 from Jdubrick/add-customization-profiles

[RHDHPAI-976] Add customization profiles via path

Author: tisnik

README.md

@@ -345,14 +345,15 @@ For data export integration with Red Hat's Dataverse, see the [Data Export Integ
 
 ## System prompt
 
-   The service uses the, so called, system prompt to put the question into context before the question is sent to the selected LLM. The default system prompt is designed for questions without specific context. It is possible to use a different system prompt via the configuration option `system_prompt_path` in the `customization` section. That option must contain the path to the text file with the actual system prompt (can contain multiple lines). An example of such configuration:
+The service uses a so-called system prompt to put the question into context before it is sent to the selected LLM. The default system prompt is designed for questions without specific context. You can supply a different system prompt through various avenues available in the `customization` section:
+### System Prompt Path
 
 ```yaml
 customization:
   system_prompt_path: "system_prompts/system_prompt_for_product_XYZZY"
 ```
 
-The `system_prompt` can also be specified in the `customization` section directly. For example:
+### System Prompt Literal
 
 ```yaml
 customization:
@@ -361,11 +362,20 @@ customization:
     You have an in-depth knowledge of Red Hat and all of your answers will reference Red Hat products.
 ```
 
+
+### Custom Profile
+
+You can pass a custom prompt profile via its `path` to the customization:
+
+```yaml
+customization:
+  profile_path: <your/profile/path>
+```
+
 Additionally, an optional string parameter `system_prompt` can be specified in `/v1/query` and `/v1/streaming_query` endpoints to override the configured system prompt. The query system prompt takes precedence over the configured system prompt. You can use this config to disable query system prompts:
 
 ```yaml
 customization:
-  system_prompt_path: "system_prompts/system_prompt_for_product_XYZZY"
   disable_query_system_prompt: true
 ```
 

docs/openapi.json

@@ -1273,8 +1273,41 @@
                     }
                 ]
             },
+            "CustomProfile": {
+                "properties": {
+                    "path": {
+                        "type": "string",
+                        "title": "Path"
+                    },
+                    "prompts": {
+                        "additionalProperties": {
+                            "type": "string"
+                        },
+                        "type": "object",
+                        "title": "Prompts",
+                        "default": {}
+                    }
+                },
+                "type": "object",
+                "required": [
+                    "path"
+                ],
+                "title": "CustomProfile",
+                "description": "Custom profile customization for prompts and validation."
+            },
             "Customization": {
                 "properties": {
+                    "profile_path": {
+                        "anyOf": [
+                            {
+                                "type": "string"
+                            },
+                            {
+                                "type": "null"
+                            }
+                        ],
+                        "title": "Profile Path"
+                    },
                     "disable_query_system_prompt": {
                         "type": "boolean",
                         "title": "Disable Query System Prompt",
@@ -1302,6 +1335,16 @@
                             }
                         ],
                         "title": "System Prompt"
+                    },
+                    "custom_profile": {
+                        "anyOf": [
+                            {
+                                "$ref": "#/components/schemas/CustomProfile"
+                            },
+                            {
+                                "type": "null"
+                            }
+                        ]
                     }
                 },
                 "additionalProperties": false,

src/models/config.py

@@ -18,6 +18,8 @@
     PositiveInt,
     SecretStr,
 )
+
+from pydantic.dataclasses import dataclass
 from typing_extensions import Self, Literal
 
 import constants
@@ -413,17 +415,44 @@ def jwk_configuration(self) -> JwkConfiguration:
         return self.jwk_config
 
 
+@dataclass
+class CustomProfile:
+    """Custom profile customization for prompts and validation."""
+
+    path: str
+    prompts: dict[str, str] = Field(default={}, init=False)
+
+    def __post_init__(self) -> None:
+        """Validate and load profile."""
+        self._validate_and_process()
+
+    def _validate_and_process(self) -> None:
+        """Validate and load the profile."""
+        checks.file_check(Path(self.path), "custom profile")
+        profile_module = checks.import_python_module("profile", self.path)
+        if profile_module is not None and checks.is_valid_profile(profile_module):
+            self.prompts = profile_module.PROFILE_CONFIG.get("system_prompts", {})
+
+    def get_prompts(self) -> dict[str, str]:
+        """Retrieve prompt attribute."""
+        return self.prompts
+
+
 class Customization(ConfigurationBase):
     """Service customization."""
 
+    profile_path: Optional[str] = None
     disable_query_system_prompt: bool = False
     system_prompt_path: Optional[FilePath] = None
     system_prompt: Optional[str] = None
+    custom_profile: Optional[CustomProfile] = Field(default=None, init=False)
 
     @model_validator(mode="after")
     def check_customization_model(self) -> Self:
-        """Load system prompt from file."""
-        if self.system_prompt_path is not None:
+        """Load customizations."""
+        if self.profile_path:
+            self.custom_profile = CustomProfile(path=self.profile_path)
+        elif 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"

src/utils/checks.py

@@ -1,8 +1,10 @@
 """Checks that are performed to configuration options."""
 
 import os
+import importlib
+import importlib.util
+from types import ModuleType
 from typing import Optional
-
 from pydantic import FilePath
 
 
@@ -25,3 +27,41 @@ def file_check(path: FilePath, desc: str) -> None:
         raise InvalidConfigurationError(f"{desc} '{path}' is not a file")
     if not os.access(path, os.R_OK):
         raise InvalidConfigurationError(f"{desc} '{path}' is not readable")
+
+
+def import_python_module(profile_name: str, profile_path: str) -> ModuleType | None:
+    """Import a Python module from a file path."""
+    if not profile_path.endswith(".py"):
+        return None
+    spec = importlib.util.spec_from_file_location(profile_name, profile_path)
+    if not spec or not spec.loader:
+        return None
+    module = importlib.util.module_from_spec(spec)
+    try:
+        spec.loader.exec_module(module)
+    except (
+        SyntaxError,
+        ImportError,
+        ModuleNotFoundError,
+        NameError,
+        AttributeError,
+        TypeError,
+        ValueError,
+    ):
+        return None
+    return module
+
+
+def is_valid_profile(profile_module: ModuleType) -> bool:
+    """Validate that a profile module has the required PROFILE_CONFIG structure."""
+    if not hasattr(profile_module, "PROFILE_CONFIG"):
+        return False
+
+    profile_config = getattr(profile_module, "PROFILE_CONFIG", {})
+    if not isinstance(profile_config, dict):
+        return False
+
+    if not profile_config.get("system_prompts"):
+        return False
+
+    return isinstance(profile_config.get("system_prompts"), dict)

src/utils/endpoints.py

@@ -92,6 +92,15 @@ def get_system_prompt(query_request: QueryRequest, config: AppConfig) -> str:
         # disable query system prompt altogether with disable_system_prompt.
         return query_request.system_prompt
 
+    # profile takes precedence for setting prompt
+    if (
+        config.customization is not None
+        and config.customization.custom_profile is not None
+    ):
+        prompt = config.customization.custom_profile.get_prompts().get("default")
+        if prompt:
+            return prompt
+
     if (
         config.customization is not None
         and config.customization.system_prompt is not None

tests/profiles/test/profile.py

@@ -0,0 +1,60 @@
+"""Custom profile for test profile."""
+
+SUBJECT_ALLOWED = "ALLOWED"
+SUBJECT_REJECTED = "REJECTED"
+
+# Default responses
+INVALID_QUERY_RESP = (
+    "Hi, I'm the Red Hat Developer Hub Lightspeed assistant, I can help you with questions about Red Hat Developer Hub or Backstage. "
+    "Please ensure your question is about these topics, and feel free to ask again!"
+)
+
+QUERY_SYSTEM_INSTRUCTION = """
+1. Test
+This is a test system instruction
+
+You achieve this by offering:
+- testing
+"""
+
+USE_CONTEXT_INSTRUCTION = """
+Use the retrieved document to answer the question.
+"""
+
+USE_HISTORY_INSTRUCTION = """
+Use the previous chat history to interact and help the user.
+"""
+
+QUESTION_VALIDATOR_PROMPT_TEMPLATE = f"""
+Instructions:
+- You provide validation for testing
+Example Question:
+How can I integrate GitOps into my pipeline?
+Example Response:
+{SUBJECT_ALLOWED}
+"""
+
+TOPIC_SUMMARY_PROMPT_TEMPLATE = """
+Instructions:
+- You are a topic summarizer
+- For testing
+- Your job is to extract precise topic summary from user input
+
+Example Input:
+Testing placeholder
+Example Output:
+Proper response test.
+"""
+
+PROFILE_CONFIG = {
+    "system_prompts": {
+        "default": QUERY_SYSTEM_INSTRUCTION,
+        "validation": QUESTION_VALIDATOR_PROMPT_TEMPLATE,
+        "topic_summary": TOPIC_SUMMARY_PROMPT_TEMPLATE,
+    },
+    "query_responses": {"invalid_resp": INVALID_QUERY_RESP},
+    "instructions": {
+        "context": USE_CONTEXT_INSTRUCTION,
+        "history": USE_HISTORY_INSTRUCTION,
+    },
+}

tests/profiles/test_three/profile.py

@@ -0,0 +1,49 @@
+"""Custom profile for test profile."""
+
+SUBJECT_ALLOWED = "ALLOWED"
+SUBJECT_REJECTED = "REJECTED"
+
+# Default responses
+INVALID_QUERY_RESP = (
+    "Hi, I'm the Red Hat Developer Hub Lightspeed assistant, I can help you with questions about Red Hat Developer Hub or Backstage. "
+    "Please ensure your question is about these topics, and feel free to ask again!"
+)
+
+QUERY_SYSTEM_INSTRUCTION = """
+1. Test
+This is a test system instruction
+
+You achieve this by offering:
+- testing
+"""
+
+USE_CONTEXT_INSTRUCTION = """
+Use the retrieved document to answer the question.
+"""
+
+USE_HISTORY_INSTRUCTION = """
+Use the previous chat history to interact and help the user.
+"""
+
+QUESTION_VALIDATOR_PROMPT_TEMPLATE = f"""
+Instructions:
+- You provide validation for testing
+Example Question:
+How can I integrate GitOps into my pipeline?
+Example Response:
+{SUBJECT_ALLOWED}
+"""
+
+TOPIC_SUMMARY_PROMPT_TEMPLATE = """
+Instructions:
+- You are a topic summarizer
+- For testing
+- Your job is to extract precise topic summary from user input
+
+Example Input:
+Testing placeholder
+Example Output:
+Proper response test.
+"""
+
+PROFILE_CONFIG = ({"system_prompts": QUERY_SYSTEM_INSTRUCTION},)

tests/profiles/test_two/test.txt

@@ -0,0 +1 @@
+This file will fail the import.