introudce chatbot client skeleton

Author: matusdrobuliak66

services/web/server/src/simcore_service_webserver/application.py

@@ -36,7 +36,6 @@
 from .dynamic_scheduler.plugin import setup_dynamic_scheduler
 from .email.plugin import setup_email
 from .exporter.plugin import setup_exporter
-from .fogbugz.plugin import setup_fogbugz
 from .folders.plugin import setup_folders
 from .functions.plugin import setup_functions
 from .garbage_collector.plugin import setup_garbage_collector
@@ -175,7 +174,6 @@ def create_application(tracing_config: TracingConfig) -> web.Application:
     setup_projects(app)
 
     # conversations
-    setup_fogbugz(app)  # Needed for support conversations
     setup_conversations(app)
 
     # licenses

services/web/server/src/simcore_service_webserver/application_settings.py

@@ -32,6 +32,7 @@
 from ._meta import API_VERSION, API_VTAG, APP_NAME
 from .application_keys import APP_SETTINGS_APPKEY
 from .catalog.settings import CatalogSettings
+from .chatbot.settings import ChatbotSettings
 from .collaboration.settings import RealTimeCollaborationSettings
 from .diagnostics.settings import DiagnosticsSettings
 from .director_v2.settings import DirectorV2Settings
@@ -260,6 +261,13 @@ class ApplicationSettings(BaseApplicationSettings, MixinLoggingSettings):
         ),
     ]
 
+    WEBSERVER_CHATBOT: Annotated[
+        ChatbotSettings | None,
+        Field(
+            json_schema_extra={"auto_default_from_env": True},
+        ),
+    ]
+
     WEBSERVER_GARBAGE_COLLECTOR: Annotated[
         GarbageCollectorSettings | None,
         Field(

services/web/server/src/simcore_service_webserver/chatbot/__init__.py

@@ -1,8 +1,7 @@
 # mypy: disable-error-code=truthy-function
-from ._client import ChatbotQuestionCreate, ChatbotRestClient, get_chatbot_rest_client
+from ._client import ChatbotRestClient, get_chatbot_rest_client
 
 __all__ = [
     "get_chatbot_rest_client",
-    "ChatbotQuestionCreate",
     "ChatbotRestClient",
 ]

services/web/server/src/simcore_service_webserver/chatbot/_client.py

@@ -9,7 +9,7 @@
 
 import httpx
 from aiohttp import web
-from pydantic import AnyUrl, BaseModel, Field
+from pydantic import BaseModel, Field
 from servicelib.aiohttp import status
 from tenacity import (
     retry,
@@ -23,14 +23,12 @@
 
 _logger = logging.getLogger(__name__)
 
+
 _JSON_CONTENT_TYPE = "application/json"
-_UNKNOWN_ERROR_MESSAGE = "Unknown error occurred"
 
 
-class ChatbotQuestionCreate(BaseModel):
-    fogbugz_project_id: int = Field(description="Project ID in Fogbugz")
-    title: str = Field(description="Case title")
-    description: str = Field(description="Case description/first comment")
+class ChatResponse(BaseModel):
+    answer: str = Field(description="Answer from the chatbot")
 
 
 def _should_retry(response: httpx.Response | None) -> bool:
@@ -42,33 +40,36 @@ def _should_retry(response: httpx.Response | None) -> bool:
     )
 
 
+def _chatbot_retry():
+    """Retry configuration for chatbot API calls"""
+    return retry(
+        retry=(
+            retry_if_result(_should_retry)
+            | retry_if_exception_type(
+                (
+                    httpx.ConnectError,
+                    httpx.TimeoutException,
+                    httpx.NetworkError,
+                    httpx.ProtocolError,
+                )
+            )
+        ),
+        stop=stop_after_attempt(3),
+        wait=wait_exponential(multiplier=1, min=1, max=10),
+        reraise=True,
+    )
+
+
 class ChatbotRestClient:
-    def __init__(self, host: AnyUrl, port: int) -> None:
+    def __init__(self, base_url: str) -> None:
         self._client = httpx.AsyncClient()
-        self.host = host
-        self.port = port
-        self._base_url = f"{self.host}:{self.port}"
+        self._base_url = base_url
 
     async def get_settings(self) -> dict[str, Any]:
         """Fetches chatbot settings"""
         url = urljoin(f"{self._base_url}", "/v1/chat/settings")
 
-        @retry(
-            retry=(
-                retry_if_result(_should_retry)
-                | retry_if_exception_type(
-                    (
-                        httpx.ConnectError,
-                        httpx.TimeoutException,
-                        httpx.NetworkError,
-                        httpx.ProtocolError,
-                    )
-                )
-            ),
-            stop=stop_after_attempt(3),
-            wait=wait_exponential(multiplier=1, min=1, max=10),
-            reraise=True,
-        )
+        @_chatbot_retry()
         async def _request() -> httpx.Response:
             return await self._client.get(url)
 
@@ -83,6 +84,36 @@ async def _request() -> httpx.Response:
             )
             raise
 
+    async def ask_question(self, question: str) -> ChatResponse:
+        """Asks a question to the chatbot"""
+        url = urljoin(f"{self._base_url}", "/v1/chat")
+
+        @_chatbot_retry()
+        async def _request() -> httpx.Response:
+            return await self._client.post(
+                url,
+                json={
+                    "question": question,
+                    "llm": "gpt-3.5-turbo",
+                    "embedding_model": "openai/text-embedding-3-large",
+                },
+                headers={
+                    "Content-Type": _JSON_CONTENT_TYPE,
+                    "Accept": _JSON_CONTENT_TYPE,
+                },
+            )
+
+        try:
+            response = await _request()
+            response.raise_for_status()
+            response_data: dict[str, Any] = response.json()
+            return ChatResponse(**response_data)
+        except Exception:
+            _logger.error(  # noqa: TRY400
+                "Failed to ask question to chatbot at %s", url
+            )
+            raise
+
     async def __aenter__(self):
         """Async context manager entry"""
         return self
@@ -96,9 +127,9 @@ async def __aexit__(self, exc_type, exc_val, exc_tb):
 
 
 async def setup_chatbot_rest_client(app: web.Application) -> None:
-    settings = get_plugin_settings(app)
+    chatbot_settings = get_plugin_settings(app)
 
-    client = ChatbotRestClient(host=settings.CHATBOT_HOST, port=settings.CHATBOT_PORT)
+    client = ChatbotRestClient(base_url=chatbot_settings.base_url)
 
     app[_APPKEY] = client
 

services/web/server/src/simcore_service_webserver/chatbot/settings.py

@@ -1,14 +1,25 @@
+from functools import cached_property
+
 from aiohttp import web
-from pydantic import AnyUrl
 from settings_library.base import BaseCustomSettings
+from settings_library.utils_service import MixinServiceSettings, URLPart
 
 from ..application_keys import APP_SETTINGS_APPKEY
 
 
-class ChatbotSettings(BaseCustomSettings):
-    CHATBOT_HOST: AnyUrl
+class ChatbotSettings(BaseCustomSettings, MixinServiceSettings):
+    CHATBOT_HOST: str
     CHATBOT_PORT: int
 
+    @cached_property
+    def base_url(self) -> str:
+        # http://chatbot:8000/v1
+        return self._compose_url(
+            prefix="CHATBOT",
+            port=URLPart.REQUIRED,
+            vtag=URLPart.EXCLUDE,
+        )
+
 
 def get_plugin_settings(app: web.Application) -> ChatbotSettings:
     settings = app[APP_SETTINGS_APPKEY].WEBSERVER_CHATBOT

services/web/server/src/simcore_service_webserver/conversations/plugin.py

@@ -6,6 +6,7 @@
 
 from ..application_keys import APP_SETTINGS_APPKEY
 from ..application_setup import ModuleCategory, app_setup_func
+from ..chatbot.plugin import setup_chatbot
 from ..fogbugz.plugin import setup_fogbugz
 from ._controller import _conversations_messages_rest, _conversations_rest
 
@@ -23,6 +24,7 @@ def setup_conversations(app: web.Application):
     assert app[APP_SETTINGS_APPKEY].WEBSERVER_CONVERSATIONS  # nosec
 
     setup_fogbugz(app)
+    setup_chatbot(app)
 
     app.router.add_routes(_conversations_rest.routes)
     app.router.add_routes(_conversations_messages_rest.routes)

services/web/server/tests/unit/with_dbs/04/test_chatbot_client.py

@@ -0,0 +1,74 @@
+# pylint: disable=redefined-outer-name
+# pylint: disable=unused-argument
+# pylint: disable=unused-variable
+# pylint: disable=too-many-arguments
+# pylint: disable=too-many-statements
+
+from collections.abc import Iterator
+
+import httpx
+import pytest
+import respx
+from aiohttp.test_utils import TestClient
+from pytest_mock import MockerFixture
+from pytest_simcore.helpers.monkeypatch_envs import setenvs_from_dict
+from pytest_simcore.helpers.typing_env import EnvVarsDict
+from simcore_service_webserver.chatbot._client import (
+    ChatResponse,
+    get_chatbot_rest_client,
+)
+from simcore_service_webserver.chatbot.settings import ChatbotSettings
+
+
+@pytest.fixture
+def app_environment(
+    monkeypatch: pytest.MonkeyPatch,
+    app_environment: EnvVarsDict,
+    mocker: MockerFixture,
+):
+    return app_environment | setenvs_from_dict(
+        monkeypatch,
+        {
+            "CHATBOT_HOST": "chatbot",
+            "CHATBOT_PORT": "8000",
+        },
+    )
+
+
+@pytest.fixture
+def mocked_chatbot_api() -> Iterator[respx.MockRouter]:
+    _BASE_URL = "http://chatbot:8000"
+
+    # Define responses in the order they will be called during the test
+    chatbot_answer_responses = [
+        {"answer": "42"},
+    ]
+
+    with respx.mock(base_url=_BASE_URL) as mock:
+        # Create a side_effect that returns responses in sequence
+        mock.post(path="/v1/chat").mock(
+            side_effect=[
+                httpx.Response(200, json=response)
+                for response in chatbot_answer_responses
+            ]
+        )
+        yield mock
+
+
+async def test_chatbot_client(
+    app_environment: EnvVarsDict,
+    client: TestClient,
+    mocked_chatbot_api: respx.MockRouter,
+):
+    assert client.app
+
+    settings = ChatbotSettings.create_from_envs()
+    assert settings.CHATBOT_HOST
+    assert settings.CHATBOT_PORT
+
+    chatbot_client = get_chatbot_rest_client(client.app)
+    assert chatbot_client
+
+    output = await chatbot_client.ask_question("What is the meaning of life?")
+    assert isinstance(output, ChatResponse)
+    assert output.answer == "42"