forked from quadbio/cell-annotator
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path_api_keys.py
More file actions
295 lines (241 loc) · 9.95 KB
/
Copy path_api_keys.py
File metadata and controls
295 lines (241 loc) · 9.95 KB
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
"""API key management for different LLM providers."""
import os
from dotenv import load_dotenv
from cell_annotator._logging import logger
class APIKeyManager:
"""
Manages API keys for different LLM providers.
Provides utilities to check availability, validate keys, and guide users
on setup for different providers.
"""
# Provider configurations. ``model_keywords`` feed ``detect_provider_from_model``;
# OpenRouter is detected via the ``provider/model`` slash heuristic instead.
PROVIDER_CONFIG = {
"openai": {
"env_var": "OPENAI_API_KEY",
"setup_url": "https://platform.openai.com/api-keys",
"description": "OpenAI models (GPT, o1, etc.)",
"model_keywords": ("gpt", "o1", "davinci", "curie", "babbage", "ada"),
},
"gemini": {
"env_var": "GEMINI_API_KEY",
"setup_url": "https://aistudio.google.com/apikey",
"description": "Google Gemini models",
"model_keywords": ("gemini", "bison"),
},
"anthropic": {
"env_var": "ANTHROPIC_API_KEY",
"setup_url": "https://console.anthropic.com/settings/keys",
"description": "Anthropic Claude models",
"model_keywords": ("claude", "anthropic", "sonnet", "haiku", "opus"),
},
"openrouter": {
"env_var": "OPENROUTER_API_KEY",
"setup_url": "https://openrouter.ai/settings/keys",
"description": "OpenRouter models (aggregated providers)",
"model_keywords": (),
},
}
def __init__(self, auto_load_env: bool = True):
"""
Initialize API key manager.
Parameters
----------
auto_load_env
Whether to automatically load .env file.
"""
if auto_load_env:
load_dotenv()
def __repr__(self) -> str:
"""Return a string representation of the API key manager status."""
lines = []
lines.append("🔑 APIKeyManager Status")
lines.append("=" * 30)
availability = self.check_key_availability()
available_providers = self.get_available_providers()
for provider, config in self.PROVIDER_CONFIG.items():
status = "✅" if availability[provider] else "❌"
lines.append(f"{status} {provider.upper()}: {config['description']}")
lines.append("")
total_providers = len(self.PROVIDER_CONFIG)
available_count = len(available_providers)
lines.append(f"📊 {available_count}/{total_providers} providers configured")
if available_count > 0:
lines.append(f"🚀 Ready: {', '.join(available_providers)}")
return "\n".join(lines)
def check_key_availability(self) -> dict[str, bool]:
"""
Check which API keys are available.
Returns
-------
Dictionary mapping provider names to availability status.
"""
availability = {}
for provider, config in self.PROVIDER_CONFIG.items():
availability[provider] = bool(os.getenv(config["env_var"]))
return availability
def get_available_providers(self) -> list[str]:
"""
Get list of providers with valid API keys.
Returns
-------
List of available provider names.
"""
return [provider for provider, available in self.check_key_availability().items() if available]
def validate_provider(self, provider: str) -> bool:
"""
Check if a provider has a valid API key.
Parameters
----------
provider
Provider name to validate.
Returns
-------
True if provider has valid API key.
"""
if provider not in self.PROVIDER_CONFIG:
return False
return provider in self.get_available_providers()
def get_setup_instructions(self, provider: str) -> str:
"""
Get setup instructions for a specific provider.
Parameters
----------
provider
Provider name.
Returns
-------
Setup instruction string.
"""
if provider not in self.PROVIDER_CONFIG:
return f"Unknown provider: {provider}"
config = self.PROVIDER_CONFIG[provider]
return (
f"To use {config['description']}, set the environment variable "
f"`{config['env_var']}` with your API key from {config['setup_url']}"
)
def print_status(self) -> None:
"""Print a comprehensive status report of all providers."""
print("🔑 API Key Status Report")
print("=" * 50)
availability = self.check_key_availability()
for provider, config in self.PROVIDER_CONFIG.items():
status = "✅" if availability[provider] else "❌"
print(f"\n{status} {provider.upper()}")
print(f" Description: {config['description']}")
print(f" Environment Variable: {config['env_var']}")
if availability[provider]:
print(" Status: Ready to use")
else:
print(f" Setup URL: {config['setup_url']}")
print(f" Note: {self.get_setup_instructions(provider)}")
print("\n📊 Summary:")
total_providers = len(self.PROVIDER_CONFIG)
available_count = len(self.get_available_providers())
print(f" • {available_count}/{total_providers} providers configured")
if available_count == 0:
print("\n⚠️ No API keys found! Please set up at least one provider.")
elif available_count < total_providers:
missing = set(self.PROVIDER_CONFIG.keys()) - set(self.get_available_providers())
print(f" • Missing providers: {', '.join(missing)}")
else:
print(" • All providers configured! 🎉")
def validate_model_access(self, model: str) -> tuple[bool, str | None]:
"""
Check if a specific model is accessible by detecting its provider.
Parameters
----------
model
Model name to check.
Returns
-------
Tuple of (is_accessible, provider_name)
"""
provider = detect_provider_from_model(model)
return self.validate_provider(provider), provider
def check_and_warn(self, provider: str | None = None, model: str | None = None) -> bool:
"""
Check API key availability and log appropriate warnings.
Parameters
----------
provider
Specific provider to check. If None, checks all.
model
Specific model to check access for.
Returns
-------
True if requested provider/model is accessible.
"""
if model:
accessible, detected_provider = self.validate_model_access(model)
if accessible:
logger.info("✅ API key found for provider %s", detected_provider)
return True
elif detected_provider:
logger.warning(
"❌ Model '%s' requires %s API key. %s",
model,
detected_provider,
self.get_setup_instructions(detected_provider),
)
return False
else:
logger.warning("❌ Unknown model '%s'", model)
return False
if provider:
if self.validate_provider(provider):
logger.info("✅ %s API key is available", provider.upper())
return True
else:
logger.warning("❌ %s", self.get_setup_instructions(provider))
return False
# Check all providers
available = self.get_available_providers()
if available:
logger.info("✅ Available providers: %s", ", ".join(available))
return True
else:
logger.warning("❌ No API keys found! Please configure at least one provider.")
for prov in self.PROVIDER_CONFIG:
logger.info(" %s", self.get_setup_instructions(prov))
return False
def detect_provider_from_model(model: str) -> str:
"""
Auto-detect the LLM provider from a model name string.
OpenRouter slugs follow ``<provider>/<model>`` (e.g. ``openai/gpt-4o-mini``);
the ``models/`` prefix that Gemini IDs sometimes carry is excluded so it
does not false-match. Otherwise, match keywords from
``APIKeyManager.PROVIDER_CONFIG[*].model_keywords`` in priority order
(gemini, anthropic, openai). Defaults to ``"openai"`` if nothing matches.
Parameters
----------
model
Model name or slug.
Returns
-------
Provider name.
"""
model_lower = model.lower()
# OpenRouter uses '<provider>/<model>' slugs (e.g. 'openai/gpt-4o-mini').
# The 'models/' guard avoids false-matching Gemini IDs like 'models/gemini-1.5-flash'.
if "/" in model and not model_lower.startswith("models/"):
return "openrouter"
# Priority order matters: a model name like "ada-claude-experiment" should
# route to anthropic, not openai (anthropic-specific keywords win).
for provider in ("gemini", "anthropic", "openai"):
keywords = APIKeyManager.PROVIDER_CONFIG[provider].get("model_keywords", ())
if any(keyword in model_lower for keyword in keywords):
return provider
return "openai"
class APIKeyMixin:
"""Mixin class to add API key management capabilities to other classes."""
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self._api_key_manager = APIKeyManager()
@property
def api_keys(self) -> APIKeyManager:
"""Access to API key manager."""
return self._api_key_manager
def check_api_access(self, provider: str | None = None, model: str | None = None) -> bool:
"""Check API access and log warnings if needed."""
return self._api_key_manager.check_and_warn(provider=provider, model=model)