feat: mock capabilities initial commit

app/core/api_response.py

@@ -0,0 +1,87 @@
+from functools import wraps
+from fastapi import HTTPException, Request, status
+from loguru import logger
+import os
+import json
+from typing import Dict
+from environs import Env
+
+env = Env()
+env.read_env()
+
+USE_MOCK = env.bool("USE_MOCK", True)
+
+
+def url_to_filename(url: str, method: str) -> str:
+    """
+    Convert API URL to mock filename.
+    Example: 
+    - Input: GET "/v1/chat/completions" -> "chat_completions_GET.json"
+    - Input: GET "/v1/chat/completions/{completion_id}" -> "chat_completions_id_GET.json"
+    - Input: GET "/v1/chat/completions/123/messages" -> "chat_completions_id_messages_GET.json"
+    """
+    logger.trace(f"BEGIN: url: {url} method: {method}")
+    # Remove version prefix and leading/trailing slashes
+    path = url.strip("/")
+    if path.startswith("v1/"):
+        path = path[3:]
+    
+    # Replace path parameters with descriptive names
+    path = path.replace("{completion_id}", "id")
+    path = path.replace("{message_id}", "id")
+    
+    # Convert to filename format
+    filename = path.replace("/", "_")
+    
+    # Add method suffix
+    result = f"{filename}_{method}"
+    logger.trace(f"END: result: {result}")
+    return result
+
+
+def get_mock_response(url_path: str, method: str) -> Dict:
+    """Get mock response from JSON file."""
+    logger.trace(f"BEGIN: url_path: {url_path} method: {method}")
+    filename = None
+    try:
+        # Convert to filename
+        filename = url_to_filename(url_path, method)
+        
+        # Load mock response
+        file_path = os.path.join(os.path.dirname(__file__), "mock", f"{filename}.json")
+        with open(file_path, "r") as f:
+            result = json.load(f)
+            logger.trace(f"END: result: {result}")
+            return result
+    except FileNotFoundError:
+        raise HTTPException(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
+            detail=f"{filename} mock file not found for endpoint: {url_path} [{method}]"
+        )
+    except Exception as e:
+        raise HTTPException(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
+            detail=f"{filename} error loading mock response: {str(e)}"
+        )
+
+
+def api_response():
+    """Decorator to handle mock/real API responses."""
+    def decorator(func):
+        @wraps(func)
+        async def wrapper(request: Request, *args, **kwargs):
+            url_path = request.url.path
+            method = request.method
+            logger.debug(f"BEGIN: url_path: {url_path} method: {method}")
+            if USE_MOCK:
+                logger.warning("Using mock response")
+                result = get_mock_response(url_path, method)
+                logger.trace(f"END: result: {result}")
+                return result
+            else:
+                # Call original function for real response
+                result = await func(request, *args, **kwargs)
+                logger.trace(f"END: result: {result}")
+                return result
+        return wrapper
+    return decorator

docs/conversation.drawio

@@ -0,0 +1,90 @@
+<mxfile host="65bd71144e">
+    <diagram id="RUA-RFROyaZDF0aJ2uCW" name="Page-1">
+        <mxGraphModel dx="1098" dy="639" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0" adaptiveColors="simple">
+            <root>
+                <mxCell id="0"/>
+                <mxCell id="1" parent="0"/>
+                <mxCell id="4" style="edgeStyle=none;html=1;" edge="1" parent="1" source="2" target="3">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="2" value="Actor" style="shape=umlActor;verticalLabelPosition=bottom;verticalAlign=top;html=1;outlineConnect=0;" vertex="1" parent="1">
+                    <mxGeometry x="70" y="230" width="30" height="60" as="geometry"/>
+                </mxCell>
+                <mxCell id="6" value="" style="edgeStyle=none;html=1;" edge="1" parent="1" source="3" target="5">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="3" value="frontend" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
+                    <mxGeometry x="230" y="230" width="120" height="60" as="geometry"/>
+                </mxCell>
+                <mxCell id="8" style="edgeStyle=none;html=1;" edge="1" parent="1" source="5" target="7">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="10" value="" style="edgeStyle=none;html=1;" edge="1" parent="1" source="5" target="9">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="12" style="edgeStyle=none;html=1;" edge="1" parent="1" source="5" target="11">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="17" style="edgeStyle=none;html=1;" edge="1" parent="1" source="5" target="16">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="20" style="edgeStyle=none;html=1;" edge="1" parent="1" source="5" target="19">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="5" value="backend" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
+                    <mxGeometry x="500" y="230" width="120" height="60" as="geometry"/>
+                </mxCell>
+                <mxCell id="7" value="mongo" style="shape=cylinder3;whiteSpace=wrap;html=1;boundedLbl=1;backgroundOutline=1;size=15;" vertex="1" parent="1">
+                    <mxGeometry x="800" y="220" width="60" height="80" as="geometry"/>
+                </mxCell>
+                <mxCell id="22" value="" style="edgeStyle=none;html=1;" edge="1" parent="1" source="9" target="21">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="24" value="" style="edgeStyle=none;html=1;" edge="1" parent="1" source="9" target="23">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="9" value="schema" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
+                    <mxGeometry x="180" y="400" width="120" height="60" as="geometry"/>
+                </mxCell>
+                <mxCell id="14" style="edgeStyle=none;html=1;" edge="1" parent="1" source="11" target="13">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="11" value="model" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
+                    <mxGeometry x="490" y="400" width="120" height="60" as="geometry"/>
+                </mxCell>
+                <mxCell id="15" style="edgeStyle=none;html=1;" edge="1" parent="1" source="13" target="16">
+                    <mxGeometry relative="1" as="geometry">
+                        <mxPoint x="640" y="460" as="targetPoint"/>
+                    </mxGeometry>
+                </mxCell>
+                <mxCell id="27" style="edgeStyle=none;html=1;" edge="1" parent="1" source="13" target="23">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="28" style="edgeStyle=none;html=1;" edge="1" parent="1" source="13" target="21">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="13" value="chat_completion" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;" vertex="1" parent="1">
+                    <mxGeometry x="660" y="640" width="120" height="120" as="geometry"/>
+                </mxCell>
+                <mxCell id="29" style="edgeStyle=none;html=1;" edge="1" parent="1" source="16" target="7">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="16" value="repository" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
+                    <mxGeometry x="670" y="400" width="120" height="60" as="geometry"/>
+                </mxCell>
+                <mxCell id="18" value="api" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
+                    <mxGeometry x="25" y="400" width="120" height="60" as="geometry"/>
+                </mxCell>
+                <mxCell id="19" value="service" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
+                    <mxGeometry x="340" y="400" width="120" height="60" as="geometry"/>
+                </mxCell>
+                <mxCell id="21" value="conversation" style="ellipse;whiteSpace=wrap;html=1;rounded=0;" vertex="1" parent="1">
+                    <mxGeometry x="180" y="670" width="80" height="80" as="geometry"/>
+                </mxCell>
+                <mxCell id="23" value="&lt;span style=&quot;color: rgb(0, 0, 0);&quot;&gt;chat_completion&lt;/span&gt;" style="ellipse;whiteSpace=wrap;html=1;rounded=0;" vertex="1" parent="1">
+                    <mxGeometry x="260" y="520" width="120" height="90" as="geometry"/>
+                </mxCell>
+            </root>
+        </mxGraphModel>
+    </diagram>
+</mxfile>

resources/mock/chat_completions_GET.json

@@ -0,0 +1,30 @@
+[
+    {
+        "id": "chatcmpl-mock-123",
+        "object": "chat.completion",
+        "created": 1677858242,
+        "model": "gpt-3.5-turbo",
+        "choices": [
+            {
+                "index": 0,
+                "message": {
+                    "role": "assistant",
+                    "content": "This is a mock response from the assistant.",
+                    "tool_calls": null,
+                    "annotations": [],
+                    "audio": null,
+                    "refusal": ""
+                },
+                "finish_reason": "stop",
+                "logprobs": null
+            }
+        ],
+        "usage": {
+            "prompt_tokens": 10,
+            "completion_tokens": 20,
+            "total_tokens": 30
+        },
+        "service_tier": "standard",
+        "system_fingerprint": "fp_1234567890"
+    }
+] 

resources/mock/chat_completions_POST.json

@@ -0,0 +1,28 @@
+{
+    "id": "chatcmpl-mock-123",
+    "object": "chat.completion",
+    "created": 1677858242,
+    "model": "gpt-3.5-turbo",
+    "choices": [
+        {
+            "index": 0,
+            "message": {
+                "role": "assistant",
+                "content": "This is a mock response from the assistant.",
+                "tool_calls": null,
+                "annotations": [],
+                "audio": null,
+                "refusal": ""
+            },
+            "finish_reason": "stop",
+            "logprobs": null
+        }
+    ],
+    "usage": {
+        "prompt_tokens": 10,
+        "completion_tokens": 20,
+        "total_tokens": 30
+    },
+    "service_tier": "standard",
+    "system_fingerprint": "fp_1234567890"
+} 

resources/mock/chat_completions_id_GET.json

@@ -0,0 +1,28 @@
+{
+    "id": "chatcmpl-mock-123",
+    "object": "chat.completion",
+    "created": 1677858242,
+    "model": "gpt-3.5-turbo",
+    "choices": [
+        {
+            "index": 0,
+            "message": {
+                "role": "assistant",
+                "content": "This is a mock response from the assistant.",
+                "tool_calls": null,
+                "annotations": [],
+                "audio": null,
+                "refusal": ""
+            },
+            "finish_reason": "stop",
+            "logprobs": null
+        }
+    ],
+    "usage": {
+        "prompt_tokens": 10,
+        "completion_tokens": 20,
+        "total_tokens": 30
+    },
+    "service_tier": "standard",
+    "system_fingerprint": "fp_1234567890"
+} 

resources/mock/chat_completions_messages_GET.json

@@ -0,0 +1,36 @@
+{
+    "object": "list",
+    "data": [
+        {
+            "id": "chatcmpl-mock-123",
+            "object": "chat.completion",
+            "created": 1677858242,
+            "model": "gpt-3.5-turbo",
+            "choices": [
+                {
+                    "index": 0,
+                    "message": {
+                        "role": "assistant",
+                        "content": "This is a mock response from the assistant.",
+                        "tool_calls": null,
+                        "annotations": [],
+                        "audio": null,
+                        "refusal": ""
+                    },
+                    "finish_reason": "stop",
+                    "logprobs": null
+                }
+            ],
+            "usage": {
+                "prompt_tokens": 10,
+                "completion_tokens": 20,
+                "total_tokens": 30
+            },
+            "service_tier": "standard",
+            "system_fingerprint": "fp_1234567890"
+        }
+    ],
+    "first_id": "chatcmpl-mock-123",
+    "last_id": "chatcmpl-mock-123",
+    "has_more": false
+} 

resources/mock/chat_completions_plots_GET.json

@@ -0,0 +1,28 @@
+{
+    "id": "chatcmpl-mock-123",
+    "name": "Mock Chat",
+    "created_at": 1677858242,
+    "updated_at": 1677858242,
+    "message": {
+        "message_id": "msg-mock-123",
+        "role": "assistant",
+        "content": "This is a mock response from the assistant.",
+        "name": null,
+        "function_call": null,
+        "tool_calls": null,
+        "annotations": [],
+        "audio": null,
+        "refusal": "",
+        "created_at": 1677858242
+    },
+    "plots": [
+        {
+            "type": "line",
+            "data": {
+                "x": [1, 2, 3, 4, 5],
+                "y": [1, 4, 9, 16, 25]
+            },
+            "title": "Mock Plot"
+        }
+    ]
+} 

resources/mock/conversations_GET.json

@@ -0,0 +1,67 @@
+{
+    "items": [
+        {
+            "id": "682f026d-23e8-800f-90a1-a1399b85ae64",
+            "title": "Customer status",
+            "create_time": "2025-05-22T10:54:37.569747Z",
+            "update_time": "2025-05-22T10:55:55.212705Z",
+            "mapping": null,
+            "current_node": null,
+            "conversation_template_id": null,
+            "gizmo_id": null,
+            "is_archived": false,
+            "is_starred": null,
+            "is_do_not_remember": false,
+            "memory_scope": "global_enabled",
+            "workspace_id": null,
+            "async_status": null,
+            "safe_urls": [],
+            "blocked_urls": [],
+            "conversation_origin": null,
+            "snippet": null
+        },
+        {
+            "id": "682ede89-cd84-800f-b80f-8389bcbee865",
+            "title": "Ticket count by status",
+            "create_time": "2025-05-22T08:21:30.215436Z",
+            "update_time": "2025-05-22T08:22:54.867192Z",
+            "mapping": null,
+            "current_node": null,
+            "conversation_template_id": null,
+            "gizmo_id": null,
+            "is_archived": false,
+            "is_starred": null,
+            "is_do_not_remember": false,
+            "memory_scope": "global_enabled",
+            "workspace_id": null,
+            "async_status": null,
+            "safe_urls": [],
+            "blocked_urls": [],
+            "conversation_origin": null,
+            "snippet": null
+        },
+        {
+            "id": "682ec852-4014-800f-8a98-d257668a391e",
+            "title": "Ticket comments count by customer",
+            "create_time": "2025-05-22T06:46:42.703604Z",
+            "update_time": "2025-05-22T06:50:05.464929Z",
+            "mapping": null,
+            "current_node": null,
+            "conversation_template_id": null,
+            "gizmo_id": null,
+            "is_archived": false,
+            "is_starred": null,
+            "is_do_not_remember": false,
+            "memory_scope": "global_enabled",
+            "workspace_id": null,
+            "async_status": null,
+            "safe_urls": [],
+            "blocked_urls": [],
+            "conversation_origin": null,
+            "snippet": null
+        }
+    ],
+    "total": 79,
+    "limit": 28,
+    "offset": 0
+}

resources/mock/conversations_id_GET.json

@@ -0,0 +1,20 @@
+{
+    "id": "682f026d-23e8-800f-90a1-a1399b85ae64",
+    "title": "Customer status",
+    "create_time": "2025-05-22T10:54:37.569747Z",
+    "update_time": "2025-05-22T10:55:55.212705Z",
+    "mapping": null,
+    "current_node": null,
+    "conversation_template_id": null,
+    "gizmo_id": null,
+    "is_archived": false,
+    "is_starred": null,
+    "is_do_not_remember": false,
+    "memory_scope": "global_enabled",
+    "workspace_id": null,
+    "async_status": null,
+    "safe_urls": [],
+    "blocked_urls": [],
+    "conversation_origin": null,
+    "snippet": null
+}