3e4d08b6bf
* Add OpenAI-compatible HTTP API * Support browser API clients * Handle missing KV cache during rewind
467 lines
20 KiB
Python
467 lines
20 KiB
Python
#!/usr/bin/env python3
|
|
"""Dependency-free OpenAI-compatible HTTP gateway for the colibri engine."""
|
|
|
|
import argparse
|
|
import codecs
|
|
import json
|
|
import os
|
|
import signal
|
|
import subprocess
|
|
import sys
|
|
import threading
|
|
import time
|
|
import uuid
|
|
from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer
|
|
from pathlib import Path
|
|
from urllib.parse import unquote, urlsplit
|
|
|
|
|
|
HERE = Path(__file__).resolve().parent
|
|
END = b"\x01\x01END\x01\x01\n"
|
|
READY = b"\x01\x01READY\x01\x01\n"
|
|
MAX_BODY = 4 << 20
|
|
DEFAULT_CORS_ORIGINS = (
|
|
"http://127.0.0.1:5173",
|
|
"http://localhost:5173",
|
|
"http://tauri.localhost",
|
|
"tauri://localhost",
|
|
)
|
|
|
|
|
|
class APIError(Exception):
|
|
def __init__(self, status, message, param=None, code=None, error_type="invalid_request_error"):
|
|
super().__init__(message)
|
|
self.status = status
|
|
self.message = message
|
|
self.param = param
|
|
self.code = code
|
|
self.error_type = error_type
|
|
|
|
|
|
def error_object(error):
|
|
return {"error": {"message": error.message, "type": error.error_type,
|
|
"param": error.param, "code": error.code}}
|
|
|
|
|
|
def content_text(content, param):
|
|
if isinstance(content, str):
|
|
return content
|
|
if not isinstance(content, list):
|
|
raise APIError(400, "Message content must be a string or an array of text parts.", param)
|
|
parts = []
|
|
for index, part in enumerate(content):
|
|
if not isinstance(part, dict) or part.get("type") not in ("text", "input_text"):
|
|
raise APIError(400, "Colibri currently supports text message content only.",
|
|
f"{param}.{index}", "unsupported_content_type")
|
|
if not isinstance(part.get("text"), str):
|
|
raise APIError(400, "Text content parts require a string `text` field.",
|
|
f"{param}.{index}.text")
|
|
parts.append(part["text"])
|
|
return "".join(parts)
|
|
|
|
|
|
def render_chat(messages, enable_thinking=False, reasoning_effort=None):
|
|
"""Render the text-only subset of the official GLM-5.2 chat template."""
|
|
if not isinstance(messages, list) or not messages:
|
|
raise APIError(400, "`messages` must be a non-empty array.", "messages")
|
|
prompt = ["[gMASK]<sop>"]
|
|
if enable_thinking:
|
|
effort = "High" if reasoning_effort == "high" else "Max"
|
|
prompt.append(f"<|system|>Reasoning Effort: {effort}")
|
|
for index, message in enumerate(messages):
|
|
if not isinstance(message, dict):
|
|
raise APIError(400, "Each message must be an object.", f"messages.{index}")
|
|
role = message.get("role")
|
|
text = content_text(message.get("content"), f"messages.{index}.content")
|
|
if role in ("system", "developer"):
|
|
prompt.append(f"<|system|>{text}")
|
|
elif role == "user":
|
|
prompt.append(f"<|user|>{text}")
|
|
elif role == "assistant":
|
|
prompt.append(f"<|assistant|><think></think>{text.strip()}")
|
|
else:
|
|
raise APIError(400, f"Unsupported message role: {role!r}.",
|
|
f"messages.{index}.role", "unsupported_role")
|
|
prompt.append("<|assistant|><think>" if enable_thinking else
|
|
"<|assistant|><think></think>")
|
|
return "".join(prompt)
|
|
|
|
|
|
def generation_options(body, limit):
|
|
if body.get("n", 1) != 1:
|
|
raise APIError(400, "Colibri currently supports `n=1` only.", "n", "unsupported_value")
|
|
for name in ("tools", "functions"):
|
|
if body.get(name):
|
|
raise APIError(400, f"`{name}` is not supported yet.", name, "unsupported_parameter")
|
|
if body.get("stop") is not None:
|
|
raise APIError(400, "Custom stop sequences are not supported yet.", "stop", "unsupported_parameter")
|
|
if body.get("logprobs"):
|
|
raise APIError(400, "Log probabilities are not supported yet.", "logprobs", "unsupported_parameter")
|
|
if body.get("frequency_penalty", 0) or body.get("presence_penalty", 0):
|
|
raise APIError(400, "Token penalties are not supported yet.", None, "unsupported_parameter")
|
|
if body.get("seed") is not None:
|
|
raise APIError(400, "Per-request seeds are not supported yet.", "seed", "unsupported_parameter")
|
|
response_format = body.get("response_format")
|
|
if response_format not in (None, {"type": "text"}):
|
|
raise APIError(400, "Only the default text response format is supported.",
|
|
"response_format", "unsupported_parameter")
|
|
|
|
maximum = body.get("max_completion_tokens")
|
|
maximum_param = "max_completion_tokens"
|
|
if maximum is None:
|
|
maximum = body.get("max_tokens")
|
|
maximum_param = "max_tokens"
|
|
if maximum is None:
|
|
maximum = min(256, limit)
|
|
temperature = body.get("temperature")
|
|
top_p = body.get("top_p")
|
|
temperature = 0.7 if temperature is None else temperature
|
|
top_p = 0.9 if top_p is None else top_p
|
|
if isinstance(maximum, bool) or not isinstance(maximum, int) or not 1 <= maximum <= limit:
|
|
raise APIError(400, f"`{maximum_param}` must be an integer between 1 and {limit}.", maximum_param)
|
|
if isinstance(temperature, bool) or not isinstance(temperature, (int, float)) or not 0 <= temperature <= 2:
|
|
raise APIError(400, "`temperature` must be between 0 and 2.", "temperature")
|
|
if isinstance(top_p, bool) or not isinstance(top_p, (int, float)) or not 0 < top_p <= 1:
|
|
raise APIError(400, "`top_p` must be greater than 0 and at most 1.", "top_p")
|
|
return maximum, float(temperature), float(top_p)
|
|
|
|
|
|
def read_engine_turn(stream, sentinel, on_bytes):
|
|
pending = b""
|
|
while True:
|
|
byte = stream.read(1)
|
|
if byte == b"":
|
|
raise RuntimeError("colibri engine exited unexpectedly")
|
|
pending += byte
|
|
if pending.endswith(sentinel):
|
|
data = pending[:-len(sentinel)]
|
|
if data:
|
|
on_bytes(data)
|
|
break
|
|
if len(pending) > len(sentinel):
|
|
on_bytes(pending[:-len(sentinel)])
|
|
pending = pending[-len(sentinel):]
|
|
|
|
fields = stream.readline().decode("utf-8", "replace").strip().split()
|
|
if len(fields) < 5 or fields[0] != "STAT":
|
|
raise RuntimeError(f"invalid engine status: {' '.join(fields)}")
|
|
return {
|
|
"completion_tokens": int(fields[1]),
|
|
"tokens_per_second": float(fields[2]),
|
|
"cache_hit_percent": float(fields[3]),
|
|
"rss_gb": float(fields[4]),
|
|
"prompt_tokens": int(fields[5]) if len(fields) > 5 else 0,
|
|
"length_limited": bool(int(fields[6])) if len(fields) > 6 else False,
|
|
}
|
|
|
|
|
|
class Engine:
|
|
def __init__(self, executable, model, cap=8, max_tokens=1024, env=None):
|
|
child_env = dict(env or os.environ, SNAP=str(model), SERVE="1", NGEN=str(max_tokens))
|
|
self.process = subprocess.Popen(
|
|
[str(executable), str(cap)], env=child_env, stdin=subprocess.PIPE,
|
|
stdout=subprocess.PIPE, bufsize=0,
|
|
)
|
|
self.lock = threading.Lock()
|
|
read_engine_turn(self.process.stdout, READY, lambda _: None)
|
|
|
|
def generate(self, prompt, max_tokens, temperature, top_p, on_text):
|
|
payload = prompt.encode("utf-8")
|
|
if b"\0" in payload:
|
|
raise APIError(400, "NUL bytes are not supported in prompts.", "messages")
|
|
decoder = codecs.getincrementaldecoder("utf-8")("replace")
|
|
|
|
def decode(data):
|
|
text = decoder.decode(data)
|
|
if text:
|
|
on_text(text)
|
|
|
|
with self.lock:
|
|
if self.process.poll() is not None:
|
|
raise RuntimeError("colibri engine is not running")
|
|
header = f"\x02PROMPT {len(payload)} {max_tokens} {temperature:.8g} {top_p:.8g}\n".encode()
|
|
self.process.stdin.write(header + payload + b"\n")
|
|
self.process.stdin.flush()
|
|
stats = read_engine_turn(self.process.stdout, END, decode)
|
|
tail = decoder.decode(b"", final=True)
|
|
if tail:
|
|
on_text(tail)
|
|
return stats
|
|
|
|
def close(self):
|
|
if self.process.poll() is None:
|
|
self.process.terminate()
|
|
try:
|
|
self.process.wait(timeout=5)
|
|
except subprocess.TimeoutExpired:
|
|
self.process.kill()
|
|
|
|
|
|
def model_object(model_id, created):
|
|
return {"id": model_id, "object": "model", "created": created, "owned_by": "colibri"}
|
|
|
|
|
|
class APIServer(ThreadingHTTPServer):
|
|
daemon_threads = True
|
|
|
|
def __init__(self, address, engine, model_id, api_key=None, max_tokens=1024,
|
|
cors_origins=DEFAULT_CORS_ORIGINS):
|
|
super().__init__(address, APIHandler)
|
|
self.engine = engine
|
|
self.model_id = model_id
|
|
self.api_key = api_key
|
|
self.max_tokens = max_tokens
|
|
self.cors_origins = tuple(cors_origins)
|
|
self.created = int(time.time())
|
|
|
|
|
|
class APIHandler(BaseHTTPRequestHandler):
|
|
protocol_version = "HTTP/1.1"
|
|
server_version = "colibri"
|
|
|
|
def log_message(self, fmt, *args):
|
|
sys.stderr.write("[api] %s - %s\n" % (self.address_string(), fmt % args))
|
|
|
|
def send_json(self, status, body, request_id=None):
|
|
data = json.dumps(body, ensure_ascii=False, separators=(",", ":")).encode()
|
|
self.send_response(status)
|
|
self.send_header("Content-Type", "application/json")
|
|
self.send_header("Content-Length", str(len(data)))
|
|
if request_id:
|
|
self.send_header("x-request-id", request_id)
|
|
self.send_cors_headers()
|
|
self.end_headers()
|
|
self.wfile.write(data)
|
|
|
|
def send_cors_headers(self):
|
|
origin = self.headers.get("Origin")
|
|
if not origin or ("*" not in self.server.cors_origins and origin not in self.server.cors_origins):
|
|
return
|
|
self.send_header("Access-Control-Allow-Origin", "*" if "*" in self.server.cors_origins else origin)
|
|
self.send_header("Access-Control-Allow-Methods", "GET, POST, OPTIONS")
|
|
self.send_header("Access-Control-Allow-Headers", "Authorization, Content-Type")
|
|
self.send_header("Access-Control-Expose-Headers", "x-request-id")
|
|
self.send_header("Access-Control-Max-Age", "600")
|
|
if "*" not in self.server.cors_origins:
|
|
self.send_header("Vary", "Origin")
|
|
|
|
def require_auth(self):
|
|
if self.server.api_key and self.headers.get("Authorization") != f"Bearer {self.server.api_key}":
|
|
raise APIError(401, "Invalid or missing API key.", None, "invalid_api_key",
|
|
"authentication_error")
|
|
|
|
def read_json(self):
|
|
try:
|
|
length = int(self.headers.get("Content-Length", "0"))
|
|
except ValueError:
|
|
raise APIError(400, "Invalid Content-Length header.")
|
|
if length < 1 or length > MAX_BODY:
|
|
raise APIError(400, f"Request body must be between 1 and {MAX_BODY} bytes.")
|
|
try:
|
|
body = json.loads(self.rfile.read(length))
|
|
except (json.JSONDecodeError, UnicodeDecodeError):
|
|
raise APIError(400, "Request body must be valid JSON.")
|
|
if not isinstance(body, dict):
|
|
raise APIError(400, "Request body must be a JSON object.")
|
|
return body
|
|
|
|
def check_model(self, body):
|
|
model = body.get("model")
|
|
if model != self.server.model_id:
|
|
raise APIError(404, f"The model `{model}` does not exist.", "model", "model_not_found")
|
|
|
|
def do_GET(self):
|
|
request_id = "req_" + uuid.uuid4().hex
|
|
try:
|
|
path = urlsplit(self.path).path
|
|
if path == "/health":
|
|
self.send_json(200, {"status": "ok"}, request_id)
|
|
return
|
|
self.require_auth()
|
|
if path == "/v1/models":
|
|
self.send_json(200, {"object": "list", "data": [model_object(
|
|
self.server.model_id, self.server.created)]}, request_id)
|
|
elif path.startswith("/v1/models/") and unquote(path[11:]) == self.server.model_id:
|
|
self.send_json(200, model_object(self.server.model_id, self.server.created), request_id)
|
|
else:
|
|
raise APIError(404, "Not found.", None, "not_found")
|
|
except APIError as error:
|
|
self.send_json(error.status, error_object(error), request_id)
|
|
|
|
def do_OPTIONS(self):
|
|
self.send_response(204)
|
|
self.send_header("Content-Length", "0")
|
|
self.send_cors_headers()
|
|
self.end_headers()
|
|
|
|
def do_POST(self):
|
|
request_id = "req_" + uuid.uuid4().hex
|
|
try:
|
|
self.require_auth()
|
|
body = self.read_json()
|
|
self.check_model(body)
|
|
path = urlsplit(self.path).path
|
|
if path == "/v1/chat/completions":
|
|
self.chat_completion(body, request_id)
|
|
elif path == "/v1/completions":
|
|
self.completion(body, request_id)
|
|
else:
|
|
raise APIError(404, "Not found.", None, "not_found")
|
|
except APIError as error:
|
|
self.send_json(error.status, error_object(error), request_id)
|
|
except (BrokenPipeError, ConnectionResetError):
|
|
pass
|
|
except Exception as error:
|
|
self.log_error("request failed: %s", error)
|
|
api_error = APIError(500, "The colibri engine failed to process the request.",
|
|
None, "engine_error", "server_error")
|
|
try:
|
|
self.send_json(500, error_object(api_error), request_id)
|
|
except OSError:
|
|
pass
|
|
|
|
def generation(self, body, prompt, request_id, chat):
|
|
maximum, temperature, top_p = generation_options(body, self.server.max_tokens)
|
|
stream = body.get("stream", False)
|
|
if not isinstance(stream, bool):
|
|
raise APIError(400, "`stream` must be a boolean.", "stream")
|
|
object_name = "chat.completion" if chat else "text_completion"
|
|
id_prefix = "chatcmpl-" if chat else "cmpl-"
|
|
completion_id = id_prefix + uuid.uuid4().hex
|
|
created = int(time.time())
|
|
|
|
if not stream:
|
|
output = []
|
|
stats = self.server.engine.generate(prompt, maximum, temperature, top_p, output.append)
|
|
text = "".join(output)
|
|
finish = "length" if stats["length_limited"] else "stop"
|
|
choice = ({"index": 0, "message": {"role": "assistant", "content": text,
|
|
"refusal": None}, "logprobs": None, "finish_reason": finish} if chat else
|
|
{"index": 0, "text": text, "logprobs": None, "finish_reason": finish})
|
|
self.send_json(200, {"id": completion_id, "object": object_name, "created": created,
|
|
"model": self.server.model_id, "choices": [choice], "usage": self.usage(stats)}, request_id)
|
|
return
|
|
|
|
stream_options = body.get("stream_options")
|
|
if stream_options is not None and not isinstance(stream_options, dict):
|
|
raise APIError(400, "`stream_options` must be an object.", "stream_options")
|
|
include_usage = bool((stream_options or {}).get("include_usage"))
|
|
stream_object = "chat.completion.chunk" if chat else object_name
|
|
self.send_response(200)
|
|
self.send_header("Content-Type", "text/event-stream")
|
|
self.send_header("Cache-Control", "no-cache")
|
|
self.send_header("X-Accel-Buffering", "no")
|
|
self.send_header("x-request-id", request_id)
|
|
self.send_cors_headers()
|
|
self.end_headers()
|
|
connected = True
|
|
|
|
def event(choices, usage_marker=False):
|
|
nonlocal connected
|
|
if not connected:
|
|
return
|
|
event_body = {"id": completion_id, "object": stream_object, "created": created,
|
|
"model": self.server.model_id, "choices": choices}
|
|
if include_usage:
|
|
event_body["usage"] = None if not usage_marker else usage_marker
|
|
try:
|
|
data = json.dumps(event_body, ensure_ascii=False, separators=(",", ":"))
|
|
self.wfile.write(f"data: {data}\n\n".encode())
|
|
self.wfile.flush()
|
|
except OSError:
|
|
connected = False
|
|
|
|
if chat:
|
|
event([{"index": 0, "delta": {"role": "assistant", "content": ""},
|
|
"logprobs": None, "finish_reason": None}])
|
|
|
|
def emit(text):
|
|
choice = ({"index": 0, "delta": {"content": text}, "logprobs": None,
|
|
"finish_reason": None} if chat else
|
|
{"index": 0, "text": text, "logprobs": None, "finish_reason": None})
|
|
event([choice])
|
|
|
|
stats = self.server.engine.generate(prompt, maximum, temperature, top_p, emit)
|
|
finish = "length" if stats["length_limited"] else "stop"
|
|
final_choice = ({"index": 0, "delta": {}, "logprobs": None, "finish_reason": finish}
|
|
if chat else {"index": 0, "text": "", "logprobs": None,
|
|
"finish_reason": finish})
|
|
event([final_choice])
|
|
if include_usage:
|
|
event([], self.usage(stats))
|
|
if connected:
|
|
try:
|
|
self.wfile.write(b"data: [DONE]\n\n")
|
|
self.wfile.flush()
|
|
except OSError:
|
|
pass
|
|
self.close_connection = True
|
|
|
|
@staticmethod
|
|
def usage(stats):
|
|
prompt = stats["prompt_tokens"]
|
|
completion = stats["completion_tokens"]
|
|
return {"prompt_tokens": prompt, "completion_tokens": completion,
|
|
"total_tokens": prompt + completion}
|
|
|
|
def chat_completion(self, body, request_id):
|
|
reasoning_effort = body.get("reasoning_effort")
|
|
efforts = (None, "none", "minimal", "low", "medium", "high", "xhigh")
|
|
if reasoning_effort not in efforts:
|
|
raise APIError(400, "`reasoning_effort` must be none, minimal, low, medium, high, or xhigh.",
|
|
"reasoning_effort")
|
|
enable_thinking = body.get("enable_thinking", reasoning_effort not in (None, "none"))
|
|
if not isinstance(enable_thinking, bool):
|
|
raise APIError(400, "`enable_thinking` must be a boolean.", "enable_thinking")
|
|
prompt = render_chat(body.get("messages"), enable_thinking, reasoning_effort)
|
|
self.generation(body, prompt, request_id, True)
|
|
|
|
def completion(self, body, request_id):
|
|
prompt = body.get("prompt")
|
|
if not isinstance(prompt, str):
|
|
raise APIError(400, "Colibri currently requires `prompt` to be a string.", "prompt")
|
|
self.generation(body, prompt, request_id, False)
|
|
|
|
|
|
def serve(model, host="127.0.0.1", port=8000, model_id="glm-5.2-colibri", api_key=None,
|
|
cap=8, max_tokens=1024, engine=HERE / "glm", env=None, cors_origins=None):
|
|
if not 1 <= max_tokens:
|
|
raise ValueError("max_tokens must be positive")
|
|
if not 1 <= port <= 65535:
|
|
raise ValueError("port must be between 1 and 65535")
|
|
if host not in ("127.0.0.1", "localhost", "::1") and not api_key:
|
|
print("WARNING: API is listening beyond localhost without COLI_API_KEY", file=sys.stderr)
|
|
runtime = Engine(engine, model, cap, max_tokens, env)
|
|
origins = DEFAULT_CORS_ORIGINS if cors_origins is None else tuple(cors_origins)
|
|
server = APIServer((host, port), runtime, model_id, api_key, max_tokens, origins)
|
|
print(f"OpenAI-compatible API listening on http://{host}:{port}/v1", file=sys.stderr)
|
|
previous_sigterm = signal.getsignal(signal.SIGTERM)
|
|
signal.signal(signal.SIGTERM, lambda *_: threading.Thread(target=server.shutdown, daemon=True).start())
|
|
try:
|
|
server.serve_forever()
|
|
finally:
|
|
signal.signal(signal.SIGTERM, previous_sigterm)
|
|
server.server_close()
|
|
runtime.close()
|
|
|
|
|
|
def main():
|
|
parser = argparse.ArgumentParser(description=__doc__)
|
|
parser.add_argument("--model", default=os.environ.get("COLI_MODEL"), required=not os.environ.get("COLI_MODEL"))
|
|
parser.add_argument("--engine", default=str(HERE / "glm"))
|
|
parser.add_argument("--host", default="127.0.0.1")
|
|
parser.add_argument("--port", type=int, default=8000)
|
|
parser.add_argument("--model-id", default=os.environ.get("COLI_MODEL_ID", "glm-5.2-colibri"))
|
|
parser.add_argument("--api-key", default=os.environ.get("COLI_API_KEY"))
|
|
parser.add_argument("--cors-origin", action="append", default=None,
|
|
help="allowed browser origin; repeat as needed (use '*' for any origin)")
|
|
parser.add_argument("--cap", type=int, default=8)
|
|
parser.add_argument("--max-tokens", type=int, default=1024)
|
|
args = parser.parse_args()
|
|
serve(args.model, args.host, args.port, args.model_id, args.api_key,
|
|
args.cap, args.max_tokens, args.engine, cors_origins=args.cors_origin)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|