Spaces:
Sleeping
Sleeping
File size: 45,993 Bytes
6303ae6 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 | """Central LLM client.
This is the ONLY module that talks to Anthropic, OpenAI, Groq, or Gemini
directly (Groq for text only). All other services route through
:func:`call_text_llm` or :func:`call_vision_llm` so:
* every API call is captured in :data:`st.session_state.api_usage_log`
with a stable ``task_name``,
* the UI can show a single "API Usage Status" panel that knows which
stages really used the API,
* the API key is never returned, logged, or echoed.
Return value
------------
Every call returns an :class:`LLMCallResult` with::
success: bool
task_name: str
provider: str | None
model: str | None
used_api: bool
response_text: str | None
response_json: dict | list | None
error_message: str | None
timestamp: str # ISO 8601, UTC
estimated_input_tokens: int | None
estimated_output_tokens: int | None
status: str # "ok" | "no_api" | "invalid_key" | "quota" |
# "connection" | "model_missing" | "parse_error"
# | "unsupported_provider" | "skipped" | "exception"
``used_api`` is true only when bytes actually went over the wire (or were
attempted). Callers that fall back to local logic set it to ``False`` via
:func:`record_local_use`.
"""
from __future__ import annotations
import base64
import json
import logging
import os
import re
import time
from dataclasses import asdict, dataclass, field
from datetime import datetime, timezone
from typing import Any, Iterable, Optional
from app.config import (
GROQ_VISION_UNSUPPORTED_MESSAGE,
LLM_TASK_NAMES,
Settings,
get_settings,
)
from app.utils.logging_utils import get_logger
from app.utils.redaction import (
API_KEY_PATTERNS as _API_KEY_PATTERNS,
ORG_ID_PATTERNS as _ORG_ID_PATTERNS,
redact as _redact,
)
_logger: logging.Logger = get_logger("upwork_strategist.llm_client")
# Stable status codes — surfaced verbatim by the UI / api_gate.
STATUS_OK = "ok"
STATUS_NO_API = "no_api"
STATUS_INVALID_KEY = "invalid_key"
STATUS_QUOTA = "quota"
STATUS_CONTEXT_OVERFLOW = "context_overflow"
STATUS_CONNECTION = "connection"
STATUS_MODEL_MISSING = "model_missing"
STATUS_PARSE_ERROR = "parse_error"
STATUS_TRUNCATED = "truncated"
STATUS_UNSUPPORTED_PROVIDER = "unsupported_provider"
STATUS_SKIPPED = "skipped"
STATUS_EXCEPTION = "exception"
_SUPPORTED_PROVIDERS = ("anthropic", "openai", "groq", "gemini")
# Providers that can read images. Groq is text-only here, so it is excluded
# and handled with a dedicated, actionable message in ``call_vision_llm``.
_SUPPORTED_VISION_PROVIDERS = ("anthropic", "openai", "gemini")
# Per-request HTTP timeout (seconds) applied to every provider client so a
# hung socket cannot freeze the synchronous Streamlit call indefinitely.
# Overridable via the LLM_REQUEST_TIMEOUT env var.
def _request_timeout() -> float:
raw = os.getenv("LLM_REQUEST_TIMEOUT", "").strip()
try:
value = float(raw)
if value > 0:
return value
except (TypeError, ValueError):
pass
return 60.0
# Bounded transient-failure retry. Only STATUS_CONNECTION and genuine
# rate-limit (STATUS_QUOTA) are retried; auth/model/parse/context errors
# are never retried (retrying cannot help and would waste calls/money).
_MAX_ATTEMPTS = 3
_RETRYABLE_STATUSES = (STATUS_CONNECTION, STATUS_QUOTA)
# Backoff base in seconds (exponential: base, base*2, …). Kept small so the
# synchronous UI is never blocked for long.
_RETRY_BACKOFF_BASE = 0.5
# Finish/stop reasons that mean the model was cut off by the token budget.
_TRUNCATION_REASONS = frozenset(
{"length", "max_tokens", "max_output_tokens"}
)
# ---------------------------------------------------------------------------
# Result type
# ---------------------------------------------------------------------------
@dataclass
class LLMCallResult:
success: bool
task_name: str
provider: Optional[str] = None
model: Optional[str] = None
used_api: bool = False
response_text: Optional[str] = None
response_json: Any = None
error_message: Optional[str] = None
timestamp: str = field(
default_factory=lambda: datetime.now(timezone.utc).isoformat(timespec="seconds")
)
estimated_input_tokens: Optional[int] = None
estimated_output_tokens: Optional[int] = None
status: str = STATUS_OK
duration_seconds: Optional[float] = None
def to_log_entry(self) -> dict:
"""Return a dict that is safe to display in the UI / usage log."""
return {
"timestamp": self.timestamp,
"task_name": self.task_name,
"provider": self.provider,
"model": self.model,
"used_api": self.used_api,
"status": self.status,
"error_message": self.error_message,
"duration_seconds": self.duration_seconds,
"estimated_input_tokens": self.estimated_input_tokens,
"estimated_output_tokens": self.estimated_output_tokens,
# response_text / response_json are intentionally NOT stored
# in the usage log — that log is metadata-only.
}
# ---------------------------------------------------------------------------
# Session-state usage log
# ---------------------------------------------------------------------------
def _record_to_session(entry: dict) -> None:
"""Append ``entry`` to ``st.session_state.api_usage_log`` if available."""
try:
import streamlit as st # type: ignore
except Exception: # pragma: no cover - streamlit not always loaded
return
try:
log = st.session_state.get("api_usage_log")
if log is None:
log = []
st.session_state["api_usage_log"] = log
log.append(entry)
except Exception: # pragma: no cover - not running inside a session
return
def record_local_use(task_name: str, *, note: str = "") -> None:
"""Record a non-API stage so the UI can show LOCAL PLACEHOLDER clearly.
Callers that intentionally use deterministic local logic must call
this so the API Usage panel can flag the stage.
"""
entry = {
"timestamp": datetime.now(timezone.utc).isoformat(timespec="seconds"),
"task_name": task_name,
"provider": None,
"model": None,
"used_api": False,
"status": "local_placeholder",
"error_message": note or None,
"duration_seconds": None,
"estimated_input_tokens": None,
"estimated_output_tokens": None,
}
_record_to_session(entry)
_logger.info(
"stage=%s used_api=false status=local_placeholder note=%s",
task_name,
note or "-",
)
def get_usage_log() -> list[dict]:
"""Return the current session's usage log (or an empty list)."""
try:
import streamlit as st # type: ignore
except Exception: # pragma: no cover
return []
try:
return list(st.session_state.get("api_usage_log") or [])
except Exception: # pragma: no cover
return []
def reset_usage_log() -> None:
try:
import streamlit as st # type: ignore
except Exception: # pragma: no cover
return
try:
st.session_state["api_usage_log"] = []
except Exception: # pragma: no cover
return
# ---------------------------------------------------------------------------
# Helpers
# ---------------------------------------------------------------------------
def _validate_task_name(task_name: str) -> None:
if task_name not in LLM_TASK_NAMES:
_logger.warning("unknown llm task_name=%s", task_name)
def _estimate_tokens(text: str) -> int:
if not text:
return 0
# Rough heuristic: ~4 characters per token. Cheap, never exact.
return max(1, len(text) // 4)
def _resolve_key(settings: Settings, provider: Optional[str] = None) -> Optional[str]:
target = (provider or settings.llm_provider or "").lower()
return {
"anthropic": settings.anthropic_api_key,
"openai": settings.openai_api_key,
"groq": settings.groq_api_key,
"gemini": settings.gemini_api_key,
}.get(target)
def _resolve_model(settings: Settings, *, vision: bool = False) -> Optional[str]:
if vision:
# Vision model resolution (VISION_MODEL, or the text model when it is
# itself vision-capable) lives on Settings so the rule is shared.
return settings.active_vision_model
return {
"anthropic": settings.anthropic_model,
"openai": settings.openai_model,
"groq": settings.groq_model,
"gemini": settings.gemini_model,
}.get((settings.llm_provider or "").lower())
def _resolve_provider(settings: Settings, *, vision: bool = False) -> str:
if vision:
return settings.active_vision_provider
return (settings.llm_provider or "").lower()
def _find_json_span(text: str) -> Optional[Any]:
"""Return the first complete JSON value embedded in ``text``.
Scans from each ``{`` or ``[`` and uses ``json.JSONDecoder.raw_decode``
to find the first span that decodes cleanly. This replaces the old
greedy ``(\\{.*\\}|\\[.*\\])`` regex, which spanned from the first
brace to the LAST one — so prose containing a stray brace, or two
objects, would defeat it and a perfectly good object would parse as
``None``. The scanner finds the *first* balanced, decodable value.
"""
decoder = json.JSONDecoder()
for idx, ch in enumerate(text):
if ch not in "{[":
continue
try:
value, _end = decoder.raw_decode(text, idx)
except ValueError:
continue
return value
return None
def _parse_json(text: str) -> Optional[Any]:
if not text:
return None
candidate = text.strip()
candidate = re.sub(r"^```(?:json)?", "", candidate).strip()
candidate = re.sub(r"```$", "", candidate).strip()
try:
return json.loads(candidate)
except ValueError:
pass
# Fallback: locate the first balanced, decodable JSON value rather than
# greedily spanning to the last brace in the string.
return _find_json_span(candidate)
def _data_url(data: bytes, mime: str) -> str:
return f"data:{mime};base64," + base64.b64encode(data).decode("ascii")
def _classify_exception(exc: BaseException) -> str:
"""Map provider SDK exceptions to one of the stable status codes.
Covers OpenAI/Anthropic/Groq (httpx-based SDKs) and Gemini
(``google.api_core`` exceptions such as ``PermissionDenied``,
``ResourceExhausted``, ``InvalidArgument``, ``NotFound``).
"""
name = exc.__class__.__name__.lower()
msg = str(exc).lower()
if (
"auth" in name
or "permissiondenied" in name
or "unauthenticated" in name
or ("invalid" in name and "key" in msg)
):
return STATUS_INVALID_KEY
if (
"authentication" in msg
or "invalid api key" in msg
or "api key not valid" in msg
or "api_key_invalid" in msg
or "permission denied" in msg
or "unauthorized" in msg
):
return STATUS_INVALID_KEY
# Context-window / prompt-size overflow is a DISTINCT condition from a
# billing/rate-limit quota: the fix is "send less input / raise
# max_tokens", not "wait or buy credits". Classify it first so it is
# never mislabeled as STATUS_QUOTA (which would tell the user they are
# out of credits). Note the parenthesized and-clause — without parens
# Python's `and` binds tighter than `or`, which silently changed the
# intended grouping in the original code.
if (
"context length" in msg
or "context_length" in msg
or "context window" in msg
or "maximum context" in msg
or "too many tokens" in msg
or "token limit" in msg
or "tokens exceed" in msg
or ("exceeds the" in msg and "token" in msg)
or "request too large" in msg
or "reduce the length" in msg
):
return STATUS_CONTEXT_OVERFLOW
if (
"ratelimit" in name
or "resourceexhausted" in name
or "quota" in msg
or "rate limit" in msg
or "rate_limit" in msg
or "insufficient" in msg
or "429" in msg
or "tokens per minute" in msg
or "tokens-per-minute" in msg
or "tpm" in msg
):
return STATUS_QUOTA
if (
"connect" in name
or "timeout" in name
or "deadlineexceeded" in name
or "serviceunavailable" in name
or "internalservererror" in name
or "network" in msg
or "connection" in msg
):
return STATUS_CONNECTION
if "notfound" in name or ("model" in msg and "not" in msg):
return STATUS_MODEL_MISSING
return STATUS_EXCEPTION
# Key/org-id patterns now live in app.utils.redaction (single source of
# truth, imported above as _API_KEY_PATTERNS / _ORG_ID_PATTERNS) so the
# sink-level logging Filter and this sanitizer can never drift apart.
def sanitize_error_message(
message: Optional[str], *, secrets: Iterable[Optional[str]] = ()
) -> Optional[str]:
"""Return ``message`` with API keys and provider organization IDs scrubbed.
The UI and the API usage log only ever show the sanitized form. Provider
SDK errors can echo the raw API key (an OpenAI-compatible endpoint emits
"Incorrect API key provided: sk-..."; Gemini emits "API key not valid.
Provided: AIza..."), so this redacts, in order:
* any exact ``secrets`` value the caller supplies (the configured key) —
catches even unanticipated formats,
* API-key-shaped tokens for every provider family,
* provider organization IDs and request slugs.
Idempotent — safe to call more than once — and never returns a raw key.
Delegates to :func:`app.utils.redaction.redact` (also used by the
logging Filter) so there is exactly one definition of "what is a secret".
"""
return _redact(message, secrets=secrets)
def extend_last_entry(task_name: str, extra: dict) -> None:
"""Merge ``extra`` into the most recent usage-log entry for ``task_name``.
Used by callers that need to attach task-specific metadata
(e.g. compact-context size) to the entry the central client wrote.
The merge is metadata-only — callers must not pass raw prompts,
proposal text, dossier content, or API keys.
If no entry yet exists for ``task_name`` (this happens in tests
that monkey-patch the provider call and bypass the central
finalize step), a fresh metadata-only entry is appended so the
caller's attached fields are still recorded.
"""
try:
import streamlit as st # type: ignore
except Exception: # pragma: no cover - streamlit not always loaded
return
try:
log = st.session_state.get("api_usage_log")
if log is None:
log = []
st.session_state["api_usage_log"] = log
except Exception: # pragma: no cover
return
for entry in reversed(log):
if entry.get("task_name") == task_name:
entry.update(extra)
return
new_entry: dict = {
"timestamp": datetime.now(timezone.utc).isoformat(timespec="seconds"),
"task_name": task_name,
"provider": None,
"model": None,
"used_api": False,
"status": "metadata_only",
"error_message": None,
"duration_seconds": None,
"estimated_input_tokens": None,
"estimated_output_tokens": None,
}
new_entry.update(extra)
log.append(new_entry)
def _normalize_image(image: Any) -> Optional[tuple[bytes, str]]:
"""Return (raw_bytes, mime) for a Streamlit UploadedFile or bytes-like."""
if image is None:
return None
if isinstance(image, tuple) and len(image) == 2 and isinstance(image[0], (bytes, bytearray)):
return bytes(image[0]), str(image[1]) or "image/png"
if isinstance(image, (bytes, bytearray)):
return bytes(image), "image/png"
name = getattr(image, "name", "") or ""
mime = getattr(image, "type", "") or ""
suffix = name.lower().rsplit(".", 1)[-1] if "." in name else ""
if not mime:
mime = {
"png": "image/png",
"jpg": "image/jpeg",
"jpeg": "image/jpeg",
"webp": "image/webp",
}.get(suffix, "image/png")
data: Optional[bytes] = None
if hasattr(image, "getvalue"):
try:
data = image.getvalue()
except Exception: # noqa: BLE001
data = None
if data is None and hasattr(image, "read"):
try:
if hasattr(image, "seek"):
image.seek(0)
data = image.read()
except Exception: # noqa: BLE001
data = None
if data is None:
return None
return data, mime
# Target long-edge size (px) we upscale small screenshots to before sending to
# the vision model. Small pasted screenshots have tiny client-panel text the
# model can't resolve; enlarging the image to a comfortable resolution makes
# that fine print legible. ~1600 px matches what the major vision models
# downsample to internally, so we never send needlessly huge payloads.
_VISION_TARGET_LONG_EDGE = 1600
# Only upscale when the long edge is below this — images already large enough
# are left untouched (no quality loss, no wasted bytes).
_VISION_MIN_LONG_EDGE = 1100
# Hard cap so a pathological tiny image isn't blown up enormously.
_VISION_MAX_UPSCALE = 3.0
def _prepare_vision_image(data: bytes, mime: str) -> tuple[bytes, str]:
"""Upscale a small screenshot so the vision model can read fine print.
Best-effort: if Pillow is unavailable or the image can't be decoded, the
original bytes are returned unchanged. Larger images are returned as-is.
Upscaled output is re-encoded as lossless PNG so small text stays crisp.
"""
try:
import io as _io
from PIL import Image # type: ignore
except Exception: # noqa: BLE001 - Pillow missing → send original
return data, mime
try:
with Image.open(_io.BytesIO(data)) as im:
im.load()
w, h = im.size
long_edge = max(w, h)
if long_edge <= 0 or long_edge >= _VISION_MIN_LONG_EDGE:
return data, mime # already big enough
scale = min(_VISION_TARGET_LONG_EDGE / long_edge, _VISION_MAX_UPSCALE)
if scale <= 1.0:
return data, mime
new_size = (max(1, round(w * scale)), max(1, round(h * scale)))
# Convert to a safe mode for PNG, then high-quality upscale.
if im.mode not in ("RGB", "RGBA", "L"):
im = im.convert("RGB")
resized = im.resize(new_size, Image.LANCZOS)
buf = _io.BytesIO()
resized.save(buf, format="PNG", optimize=True)
return buf.getvalue(), "image/png"
except Exception: # noqa: BLE001 - any decode/resize failure → send original
return data, mime
# ---------------------------------------------------------------------------
# Provider adapters
# ---------------------------------------------------------------------------
def _anthropic_text(
*,
api_key: str,
model: str,
system_prompt: str,
user_prompt: str,
expected_json: bool,
max_tokens: int,
) -> tuple[str, Optional[int], Optional[int], Optional[str]]:
import anthropic # type: ignore
client = anthropic.Anthropic(api_key=api_key, timeout=_request_timeout())
response = client.messages.create(
model=model,
max_tokens=max_tokens,
temperature=0,
system=system_prompt or "",
messages=[{"role": "user", "content": user_prompt}],
)
parts: list[str] = []
for block in getattr(response, "content", []) or []:
text = getattr(block, "text", None)
if text:
parts.append(text)
out_text = "\n".join(parts).strip()
usage = getattr(response, "usage", None)
in_tokens = getattr(usage, "input_tokens", None) if usage else None
out_tokens = getattr(usage, "output_tokens", None) if usage else None
finish = getattr(response, "stop_reason", None)
return out_text, in_tokens, out_tokens, finish
def _openai_text(
*,
api_key: str,
model: str,
system_prompt: str,
user_prompt: str,
expected_json: bool,
max_tokens: int,
) -> tuple[str, Optional[int], Optional[int], Optional[str]]:
from openai import OpenAI # type: ignore
client = OpenAI(api_key=api_key, timeout=_request_timeout())
kwargs: dict[str, Any] = {
"model": model,
"messages": [
*([{"role": "system", "content": system_prompt}] if system_prompt else []),
{"role": "user", "content": user_prompt},
],
"temperature": 0,
}
if expected_json:
kwargs["response_format"] = {"type": "json_object"}
response = client.chat.completions.create(**kwargs)
out_text = (response.choices[0].message.content or "").strip()
usage = getattr(response, "usage", None)
in_tokens = getattr(usage, "prompt_tokens", None) if usage else None
out_tokens = getattr(usage, "completion_tokens", None) if usage else None
finish = getattr(response.choices[0], "finish_reason", None)
return out_text, in_tokens, out_tokens, finish
def _groq_text(
*,
api_key: str,
model: str,
system_prompt: str,
user_prompt: str,
expected_json: bool,
max_tokens: int,
) -> tuple[str, Optional[int], Optional[int], Optional[str]]:
"""Groq text completion (text-only — Groq has no image input).
Groq exposes an OpenAI-compatible Chat Completions API. We prefer the
official ``groq`` SDK when installed and otherwise fall back to the
already-bundled ``openai`` SDK pointed at Groq's compatibility endpoint,
so the provider works even when ``groq`` was not separately installed.
The API key is passed to the client only and never logged.
"""
messages = [
*([{"role": "system", "content": system_prompt}] if system_prompt else []),
{"role": "user", "content": user_prompt},
]
kwargs: dict[str, Any] = {"model": model, "messages": messages, "temperature": 0}
if expected_json:
kwargs["response_format"] = {"type": "json_object"}
try:
from groq import Groq # type: ignore
client = Groq(api_key=api_key, timeout=_request_timeout())
except ModuleNotFoundError:
# OpenAI-compatible fallback (the openai SDK ships with this app).
from openai import OpenAI # type: ignore
client = OpenAI(
api_key=api_key,
base_url="https://api.groq.com/openai/v1",
timeout=_request_timeout(),
)
response = client.chat.completions.create(**kwargs)
out_text = (response.choices[0].message.content or "").strip()
usage = getattr(response, "usage", None)
in_tokens = getattr(usage, "prompt_tokens", None) if usage else None
out_tokens = getattr(usage, "completion_tokens", None) if usage else None
finish = getattr(response.choices[0], "finish_reason", None)
return out_text, in_tokens, out_tokens, finish
def _gemini_response_text(response: Any) -> str:
"""Best-effort text extraction from a Gemini response.
``response.text`` raises when the only candidate was blocked or empty, so
we fall back to manually concatenating any text parts on the candidates.
"""
try:
text = getattr(response, "text", None)
if text:
return text.strip()
except Exception: # noqa: BLE001 - blocked/empty candidate; fall back below
pass
parts: list[str] = []
for candidate in getattr(response, "candidates", None) or []:
content = getattr(candidate, "content", None)
for part in getattr(content, "parts", None) or []:
piece = getattr(part, "text", None)
if piece:
parts.append(piece)
return "\n".join(parts).strip()
def _gemini_usage(response: Any) -> tuple[Optional[int], Optional[int]]:
usage = getattr(response, "usage_metadata", None)
in_tokens = getattr(usage, "prompt_token_count", None) if usage else None
out_tokens = getattr(usage, "candidates_token_count", None) if usage else None
return in_tokens, out_tokens
def _gemini_finish_reason(response: Any) -> Optional[str]:
"""Return the first candidate's finish reason as a lowercase string.
Gemini exposes ``finish_reason`` as an enum (e.g. ``MAX_TOKENS``); we
normalize it to a string so the truncation check can recognize it.
"""
for candidate in getattr(response, "candidates", None) or []:
reason = getattr(candidate, "finish_reason", None)
if reason is None:
continue
name = getattr(reason, "name", None)
return str(name if name is not None else reason).lower()
return None
def _gemini_model_obj(
*, api_key: str, model: str, system_prompt: str, expected_json: bool, max_tokens: int
):
"""Build a configured ``genai.GenerativeModel``. Key is never logged."""
import google.generativeai as genai # type: ignore
genai.configure(api_key=api_key)
generation_config: dict[str, Any] = {
"temperature": 0,
"max_output_tokens": max_tokens,
}
if expected_json:
generation_config["response_mime_type"] = "application/json"
return genai.GenerativeModel(
model_name=model,
system_instruction=system_prompt or None,
generation_config=generation_config,
)
def _gemini_text(
*,
api_key: str,
model: str,
system_prompt: str,
user_prompt: str,
expected_json: bool,
max_tokens: int,
) -> tuple[str, Optional[int], Optional[int], Optional[str]]:
"""Gemini text completion via the google-generativeai SDK.
When ``expected_json`` is set we both request a JSON response MIME type and
reinforce strict-JSON output in the prompt.
"""
gen_model = _gemini_model_obj(
api_key=api_key,
model=model,
system_prompt=system_prompt,
expected_json=expected_json,
max_tokens=max_tokens,
)
prompt = user_prompt
if expected_json:
prompt = (
f"{user_prompt}\n\nReturn ONLY a single valid JSON object. "
"Do not include any prose or Markdown code fences."
)
# A per-request timeout is only honored when passed to generate_content
# via request_options — a configure-/model-level timeout is ignored.
response = gen_model.generate_content(
prompt, request_options={"timeout": _request_timeout()}
)
out_text = _gemini_response_text(response)
in_tokens, out_tokens = _gemini_usage(response)
finish = _gemini_finish_reason(response)
return out_text, in_tokens, out_tokens, finish
def _anthropic_vision(
*,
api_key: str,
model: str,
system_prompt: str,
user_prompt: str,
images: list[tuple[bytes, str]],
expected_json: bool,
max_tokens: int,
) -> tuple[str, Optional[int], Optional[int], Optional[str]]:
import anthropic # type: ignore
client = anthropic.Anthropic(api_key=api_key, timeout=_request_timeout())
content: list[dict[str, Any]] = []
for data, mime in images:
content.append(
{
"type": "image",
"source": {
"type": "base64",
"media_type": mime,
"data": base64.b64encode(data).decode("ascii"),
},
}
)
if user_prompt:
content.append({"type": "text", "text": user_prompt})
response = client.messages.create(
model=model,
max_tokens=max_tokens,
temperature=0,
system=system_prompt or "",
messages=[{"role": "user", "content": content}],
)
parts: list[str] = []
for block in getattr(response, "content", []) or []:
text = getattr(block, "text", None)
if text:
parts.append(text)
out_text = "\n".join(parts).strip()
usage = getattr(response, "usage", None)
in_tokens = getattr(usage, "input_tokens", None) if usage else None
out_tokens = getattr(usage, "output_tokens", None) if usage else None
finish = getattr(response, "stop_reason", None)
return out_text, in_tokens, out_tokens, finish
def _openai_vision(
*,
api_key: str,
model: str,
system_prompt: str,
user_prompt: str,
images: list[tuple[bytes, str]],
expected_json: bool,
max_tokens: int,
) -> tuple[str, Optional[int], Optional[int], Optional[str]]:
from openai import OpenAI # type: ignore
client = OpenAI(api_key=api_key, timeout=_request_timeout())
content: list[dict[str, Any]] = []
if user_prompt:
content.append({"type": "text", "text": user_prompt})
for data, mime in images:
# detail="high" makes OpenAI process the image at full resolution (tiled),
# which is essential for reading small text in a job-post screenshot.
content.append({
"type": "image_url",
"image_url": {"url": _data_url(data, mime), "detail": "high"},
})
kwargs: dict[str, Any] = {
"model": model,
"messages": [
*([{"role": "system", "content": system_prompt}] if system_prompt else []),
{"role": "user", "content": content},
],
"temperature": 0,
}
if expected_json:
kwargs["response_format"] = {"type": "json_object"}
response = client.chat.completions.create(**kwargs)
out_text = (response.choices[0].message.content or "").strip()
usage = getattr(response, "usage", None)
in_tokens = getattr(usage, "prompt_tokens", None) if usage else None
out_tokens = getattr(usage, "completion_tokens", None) if usage else None
finish = getattr(response.choices[0], "finish_reason", None)
return out_text, in_tokens, out_tokens, finish
def _gemini_vision(
*,
api_key: str,
model: str,
system_prompt: str,
user_prompt: str,
images: list[tuple[bytes, str]],
expected_json: bool,
max_tokens: int,
) -> tuple[str, Optional[int], Optional[int], Optional[str]]:
"""Gemini multimodal completion: prompt text plus inline image blobs."""
gen_model = _gemini_model_obj(
api_key=api_key,
model=model,
system_prompt=system_prompt,
expected_json=expected_json,
max_tokens=max_tokens,
)
content: list[Any] = []
if user_prompt:
content.append(user_prompt)
for data, mime in images:
# google-generativeai accepts inline blobs as {"mime_type", "data"}.
content.append({"mime_type": mime, "data": data})
response = gen_model.generate_content(
content, request_options={"timeout": _request_timeout()}
)
out_text = _gemini_response_text(response)
in_tokens, out_tokens = _gemini_usage(response)
finish = _gemini_finish_reason(response)
return out_text, in_tokens, out_tokens, finish
# ---------------------------------------------------------------------------
# Adapter invocation helpers (retry + tolerant unpack)
# ---------------------------------------------------------------------------
def _normalize_adapter_return(ret: Any) -> tuple[str, Optional[int], Optional[int], Optional[str]]:
"""Accept a 3- or 4-tuple from a provider adapter.
Real adapters return ``(text, in_tokens, out_tokens, finish_reason)``;
older/monkeypatched fakes return the legacy 3-tuple. This keeps both
working without forcing every test to add a finish reason.
"""
if isinstance(ret, tuple) and len(ret) == 4:
return ret
if isinstance(ret, tuple) and len(ret) == 3:
text, in_toks, out_toks = ret
return text, in_toks, out_toks, None
# Unexpected shape — treat as an empty text response.
return str(ret or ""), None, None, None
def _invoke_with_retry(adapter, *, api_key: str, **kwargs):
"""Call ``adapter`` with a bounded transient-failure retry.
Retries ONLY transient conditions (STATUS_CONNECTION and genuine
rate-limit STATUS_QUOTA) with exponential backoff; never retries
auth / model-missing / context-overflow / parse errors (a retry
cannot help and would waste calls and money). Re-raises the final
exception so the caller's existing except-block classifies it.
"""
attempt = 0
while True:
attempt += 1
try:
return _normalize_adapter_return(
adapter(api_key=api_key, **kwargs)
)
except ModuleNotFoundError:
raise # missing SDK — surfaced verbatim, never retried
except Exception as exc: # noqa: BLE001
status = _classify_exception(exc)
if status in _RETRYABLE_STATUSES and attempt < _MAX_ATTEMPTS:
_logger.info(
"transient llm failure status=%s attempt=%s/%s — retrying",
status,
attempt,
_MAX_ATTEMPTS,
)
time.sleep(_RETRY_BACKOFF_BASE * (2 ** (attempt - 1)))
continue
raise
def _is_truncated(finish_reason: Optional[str]) -> bool:
if not finish_reason:
return False
return str(finish_reason).strip().lower() in _TRUNCATION_REASONS
# ---------------------------------------------------------------------------
# Public API
# ---------------------------------------------------------------------------
def call_text_llm(
task_name: str,
system_prompt: str,
user_prompt: str,
*,
expected_json: bool = False,
max_tokens: int = 1024,
settings: Optional[Settings] = None,
) -> LLMCallResult:
"""Send a single text completion to the configured provider."""
_validate_task_name(task_name)
settings = settings or get_settings()
provider = _resolve_provider(settings)
model = _resolve_model(settings)
api_key = _resolve_key(settings, provider)
started = time.monotonic()
if provider not in _SUPPORTED_PROVIDERS:
result = LLMCallResult(
success=False,
task_name=task_name,
provider=provider or None,
model=model,
used_api=False,
error_message="Provider not configured",
status=STATUS_UNSUPPORTED_PROVIDER,
)
_finalize(result, started)
return result
if not api_key:
result = LLMCallResult(
success=False,
task_name=task_name,
provider=provider,
model=model,
used_api=False,
error_message="No API key configured for provider",
status=STATUS_NO_API,
)
_finalize(result, started)
return result
if not model:
result = LLMCallResult(
success=False,
task_name=task_name,
provider=provider,
model=None,
used_api=False,
error_message="Model not configured",
status=STATUS_MODEL_MISSING,
)
_finalize(result, started)
return result
try:
_text_adapter = {
"anthropic": _anthropic_text,
"openai": _openai_text,
"groq": _groq_text,
"gemini": _gemini_text,
}[provider]
text, in_toks, out_toks, finish_reason = _invoke_with_retry(
_text_adapter,
api_key=api_key,
model=model,
system_prompt=system_prompt,
user_prompt=user_prompt,
expected_json=expected_json,
max_tokens=max_tokens,
)
except ModuleNotFoundError as exc:
result = LLMCallResult(
success=False,
task_name=task_name,
provider=provider,
model=model,
used_api=True,
error_message=f"Provider SDK missing: {exc.name}",
status=STATUS_CONNECTION,
)
_finalize(result, started)
return result
except Exception as exc: # noqa: BLE001
status = _classify_exception(exc)
result = LLMCallResult(
success=False,
task_name=task_name,
provider=provider,
model=model,
used_api=True,
error_message=sanitize_error_message(
f"{exc.__class__.__name__}: {exc}", secrets=(api_key,)
)[:200],
status=status,
)
_finalize(result, started)
return result
response_json: Any = None
if expected_json:
response_json = _parse_json(text)
if response_json is None:
# Distinguish an output cut off by the token budget (recoverable
# by raising max_tokens) from genuinely malformed JSON.
truncated = _is_truncated(finish_reason)
result = LLMCallResult(
success=False,
task_name=task_name,
provider=provider,
model=model,
used_api=True,
response_text=text,
error_message=(
"Provider response was truncated by the output token "
"limit; raise max_tokens and retry."
if truncated
else "Provider response was not valid JSON"
),
estimated_input_tokens=in_toks if in_toks is not None
else _estimate_tokens(system_prompt + user_prompt),
estimated_output_tokens=out_toks if out_toks is not None
else _estimate_tokens(text),
status=STATUS_TRUNCATED if truncated else STATUS_PARSE_ERROR,
)
_finalize(result, started)
return result
result = LLMCallResult(
success=True,
task_name=task_name,
provider=provider,
model=model,
used_api=True,
response_text=text,
response_json=response_json,
estimated_input_tokens=in_toks if in_toks is not None
else _estimate_tokens(system_prompt + user_prompt),
estimated_output_tokens=out_toks if out_toks is not None
else _estimate_tokens(text),
status=STATUS_OK,
)
_finalize(result, started)
return result
def call_vision_llm(
task_name: str,
system_prompt: str,
image_inputs: Iterable,
user_prompt: str = "",
*,
expected_json: bool = False,
max_tokens: int = 2048,
settings: Optional[Settings] = None,
) -> LLMCallResult:
"""Send a vision request to the configured provider."""
_validate_task_name(task_name)
settings = settings or get_settings()
provider = _resolve_provider(settings, vision=True)
model = _resolve_model(settings, vision=True)
api_key = _resolve_key(settings, provider)
started = time.monotonic()
images: list[tuple[bytes, str]] = []
for raw in image_inputs or []:
norm = _normalize_image(raw)
if norm is not None:
# Upscale small screenshots so tiny client-panel text is legible.
images.append(_prepare_vision_image(norm[0], norm[1]))
if not images:
result = LLMCallResult(
success=False,
task_name=task_name,
provider=provider or None,
model=model,
used_api=False,
error_message="No image inputs supplied",
status=STATUS_SKIPPED,
)
_finalize(result, started)
return result
# Groq is text-only here — surface the dedicated, actionable message
# rather than a generic "provider not configured".
if provider == "groq":
result = LLMCallResult(
success=False,
task_name=task_name,
provider=provider,
model=model,
used_api=False,
error_message=GROQ_VISION_UNSUPPORTED_MESSAGE,
status=STATUS_UNSUPPORTED_PROVIDER,
)
_finalize(result, started)
return result
if provider not in _SUPPORTED_VISION_PROVIDERS:
result = LLMCallResult(
success=False,
task_name=task_name,
provider=provider or None,
model=model,
used_api=False,
error_message="Provider not configured",
status=STATUS_UNSUPPORTED_PROVIDER,
)
_finalize(result, started)
return result
if not api_key:
result = LLMCallResult(
success=False,
task_name=task_name,
provider=provider,
model=model,
used_api=False,
error_message="No API key configured for provider",
status=STATUS_NO_API,
)
_finalize(result, started)
return result
if not model:
result = LLMCallResult(
success=False,
task_name=task_name,
provider=provider,
model=None,
used_api=False,
error_message="Model not configured",
status=STATUS_MODEL_MISSING,
)
_finalize(result, started)
return result
try:
_vision_adapter = {
"anthropic": _anthropic_vision,
"openai": _openai_vision,
"gemini": _gemini_vision,
}[provider]
text, in_toks, out_toks, finish_reason = _invoke_with_retry(
_vision_adapter,
api_key=api_key,
model=model,
system_prompt=system_prompt,
user_prompt=user_prompt,
images=images,
expected_json=expected_json,
max_tokens=max_tokens,
)
except ModuleNotFoundError as exc:
result = LLMCallResult(
success=False,
task_name=task_name,
provider=provider,
model=model,
used_api=True,
error_message=f"Provider SDK missing: {exc.name}",
status=STATUS_CONNECTION,
)
_finalize(result, started)
return result
except Exception as exc: # noqa: BLE001
status = _classify_exception(exc)
result = LLMCallResult(
success=False,
task_name=task_name,
provider=provider,
model=model,
used_api=True,
error_message=sanitize_error_message(
f"{exc.__class__.__name__}: {exc}", secrets=(api_key,)
)[:200],
status=status,
)
_finalize(result, started)
return result
response_json: Any = None
if expected_json:
response_json = _parse_json(text)
if response_json is None:
truncated = _is_truncated(finish_reason)
result = LLMCallResult(
success=False,
task_name=task_name,
provider=provider,
model=model,
used_api=True,
response_text=text,
error_message=(
"Provider response was truncated by the output token "
"limit; raise max_tokens and retry."
if truncated
else "Provider response was not valid JSON"
),
estimated_input_tokens=in_toks if in_toks is not None
else _estimate_tokens(system_prompt + user_prompt),
estimated_output_tokens=out_toks if out_toks is not None
else _estimate_tokens(text),
status=STATUS_TRUNCATED if truncated else STATUS_PARSE_ERROR,
)
_finalize(result, started)
return result
result = LLMCallResult(
success=True,
task_name=task_name,
provider=provider,
model=model,
used_api=True,
response_text=text,
response_json=response_json,
estimated_input_tokens=in_toks if in_toks is not None
else _estimate_tokens(system_prompt + user_prompt),
estimated_output_tokens=out_toks if out_toks is not None
else _estimate_tokens(text),
status=STATUS_OK,
)
_finalize(result, started)
return result
# ---------------------------------------------------------------------------
# Finalization
# ---------------------------------------------------------------------------
def _finalize(result: LLMCallResult, started_monotonic: float) -> None:
result.duration_seconds = round(time.monotonic() - started_monotonic, 3)
# Strip provider organization IDs before the message touches the
# session log so the UI never displays raw provider metadata.
if result.error_message:
result.error_message = sanitize_error_message(result.error_message)
entry = result.to_log_entry()
_record_to_session(entry)
_logger.info(
"stage=%s used_api=%s status=%s provider=%s model=%s in_tokens=%s out_tokens=%s",
result.task_name,
str(result.used_api).lower(),
result.status,
result.provider or "-",
result.model or "-",
result.estimated_input_tokens if result.estimated_input_tokens is not None else "-",
result.estimated_output_tokens if result.estimated_output_tokens is not None else "-",
)
__all__ = [
"LLMCallResult",
"call_text_llm",
"call_vision_llm",
"record_local_use",
"extend_last_entry",
"sanitize_error_message",
"get_usage_log",
"reset_usage_log",
"STATUS_OK",
"STATUS_NO_API",
"STATUS_INVALID_KEY",
"STATUS_QUOTA",
"STATUS_CONTEXT_OVERFLOW",
"STATUS_CONNECTION",
"STATUS_MODEL_MISSING",
"STATUS_PARSE_ERROR",
"STATUS_TRUNCATED",
"STATUS_UNSUPPORTED_PROVIDER",
"STATUS_SKIPPED",
"STATUS_EXCEPTION",
]
|