jims-api 0.0.0__tar.gz

jims_api-0.0.0/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.4
+Name: jims-api
+Version: 0.0.0
+Summary: universal API for JIMS application
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: click>=8.0
+Requires-Dist: fastapi>=0.128.0
+Requires-Dist: jims-core>=0.4.2
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: uvicorn>=0.35.0
+
+# jims-api
+
+`jims-api` exposes any JIMS application as a FastAPI HTTP service.
+
+
+## Run
+
+```bash
+jims-api --app my_project.app:app --port 8080
+```
+
+Environment variables:
+
+- `JIMS_APP` - JIMS app import path (`module:attr`)
+- `JIMS_PORT` - HTTP port
+- `JIMS_HOST` - HTTP host
+- `JIMS_API_KEY` - optional bearer token for auth
+
+## Endpoints
+
+- `GET /health`
+- `POST /api/v1/chat`
+
+### `POST /api/v1/chat`
+
+Request:
+
+```json
+{
+  "contact_id": "customer:42",
+  "message": "Hello",
+  "thread_id": null,
+  "thread_config": {"interface": "api"},
+  "event_type": "comm.user_message",
+  "run_conversation_start_on_new_thread": false
+}
+```
+
+Response:
+
+```json
+{
+  "thread_id": "0194f0f3-d88d-7cca-8f37-ff44f911f539",
+  "created_new_thread": true,
+  "assistant_messages": ["Hi! How can I help?"],
+  "events": [
+    {
+      "event_type": "comm.assistant_message",
+      "event_data": {"role": "assistant", "content": "Hi! How can I help?"}
+    }
+  ]
+}
+```
+
+If `JIMS_API_KEY` is set, send it as `Authorization: Bearer <token>`

jims_api-0.0.0/README.md

@@ -0,0 +1,55 @@
+# jims-api
+
+`jims-api` exposes any JIMS application as a FastAPI HTTP service.
+
+
+## Run
+
+```bash
+jims-api --app my_project.app:app --port 8080
+```
+
+Environment variables:
+
+- `JIMS_APP` - JIMS app import path (`module:attr`)
+- `JIMS_PORT` - HTTP port
+- `JIMS_HOST` - HTTP host
+- `JIMS_API_KEY` - optional bearer token for auth
+
+## Endpoints
+
+- `GET /health`
+- `POST /api/v1/chat`
+
+### `POST /api/v1/chat`
+
+Request:
+
+```json
+{
+  "contact_id": "customer:42",
+  "message": "Hello",
+  "thread_id": null,
+  "thread_config": {"interface": "api"},
+  "event_type": "comm.user_message",
+  "run_conversation_start_on_new_thread": false
+}
+```
+
+Response:
+
+```json
+{
+  "thread_id": "0194f0f3-d88d-7cca-8f37-ff44f911f539",
+  "created_new_thread": true,
+  "assistant_messages": ["Hi! How can I help?"],
+  "events": [
+    {
+      "event_type": "comm.assistant_message",
+      "event_data": {"role": "assistant", "content": "Hi! How can I help?"}
+    }
+  ]
+}
+```
+
+If `JIMS_API_KEY` is set, send it as `Authorization: Bearer <token>`

jims_api-0.0.0/pyproject.toml

@@ -0,0 +1,38 @@
+[project]
+name = "jims-api"
+dynamic = ["version"]
+description = "universal API for JIMS application"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "click>=8.0",
+    "fastapi>=0.128.0",
+    "jims-core>=0.4.2",
+    "loguru>=0.7.3",
+    "uvicorn>=0.35.0",
+]
+
+[tool.uv.sources]
+jims-core = { workspace = true }
+
+[tool.uv-workspace-codegen]
+generate = true
+template_type = ["lib", "publish"]
+generate_standard_pytest_step = true
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+
+[dependency-groups]
+dev = [
+    "aiosqlite>=0.20.0",
+    "httpx>=0.28.0",
+    "mypy>=1.19.1",
+    "pytest>=8.4.1",
+    "pytest-asyncio>=1.1.0",
+    "ruff>=0.15.0",
+]
+
+[project.scripts]
+jims-api = "jims_api.main:main"

jims_api-0.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

jims_api-0.0.0/src/jims_api/main.py

@@ -0,0 +1,184 @@
+import asyncio
+from typing import Any, Awaitable
+from uuid import UUID
+
+import click
+import uvicorn
+from fastapi import Depends, FastAPI, Header, HTTPException
+from jims_core.app import JimsApp
+from jims_core.thread.thread_controller import ThreadController
+from jims_core.util import (
+    load_jims_app,
+    setup_monitoring_and_tracing_with_sentry,
+    setup_prometheus_metrics,
+    setup_verbose_logging,
+    uuid7,
+)
+from loguru import logger
+from pydantic import BaseModel, Field
+
+
+class ChatRequest(BaseModel):
+    contact_id: str
+    message: str
+    thread_id: UUID | None = None  # if none provided - create new thread
+    thread_config: dict[str, Any] = Field(default_factory=lambda: {"interface": "api"})
+    event_type: str = "comm.user_message"
+    run_conversation_start_on_new_thread: bool = False
+
+
+class ApiEvent(BaseModel):
+    event_type: str
+    event_data: dict[str, Any]
+
+
+class ChatResponse(BaseModel):
+    thread_id: UUID
+    created_new_thread: bool
+    assistant_messages: list[str]
+    events: list[ApiEvent]
+
+
+def _extract_token(authorization: str | None) -> str | None:
+    if authorization is None:
+        return None
+
+    if authorization.lower().startswith("bearer "):
+        return authorization.split(" ", 1)[1]
+
+    return authorization
+
+
+def _auth_dependency(api_key: str | None):
+    async def require_auth(authorization: str | None = Header(default=None, alias="Authorization")) -> None:
+        if api_key is None:
+            return
+
+        token = _extract_token(authorization)
+        if token != api_key:
+            raise HTTPException(status_code=401, detail="Unauthorized")
+
+    return require_auth
+
+
+async def _resolve_jims_app(app_name: str) -> JimsApp:
+    loaded_app = load_jims_app(app_name)
+    if isinstance(loaded_app, Awaitable):
+        loaded_app = await loaded_app
+    return loaded_app
+
+
+def create_api(jims_app: JimsApp, api_key: str | None) -> FastAPI:
+    app = FastAPI(title="JIMS API", version="0.1.0")
+    require_auth = _auth_dependency(api_key)
+
+    @app.get("/health")
+    async def health() -> dict[str, str]:
+        return {"status": "ok"}
+
+    @app.post("/api/v1/chat", response_model=ChatResponse, dependencies=[Depends(require_auth)])
+    async def chat(req: ChatRequest) -> ChatResponse:
+        created_new_thread = False
+
+        if req.thread_id is not None:
+            ctl = await ThreadController.from_thread_id(jims_app.sessionmaker, req.thread_id)
+            if ctl is None:
+                raise HTTPException(status_code=404, detail=f"Thread '{req.thread_id}' not found")
+        else:
+            ctl = await ThreadController.latest_thread_from_contact_id(jims_app.sessionmaker, req.contact_id)
+
+        if ctl is None:
+            created_new_thread = True
+            thread_id = uuid7()
+            ctl = await jims_app.new_thread(
+                contact_id=req.contact_id,
+                thread_id=thread_id,
+                thread_config=req.thread_config,
+            )
+
+            if req.run_conversation_start_on_new_thread and jims_app.conversation_start_pipeline is not None:
+                await ctl.run_pipeline_with_context(jims_app.conversation_start_pipeline)
+
+        await ctl.store_event_dict(
+            event_id=uuid7(),
+            event_type=req.event_type,
+            event_data={"role": "user", "content": req.message},
+        )
+
+        try:
+            outgoing_events = await ctl.run_pipeline_with_context(jims_app.pipeline)
+        except Exception as exc:
+            logger.exception("Pipeline execution failed")
+            raise HTTPException(status_code=500, detail=f"Pipeline error: {exc}") from exc
+
+        assistant_messages = [
+            str(ev.event_data.get("content", ""))
+            for ev in outgoing_events
+            if ev.event_type == "comm.assistant_message" and isinstance(ev.event_data, dict)
+        ]
+
+        response_events = [
+            ApiEvent(
+                event_type=ev.event_type,
+                event_data=ev.event_data if isinstance(ev.event_data, dict) else {},
+                # todo filter comm.* events only?
+            )
+            for ev in outgoing_events
+        ]
+
+        return ChatResponse(
+            thread_id=ctl.thread.thread_id,
+            created_new_thread=created_new_thread,
+            assistant_messages=assistant_messages,
+            events=response_events,
+        )
+
+    return app
+
+
+@click.command()
+@click.option("--app", type=click.STRING, default="app", help="JIMS app in module:attr format.")
+@click.option("--host", type=click.STRING, default="0.0.0.0")
+@click.option("--port", type=click.INT, default=8080)
+@click.option("--api-key", type=click.STRING, default=None, help="Optional bearer token for API auth.")
+@click.option("--enable-sentry", is_flag=True, help="Enable tracing to Sentry", default=False)
+@click.option("--metrics-port", type=click.INT, default=8000)
+@click.option("--verbose", is_flag=True, default=False)
+def cli(
+    app: str,
+    host: str,
+    port: int,
+    api_key: str | None,
+    enable_sentry: bool,
+    metrics_port: int,
+    verbose: bool,
+) -> None:
+    if verbose:
+        setup_verbose_logging()
+
+    setup_prometheus_metrics(port=metrics_port)
+
+    if enable_sentry:
+        setup_monitoring_and_tracing_with_sentry()
+
+    async def run_api() -> None:
+        jims_app = await _resolve_jims_app(app)
+        api = create_api(jims_app, api_key=api_key)
+        server = uvicorn.Server(uvicorn.Config(api, host=host, port=port, log_level="info"))
+        await server.serve()
+
+    try:
+        asyncio.run(run_api())
+    except KeyboardInterrupt:
+        logger.info("API stopped by user")
+    except Exception as exc:
+        logger.exception(f"API crashed: {exc}")
+        raise SystemExit(1) from exc
+
+
+def main() -> None:
+    cli(auto_envvar_prefix="JIMS")
+
+
+if __name__ == "__main__":
+    main()

jims_api-0.0.0/src/jims_api.egg-info/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.4
+Name: jims-api
+Version: 0.0.0
+Summary: universal API for JIMS application
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: click>=8.0
+Requires-Dist: fastapi>=0.128.0
+Requires-Dist: jims-core>=0.4.2
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: uvicorn>=0.35.0
+
+# jims-api
+
+`jims-api` exposes any JIMS application as a FastAPI HTTP service.
+
+
+## Run
+
+```bash
+jims-api --app my_project.app:app --port 8080
+```
+
+Environment variables:
+
+- `JIMS_APP` - JIMS app import path (`module:attr`)
+- `JIMS_PORT` - HTTP port
+- `JIMS_HOST` - HTTP host
+- `JIMS_API_KEY` - optional bearer token for auth
+
+## Endpoints
+
+- `GET /health`
+- `POST /api/v1/chat`
+
+### `POST /api/v1/chat`
+
+Request:
+
+```json
+{
+  "contact_id": "customer:42",
+  "message": "Hello",
+  "thread_id": null,
+  "thread_config": {"interface": "api"},
+  "event_type": "comm.user_message",
+  "run_conversation_start_on_new_thread": false
+}
+```
+
+Response:
+
+```json
+{
+  "thread_id": "0194f0f3-d88d-7cca-8f37-ff44f911f539",
+  "created_new_thread": true,
+  "assistant_messages": ["Hi! How can I help?"],
+  "events": [
+    {
+      "event_type": "comm.assistant_message",
+      "event_data": {"role": "assistant", "content": "Hi! How can I help?"}
+    }
+  ]
+}
+```
+
+If `JIMS_API_KEY` is set, send it as `Authorization: Bearer <token>`

jims_api-0.0.0/src/jims_api.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+pyproject.toml
+src/jims_api/__init__.py
+src/jims_api/main.py
+src/jims_api/py.typed
+src/jims_api.egg-info/PKG-INFO
+src/jims_api.egg-info/SOURCES.txt
+src/jims_api.egg-info/dependency_links.txt
+src/jims_api.egg-info/entry_points.txt
+src/jims_api.egg-info/requires.txt
+src/jims_api.egg-info/top_level.txt

jims_api-0.0.0/src/jims_api.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

jims_api-0.0.0/src/jims_api.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+jims-api = jims_api.main:main

jims_api-0.0.0/src/jims_api.egg-info/requires.txt

@@ -0,0 +1,5 @@
+click>=8.0
+fastapi>=0.128.0
+jims-core>=0.4.2
+loguru>=0.7.3
+uvicorn>=0.35.0

jims_api-0.0.0/src/jims_api.egg-info/top_level.txt

@@ -0,0 +1 @@
+jims_api