vtcode_commons/
provider.rs

1//! Provider enum and core definitions shared across VT Code crates.
2//!
3//! This module provides the [`Provider`] enum and its pure methods. Methods
4//! that depend on model catalogs or vtcode-config internals
5//! (`supports_reasoning_effort`, `supports_service_tier`) remain in
6//! `vtcode-config` as extension methods.
7
8use serde::{Deserialize, Serialize};
9use std::fmt;
10use std::str::FromStr;
11
12/// Error returned when parsing a provider string fails.
13#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
14pub enum ProviderParseError {
15    #[error("Invalid provider: '{}'. Supported providers: {}", .0, crate::provider::Provider::all_providers().iter().map(|p| p.to_string()).collect::<Vec<_>>().join(", "))]
16    InvalidProvider(String),
17}
18
19/// Supported AI model providers
20#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
21#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize, Deserialize, Default)]
22pub enum Provider {
23    /// Google Gemini models
24    Gemini,
25    /// OpenAI GPT models
26    #[default]
27    OpenAI,
28    /// Anthropic Claude models
29    Anthropic,
30    /// GitHub Copilot preview integration
31    Copilot,
32    /// DeepSeek native models
33    DeepSeek,
34    /// Official Meta AI Muse models
35    Meta,
36    /// OpenRouter marketplace models
37    OpenRouter,
38    /// Local Ollama models
39    Ollama,
40    /// Ollama Cloud hosted models (ollama.com)
41    OllamaCloud,
42    /// LM Studio local models
43    LmStudio,
44    /// llama.cpp local models
45    LlamaCpp,
46    /// Moonshot.ai models
47    Moonshot,
48    /// Z.AI GLM models
49    ZAI,
50    /// MiniMax models
51    Minimax,
52    /// Xiaomi MiMo models
53    MiMo,
54    /// Mistral AI models
55    Mistral,
56    /// Hugging Face Inference Providers
57    HuggingFace,
58    /// OpenCode Zen gateway (pay-as-you-go)
59    OpenCodeZen,
60    /// OpenCode Go subscription
61    OpenCodeGo,
62    /// Alibaba Cloud Qwen models
63    Qwen,
64    /// StepFun models
65    StepFun,
66    /// Evolink multi-model gateway
67    Evolink,
68    /// Poolside AI models
69    Poolside,
70    /// xAI Grok models
71    XAI,
72    /// NVIDIA NIM OpenAI-compatible models
73    NVIDIA,
74}
75
76impl Provider {
77    /// Get the default API key environment variable for this provider
78    pub fn default_api_key_env(&self) -> &'static str {
79        match self {
80            Provider::Gemini => "GEMINI_API_KEY",
81            Provider::OpenAI => "OPENAI_API_KEY",
82            Provider::Anthropic => "ANTHROPIC_API_KEY",
83            Provider::Copilot => "",
84            Provider::DeepSeek => "DEEPSEEK_API_KEY",
85            Provider::Meta => "META_API_KEY",
86            Provider::OpenRouter => "OPENROUTER_API_KEY",
87            Provider::Ollama => "OLLAMA_API_KEY",
88            Provider::OllamaCloud => "OLLAMA_API_KEY",
89            Provider::LmStudio => "LMSTUDIO_API_KEY",
90            Provider::LlamaCpp => "LLAMACPP_API_KEY",
91            Provider::Moonshot => "MOONSHOT_API_KEY",
92            Provider::ZAI => "ZAI_API_KEY",
93            Provider::Minimax => "MINIMAX_API_KEY",
94            Provider::MiMo => "MIMO_API_KEY",
95            Provider::Mistral => "MISTRAL_API_KEY",
96            Provider::HuggingFace => "HF_TOKEN",
97            Provider::OpenCodeZen => "OPENCODE_ZEN_API_KEY",
98            Provider::OpenCodeGo => "OPENCODE_GO_API_KEY",
99            Provider::Qwen => "QWEN_API_KEY",
100            Provider::StepFun => "STEPFUN_API_KEY",
101            Provider::Evolink => "EVOLINK_API_KEY",
102            Provider::Poolside => "POOLSIDE_API_KEY",
103            Provider::XAI => "XAI_API_KEY",
104            Provider::NVIDIA => "NVIDIA_API_KEY",
105        }
106    }
107
108    /// Get all supported providers
109    pub fn all_providers() -> Vec<Provider> {
110        vec![
111            Provider::OpenAI,
112            Provider::Anthropic,
113            Provider::Copilot,
114            Provider::Minimax,
115            Provider::MiMo,
116            Provider::Mistral,
117            Provider::Gemini,
118            Provider::DeepSeek,
119            Provider::Meta,
120            Provider::HuggingFace,
121            Provider::OpenRouter,
122            Provider::Ollama,
123            Provider::OllamaCloud,
124            Provider::LmStudio,
125            Provider::LlamaCpp,
126            Provider::Moonshot,
127            Provider::ZAI,
128            Provider::OpenCodeZen,
129            Provider::OpenCodeGo,
130            Provider::Qwen,
131            Provider::StepFun,
132            Provider::Evolink,
133            Provider::Poolside,
134            Provider::XAI,
135            Provider::NVIDIA,
136        ]
137    }
138
139    /// Human-friendly label for display purposes
140    pub fn label(&self) -> &'static str {
141        match self {
142            Provider::Gemini => "Gemini",
143            Provider::OpenAI => "OpenAI",
144            Provider::Anthropic => "Anthropic",
145            Provider::Copilot => "GitHub Copilot",
146            Provider::DeepSeek => "DeepSeek",
147            Provider::Meta => "Meta AI",
148            Provider::OpenRouter => "OpenRouter",
149            Provider::Ollama => "Ollama",
150            Provider::OllamaCloud => "Ollama Cloud",
151            Provider::LmStudio => "LM Studio",
152            Provider::LlamaCpp => "llama.cpp",
153            Provider::Moonshot => "Moonshot",
154            Provider::ZAI => "Z.AI",
155            Provider::Minimax => "MiniMax",
156            Provider::MiMo => "Xiaomi MiMo",
157            Provider::Mistral => "Mistral",
158            Provider::HuggingFace => "Hugging Face",
159            Provider::OpenCodeZen => "OpenCode Zen",
160            Provider::OpenCodeGo => "OpenCode Go",
161            Provider::Qwen => "Qwen",
162            Provider::StepFun => "StepFun",
163            Provider::Evolink => "Evolink",
164            Provider::Poolside => "Poolside",
165            Provider::XAI => "xAI",
166            Provider::NVIDIA => "NVIDIA",
167        }
168    }
169
170    pub fn is_dynamic(&self) -> bool {
171        matches!(self, Provider::Copilot) || self.is_local()
172    }
173
174    pub fn is_local(&self) -> bool {
175        matches!(self, Provider::Ollama | Provider::LmStudio | Provider::LlamaCpp)
176    }
177
178    pub fn local_install_instructions(&self) -> Option<&'static str> {
179        match self {
180            Provider::Ollama => Some(
181                "Ollama server is not running. To start:\n  1. Install Ollama from https://ollama.com\n  2. Run 'ollama serve' in a terminal\n  3. Pull models using 'ollama pull <model-name>' (e.g., 'ollama pull gpt-oss:20b')",
182            ),
183            Provider::LmStudio => Some(
184                "LM Studio server is not running. To start:\n  1. Install LM Studio from https://lmstudio.ai\n  2. Open LM Studio and start the Local Server on port 1234\n  3. Load the model you want to use",
185            ),
186            Provider::LlamaCpp => Some(
187                "llama.cpp server is not running. To start:\n  1. Install llama.cpp from https://llama.app or your package manager\n  2. Run 'llama-server -m /path/to/model.gguf --port 8080'\n  3. Keep the server running while VT Code connects",
188            ),
189            _ => None,
190        }
191    }
192
193    pub fn uses_managed_auth(&self) -> bool {
194        matches!(self, Provider::Copilot)
195    }
196
197    pub fn platform_url(&self) -> Option<&'static str> {
198        match self {
199            Provider::Gemini => Some("https://aistudio.google.com/app/apikey"),
200            Provider::OpenAI => Some("https://platform.openai.com/api-keys"),
201            Provider::Anthropic => Some("https://console.anthropic.com"),
202            Provider::Copilot => None,
203            Provider::DeepSeek => Some("https://platform.deepseek.com"),
204            Provider::Meta => Some("https://developer.meta.com/ai/models"),
205            Provider::OpenRouter => Some("https://openrouter.ai/api/v1/auth/keys"),
206            Provider::Ollama => None,
207            Provider::OllamaCloud => Some("https://ollama.com"),
208            Provider::LmStudio => None,
209            Provider::LlamaCpp => None,
210            Provider::Moonshot => Some("https://platform.kimi.ai/console/api-keys"),
211            Provider::ZAI => Some("https://z.ai/docs"),
212            Provider::Minimax => Some("https://platform.minimax.io/docs"),
213            Provider::MiMo => Some("https://platform.xiaomimimo.com/docs/en-US/welcome"),
214            Provider::Mistral => Some("https://console.mistral.ai"),
215            Provider::HuggingFace => Some("https://huggingface.co/settings/tokens"),
216            Provider::OpenCodeZen => Some("https://opencode.ai/docs/zen/"),
217            Provider::OpenCodeGo => Some("https://opencode.ai/docs/go/"),
218            Provider::Qwen => Some("https://dashscope.console.aliyun.com"),
219            Provider::StepFun => Some("https://platform.stepfun.com"),
220            Provider::Evolink => Some("https://evolink.ai/dashboard/keys"),
221            Provider::Poolside => Some("https://poolside.ai"),
222            Provider::XAI => Some("https://docs.x.ai"),
223            Provider::NVIDIA => Some("https://build.nvidia.com"),
224        }
225    }
226}
227
228impl fmt::Display for Provider {
229    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
230        match self {
231            Provider::Gemini => write!(f, "gemini"),
232            Provider::OpenAI => write!(f, "openai"),
233            Provider::Anthropic => write!(f, "anthropic"),
234            Provider::Copilot => write!(f, "copilot"),
235            Provider::DeepSeek => write!(f, "deepseek"),
236            Provider::Meta => write!(f, "meta"),
237            Provider::OpenRouter => write!(f, "openrouter"),
238            Provider::Ollama => write!(f, "ollama"),
239            Provider::OllamaCloud => write!(f, "ollama-cloud"),
240            Provider::LmStudio => write!(f, "lmstudio"),
241            Provider::LlamaCpp => write!(f, "llamacpp"),
242            Provider::Moonshot => write!(f, "moonshot"),
243            Provider::ZAI => write!(f, "zai"),
244            Provider::Minimax => write!(f, "minimax"),
245            Provider::MiMo => write!(f, "mimo"),
246            Provider::Mistral => write!(f, "mistral"),
247            Provider::HuggingFace => write!(f, "huggingface"),
248            Provider::OpenCodeZen => write!(f, "opencode-zen"),
249            Provider::OpenCodeGo => write!(f, "opencode-go"),
250            Provider::Qwen => write!(f, "qwen"),
251            Provider::StepFun => write!(f, "stepfun"),
252            Provider::Evolink => write!(f, "evolink"),
253            Provider::Poolside => write!(f, "poolside"),
254            Provider::XAI => write!(f, "xai"),
255            Provider::NVIDIA => write!(f, "nvidia"),
256        }
257    }
258}
259
260impl AsRef<str> for Provider {
261    fn as_ref(&self) -> &str {
262        match self {
263            Provider::Gemini => "gemini",
264            Provider::OpenAI => "openai",
265            Provider::Anthropic => "anthropic",
266            Provider::Copilot => "copilot",
267            Provider::DeepSeek => "deepseek",
268            Provider::Meta => "meta",
269            Provider::OpenRouter => "openrouter",
270            Provider::Ollama => "ollama",
271            Provider::OllamaCloud => "ollama-cloud",
272            Provider::LmStudio => "lmstudio",
273            Provider::LlamaCpp => "llamacpp",
274            Provider::Moonshot => "moonshot",
275            Provider::ZAI => "zai",
276            Provider::Minimax => "minimax",
277            Provider::MiMo => "mimo",
278            Provider::Mistral => "mistral",
279            Provider::HuggingFace => "huggingface",
280            Provider::OpenCodeZen => "opencode-zen",
281            Provider::OpenCodeGo => "opencode-go",
282            Provider::Qwen => "qwen",
283            Provider::StepFun => "stepfun",
284            Provider::Evolink => "evolink",
285            Provider::Poolside => "poolside",
286            Provider::XAI => "xai",
287            Provider::NVIDIA => "nvidia",
288        }
289    }
290}
291
292impl FromStr for Provider {
293    type Err = ProviderParseError;
294
295    fn from_str(s: &str) -> Result<Self, Self::Err> {
296        match s.to_lowercase().as_str() {
297            "gemini" => Ok(Provider::Gemini),
298            "openai" => Ok(Provider::OpenAI),
299            "anthropic" => Ok(Provider::Anthropic),
300            "copilot" => Ok(Provider::Copilot),
301            "deepseek" => Ok(Provider::DeepSeek),
302            "meta" | "meta-ai" => Ok(Provider::Meta),
303            "openrouter" => Ok(Provider::OpenRouter),
304            "ollama" => Ok(Provider::Ollama),
305            "ollama-cloud" | "ollamacloud" | "ollama_cloud" => Ok(Provider::OllamaCloud),
306            "lmstudio" => Ok(Provider::LmStudio),
307            "llamacpp" | "llama.cpp" | "llama-cpp" => Ok(Provider::LlamaCpp),
308            "moonshot" => Ok(Provider::Moonshot),
309            "zai" => Ok(Provider::ZAI),
310            "minimax" => Ok(Provider::Minimax),
311            "mimo" => Ok(Provider::MiMo),
312            "mistral" => Ok(Provider::Mistral),
313            "huggingface" => Ok(Provider::HuggingFace),
314            "opencode-zen" | "opencodezen" => Ok(Provider::OpenCodeZen),
315            "opencode-go" | "opencodego" => Ok(Provider::OpenCodeGo),
316            "qwen" => Ok(Provider::Qwen),
317            "stepfun" => Ok(Provider::StepFun),
318            "evolink" => Ok(Provider::Evolink),
319            "poolside" => Ok(Provider::Poolside),
320            "xai" => Ok(Provider::XAI),
321            "nvidia" | "nvidia-nim" => Ok(Provider::NVIDIA),
322            _ => Err(ProviderParseError::InvalidProvider(s.to_string())),
323        }
324    }
325}
vtcode_commons/provider.rs

vtcode_commons/
provider.rs
