Merge branch 'main' into feat_add_human_in_the_loop_agent

# Please enter a commit message to explain why this merge is necessary,
# especially if it merges an updated upstream into a topic branch.
#
# Lines starting with '#' will be ignored, and an empty message aborts
# the commit.

Author: MRGuziX

agents/crewai/websearch_agent/Dockerfile

@@ -19,8 +19,10 @@ COPY src/ ./src/
 # Install the project and its dependencies using uv
 RUN uv pip install --system --no-cache .
 
-# Copy the application entrypoint
+# Copy the application entrypoint, playground UI, and images
 COPY main.py .
+COPY playground/ ./playground/
+COPY images/ ./images/
 
 # Pre-create the directory that CrewAI writes to at import time
 # (crewai.utilities.paths.db_storage_path -> ~/.local/share/app/)

agents/crewai/websearch_agent/README.md

@@ -201,6 +201,52 @@ curl -sN -X POST https://<YOUR_ROUTE_URL>/chat/completions \
 
 ---
 
+## Playground UI
+
+A browser-based chat interface is served directly by the agent at the root URL — no separate process needed.
+
+### Running the Playground
+
+Start the agent and open the root URL in your browser:
+
+```bash
+uvicorn main:app --port 8000
+```
+
+Open [http://localhost:8000](http://localhost:8000) in your browser.
+
+A green dot in the header means the agent is connected and ready. Type a message and press **Enter** to send.
+
+When deployed to OpenShift, the playground is available at the route URL.
+
+### Standalone Flask Playground (alternative)
+
+You can also run the playground as a separate Flask app if needed:
+
+```bash
+uv pip install flask
+```
+
+```bash
+# Terminal 1: Start the agent
+uvicorn main:app --port 8000
+
+# Terminal 2: Start the playground
+flask --app playground/app run --port 5001
+```
+
+| Variable    | Default                  | Description                     |
+|-------------|--------------------------|---------------------------------|
+| `AGENT_URL` | `http://localhost:8000`  | URL of the running agent API    |
+
+If the agent runs on a different host or port:
+
+```bash
+AGENT_URL=https://your-agent-url flask --app playground/app run --port 5001
+```
+
+---
+
 ## Agent-Specific Documentation
 
 - [CrewAI Documentation](https://docs.crewai.com/)

agents/crewai/websearch_agent/deploy.sh

@@ -16,6 +16,13 @@ set -e  # Exit on error
 source .env
 export CONTAINER_IMAGE BASE_URL MODEL_ID
 
+## ============================================
+# COPY SHARED IMAGES FOR DOCKER BUILD CONTEXT
+## ============================================
+
+cp -r ../../../images ./images && echo "Images copied into build context"
+trap 'rm -rf ./images' EXIT
+
 ## ============================================
 # DOCKER BUILD
 ## ============================================

agents/crewai/websearch_agent/examples/ai_service.py

@@ -1,3 +1,5 @@
+from os import getenv
+
 from crewai import LLM
 from crewai.agents.parser import AgentAction, AgentFinish
 from crewai.tools.tool_types import ToolResult
@@ -20,8 +22,6 @@ def ai_stream_service(context, base_url=None, model_id=None):
     Returns:
         Tuple (generate, generate_stream).
     """
-    from os import getenv
-
     api_key = getenv("API_KEY", "no-key")
 
     if base_url and not base_url.endswith("/v1"):

agents/crewai/websearch_agent/init.sh

@@ -6,10 +6,11 @@
 import uuid
 from contextlib import asynccontextmanager
 from os import getenv
+from pathlib import Path
 
 from crewai import LLM
 from fastapi import FastAPI, HTTPException
-from fastapi.responses import StreamingResponse
+from fastapi.responses import FileResponse, HTMLResponse, StreamingResponse
 from pydantic import BaseModel, Field
 
 from crewai_web_search.crew import AssistanceAgents
@@ -364,6 +365,35 @@ async def health():
     return {"status": "healthy", "agent_initialized": llm is not None}
 
 
+# ── Playground UI ────────────────────────────────────────────────────────────
+_BASE_DIR = Path(__file__).resolve().parent
+_PLAYGROUND_HTML = _BASE_DIR / "playground" / "templates" / "index.html"
+# In Docker the images are copied to /app/images; locally they live at the repo root
+_IMAGES_DIR = _BASE_DIR / "images"
+if not _IMAGES_DIR.is_dir():
+    _IMAGES_DIR = _BASE_DIR.parent.parent.parent / "images"
+
+
+@app.get("/", response_class=HTMLResponse, include_in_schema=False)
+async def playground():
+    """Serve the playground chat UI."""
+    return FileResponse(_PLAYGROUND_HTML)
+
+
+@app.get("/images/{filename:path}", include_in_schema=False)
+async def serve_image(filename: str):
+    """Serve images from the project-level images directory."""
+    base = _IMAGES_DIR.resolve()
+    file_path = (base / filename).resolve()
+    try:
+        file_path.relative_to(base)
+    except ValueError:
+        raise HTTPException(status_code=404, detail="Image not found")
+    if not file_path.is_file():
+        raise HTTPException(status_code=404, detail="Image not found")
+    return FileResponse(file_path)
+
+
 if __name__ == "__main__":
     import uvicorn
 

agents/crewai/websearch_agent/main.py

@@ -0,0 +1,146 @@
+"""
+Playground UI for the CrewAI Web Search Agent.
+
+A simple Flask chat interface that proxies requests to the agent's
+/chat/completions endpoint with streaming support.
+
+Usage:
+    # Make sure the agent is running first (default: http://localhost:8000)
+    cd agents/crewai/websearch_agent
+    flask --app playground/app run --port 5001
+
+    # Or with a custom agent URL:
+    AGENT_URL=http://localhost:8000 flask --app playground/app run --port 5001
+"""
+
+import json
+import logging
+from os import getenv
+from pathlib import Path
+
+import requests as http_requests
+from flask import (
+    Flask,
+    Response,
+    jsonify,
+    render_template,
+    request,
+    send_from_directory,
+    stream_with_context,
+)
+
+logging.basicConfig(level=logging.DEBUG)
+logger = logging.getLogger(__name__)
+
+IMAGES_DIR = Path(__file__).resolve().parents[4] / "images"
+
+app = Flask(__name__)
+
+
+@app.route("/images/<path:filename>")
+def serve_image(filename):
+    """Serve images from the project-level images directory."""
+    return send_from_directory(IMAGES_DIR, filename)
+
+
+AGENT_URL = getenv("AGENT_URL", "http://localhost:8000")
+
+
+@app.route("/")
+def index():
+    return render_template("index.html")
+
+
+@app.route("/api/health", methods=["GET"])
+def health():
+    """Check if the agent is reachable."""
+    try:
+        resp = http_requests.get(f"{AGENT_URL}/health", timeout=5)
+        return jsonify(resp.json()), resp.status_code
+    except Exception:
+        logger.exception("Error checking agent health")
+        return (
+            jsonify(
+                {
+                    "status": "unreachable",
+                    "error": "Agent is unreachable. Please try again later.",
+                }
+            ),
+            503,
+        )
+
+
+@app.route("/api/chat", methods=["POST"])
+def chat():
+    """Proxy chat requests to the agent with streaming."""
+    data = request.get_json() or {}
+    messages = data.get("messages", [])
+
+    payload = {
+        "messages": messages,
+        "stream": True,
+    }
+
+    logger.info(f"Sending request to {AGENT_URL}/chat/completions (messages={len(payload.get('messages', []))}, stream={payload.get('stream')})")
+
+    def generate():
+        try:
+            with http_requests.post(
+                f"{AGENT_URL}/chat/completions",
+                json=payload,
+                stream=True,
+                timeout=(10, 300),
+            ) as resp:
+                logger.info(f"Agent response status: {resp.status_code}")
+
+                if resp.status_code != 200:
+                    error_msg = resp.text[:500]
+                    logger.error(f"Agent error: {error_msg}")
+                    error = json.dumps(
+                        {
+                            "error": {
+                                "message": f"Agent returned {resp.status_code}: {error_msg}"
+                            }
+                        }
+                    )
+                    yield f"data: {error}\n\n"
+                    return
+
+                for chunk in resp.iter_content(chunk_size=None, decode_unicode=True):
+                    if chunk:
+                        logger.debug(f"Chunk: {chunk[:200]}")
+                        yield chunk
+
+        except http_requests.exceptions.ConnectionError:
+            logger.error(f"Cannot connect to agent at {AGENT_URL}")
+            error = json.dumps(
+                {
+                    "error": {
+                        "message": f"Cannot connect to agent at {AGENT_URL}. Is it running?"
+                    }
+                }
+            )
+            yield f"data: {error}\n\n"
+        except http_requests.exceptions.ReadTimeout:
+            logger.error("Agent request timed out")
+            error = json.dumps({"error": {"message": "Agent request timed out (300s)"}})
+            yield f"data: {error}\n\n"
+        except Exception:
+            logger.exception("Unexpected error in proxy")
+            error = json.dumps({"error": {"message": "Internal server error"}})
+            yield f"data: {error}\n\n"
+
+    return Response(
+        stream_with_context(generate()),
+        content_type="text/event-stream",
+        headers={
+            "Cache-Control": "no-cache",
+            "X-Accel-Buffering": "no",
+            "Connection": "keep-alive",
+        },
+    )
+
+
+if __name__ == "__main__":
+    debug_mode = getenv("FLASK_DEBUG", "false").lower() == "true"
+    app.run(debug=debug_mode, port=5001)