openscribe/server/app/providers/summary.py
Laurence 51321aa7c5
Some checks failed
ci / firmware (pull_request) Failing after 1s
ci / emulator (pull_request) Failing after 27s
ci / openapi (pull_request) Failing after 33s
ci / server (pull_request) Failing after 37s
feat(server): pluggable AI providers - any open-standard or commercial AI
Lets the owner point transcription and summarisation at any AI: an open-standard
endpoint (OpenAI-compatible / local faster-whisper / Ollama) or a commercial API
(OpenAI, Anthropic, Gemini). Config-driven, self-hostable, no lock-in.

What changed:
- server/app/providers/: provider layer.
  - base.py: Transcriber/Summariser protocols + shared summary prompt + tolerant JSON
    parser (uniform Summary shape across providers).
  - summary.py: OpenAICompatibleSummariser (any /chat/completions - OpenAI, Groq,
    OpenRouter, LocalAI, LM Studio, vLLM, Ollama /v1) and AnthropicSummariser (Claude
    via the official anthropic SDK; Messages API has no OpenAI-compatible endpoint).
  - transcription.py: OpenAICompatibleTranscriber (/audio/transcriptions - OpenAI,
    Groq, self-hosted whisper server) and LocalWhisperTranscriber (faster-whisper,
    execution wired in M5).
  - factory.py: builds the configured providers with per-provider defaults
    (anthropic -> claude-opus-4-8, openai_compatible -> gpt-4o-mini, ollama -> llama3.1).
- config.py + .env.example: transcription_provider / llm_provider selectors + base_url,
  key, model settings; local faster-whisper and Ollama kept as the self-hosted defaults.
- main.py: /health now reports the resolved provider names (no secrets).
- requirements.txt: httpx drives all HTTP providers; anthropic + faster-whisper are
  optional, only for their respective providers.
- docs/ai-providers.md: config recipes for OpenAI, Groq, Anthropic, Gemini, LocalAI,
  LM Studio, Ollama, self-hosted whisper.
- state/: DECISIONS, ARCHITECTURE, TODO updated.

Why:
- The user asked to connect the device to any open standard AI or commercial one; this
  is also the core differentiator vs Plaud's locked cloud.

Notes:
- Anthropic provider uses the official SDK and defaults to claude-opus-4-8 (per the
  claude-api guidance). AI deps are optional per chosen provider. Modules byte-compile
  cleanly; end-to-end wiring into the ingest pipeline lands with M5.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-03 18:56:58 +01:00

66 lines
2.6 KiB
Python

# SPDX-License-Identifier: GPL-3.0-only
"""Summarisation providers.
- OpenAICompatibleSummariser: any endpoint speaking the OpenAI /chat/completions API -
OpenAI, Groq, Together, OpenRouter, LocalAI, vLLM, LM Studio, and Ollama's /v1 endpoint.
- AnthropicSummariser: Claude via the official Anthropic SDK (Messages API). Anthropic does
not expose an OpenAI-compatible endpoint, so it needs its own provider.
"""
from __future__ import annotations
import httpx
from ..models import Summary
from .base import SUMMARY_SYSTEM, parse_summary, summary_user_prompt
class OpenAICompatibleSummariser:
"""Talks the OpenAI Chat Completions API. Works with any compatible base_url."""
def __init__(self, base_url: str, api_key: str, model: str):
self.base_url = base_url.rstrip("/")
self.api_key = api_key
self.model = model
self.name = f"openai_compatible:{model}"
def summarise(self, recording_id: str, transcript_text: str) -> Summary:
headers = {"Authorization": f"Bearer {self.api_key}"} if self.api_key else {}
payload = {
"model": self.model,
"messages": [
{"role": "system", "content": SUMMARY_SYSTEM},
{"role": "user", "content": summary_user_prompt(transcript_text)},
],
"temperature": 0.2,
# Honoured by OpenAI/Groq/vLLM/etc.; ignored by servers that don't support it.
"response_format": {"type": "json_object"},
}
resp = httpx.post(
f"{self.base_url}/chat/completions", headers=headers, json=payload, timeout=120
)
resp.raise_for_status()
content = resp.json()["choices"][0]["message"]["content"]
return parse_summary(recording_id, self.name, content)
class AnthropicSummariser:
"""Claude via the official Anthropic SDK. Default model: claude-opus-4-8."""
def __init__(self, api_key: str, model: str):
import anthropic # imported lazily so the dep is only needed for this provider
self._client = (
anthropic.Anthropic(api_key=api_key) if api_key else anthropic.Anthropic()
)
self.model = model
self.name = f"anthropic:{model}"
def summarise(self, recording_id: str, transcript_text: str) -> Summary:
resp = self._client.messages.create(
model=self.model,
max_tokens=2000,
system=SUMMARY_SYSTEM,
messages=[{"role": "user", "content": summary_user_prompt(transcript_text)}],
)
text = next((b.text for b in resp.content if b.type == "text"), "")
return parse_summary(recording_id, self.name, text)