llm_council/backend/openai_compat.py
Irina Levit 3546c04348
Some checks failed
CI / backend-test (push) Successful in 4m9s
CI / frontend-test (push) Failing after 3m48s
CI / lint-python (push) Successful in 1m41s
CI / secret-scanning (push) Successful in 1m20s
CI / dependency-scan (push) Successful in 10m50s
CI / workflow-summary (push) Successful in 1m11s
feat: Major UI/UX improvements and production readiness
## Features Added

### Document Reference System
- Implemented numbered document references (@1, @2, etc.) with autocomplete dropdown
- Added fuzzy filename matching for @filename references
- Document filtering now prioritizes numeric refs > filename refs > all documents
- Autocomplete dropdown appears when typing @ with keyboard navigation (Up/Down, Enter/Tab, Escape)
- Document numbers displayed in UI for easy reference

### Conversation Management
- Added conversation rename functionality with inline editing
- Implemented conversation search (by title and content)
- Search box always visible, even when no conversations exist
- Export reports now replace @N references with actual filenames

### UI/UX Improvements
- Removed debug toggle button
- Improved text contrast in dark mode (better visibility)
- Made input textarea expand to full available width
- Fixed file text color for better readability
- Enhanced document display with numbered badges

### Configuration & Timeouts
- Made HTTP client timeouts configurable (connect, write, pool)
- Added .env.example with all configuration options
- Updated timeout documentation

### Developer Experience
- Added `make test-setup` target for automated test conversation creation
- Test setup script supports TEST_MESSAGE and TEST_DOCS env vars
- Improved Makefile with dev and test-setup targets

### Documentation
- Updated ARCHITECTURE.md with all new features
- Created comprehensive deployment documentation
- Added GPU VM setup guides
- Removed unnecessary markdown files (CLAUDE.md, CONTRIBUTING.md, header.jpg)
- Organized documentation in docs/ directory

### GPU VM / Ollama (Stability + GPU Offload)
- Updated GPU VM docs to reflect the working systemd environment for remote Ollama
- Standardized remote Ollama port to 11434 (and added /v1/models verification)
- Documented required env for GPU offload on this VM:
  - `OLLAMA_MODELS=/mnt/data/ollama`, `HOME=/mnt/data/ollama/home`
  - `OLLAMA_LLM_LIBRARY=cuda_v12` (not `cuda`)
  - `LD_LIBRARY_PATH=/usr/local/lib/ollama:/usr/local/lib/ollama/cuda_v12`

## Technical Changes

### Backend
- Enhanced `docs_context.py` with reference parsing (numeric and filename)
- Added `update_conversation_title` to storage.py
- New endpoints: PATCH /api/conversations/{id}/title, GET /api/conversations/search
- Improved report generation with filename substitution

### Frontend
- Removed debugMode state and related code
- Added autocomplete dropdown component
- Implemented search functionality in Sidebar
- Enhanced ChatInterface with autocomplete and improved textarea sizing
- Updated CSS for better contrast and responsive design

## Files Changed
- Backend: config.py, council.py, docs_context.py, main.py, storage.py
- Frontend: App.jsx, ChatInterface.jsx, Sidebar.jsx, and related CSS files
- Documentation: README.md, ARCHITECTURE.md, new docs/ directory
- Configuration: .env.example, Makefile
- Scripts: scripts/test_setup.py

## Breaking Changes
None - all changes are backward compatible

## Testing
- All existing tests pass
- New test-setup script validates conversation creation workflow
- Manual testing of autocomplete, search, and rename features
2025-12-28 18:15:02 -05:00

254 lines
9.2 KiB
Python

"""OpenAI-compatible API client (for Ollama / vLLM / TGI / OpenAI-style servers).
This lets LLM Council talk to any OpenAI-compatible server (local Ollama,
remote Ollama, vLLM, TGI, etc.).
"""
from __future__ import annotations
import asyncio
import os
from typing import Any, Dict, List, Optional
import httpx
from .config import (
OPENAI_COMPAT_BASE_URL,
OPENAI_COMPAT_RETRIES,
OPENAI_COMPAT_RETRY_BACKOFF_SECONDS,
OPENAI_COMPAT_TIMEOUT_SECONDS,
OPENAI_COMPAT_CONNECT_TIMEOUT_SECONDS,
OPENAI_COMPAT_WRITE_TIMEOUT_SECONDS,
OPENAI_COMPAT_POOL_TIMEOUT_SECONDS,
DEBUG,
)
def _resolve_chat_completions_url(base_url: str) -> str:
"""
Accepts either:
- http://host:8000 -> http://host:8000/v1/chat/completions
- http://host:8000/v1 -> http://host:8000/v1/chat/completions
- http://host:8000/v1/ -> http://host:8000/v1/chat/completions
"""
base = base_url.rstrip("/")
if base.endswith("/v1"):
return f"{base}/chat/completions"
if "/v1/" in f"{base}/":
# Already has /v1 somewhere; assume caller gave full root including /v1
return f"{base}/chat/completions"
return f"{base}/v1/chat/completions"
def _resolve_models_url(base_url: str) -> str:
base = base_url.rstrip("/")
if base.endswith("/v1"):
return f"{base}/models"
if "/v1/" in f"{base}/":
return f"{base}/models"
return f"{base}/v1/models"
def _resolve_ollama_tags_url(base_url: str) -> str:
"""Resolve Ollama's native /api/tags endpoint URL."""
base = base_url.rstrip("/")
return f"{base}/api/tags"
def _should_retry(status_code: int) -> bool:
return status_code in {408, 409, 425, 429, 500, 502, 503, 504}
async def query_model(
model: str,
messages: List[Dict[str, str]],
*,
base_url: Optional[str] = None,
api_key: Optional[str] = None,
max_tokens: int = 2048,
timeout: Optional[float] = None,
client: Optional[httpx.AsyncClient] = None,
) -> Optional[Dict[str, Any]]:
"""Query a model via an OpenAI-compatible chat completions endpoint."""
resolved_base_url = base_url or OPENAI_COMPAT_BASE_URL
if not resolved_base_url:
print("Error querying OpenAI-compatible provider: OPENAI_COMPAT_BASE_URL not set")
return None
resolved_api_key = api_key if api_key is not None else os.getenv("OPENAI_COMPAT_API_KEY")
resolved_timeout = OPENAI_COMPAT_TIMEOUT_SECONDS if timeout is None else timeout
retries = OPENAI_COMPAT_RETRIES
backoff = OPENAI_COMPAT_RETRY_BACKOFF_SECONDS
url = _resolve_chat_completions_url(resolved_base_url)
headers = {"Content-Type": "application/json"}
if resolved_api_key:
headers["Authorization"] = f"Bearer {resolved_api_key}"
payload: Dict[str, Any] = {
"model": model,
"messages": messages,
"max_tokens": max_tokens,
}
if DEBUG:
print(f"[DEBUG] Querying model '{model}' at {url} (timeout={resolved_timeout}s, max_tokens={max_tokens})")
close_client = False
try:
if client is None:
# Use explicit Timeout object to ensure read timeout is set correctly
# For LLM requests, we need a long read timeout since generation can take time
timeout_config = httpx.Timeout(
connect=OPENAI_COMPAT_CONNECT_TIMEOUT_SECONDS,
read=resolved_timeout, # Read timeout: use the configured timeout
write=OPENAI_COMPAT_WRITE_TIMEOUT_SECONDS,
pool=OPENAI_COMPAT_POOL_TIMEOUT_SECONDS
)
client = httpx.AsyncClient(timeout=timeout_config)
close_client = True
attempt = 0
while True:
if DEBUG:
print(f"[DEBUG] Attempt {attempt + 1}/{retries + 1}: POST {url}")
resp = await client.post(url, headers=headers, json=payload)
if resp.status_code != 200:
# Preserve server-provided error text for debugging.
try:
err_json = resp.json()
err_msg = err_json.get("error", {}).get("message", resp.text)
except Exception:
err_msg = resp.text
if attempt < retries and _should_retry(resp.status_code):
await asyncio.sleep(backoff * (2**attempt))
attempt += 1
continue
print(f"Error querying model {model} (HTTP {resp.status_code}): {err_msg}")
return None
data = resp.json()
msg = data["choices"][0]["message"]
if DEBUG:
print(f"[DEBUG] Model '{model}' responded successfully")
return {
"content": msg.get("content"),
"reasoning_details": msg.get("reasoning_details"),
}
except httpx.TimeoutException as e:
print(f"[ERROR] Model '{model}' timeout after {resolved_timeout}s at {url}")
print(
f"[ERROR] This can mean the model is loading / slow, OR that the server/port is unreachable.\n"
f"[ERROR] Check connectivity: curl {resolved_base_url}/api/tags"
)
return None
except httpx.ConnectError as e:
print(f"[ERROR] Cannot connect to {url}: {e}")
print(f"[ERROR] Is Ollama running? Check: curl {resolved_base_url}/api/tags")
return None
except Exception as e:
print(f"[ERROR] Unexpected error querying model '{model}' at {url}: {type(e).__name__}: {e}")
import traceback
traceback.print_exc()
return None
finally:
if close_client and client is not None:
await client.aclose()
async def list_models(
*,
base_url: Optional[str] = None,
api_key: Optional[str] = None,
timeout: Optional[float] = None,
client: Optional[httpx.AsyncClient] = None,
) -> Optional[List[str]]:
"""Return model IDs from an OpenAI-compatible server (/v1/models)."""
resolved_base_url = base_url or OPENAI_COMPAT_BASE_URL
if not resolved_base_url:
return None
resolved_api_key = api_key if api_key is not None else os.getenv("OPENAI_COMPAT_API_KEY")
resolved_timeout = OPENAI_COMPAT_TIMEOUT_SECONDS if timeout is None else timeout
retries = OPENAI_COMPAT_RETRIES
backoff = OPENAI_COMPAT_RETRY_BACKOFF_SECONDS
# Try OpenAI-compatible endpoint first
url = _resolve_models_url(resolved_base_url)
headers = {"Content-Type": "application/json"}
if resolved_api_key:
headers["Authorization"] = f"Bearer {resolved_api_key}"
close_client = False
try:
if client is None:
# Use explicit Timeout object for list_models (faster operation)
timeout_config = httpx.Timeout(
connect=OPENAI_COMPAT_CONNECT_TIMEOUT_SECONDS,
read=resolved_timeout,
write=OPENAI_COMPAT_WRITE_TIMEOUT_SECONDS,
pool=OPENAI_COMPAT_POOL_TIMEOUT_SECONDS
)
client = httpx.AsyncClient(timeout=timeout_config)
close_client = True
attempt = 0
while True:
resp = await client.get(url, headers=headers)
if resp.status_code == 200:
data = resp.json()
# Try OpenAI-compatible format first
items = data.get("data", [])
if items:
ids: List[str] = []
for it in items:
mid = it.get("id")
if mid:
ids.append(mid)
return ids
# Fallback: check if it's already in Ollama format
items = data.get("models", [])
if items:
ids: List[str] = []
for it in items:
mid = it.get("name") or it.get("model")
if mid:
ids.append(mid)
return ids
return []
# If /v1/models fails, try Ollama's native /api/tags endpoint
if resp.status_code == 404 and attempt == 0:
ollama_url = _resolve_ollama_tags_url(resolved_base_url)
if DEBUG:
print(f"[DEBUG] /v1/models not found, trying Ollama native API: {ollama_url}")
resp = await client.get(ollama_url, headers=headers)
if resp.status_code == 200:
data = resp.json()
items = data.get("models", [])
if items:
ids: List[str] = []
for it in items:
mid = it.get("name") or it.get("model")
if mid:
ids.append(mid)
return ids
if attempt < retries and _should_retry(resp.status_code):
await asyncio.sleep(backoff * (2**attempt))
attempt += 1
continue
return None
except Exception as e:
if DEBUG:
msg = str(e) if str(e) else "(no message)"
print(f"[DEBUG] Error listing models: {type(e).__name__}: {msg}")
return None
finally:
if close_client and client is not None:
await client.aclose()