Add scaffolding for role explanation endpoint

Author: mabashian

README-ANSIBLE_AI_MODEL_MESH_CONFIG.md

@@ -31,6 +31,11 @@ ANSIBLE_AI_MODEL_MESH_CONFIG="{
         "config": {
             "inference_url": "http://host.containers.internal:11434",
             "model_id": "mistral:instruct"}},
+    "ModelPipelineRoleExplanation": {
+        "provider": "ollama",
+        "config": {
+            "inference_url": "http://host.containers.internal:11434",
+            "model_id": "mistral:instruct"}},
     "ModelPipelineChatBot": {
         "provider": "http",
         "config": {

ansible_ai_connect/ai/api/model_pipelines/README.md

@@ -35,6 +35,7 @@ Implementations of a pipeline, for a particular provider, for a particular featu
 - `ModelPipelinePlaybookGeneration`
 - `ModelPipelineRoleGeneration`
 - `ModelPipelinePlaybookExplanation`
+- `ModelPipelineRoleExplanation`
 - `ModelPipelineChatBot`
 
 ### Registering pipelines
@@ -74,6 +75,7 @@ REGISTRY = {
         ModelPipelinePlaybookGeneration: <Implementing class>
         ModelPipelineRoleGeneration: <Implementing class>
         ModelPipelinePlaybookExplanation: <Implementing class>
+        ModelPipelineRoleExplanation: <Implementing class>
         ModelPipelineChatBot: <Implementing class>
         PipelineConfiguration: <Implementing class>
         Serializer: <Implementing class>

ansible_ai_connect/ai/api/model_pipelines/dummy/pipelines.py

@@ -30,11 +30,14 @@
     ModelPipelineCompletions,
     ModelPipelinePlaybookExplanation,
     ModelPipelinePlaybookGeneration,
+    ModelPipelineRoleExplanation,
     ModelPipelineRoleGeneration,
     PlaybookExplanationParameters,
     PlaybookExplanationResponse,
     PlaybookGenerationParameters,
     PlaybookGenerationResponse,
+    RoleExplanationParameters,
+    RoleExplanationResponse,
     RoleGenerationParameters,
     RoleGenerationResponse,
 )
@@ -200,3 +203,16 @@ def invoke(self, params: PlaybookExplanationParameters) -> PlaybookExplanationRe
 
     def self_test(self) -> Optional[HealthCheckSummary]:
         raise NotImplementedError
+
+
+@Register(api_type="dummy")
+class DummyRoleExplanationPipeline(DummyMetaData, ModelPipelineRoleExplanation[DummyConfiguration]):
+
+    def __init__(self, config: DummyConfiguration):
+        super().__init__(config=config)
+
+    def invoke(self, params: RoleExplanationParameters) -> RoleExplanationResponse:
+        return EXPLANATION
+
+    def self_test(self) -> Optional[HealthCheckSummary]:
+        raise NotImplementedError

ansible_ai_connect/ai/api/model_pipelines/dummy/tests/test_factory.py

@@ -18,6 +18,7 @@
     DummyCompletionsPipeline,
     DummyPlaybookExplanationPipeline,
     DummyPlaybookGenerationPipeline,
+    DummyRoleExplanationPipeline,
     DummyRoleGenerationPipeline,
 )
 from ansible_ai_connect.ai.api.model_pipelines.nop.pipelines import (
@@ -30,6 +31,7 @@
     ModelPipelineContentMatch,
     ModelPipelinePlaybookExplanation,
     ModelPipelinePlaybookGeneration,
+    ModelPipelineRoleExplanation,
     ModelPipelineRoleGeneration,
 )
 from ansible_ai_connect.ai.api.model_pipelines.tests import mock_config
@@ -62,5 +64,10 @@ def test_playbook_explanation_pipeline(self):
             ModelPipelinePlaybookExplanation, DummyPlaybookExplanationPipeline
         )
 
+    def test_role_explanation_pipeline(self):
+        self.assert_concrete_implementation(
+            ModelPipelineRoleExplanation, DummyRoleExplanationPipeline
+        )
+
     def test_chatbot_pipeline(self):
         self.assert_default_implementation(ModelPipelineChatBot, NopChatBotPipeline)

ansible_ai_connect/ai/api/model_pipelines/grpc/tests/test_factory.py

@@ -22,6 +22,7 @@
     NopContentMatchPipeline,
     NopPlaybookExplanationPipeline,
     NopPlaybookGenerationPipeline,
+    NopRoleExplanationPipeline,
     NopRoleGenerationPipeline,
 )
 from ansible_ai_connect.ai.api.model_pipelines.pipelines import (
@@ -30,6 +31,7 @@
     ModelPipelineContentMatch,
     ModelPipelinePlaybookExplanation,
     ModelPipelinePlaybookGeneration,
+    ModelPipelineRoleExplanation,
     ModelPipelineRoleGeneration,
 )
 from ansible_ai_connect.ai.api.model_pipelines.tests import mock_config
@@ -60,5 +62,8 @@ def test_playbook_explanation_pipeline(self):
             ModelPipelinePlaybookExplanation, NopPlaybookExplanationPipeline
         )
 
+    def test_role_explanation_pipeline(self):
+        self.assert_default_implementation(ModelPipelineRoleExplanation, NopRoleExplanationPipeline)
+
     def test_chatbot_pipeline(self):
         self.assert_default_implementation(ModelPipelineChatBot, NopChatBotPipeline)

ansible_ai_connect/ai/api/model_pipelines/http/tests/test_factory.py

@@ -22,6 +22,7 @@
     NopContentMatchPipeline,
     NopPlaybookExplanationPipeline,
     NopPlaybookGenerationPipeline,
+    NopRoleExplanationPipeline,
     NopRoleGenerationPipeline,
 )
 from ansible_ai_connect.ai.api.model_pipelines.pipelines import (
@@ -30,6 +31,7 @@
     ModelPipelineContentMatch,
     ModelPipelinePlaybookExplanation,
     ModelPipelinePlaybookGeneration,
+    ModelPipelineRoleExplanation,
     ModelPipelineRoleGeneration,
 )
 from ansible_ai_connect.ai.api.model_pipelines.tests import mock_config
@@ -60,5 +62,8 @@ def test_playbook_explanation_pipeline(self):
             ModelPipelinePlaybookExplanation, NopPlaybookExplanationPipeline
         )
 
+    def test_role_explanation_pipeline(self):
+        self.assert_default_implementation(ModelPipelineRoleExplanation, NopRoleExplanationPipeline)
+
     def test_chatbot_pipeline(self):
         self.assert_concrete_implementation(ModelPipelineChatBot, HttpChatBotPipeline)

ansible_ai_connect/ai/api/model_pipelines/langchain/pipelines.py

@@ -40,11 +40,14 @@
     ModelPipelineCompletions,
     ModelPipelinePlaybookExplanation,
     ModelPipelinePlaybookGeneration,
+    ModelPipelineRoleExplanation,
     ModelPipelineRoleGeneration,
     PlaybookExplanationParameters,
     PlaybookExplanationResponse,
     PlaybookGenerationParameters,
     PlaybookGenerationResponse,
+    RoleExplanationParameters,
+    RoleExplanationResponse,
     RoleGenerationParameters,
     RoleGenerationResponse,
 )
@@ -443,3 +446,21 @@ def self_test(self) -> Optional[HealthCheckSummary]:
 
     def get_chat_model(self, model_id):
         raise NotImplementedError
+
+
+class LangchainRoleExplanationPipeline(
+    LangchainBase[
+        LANGCHAIN_PIPELINE_CONFIGURATION, RoleExplanationParameters, RoleExplanationResponse
+    ],
+    ModelPipelineRoleExplanation[LANGCHAIN_PIPELINE_CONFIGURATION],
+    Generic[LANGCHAIN_PIPELINE_CONFIGURATION],
+):
+
+    def __init__(self, config: LANGCHAIN_PIPELINE_CONFIGURATION):
+        super().__init__(config=config)
+
+    def self_test(self) -> Optional[HealthCheckSummary]:
+        raise NotImplementedError
+
+    def invoke(self, params: RoleExplanationParameters) -> RoleExplanationResponse:
+        raise NotImplementedError

ansible_ai_connect/ai/api/model_pipelines/llamacpp/tests/test_factory.py

@@ -22,6 +22,7 @@
     NopContentMatchPipeline,
     NopPlaybookExplanationPipeline,
     NopPlaybookGenerationPipeline,
+    NopRoleExplanationPipeline,
     NopRoleGenerationPipeline,
 )
 from ansible_ai_connect.ai.api.model_pipelines.pipelines import (
@@ -30,6 +31,7 @@
     ModelPipelineContentMatch,
     ModelPipelinePlaybookExplanation,
     ModelPipelinePlaybookGeneration,
+    ModelPipelineRoleExplanation,
     ModelPipelineRoleGeneration,
 )
 from ansible_ai_connect.ai.api.model_pipelines.tests import mock_config
@@ -60,5 +62,8 @@ def test_playbook_explanation_pipeline(self):
             ModelPipelinePlaybookExplanation, NopPlaybookExplanationPipeline
         )
 
+    def test_role_explanation_pipeline(self):
+        self.assert_default_implementation(ModelPipelineRoleExplanation, NopRoleExplanationPipeline)
+
     def test_chatbot_pipeline(self):
         self.assert_default_implementation(ModelPipelineChatBot, NopChatBotPipeline)

ansible_ai_connect/ai/api/model_pipelines/nop/pipelines.py

@@ -27,11 +27,14 @@
     ModelPipelineContentMatch,
     ModelPipelinePlaybookExplanation,
     ModelPipelinePlaybookGeneration,
+    ModelPipelineRoleExplanation,
     ModelPipelineRoleGeneration,
     PlaybookExplanationParameters,
     PlaybookExplanationResponse,
     PlaybookGenerationParameters,
     PlaybookGenerationResponse,
+    RoleExplanationParameters,
+    RoleExplanationResponse,
     RoleGenerationParameters,
     RoleGenerationResponse,
 )
@@ -116,6 +119,19 @@ def self_test(self) -> Optional[HealthCheckSummary]:
         raise NotImplementedError
 
 
+@Register(api_type="nop")
+class NopRoleExplanationPipeline(NopMetaData, ModelPipelineRoleExplanation[NopConfiguration]):
+
+    def __init__(self, config: NopConfiguration):
+        super().__init__(config=config)
+
+    def invoke(self, params: RoleExplanationParameters) -> RoleExplanationResponse:
+        raise NotImplementedError
+
+    def self_test(self) -> Optional[HealthCheckSummary]:
+        raise NotImplementedError
+
+
 @Register(api_type="nop")
 class NopChatBotPipeline(NopMetaData, ModelPipelineChatBot[NopConfiguration]):
 

ansible_ai_connect/ai/api/model_pipelines/ollama/pipelines.py

@@ -21,6 +21,7 @@
     LangchainMetaData,
     LangchainPlaybookExplanationPipeline,
     LangchainPlaybookGenerationPipeline,
+    LangchainRoleExplanationPipeline,
     LangchainRoleGenerationPipeline,
 )
 from ansible_ai_connect.ai.api.model_pipelines.ollama.configuration import (
@@ -80,6 +81,19 @@ def get_chat_model(self, model_id):
         )
 
 
+@Register(api_type="ollama")
+class OllamaRoleExplanationPipeline(LangchainRoleExplanationPipeline[OllamaConfiguration]):
+
+    def __init__(self, config: OllamaConfiguration):
+        super().__init__(config=config)
+
+    def get_chat_model(self, model_id):
+        return OllamaLLM(
+            base_url=self.config.inference_url,
+            model=model_id,
+        )
+
+
 @Register(api_type="ollama")
 class OllamaPlaybookExplanationPipeline(LangchainPlaybookExplanationPipeline[OllamaConfiguration]):
 

ansible_ai_connect/ai/api/model_pipelines/ollama/tests/test_factory.py

@@ -22,13 +22,15 @@
     OllamaCompletionsPipeline,
     OllamaPlaybookExplanationPipeline,
     OllamaPlaybookGenerationPipeline,
+    OllamaRoleExplanationPipeline,
 )
 from ansible_ai_connect.ai.api.model_pipelines.pipelines import (
     ModelPipelineChatBot,
     ModelPipelineCompletions,
     ModelPipelineContentMatch,
     ModelPipelinePlaybookExplanation,
     ModelPipelinePlaybookGeneration,
+    ModelPipelineRoleExplanation,
 )
 from ansible_ai_connect.ai.api.model_pipelines.tests import mock_config
 from ansible_ai_connect.ai.api.model_pipelines.tests.test_factory import (
@@ -55,5 +57,10 @@ def test_playbook_explanation_pipeline(self):
             ModelPipelinePlaybookExplanation, OllamaPlaybookExplanationPipeline
         )
 
+    def test_role_explanation_pipeline(self):
+        self.assert_concrete_implementation(
+            ModelPipelineRoleExplanation, OllamaRoleExplanationPipeline
+        )
+
     def test_chatbot_pipeline(self):
         self.assert_default_implementation(ModelPipelineChatBot, NopChatBotPipeline)

ansible_ai_connect/ai/api/model_pipelines/pipelines.py

@@ -184,6 +184,35 @@ def init(
 PlaybookExplanationResponse = str
 
 
+@define
+class RoleExplanationParameters:
+    request: Request
+    files: list
+    role_name: str
+    model_id: str
+    focus_on_file: str
+
+    @classmethod
+    def init(
+        cls,
+        request,
+        files: list = [],
+        role_name: str = "",
+        model_id: str = "",
+        focus_on_file: str = "",
+    ):
+        return cls(
+            request=request,
+            files=files,
+            role_name=role_name,
+            model_id=model_id,
+            focus_on_file=focus_on_file,
+        )
+
+
+RoleExplanationResponse = str
+
+
 @define
 class ChatBotParameters:
     query: str
@@ -326,6 +355,20 @@ def alias():
         return "playbook-explanation"
 
 
+class ModelPipelineRoleExplanation(
+    ModelPipeline[PIPELINE_CONFIGURATION, RoleExplanationParameters, RoleExplanationResponse],
+    Generic[PIPELINE_CONFIGURATION],
+    metaclass=ABCMeta,
+):
+
+    def __init__(self, config: PIPELINE_CONFIGURATION):
+        super().__init__(config=config)
+
+    @staticmethod
+    def alias():
+        return "role-explanation"
+
+
 class ModelPipelineChatBot(
     ModelPipeline[PIPELINE_CONFIGURATION, ChatBotParameters, ChatBotResponse],
     Generic[PIPELINE_CONFIGURATION],

ansible_ai_connect/ai/api/model_pipelines/registry.py

@@ -28,6 +28,7 @@
     ModelPipelineContentMatch,
     ModelPipelinePlaybookExplanation,
     ModelPipelinePlaybookGeneration,
+    ModelPipelineRoleExplanation,
     ModelPipelineRoleGeneration,
 )
 from ansible_ai_connect.main.settings.types import t_model_mesh_api_type
@@ -42,6 +43,7 @@
         ModelPipelinePlaybookGeneration,
         ModelPipelineRoleGeneration,
         ModelPipelinePlaybookExplanation,
+        ModelPipelineRoleExplanation,
         ModelPipelineChatBot,
         PipelineConfiguration,
         Serializer,

ansible_ai_connect/ai/api/model_pipelines/tests/test_factory.py

@@ -21,13 +21,15 @@
     NopContentMatchPipeline,
     NopPlaybookExplanationPipeline,
     NopPlaybookGenerationPipeline,
+    NopRoleExplanationPipeline,
 )
 from ansible_ai_connect.ai.api.model_pipelines.pipelines import (
     PIPELINE_TYPE,
     MetaData,
     ModelPipelineContentMatch,
     ModelPipelinePlaybookExplanation,
     ModelPipelinePlaybookGeneration,
+    ModelPipelineRoleExplanation,
 )
 from ansible_ai_connect.ai.api.model_pipelines.tests import mock_config
 from ansible_ai_connect.test_utils import WisdomServiceAPITestCaseBaseOIDC
@@ -91,6 +93,20 @@ def test_default_fallback_playbook_explanation(self):
                 log,
             )
 
+    # 'grpc' does not have a Role Explanation pipeline
+    @override_settings(ANSIBLE_AI_MODEL_MESH_CONFIG=mock_config("grpc"))
+    def test_default_fallback_role_explanation(self):
+        factory = ModelPipelineFactory()
+
+        with self.assertLogs(logger="root", level="INFO") as log:
+            pipeline = factory.get_pipeline(ModelPipelineRoleExplanation)
+            self.assertIsNotNone(pipeline)
+            self.assertIsInstance(pipeline, NopRoleExplanationPipeline)
+            self.assertInLog(
+                "Using NOP implementation for 'ModelPipelineRoleExplanation'.",
+                log,
+            )
+
 
 class TestModelPipelineFactoryImplementations(WisdomServiceAPITestCaseBaseOIDC):
     def assert_concrete_implementation(self, pipeline_type: Type[PIPELINE_TYPE], expected_cls):